Enable ruff ANN rule and fix annotations (#25)

Author: tr4nt0r

pyproject.toml

@@ -47,8 +47,9 @@ line-length = 88
 target-version = "py311"
 
 [tool.ruff.lint]
-select = ["E4", "E7", "E9", "F", "UP", "S"]
-ignore = []
+select = ["E4", "E7", "E9", "F", "UP", "S", "ANN"]
+# select = ["ALL"]
+ignore = ["ANN003", "ANN401"]
 
 
 [tool.ruff.lint.per-file-ignores]

readme_example.py

@@ -3,11 +3,11 @@
 
 from httpx import HTTPStatusError
 
-from pythonxbox.webapi.api.client import XboxLiveClient
-from pythonxbox.webapi.authentication.manager import AuthenticationManager
-from pythonxbox.webapi.authentication.models import OAuth2TokenResponse
-from pythonxbox.webapi.common.signed_session import SignedSession
-from pythonxbox.webapi.scripts import CLIENT_ID, CLIENT_SECRET, TOKENS_FILE
+from pythonxbox.api.client import XboxLiveClient
+from pythonxbox.authentication.manager import AuthenticationManager
+from pythonxbox.authentication.models import OAuth2TokenResponse
+from pythonxbox.common.signed_session import SignedSession
+from pythonxbox.scripts import CLIENT_ID, CLIENT_SECRET, TOKENS_FILE
 
 """
 This uses the global default client identification by OpenXbox
@@ -23,7 +23,7 @@
 """
 
 
-async def async_main():
+async def async_main() -> None:
     # Create a HTTP client session
     async with SignedSession() as session:
         """

src/pythonxbox/api/client.py

@@ -36,7 +36,7 @@
 
 
 class Session:
-    def __init__(self, auth_mgr: AuthenticationManager):
+    def __init__(self, auth_mgr: AuthenticationManager) -> None:
         self._auth_mgr = auth_mgr
         self._cv = CorrelationVector()
 
@@ -125,7 +125,7 @@ def __init__(
         self,
         auth_mgr: AuthenticationManager,
         language: XboxLiveLanguage = DefaultXboxLiveLanguages.United_States,
-    ):
+    ) -> None:
         self._auth_mgr = auth_mgr
         self.session = Session(auth_mgr)
         self._language = language

src/pythonxbox/api/language.py

@@ -4,7 +4,13 @@
 
 
 class XboxLiveLanguage:
-    def __init__(self, name, short_id, identifier, locale):
+    def __init__(
+        self,
+        name: str,
+        short_id: str,
+        identifier: str,
+        locale: str,
+    ) -> None:
         """
         Initialize a new instance of :class:`XboxLiveLanguage`
 

src/pythonxbox/api/provider/account/__init__.py

@@ -12,7 +12,9 @@ class AccountProvider(BaseProvider):
     HEADERS_USER_MGT = {"x-xbl-contract-version": "1"}
     HEADERS_ACCOUNT = {"x-xbl-contract-version": "2"}
 
-    async def claim_gamertag(self, xuid, gamertag, **kwargs) -> ClaimGamertagResult:
+    async def claim_gamertag(
+        self, xuid: str, gamertag: str, **kwargs
+    ) -> ClaimGamertagResult:
         """
         Claim gamertag
 
@@ -40,7 +42,7 @@ async def claim_gamertag(self, xuid, gamertag, **kwargs) -> ClaimGamertagResult:
             resp.raise_for_status()
 
     async def change_gamertag(
-        self, xuid, gamertag, preview=False, **kwargs
+        self, xuid: str, gamertag: str, preview: bool = False, **kwargs
     ) -> ChangeGamertagResult:
         """
         Change your gamertag.

src/pythonxbox/api/provider/achievements/__init__.py

@@ -21,7 +21,7 @@ class AchievementsProvider(RateLimitedProvider):
     RATE_LIMITS = {"burst": 100, "sustain": 300}
 
     async def get_achievements_detail_item(
-        self, xuid, service_config_id, achievement_id, **kwargs
+        self, xuid: str, service_config_id: str, achievement_id: str, **kwargs
     ) -> AchievementResponse:
         """
         Get achievement detail for specific item
@@ -45,7 +45,7 @@ async def get_achievements_detail_item(
         return AchievementResponse(**resp.json())
 
     async def get_achievements_xbox360_all(
-        self, xuid, title_id, **kwargs
+        self, xuid: str, title_id: str, **kwargs
     ) -> Achievement360Response:
         """
         Get all achievements for specific X360 title Id
@@ -70,7 +70,7 @@ async def get_achievements_xbox360_all(
         return Achievement360Response(**resp.json())
 
     async def get_achievements_xbox360_earned(
-        self, xuid, title_id, **kwargs
+        self, xuid: str, title_id: str, **kwargs
     ) -> Achievement360Response:
         """
         Get earned achievements for specific X360 title id
@@ -95,7 +95,7 @@ async def get_achievements_xbox360_earned(
         return Achievement360Response(**resp.json())
 
     async def get_achievements_xbox360_recent_progress_and_info(
-        self, xuid, **kwargs
+        self, xuid: str, **kwargs
     ) -> Achievement360ProgressResponse:
         """
         Get recent achievement progress and information
@@ -117,7 +117,7 @@ async def get_achievements_xbox360_recent_progress_and_info(
         return Achievement360ProgressResponse(**resp.json())
 
     async def get_achievements_xboxone_gameprogress(
-        self, xuid, title_id, **kwargs
+        self, xuid: str, title_id: str, **kwargs
     ) -> AchievementResponse:
         """
         Get gameprogress for Xbox One title
@@ -142,7 +142,7 @@ async def get_achievements_xboxone_gameprogress(
         return AchievementResponse(**resp.json())
 
     async def get_achievements_xboxone_recent_progress_and_info(
-        self, xuid, **kwargs
+        self, xuid: str, **kwargs
     ) -> RecentProgressResponse:
         """
         Get recent achievement progress and information

src/pythonxbox/api/provider/baseprovider.py

@@ -4,9 +4,15 @@
 Subclassed by every *real* provider
 """
 
+from typing import TYPE_CHECKING
+
+
+if TYPE_CHECKING:
+    from pythonxbox.api.client import XboxLiveClient
+
 
 class BaseProvider:
-    def __init__(self, client):
+    def __init__(self, client: "XboxLiveClient") -> None:
         """
         Initialize an the BaseProvider
 

src/pythonxbox/api/provider/catalog/models.py

@@ -250,7 +250,7 @@ class SkuProperties(PascalCaseModel):
     is_bundle: bool
 
     @field_validator("last_update_date", mode="before", check_fields=True)
-    def validator(x):
+    def validator(x: "SkuProperties") -> "SkuProperties":
         return x or None
 
 

src/pythonxbox/api/provider/presence/__init__.py

@@ -17,7 +17,7 @@ class PresenceProvider(BaseProvider):
 
     async def get_presence(
         self,
-        xuid,
+        xuid: str,
         presence_level: PresenceLevel = PresenceLevel.USER,
         **kwargs,
     ) -> PresenceItem:

src/pythonxbox/api/provider/ratelimitedprovider.py

@@ -4,17 +4,21 @@
 Subclassed by providers with rate limit support
 """
 
+from typing import TYPE_CHECKING
 from pythonxbox.api.provider.baseprovider import BaseProvider
 from pythonxbox.common.exceptions import XboxException
 from pythonxbox.common.ratelimits import CombinedRateLimit
 from pythonxbox.common.ratelimits.models import LimitType, ParsedRateLimit, TimePeriod
 
+if TYPE_CHECKING:
+    from pythonxbox.api.client import XboxLiveClient
+
 
 class RateLimitedProvider(BaseProvider):
     # dict -> Dict (typing.dict) https://stackoverflow.com/a/63460173
     RATE_LIMITS: dict[str, int | dict[str, int]]
 
-    def __init__(self, client):
+    def __init__(self, client: "XboxLiveClient") -> None:
         """
         Initialize Baseclass
 
@@ -39,7 +43,7 @@ def __init__(self, client):
                 "RateLimitedProvider as parent class but RATE_LIMITS not set!"
             )
 
-    def __handle_rate_limit_setup(self):
+    def __handle_rate_limit_setup(self) -> None:
         # Retrieve burst and sustain from the dict
         burst_key = self.RATE_LIMITS["burst"]
         sustain_key = self.RATE_LIMITS["sustain"]