APIリファレンス

この項目ではdiscord.pyのAPIが持つコマンド拡張モジュールについて解説します。

Bots

Bot

class discord.ext.commands.Bot(command_prefix, help_command=<default-help-command>, description=None, **options)

Discord Botを表します。

このクラスは discord.Client のサブクラスのため、 discord.Client でできることと同じことをこのBotで行うことができます。

また、 GroupMixin も継承しており、コマンド管理の機能も使用可能です。

command_prefix

コマンドの接頭詞とは、コマンドの判定のためにメッセージの先頭に付けなければならないものです。接頭詞には、そのまま接頭詞として使用する文字列、または discord.Message を二つ目の引数として受け取り、接頭詞を返す呼び出し可能な関数を渡すことができます。これは「動的な」接頭詞の実装を容易にするためです。

接頭詞に空文字列を渡せば、接頭詞なしでコマンドの呼び出しができます。これはDM上では有用ですが、サーバーでは意図せずコマンドを呼び出してしまうことに繋がるため、避けるべきです。

接頭詞は複数設定することもできます。複数の接頭詞がイテラブルで渡された場合、メッセージと最初に一致するものが接頭詞として使用されます。この接頭詞は Context.prefix で取得することができます。また、空のイテラブルオブジェクトは使用できません。

注釈

複数の接頭辞を渡すとき、後の接頭辞にマッチする接頭辞を、それよりも前に渡さないよう注意してください。たとえば、接頭辞が``('!', '!?')``のとき、!?``の接頭辞は、その前のものが!?``で始まるメッセージにマッチするため、どのメッセージにも反応しません。これは空文字列を渡すときは特に重要で、その後の接頭辞は無視されるため、空文字列は最後に置かないといけません。

case_insensitive

Whether the commands should be case insensitive. Defaults to False. This attribute does not carry over to groups. You must set it to every group if you require group commands to be case insensitive as well.

Type

bool

description

The content prefixed into the default help message.

Type

str

self_bot

If True, the bot will only listen to commands invoked by itself rather than ignoring itself. If False (the default) then the bot will ignore itself. This cannot be changed once initialised.

Type

bool

help_command

The help command implementation to use. This can be dynamically set at runtime. To remove the help command pass None. For more information on implementing a help command, see Help Commands.

Type

Optional[HelpCommand]

owner_id

The user ID that owns the bot. If this is not set and is then queried via is_owner() then it is fetched automatically using application_info().

Type

Optional[int]

owner_ids

The user IDs that owns the bot. This is similar to owner_id. If this is not set and the application is team based, then it is fetched automatically using application_info(). For performance reasons it is recommended to use a set for the collection. You cannot set both owner_id and owner_ids.

バージョン 1.3 で追加.

Type

Optional[Collection[int]]

strip_after_prefix

Whether to strip whitespace characters after encountering the command prefix. This allows for !   hello and !hello to both work if the command_prefix is set to !. Defaults to False.

バージョン 1.7 で追加.

Type

bool

activity

The activity being used upon logging in.

Type

Optional[BaseActivity]

add_check(func, *, call_once=False)

ボットにグローバルチェックを追加します。

これは:meth:.check`と:meth:.check_once`のデコレータでない実装です。

パラメータ
  • func -- グローバルチェックとして使用される関数。

  • call_once (bool) -- If the function should only be called once per Command.invoke() call.

add_cog(cog, *, override=False)

botに「コグ」を追加します。

コグは、イベントリスナーとコマンドを持つクラスです。

バージョン 2.0 で変更: ClientException is raised when a cog with the same name is already loaded.

パラメータ
  • cog (Cog) -- ボットに登録するコグ。

  • override (bool) --

    If a previously loaded cog with the same name should be ejected instead of raising an error.

    バージョン 2.0 で追加.

例外
add_command(command)

Adds a Command into the internal list of commands.

これは通常、呼び出されません。代わりに command()group() のショートカットデコレータが使われます。

バージョン 1.4 で変更: Raise CommandRegistrationError instead of generic ClientException

パラメータ

command (Command) -- 追加するコマンド。

例外
add_listener(func, name=None)

listen() の代替の非デコレータ

パラメータ
  • func (coroutine) -- 呼び出される関数

  • name (Optional[str]) -- 待機するイベントの名前。デフォルトでは func.__name__ です。

サンプル

async def on_ready(): pass
async def my_message(message): pass

bot.add_listener(on_ready)
bot.add_listener(my_message, 'on_message')
after_invoke(coro)

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

A post-invoke hook is called directly after the command is called. This makes it a useful function to clean-up database connections or any type of clean up required.

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

注釈

Similar to before_invoke(), this is not called unless checks and argument parsing procedures succeed. This hook is, however, always called regardless of the internal command callback raising an error (i.e. CommandInvokeError). This makes it ideal for clean-up scenarios.

パラメータ

coro (coroutine) -- The coroutine to register as the post-invoke hook.

例外

TypeError -- The coroutine passed is not actually a coroutine.

allowed_mentions

The allowed mention configuration.

バージョン 1.4 で追加.

Type

Optional[AllowedMentions]

application_id

The client's application ID.

If this is not passed via __init__ then this is retrieved through the gateway when an event contains the data. Usually after on_connect() is called.

Type

Optional[int]

await application_info()

This function is a coroutine.

Botのアプリケーション情報を取得します。

例外

HTTPException -- Retrieving the information failed somehow.

戻り値

Botのアプリケーション情報。

戻り値の型

AppInfo

await before_identify_hook(shard_id, *, initial=False)

This function is a coroutine.

A hook that is called before IDENTIFYing a session. This is useful if you wish to have more control over the synchronization of multiple IDENTIFYing clients.

The default implementation sleeps for 5 seconds.

バージョン 1.4 で追加.

パラメータ
  • shard_id (int) -- The shard ID that requested being IDENTIFY'd

  • initial (bool) -- Whether this IDENTIFY is the first initial IDENTIFY.

before_invoke(coro)

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

A pre-invoke hook is called directly before the command is called. This makes it a useful function to set up database connections or any type of set up required.

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

注釈

The before_invoke() and after_invoke() hooks are only called if all checks and argument parsing procedures pass without error. If any check or argument parsing procedures fail then the hooks are not called.

パラメータ

coro (coroutine) -- The coroutine to register as the pre-invoke hook.

例外

TypeError -- The coroutine passed is not actually a coroutine.

cached_messages

Read-only list of messages the connected client has cached.

バージョン 1.1 で追加.

Type

Sequence[Message]

await change_presence(*, activity=None, status=None, afk=False)

This function is a coroutine.

クライアントのステータスを変更します。

サンプル

game = discord.Game("with the API")
await client.change_presence(status=discord.Status.idle, activity=game)
パラメータ
  • activity (Optional[BaseActivity]) -- 実行中のアクティビティ。何も実行していない場合は None を返します。

  • status (Optional[Status]) -- 変更するステータスを示します。 None の場合、 Status.online が使用されます。

  • afk (Optional[bool]) -- ステータスを退席中に変更するかどうかを返します。これによって、実際にアイドル状態に移行した場合において、Discordクライアントにプッシュ通知をより適切に処理させることができます。

例外

InvalidArgument -- If the activity parameter is not the proper type.

check(func)

Botにグローバルチェックを追加するデコレーター

このグローバルチェックは、 check() がコマンドごとに適用されるのと似ていますが、コマンドチェックが検証され、かつBotが持つすべてのコマンドが適用される前に実行される点で異なります。

注釈

この関数は、通常の関数かコルーチン、どちらでも成り得ます。

check() コマンドと同様、 Context 型の単一のパラメータを取り、 CommandError から継承された例外のみを投げることができます。

サンプル

@bot.check
def check_commands(ctx):
    return ctx.command.qualified_name in allowed_commands
check_once(func)

Botに「一度だけ実行される」グローバルチェックを追加するデコレーター

Unlike regular global checks, this one is called only once per Command.invoke() call.

通常のグローバルチェックは、コマンドが呼び出されるか Command.can_run() が呼び出されるたび、実行されます。しかしこのグローバルチェックはそれを迂回し、デフォルトのhelpコマンドの中であっても、たった一度だけ呼ばれます。

注釈

When using this function the Context sent to a group subcommand may only parse the parent command and not the subcommands due to it being invoked once per Bot.invoke() call.

注釈

この関数は、通常の関数かコルーチン、どちらでも成り得ます。

check() コマンドと同様、 Context 型の単一のパラメータを取り、 CommandError から継承された例外のみを投げることができます。

サンプル

@bot.check_once
def whitelist(ctx):
    return ctx.message.author.id in my_whitelist
clear()

Botの内部状態をクリアします。

これが実行されると、Botは「再実行」されたと見なされます。また、これにより is_closed()is_ready()False を返し、内部のキャッシュもクリアされます。

cogs

A read-only mapping of cog name to cog.

Type

Mapping[str, Cog]

command(*args, **kwargs)

command() を呼び出し、 add_command() を介して内部コマンドリストに追加するショートカットデコレータ。

戻り値

A decorator that converts the provided method into a Command, adds it to the bot, then returns it.

戻り値の型

Callable[..., Command]

commands

A unique set of commands without aliases that are registered.

Type

Set[Command]

await connect(*, reconnect=True)

This function is a coroutine.

WebSocket接続を作成し、Discordからのメッセージをリッスンできるようにします。これはイベントシステム全体とライブラリの様々な機能を実行するループです。WebSocket接続が終了するまで、プログラムは再開されません。

パラメータ

reconnect (bool) -- インターネットの障害やDiscord側の特定の障害が発生した際、再接続を試みるかどうかを表します。不正な状態へ移行する可能性がある特定の切断(無効なシャーディングpayloadや不正なトークンなど) は処理されません。

例外
  • GatewayNotFound -- If the gateway to connect to Discord is not found. Usually if this is thrown then there is a Discord API outage.

  • ConnectionClosed -- The websocket connection has been terminated.

await create_guild(name, region=None, icon=None, *, code=None)

This function is a coroutine.

Guild を作成します。

10以上のギルドに参加しているBotアカウントは、ギルドの作成ができません。

パラメータ
  • name (str) -- ギルドの名前。

  • region (VoiceRegion) -- 音声通話に利用されるサーバーの地域。デフォルト値は VoiceRegion.us_west

  • icon (bytes) -- The bytes-like object representing the icon. See ClientUser.edit() for more details on what is expected.

  • code (Optional[str]) --

    The code for a template to create the guild with.

    バージョン 1.4 で追加.

例外
戻り値

The guild created. This is not the same guild that is added to cache.

戻り値の型

Guild

await delete_invite(invite)

This function is a coroutine.

Invite や、招待のURL、IDを削除します。

これを行うには、関連付けられたGuildにて、 manage_channels 権限が必要です。

パラメータ

invite (Union[Invite, str]) -- 取り消す招待。

例外
  • Forbidden -- You do not have permissions to revoke invites.

  • NotFound -- The invite is invalid or expired.

  • HTTPException -- Revoking the invite failed.

emojis

The emojis that the connected client has.

Type

List[Emoji]

event(coro)

リッスンするイベントを登録するデコレータ。

イベントの詳細については 以下のドキュメント を参照してください。

イベントは コルーチン でなければいけません。違う場合は TypeError が発生します。

サンプル

@client.event
async def on_ready():
    print('Ready!')
例外

TypeError -- The coroutine passed is not actually a coroutine.

extensions

A read-only mapping of extension name to extension.

Type

Mapping[str, types.ModuleType]

await fetch_channel(channel_id)

This function is a coroutine.

Retrieves a abc.GuildChannel or abc.PrivateChannel with the specified ID.

注釈

This method is an API call. For general usage, consider get_channel() instead.

バージョン 1.2 で追加.

例外
  • InvalidData -- An unknown channel type was received from Discord.

  • HTTPException -- Retrieving the channel failed.

  • NotFound -- Invalid Channel ID.

  • Forbidden -- You do not have permission to fetch this channel.

戻り値

IDから取得したチャンネル。

戻り値の型

Union[ abc.GuildChannel , abc.PrivateChannel ]

await fetch_guild(guild_id)

