New features

.github/workflows/pull_request.yml

@@ -10,7 +10,7 @@ jobs:
  strategy:
  fail-fast: false
  matrix:
- python-version: ["3.11", "3.10", "3.9", "3.8"]
+ python-version: ["3.11", "3.10"]
 
  steps:
  - uses: actions/checkout@v3

README.md

@@ -38,7 +38,7 @@ password of the ClashOfClans developer portal
  - Control over the number of requests per second and the number of used tokens
  - Open source
  - Type hinted
- - Sopports Python 3.8 -> 3.11
+ - Supports Python 3.8 -> 3.11
 
 ---
 
@@ -58,7 +58,6 @@ I'm planning to keep the API wrapper up to date and improve it as good as I can.
 ### Planned features
 
 - more bulk requests
-- pytests for the models
 - events
 
 ### Planned utils

pyclasher/api/bulk_requests/__init__.py

@@ -1,5 +1,5 @@
 from .b_player import PlayerBulkRequest
-from .b_request_model import BulkRequestModel
+from .abc import BulkRequestModel
 
 __all__ = (
  "PlayerBulkRequest",

pyclasher/api/bulk_requests/b_request_model.py → pyclasher/api/bulk_requests/abc.py

@@ -3,7 +3,6 @@
 
 class BulkRequestModel:
  _request_model = ...
- _main_attribute = None
  _requests = None
 
  @property
@@ -21,19 +20,11 @@ def __get_properties(self):
  if isinstance(prop, property)
  }
 
- async def _async_request(self):
- self._tasks = [request.request() for request in self._requests]
+ async def request(self, client_id=None):
+ self._tasks = [request.request(client_id) for request in self._requests]
  await gather(*self._tasks)
  return self
 
- def request(self):
- try:
- get_running_loop()
- except RuntimeError:
- return run(self._async_request())
- else:
- return self._async_request()
-
  def __len__(self):
  return len(self._requests)
 
@@ -54,7 +45,7 @@ def __next__(self):
  return next(self._iter)
 
  def __str__(self):
