Built-in Checks for the commands extension of discord py

Checks.py

@commands.guild_only()
# Command cannot be used in private messages.

@commands.dm_only()
# Command can only be used in private messages.

@commands.is_owner()
# Command can only be used by the bot owner.

@commands.is_nsfw()
# Command can only be used in NSFW channels

@commands.has_role("name") 
# Check if member has a role with the name "name"

@commands.bot_has_role(11132312313213) 
# As above, but for the bot itself. (name can be replaced with id)

@commands.has_any_role("role1","foo",11132312313213) 
# Check if user has any of the roles with the names "role1", "foo", or the role with id 11132312313213

@commands.bot_has_any_role(*roles) 
# As above, but for the bot itself

@commands.has_permissions(ban_members=True, kick_members=True) 
# Check if user has all of the passed permissions 
#  e.g. this command will require both kick and ban permissions

@commands.bot_has_permissions(**perms)
# As above, but for the bot itself.

@commands.has_guild_permissions(**perms)
@commands.bot_has_guild_permissions(**perms)
# As for the two above, but for guild permissions rather than channel permissions.

@commands.check(myfunction)
# Check against your own function that returns those able to use your command

@commands.check_any(*myfunctions)
# Command will be ran if the conditions of any of your own check functions are met

from discord.ext.commands.cooldowns import BucketType
# BucketType can be BucketType.default, member, user, guild, role, or channel
@commands.cooldown(rate,per,BucketType) 
# Limit how often a command can be used, (num per, seconds, BucketType)

@commands.max_concurrency(number, per=BucketType.default, *, wait=False)
# Limit how many instances of the command can be running at the same time.
# Setting wait=True will queue up additional commands. False will raise MaxConcurrencyReached

# Checks can be stacked, and will Raise a CheckFailure if any check fails.

Is there a way to make it for user IDs instead of role IDs?

Make what for user IDs instead of role IDs? Your question wasn't very specific.

Make what for user IDs instead of role IDs? Your question wasn't very specific.

Yeah I mean like @commands.has_role making it so you need to have the role name/role ID. Is there a way to make it so the commands only work on specific user IDs?

From what I can tell, no, however, within a command you can put in some code that checks the user IDs:

@commands.command
async def my_command(ctx):
    allowed_IDs = [123456789, 987654321, ...]
    if ctx.author.id in allowed_IDs:
        #put your command content here
        ...
    else:
        #stuff to do if user is not authorized
        ...

Nevermind I fixed my issue. Thank you for telling me how to check the user IDs

Hey cap, I have a question regarding what you and shoreline were talking about. Could you drop your discord? I’d prefer to discuss it over discord and not having to conversate it over a github forum

They're talking about a check but only certain users can run it. I'd personally make it its own predicate, so it can be used anywhere and allows you to pass in your own IDs, of course.

I know but my question was going to be whether if it’s possible to code a command that sends the role ID to a whitelist.json or txt so you don’t have to add each individual role ID in the code itself. So instead of opening up your editor and adding onto “ allowed_IDs = [123456789, 987654321, ...]” you could add a command where the usage would be “(prefix)whitelist add (roleID). Sorry if this doesn’t make much sense I did the best I could to explain it.

@choppa1337 my discord is CaptainClumsy#3018. I'm pretty much always active other than at night.
You can accomplish something like this using the json python module, and you can contact me on discord for help with.

Also @Nanofaux that's a good idea lol, I kind of forgot about defining your own predicate.

@choppa1337 Yeah something like that would be possible

Is it possible to make a message send if the @commands.is_owner() check fails? and if so how

@george2781 Yes, that's possible. After defining your command, define an error handler that checks if the error raised is commands.NotOwner:

@my_command_name.on_error
async def my_command_name_error_handler(ctx, error):
    if isinstance(error, commands.NotOwner:
        ctx.send('You are not the owner')

Does the cool down apply to rewrite?

yes

How to check if the user who raised the command is a specific user, not about roles or permissions?
Same about guild, how to check if the command is raised in a specific guild?

For that, you can write your own custom check: https://discordpy.readthedocs.io/en/latest/ext/commands/api.html?highlight=checks#checks

For that, you can write your own custom check: https://discordpy.readthedocs.io/en/latest/ext/commands/api.html?highlight=checks#checks

Thanks so much! Have been looking for hours for an answer!

@Painezor, you should add @commands.dm_only() to the list.

@Painezor, you should add @commands.dm_only() to the list.

Done.

I have an issue with the @commands.has_any_role() method...
The first line is the error returned by the method, you can see the role id required in order to execute the command.
The second line is the list of the roles from the member... The id is in the list, but the method won't see it... It doesn't matter wether it looks for names or for ids, it won't work...

I have an issue with the @commands.has_any_role() method...
The first line is the error returned by the method, you can see the role id required in order to execute the command.
The second line is the list of the roles from the member... The id is in the list, but the method won't see it... It doesn't matter wether it looks for names or for ids, it won't work...

Ok nvm i made a mistake in the code. I was inputing a list in the has_any_role() method.

i still looked at this, very useful gist

thank u so much <3

You could do it by putting a * before the variable (list) containing the roles in the parameters:

roles = ['role_a', 'role_b', 'role_c']

@commands.has_any_role(*roles)
@commands.command
async def my_command(ctx):
    ...

Not working @CapClumpsy

@parthshingari28 Could you show your code, or contact me on discord at CaptainClumsy#3018, since just saying "Not working" isn't very helpful and I can't really tell what's the problem.

Can You give a example how to do it for Cogs , that will be very helpful for me .

@Mr-ROI what is "it", are you talking about the checks, or something else?
If you're talking about the checks, simply put the check decorator before a method that is being used for a command.

Is there an example as to how I could use my own function? What should the function return? Should it be true/false or a list of ID's?

@jeanravenclaw true/false yea

@FireRedz thanks!