mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-06-07 12:18:59 +00:00
Code Issues Projects Releases Wiki Activity

[commands] Properly raise the correct exception for owner_ids

Browse Source 
Also some minor nits with documentation.
This commit is contained in:
Rapptz 2019-06-29 19:26:45 -04:00
parent 69364a25eb
commit 68342db04d
3 changed files with 15 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
discord/ext/commands/bot.py
View File

@ -111,13 +111,10 @@ class BotBase(GroupMixin):
self.owner_ids = options.get('owner_ids', {}) self.owner_ids = options.get('owner_ids', {})
if self.owner_id and self.owner_ids: if self.owner_id and self.owner_ids:
raise ValueError('Both owner_id and owner_ids are set.') raise TypeError('Both owner_id and owner_ids are set.')
elif not isinstance(self.owner_id, int):
raise ValueError('owner_id is not an int.') if self.owner_ids and not isinstance(self.owner_ids, collections.abc.Collection):
elif not isinstance(self.owner_ids, (set, list, tuple)): raise TypeError('owner_ids must be a collection not {0.__class__!r}'.format(self.owner_ids))
raise ValueError('owner_ids is not a set, list or tuple.')
elif not all(isinstance(i, int) for i in self.owner_ids):
raise ValueError('owner_ids has to be an iterable of int.')
if options.pop('self_bot', False): if options.pop('self_bot', False):
self._skip_check = lambda x, y: x != y self._skip_check = lambda x, y: x != y
@ -295,7 +292,7 @@ class BotBase(GroupMixin):
through the use of :meth:`~.Bot.application_info`. through the use of :meth:`~.Bot.application_info`.
The function also checks if the application is team-owned if The function also checks if the application is team-owned if
:attr:`owner_id` is not set. :attr:`owner_ids` is not set.
Parameters Parameters
----------- -----------
@ -315,8 +312,8 @@ class BotBase(GroupMixin):
else: else:
app = await self.application_info() app = await self.application_info()
if app.team: if app.team:
self.owner_ids = {m.id for m in app.team.members} self.owner_ids = ids = {m.id for m in app.team.members}
return user.id in self.owner_ids return user.id in ids
else: else:
self.owner_id = owner_id = app.owner.id self.owner_id = owner_id = app.owner.id
return user.id == owner_id return user.id == owner_id
@ -980,12 +977,15 @@ class Bot(BotBase, discord.Client):
set at runtime. To remove the help command pass ``None``. For more set at runtime. To remove the help command pass ``None``. For more
information on implementing a help command, see :ref:`ext_commands_help_command`. information on implementing a help command, see :ref:`ext_commands_help_command`.
owner_id: Optional[:class:`int`] owner_id: Optional[:class:`int`]
The ID that owns the bot. If this is not set and is then queried via The user ID that owns the bot. If this is not set and is then queried via
:meth:`.is_owner` then it is fetched automatically using :meth:`.is_owner` then it is fetched automatically using
:meth:`~.Bot.application_info`. :meth:`~.Bot.application_info`.
owner_ids: Optional[:class:`set`] owner_ids: Optional[Collection[:class:`int`]]
The IDs that owns the bot. This is similar to `owner_id`. The user IDs that owns the bot. This is similar to `owner_id`.
If both `owner_id` and `owner_ids` are set, ValueError would be raised. If this is not set and the application is team based, then it is
fetched automatically using :meth:`~.Bot.application_info`.
For performance reasons it is recommended to use a :class:`set`
for the collection. You cannot set both `owner_id` and `owner_ids`.
""" """
pass pass

2
discord/team.py
View File

@ -33,7 +33,6 @@ from .enums import TeamMembershipState, try_enum
class Team: class Team:
"""Represents an application team for a bot provided by Discord. """Represents an application team for a bot provided by Discord.
Attributes Attributes
------------- -------------
id: :class:`int` id: :class:`int`
@ -75,7 +74,6 @@ class Team:
class TeamMember: class TeamMember:
"""Represents a team member in a team. """Represents a team member in a team.
Attributes Attributes
------------- -------------
team: :class:`team` team: :class:`team`

5
docs/api.rst
View File

@ -42,9 +42,6 @@ Client
.. autoclass:: AppInfo .. autoclass:: AppInfo
:members: :members:
.. autoclass:: GameInfo
:members:
.. autoclass:: Team .. autoclass:: Team
:members: :members:
@ -1547,7 +1544,7 @@ of :class:`enum.Enum`.
.. class:: TeamMembershipState .. class:: TeamMembershipState
Represents the membership state of a team member retrieved through :func:Bot.application_info. Represents the membership state of a team member retrieved through :func:Bot.application_info.
.. attribue:: invited .. attribue:: invited