Objects and methods¶

ActionRow¶

class dislash.ActionRow(*components)¶

Represents an action row. Action rows are basically shelves for buttons.

Parameters: components (List[Button]) – a list of up to 5 buttons to place in a row

add_button(*, style: dislash.interactions.message_components.ButtonStyle, label: Optional[str] = None, emoji: Optional[str] = None, custom_id: Optional[str] = None, url: Optional[str] = None, disabled: bool = False)¶

add_menu(*, custom_id: str, placeholder: Optional[str] = None, min_values: int = 1, max_values: int = 1, options: Optional[list] = None)¶

disable_buttons(*positions: int)¶: Sets disabled to True for all buttons in this row.

enable_buttons(*positions: int)¶: Sets disabled to False for all buttons in this row.

classmethod from_dict(data: dict)¶

to_dict()¶

ApplicationCommand¶

class dislash.ApplicationCommand(type: dislash.interactions.application_command.ApplicationCommandType, **kwargs)¶: Base class for application commands

ApplicationCommandError¶

class dislash.ApplicationCommandError(message=None, *args)¶

The base exception type for all slash-command related errors.

This inherits from discord.DiscordException.

This exception and exceptions inherited from it are handled in a special way as they are caught and passed into a special event from SlashClient, on_slash_command_error().

ApplicationCommandInteractionData¶

class dislash.ApplicationCommandInteractionData(*, data, guild, state)¶

ApplicationCommandPermissions¶

class dislash.ApplicationCommandPermissions(raw_permissions: Optional[list] = None)¶

Represents application command permissions. Roughly equivalent to a list of RawCommandPermission

Application command permissions are checked on the server side. Only local application commands can have this type of permissions.

Parameters: raw_permissions (List[RawCommandPermission]) – a list of RawCommandPermission. However, from_pairs() or from_ids() might be more convenient.

classmethod from_dict(data: dict)¶

classmethod from_ids(role_perms: Optional[dict] = None, user_perms: Optional[dict] = None)¶

Creates SlashCommandPermissions from 2 dictionaries of IDs and permissions.

Parameters

role_perms (dict) – a dictionary of {role_id: bool}
user_perms (dict) – a dictionary of {user_id: bool}

classmethod from_pairs(permissions: dict)¶

Creates SlashCommandPermissions using instances of discord.Role and discord.User

Parameters: permissions (dict) – a dictionary of {Role | User: bool}

to_dict()¶

ApplicationCommandType¶

class dislash.ApplicationCommandType¶

BadArgument¶

class dislash.BadArgument(message=None, *args)¶

BaseInteraction¶

class dislash.BaseInteraction(client, data: dict)¶

The base class for all interactions

async create_response(content=None, *, type=None, embed=None, embeds=None, components=None, view=None, ephemeral=False, tts=False, allowed_mentions=None)¶

Creates an interaction response.

Parameters

content (str) – response content
type (int | ResponseType) – sets the response type. See ResponseType
embed (discord.Embed) – response embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
ephemeral (bool) – if set to True, your response will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.

Raises

HTTPException – sending the response failed
InvalidArgument – Both embed and embeds are specified

async delete()¶: Deletes the original interaction response.

async delete_after(delay: float)¶

async edit(content=None, *, embed=None, embeds=None, components=None, allowed_mentions=None)¶

Edits the original interaction response.

Parameters

content (str) – New message content
embed (discord.Embed) – New message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds of a new message
components (List[ActionRow]) – a list of up to 5 action rows
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.

Returns

message – The message that was edited

Return type

discord.Message

async fetch_initial_response()¶: Fetches the original interaction response.

async followup(content=None, *, embed=None, embeds=None, file=None, files=None, components=None, view=None, tts=False, ephemeral=False, allowed_mentions=None, username=None, avatar_url=None)¶

Sends a followup message.

Parameters

content (str) – the followup message content
embed (discord.Embed) – the followup message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
file (discord.File) – a file to attach to the message
files (List[discord.File]) – a list of files to attach to the message
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
ephemeral (bool) – if set to True, your message will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message
username (str) – override the default bot name
avatar_url (str) – override the default avatar of the bot

async reply(content=None, *, embed=None, embeds=None, components=None, view=None, file=None, files=None, tts=False, hide_user_input=False, ephemeral=False, delete_after=None, allowed_mentions=None, type=None, fetch_response_message=True)¶

Creates an interaction response. What’s the difference between this method and create_response()? If the token is no longer valid, this method sends a usual channel message instead of creating an interaction response. Also, this method fetches the interaction response message and returns it, unlike create_response().

Parameters

content (str) – message content
embed (discord.Embed) – message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
file (discord.File) – if it’s the first interaction reply, the file will be ignored due to API limitations. Everything else is the same as in discord.TextChannel.send() method.
files (List[discord.File]) – same as file but for multiple files.
hide_user_input (bool) – if set to True, user’s input won’t be displayed
ephemeral (bool) – if set to True, your response will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
delete_after (float) – if specified, your reply will be deleted after delete_after seconds
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.
type (int | ResponseType) – sets the response type. If it’s not specified, this method sets it according to hide_user_input, content and embed params.
fetch_response_message (bool) – whether to fetch and return the response message. Defaults to True.

Raises

HTTPException – sending the response failed
InvalidArgument – Both embed and embeds are specified

Returns

message – The response message that has been sent or None if the message is ephemeral

Return type

discord.Message | None

BotMissingAnyRole¶

class dislash.BotMissingAnyRole(missing_roles)¶

BotMissingPermissions¶

class dislash.BotMissingPermissions(missing_perms, *args)¶

