ossapi 3.3.1__tar.gz → 3.3.3__tar.gz

{ossapi-3.3.1 → ossapi-3.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ossapi
-Version: 3.3.1
+Version: 3.3.3
 Summary: Complete python wrapper for osu! api v2 and v1.
 Author-email: Liam DeVoe <orionldevoe@gmail.com>
 Project-URL: Homepage, https://github.com/circleguard/ossapi
@@ -86,9 +86,9 @@ ossapi provides an async variant, `OssapiAsync`, which has an identical interfac
 
 ```python
 import asyncio
-from ossapi import Ossapi
+from ossapi import OssapiAsync
 
-api = Ossapi(client_id, client_secret)
+api = OssapiAsync(client_id, client_secret)
 
 async def main():
     await api.user("tybug")

{ossapi-3.3.1 → ossapi-3.3.3}/README.md

@@ -72,9 +72,9 @@ ossapi provides an async variant, `OssapiAsync`, which has an identical interfac
 
 ```python
 import asyncio
-from ossapi import Ossapi
+from ossapi import OssapiAsync
 
-api = Ossapi(client_id, client_secret)
+api = OssapiAsync(client_id, client_secret)
 
 async def main():
     await api.user("tybug")

{ossapi-3.3.1 → ossapi-3.3.3}/ossapi/enums.py

@@ -86,6 +86,7 @@ class UserAccountHistoryType(EnumModel):
     NOTE = "note"
     RESTRICTION = "restriction"
     SILENCE = "silence"
+    TOURNAMENT_BAN = "tournament_ban"
 
 class MessageType(EnumModel):
     HYPE = "hype"
@@ -281,6 +282,8 @@ class UserBeatmapType(EnumModel):
     MOST_PLAYED = "most_played"
     RANKED = "ranked"
     PENDING = "pending"
+    GUEST = "guest"
+    NOMINATED = "nominated"
 
 class BeatmapDiscussionPostSort(EnumModel):
     NEW = "id_desc"
@@ -474,9 +477,11 @@ class ProfileBanner(Model):
 
 class UserAccountHistory(Model):
     description: Optional[str]
-    type: UserAccountHistoryType
-    timestamp: Datetime
+    id: int
     length: int
+    permanent: bool
+    timestamp: Datetime
+    type: UserAccountHistoryType
 
 
 class UserBadge(Model):

{ossapi-3.3.1 → ossapi-3.3.3}/ossapi/models.py

@@ -154,6 +154,9 @@ class UserCompact(Model):
     def expand(self) -> User:
         return self._fk_user(self.id)
 
+    def refresh(self) -> User:
+        return self._fk_user(self.id)
+
 class User(UserCompact):
     comments_count: int
     cover_url: str
@@ -571,7 +574,7 @@ class BeatmapsetDiscussionPost(Model):
     updated_at: Datetime
     deleted_at: Optional[Datetime]
 
-    def user(self) -> user:
+    def user(self) -> User:
         return self._fk_user(self.user_id)
 
     def last_editor(self) -> Optional[User]:
@@ -1136,7 +1139,7 @@ class UserStatistics(Model):
     total_hits: int
     total_score: int
     user: Optional[UserCompact]
-    variants: Optional[List[StatisticsVariant]]
+    variants: Optional[List[StatisticsVariant]] #!
 
 class UserStatisticsRulesets(Model):
     # undocumented

{ossapi-3.3.1 → ossapi-3.3.3}/ossapi/ossapiv2.py

@@ -15,7 +15,7 @@ import sys
 
 from requests_oauthlib import OAuth2Session
 from oauthlib.oauth2 import (BackendApplicationClient, TokenExpiredError,
-    AccessDeniedError)
+    AccessDeniedError, OAuth2Error)
 from oauthlib.oauth2.rfc6749.errors import InsufficientScopeError
 from oauthlib.oauth2.rfc6749.tokens import OAuth2Token
 import osrparse
@@ -56,7 +56,9 @@ from ossapi.replay import Replay
 # details).
 GameModeT = Union[GameMode, str]
 ScoreTypeT = Union[ScoreType, str]
-ModT = Union[Mod, str, int, list]
+# XXX this cannot be recursively typed without breaking our runtime type hint
+# inspection.
+ModT = Union[Mod, str, int, list[Union[Mod, str, int]]]
 RankingFilterT = Union[RankingFilter, str]
 RankingTypeT = Union[RankingType, str]
 UserBeatmapTypeT = Union[UserBeatmapType, str]