This function is a coroutine.

IDから Guild を取得します。

注釈

Using this, you will not receive Guild.channels, Guild.members, Member.activity and Member.voice per Member.

注釈

このメソッドはAPIを呼び出します。通常は get_guild() を代わりとして使用してください。

パラメータ

guild_id (int) -- 取得したいギルドのID。

例外
戻り値

IDから取得したギルド。

戻り値の型

Guild

fetch_guilds(*, limit=100, before=None, after=None)

Botが所属するGuildを取得できる、 AsyncIterator を取得します。

注釈

これを使った場合、各 GuildGuild.ownerGuild.iconGuild.idGuild.name のみ取得できます。

注釈

これはAPIを呼び出します。通常は guilds を代わりに使用してください。

サンプル

使い方

async for guild in client.fetch_guilds(limit=150):
    print(guild.name)

リストへフラット化

guilds = await client.fetch_guilds(limit=150).flatten()
# guilds is now a list of Guild...

すべてのパラメータがオプションです。

パラメータ
  • limit (Optional[int]) -- The number of guilds to retrieve. If None, it retrieves every guild you have access to. Note, however, that this would make it a slow operation. Defaults to 100.

  • before (Union[abc.Snowflake, datetime.datetime]) -- Retrieves guilds before this date or object. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

  • after (Union[abc.Snowflake, datetime.datetime]) -- Retrieve guilds after this date or object. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

例外

HTTPException -- Getting the guilds failed.

列挙

Guild -- データを解析したGuild。

await fetch_invite(url, *, with_counts=True)

This function is a coroutine.

Gets an Invite from a discord.gg URL or ID.

注釈

If the invite is for a guild you have not joined, the guild and channel attributes of the returned Invite will be PartialInviteGuild and PartialInviteChannel respectively.

パラメータ
例外
戻り値

The invite from the URL/ID.

戻り値の型

Invite

await fetch_template(code)

This function is a coroutine.

Gets a Template from a discord.new URL or code.

パラメータ

code (Union[Template, str]) -- The Discord Template Code or URL (must be a discord.new URL).

例外
戻り値

The template from the URL/code.

戻り値の型

Template

await fetch_user(user_id)

This function is a coroutine.

Retrieves a User based on their ID. This can only be used by bot accounts. You do not have to share any guilds with the user to get this information, however many operations do require that you do.

注釈

This method is an API call. For general usage, consider get_user() instead.

パラメータ

user_id (int) -- The user's ID to fetch from.

例外
戻り値

The user you requested.

戻り値の型

User

await fetch_webhook(webhook_id)

This function is a coroutine.

Retrieves a Webhook with the specified ID.

例外
戻り値

The webhook you requested.

戻り値の型

Webhook

await fetch_widget(guild_id)

This function is a coroutine.

Gets a Widget from a guild ID.

注釈

The guild must have the widget enabled to get this information.

パラメータ

guild_id (int) -- The ID of the guild.

例外
戻り値

The guild's widget.

戻り値の型

Widget

for ... in get_all_channels()

A generator that retrieves every abc.GuildChannel the client can 'access'.

This is equivalent to:

for guild in client.guilds:
    for channel in guild.channels:
        yield channel

注釈

Just because you receive a abc.GuildChannel does not mean that you can communicate in said channel. abc.GuildChannel.permissions_for() should be used for that.

列挙

abc.GuildChannel -- A channel the client can 'access'.

for ... in get_all_members()

Returns a generator with every Member the client can see.

This is equivalent to:

for guild in client.guilds:
    for member in guild.members:
        yield member
列挙

Member -- A member the client can see.

get_channel(id)

Returns a channel with the given ID.

パラメータ

id (int) -- The ID to search for.

戻り値

The returned channel or None if not found.

戻り値の型

Optional[Union[abc.GuildChannel, abc.PrivateChannel]]

get_cog(name)

Gets the cog instance requested.

If the cog is not found, None is returned instead.

パラメータ

name (str) -- The name of the cog you are requesting. This is equivalent to the name passed via keyword argument in class creation or the class name if unspecified.

戻り値

The cog that was requested. If not found, returns None.

戻り値の型

Optional[Cog]

get_command(name)

Get a Command from the internal list of commands.

This could also be used as a way to get aliases.

The name could be fully qualified (e.g. 'foo bar') will get the subcommand bar of the group command foo. If a subcommand is not found then None is returned just as usual.

パラメータ

name (str) -- The name of the command to get.

戻り値

The command that was requested. If not found, returns None.

戻り値の型

Optional[Command]

await get_context(message, *, cls=<class 'discord.ext.commands.context.Context'>)

This function is a coroutine.

Returns the invocation context from the message.

This is a more low-level counter-part for process_commands() to allow users more fine grained control over the processing.

The returned context is not guaranteed to be a valid invocation context, Context.valid must be checked to make sure it is. If the context is not valid then it is not a valid candidate to be invoked under invoke().

パラメータ
  • message (discord.Message) -- The message to get the invocation context from.

  • cls -- The factory class that will be used to create the context. By default, this is Context. Should a custom class be provided, it must be similar enough to Context's interface.

戻り値

The invocation context. The type of this can change via the cls parameter.

戻り値の型

Context

get_emoji(id)

Returns an emoji with the given ID.

パラメータ

id (int) -- The ID to search for.

戻り値

The custom emoji or None if not found.

戻り値の型

Optional[Emoji]

get_guild(id)

Returns a guild with the given ID.

パラメータ

id (int) -- The ID to search for.

戻り値

The guild or None if not found.

戻り値の型

Optional[Guild]

await get_prefix(message)

This function is a coroutine.

Retrieves the prefix the bot is listening to with the message as a context.

パラメータ

message (discord.Message) -- The message context to get the prefix of.

戻り値

A list of prefixes or a single prefix that the bot is listening for.

戻り値の型

Union[List[str], str]

get_user(id)

Returns a user with the given ID.

パラメータ

id (int) -- The ID to search for.

戻り値

The user or None if not found.

戻り値の型

Optional[User]

group(*args, **kwargs)

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

戻り値

A decorator that converts the provided method into a Group, adds it to the bot, then returns it.

戻り値の型

Callable[..., Group]

guilds

The guilds that the connected client is a member of.

Type

List[Guild]

intents

The intents configured for this connection.

バージョン 1.5 で追加.

Type

Intents

await invoke(ctx)

This function is a coroutine.

Invokes the command given under the invocation context and handles all the internal event dispatch mechanisms.

パラメータ

ctx (Context) -- The invocation context to invoke.

is_closed()

bool: Indicates if the websocket connection is closed.

await is_owner(user)

This function is a coroutine.

Checks if a User or Member is the owner of this bot.

If an owner_id is not set, it is fetched automatically through the use of application_info().

バージョン 1.3 で変更: The function also checks if the application is team-owned if owner_ids is not set.

パラメータ

user (abc.User) -- The user to check for.

戻り値

Whether the user is the owner.

戻り値の型

bool

is_ready()

bool: Specifies if the client's internal cache is ready for use.

is_ws_ratelimited()

bool: Whether the websocket is currently rate limited.

This can be useful to know when deciding whether you should query members using HTTP or via the gateway.

バージョン 1.6 で追加.

latency

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

This could be referred to as the Discord WebSocket protocol latency.

Type

float

listen(name=None)

A decorator that registers another function as an external event listener. Basically this allows you to listen to multiple events from different places e.g. such as on_ready()

The functions being listened to must be a coroutine.

サンプル

@bot.listen()
async def on_message(message):
    print('one')

# in some other file...

@bot.listen('on_message')
async def my_message(message):
    print('two')

Would print one and two in an unspecified order.

例外

TypeError -- The function being listened to is not a coroutine.

load_extension(name, *, package=None)

Loads an extension.

An extension is a python module that contains commands, cogs, or listeners.

An extension must have a global function, setup defined as the entry point on what to do when the extension is loaded. This entry point must have a single argument, the bot.

パラメータ
  • name (str) -- The extension name to load. It must be dot separated like regular Python imports if accessing a sub-module. e.g. foo.test if you want to import foo/test.py.

  • package (Optional[str]) --

    The package name to resolve relative imports with. This is required when loading an extension using a relative path, e.g .foo.test. Defaults to None.

    バージョン 1.7 で追加.

例外
  • ExtensionNotFound -- The extension could not be imported. This is also raised if the name of the extension could not be resolved using the provided package parameter.

  • ExtensionAlreadyLoaded -- The extension is already loaded.

  • NoEntryPointError -- The extension does not have a setup function.

  • ExtensionFailed -- The extension or its setup function had an execution error.

await login(token)

This function is a coroutine.

Logs in the client with the specified credentials.

パラメータ

token (str) -- The authentication token. Do not prefix this token with anything as the library will do it for you.

例外
  • LoginFailure -- The wrong credentials are passed.

  • HTTPException -- An unknown HTTP related error occurred, usually when it isn't 200 or the known incorrect credentials passing status code.

await on_command_error(context, exception)

This function is a coroutine.

The default command error handler provided by the bot.

By default this prints to sys.stderr however it could be overridden to have a different implementation.

This only fires if you do not specify any listeners for command error.

await on_error(event_method, *args, **kwargs)

This function is a coroutine.

The default error handler provided by the client.

By default this prints to sys.stderr however it could be overridden to have a different implementation. Check on_error() for more details.

private_channels

The private channels that the connected client is participating on.

注釈

This returns only up to 128 most recent private channels due to an internal working on how Discord deals with private channels.

Type

List[abc.PrivateChannel]

await process_commands(message)

This function is a coroutine.

This function processes the commands that have been registered to the bot and other groups. Without this coroutine, none of the commands will be triggered.

By default, this coroutine is called inside the on_message() event. If you choose to override the on_message() event, then you should invoke this coroutine as well.

This is built using other low level tools, and is equivalent to a call to get_context() followed by a call to invoke().

This also checks if the message's author is a bot and doesn't call get_context() or invoke() if so.

パラメータ

message (discord.Message) -- The message to process commands for.

reload_extension(name, *, package=None)

Atomically reloads an extension.

This replaces the extension with the same extension, only refreshed. This is equivalent to a unload_extension() followed by a load_extension() except done in an atomic way. That is, if an operation fails mid-reload then the bot will roll-back to the prior working state.

パラメータ
  • name (str) -- The extension name to reload. It must be dot separated like regular Python imports if accessing a sub-module. e.g. foo.test if you want to import foo/test.py.

  • package (Optional[str]) --

    The package name to resolve relative imports with. This is required when reloading an extension using a relative path, e.g .foo.test. Defaults to None.

    バージョン 1.7 で追加.

例外
  • ExtensionNotLoaded -- The extension was not loaded.

  • ExtensionNotFound -- The extension could not be imported. This is also raised if the name of the extension could not be resolved using the provided package parameter.

  • NoEntryPointError -- The extension does not have a setup function.

  • ExtensionFailed -- The extension setup function had an execution error.

remove_check(func, *, call_once=False)

Removes a global check from the bot.

This function is idempotent and will not raise an exception if the function is not in the global checks.

パラメータ
  • func -- The function to remove from the global checks.

  • call_once (bool) -- If the function was added with call_once=True in the Bot.add_check() call or using check_once().

remove_cog(name)

Removes a cog from the bot.

All registered commands and event listeners that the cog has registered will be removed as well.

If no cog is found then this method has no effect.

パラメータ

name (str) -- The name of the cog to remove.

remove_command(name)

Remove a Command from the internal list of commands.

This could also be used as a way to remove aliases.

パラメータ

name (str) -- The name of the command to remove.

戻り値

The command that was removed. If the name is not valid then None is returned instead.

戻り値の型

Optional[Command]

remove_listener(func, name=None)

Removes a listener from the pool of listeners.

パラメータ
  • func -- The function that was used as a listener to remove.

  • name (str) -- 削除したいイベントの名前。デフォルトでは func.__name__ です。

run(*args, **kwargs)

A blocking call that abstracts away the event loop initialisation from you.

If you want more control over the event loop then this function should not be used. Use start() coroutine or connect() + login().

Roughly Equivalent to:

try:
    loop.run_until_complete(start(*args, **kwargs))
except KeyboardInterrupt:
    loop.run_until_complete(close())
    # cancel all tasks lingering
finally:
    loop.close()

警告

This function must be the last function to call due to the fact that it is blocking. That means that registration of events or anything being called after this function call will not execute until it returns.

await start(token, *, reconnect=True)

This function is a coroutine.

A shorthand coroutine for login() + connect().

例外

TypeError -- An unexpected keyword argument was received.

unload_extension(name, *, package=None)

Unloads an extension.

When the extension is unloaded, all commands, listeners, and cogs are removed from the bot and the module is un-imported.

The extension can provide an optional global function, teardown, to do miscellaneous clean-up if necessary. This function takes a single parameter, the bot, similar to setup from load_extension().

パラメータ
  • name (str) -- The extension name to unload. It must be dot separated like regular Python imports if accessing a sub-module. e.g. foo.test if you want to import foo/test.py.

  • package (Optional[str]) --

    The package name to resolve relative imports with. This is required when unloading an extension using a relative path, e.g .foo.test. Defaults to None.

    バージョン 1.7 で追加.

例外
user

Represents the connected client. None if not logged in.

Type

Optional[ClientUser]

users

Returns a list of all the users the bot can see.

Type

List[User]

voice_clients

Represents a list of voice connections.

These are usually VoiceClient instances.

Type

List[VoiceProtocol]

wait_for(event, *, check=None, timeout=None)

This function is a coroutine.

Waits for a WebSocket event to be dispatched.

This could be used to wait for a user to reply to a message, or to react to a message, or to edit a message in a self-contained way.

The timeout parameter is passed onto asyncio.wait_for(). By default, it does not timeout. Note that this does propagate the asyncio.TimeoutError for you in case of timeout and is provided for ease of use.

In case the event returns multiple arguments, a tuple containing those arguments is returned instead. Please check the documentation for a list of events and their parameters.

This function returns the first event that meets the requirements.

サンプル

Waiting for a user reply:

@client.event
async def on_message(message):
    if message.content.startswith('$greet'):
        channel = message.channel
        await channel.send('Say hello!')

        def check(m):
            return m.content == 'hello' and m.channel == channel

        msg = await client.wait_for('message', check=check)
        await channel.send(f'Hello {msg.author}!')

Waiting for a thumbs up reaction from the message author:

@client.event
async def on_message(message):
    if message.content.startswith('$thumb'):
        channel = message.channel
        await channel.send('Send me that 👍 reaction, mate')

        def check(reaction, user):
            return user == message.author and str(reaction.emoji) == '👍'

        try:
            reaction, user = await client.wait_for('reaction_add', timeout=60.0, check=check)
        except asyncio.TimeoutError:
            await channel.send('👎')
        else:
            await channel.send('👍')
パラメータ
  • event (str) -- The event name, similar to the event reference, but without the on_ prefix, to wait for.

  • check (Optional[Callable[..., bool]]) -- A predicate to check what to wait for. The arguments must meet the parameters of the event being waited for.

  • timeout (Optional[float]) -- The number of seconds to wait before timing out and raising asyncio.TimeoutError.

例外

asyncio.TimeoutError -- If a timeout is provided and it was reached.

戻り値

Returns no arguments, a single argument, or a tuple of multiple arguments that mirrors the parameters passed in the event reference.

戻り値の型

Any

await wait_until_ready()

This function is a coroutine.

Waits until the client's internal cache is all ready.

for ... in walk_commands()

An iterator that recursively walks through all commands and subcommands.

バージョン 1.4 で変更: Duplicates due to aliases are no longer returned

列挙

Union[Command, Group] -- A command or group from the internal list of commands.

AutoShardedBot

class discord.ext.commands.AutoShardedBot(command_prefix, help_command=<default-help-command>, description=None, **options)

This is similar to Bot except that it is inherited from discord.AutoShardedClient instead.

Prefix Helpers

discord.ext.commands.when_mentioned(bot, msg)

A callable that implements a command prefix equivalent to being mentioned.

These are meant to be passed into the Bot.command_prefix attribute.

discord.ext.commands.when_mentioned_or(*prefixes)

A callable that implements when mentioned or other prefixes provided.

These are meant to be passed into the Bot.command_prefix attribute.

サンプル

bot = commands.Bot(command_prefix=commands.when_mentioned_or('!'))

注釈

This callable returns another callable, so if this is done inside a custom callable, you must call the returned callable, for example:

async def get_prefix(bot, message):
    extras = await prefixes_for(message.guild) # returns a list
    return commands.when_mentioned_or(*extras)(bot, message)

イベントリファレンス

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

discord.on_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.

A default one is provided (Bot.on_command_error()).

パラメータ
  • ctx (Context) -- The invocation context.

  • error (CommandError derived) -- The error that was raised.

discord.on_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.

パラメータ

ctx (Context) -- The invocation context.

discord.on_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 the user input it correctly.

パラメータ

ctx (Context) -- The invocation context.

Commands

Decorators

discord.ext.commands.command(name=None, cls=None, **attrs)

A decorator that transforms a function into a Command or if called with group(), Group.

By default the help attribute is received automatically from the docstring of the function and is cleaned up with the use of inspect.cleandoc. If the docstring is bytes, then it is decoded into str using utf-8 encoding.

All checks added using the check() & co. decorators are added into the function. There is no way to supply your own checks through this decorator.

パラメータ
  • name (str) -- The name to create the command with. By default this uses the function name unchanged.

  • cls -- The class to construct with. By default this is Command. You usually do not change this.

  • attrs -- Keyword arguments to pass into the construction of the class denoted by cls.

例外

TypeError -- If the function is not a coroutine or is already a command.

discord.ext.commands.group(name=None, **attrs)

A decorator that transforms a function into a Group.

This is similar to the command() decorator but the cls parameter is set to Group by default.

バージョン 1.1 で変更: The cls parameter can now be passed.

Command

class discord.ext.commands.Command(*args, **kwargs)

A class that implements the protocol for a bot text command.

These are not created manually, instead they are created via the decorator or functional interface.

name

The name of the command.

Type

str

callback

The coroutine that is executed when the command is called.

Type

coroutine

help

The long help text for the command.

Type

str

brief

The short help text for the command.

Type

Optional[str]

usage

A replacement for arguments in the default help text.

Type

Optional[str]

aliases

The list of aliases the command can be invoked under.

Type

Union[List[str], Tuple[str]]

enabled

A boolean that indicates if the command is currently enabled. If the command is invoked while it is disabled, then DisabledCommand is raised to the on_command_error() event. Defaults to True.

Type

bool

parent

The parent command that this command belongs to. None if there isn't one.

Type

Optional[Command]

cog

The cog that this command belongs to. None if there isn't one.

Type

Optional[Cog]

checks

A list of predicates that verifies if the command could be executed with the given Context as the sole parameter. If an exception is necessary to be thrown to signal failure, then one inherited from CommandError should be used. Note that if the checks fail then CheckFailure exception is raised to the on_command_error() event.

Type

List[Callable[[Context], bool]]

description

The message prefixed into the default help command.

Type

str

hidden

If True, the default help command does not show this in the help output.

Type

bool

rest_is_raw

If False and a keyword-only argument is provided then the keyword only argument is stripped and handled as if it was a regular argument that handles MissingRequiredArgument and default values in a regular matter rather than passing the rest completely raw. If True then the keyword-only argument will pass in the rest of the arguments in a completely raw matter. Defaults to False.

Type

bool

invoked_subcommand

The subcommand that was invoked, if any.

Type

Optional[Command]

require_var_positional

If True and a variadic positional argument is specified, requires the user to specify at least one argument. Defaults to False.

バージョン 1.5 で追加.

Type

bool

ignore_extra

If True, ignores extraneous strings passed to a command if all its requirements are met (e.g. ?foo a b c when only expecting a and b). Otherwise on_command_error() and local error handlers are called with TooManyArguments. Defaults to True.

Type

bool

cooldown_after_parsing

If True, cooldown processing is done after argument parsing, which calls converters. If False then cooldown processing is done first and then the converters are called second. Defaults to False.

Type

bool

add_check(func)

Adds a check to the command.

This is the non-decorator interface to check().

バージョン 1.3 で追加.

パラメータ

func -- The function that will be used as a check.

remove_check(func)

Removes a check from the command.

This function is idempotent and will not raise an exception if the function is not in the command's checks.

バージョン 1.3 で追加.

パラメータ

func -- The function to remove from the checks.

update(**kwargs)

Updates Command instance with updated attribute.

This works similarly to the command() decorator in terms of parameters in that they are passed to the Command or subclass constructors, sans the name and callback.

await __call__(*args, **kwargs)

This function is a coroutine.

Calls the internal callback that the command holds.

注釈

This bypasses all mechanisms -- including checks, converters, invoke hooks, cooldowns, etc. You must take care to pass the proper arguments and types to this function.

バージョン 1.3 で追加.

copy()

Creates a copy of this command.

戻り値

A new instance of this command.

戻り値の型

Command

clean_params

Dict[str, inspect.Parameter]: Retrieves the parameter dictionary without the context or self parameters.

Useful for inspecting signature.

full_parent_name

Retrieves the fully qualified parent command name.

This the base command name required to execute it. For example, in ?one two three the parent name would be one two.

Type

str

parents

Retrieves the parents of this command.

If the command has no parents then it returns an empty list.

For example in commands ?a b c test, the parents are [c, b, a].

バージョン 1.1 で追加.

Type

List[Command]

root_parent

Retrieves the root parent of this command.

If the command has no parents then it returns None.

For example in commands ?a b c test, the root parent is a.

Type

Optional[Command]

qualified_name

Retrieves the fully qualified command name.

This is the full parent name with the command name as well. For example, in ?one two three the qualified name would be one two three.

Type

str

is_on_cooldown(ctx)

Checks whether the command is currently on cooldown.

パラメータ

ctx (Context) -- The invocation context to use when checking the commands cooldown status.

戻り値

A boolean indicating if the command is on cooldown.

戻り値の型

bool

reset_cooldown(ctx)

Resets the cooldown on this command.

パラメータ

ctx (Context) -- The invocation context to reset the cooldown under.

get_cooldown_retry_after(ctx)

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

バージョン 1.4 で追加.

パラメータ

ctx (Context) -- The invocation context to retrieve the cooldown from.

戻り値

The amount of time left on this command's cooldown in seconds. If this is 0.0 then the command isn't on cooldown.

戻り値の型

float

error(coro)

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

A local error handler is an on_command_error() event limited to a single command. However, the on_command_error() is still invoked afterwards as the catch-all.

パラメータ

coro (coroutine) -- The coroutine to register as the local error handler.

例外

TypeError -- The coroutine passed is not actually a coroutine.

has_error_handler()

bool: Checks whether the command has an error handler registered.

バージョン 1.7 で追加.

before_invoke(coro)

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

A pre-invoke hook is called directly before the command is called. This makes it a useful function to set up database connections or any type of set up required.

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

See Bot.before_invoke() for more info.

パラメータ

coro (coroutine) -- The coroutine to register as the pre-invoke hook.

例外

TypeError -- The coroutine passed is not actually a coroutine.

after_invoke(coro)

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

A post-invoke hook is called directly after the command is called. This makes it a useful function to clean-up database connections or any type of clean up required.

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

See Bot.after_invoke() for more info.

パラメータ

coro (coroutine) -- The coroutine to register as the post-invoke hook.

例外

TypeError -- The coroutine passed is not actually a coroutine.

cog_name

The name of the cog this command belongs to, if any.

Type

Optional[str]

short_doc

Gets the "short" documentation of a command.

By default, this is the brief attribute. If that lookup leads to an empty string then the first line of the help attribute is used instead.

Type

str

signature

Returns a POSIX-like signature useful for help command output.

Type

str

await can_run(ctx)

This function is a coroutine.

Checks if the command can be executed by checking all the predicates inside the checks attribute. This also checks whether the command is disabled.

バージョン 1.3 で変更: Checks whether the command is disabled or not

パラメータ

ctx (Context) -- The ctx of the command currently being invoked.

例外

