ossapi 5.0.2__tar.gz → 5.1.0__tar.gz

{ossapi-5.0.2 → ossapi-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: ossapi
-Version: 5.0.2
+Version: 5.1.0
 Summary: Complete python wrapper for osu! api v2 and v1.
 Author-email: Liam DeVoe <orionldevoe@gmail.com>
 Project-URL: Homepage, https://github.com/tybug/ossapi

{ossapi-5.0.2 → ossapi-5.1.0}/ossapi/enums.py

@@ -872,3 +872,8 @@ class RoomPlaylistItemStats(Model):
 class RoomDifficultyRange(Model):
     min: float
     max: float
+
+
+class BeatmapOwner(Model):
+    id: int
+    username: str

{ossapi-5.0.2 → ossapi-5.1.0}/ossapi/models.py

@@ -68,6 +68,7 @@ from ossapi.enums import (
     BeatmapPackUserCompletionData,
     RoomPlaylistItemStats,
     RoomDifficultyRange,
+    BeatmapOwner,
 )
 from ossapi.utils import Datetime, Model, BaseModel, Field
 
@@ -292,6 +293,9 @@ class Beatmap(BeatmapCompact):
     # This is optional as a workaround until
     # https://github.com/ppy/osu-web/issues/9784 is resolved.
     owner: Field(name="user", type=Optional[UserCompact])
+    # TODO does the new addition of this owners attribute deprecate the owner
+    # attribute?
+    owners: Optional[List[BeatmapOwner]]
 
     # overridden fields
     # -----------------
@@ -737,7 +741,11 @@ class BeatmapsetDiscussion(Model):
     current_user_attributes: Any
     updated_at: Datetime
     deleted_at: Optional[Datetime]
-    last_post_at: Datetime
+    # marked as required in the docs, but null in
+    #   api.beatmapset_events(beatmapset_id=1112418)
+    # due to this post
+    # https://osu.ppy.sh/beatmapsets/1112418/discussion/-/generalAll#/1633002
+    last_post_at: Optional[Datetime]
     kudosu_denied: bool
     starting_post: Optional[BeatmapsetDiscussionPost]
     posts: Optional[List[BeatmapsetDiscussionPost]]
@@ -942,7 +950,7 @@ class ChangelogListing(Model):
 
 class MultiplayerScores(Model):
     cursor_string: CursorStringT
-    params: str
+    params: Any
     scores: List[MultiplayerScore]
     total: Optional[int]
     user_score: Optional[MultiplayerScore]
@@ -954,7 +962,7 @@ class MultiplayerScore(Model):
     room_id: int
     playlist_item_id: int
     beatmap_id: int
-    rank: int
+    rank: Grade
     total_score: int
     max_combo: int
     mods: List[Mod]
@@ -963,6 +971,28 @@ class MultiplayerScore(Model):
     position: Optional[int]
     scores_around: Optional[MultiplayerScoresAround]
     user: User
+    solo_score_id: int
+    classic_total_score: int
+    preserve: bool
+    processed: bool
+    ranked: bool
+    maximum_statistics: Statistics
+    total_score_without_mods: int
+    best_id: Optional[int]
+    type: str
+    accuracy: float
+    build_id: int
+    ended_at: Datetime
+    is_perfect_combo: bool
+    replay: bool
+    pp: float
+    started_at: Datetime
+    ruleset_id: int
+    current_user_attributes: Any
+    has_replay: bool
+    legacy_perfect: bool
+    legacy_score_id: int
+    legacy_total_score: int
 
     def beatmap(self):
         return self._fk_beatmap(self.beatmap_id)
@@ -1070,6 +1100,12 @@ class BeatmapPack(Model):
     user_completion_data: Optional[BeatmapPackUserCompletionData]
 
 
+class Scores(Model):
+    cursor: CursorT
+    cursor_string: CursorStringT
+    scores: List[Score]
+
+
 # ================
 # Parameter Models
 # ================
@@ -1145,12 +1181,12 @@ class BeatmapsetEventComment(Model):
 
 class BeatmapsetEventCommentNoPost(Model):
     beatmap_discussion_id: int
-    beatmap_discussion_post_id: int
+    beatmap_discussion_post_id: Optional[int]
 
 
 class BeatmapsetEventCommentNone(Model):
-    beatmap_discussion_id: int
-    beatmap_discussion_post_id: int
+    beatmap_discussion_id: Optional[int]
+    beatmap_discussion_post_id: Optional[int]
 
 
 class BeatmapsetEventCommentChange(Generic[S], BeatmapsetEventCommentNone):
@@ -1176,6 +1212,7 @@ class BeatmapsetEventCommentOwnerChange(BeatmapsetEventCommentNone):
     beatmap_version: str
     new_user_id: int
     new_user_username: str
+    new_users: List[int]
 
 
 class BeatmapsetEventCommentNominate(Model):
@@ -1224,7 +1261,14 @@ class BeatmapsetEvent(Model):
             BeatmapsetEventType.DISCUSSION_RESTORE: BeatmapsetEventCommentNoPost,
             # same here
             # BeatmapsetEventType.DISCUSSION_UNLOCK: BeatmapsetEventComment,
-            BeatmapsetEventType.DISQUALIFY: BeatmapsetEventCommentWithNominators,
+            # Some events have a comment that is *just a string*.
+            #   api.beatmapset_events(beatmapset_id=724033)
+            # I've only seen this for "type": "disqualify", but who knows where
+            # else it could happen. I've preemptively marked NOMINATION_RESET as
+            # taking a string also.
+            BeatmapsetEventType.DISQUALIFY: Union[
+                BeatmapsetEventCommentWithNominators, str
+            ],
             # same here
             # BeatmapsetEventType.DISQUALIFY_LEGACY: BeatmapsetEventComment
             BeatmapsetEventType.GENRE_EDIT: BeatmapsetEventCommentChange[str],
@@ -1240,7 +1284,9 @@ class BeatmapsetEvent(Model):
             BeatmapsetEventType.NOMINATE: BeatmapsetEventCommentNominate,
             # same here
             # BeatmapsetEventType.NOMINATE_MODES: BeatmapsetEventComment,
-            BeatmapsetEventType.NOMINATION_RESET: BeatmapsetEventCommentWithNominators,
+            BeatmapsetEventType.NOMINATION_RESET: Union[
+                BeatmapsetEventCommentWithNominators, str
+            ],
             BeatmapsetEventType.NOMINATION_RESET_RECEIVED: BeatmapsetEventCommentWithSourceUser,
             BeatmapsetEventType.QUALIFY: type(None),
             BeatmapsetEventType.RANK: type(None),
@@ -1248,7 +1294,11 @@ class BeatmapsetEvent(Model):
             BeatmapsetEventType.NSFW_TOGGLE: BeatmapsetEventCommentChange[bool],
         }
         type_ = BeatmapsetEventType(data["type"])
