API Reference#

The reference manual that follows details the API of Pycord’s bridge command extension module.

Note

Using the prefixed command version (which uses the ext.commands extension) of bridge commands in guilds requires Intents.message_context to be enabled.

Bots#

Bot#

Methods

defadd_bridge_command
@bridge_command
@bridge_group

class discord.ext.bridge.Bot(command_prefix=<function when_mentioned>, help_command=..., **options)[source]#

Represents a discord bot, with support for cross-compatibility between command types.

This class is a subclass of ext.commands.Bot and as a result anything that you can do with a ext.commands.Bot you can do with this bot.

New in version 2.0.

Parameters:

command_prefix (str | Iterable[str] | Callable[[Bot | AutoShardedBot, Message], str | Iterable[str] | Coroutine[Any, Any, str | Iterable[str]]]) –
help_command (HelpCommand | None) –

add_bridge_command(command)#

Takes a BridgeCommand and adds both a slash and traditional (prefix-based) version of the command to the bot.

Parameters:: command (BridgeCommand) –

@bridge_command#

A shortcut decorator that invokes bridge_command() and adds it to the internal command list via add_bridge_command().

Returns:: A decorator that converts the provided method into an BridgeCommand, adds both a slash and traditional (prefix-based) version of the command to the bot, and returns the BridgeCommand.
Return type:: Callable[…, BridgeCommand]

@bridge_group#

A decorator that is used to wrap a function as a bridge command group.

Parameters:: kwargs (Optional[Dict[str, Any]]) – Keyword arguments that are directly passed to the respective command constructors. (SlashCommandGroup and ext.commands.Group)

AutoShardedBot#

class discord.ext.bridge.AutoShardedBot(command_prefix=<function when_mentioned>, help_command=..., **options)[source]#

This is similar to Bot except that it is inherited from ext.commands.AutoShardedBot instead.

New in version 2.0.

Parameters:

command_prefix (str | Iterable[str] | Callable[[Bot | AutoShardedBot, Message], str | Iterable[str] | Coroutine[Any, Any, str | Iterable[str]]]) –
help_command (HelpCommand | None) –

Event Reference#

These events function similar to the regular events, except they are custom to the bridge extension module.

discord.ext.bridge.on_bridge_command_error(ctx, error)#

An error handler that is called when an error is raised inside a command either through user input error, check failure, or an error in your own code.

Parameters:

ctx (Context) – The invocation context.
error (CommandError derived) – The error that was raised.

discord.ext.bridge.on_bridge_command(ctx)#

An event that is called when a command is found and is about to be invoked.

This event is called regardless of whether the command itself succeeds via error or completes.

Parameters:: ctx (Context) – The invocation context.

discord.ext.bridge.on_bridge_command_completion(ctx)#

An event that is called when a command has completed its invocation.

This event is called only if the command succeeded, i.e. all checks have passed and users input them correctly.

Parameters:: ctx (Context) – The invocation context.

Commands#

BridgeCommand#

Attributes

description_localizations
ext_variant
name_localizations
slash_variant

Methods

defadd_to
@after_invoke
@before_invoke
@error

class discord.ext.bridge.BridgeCommand(callback, **kwargs)[source]#

Compatibility class between prefixed-based commands and slash commands.

Parameters:

callback (Callable[[BridgeContext, …], Awaitable[Any]]) – The callback to invoke when the command is executed. The first argument will be a BridgeContext, and any additional arguments will be passed to the callback. This callback must be a coroutine.
parent (Optional[BridgeCommandGroup]:) – Parent of the BridgeCommand.
kwargs (Optional[Dict[str, Any]]) – Keyword arguments that are directly passed to the respective command constructors. (SlashCommand and ext.commands.Command)

slash_variant#

The slash command version of this bridge command.

Type:: BridgeSlashCommand

ext_variant#

The prefix-based version of this bridge command.

Type:: BridgeExtCommand

property name_localizations#: Returns name_localizations from slash_variant You can edit/set name_localizations directly with .. code-block:: python3

bridge_command.name_localizations[“en-UK”] = … # or any other locale # or bridge_command.name_localizations = {“en-UK”: …, “fr-FR”: …}

property description_localizations#: Returns description_localizations from slash_variant You can edit/set description_localizations directly with .. code-block:: python3

bridge_command.description_localizations[“en-UK”] = … # or any other locale # or bridge_command.description_localizations = {“en-UK”: …, “fr-FR”: …}

add_to(bot)[source]#

Adds the command to a bot. This method is inherited by BridgeCommandGroup.

Parameters:: bot (Union[Bot, AutoShardedBot]) – The bot to add the command to.
Return type:: None