BotMissingRole¶

class dislash.BotMissingRole(missing_role)¶

BucketType¶

class dislash.BucketType(value)¶

classmethod try_value(value)¶

Button¶

class dislash.Button(*, style: dislash.interactions.message_components.ButtonStyle, label: Optional[str] = None, emoji: Optional[discord.partial_emoji.PartialEmoji] = None, custom_id: Optional[str] = None, url: Optional[str] = None, disabled: bool = False)¶

Builds a button.

Parameters

style (ButtonStyle) – Style of the button
label (str) – Button text
emoji (str | discord.PartialEmoji) – Button emoji
custom_id (str) – You should set it by yourself, it’s not a snowflake. If button style is not ButtonStyle.link, this is a required field
url (str) – If button style is ButtonStyle.link, this is a required field.
disabled (bool) – Whether the button is disabled or not. Defaults to false.

classmethod from_dict(data: dict)¶

to_dict()¶

MessageInteraction¶

class dislash.MessageInteraction(client, data)¶

Represents a button interaction. Obtainable via discord.Context.wait_for_button_click and in on_button_click event.

author¶

The user that clicked the button

Type: discord.Member | discord.User

channel¶

The channel where the click happened

Type: discord.Messageable

guild¶

The guild where the click happened

Type: discord.Guild | None

message¶

The message where the button was clicked

Type: discord.Message

components¶

A list of ActionRow instances containing other components

Type: list

component¶

The component that author interacted with

Type: Component

async create_response(content=None, *, type=None, embed=None, embeds=None, components=None, view=None, ephemeral=False, tts=False, allowed_mentions=None)¶

Creates an interaction response.

Parameters

content (str) – response content
type (int | ResponseType) – sets the response type. See ResponseType
embed (discord.Embed) – response embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
ephemeral (bool) – if set to True, your response will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.

Raises

HTTPException – sending the response failed
InvalidArgument – Both embed and embeds are specified

async delete()¶: Deletes the original interaction response.

async delete_after(delay: float)¶

async edit(content=None, *, embed=None, embeds=None, components=None, allowed_mentions=None)¶

Edits the original interaction response.

Parameters

content (str) – New message content
embed (discord.Embed) – New message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds of a new message
components (List[ActionRow]) – a list of up to 5 action rows
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.

Returns

message – The message that was edited

Return type

discord.Message

async fetch_initial_response()¶: Fetches the original interaction response.

async followup(content=None, *, embed=None, embeds=None, file=None, files=None, components=None, view=None, tts=False, ephemeral=False, allowed_mentions=None, username=None, avatar_url=None)¶

Sends a followup message.

Parameters

content (str) – the followup message content
embed (discord.Embed) – the followup message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
file (discord.File) – a file to attach to the message
files (List[discord.File]) – a list of files to attach to the message
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
ephemeral (bool) – if set to True, your message will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message
username (str) – override the default bot name
avatar_url (str) – override the default avatar of the bot

async reply(content=None, *, embed=None, embeds=None, components=None, view=None, file=None, files=None, tts=False, hide_user_input=False, ephemeral=False, delete_after=None, allowed_mentions=None, type=None, fetch_response_message=True)¶

Creates an interaction response. What’s the difference between this method and create_response()? If the token is no longer valid, this method sends a usual channel message instead of creating an interaction response. Also, this method fetches the interaction response message and returns it, unlike create_response().

Parameters

content (str) – message content
embed (discord.Embed) – message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
file (discord.File) – if it’s the first interaction reply, the file will be ignored due to API limitations. Everything else is the same as in discord.TextChannel.send() method.
files (List[discord.File]) – same as file but for multiple files.
hide_user_input (bool) – if set to True, user’s input won’t be displayed
ephemeral (bool) – if set to True, your response will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
delete_after (float) – if specified, your reply will be deleted after delete_after seconds
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.
type (int | ResponseType) – sets the response type. If it’s not specified, this method sets it according to hide_user_input, content and embed params.
fetch_response_message (bool) – whether to fetch and return the response message. Defaults to True.

Raises

HTTPException – sending the response failed
InvalidArgument – Both embed and embeds are specified

Returns

message – The response message that has been sent or None if the message is ephemeral

Return type

discord.Message | None

ButtonStyle¶

class dislash.ButtonStyle¶

blurple = 1

grey = 2

green = 3

red = 4

link = 5

CheckAnyFailure¶

class dislash.CheckAnyFailure(checks, errors)¶

ClickListener¶

class dislash.ClickListener(message_id: int, timeout: Optional[float] = None)¶

Creates a nice click manager for a message. You can use this class, or call discord.Message.create_click_listener(timeout) in order to create an instance.

Click manager allows to process button clicks under a specific message using decorator-based interface.

Parameters

message_id (int) – the ID of the message with buttons
timeout (float) – the amount of seconds required after the last matched interaction for the click manager to finish working. Defaults to None, which means no timeout.

from_user(user: discord.user.User, *, cancel_others: bool = False, reset_timeout: bool = True)¶

A decorator that makes the function below waiting for a click from the specified user.

Parameters are the same as in matching_condition(), except check parameter is replaced with a user to compare with.

kill()¶: Kills the click manager. Only useful if the timeout param was specified as None.

matching_condition(check, *, cancel_others: bool = False, reset_timeout: bool = True)¶

A decorator that makes the function below waiting for a click matching the specified conditions.

Parameters