@@ -213,6 +215,20 @@ def request(scope, *, requires_user=False, category):
     return decorator
 
 
+class ReauthenticationRequired(Exception):
+    """
+    Indicates that either the user has revoked this application from their
+    account, or osu-web itself has invalidated the refresh token associated with
+    this application.
+
+    This exception is only raised when a manual access_token is passed to
+    Ossapi, to bypass Ossapi's default authentication methods. The expectation
+    is that in these cases, the consumer has their own way of authenticating
+    with the user. That method should be used here to handle the
+    reauthentication.
+    """
+    pass
+
 class Grant(Enum):
     """
     The grant types used by the api.
@@ -259,10 +275,9 @@ class Ossapi:
         The redirect uri for the client. Must be passed if using the
         authorization code grant. This must exactly match the redirect uri on
         the client's settings page. Additionally, in order for ossapi to receive
-        authentication from this redirect uri, it must be a port on localhost.
-        So "http://localhost:3914/", "http://localhost:727/", etc are all valid
-        redirect uris. You can change your client's redirect uri from its
-        settings page.
+        authentication from this redirect uri, it must be a port on localhost,
+        e.g. "http://localhost:3914/". You can change your client's redirect uri
+        from its settings page.
     scopes: List[str]
         What scopes to request when authenticating.
     grant: Grant or str
@@ -382,6 +397,8 @@ class Ossapi:
             raise ValueError("`redirect_uri` must be passed if the "
                 "authorization code grant is used.")
 
+        # whether the consumer passed a token to ossapi to bypass authentication
+        self.access_token_passed = False
         token = None
         if access_token is not None:
             # allow refresh_token to be null for the case of client credentials
@@ -393,6 +410,7 @@ class Ossapi:
                 "refresh_token": refresh_token
             }
             token = OAuth2Token(params)
+            self.access_token_passed = True
 
         self.session = self.authenticate(token=token)
 
@@ -453,6 +471,8 @@ class Ossapi:
         with this OssapiV2's parameters, or from a fresh authentication if no
         such file exists.
         """
+
+        # try saved token file first
         if self.token_file.exists() or token is not None:
             if token is None:
                 with open(self.token_file, "rb") as f:
@@ -473,6 +493,10 @@ class Ossapi:
                     token_updater=self._save_token,
                     scope=[scope.value for scope in self.scopes])
 
+        # otherwise, authorize from scratch
+        return self._new_grant()
+
+    def _new_grant(self):
         if self.grant is Grant.CLIENT_CREDENTIALS:
             return self._new_client_grant(self.client_id, self.client_secret)
 
@@ -553,9 +577,30 @@ class Ossapi:
         params = self._format_params(params)
         # also format data for post requests
         data = self._format_params(data)
