Merge pull request #40 from Jylpah/dev

version 1.2.11: default_path() method for Maps and WGApiWoTBlitzTankopedia to access the packaged maps/tankopedia

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "blitz-models"
-version = "1.2.10"
+version = "1.2.11"
 authors = [{ name = "Jylpah", email = "[email protected]" }]
 description = "Pydantic models for Wargaming's World of Tanks Blitz game "
 readme = "README.md"

src/blitzmodels/map.py

@@ -167,15 +167,22 @@ def load_yaml(cls, yaml_doc: str) -> Self | None:
         return None
 
     @classmethod
-    async def open_default(cls) -> Optional[Self]:
+    def default_path(cls) -> Path:
         """
-        Open maps shipped with the package
+        Return Path of the Tankopedia shipped with the package
         """
         packaged_maps: Traversable = importlib.resources.files("blitzmodels").joinpath(
             "maps.json"
         )  # REFACTOR in Python 3.12
         with as_file(packaged_maps) as maps_fn:
-            return await cls.open_json(maps_fn)
+            return maps_fn
+
+    @classmethod
+    async def open_default(cls) -> Optional[Self]:
+        """
+        Open maps shipped with the package
+        """
+        return await cls.open_json(cls.default_path())
 
     def get_by_key(self, key: str) -> Map | None:
         """A brute-force map search by key"""

src/blitzmodels/wg_api.py

@@ -23,6 +23,7 @@
     field_serializer,
     Field,
 )
+from pathlib import Path
 from importlib.resources.abc import Traversable
 from importlib.resources import as_file
 import importlib
@@ -710,15 +711,22 @@ def _validate_code(self) -> Self:
         return self
 
     @classmethod
-    async def open_default(cls) -> Optional[Self]:
+    def default_path(cls) -> Path:
         """
-        Open Tankopedia shipped with the package
+        Return Path of the Tankopedia shipped with the package
         """
         packaged_tankopedia: Traversable = importlib.resources.files(
             "blitzmodels"
         ).joinpath("tanks.json")  # REFACTOR in Python 3.12
         with as_file(packaged_tankopedia) as tankopedia_fn:
-            return await cls.open_json(tankopedia_fn)
+            return tankopedia_fn
+
+    @classmethod
+    async def open_default(cls) -> Optional[Self]:
+        """
+        Open Tankopedia shipped with the package
+        """
+        return await cls.open_json(cls.default_path())
 
     def __len__(self) -> int:
         return len(self.data)