review fixes part 2

Author: doluk

coc/__init__.py

@@ -35,7 +35,7 @@
     ACHIEVEMENT_ORDER,
     BUILDER_TROOPS_ORDER,
     HERO_ORDER,
-    HERO_PETS_ORDER,
+    PETS_ORDER,
     HOME_TROOP_ORDER,
     SIEGE_MACHINE_ORDER,
     SPELL_ORDER,

coc/abc.py

@@ -25,7 +25,7 @@
 from pathlib import Path
 from typing import AsyncIterator, Any, Dict, Type, Optional, TYPE_CHECKING
 
-from .enums import Resource
+from .enums import PETS_ORDER, Resource
 from .miscmodels import try_enum, Badge, TimeDelta
 from .iterators import PlayerIterator
 from .utils import CaseInsensitiveDict, UnitStat, _get_maybe_first
@@ -204,7 +204,7 @@ def _load_json_meta(cls, troop_meta, id, name, lab_to_townhall):
             cls.is_elixir_spell = True
         elif production_building == "Mini Spell Factory":
             cls.is_dark_spell = True
-        elif name in coc.HERO_PETS_ORDER:
+        elif name in PETS_ORDER:
             production_building = "Pet Shop"
 
         # load buildings

coc/enums.py

@@ -149,7 +149,7 @@ class Resource(Enum):
 
 HERO_ORDER = ["Barbarian King", "Archer Queen", "Grand Warden", "Royal Champion", "Battle Machine"]
 
