osu.py 2.2.2__tar.gz → 2.3.0__tar.gz

{osu_py-2.2.2/osu.py.egg-info → osu_py-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osu.py
-Version: 2.2.2
+Version: 2.3.0
 Summary: API Wrapper for osu!api v2 written in Python.
 Home-page: https://github.com/Sheepposu/osu.py
 Author: Sheepposu

{osu_py-2.2.2 → osu_py-2.3.0}/osu/__init__.py

@@ -14,4 +14,4 @@ from .util import (
 from .results import *
 
 
-__version__ = "2.2.2"
+__version__ = "2.3.0"

{osu_py-2.2.2 → osu_py-2.3.0}/osu/asyncio/client.py

@@ -103,7 +103,7 @@ class AsynchronousClient:
         code: Optional[str] = None,
         request_wait_time: float = 1.0,
         limit_per_minute: int = 60,
-        lazily_authenticate: bool = True
+        lazily_authenticate: bool = True,
     ) -> Union["AsynchronousClient", Awaitable]:
         """
         Creates client from client id, client secret, redirect uri, and scope.
@@ -147,6 +147,7 @@ class AsynchronousClient:
         """
         auth = AsynchronousAuthHandler(client_id, client_secret, redirect_url, scope)
         if not lazily_authenticate:
+
             async def create():
                 await auth.get_auth_token(code)
                 return cls(auth, request_wait_time, limit_per_minute)
@@ -268,9 +269,9 @@ class AsynchronousClient:
             return
         return list(
             map(
-                lambda mod: (Mod[mod.name].value if not isinstance(mod, Mod) else mod.value)
-                if type(mod) != str
-                else mod,
+                lambda mod: (
+                    (Mod[mod.name].value if not isinstance(mod, Mod) else mod.value) if type(mod) != str else mod
+                ),
                 mods,
             )
         )
@@ -1492,6 +1493,22 @@ class AsynchronousClient:
         res = await self.http.make_request(Path.get_users(), **{"ids[]": ids})
         return list(map(UserCompact, res["users"]))
 
+    async def lookup_users(self, users: list[int, str]):
+        """
+        Lookup users by a mix of user ids and usernames.
+        Can lookup maximum 50 at a time.
+
+        ids: Sequence[Union[:class:`int`, :class:`str`]]
+            Can be a list of user ids and usernames.
+            Usernames should be prefixed with "@" to make sure they're interpreted as usernames by the api.
+
+        **Returns**
+
+        Sequence[:class:`UserCompact`]
+        """
+        res = await self.http.make_request(Path.lookup_users(), **{"ids[]": users})
+        return list(map(UserCompact, res["users"]))
+
     async def get_wiki_page(self, locale: str, path: str) -> WikiPage:
         """
         The wiki article or image data.

{osu_py-2.2.2 → osu_py-2.3.0}/osu/client.py

@@ -76,7 +76,7 @@ class Client:
         code: Optional[str] = None,
         request_wait_time: float = 1.0,
         limit_per_minute: int = 60,
-        lazily_authenticate: bool = True
+        lazily_authenticate: bool = True,
     ) -> "Client":
         """
         Returns a :class:`Client` object from client id, client secret, redirect uri, and scope.
@@ -243,9 +243,9 @@ class Client:
             return
         return list(
             map(
-                lambda mod: (Mod[mod.name].value if not isinstance(mod, Mod) else mod.value)
-                if type(mod) != str
-                else mod,
+                lambda mod: (
+                    (Mod[mod.name].value if not isinstance(mod, Mod) else mod.value) if type(mod) != str else mod
+                ),
                 mods,
             )
         )
@@ -1450,6 +1450,7 @@ class Client:
     def get_users(self, ids: Sequence[int]) -> List[UserCompact]:
         """
         Returns list of users.
+        Can get maximum 50 at a time.
 
         Requires OAuth and scope public
 
@@ -1465,9 +1466,22 @@ class Client:
             Includes attributes: country, cover, groups, statistics_rulesets.
         """
         res = self.http.make_request(Path.get_users(), **{"ids[]": ids})
-        import json
-        with open("users.json", "w", encoding="utf-8") as f:
-            json.dump(res["users"], f)
+        return list(map(UserCompact, res["users"]))
+
+    def lookup_users(self, users: list[int, str]):
+        """
+        Lookup users by a mix of user ids and usernames.
+        Can lookup maximum 50 at a time.
+
+        ids: Sequence[Union[:class:`int`, :class:`str`]]
+            Can be a list of user ids and usernames.
+            Usernames should be prefixed with "@" to make sure they're interpreted as usernames by the api.
+
+        **Returns**
+
+        Sequence[:class:`UserCompact`]
+        """
+        res = self.http.make_request(Path.lookup_users(), **{"ids[]": users})
         return list(map(UserCompact, res["users"]))
 
     def get_wiki_page(self, locale: str, path: str) -> WikiPage:

{osu_py-2.2.2 → osu_py-2.3.0}/osu/objects/beatmap.py

@@ -261,7 +261,9 @@ class Beatmapset(BeatmapsetCompact):
         self.is_scoreable: bool = get_required(data, "is_scoreable")
         self.last_updated: Optional[datetime] = get_optional(data, "last_updated", parser.parse)
         self.legacy_thread_url: Optional[str] = get_required(data, "legacy_thread_url")
-        self.nominations_summary: BeatmapsetRequirement = BeatmapsetRequirement(get_required(data, "nominations_summary"))
+        self.nominations_summary: BeatmapsetRequirement = BeatmapsetRequirement(
+            get_required(data, "nominations_summary")
+        )
         self.ranked: RankStatus = RankStatus(get_required(data, "ranked"))
         self.ranked_date: Optional[datetime] = get_optional(data, "ranked_date", parser.parse)
         self.storyboard: bool = get_required(data, "storyboard")

{osu_py-2.2.2 → osu_py-2.3.0}/osu/objects/comment.py

@@ -176,7 +176,9 @@ class CommentBundle:
     )
 
     def __init__(self, data):
