fix && formation

This commit is contained in:
grey-cat-1908 2023-06-04 13:21:23 +03:00
parent f9c8b04428
commit 82a94cac7a
3 changed files with 69 additions and 67 deletions

View file

@ -62,7 +62,7 @@ class BoticordClient:
Bot's shards count Bot's shards count
users ( :obj:`int` ) users ( :obj:`int` )
Bot's users count Bot's users count
Returns: Returns:
:obj:`~.types.ResourceBot`: :obj:`~.types.ResourceBot`:
ResourceBot object. ResourceBot object.

View file

@ -213,37 +213,37 @@ class BotLibrary(IntEnum):
DISCORD4J = 1 DISCORD4J = 1
"""Discord4j""" """Discord4j"""
DISCORDCR = 2 DISCORDCR = 2
"""Discordcr""" """Discordcr"""
DISCORDGO = 3 DISCORDGO = 3
"""DiscordGO""" """DiscordGO"""
DISCORDDOO = 4 DISCORDDOO = 4
"""Discordoo""" """Discordoo"""
DSHARPPLUS = 5 DSHARPPLUS = 5
"""DSharpPlus""" """DSharpPlus"""
DISCORDJS = 6 DISCORDJS = 6
"""Discord.js""" """Discord.js"""
DISCORDNET = 7 DISCORDNET = 7
"""Discord.Net""" """Discord.Net"""
DISCORDPY = 8 DISCORDPY = 8
"""discord.py""" """discord.py"""
ERIS = 9 ERIS = 9
"""eris""" """eris"""
JAVACORD = 10 JAVACORD = 10
"""JavaCord""" """JavaCord"""
JDA = 11 JDA = 11
"""JDA""" """JDA"""
OTHER = 12 OTHER = 12
"""Other""" """Other"""
@ -409,7 +409,7 @@ class UserLinks(APIObjectBase):
self.custon = data.get("custom") self.custon = data.get("custom")
return self return self
@dataclass(repr=False) @dataclass(repr=False)
class UserBadge(APIObjectBase): class UserBadge(APIObjectBase):
@ -435,9 +435,9 @@ class UserBadge(APIObjectBase):
""" """
self: UserBadge = super().__new__(cls) self: UserBadge = super().__new__(cls)
self.id = data['id'] self.id = data["id"]
self.name = data['name'] self.name = data["name"]
self.asset_url = data['assetURL'] self.asset_url = data["assetURL"]
return self return self
@ -554,11 +554,6 @@ class PartialUser(APIObjectBase):
self.short_domain = data.get("shortDomain") self.short_domain = data.get("shortDomain")
return self return self
@dataclass(repr=False)
class ResourceBot(APIObjectBase):
"""Tak nado"""
@dataclass(repr=False) @dataclass(repr=False)
@ -639,24 +634,24 @@ class ResourceServer(APIObjectBase):
---------- ----------
data: :class:`dict` data: :class:`dict`
The dictionary to convert into a ResourceServer.""" The dictionary to convert into a ResourceServer."""
self = super().__new__(cls) self = super().__new__(cls)
self.id = data['id'] self.id = data["id"]
self.name = data['name'] self.name = data["name"]
self.short_description = data['shortDescription'] self.short_description = data["shortDescription"]
self.description = data['description)'] self.description = data["description)"]
self.avatar = data.get("avatar") self.avatar = data.get("avatar")
self.short_link = data.get("shortLink") self.short_link = data.get("shortLink")
self.invite_link = data.get("inviteLink") self.invite_link = data.get("inviteLink")
self.owner = data.get("owner") self.owner = data.get("owner")
self.website = data.get("website") self.website = data.get("website")
self.up_count = data.get("upCount") self.up_count = data.get("upCount")
self.premium_active = data['premium'].get('active') self.premium_active = data["premium"].get("active")
self.premium_splash_url = data['premium'].get('splashURL') self.premium_splash_url = data["premium"].get("splashURL")
self.premium_auto_fetch = data['premium'].get('autoFetch') self.premium_auto_fetch = data["premium"].get("autoFetch")
self.premium_banner_url = data['premium'].get('bannerURL') self.premium_banner_url = data["premium"].get("bannerURL")
self.status = ResourceStatus(data.get("status")) self.status = ResourceStatus(data.get("status"))
self.ratings = [ self.ratings = [
@ -676,46 +671,14 @@ class ResourceServer(APIObjectBase):
return self 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) @dataclass(repr=False)
class ResourceBot(APIObjectBase): class ResourceBot(APIObjectBase):
"""Bot published on BotiCord """Bot published on BotiCord
.. warning:: .. 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: str
"""ID of the bot""" """ID of the bot"""
@ -852,5 +815,40 @@ class ResourceBot(APIObjectBase):
return self 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: class LinkDomain:
pass pass

View file

@ -42,10 +42,14 @@ extensions = [
"sphinx.ext.viewcode", "sphinx.ext.viewcode",
"sphinx.ext.autosectionlabel", "sphinx.ext.autosectionlabel",
"sphinx.ext.extlinks", "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. # Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"] templates_path = ["_templates"]