matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

[commands] Add support for IDs in the role related checks.

Browse Source 
This affects:

* commands.has_role
* commands.has_any_role
* commands.bot_has_role
* commands.bot_has_any_role
This commit is contained in:
Xua 2018-11-11 13:47:19 +13:00 committed by Rapptz
parent 6bfd92e4a5
commit 016963500b
1 changed files with 25 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
discord/ext/commands/core.py
View File

@ -1208,42 +1208,47 @@ def check(predicate):
return func return func
return decorator return decorator
def has_role(name): def has_role(item):
"""A :func:`.check` that is added that checks if the member invoking the """A :func:`.check` that is added that checks if the member invoking the
command has the role specified via the name specified. command has the role specified via the name or ID specified.
The name is case sensitive and must be exact. No normalisation is done in If a string is specified, you must give the exact name of the role, including
the input. caps and spelling.
If an integer is specified, you must give the exact snowflake ID of the role.
If the message is invoked in a private message context then the check will If the message is invoked in a private message context then the check will
return ``False``. return ``False``.
Parameters Parameters
----------- -----------
name: str item: Union[int, str]
The name of the role to check. The name or ID of the role to check.
""" """
def predicate(ctx): def predicate(ctx):
if not isinstance(ctx.channel, discord.abc.GuildChannel): if not isinstance(ctx.channel, discord.abc.GuildChannel):
return False return False
role = discord.utils.get(ctx.author.roles, name=name) if isinstance(item, int):
role = discord.utils.get(ctx.author.roles, id=item)
else:
role = discord.utils.get(ctx.author.roles, name=item)
return role is not None return role is not None
return check(predicate) return check(predicate)
def has_any_role(*names): def has_any_role(*items):
r"""A :func:`.check` that is added that checks if the member invoking the r"""A :func:`.check` that is added that checks if the member invoking the
command has **any** of the roles specified. This means that if they have command has **any** of the roles specified. This means that if they have
one out of the three roles specified, then this check will return `True`. one out of the three roles specified, then this check will return `True`.
Similar to :func:`.has_role`\, the names passed in must be exact. Similar to :func:`.has_role`\, the names or IDs passed in must be exact.
Parameters Parameters
----------- -----------
names items
An argument list of names to check that the member has roles wise. An argument list of names or IDs to check that the member has roles wise.
Example Example
-------- --------
@ -1251,7 +1256,7 @@ def has_any_role(*names):
.. code-block:: python3 .. code-block:: python3
@bot.command() @bot.command()
@commands.has_any_role('Library Devs', 'Moderators') @commands.has_any_role('Library Devs', 'Moderators', 492212595072434186)
async def cool(ctx): async def cool(ctx):
await ctx.send('You are cool indeed') await ctx.send('You are cool indeed')
""" """
@ -1260,7 +1265,7 @@ def has_any_role(*names):
return False return False
getter = functools.partial(discord.utils.get, ctx.author.roles) getter = functools.partial(discord.utils.get, ctx.author.roles)
return any(getter(name=name) is not None for name in names) return any(getter(id=item) is not None if isinstance(item, int) else getter(name=item) is not None for item in items)
return check(predicate) return check(predicate)
def has_permissions(**perms): def has_permissions(**perms):
@ -1302,7 +1307,7 @@ def has_permissions(**perms):
return check(predicate) return check(predicate)
def bot_has_role(name): def bot_has_role(item):
"""Similar to :func:`.has_role` except checks if the bot itself has the """Similar to :func:`.has_role` except checks if the bot itself has the
role. role.
""" """
@ -1312,11 +1317,14 @@ def bot_has_role(name):
if not isinstance(ch, discord.abc.GuildChannel): if not isinstance(ch, discord.abc.GuildChannel):
return False return False
me = ch.guild.me me = ch.guild.me
role = discord.utils.get(me.roles, name=name) if isinstance(item, int):
role = discord.utils.get(me.roles, id=item)
else:
role = discord.utils.get(me.roles, name=item)
return role is not None return role is not None
return check(predicate) return check(predicate)
def bot_has_any_role(*names): def bot_has_any_role(*items):
"""Similar to :func:`.has_any_role` except checks if the bot itself has """Similar to :func:`.has_any_role` except checks if the bot itself has
any of the roles listed. any of the roles listed.
""" """
@ -1326,7 +1334,7 @@ def bot_has_any_role(*names):
return False return False
me = ch.guild.me me = ch.guild.me
getter = functools.partial(discord.utils.get, me.roles) getter = functools.partial(discord.utils.get, me.roles)
return any(getter(name=name) is not None for name in names) return any(getter(id=item) is not None if isinstance(item, int) else getter(name=item) is not None for item in items)
return check(predicate) return check(predicate)
def bot_has_permissions(**perms): def bot_has_permissions(**perms):