-        try:
-            r = self.session.request(method, f"{self.base_url}{url}",
+
+        def make_request():
+            return self.session.request(method, f"{self.base_url}{url}",
                 params=params, data=data)
+
+        def reauthenticate_and_retry():
+            # don't automatically re-authenticate if the user passed an access
+            # token. They should handle re-authentication with the user
+            # manually (since they may have a bespoke system, like a website).
+            if self.access_token_passed:
+                self.log.info("refresh token is invalid. raising for consumer "
+                    "to handle since access token was passed originally.")
+                raise ReauthenticationRequired()
+
+            self.log.info("refresh token invalid, re-authenticating (grant: "
+                f"{self.grant})")
+            # don't use .authenticate, that falls back to cached tokens. go
+            # straight to authenticating from scratch.
+            self.session = self._new_grant()
+            # redo the request now that we have a valid session
+            return make_request()
+
+        try:
+            r = make_request()
         except TokenExpiredError:
             # provide "auto refreshing" for client credentials grant. The client
             # grant doesn't actually provide a refresh token, so we can't hook
@@ -568,11 +613,23 @@ class Ossapi:
             self.session = self._new_client_grant(self.client_id,
                 self.client_secret)
             # redo the request now that we have a valid token
-            r = self.session.request(method, f"{self.base_url}{url}",
-                params=params, data=data)
+            r = make_request()
+        except OAuth2Error as e:
+            if e.description != "The refresh token is invalid.":
+                raise
+
+            r = reauthenticate_and_retry()
 
         self.log.info(f"made {method} request to {r.request.url}, data {data}")
         json_ = r.json()
+
+        # occurs if a client gets revoked and the token hasn't officially
+        # expired yet (so it doesn't error earlier up in the chain with
+        # Oauth2Error).
+        if json_ == {"authentication": "basic"}:
+            r = reauthenticate_and_retry()
+            json_ = r.json()
+
         self.log.debug(f"received json: \n{json.dumps(json_, indent=4)}")
         self._check_response(json_, r.url)
 
@@ -586,13 +643,6 @@ class Ossapi:
             raise ValueError(f"api returned an error of `{json_['error']}` for "
                 f"a request to {unquote(url)}")
 
-        # Shouldn't happen in normal usage. Might occur if a client gets revoked
-        # and we still have a local token.pickel saved for it. But I haven't
-        # tested.
-        if json_ == {"authentication": "basic"}:
-            raise ValueError(f"Invalid authentication. json: {json_}, url: "
-                f"{url}")
-
     def _get(self, type_, url, params={}):
         return self._request(type_, "GET", url, params=params)
 
@@ -802,7 +852,7 @@ class Ossapi:
         try:
             type_hints = get_type_hints(type_)
         except TypeError:
-            assert type(type_) is _GenericAlias # pylint: disable=unidiomatic-typecheck
+            assert type(type_) is _GenericAlias
 
             signature_type = get_origin(type_)
             type_hints = get_type_hints(signature_type)

{ossapi-3.3.1 → ossapi-3.3.3}/ossapi/ossapiv2_async.py

@@ -122,7 +122,7 @@ class Oauth2SessionAsync(OAuth2Session):
 # details).
 GameModeT = Union[GameMode, str]
 ScoreTypeT = Union[ScoreType, str]
-ModT = Union[Mod, str, int, list]
+ModT = Union[Mod, str, int, list[Union[Mod, str, int]]]
 RankingFilterT = Union[RankingFilter, str]
 RankingTypeT = Union[RankingType, str]
 UserBeatmapTypeT = Union[UserBeatmapType, str]
@@ -326,10 +326,9 @@ class OssapiAsync:
         The redirect uri for the client. Must be passed if using the
         authorization code grant. This must exactly match the redirect uri on
         the client's settings page. Additionally, in order for ossapi to receive
-        authentication from this redirect uri, it must be a port on localhost.
-        So "http://localhost:3914/", "http://localhost:727/", etc are all valid
-        redirect uris. You can change your client's redirect uri from its
-        settings page.
+        authentication from this redirect uri, it must be a port on localhost,
+        e.g. "http://localhost:3914/". You can change your client's redirect uri
+        from its settings page.
     scopes: List[str]
         What scopes to request when authenticating.
     grant: Grant or str
@@ -890,7 +889,7 @@ class OssapiAsync:
         try:
             type_hints = get_type_hints(type_)
         except TypeError:
-            assert type(type_) is _GenericAlias # pylint: disable=unidiomatic-typecheck
+            assert type(type_) is _GenericAlias
 
             signature_type = get_origin(type_)
             type_hints = get_type_hints(signature_type)

{ossapi-3.3.1 → ossapi-3.3.3}/ossapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ossapi
-Version: 3.3.1
+Version: 3.3.3
 Summary: Complete python wrapper for osu! api v2 and v1.
 Author-email: Liam DeVoe <orionldevoe@gmail.com>
 Project-URL: Homepage, https://github.com/circleguard/ossapi
@@ -86,9 +86,9 @@ ossapi provides an async variant, `OssapiAsync`, which has an identical interfac
 
 ```python
 import asyncio
-from ossapi import Ossapi
+from ossapi import OssapiAsync
 
-api = Ossapi(client_id, client_secret)
+api = OssapiAsync(client_id, client_secret)
 
 async def main():
     await api.user("tybug")

{ossapi-3.3.1 → ossapi-3.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ossapi"
-version = "3.3.1"
+version = "3.3.3"
 description = "Complete python wrapper for osu! api v2 and v1."
 readme = "README.md"
 keywords = ["osu!", "wrapper", "api", "python"]

{ossapi-3.3.1 → ossapi-3.3.3}/tests/test_endpoints.py

@@ -107,6 +107,8 @@ class TestSearchBeatmaps(TestCase):
 class TestUser(TestCase):
     def test_deserialize(self):
         api.user(12092800)
+        # user with an account_history (tournament ban)
+        api.user(9997093)
 
     def test_key(self):
         # make sure it automatically falls back to username if not specified