CommandError -- Any command error that was raised during a check call will be propagated by this function.

戻り値

A boolean indicating if the command can be invoked.

戻り値の型

bool

Group

class discord.ext.commands.Group(*args, **kwargs)

A class that implements a grouping protocol for commands to be executed as subcommands.

This class is a subclass of Command and thus all options valid in Command are valid in here as well.

invoke_without_command

Indicates if the group callback should begin parsing and invocation only if no subcommand was found. Useful for making it an error handling function to tell the user that no subcommand was found or to have different functionality in case no subcommand was found. If this is False, then the group callback will always be invoked first. This means that the checks and the parsing dictated by its parameters will be executed. Defaults to False.

Type

bool

case_insensitive

Indicates if the group's commands should be case insensitive. Defaults to False.

Type

bool

copy()

Creates a copy of this Group.

戻り値

A new instance of this group.

戻り値の型

Group

add_check(func)

Adds a check to the command.

This is the non-decorator interface to check().

バージョン 1.3 で追加.

パラメータ

func -- The function that will be used as a check.

add_command(command)

Adds a Command into the internal list of commands.

これは通常、呼び出されません。代わりに command()group() のショートカットデコレータが使われます。

バージョン 1.4 で変更: Raise CommandRegistrationError instead of generic ClientException

パラメータ

command (Command) -- 追加するコマンド。

例外
after_invoke(coro)

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

A post-invoke hook is called directly after the command is called. This makes it a useful function to clean-up database connections or any type of clean up required.

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

See Bot.after_invoke() for more info.

パラメータ

coro (coroutine) -- The coroutine to register as the post-invoke hook.

例外

TypeError -- The coroutine passed is not actually a coroutine.

before_invoke(coro)

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

A pre-invoke hook is called directly before the command is called. This makes it a useful function to set up database connections or any type of set up required.

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

See Bot.before_invoke() for more info.

パラメータ

coro (coroutine) -- The coroutine to register as the pre-invoke hook.

例外

TypeError -- The coroutine passed is not actually a coroutine.

await can_run(ctx)

This function is a coroutine.

Checks if the command can be executed by checking all the predicates inside the checks attribute. This also checks whether the command is disabled.

バージョン 1.3 で変更: Checks whether the command is disabled or not

パラメータ

ctx (Context) -- The ctx of the command currently being invoked.

例外

CommandError -- Any command error that was raised during a check call will be propagated by this function.

戻り値

A boolean indicating if the command can be invoked.

戻り値の型

bool

clean_params

Dict[str, inspect.Parameter]: Retrieves the parameter dictionary without the context or self parameters.

Useful for inspecting signature.

cog_name

The name of the cog this command belongs to, if any.

Type

Optional[str]

command(*args, **kwargs)

command() を呼び出し、 add_command() を介して内部コマンドリストに追加するショートカットデコレータ。

戻り値

A decorator that converts the provided method into a Command, adds it to the bot, then returns it.

戻り値の型

Callable[..., Command]

commands

A unique set of commands without aliases that are registered.

Type

Set[Command]

error(coro)

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

A local error handler is an on_command_error() event limited to a single command. However, the on_command_error() is still invoked afterwards as the catch-all.

パラメータ

coro (coroutine) -- The coroutine to register as the local error handler.

例外

TypeError -- The coroutine passed is not actually a coroutine.

full_parent_name

Retrieves the fully qualified parent command name.

This the base command name required to execute it. For example, in ?one two three the parent name would be one two.

Type

str

get_command(name)

Get a Command from the internal list of commands.

This could also be used as a way to get aliases.

The name could be fully qualified (e.g. 'foo bar') will get the subcommand bar of the group command foo. If a subcommand is not found then None is returned just as usual.

パラメータ

name (str) -- The name of the command to get.

戻り値

The command that was requested. If not found, returns None.

戻り値の型

Optional[Command]

get_cooldown_retry_after(ctx)

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

バージョン 1.4 で追加.

パラメータ

ctx (Context) -- The invocation context to retrieve the cooldown from.

戻り値

The amount of time left on this command's cooldown in seconds. If this is 0.0 then the command isn't on cooldown.

戻り値の型

float

group(*args, **kwargs)

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

戻り値

A decorator that converts the provided method into a Group, adds it to the bot, then returns it.

戻り値の型

Callable[..., Group]

has_error_handler()

bool: Checks whether the command has an error handler registered.

バージョン 1.7 で追加.

is_on_cooldown(ctx)

Checks whether the command is currently on cooldown.

パラメータ

ctx (Context) -- The invocation context to use when checking the commands cooldown status.

戻り値

A boolean indicating if the command is on cooldown.

戻り値の型

bool

parents

Retrieves the parents of this command.

If the command has no parents then it returns an empty list.

For example in commands ?a b c test, the parents are [c, b, a].

バージョン 1.1 で追加.

Type

List[Command]

qualified_name

Retrieves the fully qualified command name.

This is the full parent name with the command name as well. For example, in ?one two three the qualified name would be one two three.

Type

str

remove_check(func)

Removes a check from the command.

This function is idempotent and will not raise an exception if the function is not in the command's checks.

バージョン 1.3 で追加.

パラメータ

func -- The function to remove from the checks.

remove_command(name)

Remove a Command from the internal list of commands.

This could also be used as a way to remove aliases.

パラメータ

name (str) -- The name of the command to remove.

戻り値

The command that was removed. If the name is not valid then None is returned instead.

戻り値の型

Optional[Command]

reset_cooldown(ctx)

Resets the cooldown on this command.

パラメータ

ctx (Context) -- The invocation context to reset the cooldown under.

root_parent

Retrieves the root parent of this command.

If the command has no parents then it returns None.

For example in commands ?a b c test, the root parent is a.

Type

Optional[Command]

short_doc

Gets the "short" documentation of a command.

By default, this is the brief attribute. If that lookup leads to an empty string then the first line of the help attribute is used instead.

Type

str

signature

Returns a POSIX-like signature useful for help command output.

Type

str

update(**kwargs)

Updates Command instance with updated attribute.

This works similarly to the command() decorator in terms of parameters in that they are passed to the Command or subclass constructors, sans the name and callback.

for ... in walk_commands()

An iterator that recursively walks through all commands and subcommands.

バージョン 1.4 で変更: Duplicates due to aliases are no longer returned

列挙

Union[Command, Group] -- A command or group from the internal list of commands.

GroupMixin

class discord.ext.commands.GroupMixin(*args, **kwargs)

A mixin that implements common functionality for classes that behave similar to Group and are allowed to register commands.

all_commands

A mapping of command name to Command objects.

Type

dict

case_insensitive

Whether the commands should be case insensitive. Defaults to False.

Type

bool

commands

A unique set of commands without aliases that are registered.

Type

Set[Command]

add_command(command)

Adds a Command into the internal list of commands.

これは通常、呼び出されません。代わりに command()group() のショートカットデコレータが使われます。

バージョン 1.4 で変更: Raise CommandRegistrationError instead of generic ClientException

パラメータ

command (Command) -- 追加するコマンド。

例外
remove_command(name)

Remove a Command from the internal list of commands.

This could also be used as a way to remove aliases.

パラメータ

name (str) -- The name of the command to remove.

戻り値

The command that was removed. If the name is not valid then None is returned instead.

戻り値の型

Optional[Command]

for ... in walk_commands()

An iterator that recursively walks through all commands and subcommands.

バージョン 1.4 で変更: Duplicates due to aliases are no longer returned

列挙

Union[Command, Group] -- A command or group from the internal list of commands.

get_command(name)

Get a Command from the internal list of commands.

This could also be used as a way to get aliases.

The name could be fully qualified (e.g. 'foo bar') will get the subcommand bar of the group command foo. If a subcommand is not found then None is returned just as usual.

パラメータ

name (str) -- The name of the command to get.

戻り値

The command that was requested. If not found, returns None.

戻り値の型

Optional[Command]

command(*args, **kwargs)

command() を呼び出し、 add_command() を介して内部コマンドリストに追加するショートカットデコレータ。

戻り値

A decorator that converts the provided method into a Command, adds it to the bot, then returns it.

戻り値の型

Callable[..., Command]

group(*args, **kwargs)

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

戻り値

A decorator that converts the provided method into a Group, adds it to the bot, then returns it.

戻り値の型

Callable[..., Group]

Cogs

Cog

class discord.ext.commands.Cog(*args, **kwargs)

The base class that all cogs must inherit from.

A cog is a collection of commands, listeners, and optional state to help group commands together. More information on them can be found on the コグ page.

When inheriting from this class, the options shown in CogMeta are equally valid here.

get_commands()
戻り値

A list of Commands that are defined inside this cog.

注釈

This does not include subcommands.

戻り値の型

List[Command]

qualified_name

Returns the cog's specified name, not the class name.

Type

str

description

Returns the cog's description, typically the cleaned docstring.

Type

str

for ... in walk_commands()

An iterator that recursively walks through this cog's commands and subcommands.

列挙

Union[Command, Group] -- A command or group from the cog.

get_listeners()

Returns a list of (name, function) listener pairs that are defined in this cog.

戻り値

The listeners defined in this cog.

戻り値の型

List[Tuple[str, coroutine]]

classmethod listener(name=None)

A decorator that marks a function as a listener.

This is the cog equivalent of Bot.listen().

パラメータ

name (str) -- The name of the event being listened to. If not provided, it defaults to the function's name.

例外

TypeError -- The function is not a coroutine function or a string was not passed as the name.

has_error_handler()

bool: Checks whether the cog has an error handler.

バージョン 1.7 で追加.

cog_unload()

A special method that is called when the cog gets removed.

This function cannot be a coroutine. It must be a regular function.

Subclasses must replace this if they want special unloading behaviour.

bot_check_once(ctx)

A special method that registers as a Bot.check_once() check.

This function can be a coroutine and must take a sole parameter, ctx, to represent the Context.

bot_check(ctx)

A special method that registers as a Bot.check() check.

This function can be a coroutine and must take a sole parameter, ctx, to represent the Context.

cog_check(ctx)

A special method that registers as a commands.check() for every command and subcommand in this cog.

This function can be a coroutine and must take a sole parameter, ctx, to represent the Context.

await cog_command_error(ctx, error)

A special method that is called whenever an error is dispatched inside this cog.

This is similar to on_command_error() except only applying to the commands inside this cog.

This must be a coroutine.

パラメータ
  • ctx (Context) -- The invocation context where the error happened.

  • error (CommandError) -- The error that happened.

await cog_before_invoke(ctx)

A special method that acts as a cog local pre-invoke hook.

This is similar to Command.before_invoke().

This must be a coroutine.

パラメータ

ctx (Context) -- The invocation context.

await cog_after_invoke(ctx)

A special method that acts as a cog local post-invoke hook.

This is similar to Command.after_invoke().

This must be a coroutine.

パラメータ

ctx (Context) -- The invocation context.

CogMeta

class discord.ext.commands.CogMeta(*args, **kwargs)

A metaclass for defining a cog.

Note that you should probably not use this directly. It is exposed purely for documentation purposes along with making custom metaclasses to intermix with other metaclasses such as the abc.ABCMeta metaclass.

For example, to create an abstract cog mixin class, the following would be done.

import abc

class CogABCMeta(commands.CogMeta, abc.ABCMeta):
    pass

class SomeMixin(metaclass=abc.ABCMeta):
    pass

class SomeCogMixin(SomeMixin, commands.Cog, metaclass=CogABCMeta):
    pass

注釈

When passing an attribute of a metaclass that is documented below, note that you must pass it as a keyword-only argument to the class creation like the following example:

class MyCog(commands.Cog, name='My Cog'):
    pass
name

The cog name. By default, it is the name of the class with no modification.

Type

str

description

The cog description. By default, it is the cleaned docstring of the class.

バージョン 1.6 で追加.

Type

str

command_attrs

A list of attributes to apply to every command inside this cog. The dictionary is passed into the Command options at __init__. If you specify attributes inside the command attribute in the class, it will override the one specified inside this attribute. For example:

class MyCog(commands.Cog, command_attrs=dict(hidden=True)):
    @commands.command()
    async def foo(self, ctx):
        pass # hidden -> True

    @commands.command(hidden=False)
    async def bar(self, ctx):
        pass # hidden -> False
Type

dict

Help Commands

HelpCommand

class discord.ext.commands.HelpCommand(*args, **kwargs)

The base implementation for help command formatting.

注釈

Internally instances of this class are deep copied every time the command itself is invoked to prevent a race condition mentioned in GH-2123.

This means that relying on the state of this class to be the same between command invocations would not work as expected.

context

The context that invoked this help formatter. This is generally set after the help command assigned, command_callback(), has been called.

Type

Optional[Context]

show_hidden

Specifies if hidden commands should be shown in the output. Defaults to False.

Type

bool

verify_checks

Specifies if commands should have their Command.checks called and verified. If True, always calls Commands.checks. If None, only calls Commands.checks in a guild setting. If False, never calls Commands.checks. Defaults to True.

..versionchanged:: 1.7

Type

Optional[bool]

command_attrs

A dictionary of options to pass in for the construction of the help command. This allows you to change the command behaviour without actually changing the implementation of the command. The attributes will be the same as the ones passed in the Command constructor.

Type

dict

add_check(func)

Adds a check to the help command.

バージョン 1.4 で追加.

パラメータ

func -- The function that will be used as a check.

remove_check(func)

Removes a check from the help command.

This function is idempotent and will not raise an exception if the function is not in the command's checks.

バージョン 1.4 で追加.

パラメータ

func -- The function to remove from the checks.

get_bot_mapping()

Retrieves the bot mapping passed to send_bot_help().

invoked_with

Similar to Context.invoked_with except properly handles the case where Context.send_help() is used.

If the help command was used regularly then this returns the Context.invoked_with attribute. Otherwise, if it the help command was called using Context.send_help() then it returns the internal command name of the help command.

戻り値

The command name that triggered this invocation.

戻り値の型

str

get_command_signature(command)

ヘルプページに表示される、コマンドの使用方法を示す文字列を返します。

パラメータ

command (Command) -- The command to get the signature of.

戻り値

The signature for the command.

戻り値の型

str

remove_mentions(string)

Removes mentions from the string to prevent abuse.

This includes @everyone, @here, member mentions and role mentions.

戻り値

The string with mentions removed.

戻り値の型

str

cog

A property for retrieving or setting the cog for the help command.

When a cog is set for the help command, it is as-if the help command belongs to that cog. All cog special methods will apply to the help command and it will be automatically unset on unload.

To unbind the cog from the help command, you can set it to None.

戻り値

The cog that is currently set for the help command.

戻り値の型

Optional[Cog]

command_not_found(string)

This function could be a coroutine.

A method called when a command is not found in the help command. This is useful to override for i18n.

Defaults to No command called {0} found.

パラメータ

string (str) -- The string that contains the invalid command. Note that this has had mentions removed to prevent abuse.

戻り値

The string to use when a command has not been found.

戻り値の型

str

subcommand_not_found(command, string)

This function could be a coroutine.

A method called when a command did not have a subcommand requested in the help command. This is useful to override for i18n.

Defaults to either:

  • 'Command "{command.qualified_name}" has no subcommands.'
    • If there is no subcommand in the command parameter.

  • 'Command "{command.qualified_name}" has no subcommand named {string}'
    • If the command parameter has subcommands but not one named string.

パラメータ
  • command (Command) -- The command that did not have the subcommand requested.

  • string (str) -- The string that contains the invalid subcommand. Note that this has had mentions removed to prevent abuse.

戻り値

The string to use when the command did not have the subcommand requested.

戻り値の型

str

await filter_commands(commands, *, sort=False, key=None)

This function is a coroutine.

Returns a filtered list of commands and optionally sorts them.

This takes into account the verify_checks and show_hidden attributes.

パラメータ
  • commands (Iterable[Command]) -- An iterable of commands that are getting filtered.

  • sort (bool) -- Whether to sort the result.

  • key (Optional[Callable[Command, Any]]) -- An optional key function to pass to sorted() that takes a Command as its sole parameter. If sort is passed as True then this will default as the command name.

戻り値

A list of commands that passed the filter.

戻り値の型

List[Command]

get_max_size(commands)

Returns the largest name length of the specified command list.

パラメータ

commands (Sequence[Command]) -- A sequence of commands to check for the largest size.

戻り値

The maximum width of the commands.

戻り値の型

int

get_destination()

Returns the Messageable where the help command will be output.

You can override this method to customise the behaviour.

By default this returns the context's channel.

戻り値

The destination where the help command will be output.

戻り値の型

abc.Messageable

await send_error_message(error)

This function is a coroutine.

Handles the implementation when an error happens in the help command. For example, the result of command_not_found() or command_has_no_subcommand_found() will be passed here.

You can override this method to customise the behaviour.

By default, this sends the error message to the destination specified by get_destination().

注釈

You can access the invocation context with HelpCommand.context.

パラメータ

error (str) -- The error message to display to the user. Note that this has had mentions removed to prevent abuse.

await on_help_command_error(ctx, error)

This function is a coroutine.

The help command's error handler, as specified by エラーハンドリング.

Useful to override if you need some specific behaviour when the error handler is called.

By default this method does nothing and just propagates to the default error handlers.

パラメータ
await send_bot_help(mapping)

This function is a coroutine.

Handles the implementation of the bot command page in the help command. This function is called when the help command is called with no arguments.

It should be noted that this method does not return anything -- rather the actual message sending should be done inside this method. Well behaved subclasses should use get_destination() to know where to send, as this is a customisation point for other users.

You can override this method to customise the behaviour.

注釈

You can access the invocation context with HelpCommand.context.

Also, the commands in the mapping are not filtered. To do the filtering you will have to call filter_commands() yourself.

パラメータ

mapping (Mapping[Optional[Cog], List[Command]]) -- A mapping of cogs to commands that have been requested by the user for help. The key of the mapping is the Cog that the command belongs to, or None if there isn't one, and the value is a list of commands that belongs to that cog.

await send_cog_help(cog)

This function is a coroutine.

Handles the implementation of the cog page in the help command. This function is called when the help command is called with a cog as the argument.

It should be noted that this method does not return anything -- rather the actual message sending should be done inside this method. Well behaved subclasses should use get_destination() to know where to send, as this is a customisation point for other users.

You can override this method to customise the behaviour.

注釈

You can access the invocation context with HelpCommand.context.

To get the commands that belong to this cog see Cog.get_commands(). The commands returned not filtered. To do the filtering you will have to call filter_commands() yourself.

パラメータ

cog (Cog) -- The cog that was requested for help.

await send_group_help(group)

This function is a coroutine.

Handles the implementation of the group page in the help command. This function is called when the help command is called with a group as the argument.

It should be noted that this method does not return anything -- rather the actual message sending should be done inside this method. Well behaved subclasses should use get_destination() to know where to send, as this is a customisation point for other users.

You can override this method to customise the behaviour.

注釈

You can access the invocation context with HelpCommand.context.

To get the commands that belong to this group without aliases see Group.commands. The commands returned not filtered. To do the filtering you will have to call filter_commands() yourself.

パラメータ

group (Group) -- The group that was requested for help.

await send_command_help(command)

This function is a coroutine.

Handles the implementation of the single command page in the help command.

It should be noted that this method does not return anything -- rather the actual message sending should be done inside this method. Well behaved subclasses should use get_destination() to know where to send, as this is a customisation point for other users.

You can override this method to customise the behaviour.

注釈

You can access the invocation context with HelpCommand.context.

Showing Help

There are certain attributes and methods that are helpful for a help command to show such as the following:

There are more than just these attributes but feel free to play around with these to help you get started to get the output that you want.

パラメータ

command (Command) -- The command that was requested for help.

await prepare_help_command(ctx, command=None)

This function is a coroutine.

A low level method that can be used to prepare the help command before it does anything. For example, if you need to prepare some state in your subclass before the command does its processing then this would be the place to do it.

The default implementation does nothing.

注釈

This is called inside the help command callback body. So all the usual rules that happen inside apply here as well.

パラメータ
  • ctx (Context) -- The invocation context.

  • command (Optional[str]) -- The argument passed to the help command.

await command_callback(ctx, *, command=None)

This function is a coroutine.

The actual implementation of the help command.

It is not recommended to override this method and instead change the behaviour through the methods that actually get dispatched.

DefaultHelpCommand

class discord.ext.commands.DefaultHelpCommand(*args, **kwargs)

The implementation of the default help command.

This inherits from HelpCommand.

It extends it with the following attributes.

width

The maximum number of characters that fit in a line. Defaults to 80.

Type

int

sort_commands

Whether to sort the commands in the output alphabetically. Defaults to True.

Type

bool

dm_help

A tribool that indicates if the help command should DM the user instead of sending it to the channel it received it from. If the boolean is set to True, then all help output is DM'd. If False, none of the help output is DM'd. If None, then the bot will only DM when the help message becomes too long (dictated by more than dm_help_threshold characters). Defaults to False.

Type

Optional[bool]

dm_help_threshold

The number of characters the paginator must accumulate before getting DM'd to the user if dm_help is set to None. Defaults to 1000.

Type

Optional[int]

indent

How much to indent the commands from a heading. Defaults to 2.

Type

int

commands_heading

The command list's heading string used when the help command is invoked with a category name. Useful for i18n. Defaults to "Commands:"

Type

str

no_category

The string used when there is a command which does not belong to any category(cog). Useful for i18n. Defaults to "No Category"

Type

str

paginator

The paginator used to paginate the help command output.

Type

Paginator

shorten_text(text)

str: Shortens text to fit into the width.

get_ending_note()

str: Returns help command's ending note. This is mainly useful to override for i18n purposes.

add_indented_commands(commands, *, heading, max_size=None)

Indents a list of commands after the specified heading.

The formatting is added to the paginator.

The default implementation is the command name indented by indent spaces, padded to max_size followed by the command's Command.short_doc and then shortened to fit into the width.

パラメータ
  • commands (Sequence[Command]) -- A list of commands to indent for output.

  • heading (str) -- The heading to add to the output. This is only added if the list of commands is greater than 0.

  • max_size (Optional[int]) -- The max size to use for the gap between indents. If unspecified, calls get_max_size() on the commands parameter.

await send_pages()

A helper utility to send the page output from paginator to the destination.

add_command_formatting(command)

A utility function to format the non-indented block of commands and groups.

パラメータ

command (Command) -- The command to format.

get_destination()

Returns the Messageable where the help command will be output.

You can override this method to customise the behaviour.

By default this returns the context's channel.

戻り値

The destination where the help command will be output.

戻り値の型

abc.Messageable

MinimalHelpCommand

class discord.ext.commands.MinimalHelpCommand(*args, **kwargs)

An implementation of a help command with minimal output.

This inherits from HelpCommand.

sort_commands

Whether to sort the commands in the output alphabetically. Defaults to True.

Type

bool

commands_heading

The command list's heading string used when the help command is invoked with a category name. Useful for i18n. Defaults to "Commands"

Type

str

aliases_heading

The alias list's heading string used to list the aliases of the command. Useful for i18n. Defaults to "Aliases:".

Type

str

dm_help

A tribool that indicates if the help command should DM the user instead of sending it to the channel it received it from. If the boolean is set to True, then all help output is DM'd. If False, none of the help output is DM'd. If None, then the bot will only DM when the help message becomes too long (dictated by more than dm_help_threshold characters). Defaults to False.

Type

Optional[bool]

dm_help_threshold

The number of characters the paginator must accumulate before getting DM'd to the user if dm_help is set to None. Defaults to 1000.

Type

Optional[int]

no_category

The string used when there is a command which does not belong to any category(cog). Useful for i18n. Defaults to "No Category"

Type

str

paginator

The paginator used to paginate the help command output.

Type

Paginator

await send_pages()

A helper utility to send the page output from paginator to the destination.

get_opening_note()

Returns help command's opening note. This is mainly useful to override for i18n purposes.

The default implementation returns

Use `{prefix}{command_name} [command]` for more info on a command.
You can also use `{prefix}{command_name} [category]` for more info on a category.
戻り値