error(coro)[source]#

A decorator that registers a coroutine as a local error handler.

This error handler is limited to the command it is defined to. However, higher scope handlers (per-cog and global) are still invoked afterwards as a catch-all. This handler also functions as the handler for both the prefixed and slash versions of the command.

This error handler takes two parameters, a BridgeContext and a DiscordException.

Parameters:: coro (coroutine) – The coroutine to register as the local error handler.
Raises:: TypeError – The coroutine passed is not actually a coroutine.

before_invoke(coro)[source]#

A decorator that registers a coroutine as a pre-invoke hook.

This hook is called directly before the command is called, making it useful for any sort of set up required. This hook is called for both the prefixed and slash versions of the command.

This pre-invoke hook takes a sole parameter, a BridgeContext.

Parameters:: coro (coroutine) – The coroutine to register as the pre-invoke hook.
Raises:: TypeError – The coroutine passed is not actually a coroutine.

after_invoke(coro)[source]#

A decorator that registers a coroutine as a post-invoke hook.

This hook is called directly after the command is called, making it useful for any sort of clean up required. This hook is called for both the prefixed and slash versions of the command.

This post-invoke hook takes a sole parameter, a BridgeContext.

Parameters:: coro (coroutine) – The coroutine to register as the post-invoke hook.
Raises:: TypeError – The coroutine passed is not actually a coroutine.

BridgeCommandGroup#

Attributes

ext_variant
mapped
slash_variant
subcommands

Methods

@command
defwalk_commands

class discord.ext.bridge.BridgeCommandGroup(callback, *args, **kwargs)[source]#

Compatibility class between prefixed-based commands and slash commands.

Parameters:

callback (Callable[[BridgeContext, …], Awaitable[Any]]) – The callback to invoke when the command is executed. The first argument will be a BridgeContext, and any additional arguments will be passed to the callback. This callback must be a coroutine.
kwargs (Optional[Dict[str, Any]]) – Keyword arguments that are directly passed to the respective command constructors. (SlashCommand and ext.commands.Command)

slash_variant#

The slash command version of this command group.

Type:: SlashCommandGroup

ext_variant#

The prefix-based version of this command group.

Type:: ext.commands.Group

subcommands#

List of bridge commands in this group

Type:: List[BridgeCommand]

mapped#

If map_to() is used, the mapped slash command.

Type:: Optional[SlashCommand]

for ... in walk_commands()[source]#

An iterator that recursively walks through all the bridge group’s subcommands.

Yields:: BridgeCommand – A bridge command of this bridge group.

command(*args, **kwargs)[source]#

A decorator to register a function as a subcommand.

Parameters:: kwargs (Optional[Dict[str, Any]]) – Keyword arguments that are directly passed to the respective command constructors. (SlashCommand and ext.commands.Command)

Decorators#

@bridge.bridge_command#

A decorator that is used to wrap a function as a bridge command.

Parameters:: kwargs (Optional[Dict[str, Any]]) – Keyword arguments that are directly passed to the respective command constructors. (SlashCommand and ext.commands.Command)

@bridge.bridge_group#

A decorator that is used to wrap a function as a bridge command group.

Parameters:: kwargs (Optional[Dict[str, Any]]) – Keyword arguments that are directly passed to the respective command constructors (SlashCommandGroup and ext.commands.Group).

@bridge.map_to#

To be used with bridge command groups, map the main command to a slash subcommand.

Parameters:

name (str) – The new name of the mapped command.
description (Optional[str]) – The new description of the mapped command.

Example

@bot.bridge_group()
@bridge.map_to("show")
async def config(ctx: BridgeContext):
    ...

@config.command()
async def toggle(ctx: BridgeContext):
    ...

Prefixed commands will not be affected, but slash commands will appear as:

/config show
/config toggle

@bridge.guild_only#

Intended to work with ApplicationCommand and BridgeCommand, adds a check() that locks the command to only run in guilds, and also registers the command as guild only client-side (on discord).

Basically a utility function that wraps both discord.ext.commands.guild_only() and discord.commands.guild_only().

@bridge.is_nsfw#

Intended to work with ApplicationCommand and BridgeCommand, adds a check() that locks the command to only run in nsfw contexts, and also registers the command as nsfw client-side (on discord).

Basically a utility function that wraps both discord.ext.commands.is_nsfw() and discord.commands.is_nsfw().

Warning

In DMs, the prefixed-based command will always run as the user’s privacy settings cannot be checked directly.

@bridge.has_permissions#

Intended to work with SlashCommand and BridgeCommand, adds a check() that locks the command to be run by people with certain permissions inside guilds, and also registers the command as locked behind said permissions.