-        return {"comment": mapping[type_]}
+        # some events don't seem to have an associate comment, eg
+        #   api.beatmapset_events(beatmapset_id=692322)
+        # I don't know under what circumstances this does or does not happen, so
+        # I am marking all comments as optional.
+        return {"comment": Optional[mapping[type_]]}
 
     def user(self) -> Optional[User]:
         return self._fk_user(self.user_id)
@@ -1402,7 +1452,7 @@ class _Room1(Model):
     type: RoomType
     user_id: int
     starts_at: Datetime
-    ends_at: Datetime
+    ends_at: Optional[Datetime]
     max_attempts: Optional[int]
     participant_count: int
     channel_id: int
@@ -1422,7 +1472,7 @@ class Room(Model):
     type: RoomType
     user_id: int
     starts_at: Datetime
-    ends_at: Datetime
+    ends_at: Optional[Datetime]
     max_attempts: Optional[int]
     participant_count: int
     channel_id: int

{ossapi-5.0.2 → ossapi-5.1.0}/ossapi/ossapiv2.py

@@ -77,6 +77,7 @@ from ossapi.models import (
     Events,
     BeatmapPack,
     BeatmapPacks,
+    Scores,
 )
 from ossapi.enums import (
     GameMode,
@@ -898,12 +899,21 @@ class Ossapi:
         # because if we got here that means we were passed a value for this
         # attribute, so we know it's defined and not optional.
         if is_optional(type_):
-            # leaving these assertions in to help me catch errors in my
-            # reasoning until I better understand python's typing.
-            assert len(args) == 2
-            type_ = args[0]
-            origin = get_origin(type_)
-            args = get_args(type_)
+            assert len(args) >= 2
+            # two args is the standard, for Optional[T] = Union[T, None].
+            # but we could also have Union[T, None, V] which passes is_optional
+            # but we want to unwrap differently to preserve the Union[T, V].
+            if len(args) == 2:
+                type_ = args[0]
+                origin = get_origin(type_)
+                args = get_args(type_)
+            else:
+                # should we be changing type_ here? it's not technically correct
+                # anymore, we'd have to remove None from the union. But I don't
+                # know if we rely on type_ instead of args anywhere, and I don't
+                # know how to create a new type instance.
+                origin = get_origin(type_)
+                args = tuple(t for t in get_args(type_) if t is not type(None))
 
         # validate that the values we're receiving are the types we expect them
         # to be
@@ -2423,8 +2433,6 @@ class Ossapi:
     # /rooms
     # ------
 
-    # TODO add test for this once I figure out values for room_id and
-    # playlist_id that actually produce a response lol
     @request(Scope.PUBLIC, category="rooms")
     def multiplayer_scores(
         self,
@@ -2562,6 +2570,28 @@ class Ossapi:
         """
         return self._get(Score, f"/scores/{score_id}")
 
+    @request(Scope.PUBLIC, category="scores")
+    def scores(
+        self, mode: GameModeT, *, cursor_string: Optional[str] = None
+    ) -> Scores:
+        """
+        Returns most recent 1000 passed scores across all users.
+
+        Parameters
+        ----------
+        mode
+            The mode to get scores for.
+        cursor_string
+            Cursor for pagination.
+
+        Notes
+        -----
+        Implements the `Get Scores
+        <https://osu.ppy.sh/docs/index.html#get-scores94>`__ endpoint.
+        """
+        params = {"mode": mode.value, "cursor_string": cursor_string}
+        return self._get(Scores, "/scores", params)
+
     @request(Scope.PUBLIC, category="scores")
     def score_mode(self, mode: GameModeT, score_id: int) -> Score:
         """

{ossapi-5.0.2 → ossapi-5.1.0}/ossapi/ossapiv2_async.py

@@ -90,6 +90,7 @@ from ossapi.models import (
     Events,
     BeatmapPack,
     BeatmapPacks,
+    Scores,
 )
 from ossapi.enums import (
     GameMode,
@@ -2648,7 +2649,7 @@ class OssapiAsync:
     # -------
 
     @request(Scope.PUBLIC, category="scores")
-    def score(self, score_id: int) -> Score:
+    async def score(self, score_id: int) -> Score:
         """
         Get a score. This corresponds to urls of the form https://osu.ppy.sh/scores/1312718771
         ("new id format").
@@ -2665,10 +2666,32 @@ class OssapiAsync:
         Implements the `Get Score
         <https://osu.ppy.sh/docs/index.html#scoresmodescore>`__ endpoint.
         """
-        return self._get(Score, f"/scores/{score_id}")
+        return await self._get(Score, f"/scores/{score_id}")
 
     @request(Scope.PUBLIC, category="scores")
-    def score_mode(self, mode: GameModeT, score_id: int) -> Score:
+    async def scores(
+        self, mode: GameModeT, *, cursor_string: Optional[str] = None
+    ) -> Scores:
+        """
+        Returns most recent 1000 passed scores across all users.
+
+        Parameters
+        ----------
+        mode
+            The mode to get scores for.
+        cursor_string
+            Cursor for pagination.
+
+        Notes
+        -----
+        Implements the `Get Scores
+        <https://osu.ppy.sh/docs/index.html#get-scores94>`__ endpoint.
+        """
+        params = {"mode": mode.value, "cursor_string": cursor_string}
+        return await self._get(Scores, "/scores", params)
+
+    @request(Scope.PUBLIC, category="scores")
+    async def score_mode(self, mode: GameModeT, score_id: int) -> Score:
         """
         Get a score, where the score id is specific to the gamemode. This
         corresponds to urls of the form https://osu.ppy.sh/scores/osu/4459998279
@@ -2688,7 +2711,7 @@ class OssapiAsync:
         Implements the `Get Score
         <https://osu.ppy.sh/docs/index.html#scoresmodescore>`__ endpoint.
         """
-        return self._get(Score, f"/scores/{mode.value}/{score_id}")
+        return await self._get(Score, f"/scores/{mode.value}/{score_id}")
 
     async def _download_score(self, *, url, raw):
         from aiohttp import ClientSession, ContentTypeError

{ossapi-5.0.2 → ossapi-5.1.0}/ossapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: ossapi
-Version: 5.0.2
+Version: 5.1.0
 Summary: Complete python wrapper for osu! api v2 and v1.
 Author-email: Liam DeVoe <orionldevoe@gmail.com>
 Project-URL: Homepage, https://github.com/tybug/ossapi

{ossapi-5.0.2 → ossapi-5.1.0}/pyproject.toml

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

{ossapi-5.0.2 → ossapi-5.1.0}/tests/test_endpoints.py

@@ -56,8 +56,13 @@ class TestBeatmapScores(TestCase):
 class TestBeatmap(TestCase):
     def test_deserialize(self):
         api.beatmap(beatmap_id=221777)
+        # beatmap with multiple owners (.owners)
+        bm = api.beatmap(beatmap_id=4060023)
+        # see https://discord.com/channels/188630481301012481/
+        # 188630616286167041/1315396179655262239
+        assert bm.owner is None
 
-        # beatmap with a diff owner
+        # beatmap with a diff owner (.owner)
         bm = api.beatmap(beatmap_id=1604098)
         # might need to be updated when
         # https://github.com/ppy/osu-web/issues/9784 is addressed.
@@ -72,6 +77,10 @@ class TestBeatmapset(TestCase):
 class TestBeatmapsetEvents(TestCase):
     def test_deserialize(self):
         api.beatmapset_events()
+        api.beatmapset_events(beatmapset_id=1339615)
+        api.beatmapset_events(beatmapset_id=692322)
+        api.beatmapset_events(beatmapset_id=724033)
+        api.beatmapset_events(beatmapset_id=1112418)
 
     def test_all_types(self):
         # beatmapset_events is a really complicated endpoint in terms of return
@@ -310,6 +319,17 @@ class TestBeatmapPack(TestCase):
         api.beatmap_pack("A1")
 
 
+class TestMultiplayerScores(TestCase):
+    def test_deserialize(self):
+        api.multiplayer_scores(1057998, 11773230)
+
+
+class TestScores(TestCase):
+    def test_deserialize(self):
+        scores = api.scores("osu")
+        api.scores("osu", cursor_string=scores.cursor_string)
+
+
 # ======================
 # api_full test cases
 # ======================