Rewrite League and BaseLeague, fix Player.get_pet()

Author: doluk

coc/__init__.py

@@ -77,8 +77,7 @@
     Timestamp,
     TimeDelta,
     Label,
-    WarLeague,
-    BuilderBaseLeague
+    BaseLeague
 )
 from .players import Player, ClanMember, RankedPlayer
 from .player_clan import PlayerClan

coc/clans.py

@@ -25,7 +25,7 @@
 
 
 from .players import ClanMember
-from .miscmodels import try_enum, ChatLanguage, Location, Label, WarLeague, CapitalDistrict
+from .miscmodels import try_enum, ChatLanguage, Location, Label, BaseLeague, CapitalDistrict
 from .utils import get, cached_property, correct_tag
 from .abc import BaseClan
 
@@ -149,9 +149,9 @@ class Clan(BaseClan):
         The type which the clan capital districts found in
         :attr:`Clan.capital_districts` will be of. Ensure any overriding of
         this inherits from :class:`coc.CapitalDistrict`.
-    war_league: :class:`coc.WarLeague`
+    war_league: :class:`coc.BaseLeague`
         The clan's CWL league.
-    capital_league: :class:`coc.WarLeague`
+    capital_league: :class:`coc.BaseLeague`
         The clan's Clan Capital league.
     """
 
@@ -222,8 +222,8 @@ def _from_data(self, data: dict) -> None:
         self.war_losses: int = data_get("warLosses", -1)
         self.public_war_log: bool = data_get("isWarLogPublic")
         self.description: str = data_get("description")
-        self.war_league = try_enum(WarLeague, data=data_get("warLeague"))
-        self.capital_league = try_enum(WarLeague, data=data_get("capitalLeague"))
+        self.war_league = try_enum(BaseLeague, data=data_get("warLeague"))
+        self.capital_league = try_enum(BaseLeague, data=data_get("capitalLeague"))
         self.chat_language = try_enum(ChatLanguage, data=data_get("chatLanguage"))
         self.required_townhall = data_get("requiredTownhallLevel")
 

coc/client.py

@@ -34,7 +34,7 @@
 from .clans import Clan, RankedClan
 from .errors import Forbidden, GatewayError, NotFound, PrivateWarLog
 from .enums import WarRound
-from .miscmodels import GoldPassSeason, Label, League, Location, LoadGameData
+from .miscmodels import BaseLeague, GoldPassSeason, Label, League, Location, LoadGameData
 from .hero import HeroHolder, PetHolder
 from .http import HTTPClient, BasicThrottler, BatchThrottler
 from .iterators import (
@@ -1614,7 +1614,8 @@ async def get_league_named(self, league_name: str) -> Optional[League]:
         """
         return get(await self.search_leagues(), name=league_name)
 
-    async def search_builder_base_leagues(self, *, limit: int = None, before: str = None, after: str = None) -> List[League]:
+    async def search_builder_base_leagues(self, *, limit: int = None, before: str = None, after: str = None)-> List[
+        BaseLeague]:
         """Get list of builder base leagues.
 
         Parameters
@@ -1638,13 +1639,13 @@ async def search_builder_base_leagues(self, *, limit: int = None, before: str =
 
         Returns
         --------
-        List[:class:`League`]
+        List[:class:`BaseLeague`]
             The requested leagues.
         """
         data = await self.http.search_builder_base_leagues(limit=limit, before=before, after=after)
-        return [League(data=n, client=self) for n in data["items"]]
+        return [BaseLeague(data=n, client=self) for n in data["items"]]
 
-    async def get_builder_base_league(self, league_id: int) -> League:
+    async def get_builder_base_league(self, league_id: int) -> BaseLeague:
         """
         Get builder base league information
 
@@ -1667,13 +1668,13 @@ async def get_builder_base_league(self, league_id: int) -> League:
 
         Returns
         --------
-        :class:`League`
+        :class:`BaseLeague`
             The league with the requested ID
         """
         data = await self.http.get_builder_base_league(league_id)
-        return League(data=data, client=self)
+        return BaseLeague(data=data, client=self)
 