-HERO_PETS_ORDER = [
+PETS_ORDER = [
     "L.A.S.S.I",
     "Electro Owl",
     "Mighty Yak",

coc/players.py

@@ -35,7 +35,7 @@
     UNRANKED_LEAGUE_DATA,
     ACHIEVEMENT_ORDER,
     SUPER_TROOP_ORDER,
-    HERO_PETS_ORDER,
+    PETS_ORDER,
 )
 from .abc import BasePlayer
 from .hero import Hero, Pet
@@ -237,6 +237,7 @@ class Player(ClanMember):
         "war_opted_in",
         "_achievements",
         "_heroes",
+        "_pets",
         "_labels",
         "_spells",
         "_home_troops",
@@ -262,7 +263,7 @@ class Player(ClanMember):
         "_cs_home_troops",
         "_cs_builder_troops",
         "_cs_siege_machines",
-        "_cs_hero_pets",
+        "_cs_pets",
         "_cs_super_troops",
         "_cs_heroes",
         "_cs_spells",
@@ -281,6 +282,7 @@ def __init__(self, *, data, client, load_game_data=None, **_):
         self._home_troops: dict = {}
         self._builder_troops: dict = {}
         self._super_troops: list = []
+        self._pets = None # type: Optional[dict]
 
         self.achievement_cls = Achievement
         self.hero_cls = Hero
@@ -335,7 +337,7 @@ def _from_data(self, data: dict) -> None:
         if self._game_files_loaded:
             pet_lookup = [p.name for p in self._client._pet_holder.items]
         else:
-            pet_lookup = HERO_PETS_ORDER
+            pet_lookup = PETS_ORDER
 
         self._iter_labels = (label_cls(data=ldata, client=self._client) for ldata in data_get("labels", []))
         self._iter_achievements = (achievement_cls(data=adata) for adata in data_get("achievements", []))
@@ -400,11 +402,12 @@ def load_game_data(self):
         # if self._game_files_loaded:
         #     return True
 
-        holders = (self._client._troop_holder, self._client._hero_holder, self._client._spell_holder)
+        holders = (self._client._troop_holder, self._client._hero_holder, self._client._spell_holder,
+                   self._client._pet_holder)
         if not all(holder.loaded for holder in holders):
             self._client._load_holders()
 
-        for items, holder in zip((self.troops, self.heroes, self.spells), holders):
+        for items, holder in zip((self.troops, self.heroes, self.spells, self.pets), holders):
             for item in items:
                 if not item.is_loaded:
                     if isinstance(item, Troop):
@@ -435,7 +438,7 @@ def achievements(self) -> List[Achievement]:
         return list(sorted_achievements.values())
 
     def get_achievement(self, name: str, default_value=None) -> Optional[Achievement]:
-        """Returns an achievement with the given name.
+        """Gets an achievement with the given name.
 
         Parameters
         -----------
@@ -544,18 +547,42 @@ def siege_machines(self) -> List[Troop]:
         troops = (t for t in self.troops if t.name in SIEGE_MACHINE_ORDER or t.is_siege_machine)
         return list(sorted(troops, key=lambda t: order.get(t.name, 0)))
 
-    @cached_property("_cs_hero_pets")
-    def hero_pets(self) -> List[Pet]:
+    @cached_property("_cs_pets")
+    def pets(self) -> List[Pet]:
         """List[:class:`Pet`]: A :class:`List` of the player's hero pets.
 
         This will return hero pets in the order found in the Pet House in-game.
 
         This includes:
         - Hero pets only.
         """
-        order = {k: v for v, k in enumerate(HERO_PETS_ORDER)}
+        order = {k: v for v, k in enumerate(PETS_ORDER)}
         return list(sorted(self._iter_pets, key=lambda t: order.get(t.name, 0)))
 
+    def get_pet(self, name: str, default_value=None) -> Optional[Pet]:
+        """Gets the pet with the given name.
+
+        Parameters
+        -----------
+        name: :class:`str`
+            The name of a pet as found in-game.
+        default_value:
+            The default value to return if a pet with ``name`` is not found. Defaults to ``None``.
+
+        Returns
+        --------
+        Optional[:class:`Pet`]
+            The returned pet or the ``default_value`` if not found, which defaults to ``None``.
+
+        """
+        if not self._pets:
+            _ = self._pets
+
+        try:
+            return self._pets[name]
+        except KeyError:
+            return default_value
+
     @cached_property("_cs_super_troops")
     def super_troops(self) -> List[Troop]:
         """List[:class:`Troop`]: A :class:`List` of the player's super troops.
@@ -573,7 +600,7 @@ def super_troops(self) -> List[Troop]:
         return list(sorted(self._super_troops, key=lambda t: order.get(t.name, 0)))
 
     def get_troop(self, name: str, is_home_troop=None, default_value=None) -> Optional[Troop]:
-        """Returns a troop with the given name.
+        """Gets a troop with the given name.
 
         Parameters
         -----------
@@ -626,16 +653,19 @@ def heroes(self) -> List[Hero]:
         return list(sorted_heroes.values())
 
     def get_hero(self, name: str, default_value=None) -> Optional[Hero]:
-        """
-        Gets the player
+        """Gets the hero with the given name.
+
         Parameters
-        ----------
-        name
-        default_value
+        -----------
+        name: :class:`str`
+            The name of a hero as found in-game.
+        default_value:
+            The default value to return if a hero with ``name`` is not found. Defaults to ``None``.
 
         Returns
-        -------
-        Hero
+        --------
+        Optional[:class:`Hero`]
+            The returned hero or the ``default_value`` if not found, which defaults to ``None``.
 
         """
         if not self._heroes:
@@ -661,7 +691,7 @@ def spells(self) -> List[Spell]:
                     key=lambda s: order.get(s.name, 0)))
 
     def get_spell(self, name: str, default_value=None) -> Optional[Spell]:
-        """Returns a spell with the given name.
+        """Gets the spell with the given name.
 
         Parameters
         -----------

coc/raid.py

@@ -103,7 +103,7 @@ def _from_data(self, data):
     @property
     def attacks(self):
         """List[:class:`RaidAttack`]: The member's attacks in this raid log entry.
-        Can be empty due to missing parts in the api response
+        Can be empty due to missing parts in the API response.
         """
         list_attacks = self._attacks  # type: List[RaidAttack]
         if list_attacks:
@@ -146,7 +146,8 @@ class RaidAttack:
                  "destruction",
                  "stars",
                  "_client",
-                 "_raw_data")
+                 "_raw_data",
+                 )
 
     def __repr__(self):
         attrs = [
@@ -155,7 +156,7 @@ def __repr__(self):
             ("district", repr(self.district)),
             ("attacker_tag", self.attacker_tag),
             ("destruction", self.destruction),
-            ("stars", self.stars)
+            ("stars", self.stars),
         ]
         return "<%s %s>" % (self.__class__.__name__, " ".join("%s=%r" % t for t in attrs),)
 

