Merge pull request #78 from leonhard-s/release/0.4.0

Author: leonhard-s

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2023 Leonhard S.
+Copyright (c) 2018-2025 Leonhard S.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

auraxium/__init__.py

@@ -34,4 +34,4 @@
 ]
 
 __author__ = 'Leonhard S.'
-__version__ = '0.3.0'
+__version__ = '0.4.0'

auraxium/_rest.py

@@ -71,7 +71,7 @@ def __init__(self, loop: Optional[asyncio.AbstractEventLoop] = None,
                 loop = asyncio.get_running_loop()
             except RuntimeError:  # pragma: no cover
                 # Hacky way to deprecate things that are not functions
-                deprecated('0.3', '0.4', ':meth:`asyncio.new_event_loop()')(
+                deprecated('0.3', '0.5', ':meth:`asyncio.new_event_loop()')(
                     lambda: None)()
                 loop = asyncio.new_event_loop()
         self.loop: asyncio.AbstractEventLoop = loop

auraxium/base.py

@@ -120,7 +120,7 @@ def __repr__(self) -> str:
         return f'<{self.__class__.__name__}:{self.id}>'
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.count`')  # pragma: no cover
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.count`')  # pragma: no cover
     async def count(cls, client: RequestClient, **kwargs: Any) -> int:
         """Return the number of items matching the given terms.
 
@@ -134,7 +134,7 @@ async def count(cls, client: RequestClient, **kwargs: Any) -> int:
         return await client.count(cls, **kwargs)  # type: ignore
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.find`')  # pragma: no cover
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.find`')  # pragma: no cover
     async def find(cls: Type[Ps2ObjectT], results: int = 10, *,
                    offset: int = 0, promote_exact: bool = False,
                    check_case: bool = True, client: RequestClient,
@@ -166,7 +166,7 @@ async def find(cls: Type[Ps2ObjectT], results: int = 10, *,
             check_case=check_case, **kwargs)
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.get`')  # pragma: no cover
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.get`')  # pragma: no cover
     async def get(cls: Type[Ps2ObjectT], client: RequestClient,
                   check_case: bool = True, **kwargs: Any
                   ) -> Optional[Ps2ObjectT]:
@@ -187,7 +187,7 @@ async def get(cls: Type[Ps2ObjectT], client: RequestClient,
             cls, results=1, check_case=check_case, **kwargs)
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.get`')  # pragma: no cover
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.get`')  # pragma: no cover
     async def get_by_id(cls: Type[Ps2ObjectT], id_: int, *,
                         client: RequestClient) -> Optional[Ps2ObjectT]:
         """Retrieve an object by its unique Census ID.
@@ -291,7 +291,7 @@ def alter_cache(cls, size: int, ttu: Optional[float] = None) -> None:
             cls._cache.ttu = ttu
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.get`')  # pragma: no cover
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.get`')  # pragma: no cover
     async def get_by_id(cls: Type[CachedT], id_: int, *,
                         client: RequestClient) -> Optional[CachedT]:
         """Retrieve an object by by ID.
@@ -362,7 +362,7 @@ def __str__(self) -> str:
         return str(self.name)
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.get`')  # pragma: no cover
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.get`')  # pragma: no cover
     async def get_by_name(cls: Type[NamedT], name: str, *, locale: str = 'en',
                           client: RequestClient) -> Optional[NamedT]:
         """Retrieve an object by its unique name.

auraxium/models/_character.py

@@ -194,7 +194,7 @@ class Name(RESTPayload):
         first: str
         first_lower: str
 
-        @deprecated('0.2', '0.4', replacement=':attr:`auraxium.models.'
+        @deprecated('0.2', '0.5', replacement=':attr:`auraxium.models.'
                     'CharacterData.Name.name`')
         def __call__(self, locale: str = 'en') -> str:  # pragma: no cover
             return self.first

auraxium/ps2/_character.py

@@ -365,7 +365,7 @@ async def friends(self) -> List['Character']:
         return [Character(d, client=self._client) for d in data]
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.get`')
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.get`')
     async def get_by_name(cls: Type[NamedT], name: str, *, locale: str = 'en',
                           client: RequestClient
                           ) -> Optional[NamedT]:  # pragma: no cover

auraxium/ps2/_outfit.py

@@ -174,7 +174,7 @@ def tag(self) -> str:
         return self.alias
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.get`')
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.get`')
     async def get_by_name(cls: Type[NamedT], name: str, *, locale: str = 'en',
                           client: RequestClient
                           ) -> Optional[NamedT]:  # pragma: no cover
@@ -198,7 +198,7 @@ async def get_by_name(cls: Type[NamedT], name: str, *, locale: str = 'en',
         return cls(payload, client=client)
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.get`')
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.get`')
     async def get_by_tag(cls, tag: str, client: RequestClient
                          ) -> Optional['Outfit']:  # pragma: no cover
         """Return an outfit by its unique tag.

auraxium/ps2/_weapon.py

@@ -194,7 +194,7 @@ def fire_groups(self) -> SequenceProxy[FireGroup]:
         return SequenceProxy(FireGroup, query, client=self._client)
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.get`')
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.get`')
     async def get_by_name(cls, name: str, *, locale: str = 'en',
                           client: RequestClient
                           ) -> Optional['Weapon']:  # pragma: no cover

auraxium/ps2/_world.py

@@ -71,7 +71,7 @@ async def events(self, **kwargs: Any) -> List[CensusData]:
         return data
 
     @classmethod
-    @deprecated('0.2', '0.4', replacement=':meth:`auraxium.Client.get`')
+    @deprecated('0.2', '0.5', replacement=':meth:`auraxium.Client.get`')
     async def get_by_name(cls: Type[NamedT], name: str, *, locale: str = 'en',
                           client: RequestClient
                           ) -> Optional[NamedT]:  # pragma: no cover

auraxium/types.py

@@ -30,7 +30,7 @@ class LocaleData(pydantic.BaseModel):
     fr: Optional[str] = None
     it: Optional[str] = None
 
-    @deprecated('0.3.0', ':attr:`auraxium.types.LocaleData.name`')
+    @deprecated('0.3', '0.5', ':attr:`auraxium.types.LocaleData.name`')
     def __call__(self, locale: str = 'en') -> str:  # pragma: no cover
         return getattr(self, locale)