-    async def get_builder_base_league_named(self, league_name: str) -> Optional[League]:
+    async def get_builder_base_league_named(self, league_name: str) -> Optional[BaseLeague]:
         """Get a builder base league by name.
 
         This is somewhat equivalent to
@@ -1699,12 +1700,12 @@ async def get_builder_base_league_named(self, league_name: str) -> Optional[Leag
 
         Returns
         --------
-        :class:`League`
+        :class:`BaseLeague`
             The first league matching the league name. Could be ``None`` if not found.
         """
         return get(await self.search_builder_base_leagues(), name=league_name)
 
-    async def search_war_leagues(self, *, limit: int = None, before: str = None, after: str = None) -> List[League]:
+    async def search_war_leagues(self, *, limit: int = None, before: str = None, after: str = None) -> List[BaseLeague]:
         """Get list of war leagues.
 
         Parameters
@@ -1728,13 +1729,13 @@ async def search_war_leagues(self, *, limit: int = None, before: str = None, aft
 
         Returns
         --------
-        List[:class:`League`]
+        List[:class:`BaseLeague`]
             The requested leagues.
         """
         data = await self.http.search_war_leagues(limit=limit, before=before, after=after)
-        return [League(data=n, client=self) for n in data["items"]]
+        return [BaseLeague(data=n, client=self) for n in data["items"]]
 
-    async def get_war_league(self, league_id: int) -> League:
+    async def get_war_league(self, league_id: int) -> BaseLeague:
         """
         Get war league information
 
@@ -1757,13 +1758,13 @@ async def get_war_league(self, league_id: int) -> League:
 
         Returns
         --------
-        :class:`League`
+        :class:`BaseLeague`
             The league with the requested ID
         """
         data = await self.http.get_war_league(league_id)
-        return League(data=data, client=self)
+        return BaseLeague(data=data, client=self)
 
-    async def get_war_league_named(self, league_name: str) -> Optional[League]:
+    async def get_war_league_named(self, league_name: str) -> Optional[BaseLeague]:
         """Get a war league by name.
 
         This is somewhat equivalent to
@@ -1789,12 +1790,12 @@ async def get_war_league_named(self, league_name: str) -> Optional[League]:
 
         Returns
         --------
-        :class:`League`
+        :class:`BaseLeague`
             The first league matching the league name. Could be ``None`` if not found.
         """
         return get(await self.search_war_leagues(), name=league_name)
 
-    async def search_capital_leagues(self, *, limit: int = None, before: str = None, after: str = None) -> List[League]:
+    async def search_capital_leagues(self, *, limit: int = None, before: str = None, after: str = None) -> List[BaseLeague]:
         """Get list of capital leagues.
 
         Parameters
@@ -1818,13 +1819,13 @@ async def search_capital_leagues(self, *, limit: int = None, before: str = None,
 
         Returns
         --------
-        List[:class:`League`]
+        List[:class:`BaseLeague`]
             The requested leagues.
         """
         data = await self.http.search_capital_leagues(limit=limit, before=before, after=after)
-        return [League(data=n, client=self) for n in data["items"]]
+        return [BaseLeague(data=n, client=self) for n in data["items"]]
 
-    async def get_capital_league(self, league_id: int) -> League:
+    async def get_capital_league(self, league_id: int) -> BaseLeague:
         """
         Get capital league information
 
@@ -1847,13 +1848,13 @@ async def get_capital_league(self, league_id: int) -> League:
 
         Returns
         --------
-        :class:`League`
+        :class:`BaseLeague`
             The league with the requested ID
         """
         data = await self.http.get_capital_league(league_id)
-        return League(data=data, client=self)
+        return BaseLeague(data=data, client=self)
 
-    async def get_capital_league_named(self, league_name: str) -> Optional[League]:
+    async def get_capital_league_named(self, league_name: str) -> Optional[BaseLeague]:
         """Get a capital league by name.
 
         This is somewhat equivalent to
@@ -1879,7 +1880,7 @@ async def get_capital_league_named(self, league_name: str) -> Optional[League]:
 
         Returns
         --------
-        :class:`League`
+        :class:`BaseLeague`
             The first league matching the league name. Could be ``None`` if not found.
         """
         return get(await self.search_capital_leagues(), name=league_name)