check (function) – the required condition. This function must take exactly one argument which is guaranteed to be an instance of MessageInteraction. This function must return True or False.
cancel_others (bool) – defaults to False. Specifies whether to cancel all other local listeners or not. For example, if this parameter is False, the library will activate all other listeners matching the interaction, untill all listeners are toggled or some of them cancels others.
reset_timeout (bool) – defaults to True. Specifies whether to restart the timer or not. By restarting the timer, you extend the lifespan of all local listeners.

matching_id(custom_id: str, *, cancel_others: bool = False, reset_timeout: bool = True)¶

A decorator that makes the function below waiting for a click of the button matching the specified custom_id.

Parameters are the same as in matching_condition(), except check parameter is replaced with custom_id.

no_checks(*, cancel_others: bool = False, reset_timeout: bool = True)¶

A decorator that makes the function below waiting for any click.

Parameters are the same as in matching_condition(), except there’s no check.

not_from_user(user: discord.user.User, *, cancel_others: bool = False, reset_timeout: bool = True)¶

A decorator that makes the function below waiting for a click from a user not maching the specified one.

Parameters are the same as in matching_condition(), except check parameter is replaced with a user to compare with.

timeout(func)¶: A decorator that makes the function below waiting for click listener timeout.

CommandOnCooldown¶

class dislash.CommandOnCooldown(cooldown, retry_after)¶

Exception raised when the application command being invoked is on cooldown.

This inherits from ApplicationCommandError

## Attributes

cooldown: Cooldown (a class with attributes rate, per, and type)

retry_after: float (the amount of seconds to wait before you can retry again)

CommandParent¶

class dislash.CommandParent(func, *, name=None, description=None, options=None, default_permission=True, guild_ids=None, connectors=None, auto_sync=True, **kwargs)¶

error(func)¶: A decorator that makes the function below work as error handler for this command.

get_cooldown_retry_after(inter)¶

Retrieves the amount of seconds before this slash command can be tried again.

Parameters: inter (SlashInteraction) – The interaction to retrieve the cooldown from.
Returns: The amount of time left on this slash command’s cooldown in seconds. If this is 0.0 then the slash command isn’t on cooldown.
Return type: float

async invoke(interaction)¶

async invoke_children(interaction)¶

is_on_cooldown(inter)¶

Checks whether the slash command is currently on cooldown.

Parameters: inter (SlashInteraction) – The interaction to use when checking the commands cooldown status.
Returns: A boolean indicating if the slash command is on cooldown.
Return type: bool

reset_cooldown(inter)¶

Resets the cooldown on this slash command.

Parameters: inter (SlashInteraction) – The interaction to reset the cooldown under.

sub_command(name: Optional[str] = None, description: Optional[str] = None, options: Optional[list] = None, connectors: Optional[dict] = None, **kwargs)¶

A decorator that creates a subcommand under the base command.

Parameters

name (str) – the name of the subcommand. Defaults to the function name
description (str) – the description of the subcommand
options (list) – the options of the subcommand for registration in API
connectors (dict) – which function param states for each option. If the name of an option already matches the corresponding function param, you don’t have to specify the connectors. Connectors template: {"option-name": "param_name", ...}

sub_command_group(name=None, **kwargs)¶

A decorator that creates a subcommand group under the base command. Remember that the group must have at least one subcommand.

Parameters: name (str) – the name of the subcommand group. Defaults to the function name

Component¶

class dislash.Component(type: int)¶: The base class for message components

ComponentType¶

class dislash.ComponentType¶

ContextMenuInteraction¶

class dislash.ContextMenuInteraction(client, payload)¶

async create_response(content=None, *, type=None, embed=None, embeds=None, components=None, view=None, ephemeral=False, tts=False, allowed_mentions=None)¶

Creates an interaction response.

Parameters

content (str) – response content
type (int | ResponseType) – sets the response type. See ResponseType
embed (discord.Embed) – response embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
ephemeral (bool) – if set to True, your response will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.

Raises

HTTPException – sending the response failed
InvalidArgument – Both embed and embeds are specified

async delete()¶: Deletes the original interaction response.

async delete_after(delay: float)¶

async edit(content=None, *, embed=None, embeds=None, components=None, allowed_mentions=None)¶

Edits the original interaction response.

Parameters

content (str) – New message content
embed (discord.Embed) – New message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds of a new message
components (List[ActionRow]) – a list of up to 5 action rows
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.

Returns

message – The message that was edited

Return type

discord.Message

async fetch_initial_response()¶: Fetches the original interaction response.

async followup(content=None, *, embed=None, embeds=None, file=None, files=None, components=None, view=None, tts=False, ephemeral=False, allowed_mentions=None, username=None, avatar_url=None)¶

Sends a followup message.

Parameters

content (str) – the followup message content
embed (discord.Embed) – the followup message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
file (discord.File) – a file to attach to the message
files (List[discord.File]) – a list of files to attach to the message
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
ephemeral (bool) – if set to True, your message will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message
username (str) – override the default bot name
avatar_url (str) – override the default avatar of the bot

async reply(content=None, *, embed=None, embeds=None, components=None, view=None, file=None, files=None, tts=False, hide_user_input=False, ephemeral=False, delete_after=None, allowed_mentions=None, type=None, fetch_response_message=True)¶

Creates an interaction response. What’s the difference between this method and create_response()? If the token is no longer valid, this method sends a usual channel message instead of creating an interaction response. Also, this method fetches the interaction response message and returns it, unlike create_response().

Parameters

