Exceptions

Exception Hierarchy

• Exception

  • DiscordException

    • ClientException

      • InvalidData

      • InvalidArgument

      • LoginFailure

      • ConnectionClosed

      • PrivilegedIntentsRequired

      • InteractionResponded

    • NoMoreItems

    • GatewayNotFound

    • HTTPException

      • Forbidden

      • NotFound

      • DiscordServerError

    • ApplicationCommandError

      • CheckFailure

      • ApplicationCommandInvokeError

    • ExtensionError

      • ExtensionAlreadyLoaded

      • ExtensionNotLoaded

      • NoEntryPointError

      • ExtensionFailed

      • ExtensionNotFound

    • sinks.SinkException

      • sinks.RecordingException

      • sinks.WaveSinkError

      • sinks.MP3SinkError

      • sinks.MP4SinkError

      • sinks.M4ASinkError

      • sinks.MKVSinkError

      • sinks.MKASinkError

      • sinks.OGGSinkError

    • MissingVoiceDependenciesError

Objects

The following exceptions are thrown by the library.

exception discord.DiscordException

Base exception class for pycord

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

exception discord.ClientException

Exception that’s raised when an operation in the Client fails.

These are usually for exceptions that happened due to user input.

exception discord.LoginFailure

Exception that’s raised when the Client.login() function fails to log you in from improper credentials or some other misc. failure.

exception discord.NoMoreItems

Exception that is raised when an async iteration operation has no more items.

exception discord.HTTPException(response, message)

Exception that’s raised when an HTTP request operation fails.

response

The response of the failed HTTP request. This is an instance of aiohttp.ClientResponse. In some cases this could also be a requests.Response.

Type:

aiohttp.ClientResponse

text

The text of the error. Could be an empty string.

Type:

str

status

The status code of the HTTP request.

Type:

int

code

The Discord specific error code for the failure.

Type:

int

Parâmetros:

• response (ClientResponse | Response)

• message (str | dict[str, Any] | None)

exception discord.Forbidden(response, message)

Exception that’s raised for when status code 403 occurs.

Subclass of HTTPException

Parâmetros:

• response (ClientResponse | Response)

• message (str | dict[str, Any] | None)

exception discord.NotFound(response, message)

Exception that’s raised for when status code 404 occurs.

Subclass of HTTPException

Parâmetros:

• response (ClientResponse | Response)

• message (str | dict[str, Any] | None)

exception discord.DiscordServerError(response, message)

Exception that’s raised for when a 500 range status code occurs.

Subclass of HTTPException.

Adicionado na versão 1.5.

Parâmetros:

• response (ClientResponse | Response)

• message (str | dict[str, Any] | None)

exception discord.InvalidData

Exception that’s raised when the library encounters unknown or invalid data from Discord.

exception discord.InvalidArgument

Exception that’s raised when an argument to a function is invalid some way (e.g. wrong value or wrong type).

This could be considered the parallel of ValueError and TypeError except inherited from ClientException and thus DiscordException.

exception discord.GatewayNotFound

An exception that is raised when the gateway for Discord could not be found

exception discord.ConnectionClosed(socket, *, shard_id, code=None)

Exception that’s raised when the gateway connection is closed for reasons that could not be handled internally.

code

The close code of the websocket.

Type:

int

reason

The reason provided for the closure.

Type:

str

shard_id

The shard ID that got closed if applicable.

Type:

Optional[int]

Parâmetros:

• socket (ClientWebSocketResponse)

• shard_id (int | None)

• code (int | None)

exception discord.PrivilegedIntentsRequired(shard_id)

Exception that’s raised when the gateway is requesting privileged intents, but they’re not ticked in the developer page yet.

Go to https://discord.com/developers/applications/ and enable the intents that are required. Currently, these are as follows:

• Intents.members

• Intents.presences

• Intents.message_content

shard_id

The shard ID that got closed if applicable.

Type:

Optional[int]

Parâmetros:

shard_id (int | None)

exception discord.InteractionResponded(interaction)

Exception that’s raised when sending another interaction response using InteractionResponse when one has already been done before.

An interaction can only respond once.

Adicionado na versão 2.0.

interaction

The interaction that’s already been responded to.

Type:

Interaction

Parâmetros:

interaction (Interaction)

exception discord.opus.OpusError(code=0, message=None)

An exception that is thrown for libopus related errors.

code

The error code returned.

Type:

int

Parâmetros:

• code (int)

• message (str | None)

exception discord.opus.OpusNotLoaded

An exception that is thrown for when libopus is not loaded.

exception discord.ApplicationCommandError

The base exception type for all application command related errors.

This inherits from 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.CheckFailure

Exception raised when the predicates in Command.checks have failed.

This inherits from ApplicationCommandError

exception discord.ApplicationCommandInvokeError(e)

Exception raised when the command being invoked raised an exception.

This inherits from ApplicationCommandError

original

The original exception that was raised. You can also get this via the __cause__ attribute.

Type:

Exception

Parâmetros:

e (Exception)

exception discord.ExtensionError(message=None, *args, name)

Base exception for extension related errors.

This inherits from DiscordException.

name

The extension that had an error.

Type:

str

Parâmetros:

• message (str | None)

• args (Any)

• name (str)

exception discord.ExtensionAlreadyLoaded(name)

An exception raised when an extension has already been loaded.

This inherits from ExtensionError

Parâmetros:

name (str)

exception discord.ExtensionNotLoaded(name)

An exception raised when an extension was not loaded.

This inherits from ExtensionError

Parâmetros:

name (str)

exception discord.NoEntryPointError(name)

An exception raised when an extension does not have a setup entry point function.

This inherits from ExtensionError

Parâmetros:

name (str)

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

The original exception that was raised. You can also get this via the __cause__ attribute.

Type:

Exception

Parâmetros:

• name (str)

• original (Exception)

exception discord.ExtensionNotFound(name)

An exception raised when an extension is not found.

This inherits from ExtensionError

Alterado na versão 1.3: Made the original attribute always None.

name

The extension that had the error.

Type:

str

Parâmetros:

name (str)

exception discord.sinks.SinkException

Raised when a Sink error occurs.

Adicionado na versão 2.0.

exception discord.sinks.RecordingException

Exception that’s thrown when there is an error while trying to record audio from a voice channel.

Adicionado na versão 2.0.

exception discord.sinks.WaveSinkError

Exception thrown when an exception occurs with WaveSink

Adicionado na versão 2.0.

exception discord.sinks.MP3SinkError

Exception thrown when an exception occurs with MP3Sink

Adicionado na versão 2.0.

exception discord.sinks.MP4SinkError

Exception thrown when an exception occurs with MP4Sink

Adicionado na versão 2.0.

exception discord.sinks.M4ASinkError

Exception thrown when an exception occurs with M4ASink

Adicionado na versão 2.0.

exception discord.sinks.MKVSinkError

Exception thrown when an exception occurs with MKVSink

Adicionado na versão 2.0.

exception discord.sinks.MKASinkError

Exception thrown when an exception occurs with MKASink

Adicionado na versão 2.0.

exception discord.sinks.OGGSinkError

Exception thrown when an exception occurs with OGGSink

Adicionado na versão 2.0.

exception discord.MissingVoiceDependenciesError(missing)

Raised when required voice dependencies are not installed.

Nota

This exception inherits from both RuntimeError and DiscordException.

missing

tuple[str, …] The missing dependencies that are required for voice support.

Parâmetros:

missing (tuple[str, ...])