-        self.commentable_meta: List[CommentableMeta] = list(map(CommentableMeta, get_required(data, "commentable_meta")))
+        self.commentable_meta: List[CommentableMeta] = list(
+            map(CommentableMeta, get_required(data, "commentable_meta"))
+        )
         self.comments: List[Comment] = list(map(Comment, get_required(data, "comments")))
         self.has_more: bool = get_required(data, "has_more")
         self.has_more_id: int = get_required(data, "has_more_id")

{osu_py-2.2.2 → osu_py-2.3.0}/osu/objects/match.py

@@ -109,7 +109,9 @@ class MatchEvent:
         self.timestamp: datetime = parser.parse(get_required(data, "timestamp"))
         self.user_id: int = get_required(data, "user_id")
         self.type: MatchEventType = MatchEventType(get_required(data, "detail")["type"])
-        self.text: Optional[str] = get_required(data, "detail")["text"] if "text" in get_required(data, "detail") else None
+        self.text: Optional[str] = (
+            get_required(data, "detail")["text"] if "text" in get_required(data, "detail") else None
+        )
         self.game: Optional[MatchGame] = get_optional(data, "game", MatchGame)
 
     def __repr__(self):

{osu_py-2.2.2 → osu_py-2.3.0}/osu/objects/score.py

@@ -1,7 +1,7 @@
 from dateutil import parser
 from typing import Optional, List, TYPE_CHECKING, Union, Dict
 
-from .beatmap import BeatmapCompact, BeatmapsetCompact
+from .beatmap import BeatmapCompact, BeatmapsetCompact, Beatmap
 from .user import UserCompact
 from .current_user_attributes import ScoreUserAttributes
 from ..enums import GameModeStr, GameModeInt, Mods, Mod, ObjectType, ScoreRank
@@ -176,6 +176,10 @@ class SoloScore:
 
     beatmap_id: Optional[:class:`int`]
 
+    beatmap: Optional[:class:`Beatmap`]
+
+    beatmapset: Optional[:class:`BeatmapsetCompact`]
+
     ended_at: :class:`datetime.datetime`
 
     max_combo: :class:`int`
@@ -249,6 +253,8 @@ class SoloScore:
         "user",
         "current_user_attributes",
         "weight",
+        "beatmap",
+        "beatmapset",
     )
 
     def __init__(self, data):
@@ -280,6 +286,8 @@ class SoloScore:
             data, "current_user_attributes", ScoreUserAttributes
         )
         self.weight: Optional[PpWeight] = get_optional(data, "weight", PpWeight)