content (str) – message content
embed (discord.Embed) – message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
file (discord.File) – if it’s the first interaction reply, the file will be ignored due to API limitations. Everything else is the same as in discord.TextChannel.send() method.
files (List[discord.File]) – same as file but for multiple files.
hide_user_input (bool) – if set to True, user’s input won’t be displayed
ephemeral (bool) – if set to True, your response will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
delete_after (float) – if specified, your reply will be deleted after delete_after seconds
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.
type (int | ResponseType) – sets the response type. If it’s not specified, this method sets it according to hide_user_input, content and embed params.
fetch_response_message (bool) – whether to fetch and return the response message. Defaults to True.

Raises

HTTPException – sending the response failed
InvalidArgument – Both embed and embeds are specified

Returns

message – The response message that has been sent or None if the message is ephemeral

Return type

discord.Message | None

ContextMenuInteractionData¶

class dislash.ContextMenuInteractionData(data, guild, state)¶

DiscordException¶

class dislash.DiscordException¶

Base exception class for discord.py

Ideally speaking, this could be caught to handle any exceptions thrown from this library.

SlashInteraction¶

class dislash.SlashInteraction(client, payload)¶

Every interaction with slash-commands is represented by instances of this class

author¶

The member/user that used the slash-command.

Type: discord.Member | discord.User

guild¶

The guild where interaction was created

Type: discord.Guild

channel¶

The channel where interaction was created

Type: discord.TextChannel

data¶

The arguments that were passed

Type: InteractionData

created_at¶

Then interaction was created

Type: datetime.datetime

expired¶

Whether the interaction token is still valid

Type: bool:

async create_response(content=None, *, type=None, embed=None, embeds=None, components=None, view=None, ephemeral=False, tts=False, allowed_mentions=None)¶

Creates an interaction response.

Parameters

content (str) – response content
type (int | ResponseType) – sets the response type. See ResponseType
embed (discord.Embed) – response embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
ephemeral (bool) – if set to True, your response will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.

Raises

HTTPException – sending the response failed
InvalidArgument – Both embed and embeds are specified

async delete()¶: Deletes the original interaction response.

async delete_after(delay: float)¶

async edit(content=None, *, embed=None, embeds=None, components=None, allowed_mentions=None)¶

Edits the original interaction response.

Parameters

content (str) – New message content
embed (discord.Embed) – New message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds of a new message
components (List[ActionRow]) – a list of up to 5 action rows
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.

Returns

message – The message that was edited

Return type

discord.Message

async fetch_initial_response()¶: Fetches the original interaction response.

async followup(content=None, *, embed=None, embeds=None, file=None, files=None, components=None, view=None, tts=False, ephemeral=False, allowed_mentions=None, username=None, avatar_url=None)¶

Sends a followup message.

Parameters

content (str) – the followup message content
embed (discord.Embed) – the followup message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
file (discord.File) – a file to attach to the message
files (List[discord.File]) – a list of files to attach to the message
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
ephemeral (bool) – if set to True, your message will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message
username (str) – override the default bot name
avatar_url (str) – override the default avatar of the bot

get(name: str, default=None)¶: Equivalent to InteractionData.get

get_option(name: str)¶: Equivalent to InteractionData.get_option

option_at(index: int)¶: Equivalent to InteractionData.option_at

async reply(content=None, *, embed=None, embeds=None, components=None, view=None, file=None, files=None, tts=False, hide_user_input=False, ephemeral=False, delete_after=None, allowed_mentions=None, type=None, fetch_response_message=True)¶

Creates an interaction response. What’s the difference between this method and create_response()? If the token is no longer valid, this method sends a usual channel message instead of creating an interaction response. Also, this method fetches the interaction response message and returns it, unlike create_response().

Parameters

content (str) – message content
embed (discord.Embed) – message embed
embeds (List[discord.Embed]) – a list of up to 10 embeds to attach
components (List[ActionRow]) – a list of up to 5 action rows
view (discord.ui.View) – only usable with discord.py 2.0. Read more about View in discord.py 2.0 official documentation
file (discord.File) – if it’s the first interaction reply, the file will be ignored due to API limitations. Everything else is the same as in discord.TextChannel.send() method.
files (List[discord.File]) – same as file but for multiple files.
hide_user_input (bool) – if set to True, user’s input won’t be displayed
ephemeral (bool) – if set to True, your response will only be visible to the command author
tts (bool) – whether the message is text-to-speech or not
delete_after (float) – if specified, your reply will be deleted after delete_after seconds
allowed_mentions (discord.AllowedMentions) – controls the mentions being processed in this message.
type (int | ResponseType) – sets the response type. If it’s not specified, this method sets it according to hide_user_input, content and embed params.
fetch_response_message (bool) – whether to fetch and return the response message. Defaults to True.

Raises

HTTPException – sending the response failed
InvalidArgument – Both embed and embeds are specified

Returns

message – The response message that has been sent or None if the message is ephemeral

Return type

discord.Message | None

InteractionCheckFailure¶

class dislash.InteractionCheckFailure(message=None, *args)¶

InteractionClient¶

class dislash.InteractionClient(client, *, test_guilds: Optional[List[int]] = None, sync_commands: bool = True, show_warnings: bool = True, modify_send: bool = True)¶

The main purpose of this class is to track INTERACTION_CREATE API event.

Parameters

client (commands.Bot | commands.AutoShardedBot) – The discord.py Bot instance
show_warnings (bool) – Whether to show the warnings or not. Defaults to True
modify_send (bool) – Whether to modify Messageable.send and Message.edit. Modified methods allow to specify the components parameter.

client¶

an instance of any class inherited from discord.Client

Type: commands.Bot | commands.AutoShardedBot

application_id¶

the ID of the application your bot is related to

Type: int

global_commands¶

All registered global application commands

Type: List[ApplicationCommand]

slash_commands¶

All invokable slash commands from your code

