Merge pull request #24 from 201st-Luka/correcting_errors

Correcting errors

.github/workflows/pull_request.yml

@@ -21,8 +21,8 @@ jobs:
  - name: Install dependencies
  run: |
  python -m pip install --upgrade pip
- python -m pip install flake8 pytest
- if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+ python -m pip install flake8
+ pip install -r requirements_tests.txt
  - name: linting
  run: |
  flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics

README.md

@@ -64,12 +64,26 @@ good as I can.
 - documentation
 - real example ([HeadhunterBot][headhunterbot_url] is in development)
 
+### Planned code implementations (ToDo-list)
+
+- `total_wars` attribute for `ClanWarLogEntry`
+- war log filtering for `ClanWarLogRequest` (for example filter the number of attacks per member)
+- some "average" attributes for `Clan`-classes, `WarLog`-classes, ...
+- attributes `king`, `queen`, `warden`, `royal_champion` for the `Player.heroes` attribute
+- autosort for the `ClanCurrentWarRequest` members of the `member_list` attribute (sorted by the map position)
+
 ---
 
 If you find a bug, an error or want custom functionality, please tell
 me via Discord or open an issue or start a discussion on the 
 GitHub-repository.
 
+---
+
+##### Disclaimer
+This material is unofficial and is not endorsed by Supercell. For more information see Supercell's Fan Content Policy:
+www.supercell.com/fan-content-policy.
+
 
 
 <!---links--->

build.sh

@@ -0,0 +1,3 @@
+rm -r build dist pyclasher.egg-info
+
+python setup.py sdist bdist_wheel

pyclasher/__init__.py

@@ -9,6 +9,8 @@
 .. author:: 201st-Luka
 """
 
+__version__ = '1.0.0-alpha1'
+
 from .Exceptions import ApiCode, ClientIsRunning, ClientIsNotRunning, ClientAlreadyInitialised, NoClient, \
  InvalidType, InvalidLoginData, LoginNotDone, NoneToken, RequestNotDone, InvalidTimeFormat, \
  InvalidSeasonFormat, Missing, MISSING, PyClasherException

pyclasher/bulk_requests/BulkPlayer.py

@@ -1,5 +1,7 @@
 from asyncio import get_running_loop, run
 
+from Exceptions import MISSING
+from models import Clan
 from .BulkRequestModel import BulkRequestModel
 from ..models import BaseClan
 from ..requests import PlayerRequest, ClanMembersRequest
@@ -20,8 +22,12 @@ def tags(self):
 
  @classmethod
  async def _async_from_clan(cls, clan):
- members = await (ClanMembersRequest(clan.tag).request() if isinstance(clan, BaseClan) else
- await ClanMembersRequest(clan).request())
+ if isinstance(clan, Clan) and clan.member_list is not MISSING:
+ members = clan.member_list
+ elif isinstance(clan, BaseClan):
+ members = await ClanMembersRequest(clan.tag).request()
+ else:
+ members = await ClanMembersRequest(clan).request()
  return cls.from_member_list(members)
 
  @classmethod

pyclasher/bulk_requests/BulkRequestModel.py

@@ -1,5 +1,7 @@
 from asyncio import gather, get_running_loop, run
 
+from Exceptions import RequestNotDone
+
 
 class BulkRequestModel:
  _request_model = ...
@@ -34,7 +36,12 @@ def __len__(self):
  return len(self._requests)
 
  def __getitem__(self, item):
- return self._requests[item]
+ self._requests[0].to_dict() # test if the `to_dict()` method raises `RequestNotDone`
+ if isinstance(item, int):
+ return self._requests[item]
+ if isinstance(item, slice):
+ return (self._requests[i] for i in range(*item.indices(len(self._requests))))
+ raise NotImplementedError
 
  def __iter__(self):
  self._iter = iter(self._requests)

pyclasher/bulk_requests/BulkRequestModel.pyi

@@ -1,4 +1,4 @@
-from typing import Any, Coroutine, Iterator
+from typing import Any, Coroutine, Iterator, Generator
 
 
 class BulkRequestModel:
@@ -77,7 +77,7 @@ class BulkRequestModel:
  def __len__(self) -> int:
  ...
 
- def __getitem__(self, item: int) -> _request_model:
+ def __getitem__(self, item: int | slice) -> Generator | _request_model:
  ...
 
  def __iter__(self) -> Iterator[_request_model]:

pyclasher/client.py

@@ -204,7 +204,8 @@ async def _request(self, future, url, method, body, status, error):
 
  future.set_result(response_json)
  status.set_result(response.status)
- error.set_result(None if response.status == 200 else ApiCodes.from_exception(response.status, response_json))
+ error.set_result(None if response.status == 200 else
+ ApiCodes.from_exception(response.status, response_json))
  return
 
  async def consume(self):

pyclasher/models/BaseModels.py

@@ -8,12 +8,12 @@ class BaseModel:
  _main_attribute = None
  _data = MISSING
 
- def __new__(cls, data):
+ def __new__(cls, data=None):
  if data is MISSING:
  return MISSING
  return super().__new__(cls)
 
- def __init__(self, data):
+ def __init__(self, data=None):
  if data is not None:
  self._data = data
  return
@@ -55,6 +55,11 @@ class IterBaseModel:
  _main_attribute = None
  _iter_rtype = Any
 
+ def __new__(cls, data):
+ if data is MISSING:
+ return MISSING
+ return super().__new__(cls)
+
  def __init__(self, data):
  self._data = data
  if self._data is not None and self._data is not MISSING:
@@ -69,7 +74,15 @@ def __len__(self):
  return self._len
 
  def __getitem__(self, item):
- return self._iter_rtype(self._data[item])
+ if self._data is MISSING:
+ raise RequestNotDone
+ if self._data is None:
+ return None
+ if isinstance(item, int):
+ return self._iter_rtype(self._data[item])
+ if isinstance(item, slice):
+ return (self._iter_rtype(self._data[i]) for i in range(*item.indices(len(self._data))))
+ raise NotImplementedError
 
  def __iter__(self):
  self._iter = iter(self._data)

pyclasher/models/BaseModels.pyi

@@ -2,7 +2,7 @@
 base models for this API wrapper client
 """
 
