From 82a94cac7afe4bde895813d665986b197793426f Mon Sep 17 00:00:00 2001 From: grey-cat-1908 Date: Sun, 4 Jun 2023 13:21:23 +0300 Subject: [PATCH] fix && formation --- boticordpy/client.py | 2 +- boticordpy/types.py | 126 +++++++++++++++++++++---------------------- docs/source/conf.py | 8 ++- 3 files changed, 69 insertions(+), 67 deletions(-) diff --git a/boticordpy/client.py b/boticordpy/client.py index 1d8aaed..e353f2c 100644 --- a/boticordpy/client.py +++ b/boticordpy/client.py @@ -62,7 +62,7 @@ class BoticordClient: Bot's shards count users ( :obj:`int` ) Bot's users count - + Returns: :obj:`~.types.ResourceBot`: ResourceBot object. diff --git a/boticordpy/types.py b/boticordpy/types.py index c10a442..22a60fe 100644 --- a/boticordpy/types.py +++ b/boticordpy/types.py @@ -213,37 +213,37 @@ class BotLibrary(IntEnum): DISCORD4J = 1 """Discord4j""" - + DISCORDCR = 2 """Discordcr""" - + DISCORDGO = 3 """DiscordGO""" - + DISCORDDOO = 4 """Discordoo""" - + DSHARPPLUS = 5 """DSharpPlus""" - + DISCORDJS = 6 """Discord.js""" - + DISCORDNET = 7 """Discord.Net""" - + DISCORDPY = 8 """discord.py""" - + ERIS = 9 """eris""" - + JAVACORD = 10 """JavaCord""" - + JDA = 11 """JDA""" - + OTHER = 12 """Other""" @@ -409,7 +409,7 @@ class UserLinks(APIObjectBase): self.custon = data.get("custom") return self - + @dataclass(repr=False) class UserBadge(APIObjectBase): @@ -435,9 +435,9 @@ class UserBadge(APIObjectBase): """ self: UserBadge = super().__new__(cls) - self.id = data['id'] - self.name = data['name'] - self.asset_url = data['assetURL'] + self.id = data["id"] + self.name = data["name"] + self.asset_url = data["assetURL"] return self @@ -554,11 +554,6 @@ class PartialUser(APIObjectBase): self.short_domain = data.get("shortDomain") return self - - -@dataclass(repr=False) -class ResourceBot(APIObjectBase): - """Tak nado""" @dataclass(repr=False) @@ -639,24 +634,24 @@ class ResourceServer(APIObjectBase): ---------- data: :class:`dict` The dictionary to convert into a ResourceServer.""" - + self = super().__new__(cls) - self.id = data['id'] - self.name = data['name'] - self.short_description = data['shortDescription'] - self.description = data['description)'] + self.id = data["id"] + self.name = data["name"] + self.short_description = data["shortDescription"] + self.description = data["description)"] self.avatar = data.get("avatar") self.short_link = data.get("shortLink") self.invite_link = data.get("inviteLink") self.owner = data.get("owner") self.website = data.get("website") self.up_count = data.get("upCount") - - self.premium_active = data['premium'].get('active') - self.premium_splash_url = data['premium'].get('splashURL') - self.premium_auto_fetch = data['premium'].get('autoFetch') - self.premium_banner_url = data['premium'].get('bannerURL') + + self.premium_active = data["premium"].get("active") + self.premium_splash_url = data["premium"].get("splashURL") + self.premium_auto_fetch = data["premium"].get("autoFetch") + self.premium_banner_url = data["premium"].get("bannerURL") self.status = ResourceStatus(data.get("status")) self.ratings = [ @@ -676,46 +671,14 @@ class ResourceServer(APIObjectBase): return self -@dataclass(repr=False) -class UserProfile(PartialUser): - """Information about user's profile from BotiCord. - - It has all from PartialUser and some more params: 'bots', 'servers', 'badges'""" - - badges: List[UserBadge] - """User's badges list.""" - - bots: List[ResourceBot] - """User's bots list""" - - servers: List[ResourceServer] - """User's servers list""" - - @classmethod - def from_dict(cls, data: dict): - """Generate a UserProfile from the given data. - - Parameters - ---------- - data: :class:`dict` - The dictionary to convert into a UserProfile.""" - - self = super().from_dict(data) - - self.badges = [UserBadge.from_dict(badge) for badge in data.get('badges', [])] - self.bots = [ResourceBot.from_dict(bot) for bot in data.get('bots', [])] - self.servers = [ResourceServer.from_dict(server) for server in data.get('servers', [])] - - return self - - @dataclass(repr=False) class ResourceBot(APIObjectBase): """Bot published on BotiCord .. warning:: - The result of the reverse conversion (`.to_dict()`) may not match the actual data.""" + The result of the reverse conversion (`.to_dict()`) may not match the actual data. + """ id: str """ID of the bot""" @@ -852,5 +815,40 @@ class ResourceBot(APIObjectBase): return self +@dataclass(repr=False) +class UserProfile(PartialUser): + """Information about user's profile from BotiCord. + + It has all from PartialUser and some more params: 'bots', 'servers', 'badges'""" + + badges: List[UserBadge] + """User's badges list.""" + + bots: List[ResourceBot] + """User's bots list""" + + servers: List[ResourceServer] + """User's servers list""" + + @classmethod + def from_dict(cls, data: dict): + """Generate a UserProfile from the given data. + + Parameters + ---------- + data: :class:`dict` + The dictionary to convert into a UserProfile.""" + + self = super().from_dict(data) + + self.badges = [UserBadge.from_dict(badge) for badge in data.get("badges", [])] + self.bots = [ResourceBot.from_dict(bot) for bot in data.get("bots", [])] + self.servers = [ + ResourceServer.from_dict(server) for server in data.get("servers", []) + ] + + return self + + class LinkDomain: pass diff --git a/docs/source/conf.py b/docs/source/conf.py index 961f62b..88ac24a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -42,10 +42,14 @@ extensions = [ "sphinx.ext.viewcode", "sphinx.ext.autosectionlabel", "sphinx.ext.extlinks", - "sphinxcontrib_trio" + "sphinxcontrib_trio", ] -autodoc_default_options = {"members": True, "show-inheritance": True, 'member-order': 'bysource'} +autodoc_default_options = { + "members": True, + "show-inheritance": True, + "member-order": "bysource", +} # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"]