Type: Dict[str, CommandParent]

user_commands¶

All invokable user commands from your code

Type: Dict[str, InvokableUserCommand]

message_commands¶

All invokable message commands from your code

Type: Dict[str, InvokableMessageCommand]

commands¶

All invokable application commands from your code

Type: Dict[str, InvokableApplicationCommand]

is_ready¶

Equals to True if SlashClient is ready, otherwise it’s False

Type: bool

async batch_edit_guild_command_permissions(guild_id: int, permissions: dict)¶

Batch edits permissions for all commands in a guild.

Parameters

guild_id (int) – the ID of the guild
permissions (Dict[int, ApplicationCommandPermissions]) – a dictionary of command IDs and permissions

async batch_fetch_guild_command_permissions(guild_id: int)¶

Fetches command permissions for all commands in a guild.

Parameters: guild_id (int) – the ID of the guild

async delete_global_command(command_id: int)¶

Deletes the global application command

Parameters: command_id (int) –

async delete_global_command_named(name: str)¶

Deletes a global command matching the specified name.

Parameters: name (str) – the name of the command to delete

async delete_global_commands()¶: Deletes all global commands.

async delete_guild_command(guild_id: int, command_id: int)¶

Deletes the local application command

Parameters

guild_id (int) –
command_id (int) –

async delete_guild_command_named(guild_id: int, name: str)¶

Deletes a local command matching the specified name.

Parameters

guild_id (int) – ID of the guild where the command is registered
name (str) – the name of the command to edit

async delete_guild_commands(guild_id: int)¶

Deletes all local commands in the specified guild.

Parameters: guild_id (int) – the ID of the guild where you’re going to delete the commands

dispatch(event_name, *args, **kwargs)¶

async edit_global_command(command_id: int, app_command: dislash.interactions.application_command.ApplicationCommand, **kwargs)¶

Edits a global application command

Parameters

command_id (int) –
app_command (ApplicationCommand) – replacement of the old data

async edit_global_command_named(name: str, app_command: dislash.interactions.application_command.ApplicationCommand)¶

Edits a global command matching the specified name.

Parameters

name (str) – the name of the command to edit
app_command (ApplicationCommand) – replacement of the old data

async edit_guild_command(guild_id: int, command_id: int, app_command: dislash.interactions.application_command.ApplicationCommand, **kwargs)¶

Edits the local application command

Parameters

guild_id (int) –
command_id (int) –
app_command (ApplicationCommand) – replacement of the old data

async edit_guild_command_named(guild_id: int, name: str, app_command: dislash.interactions.application_command.ApplicationCommand)¶

Edits a local command matching the specified name.

Parameters

guild_id (int) – ID of the guild where the command is registered
name (str) – the name of the command to edit
app_command (ApplicationCommand) – replacement of the old data

async edit_guild_command_permissions(guild_id: int, command_id: int, permissions: dislash.interactions.application_command.ApplicationCommandPermissions)¶

Edits command permissions for a specific command in a guild.

Parameters

guild_id (int) – the ID of the guild
command_id (int) – the ID of the command
permissions (SlashCommandPermissions | dict) – new permissions to set. If you use SlashCommandPermissions.from_pairs, you can pass the arg of that method straight into this function

event(func)¶

Decorator

@slash.event
async def on_ready():
    print("SlashClient is ready")

All possible events:
on_ready, on_auto_register,
on_slash_command, on_slash_command_error

async fetch_global_command(command_id: int)¶

Requests a registered global command

Parameters: command_id (int) –
Returns: global_command
Return type: ApplicationCommand

async fetch_global_command_named(name: str)¶

Fetches a global command that matches the specified name

Parameters: name (str) – the name of the command to fetch

async fetch_global_commands()¶

Requests a list of global registered commands from the API

Returns: global_commands
Return type: List[ApplicationCommand]

async fetch_guild_command(guild_id: int, command_id: int)¶

Requests a registered guild command

Parameters

guild_id (int) –
command_id (int) –

Returns

guild_command

Return type

ApplicationCommand

async fetch_guild_command_named(guild_id: int, name: str)¶

Fetches a guild command that matches the specified name

Parameters

guild_id (int) – ID of the guild where the command is registered
name (str) – the name of the command to fetch

async fetch_guild_command_permissions(guild_id: int, command_id: int)¶

Fetches command permissions for a specific command in a guild.

Parameters

guild_id (int) – the ID of the guild
command_id (int) – the ID of the command

async fetch_guild_commands(guild_id: int)¶

Requests a list of registered commands for a specific guild

Parameters: guild_id (int) –
Returns: guild_commands
Return type: List[ApplicationCommand]

get_global_command(command_id: int)¶

Get a cached global command

Parameters: command_id (int) – the ID of the command
Returns: slash_command
Return type: SlashCommand | None

get_global_command_named(name: str)¶

Get a cached global command matching the specified name

Parameters: name (str) – the name of the command
Returns: slash_command
Return type: SlashCommand | None

get_guild_command(guild_id: int, command_id: int)¶

Get a cached guild command

Parameters

guild_id (int) – the ID of the guild
command_id (int) – the ID of the command

Returns

slash_command

Return type

SlashCommand | None

get_guild_command_named(guild_id: int, name: str)¶

Get a cached guild command matching the specified name

Parameters

guild_id (int) – the ID of the guild
name (str) – the name of the command

Returns

slash_command

Return type

SlashCommand | None

get_guild_commands(guild_id: int)¶

Get cached guild commands

Parameters: guild_id (int) – the ID of the guild
Returns
Return type: ~:class:List[ApplicationCommand]