-from typing import Any, Iterator
+from typing import Any, Iterator, Generator
 
 from ..Exceptions import MISSING, Missing
 
@@ -123,7 +123,7 @@ class IterBaseModel:
  def __len__(self) -> int:
  ...
 
- def __getitem__(self, item: int) -> _iter_rtype:
+ def __getitem__(self, item: int | slice) -> MISSING | Generator | _iter_rtype:
  ...
 
  def __iter__(self) -> Iterator[_iter_rtype]:

pyclasher/models/Clan.pyi

@@ -210,7 +210,7 @@ class Clan(BaseClan):
  ...
 
  @property
- def war_wins(self) -> int:
+ def war_wins(self) -> Missing | int:
  """
  clan's war wins
 
@@ -220,7 +220,7 @@ class Clan(BaseClan):
  ...
 
  @property
- def war_ties(self) -> int:
+ def war_ties(self) -> Missing | int:
  """
  clan's war ties
 
@@ -230,7 +230,7 @@ class Clan(BaseClan):
  ...
 
  @property
- def war_losses(self) -> int:
+ def war_losses(self) -> Missing | int:
  """
  clan's war losses
 
@@ -250,7 +250,7 @@ class Clan(BaseClan):
  ...
 
  @property
- def chat_language(self) -> Language:
+ def chat_language(self) -> Missing | Language:
  """
  clan's chat language
 
@@ -290,7 +290,7 @@ class Clan(BaseClan):
  ...
 
  @property
- def location(self) -> Location:
+ def location(self) -> Missing | Location:
  """
  clan's location
 
@@ -320,7 +320,7 @@ class Clan(BaseClan):
  ...
 
  @property
- def description(self) -> str:
+ def description(self) -> Missing | str:
  """
  clan's description
 
@@ -330,7 +330,7 @@ class Clan(BaseClan):
  ...
 
  @property
- def clan_capital(self) -> ClanCapital:
+ def clan_capital(self) -> Missing | ClanCapital:
  """
  clan's capital
 

pyclasher/models/ClanCapitalRaidSeasons.pyi

@@ -1,5 +1,6 @@
 from typing import Iterator
 
+from ..Exceptions import Missing
 from .BaseModels import BaseModel, IterBaseModel, BaseClanMember, BaseClan, Time
 
 
@@ -526,7 +527,7 @@ class ClanCapitalRaidSeason(BaseModel):
  ...
 
  @property
- def members(self) -> ClanCapitalRaidSeasonMemberList:
+ def members(self) -> Missing | ClanCapitalRaidSeasonMemberList:
  """
  member list
 

pyclasher/models/ClanMember.pyi