+        self.beatmap: Optional[Beatmap] = get_optional(data, "beatmap", Beatmap)
+        self.beatmapset: Optional[BeatmapsetCompact] = get_optional(data, "beatmapset", BeatmapsetCompact)
 
     def __repr__(self):
         return prettify(self, "beatmap_id", "statistics")
@@ -306,11 +314,10 @@ class PpWeight:
 
 
 def get_score_object(data) -> Union[SoloScore, LegacyScore]:
-    # EAFP cuz type attribute is not reliable
-    try:
+    if data["type"] == "solo_score":
         return SoloScore(data)
-    except KeyError:
-        return LegacyScore(data)
+
+    return LegacyScore(data)
 
 
 class ScoreStatistics:

{osu_py-2.2.2 → osu_py-2.3.0}/osu/objects/user.py

@@ -338,6 +338,9 @@ class User(UserCompact):
     post_count: :class:`int`
         number of forum posts
 
+    profile_hue: Optional[:class:`int`]
+        Custom color hue in HSL degrees (0-359).
+
     profile_order: List[:class:`str`]
         Ordered list of sections in user profile page. Sections consist of:
         me, recent_activity, beatmaps, historical, kudosu, top_ranks, medals
@@ -365,11 +368,12 @@ class User(UserCompact):
         "playmode",
         "playstyle",
         "post_count",
+        "profile_hue",
         "profile_order",
         "title",
         "title_url",
         "twitter",
-        "website"
+        "website",
     )
 
     def __init__(self, data):
@@ -387,6 +391,7 @@ class User(UserCompact):
         self.playmode: GameModeStr = GameModeStr(get_required(data, "playmode"))
         self.playstyle: List[str] = get_required(data, "playstyle")
         self.post_count: int = get_required(data, "post_count")
+        self.profile_hue: Optional[int] = get_required(data, "profile_hue")
         self.profile_order: List[str] = get_required(data, "profile_order")
         self.title: Optional[str] = get_required(data, "title")
         self.title_url: Optional[str] = get_required(data, "title_url")
@@ -753,7 +758,9 @@ class UserStatistics:
         self.country_rank: Optional[int] = data.get("country_rank")
         self.global_rank: Optional[int] = get_required(data, "global_rank")
         self.global_rank_exp: Optional[int] = data.get("global_rank_exp")
-        self.grade_counts: NamedTuple = namedtuple("GradeCounts", ("ssh", "ss", "sh", "s", "a"))(**get_required(data, "grade_counts"))
+        self.grade_counts: NamedTuple = namedtuple("GradeCounts", ("ssh", "ss", "sh", "s", "a"))(
+            **get_required(data, "grade_counts")
+        )
         self.level: NamedTuple = namedtuple("Level", ("current", "progress"))(**get_required(data, "level"))
         self.hit_accuracy: float = get_required(data, "hit_accuracy")
         self.is_ranked: bool = get_required(data, "is_ranked")
@@ -1027,7 +1034,7 @@ class DailyChallengeUserStats:
         "top_50p_placements",
         "user_id",
         "weekly_streak_best",
-        "weekly_streak_current"
+        "weekly_streak_current",
     )
 
     def __init__(self, data):

{osu_py-2.2.2 → osu_py-2.3.0}/osu/path.py

@@ -172,6 +172,10 @@ class Path:
     def get_users(cls):
         return cls("get", "users", "public")
 
+    @classmethod
+    def lookup_users(cls):
+        return cls("get", "users/lookup", "public")
+
     @classmethod
     def get_wiki_page(cls, locale, path):
         return cls("get", f"wiki/{locale}/{path}", None)

{osu_py-2.2.2 → osu_py-2.3.0}/osu/util.py

@@ -396,8 +396,11 @@ def get_optional_list(data: Dict[str, _V], key: str, obj: Callable[[_V], _T]) ->
 # if testing, raise an error for expected keys
 # otherwise return none to avoid key errors in prod
 if os.getenv("OSUPY_TEST") is None:
+
     def get_required(data: Dict[str, _V], key: str):
         return data.get(key)
+
 else:
+
     def get_required(data: Dict[str, _V], key: str):
         return data[key]

{osu_py-2.2.2 → osu_py-2.3.0/osu.py.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osu.py
-Version: 2.2.2
+Version: 2.3.0
 Summary: API Wrapper for osu!api v2 written in Python.
 Home-page: https://github.com/Sheepposu/osu.py
 Author: Sheepposu