coc/utils.py

@@ -370,7 +370,7 @@ def get_season_end(month: Optional[int] = None, year: Optional[int] = None) -> d
 def get_raid_weekend_start(time: Optional[datetime] = None) -> datetime:
     """Get the datetime that the raid weekend will start.
 
-    This goes by the assumption that raid weekends start at friday 7 UTC.
+    This goes by the assumption that raid weekends start at Friday 7 am UTC.
 
     .. note::
 
@@ -398,7 +398,7 @@ def get_raid_weekend_start(time: Optional[datetime] = None) -> datetime:
 def get_raid_weekend_end(time: Optional[datetime] = None) -> datetime:
     """Get the datetime that the raid weekend will end.
 
-    This goes by the assumption that raid weekends end at monday 7 UTC.
+    This goes by the assumption that raid weekends end at Monday 7 am UTC.
 
     .. note::
 

docs/conf.py

@@ -13,8 +13,8 @@
 sys.path.append((root_project / "docs").as_posix())
 
 project = 'coc'
-copyright = '2022, mathsman'
-author = 'mathsman'
+copyright = '2022, mathsman5133'
+author = 'mathsman5133'
 release = '2.3.0'
 
 # -- General configuration ---------------------------------------------------

docs/models/miscellaneous.rst

@@ -46,35 +46,35 @@ Enumerations
 The library provides some enumerations for certain types of strings, as well as orders for troops, spells and
 achievements that are used internally.
 
-All elixir troops
+All Elixir Troops
 ^^^^^^^^^^^^^^^^^
 ordered as they appear in-game.
 
 .. data:: coc.ELIXIR_TROOP_ORDER
 
 
-All dark elixir troops
+All Dark Elixir Troops
 ^^^^^^^^^^^^^^^^^^^^^^
 ordered as they appear in-game.
 
 .. data:: coc.DARK_ELIXIR_TROOP_ORDER
 
 
-All siege machines
+All Siege Machines
 ^^^^^^^^^^^^^^^^^^
 ordered as they appear in-game.
 
 .. data:: coc.SIEGE_MACHINE_ORDER
 
 
-All super troops
+All Super Troops
 ^^^^^^^^^^^^^^^^
 ordered as they appear in-game.
 
 .. data:: coc.SUPER_TROOP_ORDER
 
 
-All home troops
+All Home Troops
 ^^^^^^^^^^^^^^^
 ordered as they appear in-game.
 
@@ -84,42 +84,42 @@ This does not contain super troops.
 .. data:: coc.HOME_TROOP_ORDER
 
 
-All builder troops
+All Builder Troops
 ^^^^^^^^^^^^^^^^^^
 ordered as they appear in-game.
 
 .. data:: coc.BUILDER_TROOPS_ORDER
 
 
-All elixir spells
+All Elixir Spells
 ^^^^^^^^^^^^^^^^^
 ordered as they appear in-game.
 
 .. data:: coc.ELIXIR_SPELL_ORDER
 
 
-All dark elixir spells
+All Dark Elixir Spells
 ^^^^^^^^^^^^^^^^^^^^^^
 ordered as they appear in-game.
 
 .. data:: coc.DARK_ELIXIR_SPELL_ORDER
 
 
-All spells
+All Spells
 ^^^^^^^^^^
 ordered as they appear in-game.
 
 .. data:: coc.SPELL_ORDER
 
 
-All heroes
+All Heroes
 ^^^^^^^^^^
 ordered as they appear in-game.
 
 .. data:: coc.HERO_ORDER
 
 
-All hero pets
+All Pets
 ^^^^^^^^^^^^^^
 ordered as they appear in-game.
 

pyproject.toml

@@ -30,7 +30,7 @@ docs = ["sphinx",
 ]
 
 [tool.setuptools]
-packages = ["coc", "coc.ext.discordlinks", "coc.static"]
+packages = ["coc", "coc.ext.discordlinks", "coc.static", "coc.ext.fullwarapi"]
 include-package-data = true
 
 [tool.setuptools.package-data]