Pincer Commands Module¶

Commands¶

command¶

@command(func=None, *, name=None, description='Description not set', enable_default=True, guild=None, cooldown=0, cooldown_scale=60, cooldown_scope=ThrottleScope.USER)¶

A decorator to create a slash command to register and respond to with the discord API from a function.

str - String int - Integer bool - Boolean float - Number pincer.objects.User - User pincer.objects.Channel - Channel pincer.objects.Role - Role pincer.objects.Mentionable - Mentionable

class Bot(Client):
    @command(
        name="test",
        description="placeholder"
    )
    async def test_command(
        self,
        ctx: MessageContext,
        amount: int,
        name: CommandArg[
            str,
            Description["Do something cool"],
            Choices[Choice["first value", 1], 5]
        ],
        optional_int: CommandArg[
            int,
            MinValue[10],
            MaxValue[100],
        ] = 50
    ):
        return Message(
            f"You chose {amount}, {name}, {letter}",
            flags=InteractionFlags.EPHEMERAL
        )

References from above:: Client, Message, MessageContext, InteractionFlags, Choices, Choice, CommandArg, Description, MinValue, MaxValue

Parameters

name (Optional[str]) – The name of the command
Default: None
description (Optional[str]) – The description of the command
Default: Description not set
enable_default (Optional[bool]) – Whether the command is enabled by default
Default: True
guild (Optional[Union[Snowflake, int, str]]) – What guild to add it to (don’t specify for global)
Default: None
cooldown (Optional[int]) – The amount of times in the cooldown_scale the command can be invoked
Default: 0
cooldown_scale (Optional[float]) – The ‘checking time’ of the cooldown
Default: 60
cooldown_scope (ThrottleScope) – What type of cooldown strategy to use
Default: ThrottleScope.USER

Raises

CommandIsNotCoroutine – If the command function is not a coro
InvalidCommandName – If the command name does not follow the regex ^[\w-]{1,32}$
InvalidCommandGuild – If the guild id is invalid
CommandDescriptionTooLong – Descriptions max 100 characters If the annotation on an argument is too long (also max 100)
CommandAlreadyRegistered – If the command already exists
TooManyArguments – Max 25 arguments to pass for commands
InvalidArgumentAnnotation – Annotation amount is max 25, Not a valid argument type, Annotations must consist of name and value

@message_command(func=None, *, name=None, enable_default=True, guild=None, cooldown=0, cooldown_scale=60, cooldown_scope=ThrottleScope.USER)¶

A decorator to create a user command to register and respond to the Discord API from a function.

class Bot(Client):
    @user_command
    async def test_message_command(
        self,
        ctx: MessageContext,
        message: UserMessage,
    ):
        return message.content

References from above:: Client, MessageContext, UserMessage, User, GuildMember,

Parameters

name (Optional[str]) – The name of the command
Default: None
enable_default (Optional[bool]) – Whether the command is enabled by default
Default: True
guild (Optional[Union[Snowflake, int, str]]) – What guild to add it to (don’t specify for global)
Default: None
cooldown (Optional[int]) – The amount of times in the cooldown_scale the command can be invoked
Default: 0
cooldown_scale (Optional[float]) – The ‘checking time’ of the cooldown
Default: 60
cooldown_scope (ThrottleScope) – What type of cooldown strategy to use
Default: ThrottleScope.USER

Raises

CommandIsNotCoroutine – If the command function is not a coro
InvalidCommandName – If the command name does not follow the regex ^[\w-]{1,32}$
InvalidCommandGuild – If the guild id is invalid
CommandDescriptionTooLong – Descriptions max 100 characters If the annotation on an argument is too long (also max 100)
CommandAlreadyRegistered – If the command already exists
InvalidArgumentAnnotation – Annotation amount is max 25, Not a valid argument type, Annotations must consist of name and value

@user_command(func=None, *, name=None, enable_default=True, guild=None, cooldown=0, cooldown_scale=60, cooldown_scope=ThrottleScope.USER)¶

A decorator to create a user command registering and responding to the Discord API from a function.

class Bot(Client):
    @user_command
    async def test_user_command(
        self,
        ctx: MessageContext,
        user: User,
        member: GuildMember
    ):
        if not member:
            # member is missing if this is a DM
            # This bot doesn't like being DMed so it won't respond
            return

        return f"Hello {user.name}, this is a Guild."
References from above:
Client, MessageContext, User, GuildMember,

nameOptional[str]
The name of the command
Default: None

enable_defaultOptional[bool]
Whether the command is enabled by default
Default: True

guildOptional[Union[Snowflake, int, str]]
What guild to add it to (don’t specify for global)
Default: None

cooldownOptional[int]
The amount of times in the cooldown_scale the command can be invoked
Default: 0

cooldown_scaleOptional[float]
The ‘checking time’ of the cooldown
Default: 60

cooldown_scopeThrottleScope
What type of cooldown strategy to use
Default: ThrottleScope.USER

CommandIsNotCoroutine
If the command function is not a coro

InvalidCommandName
If the command name does not follow the regex ^[\w-]{1,32}$

InvalidCommandGuild
If the guild id is invalid

CommandDescriptionTooLong
Descriptions max 100 characters If the annotation on an argument is too long (also max 100)

CommandAlreadyRegistered
If the command already exists

InvalidArgumentAnnotation
Annotation amount is max 25, Not a valid argument type, Annotations must consist of name and value