ossapi 5.2.1__tar.gz → 5.3.1__tar.gz

{ossapi-5.2.1 → ossapi-5.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ossapi
-Version: 5.2.1
+Version: 5.3.1
 Summary: The definitive python wrapper for the osu! api
 Author-email: Liam DeVoe <orionldevoe@gmail.com>
 Project-URL: Homepage, https://github.com/tybug/ossapi

{ossapi-5.2.1 → ossapi-5.3.1}/ossapi/__init__.py

@@ -4,147 +4,147 @@ import logging
 handler = logging.StreamHandler()
 logging.getLogger("ossapi").addHandler(handler)
 
-from ossapi.ossapi import (
-    OssapiV1,
-    ReplayUnavailableException,
-    InvalidKeyException,
-    APIException,
-)
-from ossapi.ossapiv2 import Ossapi, Grant, Scope, Domain
-from ossapi.models import (
-    Beatmap,
-    BeatmapCompact,
-    BeatmapUserScore,
-    ForumTopicAndPosts,
-    Search,
-    CommentBundle,
-    Cursor,
-    Score,
-    BeatmapsetSearchResult,
-    ModdingHistoryEventsBundle,
-    User,
-    Rankings,
-    BeatmapScores,
-    KudosuHistory,
-    Beatmapset,
-    BeatmapPlaycount,
-    Spotlight,
-    Spotlights,
-    WikiPage,
-    _Event,
-    Event,
-    BeatmapsetDiscussionPosts,
-    Build,
-    ChangelogListing,
-    MultiplayerScores,
-    BeatmapsetDiscussionVotes,
-    CreatePMResponse,
-    BeatmapsetDiscussions,
-    UserCompact,
-    BeatmapsetCompact,
-    ForumPoll,
-    Room,
-    RoomPlaylistItem,
-    RoomPlaylistItemMod,
-    RoomLeaderboardScore,
-    RoomLeaderboardUserScore,
-    RoomLeaderboard,
-    Match,
-    Matches,
-    MatchResponse,
-    ScoreMatchInfo,
-    MatchGame,
-    MatchEventDetail,
-    MatchEvent,
-    ScoringType,
-    TeamType,
-    StatisticsVariant,
-    Events,
-    BeatmapPack,
-    BeatmapPacks,
-)
+from oauthlib.oauth2 import AccessDeniedError, TokenExpiredError
+from oauthlib.oauth2.rfc6749.errors import InsufficientScopeError
+
+from ossapi.encoder import ModelEncoder, serialize_model
 from ossapi.enums import (
-    GameMode,
-    ScoreType,
-    RankingFilter,
-    RankingType,
-    UserBeatmapType,
+    Availability,
     BeatmapDiscussionPostSort,
-    UserLookupKey,
-    BeatmapsetEventType,
-    CommentableType,
-    CommentSort,
-    ForumTopicSort,
-    SearchMode,
-    MultiplayerScoresSort,
+    BeatmapPackType,
+    BeatmapPackUserCompletionData,
     BeatmapsetDiscussionVote,
     BeatmapsetDiscussionVoteSort,
-    BeatmapsetStatus,
-    MessageType,
+    BeatmapsetEventType,
     BeatmapsetSearchCategory,
-    BeatmapsetSearchMode,
     BeatmapsetSearchExplicitContent,
-    BeatmapsetSearchLanguage,
     BeatmapsetSearchGenre,
-    NewsPostKey,
+    BeatmapsetSearchLanguage,
+    BeatmapsetSearchMode,
     BeatmapsetSearchSort,
-    RoomType,
-    RoomCategory,
-    RoomSearchMode,
-    MatchEventType,
-    Variant,
+    BeatmapsetStatus,
+    ChangelogSearch,
+    CommentableType,
+    CommentSort,
+    Country,
+    Cover,
+    Covers,
+    EventAchivement,
+    EventBeatmap,
+    EventBeatmapset,
     EventsSort,
-    Statistics,
-    Availability,
+    EventUser,
+    Failtimes,
+    ForumPollText,
+    ForumPollTitle,
+    ForumPostBody,
+    ForumTopicSort,
+    GameMode,
+    GithubUser,
+    GroupDescription,
     Hype,
-    Nominations,
-    Nomination,
     Kudosu,
     KudosuGiver,
     KudosuPost,
     KudosuVote,
-    EventUser,
-    EventBeatmap,
-    EventBeatmapset,
-    EventAchivement,
-    GithubUser,
-    ChangelogSearch,
+    MatchEventType,
+    MessageType,
+    MultiplayerScoresSort,
+    NewsPostKey,
     NewsSearch,
-    ForumPostBody,
-    ForumPollText,
-    ForumPollTitle,
-    ReviewsConfig,
+    Nomination,
+    Nominations,
+    ProfileBanner,
     RankHighest,
+    RankHistory,
+    Ranking,
+    RankingFilter,
+    RankingType,
+    ReviewsConfig,
+    RoomCategory,
+    RoomSearchMode,
+    RoomType,
+    ScoreType,
+    SearchMode,
+    Statistics,
+    UserAccountHistory,
+    UserBadge,
+    UserBeatmapType,
+    UserGradeCounts,
+    UserGroup,
+    UserLevel,
+    UserLookupKey,
     UserMonthlyPlaycount,
     UserPage,
-    UserLevel,
-    UserGradeCounts,
-    UserReplaysWatchedCount,
     UserProfileCustomization,
-    RankHistory,
+    UserReplaysWatchedCount,
+    Variant,
     Weight,
-    Covers,
-    UserGroup,
-    GroupDescription,
-    UserBadge,
-    UserAccountHistory,
-    ProfileBanner,
-    Cover,
-    Country,
-    Ranking,
-    Failtimes,
-    BeatmapPackType,
-    BeatmapPackUserCompletionData,
 )
 from ossapi.mod import Mod
-from ossapi.replay import Replay
-from ossapi.encoder import ModelEncoder, serialize_model
+from ossapi.models import (
+    Beatmap,
+    BeatmapCompact,
+    BeatmapPack,
+    BeatmapPacks,
+    BeatmapPlaycount,
+    BeatmapScores,
+    Beatmapset,
+    BeatmapsetCompact,
+    BeatmapsetDiscussionPosts,
+    BeatmapsetDiscussions,
+    BeatmapsetDiscussionVotes,
+    BeatmapsetSearchResult,
+    BeatmapUserScore,
+    Build,
+    ChangelogListing,
+    CommentBundle,
+    CreatePMResponse,
+    Cursor,
+    Event,
+    Events,
+    ForumPoll,
+    ForumTopicAndPosts,
+    KudosuHistory,
+    Match,
+    Matches,
+    MatchEvent,
+    MatchEventDetail,
+    MatchGame,
+    MatchResponse,
+    ModdingHistoryEventsBundle,
+    MultiplayerScores,
+    Rankings,
+    Room,
+    RoomLeaderboard,
+    RoomLeaderboardScore,
+    RoomLeaderboardUserScore,
+    RoomPlaylistItem,
+    RoomPlaylistItemMod,
+    Score,
+    ScoreMatchInfo,
+    ScoringType,
+    Search,
+    Spotlight,
+    Spotlights,
+    StatisticsVariant,
+    TeamType,
+    User,
+    UserCompact,
+    WikiPage,
+    _Event,
+)
+from ossapi.ossapi import (
+    APIException,
+    InvalidKeyException,
+    OssapiV1,
+    ReplayUnavailableException,
+)
+from ossapi.ossapiv2 import Domain, Grant, Ossapi, Scope
 from ossapi.ossapiv2_async import OssapiAsync
+from ossapi.replay import Replay
 
-from oauthlib.oauth2 import AccessDeniedError, TokenExpiredError
-from oauthlib.oauth2.rfc6749.errors import InsufficientScopeError
-
-__version__ = "5.2.1"
+__version__ = "5.3.1"
 
 __all__ = [
     # OssapiV1

{ossapi-5.2.1 → ossapi-5.3.1}/ossapi/enums.py

@@ -1,6 +1,6 @@
-from typing import Optional, List, Any
+from typing import Any, Optional
 
-from ossapi.utils import EnumModel, Datetime, Model, Field, IntFlagModel
+from ossapi.utils import Datetime, EnumModel, Field, IntFlagModel, Model
 
 # ================
 # Documented Enums

{ossapi-5.2.1 → ossapi-5.3.1}/ossapi/models.py

@@ -2,77 +2,78 @@
 # https://docs.python.org/3.7/whatsnew/3.7.html#pep-563-postponed-evaluation-
 # of-annotations
 from __future__ import annotations
-from typing import Optional, TypeVar, Generic, Any, Union
+
 from dataclasses import dataclass
+from typing import Any, Generic, Optional, TypeVar, Union
 
-from ossapi.mod import Mod
 from ossapi.enums import (
-    UserAccountHistory,
-    ProfileBanner,
-    UserBadge,
+    Availability,
+    BeatmapOwner,
+    BeatmapPackUserCompletionData,
+    BeatmapsetApproval,
+    BeatmapsetEventType,
+    BeatmapTag,
+    ChangelogSearch,
+    ChannelType,
     Country,
     Cover,
-    UserGroup,
-    UserMonthlyPlaycount,
-    UserPage,
-    UserReplaysWatchedCount,
-    UserAchievement,
-    UserProfileCustomization,
-    RankHistory,
-    Kudosu,
-    PlayStyles,
-    ProfilePage,
-    GameMode,
-    RankStatus,
-    Failtimes,
     Covers,
-    Hype,
-    Availability,
-    Nominations,
-    Statistics,
-    Grade,
-    Weight,
-    MessageType,
-    KudosuAction,
-    KudosuGiver,
-    KudosuPost,
-    EventType,
     EventAchivement,
-    EventUser,
     EventBeatmap,
-    BeatmapsetApproval,
     EventBeatmapset,
-    KudosuVote,
-    BeatmapsetEventType,
-    UserRelationType,
-    UserLevel,
-    UserGradeCounts,
-    GithubUser,
-    ChangelogSearch,
-    ForumTopicType,
+    EventType,
+    EventUser,
+    Failtimes,
+    ForumPollText,
+    ForumPollTitle,
     ForumPostBody,
     ForumTopicSort,
-    ChannelType,
-    ReviewsConfig,
+    ForumTopicType,
+    GameMode,
+    GithubUser,
+    Grade,
+    Hype,
+    Kudosu,
+    KudosuAction,
+    KudosuGiver,
+    KudosuPost,
+    KudosuVote,
+    MatchEventType,
+    MessageType,
     NewsSearch,
     Nomination,
+    Nominations,
+    PlayStyles,
+    ProfileBanner,
+    ProfilePage,
     RankHighest,
-    RoomType,
+    RankHistory,
+    RankStatus,
+    ReviewsConfig,
     RoomCategory,
-    MatchEventType,
+    RoomDifficultyRange,
+    RoomPlaylistItemStats,
+    RoomType,
     ScoringType,
+    Statistics,
+    Team,
     TeamType,
+    UserAccountHistory,
+    UserAchievement,
+    UserBadge,
+    UserGradeCounts,
+    UserGroup,
+    UserLevel,
+    UserMonthlyPlaycount,
+    UserPage,
+    UserProfileCustomization,
+    UserRelationType,
+    UserReplaysWatchedCount,
     Variant,
-    ForumPollText,
-    ForumPollTitle,
-    BeatmapPackUserCompletionData,
-    RoomPlaylistItemStats,
-    RoomDifficultyRange,
-    BeatmapOwner,
-    BeatmapTag,
-    Team,
+    Weight,
 )
-from ossapi.utils import Datetime, Model, BaseModel, Field
+from ossapi.mod import Mod
+from ossapi.utils import BaseModel, Datetime, Field, Model
 
 T = TypeVar("T")
 S = TypeVar("S")
@@ -234,6 +235,7 @@ class User(UserCompact):
     scores_pinned_count: int
     nominated_beatmapset_count: int
     rank_highest: Optional[RankHighest]
+    current_season_stats: Optional[SeasonStatistics]
 
     def expand(self) -> User:
         # we're already expanded, no need to waste an api call
@@ -276,6 +278,9 @@ class Beatmap(BeatmapCompact):
     ar: float
     bpm: Optional[float]
     current_user_tag_ids: list[int]
+    # this might be non-optional? should test with client credentials grant.
+    current_user_playcount: Optional[int]
+    top_tag_ids: list[int]
     convert: bool
     count_circles: int
     count_sliders: int
@@ -691,6 +696,28 @@ class Spotlights(Model):
     spotlights: list[Spotlight]
 
 
+class SeasonDivision(Model):
+    colour_tier: str
+    id: int
+    image_url: str
+    name: str
+    threshold: float
+
+
+class Season(Model):
+    start_date: Datetime
+    end_date: Optional[Datetime]
+    name: str
+    room_count: int
+
+
+class SeasonStatistics(Model):
+    division: SeasonDivision
+    season: Season
+    rank: int
+    total_score: float
+
+
 # return-value wrapper for https://osu.ppy.sh/docs/index.html#get-users.
 class Users(Model):
     users: list[UserCompact]
@@ -710,6 +737,7 @@ class BeatmapPacks(Model):
 class Rankings(Model):
     beatmapsets: Optional[list[Beatmapset]]
     cursor: CursorT
+    cursor_string: Optional[str]
     ranking: Union[list[UserStatistics], list[CountryStatistics]]
     spotlight: Optional[Spotlight]
     total: Optional[int]
@@ -962,6 +990,7 @@ class ChangelogListing(Model):
 
 
 class MultiplayerScores(Model):
+    cursor: CursorT
     cursor_string: CursorStringT
     params: Any
     scores: list[MultiplayerScore]
@@ -1004,7 +1033,7 @@ class MultiplayerScore(Model):
     current_user_attributes: Any
     has_replay: bool
     legacy_perfect: bool
-    legacy_score_id: int
+    legacy_score_id: Optional[int]
     legacy_total_score: int
 
     def beatmap(self):
@@ -1610,7 +1639,12 @@ class Tag(Model):
     id: int
     name: str
     description: str
+    ruleset_id: Optional[int]
 
 
 class Tags(Model):
     tags: list[Tag]
+
+
+class BeatmapsPassed(Model):
+    beatmaps_passed: list[BeatmapCompact]

{ossapi-5.2.1 → ossapi-5.3.1}/ossapi/ossapi.py

@@ -1,8 +1,7 @@
-from json.decoder import JSONDecodeError
 import logging
-from datetime import datetime, timezone
-from typing import List
 import time
+from datetime import datetime, timezone
+from json.decoder import JSONDecodeError
 
 import requests
 from requests import RequestException