message_command(*args, **kwargs)¶

async multiple_wait_for(events_and_checks: Dict[str, Any], timeout: Optional[float] = None)¶

Waits until one of the given events toggles and matches the relevant check.

Example:

result = None
try:
    result = await client.multiple_wait_for(
        {
            "message": lambda msg: msg.author == ctx.author,
            "reaction_add": lambda react, user: user == ctx.author
        },
        timeout=60
    )
except asyncio.TimeoutError:
    await ctx.send("It took too long")
if isinstance(result, discord.Message):
    # on_message was toggled
    await ctx.send(f"You said '{result.content}'")
else:
    # on_reaction_add was toggled
    reaction, user = result
    await ctx.send(f"Your reaction: {reaction.emoji}")

Parameters

events_and_checks (Dict[str, function | None]) – a dictionary of event names and relevant checks, e.g. {"message": lambda m: m.author == ctx.author, "button_click": None}
timeout (float | None) – the amount of seconds the bot should wait for any of the given events

async overwrite_global_commands(app_commands: list)¶

Bulk overwrites all global application commands

Parameters: app_commands (List[ApplicationCommand]) –

async overwrite_guild_commands(guild_id: int, app_commands: list)¶

Bulk overwrites all guild application commands

Parameters

guild_id (int) –
app_commands (List[ApplicationCommand]) –

async register_global_command(app_command: dislash.interactions.application_command.ApplicationCommand)¶

Registers a global application command

Parameters: app_command (ApplicationCommand) –

async register_guild_command(guild_id: int, app_command: dislash.interactions.application_command.ApplicationCommand)¶

Registers a local application command

Parameters

guild_id (int) –
app_command (ApplicationCommand) –

slash_command(*args, **kwargs)¶

A decorator that allows to build a slash command.

Parameters

auto_sync (bool) – whether to automatically register the command or not. Defaults to True
name (str) – name of the slash command you want to respond to (equals to function name by default).
description (str) – the description of the slash command. It will be visible in Discord.
options (List[Option]) – the list of slash command options. The options will be visible in Discord.
default_permission (bool) – whether the command is enabled by default when the app is added to a guild.
guild_ids (List[int]) – if specified, the client will register a command in these guilds. Otherwise this command will be registered globally.
connectors (dict) – which function param states for each option. If the name of an option already matches the corresponding function param, you don’t have to specify the connectors. Connectors template: {"option-name": "param_name", ...}

teardown()¶: Cleanup the client by removing all registered listeners and caches.

user_command(*args, **kwargs)¶

async wait_for_button_click(check=None, timeout=None)¶

async wait_for_dropdown(check=None, timeout=None)¶

InteractionDataOption¶

class dislash.InteractionDataOption(*, data, resolved: dislash.interactions.app_command_interaction.Resolved)¶

Represents user’s input for a specific option

name¶

The name of the option

Type: str

value¶

The value of the option

Type: Any

options¶

Represents options of a sub-slash-command.

{name: InteractionDataOption, …}

Type: dict

get(name: str, default=None)¶

Get the value of an option with the specified name

Parameters

name (str) – the name of the option you want to get
default (any) – what to return in case nothing was found

Returns

option_value (any) – The option type isn’t SUB_COMMAND_GROUP or SUB_COMMAND
option (InteractionDataOption | default) – Otherwise

get_option(name: str)¶

Get the raw InteractionDataOption matching the specified name

Parameters: name (str) – The name of the option you want to get
Returns: option
Return type: InteractionDataOption | None

option_at(index: int)¶: Similar to InteractionData.option_at

InteractionType¶

class dislash.InteractionType¶

InvokableApplicationCommand¶

class dislash.InvokableApplicationCommand(func, *, name=None, **kwargs)¶

error(func)¶: A decorator that makes the function below work as error handler for this command.

get_cooldown_retry_after(inter)¶

Retrieves the amount of seconds before this slash command can be tried again.

Parameters: inter (SlashInteraction) – The interaction to retrieve the cooldown from.
Returns: The amount of time left on this slash command’s cooldown in seconds. If this is 0.0 then the slash command isn’t on cooldown.
Return type: float

is_on_cooldown(inter)¶

Checks whether the slash command is currently on cooldown.

Parameters: inter (SlashInteraction) – The interaction to use when checking the commands cooldown status.
Returns: A boolean indicating if the slash command is on cooldown.
Return type: bool

reset_cooldown(inter)¶

Resets the cooldown on this slash command.

Parameters: inter (SlashInteraction) – The interaction to reset the cooldown under.

InvokableContextMenuCommand¶

class dislash.InvokableContextMenuCommand(func, *, name=None, guild_ids=None, **kwargs)¶

error(func)¶: A decorator that makes the function below work as error handler for this command.

get_cooldown_retry_after(inter)¶

Retrieves the amount of seconds before this slash command can be tried again.

Parameters: inter (SlashInteraction) – The interaction to retrieve the cooldown from.
Returns: The amount of time left on this slash command’s cooldown in seconds. If this is 0.0 then the slash command isn’t on cooldown.
Return type: float

async invoke(interaction)¶

is_on_cooldown(inter)¶

Checks whether the slash command is currently on cooldown.

Parameters: inter (SlashInteraction) – The interaction to use when checking the commands cooldown status.
Returns: A boolean indicating if the slash command is on cooldown.
Return type: bool

reset_cooldown(inter)¶

Resets the cooldown on this slash command.

Parameters: inter (SlashInteraction) – The interaction to reset the cooldown under.

InvokableMessageCommand¶

class dislash.InvokableMessageCommand(func, *, name=None, guild_ids=None, **kwargs)¶

