feat: add RefreshTokenExpiredError, use aclose (#217)

* feat: add `RefreshTokenExpiredError`, use `aclose`

* docs: add breaking change warning for `close()`

README.rst

@@ -57,7 +57,7 @@ API v1 Example
        # regular syntax
        client = aiosu.v1.Client("osu api token")
        user = await client.get_user(7782553)
-       await client.close()
+       await client.aclose()
 
 
    if __name__ == "__main__":
@@ -95,7 +95,7 @@ API v2 Example
         # regular syntax
         client = aiosu.v2.Client(client_secret="secret", client_id=1000, token=token)
         user = await client.get_me()
-        await client.close()
+        await client.aclose()
 
 
     if __name__ == "__main__":

aiosu/exceptions.py

@@ -3,7 +3,7 @@
 """
 from __future__ import annotations
 
-__all__ = ("APIException",)
+__all__ = ("APIException", "InvalidClientRequestedError", "RefreshTokenExpiredError")
 
 
 class APIException(Exception):
@@ -20,6 +20,17 @@ def __init__(self, status: int, message: str = "") -> None:
         self.status = status
 
 
+class RefreshTokenExpiredError(Exception):
+    """Refresh Token Expired Error
+
+    :param message: error message, defaults to ""
+    :type message: str, optional
+    """
+
+    def __init__(self, message: str = "") -> None:
+        super().__init__(message)
+
+
 class InvalidClientRequestedError(Exception):
     """Invalid Client Requested Error
 

aiosu/v1/client.py

@@ -99,7 +99,7 @@ async def __aexit__(
         exc: Optional[BaseException],
         traceback: Optional[TracebackType],
     ) -> None:
-        await self.close()
+        await self.aclose()
 
     async def _request(
         self,
@@ -475,8 +475,16 @@ async def get_beatmap_osu(self, beatmap_id: int) -> StringIO:
         data = await self._request("GET", url)
         return StringIO(data)
 
-    async def close(self) -> None:
+    async def aclose(self) -> None:
         """Closes the client session."""
         if self._session:
             await self._session.close()
             self._session = None
+
+    async def close(self) -> None:
+        """Closes the client session. (Deprecated)"""
+        warn(
+            "close is deprecated, use aclose instead. Will be removed on 2024-03-01",
+            DeprecationWarning,
+        )
+        await self.aclose()