coc/miscmodels.py

@@ -242,7 +242,37 @@ def _from_data(self, data: dict) -> None:
         self.localised_name: str = data_get("localizedName")
 
 
-class League:
+class BaseLeague:
+    """Represents a basic league.
+
+    Attributes
+    -----------
+    id: :class:`int`: The league's unique ID
+    name: :class:`str`: The league's name, as it appears in-game."""
+
+    __slots__ = (
+        "id",
+        "name",
+        "_client"
+    )
+
+    def __init__(self, *, data, client=None):
+        # pylint: disable=invalid-name
+        self.id: int = data["id"]
+        self.name: str = data["name"]
+        self._client = client
+
+    def __repr__(self):
+        return "<%s id=%s name=%s>" % (self.__class__.__name__, self.id, self.name)
+
+    def __str__(self):
+        return self.name
+
+    def __eq__(self, other):
+        return isinstance(self, other.__class__) and other.id == self.id
+
+
+class League(BaseLeague):
     """Represents a Clash of Clans League
 
     Attributes
@@ -251,21 +281,12 @@ class League:
         :class:`int`: The league ID.
     name:
         :class:`str`: The league name.
-    localised_name:
-        :class:`str`: A localised name of the location. The extent of the use of this is unknown at present.
-    localised_short_name:
-        :class:`str`: A localised short name of the location. The extent of the use of this is unknown at present.
     icon:
         :class:`Icon`: The league's icon.
     """
 
     __slots__ = (
-        "id",
-        "name",
-        "localised_short_name",
-        "localised_name",
         "icon",
-        "_client",
     )
 
     def __str__(self):
@@ -279,17 +300,12 @@ def __eq__(self, other):
         return isinstance(other, self.__class__) and self.id == other.id
 
     def __init__(self, *, data, client):
-        self._client = client
+        super().__init__(data=data, client=client)
         self._from_data(data)
 
     def _from_data(self, data: dict) -> None:
         # pylint: disable=invalid-name
         data_get = data.get
-
-        self.id: int = data_get("id")
-        self.name: str = data_get("name")
-        self.localised_name: str = data_get("localizedName")
-        self.localised_short_name: str = data_get("localizedShortName")
         self.icon = try_enum(Icon, data=data_get("iconUrls"), client=self._client)
 
 
@@ -613,63 +629,6 @@ def __init__(self, *, data, client):
         self.hall_level: int = data.get("districtHallLevel")
 
 
-class WarLeague:
-    """Represents a clan's CWL league.
-
-    Attributes
-    -----------
-    id: :class:`int`: The league's unique ID
-    name: :class:`str`: The league's name, as it appears in-game."""
-
-    __slots__ = (
-        "id",
-        "name",
-    )
-
-    def __init__(self, *, data):
-        # pylint: disable=invalid-name
-        self.id: int = data["id"]
-        self.name: str = data["name"]
-
-    def __repr__(self):
-        return "<%s id=%s name=%s>" % (self.__class__.__name__, self.id, self.name)
-
-    def __str__(self):
-        return self.name
-
-    def __eq__(self, other):
-        return isinstance(self, other.__class__) and other.id == self.id
-
-
-class BuilderBaseLeague:
-    """Represents a player's Builder Base league.
-
-    Attributes
-    -----------
-    id: :class:`int`: The league's unique ID
-    name: :class:`str`: The league's name, as it appears in-game."""
-
-    __slots__ = (
-        "id",
-        "name",
-        "_client"
-    )
-
-    def __init__(self, *, data, client=None):
-        # pylint: disable=invalid-name
-        self.id: int = data["id"]
-        self.name: str = data["name"]
-        self._client = client
-
-    def __repr__(self):
-        return "<%s id=%s name=%s>" % (self.__class__.__name__, self.id, self.name)
-
-    def __str__(self):
-        return self.name
-
-    def __eq__(self, other):
-        return isinstance(self, other.__class__) and other.id == self.id
-
 
 class ChatLanguage:
     """Represents a clan's chat language.