error(func)¶: A decorator that makes the function below work as error handler for this command.

get_cooldown_retry_after(inter)¶

Retrieves the amount of seconds before this slash command can be tried again.

Parameters: inter (SlashInteraction) – The interaction to retrieve the cooldown from.
Returns: The amount of time left on this slash command’s cooldown in seconds. If this is 0.0 then the slash command isn’t on cooldown.
Return type: float

async invoke(interaction)¶

is_on_cooldown(inter)¶

Checks whether the slash command is currently on cooldown.

Parameters: inter (SlashInteraction) – The interaction to use when checking the commands cooldown status.
Returns: A boolean indicating if the slash command is on cooldown.
Return type: bool

reset_cooldown(inter)¶

Resets the cooldown on this slash command.

Parameters: inter (SlashInteraction) – The interaction to reset the cooldown under.

InvokableUserCommand¶

class dislash.InvokableUserCommand(func, *, name=None, guild_ids=None, **kwargs)¶

error(func)¶: A decorator that makes the function below work as error handler for this command.

get_cooldown_retry_after(inter)¶

Retrieves the amount of seconds before this slash command can be tried again.

Parameters: inter (SlashInteraction) – The interaction to retrieve the cooldown from.
Returns: The amount of time left on this slash command’s cooldown in seconds. If this is 0.0 then the slash command isn’t on cooldown.
Return type: float

async invoke(interaction)¶

is_on_cooldown(inter)¶

Checks whether the slash command is currently on cooldown.

Parameters: inter (SlashInteraction) – The interaction to use when checking the commands cooldown status.
Returns: A boolean indicating if the slash command is on cooldown.
Return type: bool

reset_cooldown(inter)¶

Resets the cooldown on this slash command.

Parameters: inter (SlashInteraction) – The interaction to reset the cooldown under.

SelectOption¶

class dislash.SelectOption(label: str, value: str, description: Optional[str] = None, emoji: Optional[str] = None, default: bool = False)¶

This class represents an option in a select menu.

Parameters

label (str) – the user-facing name of the option, max 25 characters
value (str) – the dev-define value of the option, max 100 characters
description (str) – an additional description of the option, max 50 characters
emoji (str) – well add an emoji to the option
default (bool) – will render this option as selected by default

classmethod from_dict(data: dict)¶

to_dict()¶

MessageCommand¶

class dislash.MessageCommand(name: str, **kwargs)¶

classmethod from_dict(data: dict)¶

to_dict(**kwargs)¶

MissingAnyRole¶

class dislash.MissingAnyRole(missing_roles)¶

MissingPermissions¶

class dislash.MissingPermissions(missing_perms, *args)¶

MissingRole¶

class dislash.MissingRole(missing_role)¶

NSFWChannelRequired¶

class dislash.NSFWChannelRequired(channel)¶

NoPrivateMessage¶

class dislash.NoPrivateMessage(message=None)¶

NotGuildOwner¶

class dislash.NotGuildOwner(message=None, *args)¶

NotOwner¶

class dislash.NotOwner(message=None, *args)¶

Option¶

class dislash.Option(name: str, description: Optional[str] = None, type: Optional[int] = None, required: bool = False, choices: Optional[List[dislash.interactions.application_command.OptionChoice]] = None, options: Optional[list] = None)¶

Parameters

name (str) – option’s name
description (str) – option’s description
type (Type) – the option type, e.g. Type.USER, see OptionType
required (bool) – whether this option is required or not
choices (List[OptionChoice]) – the list of option choices, type OptionChoice
options (List[Option]) – the list of sub options. You can only specify this parameter if the type is Type.SUB_COMMAND or Type.SUB_COMMAND_GROUP

add_choice(name: str, value: Any)¶

Adds an OptionChoice to the list of current choices

Parameters are the same as for OptionChoice

add_option(name: str, description: Optional[str] = None, type: Optional[int] = None, required: bool = False, choices: Optional[List[dislash.interactions.application_command.OptionChoice]] = None, options: Optional[list] = None)¶

Adds an option to the current list of options

Parameters are the same as for Option

classmethod from_dict(payload: dict)¶

to_dict()¶

OptionChoice¶

class dislash.OptionChoice(name: str, value: Any)¶

Parameters

name (str) – the name of the option-choice (visible to users)
value (str or int) – the value of the option-choice

OptionType¶

class dislash.OptionType¶

SUB_COMMAND = 1

SUB_COMMAND_GROUP = 2

STRING = 3

INTEGER = 4

BOOLEAN = 5

USER = 6

CHANNEL = 7

ROLE = 8

MENTIONABLE = 9

NUMBER = 10

PrivateMessageOnly¶

class dislash.PrivateMessageOnly(message=None)¶

RawCommandPermission¶

class dislash.RawCommandPermission(id: int, type: int, permission: bool)¶

Represents command permissions for a role or a user.

id¶

ID of a target

Type: int

type¶

1 if target is a role; 2 if target is a user

Type: int

permission¶

allow or deny the access to the command

Type: bool

classmethod from_dict(data: dict)¶

classmethod from_pair(target: Union[discord.role.Role, discord.user.User], permission: bool)¶

to_dict()¶

ResponseType¶

class dislash.ResponseType¶

All possible response type values. Used in Interaction.reply

Pong = 1: ACK a Ping

ChannelMessageWithSource = 4: Respond to an interaction with a message

AcknowledgeWithSource = 5: ACK an interaction and edit a response later, the user sees a loading state

DeferredUpdateMessage = 6: For components, ACK an interaction and edit the original message later; the user does not see a loading state