The help command opening note.

戻り値の型

str

get_command_signature(command)

ヘルプページに表示される、コマンドの使用方法を示す文字列を返します。

パラメータ

command (Command) -- The command to get the signature of.

戻り値

The signature for the command.

戻り値の型

str

get_ending_note()

Return the help command's ending note. This is mainly useful to override for i18n purposes.

The default implementation does nothing.

戻り値

The help command ending note.

戻り値の型

str

add_bot_commands_formatting(commands, heading)

Adds the minified bot heading with commands to the output.

The formatting should be added to the paginator.

The default implementation is a bold underline heading followed by commands separated by an EN SPACE (U+2002) in the next line.

パラメータ
  • commands (Sequence[Command]) -- A list of commands that belong to the heading.

  • heading (str) -- The heading to add to the line.

add_subcommand_formatting(command)

Adds formatting information on a subcommand.

The formatting should be added to the paginator.

The default implementation is the prefix and the Command.qualified_name optionally followed by an En dash and the command's Command.short_doc.

パラメータ

command (Command) -- The command to show information of.

add_aliases_formatting(aliases)

Adds the formatting information on a command's aliases.

The formatting should be added to the paginator.

The default implementation is the aliases_heading bolded followed by a comma separated list of aliases.

This is not called if there are no aliases to format.

パラメータ

aliases (Sequence[str]) -- A list of aliases to format.

add_command_formatting(command)

A utility function to format commands and groups.

パラメータ

command (Command) -- The command to format.

get_destination()

Returns the Messageable where the help command will be output.

You can override this method to customise the behaviour.

By default this returns the context's channel.

戻り値

The destination where the help command will be output.

戻り値の型

abc.Messageable

Paginator

Methods
class discord.ext.commands.Paginator(prefix='```', suffix='```', max_size=2000, linesep='\n')

A class that aids in paginating code blocks for Discord messages.

len(x)

Returns the total number of characters in the paginator.

prefix

The prefix inserted to every page. e.g. three backticks.

Type

str

suffix

The suffix appended at the end of every page. e.g. three backticks.

Type

str

max_size

The maximum amount of codepoints allowed in a page.

Type

int

linesep
The character string inserted between lines. e.g. a newline character.

バージョン 1.7 で追加.

Type

str

clear()

Clears the paginator to have no pages.

add_line(line='', *, empty=False)

Adds a line to the current page.

If the line exceeds the max_size then an exception is raised.

パラメータ
  • line (str) -- The line to add.

  • empty (bool) -- Indicates if another empty line should be added.

例外

RuntimeError -- The line was too big for the current max_size.

close_page()

Prematurely terminate a page.

pages

Returns the rendered list of pages.

Type

List[str]

Enums

class discord.ext.commands.BucketType

Specifies a type of bucket for, e.g. a cooldown.

default

The default bucket operates on a global basis.

user

The user bucket operates on a per-user basis.

guild

The guild bucket operates on a per-guild basis.

channel

The channel bucket operates on a per-channel basis.

member

The member bucket operates on a per-member basis.

category

The category bucket operates on a per-category basis.

role

The role bucket operates on a per-role basis.

バージョン 1.3 で追加.

Checks

discord.ext.commands.check(predicate)

A decorator that adds a check to the Command or its subclasses. These checks could be accessed via Command.checks.

These checks should be predicates that take in a single parameter taking a Context. If the check returns a False-like value then during invocation a CheckFailure exception is raised and sent to the on_command_error() event.

If an exception should be thrown in the predicate then it should be a subclass of CommandError. Any exception not subclassed from it will be propagated while those subclassed will be sent to on_command_error().

A special attribute named predicate is bound to the value returned by this decorator to retrieve the predicate passed to the decorator. This allows the following introspection and chaining to be done:

def owner_or_permissions(**perms):
    original = commands.has_permissions(**perms).predicate
    async def extended_check(ctx):
        if ctx.guild is None:
            return False
        return ctx.guild.owner_id == ctx.author.id or await original(ctx)
    return commands.check(extended_check)

注釈

The function returned by predicate is always a coroutine, even if the original function was not a coroutine.

バージョン 1.3 で変更: The predicate attribute was added.

サンプル

Creating a basic check to see if the command invoker is you.

def check_if_it_is_me(ctx):
    return ctx.message.author.id == 85309593344815104

@bot.command()
@commands.check(check_if_it_is_me)
async def only_for_me(ctx):
    await ctx.send('I know you!')

Transforming common checks into its own decorator:

def is_me():
    def predicate(ctx):
        return ctx.message.author.id == 85309593344815104
    return commands.check(predicate)

@bot.command()
@is_me()
async def only_me(ctx):
    await ctx.send('Only you!')
パラメータ

predicate (Callable[[Context], bool]) -- The predicate to check if the command should be invoked.

discord.ext.commands.check_any(*checks)

A check() that is added that checks if any of the checks passed will pass, i.e. using logical OR.

If all checks fail then CheckAnyFailure is raised to signal the failure. It inherits from CheckFailure.

注釈

The predicate attribute for this function is a coroutine.

バージョン 1.3 で追加.

パラメータ

*checks (Callable[[Context], bool]) -- An argument list of checks that have been decorated with the check() decorator.

例外

TypeError -- A check passed has not been decorated with the check() decorator.

サンプル

Creating a basic check to see if it's the bot owner or the server owner:

def is_guild_owner():
    def predicate(ctx):
        return ctx.guild is not None and ctx.guild.owner_id == ctx.author.id
    return commands.check(predicate)

@bot.command()
@commands.check_any(commands.is_owner(), is_guild_owner())
async def only_for_owners(ctx):
    await ctx.send('Hello mister owner!')
discord.ext.commands.has_role(item)

A check() that is added that checks if the member invoking the command has the role specified via the name or ID specified.

If a string is specified, you must give the exact name of the role, including 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 return False.

This check raises one of two special exceptions, MissingRole if the user is missing a role, or NoPrivateMessage if it is used in a private message. Both inherit from CheckFailure.

バージョン 1.1 で変更: Raise MissingRole or NoPrivateMessage instead of generic CheckFailure

パラメータ

item (Union[int, str]) -- The name or ID of the role to check.

discord.ext.commands.has_permissions(**perms)

A check() that is added that checks if the member has all of the permissions necessary.

Note that this check operates on the current channel permissions, not the guild wide permissions.

The permissions passed in must be exactly like the properties shown under discord.Permissions.

This check raises a special exception, MissingPermissions that is inherited from CheckFailure.

パラメータ

perms -- An argument list of permissions to check for.

サンプル

@bot.command()
@commands.has_permissions(manage_messages=True)
async def test(ctx):
    await ctx.send('You can manage messages.')
discord.ext.commands.has_guild_permissions(**perms)

Similar to has_permissions(), but operates on guild wide permissions instead of the current channel permissions.

If this check is called in a DM context, it will raise an exception, NoPrivateMessage.

バージョン 1.3 で追加.

discord.ext.commands.has_any_role(*items)

A check() that is added that checks if the member invoking the 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.

Similar to has_role(), the names or IDs passed in must be exact.

This check raises one of two special exceptions, MissingAnyRole if the user is missing all roles, or NoPrivateMessage if it is used in a private message. Both inherit from CheckFailure.

バージョン 1.1 で変更: Raise MissingAnyRole or NoPrivateMessage instead of generic CheckFailure

パラメータ

items (List[Union[str, int]]) -- An argument list of names or IDs to check that the member has roles wise.

サンプル

@bot.command()
@commands.has_any_role('Library Devs', 'Moderators', 492212595072434186)
async def cool(ctx):
    await ctx.send('You are cool indeed')
discord.ext.commands.bot_has_role(item)

Similar to has_role() except checks if the bot itself has the role.

This check raises one of two special exceptions, BotMissingRole if the bot is missing the role, or NoPrivateMessage if it is used in a private message. Both inherit from CheckFailure.

バージョン 1.1 で変更: Raise BotMissingRole or NoPrivateMessage instead of generic CheckFailure

discord.ext.commands.bot_has_permissions(**perms)

Similar to has_permissions() except checks if the bot itself has the permissions listed.

This check raises a special exception, BotMissingPermissions that is inherited from CheckFailure.

discord.ext.commands.bot_has_guild_permissions(**perms)

Similar to has_guild_permissions(), but checks the bot members guild permissions.

バージョン 1.3 で追加.

discord.ext.commands.bot_has_any_role(*items)

Similar to has_any_role() except checks if the bot itself has any of the roles listed.

This check raises one of two special exceptions, BotMissingAnyRole if the bot is missing all roles, or NoPrivateMessage if it is used in a private message. Both inherit from CheckFailure.

バージョン 1.1 で変更: Raise BotMissingAnyRole or NoPrivateMessage instead of generic checkfailure

discord.ext.commands.cooldown(rate, per, type=<BucketType.default: 0>)

A decorator that adds a cooldown to a Command

A cooldown allows a command to only be used a specific amount of times in a specific time frame. These cooldowns can be based either on a per-guild, per-channel, per-user, per-role or global basis. Denoted by the third argument of type which must be of enum type BucketType.

If a cooldown is triggered, then CommandOnCooldown is triggered in on_command_error() and the local error handler.

A command can only have a single cooldown.

パラメータ
  • rate (int) -- The number of times a command can be used before triggering a cooldown.

  • per (float) -- The amount of seconds to wait for a cooldown when it's been triggered.

  • type (Union[BucketType, Callable[[Message], Any]]) --

    The type of cooldown to have. If callable, should return a key for the mapping.

    バージョン 1.7 で変更: Callables are now supported for custom bucket types.

discord.ext.commands.max_concurrency(number, per=<BucketType.default: 0>, *, wait=False)

A decorator that adds a maximum concurrency to a Command or its subclasses.

This enables you to only allow a certain number of command invocations at the same time, for example if a command takes too long or if only one user can use it at a time. This differs from a cooldown in that there is no set waiting period or token bucket -- only a set number of people can run the command.

バージョン 1.3 で追加.

パラメータ
  • number (int) -- The maximum number of invocations of this command that can be running at the same time.

  • per (BucketType) -- The bucket that this concurrency is based on, e.g. BucketType.guild would allow it to be used up to number times per guild.

  • wait (bool) -- Whether the command should wait for the queue to be over. If this is set to False then instead of waiting until the command can run again, the command raises MaxConcurrencyReached to its error handler. If this is set to True then the command waits until it can be executed.

discord.ext.commands.before_invoke(coro)

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

This allows you to refer to one before invoke hook for several commands that do not have to be within the same cog.

バージョン 1.4 で追加.

サンプル

async def record_usage(ctx):
    print(ctx.author, 'used', ctx.command, 'at', ctx.message.created_at)

@bot.command()
@commands.before_invoke(record_usage)
async def who(ctx): # Output: <User> used who at <Time>
    await ctx.send('i am a bot')

class What(commands.Cog):

    @commands.before_invoke(record_usage)
    @commands.command()
    async def when(self, ctx): # Output: <User> used when at <Time>
        await ctx.send(f'and i have existed since {ctx.bot.user.created_at}')

    @commands.command()
    async def where(self, ctx): # Output: <Nothing>
        await ctx.send('on Discord')

    @commands.command()
    async def why(self, ctx): # Output: <Nothing>
        await ctx.send('because someone made me')

bot.add_cog(What())
discord.ext.commands.after_invoke(coro)

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

This allows you to refer to one after invoke hook for several commands that do not have to be within the same cog.

バージョン 1.4 で追加.

discord.ext.commands.guild_only()

A check() that indicates this command must only be used in a guild context only. Basically, no private messages are allowed when using the command.

This check raises a special exception, NoPrivateMessage that is inherited from CheckFailure.

discord.ext.commands.dm_only()

A check() that indicates this command must only be used in a DM context. Only private messages are allowed when using the command.

This check raises a special exception, PrivateMessageOnly that is inherited from CheckFailure.

バージョン 1.1 で追加.

discord.ext.commands.is_owner()

A check() that checks if the person invoking this command is the owner of the bot.

This is powered by Bot.is_owner().