@@ -1,3 +1,4 @@
+from ..Exceptions import Missing
 from .BaseModels import BaseClanMember
 from .Enums import ClanRole
 from .Leagues import League, BuilderBaseLeague
@@ -110,7 +111,7 @@ class ClanMember(BaseClanMember):
  ...
 
  @property
- def player_house(self) -> PlayerHouse:
+ def player_house(self) -> Missing | PlayerHouse:
  """
  player house
 

pyclasher/models/Enums.py

@@ -606,6 +606,7 @@ class ClanWarResult(Enum):
  LOSE = "lose"
  WIN = "win"
  TIE = "tie"
+ NONE = None
 
 
 class ClanRole(Enum):

pyclasher/models/Enums.pyi

@@ -32,7 +32,7 @@ class ApiCodes(Enum):
  def from_exception(cls,
  code: int,
  response_json: dict
- ) -> ApiCode:
+ ) -> ApiCodes:
  """
  class method that allows to initialise ApiCodes with a failed request response
 
@@ -510,6 +510,7 @@ class ClanWarResult(Enum):
  LOSE = "lose"
  WIN = "win"
  TIE = "tie"
+ NONE = None
 
 
 class ClanRole(Enum):

pyclasher/models/Player.py

@@ -154,14 +154,6 @@ def attack_wins(self):
  def defense_wins(self):
  return self._get_data('defenseWins')
 
- @property
- def versus_trophies(self):
- return self._get_data('versusTrophies')
-
- @property
- def best_versus_trophies(self):
- return self._get_data('bestVersusTrophies')
-
  @property
  def town_hall_level(self):
  return self._get_data('townHallLevel')

pyclasher/models/Player.pyi

@@ -1,5 +1,6 @@
 from typing import Iterator
 
+from ..Exceptions import Missing
 from .BaseModels import BaseModel, IterBaseModel, BaseClan
 from .Enums import ClanRole, WarPreference, Village
 from .Labels import LabelList
@@ -175,7 +176,7 @@ class PlayerAchievementProgressList(IterBaseModel):
 
 class Player(BaseModel):
  @property
- def league(self) -> League:
+ def league(self) -> Missing | League:
  ...
 
  @property
@@ -202,14 +203,6 @@ class Player(BaseModel):
  def defense_wins(self) -> int:
  ...
 
- @property
- def versus_trophies(self) -> int:
- ...
-
- @property
- def best_versus_trophies(self) -> int:
- ...
-
  @property
  def town_hall_level(self) -> int:
  ...

pyclasher/models/__init__.py

@@ -24,7 +24,7 @@
 from .ClanWarLog import ClanWarLogEntry, ClanWarLog
 from .Enums import ApiCodes, ClanType, WarFrequency, Locations, Leagues, CapitalLeagues, \
  BuilderBaseLeagues, WarLeagues, Labels, Languages, ClanWarState, ClanWarLeagueGroupState, \
- ClanWarResult, WarPreference, PlayerHouseElementType, Village, TokenStatus
+ ClanWarResult, WarPreference, PlayerHouseElementType, Village, TokenStatus, ClanRole
 # gold pass season
 from .GoldPassSeason import GoldPassSeason
 # labels

pyclasher/requests/ClanLabels.pyi

@@ -8,6 +8,9 @@ class ClanLabelsRequest(IterRequestModel):
  _iter_rtype = Label
  _list_rtype = LabelList
 
+ def __init__(self) -> None:
+ ...
+
  @property
  def items(self) -> _list_rtype:
  ...

pyclasher/requests/ClanSearch.py

@@ -11,7 +11,7 @@ class ClanSearchRequest(IterRequestModel):
  change in the future releases of the API.
  """
 
- name = None
+ clan_name = None
  _iter_rtype = Clan
  _list_rtype = ClanList
 
@@ -48,7 +48,7 @@ def __init__(self, name=None, war_frequency=None, location=None, min_members=Non
  :type before: str
  """
 
- self.name = name
+ self.clan_name = name
  IterRequestModel.__init__(self, "clans",
  kwargs={
  'name': name,
@@ -60,5 +60,5 @@ def __init__(self, name=None, war_frequency=None, location=None, min_members=Non
  'minClanLevel': min_clan_level,
  'labelIds': ",".join((label.value.id for label in label_ids)) if label_ids is not None else None,
  'limit': limit, 'after': after, 'before': before})
- self._main_attribute = self.name
+ self._main_attribute = self.clan_name
  return