UpdateMessage = 7: For components, edit the message the component was attached to

SelectMenu¶

class dislash.SelectMenu(*, custom_id: Optional[str] = None, placeholder: Optional[str] = None, min_values: int = 1, max_values: int = 1, options: Optional[list] = None, disabled: bool = False)¶

This class represents a select menu.

Parameters

custom_id (str) – a developer-defined identifier for the button, max 100 characters
placeholder (str) – custom placeholder text if nothing is selected, max 100 characters
min_values (int) – the minimum number of items that must be chosen; default 1, min 0, max 25
max_values (int) – the maximum number of items that can be chosen; default 1, max 25
options (List[SelectOption]) – the choices in the select, max 25
disabled (bool) – disable the menu, defaults to false

custom_id¶

a developer-defined identifier for the button, max 100 characters

Type: str

placeholder¶

custom placeholder text if nothing is selected, max 100 characters

Type: str

min_values¶

the minimum number of items that must be chosen; default 1, min 0, max 25

Type: int

max_values¶

the maximum number of items that can be chosen; default 1, max 25

Type: int

options¶

the choices in the select, max 25

Type: List[SelectOption]

disabled¶

disable the menu, defaults to false

Type: bool

selected_options¶

the list of chosen options, max 25

Type: List[SelectOption]

add_option(label: str, value: str, description: Optional[str] = None, emoji: Optional[str] = None, default: bool = False)¶: Adds an option to the list of options of the menu. Parameters are the same as in SelectOption.

classmethod from_dict(data: dict)¶

to_dict()¶

SlashCommand¶

class dislash.SlashCommand(name: str, description: str, options: Optional[list] = None, default_permission: bool = True, **kwargs)¶

A base class for building slash-commands.

Parameters

name (str) – The command name
description (str) – The command description (it’ll be displayed by discord)
options (List[Option]) – The options of the command. See Option
default_permission (bool) – Whether the command is enabled by default when the app is added to a guild

add_option(name: str, description: Optional[str] = None, type: Optional[int] = None, required: bool = False, choices: Optional[List[dislash.interactions.application_command.OptionChoice]] = None, options: Optional[list] = None)¶

Adds an option to the current list of options

Parameters are the same as for Option

classmethod from_dict(payload: dict)¶

to_dict(*, hide_name=False)¶

SlashInteractionData¶

class dislash.SlashInteractionData(*, data, guild, state)¶

id¶

The id of the interaction

Type: int

name¶

The name of activated slash-command

Type: str

options¶

Represents options of the slash-command.

{name: InteractionDataOption, …}

Type: dict

resolved¶

The collection of related objects, such as users, members, roles, channels and messages

Type: Resolved

get(name: str, default=None)¶

Get the value of an option with the specified name

Parameters

name (str) – the name of the option you want to get
default (any) – what to return in case nothing was found

Returns

option_value (any) – The option type isn’t SUB_COMMAND_GROUP or SUB_COMMAND
option (InteractionDataOption | default) – Otherwise

get_option(name: str)¶

Get the raw InteractionDataOption matching the specified name

Parameters: name (str) – The name of the option you want to get
Returns: option
Return type: InteractionDataOption | None

option_at(index: int)¶

Get an option by it’s index

Parameters: index (int) – the index of the option you want to get
Returns: option – the option located at the specified index
Return type: InteractionDataOption | None

SubCommand¶

class dislash.SubCommand(func, *, name=None, description=None, options=None, connectors=None, **kwargs)¶

error(func)¶: A decorator that makes the function below work as error handler for this command.

get_cooldown_retry_after(inter)¶

Retrieves the amount of seconds before this slash command can be tried again.

Parameters: inter (SlashInteraction) – The interaction to retrieve the cooldown from.
Returns: The amount of time left on this slash command’s cooldown in seconds. If this is 0.0 then the slash command isn’t on cooldown.
Return type: float

is_on_cooldown(inter)¶

Checks whether the slash command is currently on cooldown.

Parameters: inter (SlashInteraction) – The interaction to use when checking the commands cooldown status.
Returns: A boolean indicating if the slash command is on cooldown.
Return type: bool

reset_cooldown(inter)¶

Resets the cooldown on this slash command.

Parameters: inter (SlashInteraction) – The interaction to reset the cooldown under.

SubCommandGroup¶

class dislash.SubCommandGroup(func, *, name=None, **kwargs)¶

error(func)¶: A decorator that makes the function below work as error handler for this command.

get_cooldown_retry_after(inter)¶

Retrieves the amount of seconds before this slash command can be tried again.

Parameters: inter (SlashInteraction) – The interaction to retrieve the cooldown from.
Returns: The amount of time left on this slash command’s cooldown in seconds. If this is 0.0 then the slash command isn’t on cooldown.
Return type: float

is_on_cooldown(inter)¶

Checks whether the slash command is currently on cooldown.

Parameters: inter (SlashInteraction) – The interaction to use when checking the commands cooldown status.
Returns: A boolean indicating if the slash command is on cooldown.
Return type: bool

reset_cooldown(inter)¶

Resets the cooldown on this slash command.

Parameters: inter (SlashInteraction) – The interaction to reset the cooldown under.

sub_command(name: Optional[str] = None, description: Optional[str] = None, options: Optional[list] = None, connectors: Optional[dict] = None, **kwargs)¶

A decorator that creates a subcommand in the subcommand group.

Parameters are the same as in CommandParent.sub_command

UserCommand¶

class dislash.UserCommand(name: str, **kwargs)¶

classmethod from_dict(data: dict)¶

to_dict(**kwargs)¶