This check raises a special exception, NotOwner that is derived from CheckFailure.

discord.ext.commands.is_nsfw()

A check() that checks if the channel is a NSFW channel.

This check raises a special exception, NSFWChannelRequired that is derived from CheckFailure.

バージョン 1.1 で変更: Raise NSFWChannelRequired instead of generic CheckFailure. DM channels will also now pass this check.

Context

class discord.ext.commands.Context(**attrs)

Represents the context in which a command is being invoked under.

This class contains a lot of meta data to help you understand more about the invocation context. This class is not created manually and is instead passed around to commands as the first parameter.

This class implements the Messageable ABC.

message

The message that triggered the command being executed.

Type

Message

bot

The bot that contains the command being executed.

Type

Bot

args

The list of transformed arguments that were passed into the command. If this is accessed during the on_command_error() event then this list could be incomplete.

Type

list

kwargs

A dictionary of transformed arguments that were passed into the command. Similar to args, if this is accessed in the on_command_error() event then this dict could be incomplete.

Type

dict

prefix

The prefix that was used to invoke the command.

Type

str

command

The command that is being invoked currently.

Type

Command

invoked_with

The command name that triggered this invocation. Useful for finding out which alias called the command.

Type

str

invoked_parents

The command names of the parents that triggered this invocation. Useful for finding out which aliases called the command.

For example in commands ?a b c test, the invoked parents are ['a', 'b', 'c'].

バージョン 1.7 で追加.

Type

List[str]

invoked_subcommand

The subcommand that was invoked. If no valid subcommand was invoked then this is equal to None.

Type

Command

subcommand_passed

The string that was attempted to call a subcommand. This does not have to point to a valid registered subcommand and could just point to a nonsense string. If nothing was passed to attempt a call to a subcommand then this is set to None.

Type

Optional[str]

command_failed

A boolean that indicates if the command failed to be parsed, checked, or invoked.

Type

bool

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination's message history.

You must have read_message_history permissions to use this.

サンプル

使い方

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

すべてのパラメータがオプションです。

パラメータ
  • limit (Optional[int]) -- The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

  • before (Optional[Union[Snowflake, datetime.datetime]]) -- Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

  • after (Optional[Union[Snowflake, datetime.datetime]]) -- Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

  • around (Optional[Union[Snowflake, datetime.datetime]]) -- Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

  • oldest_first (Optional[bool]) -- If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

例外
  • Forbidden -- You do not have permissions to get channel message history.

  • HTTPException -- The request to get message history failed.

列挙

Message -- The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

注釈

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # do expensive stuff here
    await channel.send('done!')
await invoke(command, /, *args, **kwargs)

This function is a coroutine.

Calls a command with the arguments given.

This is useful if you want to just call the callback that a Command holds internally.

注釈

This does not handle converters, checks, cooldowns, pre-invoke, or after-invoke hooks in any matter. It calls the internal callback directly as-if it was a regular function.

You must take care in passing the proper arguments when using this function.

パラメータ
  • command (Command) -- The command that is going to be called.

  • *args -- The arguments to to use.

  • **kwargs -- The keyword arguments to use.

例外

TypeError -- The command argument to invoke is missing.

await reinvoke(*, call_hooks=False, restart=True)

This function is a coroutine.

Calls the command again.

This is similar to invoke() except that it bypasses checks, cooldowns, and error handlers.

注釈

If you want to bypass UserInputError derived exceptions, it is recommended to use the regular invoke() as it will work more naturally. After all, this will end up using the old arguments the user has used and will thus just fail again.

パラメータ
  • call_hooks (bool) -- Whether to call the before and after invoke hooks.

  • restart (bool) -- Whether to start the call chain from the very beginning or where we left off (i.e. the command that caused the error). The default is to start where we left off.

例外

ValueError -- The context to reinvoke is not valid.

valid

Checks if the invocation context is valid to be invoked with.

Type

bool

clean_prefix

「クリーンアップ」されたプレフィックスを返します。たとえば、メンションは <@id> のかわりに @name となります。

バージョン 2.0 で追加.

Type

str

cog

Returns the cog associated with this context's command. None if it does not exist.

Type

Optional[Cog]

guild

Returns the guild associated with this context's command. None if not available.

Type

Optional[Guild]

channel

Returns the channel associated with this context's command. Shorthand for Message.channel.

Type

Union[abc.Messageable]

author

Union[User, Member]: Returns the author associated with this context's command. Shorthand for Message.author

me

Union[Member, ClientUser]: Similar to Guild.me except it may return the ClientUser in private message contexts.

voice_client

A shortcut to Guild.voice_client, if applicable.

Type

Optional[VoiceProtocol]

await send_help(entity=<bot>)

This function is a coroutine.

Shows the help command for the specified entity if given. The entity can be a command or a cog.

If no entity is given, then it'll show help for the entire bot.

If the entity is a string, then it looks up whether it's a Cog or a Command.

注釈

Due to the way this function works, instead of returning something similar to command_not_found() this returns None on bad input or no help command.

パラメータ

entity (Optional[Union[Command, Cog, str]]) -- The entity to show help for.

戻り値

The result of the help command, if any.

戻り値の型

Any

await reply(content=None, **kwargs)

This function is a coroutine.

A shortcut method to abc.Messageable.send() to reply to the Message.

バージョン 1.6 で追加.

例外
  • HTTPException -- Sending the message failed.

  • Forbidden -- You do not have the proper permissions to send the message.

  • InvalidArgument -- The files list is not of the appropriate size or you specified both file and files.

戻り値

The message that was sent.

戻り値の型

Message

await fetch_message(id)

This function is a coroutine.

Retrieves a single Message from the destination.

This can only be used by bot accounts.

パラメータ

id (int) -- The message ID to look for.

例外
  • NotFound -- The specified message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

戻り値

The message asked for.

戻り値の型

Message

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

注釈

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

例外

HTTPException -- Retrieving the pinned messages failed.

戻り値

The messages that are currently pinned.

戻り値の型

List[Message]

await send(content=None, *, tts=False, embed=None, file=None, files=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content). If the content is set to None (the default), then the embed parameter must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

If the embed parameter is provided, it must be of type Embed and it must be a rich embed type.

パラメータ
  • content (str) -- The content of the message to send.

  • tts (bool) -- Indicates if the message should be sent using text-to-speech.

  • embed (Embed) -- The rich embed for the content.

  • file (File) -- The file to upload.

  • files (List[File]) -- A list of files to upload. Must be a maximum of 10.

  • nonce (int) -- The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

  • delete_after (float) -- If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  • allowed_mentions (AllowedMentions) --

    Controls the mentions being processed in this message. If this is passed, then the object is merged with allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

    バージョン 1.4 で追加.

  • reference (Union[Message, MessageReference]) --

    A reference to the Message to which you are replying, this can be created using to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the replied_user attribute of allowed_mentions or by setting mention_author.

    バージョン 1.6 で追加.

  • mention_author (Optional[bool]) --

    If set, overrides the replied_user attribute of allowed_mentions.

    バージョン 1.6 で追加.

例外
戻り値

The message that was sent.

戻り値の型

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

Converters

class discord.ext.commands.Converter(*args, **kwargs)

The base class of custom converters that require the Context to be passed to be useful.

This allows you to implement converters that function similar to the special cased discord classes.

Classes that derive from this should override the convert() method to do its conversion logic. This method must be a coroutine.

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.ObjectConverter(*args, **kwargs)

Converts to a Object.

The argument must follow the valid ID or mention formats (e.g. <@80088516616269824>).

バージョン 2.0 で追加.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by member, role, or channel mention.

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.MemberConverter(*args, **kwargs)

Converts to a Member.

All lookups are via the local guild. If in a DM context, then the lookup is done by the global cache.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by mention.

  3. Lookup by name#discrim

  4. Lookup by name

  5. Lookup by nickname

バージョン 1.5 で変更: Raise MemberNotFound instead of generic BadArgument

バージョン 1.5.1 で変更: This converter now lazily fetches members from the gateway and HTTP APIs, optionally caching the result if MemberCacheFlags.joined is enabled.

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.UserConverter(*args, **kwargs)

Converts to a User.

All lookups are via the global user cache.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by mention.

  3. Lookup by name#discrim

  4. Lookup by name

バージョン 1.5 で変更: Raise UserNotFound instead of generic BadArgument

バージョン 1.6 で変更: This converter now lazily fetches users from the HTTP APIs if an ID is passed and it's not available in cache.

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.MessageConverter(*args, **kwargs)

Converts to a discord.Message.

バージョン 1.1 で追加.

The lookup strategy is as follows (in order):

  1. Lookup by "{channel ID}-{message ID}" (retrieved by shift-clicking on "Copy ID")

  2. Lookup by message ID (the message must be in the context channel)

  3. Lookup by message URL

バージョン 1.5 で変更: Raise ChannelNotFound, MessageNotFound or ChannelNotReadable instead of generic BadArgument

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.PartialMessageConverter(*args, **kwargs)

Converts to a discord.PartialMessage.

バージョン 1.7 で追加.

The creation strategy is as follows (in order):

  1. By "{channel ID}-{message ID}" (retrieved by shift-clicking on "Copy ID")

  2. By message ID (The message is assumed to be in the context channel.)

  3. By message URL

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.TextChannelConverter(*args, **kwargs)

Converts to a TextChannel.

All lookups are via the local guild. If in a DM context, then the lookup is done by the global cache.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by mention.

  3. Lookup by name

バージョン 1.5 で変更: Raise ChannelNotFound instead of generic BadArgument

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.VoiceChannelConverter(*args, **kwargs)

Converts to a VoiceChannel.

All lookups are via the local guild. If in a DM context, then the lookup is done by the global cache.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by mention.

  3. Lookup by name

バージョン 1.5 で変更: Raise ChannelNotFound instead of generic BadArgument

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.StoreChannelConverter(*args, **kwargs)

Converts to a StoreChannel.

All lookups are via the local guild. If in a DM context, then the lookup is done by the global cache.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by mention.

  3. Lookup by name.

バージョン 1.7 で追加.

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.StageChannelConverter(*args, **kwargs)

Converts to a StageChannel.

バージョン 1.7 で追加.

All lookups are via the local guild. If in a DM context, then the lookup is done by the global cache.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by mention.

  3. Lookup by name

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.CategoryChannelConverter(*args, **kwargs)

Converts to a CategoryChannel.

All lookups are via the local guild. If in a DM context, then the lookup is done by the global cache.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by mention.

  3. Lookup by name

バージョン 1.5 で変更: Raise ChannelNotFound instead of generic BadArgument

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.InviteConverter(*args, **kwargs)

Converts to a Invite.

This is done via an HTTP request using Bot.fetch_invite().

バージョン 1.5 で変更: Raise BadInviteArgument instead of generic BadArgument

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.GuildConverter(*args, **kwargs)

Converts to a Guild.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by name. (There is no disambiguation for Guilds with multiple matching names).

バージョン 1.7 で追加.

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.RoleConverter(*args, **kwargs)

Converts to a Role.

All lookups are via the local guild. If in a DM context, then the lookup is done by the global cache.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by mention.

  3. Lookup by name

バージョン 1.5 で変更: Raise RoleNotFound instead of generic BadArgument

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.GameConverter(*args, **kwargs)

Converts to Game.

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.ColourConverter(*args, **kwargs)

Converts to a Colour.

バージョン 1.5 で変更: Add an alias named ColorConverter

The following formats are accepted:

  • 0x<hex>

  • #<hex>

  • 0x#<hex>

  • rgb(<number>, <number>, <number>)

  • Any of the classmethod in Colour

    • The _ in the name can be optionally replaced with spaces.