Basically a utility function that wraps both discord.ext.commands.has_permissions() and discord.commands.default_permissions().

Parameters:: **perms (Dict[str, bool]) – An argument list of permissions to check for.

Command Subclasses#

class discord.ext.bridge.BridgeExtCommand(*args, **kwargs)[source]#: A subclass of ext.commands.Command that is used for bridge commands.

class discord.ext.bridge.BridgeExtGroup(*args, **kwargs)[source]#: A subclass of ext.commands.Group that is used for bridge commands.

class discord.ext.bridge.BridgeSlashCommand(*args, **kwargs)[source]#: A subclass of SlashCommand that is used for bridge commands.

class discord.ext.bridge.BridgeSlashGroup(*args, **kwargs)[source]#: A subclass of SlashCommandGroup that is used for bridge commands.

Context#

BridgeContext#

Attributes

is_app

Methods

asyncdefer
asyncedit
definvoke
asyncreply
asyncrespond

class discord.ext.bridge.BridgeContext[source]#

The base context class for compatibility commands. This class is an abstract base class (also known as an abc), which is subclassed by BridgeExtContext and BridgeApplicationContext. The methods in this class are meant to give parity between the two contexts, while still allowing for all of their functionality.

When this is passed to a command, it will either be passed as BridgeExtContext, or BridgeApplicationContext. Since they are two separate classes, it’s easy to use the BridgeContext.is_app attribute. to make different functionality for each context. For example, if you want to respond to a command with the command type that it was invoked with, you can do the following:

@bot.bridge_command()
async def example(ctx: BridgeContext):
    if ctx.is_app:
        command_type = "Application command"
    else:
        command_type = "Traditional (prefix-based) command"
    await ctx.send(f"This command was invoked with a(n) {command_type}.")

New in version 2.0.

invoke(**kwds)#: Helper for @overload to raise when called.

await respond(*args, **kwargs)[source]#

This function is a coroutine.

Responds to the command with the respective response type to the current context. In BridgeExtContext, this will be reply() while in BridgeApplicationContext, this will be respond().

Return type:: Interaction | WebhookMessage | Message

await reply(*args, **kwargs)[source]#

This function is a coroutine.

Alias for respond().

Return type:: Interaction | WebhookMessage | Message

await defer(*args, **kwargs)[source]#

This function is a coroutine.

Defers the command with the respective approach to the current context. In BridgeExtContext, this will be trigger_typing() while in BridgeApplicationContext, this will be defer. :rtype: None

Note

There is no trigger_typing alias for this method. trigger_typing will always provide the same functionality across contexts.

await edit(*args, **kwargs)[source]#

This function is a coroutine.

Edits the original response message with the respective approach to the current context. In BridgeExtContext, this will have a custom approach where respond() caches the message to be edited here. In BridgeApplicationContext, this will be edit.

Return type:: InteractionMessage | Message

property is_app#: Whether the context is an BridgeApplicationContext or not.

BridgeContext Subclasses#

class discord.ext.bridge.BridgeApplicationContext(*args, **kwargs)[source]#: The application context class for compatibility commands. This class is a subclass of BridgeContext and ApplicationContext. This class is meant to be used with BridgeCommand.

New in version 2.0.

Methods

asyncdelete

class discord.ext.bridge.BridgeExtContext(*args, **kwargs)[source]#

The ext.commands context class for compatibility commands. This class is a subclass of BridgeContext and Context. This class is meant to be used with BridgeCommand.

New in version 2.0.

await delete(*, delay=None, reason=None)[source]#

This function is a coroutine.

Deletes the original response message, if it exists.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait before deleting the message.
reason (Optional[str]) – The reason for deleting the message. Shows up on the audit log.

Return type:

None

discord.ext.bridge.Context#: alias of Union[BridgeExtContext, BridgeApplicationContext]

Option#

BridgeOption#

Methods

asyncconvert

class discord.ext.bridge.BridgeOption(input_type=<class 'str'>, /, description=None, **kwargs)[source]#

A subclass of discord.Option which represents a selectable slash command option and a prefixed command argument for bridge commands.

Parameters:

input_type (InputType) –
description (str | None) –

await convert(ctx, argument)[source]#

This function is a coroutine.

The method to override to do conversion logic.

If an error is found while converting, it is recommended to raise a CommandError derived exception as it will properly propagate to the error handlers.

Parameters:

ctx (Context) – The invocation context that the argument is being used in.
argument (str) – The argument that is being converted.

Raises:

.CommandError – A generic exception occurred when converting the argument.
.BadArgument – The converter failed to convert the argument.

Return type:

Any