- return f"{self.__class__.__name__}({self._main_attribute})"
+ return f"{self.__class__.__name__}()"
 
  def __repr__(self):
  props = ', '.join(

pyclasher/api/bulk_requests/b_request_model.pyi → pyclasher/api/bulk_requests/abc.pyi

@@ -9,14 +9,11 @@ class BulkRequestModel:
 
  :cvar _request_model: the request model that is used to make the bulk request
  :type _request_model: Any
- :cvar _main_attribute: the main attribute used for the string representation (default is None)
- :type _main_attribute: Any
  :cvar _requests: list of requests
  :type _requests: list
  """
 
  _request_model: Any = ...
- _main_attribute: Any = None
  _requests: list = None
 
  @property
@@ -52,26 +49,14 @@ class BulkRequestModel:
  """
  ...
 
- async def _async_request(self) -> BulkRequestModel:
+ async def request(self, client_id: int | str = None) -> BulkRequestModel:
  """
  asynchronous method that executes the requests
 
  :return: the instance of the bulk request model
  :rtype: BulkRequestModel
  """
- self._tasks = [request.request() for request in self._requests]
- ...
-
- def request(self) -> BulkRequestModel | Coroutine[Any, Any, BulkRequestModel]:
- """
- method that executes the request
-
- this method can be used in an asynchronous context using the ``await`` keyword
- but can also be used in non-asynchronous context without awaiting the method
-
- :return: the instance of the model
- :rtype: BulkRequestModel | Coroutine[Any, Any, BulkRequestModel]
- """
+ self._tasks = [request.request(client_id) for request in self._requests]
  ...
 
  def __len__(self) -> int:

pyclasher/api/bulk_requests/b_player.py

@@ -1,6 +1,6 @@
 from asyncio import get_running_loop, run
 
-from .b_request_model import BulkRequestModel
+from .abc import BulkRequestModel
 from ..models import BaseClan
 from ..models import Clan
 from ..requests import PlayerRequest, ClanMembersRequest
@@ -13,32 +13,22 @@ class PlayerBulkRequest(BulkRequestModel):
  def __init__(self, tags):
  self._tags = tags
  self._requests = list(self._request_model(tag) for tag in self.tags)
- self._main_attribute = self.tags
  return
 
  @property
  def tags(self):
  return self._tags
 
  @classmethod
- async def _async_from_clan(cls, clan):
+ async def from_clan(cls, clan, client_id=None):
  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()
+ members = await ClanMembersRequest(clan.tag).request(client_id)
  else:
- members = await ClanMembersRequest(clan).request()
+ members = await ClanMembersRequest(clan).request(client_id)
  return cls.from_member_list(members)
 
- @classmethod
- def from_clan(cls, clan):
- try:
- get_running_loop()
- except RuntimeError:
- return run(cls._async_from_clan(clan))
- else:
- return cls._async_from_clan(clan)
-
  @classmethod
  def from_member_list(cls, member_list):
  return cls((member.tag for member in member_list))

pyclasher/api/bulk_requests/b_player.pyi

@@ -1,6 +1,6 @@
 from typing import Iterable, Coroutine, Any, Iterator
 
-from .b_request_model import BulkRequestModel
+from .abc import BulkRequestModel
 from ..models import BaseClan, ClanMemberList, ClanWarMemberList, \
  ClanWarLeagueClanMemberList, \
  ClanCapitalRaidSeasonMemberList
@@ -43,13 +43,13 @@ class PlayerBulkRequest(BulkRequestModel):
  ...
 
  @classmethod
- def from_clan(cls, clan: BaseClan | str) -> PlayerBulkRequest | Coroutine[Any, Any, PlayerBulkRequest]:
+ async def from_clan(cls, clan: BaseClan | str, client_id: int | str = None) -> PlayerBulkRequest:
  """
  class method to create an instance using a clan or a clan tag
 
  :param cls: PlayerBulkRequest
  :param clan: clan or clan tag
- :rtype: PlayerBulkRequest | Coroutine[Any, Any, PlayerBulkRequest]
+ :rtype: PlayerBulkRequest
  """
  ...
 

pyclasher/api/models/base_models.py

@@ -41,7 +41,6 @@ class IconUrl(ImageUrl):
 class IconUrls(BaseModel):
  def __init__(self, data: dict):
  super().__init__(data)
- self._main_attribute = self.small
  return
 
  @property

pyclasher/api/models/clan.py

@@ -11,7 +11,6 @@
 class ClanDistrictData(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.id
  return
 
  @property
@@ -34,7 +33,6 @@ class ClanDistrictDataList(IterBaseModel):
 class ClanCapital(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.capital_hall_level
  return
 
  @property

pyclasher/api/models/clan_capital_raid_seasons.py

@@ -5,7 +5,6 @@
 class ClanCapitalRaidSeasonClanInfo(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.tag
  return
 
  @property
@@ -28,7 +27,6 @@ def badge_urls(self):
 class ClanCapitalRaidSeasonAttacker(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.tag
  return
 
  @property
@@ -43,7 +41,6 @@ def name(self):
 class ClanCapitalRaidSeasonAttack(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.destruction_percent
  return
 
  @property
@@ -66,7 +63,6 @@ class ClanCapitalRaidSeasonAttackList(IterBaseModel):
 class ClanCapitalRaidSeasonDistrict(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.name
  return
 
  @property
@@ -192,7 +188,6 @@ def average_resources_looted(self):
 class ClanCapitalRaidSeason(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.raids_completed
  return
 
  @property

pyclasher/api/models/clan_war_league_group.py

@@ -38,7 +38,6 @@ def __next__(self):
 class ClanWarLeagueClan(BaseClan):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.tag
  return
 
  @property
@@ -63,7 +62,6 @@ def __next__(self):
 class ClanWarLeagueGroup(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.tag
  return
 
  @property

pyclasher/api/models/labels.py

@@ -5,7 +5,6 @@
 class Label(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.id
  return
 
  @property

pyclasher/api/models/language.py

@@ -4,7 +4,6 @@
 class Language(BaseModel):
  def __init__(self, data: dict):
  super().__init__(data)
- self._main_attribute = self.id
  return
 
  @property

pyclasher/api/models/leagues.py

@@ -45,7 +45,6 @@ class WarLeagueList(IterBaseModel):
 class LeagueSeason(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.id
  return
 
  @property

pyclasher/api/models/location.py

@@ -4,7 +4,6 @@
 class Location(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.id if data is not None else None
  return
 
  @property

pyclasher/api/models/login/login_models.py

@@ -22,7 +22,6 @@ def detail(self):
 class Auth(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.uid
  return
 
  @property

pyclasher/api/models/misc/api.py

@@ -4,7 +4,6 @@
 class ClientError(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.reason
  return
 
  @property
@@ -29,7 +28,6 @@ class Replay(BaseModel):
 
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.replay_tag
  return
 
  @property
@@ -46,7 +44,6 @@ class ServiceVersion(BaseModel):
 
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = (self.major, self.minor)
  return
 
  @property

pyclasher/api/models/misc/responses.py

@@ -5,7 +5,6 @@
 class VerifyTokenResponse(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.tag
  return
 
  @property
@@ -24,7 +23,6 @@ def status(self):
 class DeepLinkCreationResponse(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.link
  return
 
  @property

pyclasher/api/models/misc/war_status.py

@@ -6,7 +6,6 @@
 class WarStatus(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.clan_tag
  return
 
  @property

pyclasher/api/models/player.py

@@ -15,7 +15,6 @@ def clan_level(self):
 class LegendLeagueTournamentSeasonResult(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.id
  return
 
  @property
@@ -136,7 +135,6 @@ class PlayerAchievementProgressList(IterBaseModel):
 class Player(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.tag
  return
 
  @property

pyclasher/api/models/player_house.py

@@ -5,7 +5,6 @@
 class PlayerHouseElement(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.id
  return
 
  @property

pyclasher/api/models/war_clan.py

@@ -5,7 +5,6 @@
 class ClanWarAttack(BaseModel):
  def __init__(self, data):
  super().__init__(data)
- self._main_attribute = self.attacker_tag
  return
 
  @property

pyclasher/api/requests/abc.py

@@ -17,7 +17,6 @@ class for requesting
  """
 
  _data = MISSING
- _main_attribute = None
  _url = None
  _url_kwargs = None
  _len = None

pyclasher/api/requests/abc.pyi

@@ -11,7 +11,6 @@ request_id: int = 0
 
 class RequestModel(ABC):
  _data: dict = MISSING
- _main_attribute: Any = None
  _url: str = None
  _url_kwargs: dict | None = None
  _len: int = None