Like CSS, <number> can be either 0-255 or 0-100% and <hex> can be either a 6 digit hex number or a 3 digit hex shortcut (e.g. #fff).

バージョン 1.5 で変更: Raise BadColourArgument instead of generic BadArgument

バージョン 1.7 で変更: Added support for rgb function and 3-digit hex shortcuts

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.EmojiConverter(*args, **kwargs)

Converts to a Emoji.

All lookups are done for the local guild first, if available. If that lookup fails, then it checks the client's global cache.

The lookup strategy is as follows (in order):

  1. Lookup by ID.

  2. Lookup by extracting ID from the emoji.

  3. Lookup by name

バージョン 1.5 で変更: Raise EmojiNotFound instead of generic BadArgument

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.PartialEmojiConverter(*args, **kwargs)

Converts to a PartialEmoji.

This is done by extracting the animated flag, name and ID from the emoji.

バージョン 1.5 で変更: Raise PartialEmojiConversionFailure instead of generic BadArgument

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.clean_content(*, fix_channel_mentions=False, use_nicknames=True, escape_markdown=False, remove_markdown=False)

Converts the argument to mention scrubbed version of said content.

This behaves similarly to clean_content.

fix_channel_mentions

Whether to clean channel mentions.

Type

bool

use_nicknames

Whether to use nicknames when transforming mentions.

Type

bool

escape_markdown

Whether to also escape special markdown characters.

Type

bool

remove_markdown

Whether to also remove special markdown characters. This option is not supported with escape_markdown

バージョン 1.7 で追加.

Type

bool

await convert(ctx, argument)

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.

パラメータ
  • ctx (Context) -- The invocation context that the argument is being used in.

  • argument (str) -- The argument that is being converted.

例外
  • CommandError -- A generic exception occurred when converting the argument.

  • BadArgument -- The converter failed to convert the argument.

class discord.ext.commands.Greedy

A special converter that greedily consumes arguments until it can't. As a consequence of this behaviour, most input errors are silently discarded, since it is used as an indicator of when to stop parsing.

When a parser error is met the greedy converter stops converting, undoes the internal string parsing routine, and continues parsing regularly.

For example, in the following code:

@commands.command()
async def test(ctx, numbers: Greedy[int], reason: str):
    await ctx.send("numbers: {}, reason: {}".format(numbers, reason))

An invocation of [p]test 1 2 3 4 5 6 hello would pass numbers with [1, 2, 3, 4, 5, 6] and reason with hello.

For more information, check 特殊なコンバーター.

Exceptions

exception discord.ext.commands.CommandError(message=None, *args)

コマンドに関連するエラーすべての基礎となる例外。

これは 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 Bot, on_command_error().

exception discord.ext.commands.ConversionError(converter, original)

Converter クラスで、CommandErrorではない例外が発生した際に、発生する例外。

This inherits from CommandError.

converter

The converter that failed.

Type

discord.ext.commands.Converter

original

Converter内で発生した元の例外。 __cause__ からも取得できます。

Type

Exception

exception discord.ext.commands.MissingRequiredArgument(param)

コマンドのパラメータ解析の際、要求されたパラメータに値が渡されていない場合に発生します。

This inherits from UserInputError

param

The argument that is missing.

Type

inspect.Parameter

exception discord.ext.commands.ArgumentParsingError(message=None, *args)

An exception raised when the parser fails to parse a user's input.

This inherits from UserInputError.

There are child classes that implement more granular parsing errors for i18n purposes.

exception discord.ext.commands.UnexpectedQuoteError(quote)

An exception raised when the parser encounters a quote mark inside a non-quoted string.

This inherits from ArgumentParsingError.

quote

The quote mark that was found inside the non-quoted string.

Type

str

exception discord.ext.commands.InvalidEndOfQuotedStringError(char)

An exception raised when a space is expected after the closing quote in a string but a different character is found.

This inherits from ArgumentParsingError.

char

The character found instead of the expected string.

Type

str

exception discord.ext.commands.ExpectedClosingQuoteError(close_quote)

An exception raised when a quote character is expected but not found.

This inherits from ArgumentParsingError.

close_quote

The quote character expected.

Type

str

exception discord.ext.commands.BadArgument(message=None, *args)

コマンドの引数に渡された値の解析、または変換に失敗した場合に発生する例外。

This inherits from UserInputError

exception discord.ext.commands.BadUnionArgument(param, converters, errors)

Exception raised when a typing.Union converter fails for all its associated types.

This inherits from UserInputError

param

The parameter that failed being converted.

Type

inspect.Parameter

converters

A tuple of converters attempted in conversion, in order of failure.

Type

Tuple[Type, ..]

errors

A list of errors that were caught from failing the conversion.

Type

List[CommandError]

exception discord.ext.commands.PrivateMessageOnly(message=None)

Exception raised when an operation does not work outside of private message contexts.

This inherits from CheckFailure

exception discord.ext.commands.NoPrivateMessage(message=None)

プライベートメッセージコンテキストで、要求された処理が実行できない場合に発生する例外。

This inherits from CheckFailure

exception discord.ext.commands.CheckFailure(message=None, *args)

Exception raised when the predicates in Command.checks have failed.

This inherits from CommandError

exception discord.ext.commands.CheckAnyFailure(checks, errors)

Exception raised when all predicates in check_any() fail.

This inherits from CheckFailure.

バージョン 1.3 で追加.

errors

A list of errors that were caught during execution.

Type

List[CheckFailure]

checks

A list of check predicates that failed.

Type

List[Callable[[Context], bool]]

exception discord.ext.commands.CommandNotFound(message=None, *args)

コマンドを呼び出す際に、指定された名前を持つコマンドが存在していなかった場合に発生する例外。

This is not raised for invalid subcommands, rather just the initial main command that is attempted to be invoked.

This inherits from CommandError.

exception discord.ext.commands.DisabledCommand(message=None, *args)

呼び出そうとしたコマンドが無効化されていた際に発生する例外。

This inherits from CommandError

exception discord.ext.commands.CommandInvokeError(e)

Exception raised when the command being invoked raised an exception.

This inherits from CommandError

original

Converter内で発生した元の例外。 __cause__ からも取得できます。

Type

Exception

exception discord.ext.commands.TooManyArguments(message=None, *args)

Exception raised when the command was passed too many arguments and its Command.ignore_extra attribute was not set to True.

This inherits from UserInputError

exception discord.ext.commands.UserInputError(message=None, *args)

The base exception type for errors that involve errors regarding user input.

This inherits from CommandError.

exception discord.ext.commands.CommandOnCooldown(cooldown, retry_after)

Exception raised when the command being invoked is on cooldown.

This inherits from CommandError

cooldown

A class with attributes rate, per, and type similar to the cooldown() decorator.

Type

Cooldown

retry_after

The amount of seconds to wait before you can retry again.

Type

float

exception discord.ext.commands.MaxConcurrencyReached(number, per)

Exception raised when the command being invoked has reached its maximum concurrency.

This inherits from CommandError.

number

The maximum number of concurrent invokers allowed.

Type

int

per

The bucket type passed to the max_concurrency() decorator.

Type

BucketType

exception discord.ext.commands.NotOwner(message=None, *args)

Exception raised when the message author is not the owner of the bot.

This inherits from CheckFailure

exception discord.ext.commands.MessageNotFound(argument)

Exception raised when the message provided was not found in the channel.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The message supplied by the caller that was not found

Type

str

exception discord.ext.commands.MemberNotFound(argument)

Exception raised when the member provided was not found in the bot's cache.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The member supplied by the caller that was not found

Type

str

exception discord.ext.commands.GuildNotFound(argument)

Exception raised when the guild provided was not found in the bot's cache.

This inherits from BadArgument

バージョン 1.7 で追加.

argument

The guild supplied by the called that was not found

Type

str

exception discord.ext.commands.UserNotFound(argument)

Exception raised when the user provided was not found in the bot's cache.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The user supplied by the caller that was not found

Type

str

exception discord.ext.commands.ChannelNotFound(argument)

Exception raised when the bot can not find the channel.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The channel supplied by the caller that was not found

Type

str

exception discord.ext.commands.ChannelNotReadable(argument)

Exception raised when the bot does not have permission to read messages in the channel.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The channel supplied by the caller that was not readable

Type

abc.GuildChannel

exception discord.ext.commands.BadColourArgument(argument)

Exception raised when the colour is not valid.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The colour supplied by the caller that was not valid

Type

str

exception discord.ext.commands.RoleNotFound(argument)

Exception raised when the bot can not find the role.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The role supplied by the caller that was not found

Type

str

exception discord.ext.commands.BadInviteArgument

Exception raised when the invite is invalid or expired.

This inherits from BadArgument

バージョン 1.5 で追加.

exception discord.ext.commands.EmojiNotFound(argument)

Exception raised when the bot can not find the emoji.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The emoji supplied by the caller that was not found

Type

str

exception discord.ext.commands.PartialEmojiConversionFailure(argument)

Exception raised when the emoji provided does not match the correct format.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The emoji supplied by the caller that did not match the regex

Type

str

exception discord.ext.commands.BadBoolArgument(argument)

Exception raised when a boolean argument was not convertable.

This inherits from BadArgument

バージョン 1.5 で追加.

argument

The boolean argument supplied by the caller that is not in the predefined list

Type

str

exception discord.ext.commands.MissingPermissions(missing_perms, *args)

Exception raised when the command invoker lacks permissions to run a command.

This inherits from CheckFailure

missing_perms

The required permissions that are missing.

Type

list

exception discord.ext.commands.BotMissingPermissions(missing_perms, *args)

Exception raised when the bot's member lacks permissions to run a command.

This inherits from CheckFailure

missing_perms

The required permissions that are missing.

Type

list

exception discord.ext.commands.MissingRole(missing_role)

Exception raised when the command invoker lacks a role to run a command.

This inherits from CheckFailure

バージョン 1.1 で追加.

missing_role

The required role that is missing. This is the parameter passed to has_role().

Type

Union[str, int]

exception discord.ext.commands.BotMissingRole(missing_role)

Exception raised when the bot's member lacks a role to run a command.

This inherits from CheckFailure

バージョン 1.1 で追加.

missing_role

The required role that is missing. This is the parameter passed to has_role().

Type

Union[str, int]

exception discord.ext.commands.MissingAnyRole(missing_roles)

Exception raised when the command invoker lacks any of the roles specified to run a command.

This inherits from CheckFailure

バージョン 1.1 で追加.

missing_roles

The roles that the invoker is missing. These are the parameters passed to has_any_role().

Type

List[Union[str, int]]

exception discord.ext.commands.BotMissingAnyRole(missing_roles)

Exception raised when the bot's member lacks any of the roles specified to run a command.

This inherits from CheckFailure

バージョン 1.1 で追加.

missing_roles

The roles that the bot's member is missing. These are the parameters passed to has_any_role().

Type

List[Union[str, int]]

exception discord.ext.commands.NSFWChannelRequired(channel)

Exception raised when a channel does not have the required NSFW setting.

This inherits from CheckFailure.

バージョン 1.1 で追加.

パラメータ

channel (discord.abc.GuildChannel) -- The channel that does not have NSFW enabled.

exception discord.ext.commands.ExtensionError(message=None, *args, name)

Base exception for extension related errors.

This inherits from DiscordException.

name

The extension that had an error.

Type

str

exception discord.ext.commands.ExtensionAlreadyLoaded(name)

An exception raised when an extension has already been loaded.

This inherits from ExtensionError

exception discord.ext.commands.ExtensionNotLoaded(name)

An exception raised when an extension was not loaded.

This inherits from ExtensionError

exception discord.ext.commands.NoEntryPointError(name)

An exception raised when an extension does not have a setup entry point function.

This inherits from ExtensionError

exception discord.ext.commands.ExtensionFailed(name, original)

An exception raised when an extension failed to load during execution of the module or setup entry point.

This inherits from ExtensionError

name

The extension that had the error.

Type

str

original

Converter内で発生した元の例外。 __cause__ からも取得できます。

Type

Exception

exception discord.ext.commands.ExtensionNotFound(name)

An exception raised when an extension is not found.

This inherits from ExtensionError

バージョン 1.3 で変更: Made the original attribute always None.

name

The extension that had the error.

Type

str

exception discord.ext.commands.CommandRegistrationError(name, *, alias_conflict=False)

An exception raised when the command can't be added because the name is already taken by a different command.

This inherits from discord.ClientException

バージョン 1.4 で追加.

name

The command name that had the error.

Type

str

alias_conflict

Whether the name that conflicts is an alias of the command we try to add.

Type

bool

Exception Hierarchy