ddapi 0.12.2__tar.gz → 0.13.1__tar.gz

{ddapi-0.12.2 → ddapi-0.13.1}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 ByFox
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 ByFox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{ddapi-0.12.2 → ddapi-0.13.1}/PKG-INFO

@@ -1,66 +1,66 @@
-Metadata-Version: 2.4
-Name: ddapi
-Version: 0.12.2
-Summary: DDnet api
-Home-page: https://github.com/ByFox213/ddapi
-Author: ByFox
-License: MIT
-Project-URL: Github, https://github.com/ByFox213/ddapi
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: author
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: requires-python
-Dynamic: summary
-
-ddapi is an api from the ddnet and qwik website
-
-## Installation
-
-```bash
-  pip install ddapi
-```
-
-or
-
-```bash
-  pip install git+https://github.com/ByFox213/ddapi
-```
-
-## Usage/Examples
-
-DDnet
-
-```python
-import asyncio
-
-from ddapi import DDnetApi, DDPlayer
-
-
-async def main():
-    async with DDnetApi() as obj:
-        user: DDPlayer = await obj.player("Cor")
-    if user is not None:
-        text = f"{user.player}: {user.points.points}/{user.points.total}"
-        percent = round(user.points.total / user.points.points * 100)
-        print(f"{text}({percent}%)")
-        # Cor: 32950/32950(100%)
-    else:
-        print("Player not found")
-
-
-asyncio.run(main())
-```
-
-Tested on Python
-| 3.10 | 3.11 | 3.12 |
-|------|------|------|
-| ✅ | ✅ | ✅ |
-
-[other examples](https://github.com/ByFox213/ddapi/tree/main/example)
+Metadata-Version: 2.4
+Name: ddapi
+Version: 0.13.1
+Summary: DDnet api
+Home-page: https://github.com/ByFox213/ddapi
+Author: ByFox
+License: MIT
+Project-URL: Github, https://github.com/ByFox213/ddapi
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-python
+Dynamic: summary
+
+ddapi is an api from the ddnet and qwik website
+
+## Installation
+
+```bash
+  pip install ddapi
+```
+
+or
+
+```bash
+  pip install git+https://github.com/ByFox213/ddapi
+```
+
+## Usage/Examples
+
+DDnet
+
+```python
+import asyncio
+
+from ddapi import DDnetApi, DDPlayer
+
+
+async def main():
+    async with DDnetApi() as obj:
+        user: DDPlayer = await obj.player("Cor")
+    if user is not None:
+        text = f"{user.player}: {user.points.points}/{user.points.total}"
+        percent = round(user.points.total / user.points.points * 100)
+        print(f"{text}({percent}%)")
+        # Cor: 32950/32950(100%)
+    else:
+        print("Player not found")
+
+
+asyncio.run(main())
+```
+
+Tested on Python
+| 3.11 | 3.12 | 3.13 |
+|------|------|------|
+| ✅ | ✅ | ✅ |
+
+[other examples](https://github.com/ByFox213/ddapi/tree/main/example)

{ddapi-0.12.2 → ddapi-0.13.1}/README.md

@@ -1,45 +1,45 @@
-ddapi is an api from the ddnet and qwik website
-
-## Installation
-
-```bash
-  pip install ddapi
-```
-
-or
-
-```bash
-  pip install git+https://github.com/ByFox213/ddapi
-```
-
-## Usage/Examples
-
-DDnet
-
-```python
-import asyncio
-
-from ddapi import DDnetApi, DDPlayer
-
-
-async def main():
-    async with DDnetApi() as obj:
-        user: DDPlayer = await obj.player("Cor")
-    if user is not None:
-        text = f"{user.player}: {user.points.points}/{user.points.total}"
-        percent = round(user.points.total / user.points.points * 100)
-        print(f"{text}({percent}%)")
-        # Cor: 32950/32950(100%)
-    else:
-        print("Player not found")
-
-
-asyncio.run(main())
-```
-
-Tested on Python
-| 3.10 | 3.11 | 3.12 |
-|------|------|------|
-| ✅ | ✅ | ✅ |
-
-[other examples](https://github.com/ByFox213/ddapi/tree/main/example)
+ddapi is an api from the ddnet and qwik website
+
+## Installation
+
+```bash
+  pip install ddapi
+```
+
+or
+
+```bash
+  pip install git+https://github.com/ByFox213/ddapi
+```
+
+## Usage/Examples
+
+DDnet
+
+```python
+import asyncio
+
+from ddapi import DDnetApi, DDPlayer
+
+
+async def main():
+    async with DDnetApi() as obj:
+        user: DDPlayer = await obj.player("Cor")
+    if user is not None:
+        text = f"{user.player}: {user.points.points}/{user.points.total}"
+        percent = round(user.points.total / user.points.points * 100)
+        print(f"{text}({percent}%)")
+        # Cor: 32950/32950(100%)
+    else:
+        print("Player not found")
+
+
+asyncio.run(main())
+```
+
+Tested on Python
+| 3.11 | 3.12 | 3.13 |
+|------|------|------|
+| ✅ | ✅ | ✅ |
+
+[other examples](https://github.com/ByFox213/ddapi/tree/main/example)

{ddapi-0.12.2 → ddapi-0.13.1}/ddapi/ddapi/__init__.py

@@ -1,8 +1,10 @@
-"""the module is made for the convenience of users to download and use"""
-
-from .main import DDnetApi, DDstats, Status
-from .scheme import *  # noqa: F403
-
-__version__ = "0.12.2"
-__author__ = "ByFox"
-__LICENSE__ = "MIT"
+"""the module is made for the convenience of users to download and use"""
+
+from .api import DDnetApi, DDstats, Status
+from .enum import MasterEnum
+from .cache import CacheABC, EmptyCache, MemoryCache
+from .scheme import *  # noqa: F403
+
+__version__ = "0.13.1"
+__author__ = "ByFox"
+__LICENSE__ = "MIT"

ddapi-0.12.2/ddapi/ddapi/api.py → ddapi-0.13.1/ddapi/ddapi/_api.py

@@ -1,90 +1,115 @@
-import asyncio
-from abc import ABC
-from typing import Optional, Type, Any
-
-import aiohttp
-from aiohttp import ClientSession
-
-from ddapi.types import T
-
-try:
-    import orjson
-
-    DEFAULT_JSON_DECODER = orjson.loads
-except ImportError:
-    from aiohttp.typedefs import DEFAULT_JSON_DECODER
-
-
-class API(ABC):
-    def __init__(
-        self,
-        session: ClientSession = None,
-        autoclose: bool = True,
-        json_loads: Any = DEFAULT_JSON_DECODER,
-    ):
-        self.__session = session
-        self.json_loads = json_loads
-        self.autoclose = autoclose
-
-        if self.__session is None:
-            self.__session = aiohttp.ClientSession()
-
-    async def __aenter__(self):
-        if self.__session is None:
-            self.__session = aiohttp.ClientSession()
-        return self
-
-    async def __aexit__(self, _exc_type, _exc_val, _exc_tb):
-        if self.autoclose:
-            await self.close()
-
-    def __del__(self):
-        if self.__session is not None and not self.__session.closed:
-            loop = asyncio.get_event_loop()
-            if loop.is_running():
-                loop.create_task(self.close())
-            else:
-                loop.run_until_complete(self.close())
-
-    async def _get(self, url: str) -> Optional[dict]:
-        """Send a GET request to the given URL and return the response as JSON."""
-        async with self.__session.get(url) as req:
-            return await req.json(loads=self.json_loads) if req.status == 200 else None
-
-    async def _generate_model_instance(
-        self, url: str, model: Type[T], k: Optional[str] = None
-    ) -> Optional[T]:
-        """Generate a model instance from the given URL and optional keyword arguments.
-
-        Args:
-            url (str): The URL to fetch data from.
-            model (Type[ModelType]): The model class to instantiate.
-            k (str, optional): An optional keyword to wrap the data in a dictionary.
-
-        Returns:
-            Optional[ModelType]: A model instance.
-        """
-        dat = await self._get(url)
-        if dat is None or not dat:
-            return
-
-        data_to_pass = {k: dat} if k is not None else dat
-        return model(**data_to_pass)
-
-    async def is_closed(self) -> bool:
-        """True is closed, False otherwise."""
-        return self.__session is None or self.__session.closed
-
-    async def close(self) -> None:
-        """Close the aiohttp session."""
-        if self.__session is not None:
-            await self.__session.close()
-        self.__session = None
-
-    @property
-    def domain(self) -> str:
-        return "ddnet.org"
-
-    @staticmethod
-    def powered() -> None:
-        return None
+import asyncio
+import atexit
+import logging
+from abc import ABC
+from typing import Optional, Type, Any
+
+import aiohttp
+from aiohttp import ClientSession
+
+from ddapi.cache import CacheABC, EmptyCache
+from ddapi.types import T
+
+try:
+    import orjson
+
+    DEFAULT_JSON_DECODER = orjson.loads
+except ImportError:
+    from aiohttp.typedefs import DEFAULT_JSON_DECODER
+
+logger = logging.getLogger(__name__)
+
+
+class API(ABC):
+    def __init__(
+        self,
+        session: ClientSession = None,
+        *,
+        autoclose: bool = True,
+        cache: CacheABC = EmptyCache(),
+        json_loads: Any = DEFAULT_JSON_DECODER,
+    ):
+        self.__session = session
+        self.cache = cache
+        self.json_loads = json_loads
+        self.autoclose = autoclose
+
+        if self.__session is None:
+            self.__session = aiohttp.ClientSession()
+            logger.debug("Created a new aiohttp ClientSession.")
+
+        atexit.register(self.close_api)
+
+    async def __aenter__(self):
+        if self.__session is None:
+            self.__session = aiohttp.ClientSession()
+            logger.debug("Created a new aiohttp ClientSession on enter.")
+        return self
+
+    async def __aexit__(self, _exc_type, _exc_val, _exc_tb):
+        if self.autoclose:
+            logger.debug("Closing aiohttp ClientSession on exit.")
+            await self.close()
+
+    async def _get(self, url: str) -> Optional[dict]:
+        """Send a GET request to the given URL and return the response as JSON."""
+        logger.debug(f"Sending GET request to {url}.")
+        async with self.__session.get(url) as req:
+            if req.status == 200:
+                logger.debug(f"Received response from {url}: {req.status}.")
+                return await req.json(loads=self.json_loads)
+            logger.error(f"Failed to get response from {url}: {req.status}.")
+            return None
+
+    async def _generate_model_instance(
+        self,
+        url: str,
+        model: Type[T],
+        k: Optional[str] = None,
+        cache_timeout: int = 300,
+    ) -> Optional[T]:
+        """Generate a model instance from the given URL and optional keyword arguments.
+
+        Args:
+            url (str): The URL to fetch data from.
+            model (Type[ModelType]): The model class to instantiate.
+            k (str, optional): An optional keyword to wrap the data in a dictionary.
+
+        Returns:
+            Optional[ModelType]: A model instance.
+        """
+        cache = await self.cache.get(url)
+        if cache is not None:
+            return cache
+
+        dat = await self._get(url)
+        if dat is None or not dat:
+            logger.warning(f"No data received from {url}.")
+            return None
+
+        data = model(**{k: dat} if k is not None else dat)
+        await self.cache.set(url, data, cache_timeout)
+        return data
+
+    async def is_closed(self) -> bool:
+        """True is closed, False otherwise."""
+        return self.__session is None or self.__session.closed
+
+    async def close(self) -> None:
+        """Close the aiohttp session."""
+        if self.__session is not None:
+            logger.debug("Closing aiohttp ClientSession.")
+            await self.__session.close()
+        self.__session = None
+        self.cache = None
+
+    @property
+    def domain(self) -> str:
+        return ""
+
+    @staticmethod
+    def powered() -> None:
+        return None
+
+    def close_api(self):
+        asyncio.run(self.close())

ddapi-0.13.1/ddapi/ddapi/api/__init__.py

@@ -0,0 +1,3 @@
+from .ddnet import DDnetApi
+from .ddstats import DDstats
+from .status import Status

ddapi-0.13.1/ddapi/ddapi/api/ddnet.py

@@ -0,0 +1,72 @@
+from urllib.parse import quote
+
+from .._api import API
+from ..scheme import (
+    DDPlayer,
+    DDStatus,
+    ReleasesMaps,
+    Query,
+    QueryMap,
+    QueryMapper,
+    Master,
+    DMap,
+)
+
+__all__ = ("DDnetApi",)
+
+from ..enum import MasterEnum
+
+
+class DDnetApi(API):
+    @property
+    def domain(self) -> str:
+        return "ddnet.org"
+
+    @staticmethod
+    def powered() -> str:
+        return DDnetApi().domain
+
+    async def player(self, player: str) -> DDPlayer:
+        """Fetch player data from the API and return it as a dictionary."""
+        return await self._generate_model_instance(
+            f"https://{self.domain}/players/?json2={quote(player)}", DDPlayer
+        )
+
+    async def status(self) -> DDStatus:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/status/json/stats.json", DDStatus
+        )
+
+    async def releases_map(self) -> ReleasesMaps:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/releases/maps.json", ReleasesMaps, "maps"
+        )
+
+    async def query(self, player: str) -> Query:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/players/?query={quote(player)}", Query, "players"
+        )
+
+    async def query_map(self, map_name: str) -> QueryMap:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/maps/?query={quote(map_name)}",
+            QueryMap,
+            "maps",
+        )
+
+    async def query_mapper(self, player: str) -> QueryMapper:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/maps/?qmapper={quote(player)}",
+            QueryMapper,
+            "players",
+        )
+
+    async def master(self, number: MasterEnum = MasterEnum.master1) -> Master:
+        return await self._generate_model_instance(
+            f"https://master{number}.{self.domain}/ddnet/15/servers.json", Master
+        )
+
+    async def map(self, map_name: str) -> DMap:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/maps/?json={quote(map_name)}", DMap
+        )

ddapi-0.13.1/ddapi/ddapi/api/ddstats.py

@@ -0,0 +1,44 @@
+from urllib.parse import quote
+
+from .._api import API
+from ..scheme import (
+    DProfile,
+    SMap,
+    Maps,
+    Player,
+)
+
+__all__ = ("DDstats",)
+
+
+class DDstats(API):
+    @property
+    def domain(self) -> str:
+        return "ddstats.tw"
+
+    @staticmethod
+    def powered() -> str:
+        return DDstats().domain
+
+    async def profile(self, player_name: str) -> DProfile:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/profile/json?player={quote(player_name)}",
+            DProfile,
+            "profile",
+        )
+
+    async def map(self, map_name: str) -> SMap:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/map/json?map={quote(map_name)}", SMap
+        )
+
+    async def maps(self) -> Maps:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/maps/json", Maps, "maps"
+        )
+
+    async def player(self, player_name: str) -> Player:
+        """Fetch player data from the API and return it as a dictionary."""
+        return await self._generate_model_instance(
+            f"https://{self.domain}/player/json?player={quote(player_name)}", Player
+        )