Timeout error discord py

Client¶

class discord.Client(*, intents, **options)¶

Represents a client connection that connects to Discord.
This class is used to interact with the Discord WebSocket and API.

async with x

Asynchronously initialises the client and automatically cleans up.

New in version 2.0.

A number of options can be passed to the Client.

Parameters

• max_messages (Optional[int]) –

  The maximum number of messages to store in the internal message cache.
  This defaults to 1000. Passing in None disables the message cache.

  Changed in version 1.3: Allow disabling the message cache and change the default size to 1000.

• proxy (Optional[str]) – Proxy URL.

• proxy_auth (Optional[aiohttp.BasicAuth]) – An object that represents proxy HTTP Basic Authorization.

• shard_id (Optional[int]) – Integer starting at 0 and less than shard_count.

• shard_count (Optional[int]) – The total number of shards.

• application_id (int) – The client’s application ID.

• intents (Intents) –

  The intents that you want to enable for the session. This is a way of
  disabling and enabling certain gateway events from triggering and being sent.

  New in version 1.5.

  Changed in version 2.0: Parameter is now required.

• member_cache_flags (MemberCacheFlags) –

  Allows for finer control over how the library caches members.
  If not given, defaults to cache as much as possible with the
  currently selected intents.

  New in version 1.5.

• chunk_guilds_at_startup (bool) –

  Indicates if on_ready() should be delayed to chunk all guilds
  at start-up if necessary. This operation is incredibly slow for large
  amounts of guilds. The default is True if Intents.members
  is True.

  New in version 1.5.

• status (Optional[Status]) – A status to start your presence with upon logging on to Discord.

• activity (Optional[BaseActivity]) – An activity to start your presence with upon logging on to Discord.

• allowed_mentions (Optional[AllowedMentions]) –

  Control how the client handles mentions by default on every message sent.

  New in version 1.4.

• heartbeat_timeout (float) – The maximum numbers of seconds before timing out and restarting the
  WebSocket in the case of not receiving a HEARTBEAT_ACK. Useful if
  processing the initial packets take too long to the point of disconnecting
  you. The default timeout is 60 seconds.

• guild_ready_timeout (float) –

  The maximum number of seconds to wait for the GUILD_CREATE stream to end before
  preparing the member cache and firing READY. The default timeout is 2 seconds.

  New in version 1.4.

• assume_unsync_clock (bool) –

  Whether to assume the system clock is unsynced. This applies to the ratelimit handling
  code. If this is set to True, the default, then the library uses the time to reset
  a rate limit bucket given by Discord. If this is False then your system clock is
  used to calculate how long to sleep for. If this is set to False it is recommended to
  sync your system clock to Google’s NTP server.

  New in version 1.3.

• enable_debug_events (bool) –

  Whether to enable events that are useful only for debugging gateway related information.

  Right now this involves on_socket_raw_receive() and on_socket_raw_send(). If
  this is False then those events will not be dispatched (due to performance considerations).
  To enable these events, this must be set to True. Defaults to False.

  New in version 2.0.

• http_trace (aiohttp.TraceConfig) –

  The trace configuration to use for tracking HTTP requests the library does using aiohttp.
  This allows you to check requests the library is using. For more information, check the
  aiohttp documentation.

  New in version 2.0.

• max_ratelimit_timeout (Optional[float]) –

  The maximum number of seconds to wait when a non-global rate limit is encountered.
  If a request requires sleeping for more than the seconds passed in, then
  RateLimited will be raised. By default, there is no timeout limit.
  In order to prevent misuse and unnecessary bans, the minimum value this can be
  set to is 30.0 seconds.

  New in version 2.0.

ws¶

The websocket gateway the client is currently connected to. Could be None.

@event¶

A decorator that registers an event to listen to.

You can find more info about the events on the documentation below.

The events must be a coroutine, if not, TypeError is raised.

Example

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

Changed in version 2.0: coro parameter is now positional-only.

Raises

TypeError – The coroutine passed is not actually a coroutine.

property 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

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.

New in version 1.6.

property user¶

Represents the connected client. None if not logged in.

Type

Optional[ClientUser]

property guilds¶

The guilds that the connected client is a member of.

Type

Sequence[Guild]

property emojis¶

The emojis that the connected client has.

Type

Sequence[Emoji]

property stickers¶

The stickers that the connected client has.

New in version 2.0.

Type

Sequence[GuildSticker]

property cached_messages¶

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

New in version 1.1.

Type

Sequence[Message]

property private_channels¶

The private channels that the connected client is participating on.

Note

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

Type

Sequence[abc.PrivateChannel]

property voice_clients¶

Represents a list of voice connections.

These are usually VoiceClient instances.

Type

List[VoiceProtocol]

property 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 or after a call
to login(). Usually after on_connect()
is called.

New in version 2.0.

Type

Optional[int]

property application_flags¶

The client’s application flags.

New in version 2.0.

Type

ApplicationFlags

property application¶

The client’s application info.

This is retrieved on login() and is not updated
afterwards. This allows populating the application_id without requiring a
gateway connection.

This is None if accessed before login() is called.

See also

The application_info() API call

New in version 2.0.

Type

Optional[AppInfo]

is_ready()¶

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

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

This function is a coroutine.

The default error handler provided by the client.

By default this logs to the library logger however it could be
overridden to have a different implementation.
Check on_error() for more details.

Changed in version 2.0: event_method parameter is now positional-only
and instead of writing to sys.stderr it logs instead.

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.

New in version 1.4.

Parameters

• shard_id (int) – The shard ID that requested being IDENTIFY’d

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

await setup_hook()¶

This function is a coroutine.

A coroutine to be called to setup the bot, by default this is blank.

To perform asynchronous setup after the bot is logged in but before
it has connected to the Websocket, overwrite this coroutine.

This is only called once, in login(), and will be called before
any events are dispatched, making it a better solution than doing such
setup in the on_ready() event.

Warning

Since this is called before the websocket connection is made therefore
anything that waits for the websocket will deadlock, this includes things
like wait_for() and wait_until_ready().

New in version 2.0.

await login(token)¶

This function is a coroutine.

Logs in the client with the specified credentials and
calls the setup_hook().

Parameters

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

Raises

• 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 connect(*, reconnect=True)¶

This function is a coroutine.

Creates a websocket connection and lets the websocket listen
to messages from Discord. This is a loop that runs the entire
event system and miscellaneous aspects of the library. Control
is not resumed until the WebSocket connection is terminated.

Parameters

reconnect (bool) – If we should attempt reconnecting, either due to internet
failure or a specific failure on Discord’s part. Certain
disconnects that lead to bad state will not be handled (such as
invalid sharding payloads or bad tokens).

Raises

• 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 close()¶

This function is a coroutine.

Closes the connection to Discord.

clear()¶

Clears the internal state of the bot.

After this, the bot can be considered “re-opened”, i.e. is_closed()
and is_ready() both return False along with the bot’s internal
cache cleared.

await start(token, *, reconnect=True)¶

This function is a coroutine.

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

Parameters

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

• reconnect (bool) – If we should attempt reconnecting, either due to internet
  failure or a specific failure on Discord’s part. Certain
  disconnects that lead to bad state will not be handled (such as
  invalid sharding payloads or bad tokens).

Raises

TypeError – An unexpected keyword argument was received.

run(token, *, reconnect=True, log_handler=…, log_formatter=…, log_level=…, root_logger=False)¶

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().

This function also sets up the logging library to make it easier
for beginners to know what is going on with the library. For more
advanced users, this can be disabled by passing None to
the log_handler parameter.

Warning

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.

Parameters

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

• reconnect (bool) – If we should attempt reconnecting, either due to internet
  failure or a specific failure on Discord’s part. Certain
  disconnects that lead to bad state will not be handled (such as
  invalid sharding payloads or bad tokens).

• log_handler (Optional[logging.Handler]) –

  The log handler to use for the library’s logger. If this is None
  then the library will not set up anything logging related. Logging
  will still work if None is passed, though it is your responsibility
  to set it up.

  The default log handler if not provided is logging.StreamHandler.

  New in version 2.0.

• log_formatter (logging.Formatter) –

  The formatter to use with the given log handler. If not provided then it
  defaults to a colour based logging formatter (if available).

  New in version 2.0.

• log_level (int) –

  The default log level for the library’s logger. This is only applied if the
  log_handler parameter is not None. Defaults to logging.INFO.

  New in version 2.0.

• root_logger (bool) –

  Whether to set up the root logger rather than the library logger.
  By default, only the library logger ('discord') is set up. If this
  is set to True then the root logger is set up as well.

  Defaults to False.

  New in version 2.0.

is_closed()¶

bool: Indicates if the websocket connection is closed.

property activity¶

The activity being used upon
logging in.

Type

Optional[BaseActivity]

property status¶

Status:
The status being used upon logging on to Discord.

property allowed_mentions¶

The allowed mention configuration.

New in version 1.4.

Type

Optional[AllowedMentions]

property intents¶

The intents configured for this connection.

New in version 1.5.

Type

Intents

property users¶

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

Type

List[User]

get_channel(id, /)¶

Returns a channel or thread with the given ID.

Changed in version 2.0: id parameter is now positional-only.

Parameters

id (int) – The ID to search for.

Returns

The returned channel or None if not found.

Return type

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

get_partial_messageable(id, *, guild_id=None, type=None)¶

Returns a partial messageable with the given channel ID.

This is useful if you have a channel_id but don’t want to do an API call
to send messages to it.

New in version 2.0.

Parameters

• id (int) – The channel ID to create a partial messageable for.

• guild_id (Optional[int]) –

  The optional guild ID to create a partial messageable for.

  This is not required to actually send messages, but it does allow the
  jump_url() and
  guild properties to function properly.

• type (Optional[ChannelType]) – The underlying channel type for the partial messageable.

Returns

The partial messageable

Return type

PartialMessageable

get_stage_instance(id, /)¶

Returns a stage instance with the given stage channel ID.

New in version 2.0.

Parameters

id (int) – The ID to search for.

Returns

The stage instance or None if not found.

Return type

Optional[StageInstance]

get_guild(id, /)¶

Returns a guild with the given ID.

Changed in version 2.0: id parameter is now positional-only.

Parameters

id (int) – The ID to search for.

Returns

The guild or None if not found.

Return type

Optional[Guild]

get_user(id, /)¶

Returns a user with the given ID.

Changed in version 2.0: id parameter is now positional-only.

Parameters

id (int) – The ID to search for.

Returns

The user or None if not found.

Return type

Optional[User]

get_emoji(id, /)¶

Returns an emoji with the given ID.

Changed in version 2.0: id parameter is now positional-only.

Parameters

id (int) – The ID to search for.

Returns

The custom emoji or None if not found.

Return type

Optional[Emoji]

get_sticker(id, /)¶

Returns a guild sticker with the given ID.

New in version 2.0.

Note

To retrieve standard stickers, use fetch_sticker().
or fetch_premium_sticker_packs().

Returns

The sticker or None if not found.

Return type

Optional[GuildSticker]

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

Note

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.

Yields

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

Yields

Member – A member the client can see.

await wait_until_ready()¶

This function is a coroutine.

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

Warning

Calling this inside setup_hook() can lead to a deadlock.

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.

Examples

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('👍')

Changed in version 2.0: event parameter is now positional-only.

Parameters

• 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.

Raises

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

Returns

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

Return type

Any

await change_presence(*, activity=None, status=None)¶

This function is a coroutine.

Changes the client’s presence.

Example

game = discord.Game("with the API")
await client.change_presence(status=discord.Status.idle, activity=game)

Changed in version 2.0: Removed the afk keyword-only parameter.

Changed in version 2.0: This function will now raise TypeError instead of
InvalidArgument.

Parameters

• activity (Optional[BaseActivity]) – The activity being done. None if no currently active activity is done.

• status (Optional[Status]) – Indicates what status to change to. If None, then
  Status.online is used.

Raises

TypeError – If the activity parameter is not the proper type.

async for … in fetch_guilds(*, limit=200, before=None, after=None)¶

Retrieves an asynchronous iterator that enables receiving your guilds.

Note

Using this, you will only receive Guild.owner, Guild.icon,
Guild.id, and Guild.name per Guild.

Note

This method is an API call. For general usage, consider guilds instead.

Examples

Usage

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

Flattening into a list

guilds = [guild async for guild in client.fetch_guilds(limit=150)]
# guilds is now a list of Guild...

All parameters are optional.

Parameters

• 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 200.

  Changed in version 2.0: The default has been changed to 200.

• 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.

Raises

HTTPException – Getting the guilds failed.

Yields

Guild – The guild with the guild data parsed.

await fetch_template(code)¶

This function is a coroutine.

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

Parameters

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

Raises

• NotFound – The template is invalid.

• HTTPException – Getting the template failed.

Returns

The template from the URL/code.

Return type

Template

await fetch_guild(guild_id, /, *, with_counts=True)¶

This function is a coroutine.

Retrieves a Guild from an ID.

Note

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

Note

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

Changed in version 2.0: guild_id parameter is now positional-only.

Parameters

• guild_id (int) – The guild’s ID to fetch from.

• with_counts (bool) –

  Whether to include count information in the guild. This fills the
  Guild.approximate_member_count and Guild.approximate_presence_count
  attributes without needing any privileged intents. Defaults to True.

  New in version 2.0.

Raises

• Forbidden – You do not have access to the guild.

• HTTPException – Getting the guild failed.

Returns

The guild from the ID.

Return type

Guild

await create_guild(*, name, icon=…, code=…)¶

This function is a coroutine.

Creates a Guild.

Bot accounts in more than 10 guilds are not allowed to create guilds.

Changed in version 2.0: name and icon parameters are now keyword-only. The region parameter has been removed.

Changed in version 2.0: This function will now raise ValueError instead of
InvalidArgument.

Parameters

• name (str) – The name of the guild.

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

• code (str) –

  The code for a template to create the guild with.

  New in version 1.4.

Raises

• HTTPException – Guild creation failed.

• ValueError – Invalid icon image format given. Must be PNG or JPG.

Returns

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

Return type

Guild

await fetch_stage_instance(channel_id, /)¶

This function is a coroutine.

Gets a StageInstance for a stage channel id.

New in version 2.0.

Parameters

channel_id (int) – The stage channel ID.

Raises

• NotFound – The stage instance or channel could not be found.

• HTTPException – Getting the stage instance failed.

Returns

The stage instance from the stage channel ID.

Return type

StageInstance

await fetch_invite(url, *, with_counts=True, with_expiration=True, scheduled_event_id=None)¶

This function is a coroutine.

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

Note

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.

Parameters

• url (Union[Invite, str]) – The Discord invite ID or URL (must be a discord.gg URL).

• with_counts (bool) – Whether to include count information in the invite. This fills the
  Invite.approximate_member_count and Invite.approximate_presence_count
  fields.

• with_expiration (bool) –

  Whether to include the expiration date of the invite. This fills the
  Invite.expires_at field.

  New in version 2.0.

• scheduled_event_id (Optional[int]) –

  The ID of the scheduled event this invite is for.

  Note

  It is not possible to provide a url that contains an event_id parameter
  when using this parameter.

  New in version 2.0.

Raises

• ValueError – The url contains an event_id, but scheduled_event_id has also been provided.

• NotFound – The invite has expired or is invalid.

• HTTPException – Getting the invite failed.

Returns

The invite from the URL/ID.

Return type

Invite

await delete_invite(invite, /)¶

This function is a coroutine.

Revokes an Invite, URL, or ID to an invite.

You must have manage_channels in
the associated guild to do this.

Changed in version 2.0: invite parameter is now positional-only.

Parameters

invite (Union[Invite, str]) – The invite to revoke.

Raises

• Forbidden – You do not have permissions to revoke invites.

• NotFound – The invite is invalid or expired.

• HTTPException – Revoking the invite failed.

await fetch_widget(guild_id, /)¶

This function is a coroutine.

Gets a Widget from a guild ID.

Note

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

Changed in version 2.0: guild_id parameter is now positional-only.

Parameters

guild_id (int) – The ID of the guild.

Raises

• Forbidden – The widget for this guild is disabled.

• HTTPException – Retrieving the widget failed.

Returns

The guild’s widget.

Return type

Widget

await application_info()¶

This function is a coroutine.

Retrieves the bot’s application information.

Raises

HTTPException – Retrieving the information failed somehow.

Returns

The bot’s application information.

Return type

AppInfo

await fetch_user(user_id, /)¶

This function is a coroutine.

Retrieves a User based on their ID.
You do not have to share any guilds with the user to get this information,
however many operations do require that you do.

Note

This method is an API call. If you have discord.Intents.members and member cache enabled, consider get_user() instead.

Changed in version 2.0: user_id parameter is now positional-only.

Parameters

user_id (int) – The user’s ID to fetch from.

Raises

• NotFound – A user with this ID does not exist.

• HTTPException – Fetching the user failed.

Returns

The user you requested.

Return type

User

await fetch_channel(channel_id, /)¶

This function is a coroutine.

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

Note

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

New in version 1.2.

Changed in version 2.0: channel_id parameter is now positional-only.

Raises

• 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.

Returns

The channel from the ID.

Return type

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

await fetch_webhook(webhook_id, /)¶

This function is a coroutine.

Retrieves a Webhook with the specified ID.

Changed in version 2.0: webhook_id parameter is now positional-only.

Raises

• HTTPException – Retrieving the webhook failed.

• NotFound – Invalid webhook ID.

• Forbidden – You do not have permission to fetch this webhook.

Returns

The webhook you requested.

Return type

Webhook

await fetch_sticker(sticker_id, /)¶

This function is a coroutine.

Retrieves a Sticker with the specified ID.

New in version 2.0.

Raises

• HTTPException – Retrieving the sticker failed.

• NotFound – Invalid sticker ID.

Returns

The sticker you requested.

Return type

Union[StandardSticker, GuildSticker]

await fetch_premium_sticker_packs()¶

This function is a coroutine.

Retrieves all available premium sticker packs.

New in version 2.0.

Raises

HTTPException – Retrieving the sticker packs failed.

Returns

All available premium sticker packs.

Return type

List[StickerPack]

await create_dm(user)¶

This function is a coroutine.

Creates a DMChannel with this user.

This should be rarely called, as this is done transparently for most
people.

New in version 2.0.

Parameters

user (Snowflake) – The user to create a DM with.

Returns

The channel that was created.

Return type

DMChannel

add_view(view, *, message_id=None)¶

Registers a View for persistent listening.

This method should be used for when a view is comprised of components
that last longer than the lifecycle of the program.

New in version 2.0.

Parameters

• view (discord.ui.View) – The view to register for dispatching.

• message_id (Optional[int]) – The message ID that the view is attached to. This is currently used to
  refresh the view’s state during message update events. If not given
  then message update events are not propagated for the view.

Raises

• TypeError – A view was not passed.

• ValueError – The view is not persistent. A persistent view has no timeout
  and all their components have an explicitly provided custom_id.

property persistent_views¶

A sequence of persistent views added to the client.

New in version 2.0.

Type

Sequence[View]

AutoShardedClient¶

class discord.AutoShardedClient(*args, intents, **kwargs)¶

A client similar to Client except it handles the complications
of sharding for the user into a more manageable and transparent single
process bot.

When using this client, you will be able to use it as-if it was a regular
Client with a single shard when implementation wise internally it
is split up into multiple shards. This allows you to not have to deal with
IPC or other complicated infrastructure.

It is recommended to use this client only if you have surpassed at least
1000 guilds.

If no shard_count is provided, then the library will use the
Bot Gateway endpoint call to figure out how many shards to use.

If a shard_ids parameter is given, then those shard IDs will be used
to launch the internal shards. Note that shard_count must be provided
if this is used. By default, when omitted, the client will launch shards from
0 to shard_count - 1.

async with x

Asynchronously initialises the client and automatically cleans up.

New in version 2.0.

shard_ids¶

An optional list of shard_ids to launch the shards with.

Type

Optional[List[int]]

property latency¶

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

This operates similarly to Client.latency() except it uses the average
latency of every shard’s latency. To get a list of shard latency, check the
latencies property. Returns nan if there are no shards ready.

Type

float

property latencies¶

A list of latencies between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

This returns a list of tuples with elements (shard_id, latency).

Type

List[Tuple[int, float]]

get_shard(shard_id, /)¶

Gets the shard information at a given shard ID or None if not found.

Changed in version 2.0: shard_id parameter is now positional-only.

Returns

Information about the shard with given ID. None if not found.

Return type

Optional[ShardInfo]

property shards¶

Returns a mapping of shard IDs to their respective info object.

Type

Mapping[int, ShardInfo]

await connect(*, reconnect=True)¶

This function is a coroutine.

Creates a websocket connection and lets the websocket listen
to messages from Discord. This is a loop that runs the entire
event system and miscellaneous aspects of the library. Control
is not resumed until the WebSocket connection is terminated.

Parameters

reconnect (bool) – If we should attempt reconnecting, either due to internet
failure or a specific failure on Discord’s part. Certain
disconnects that lead to bad state will not be handled (such as
invalid sharding payloads or bad tokens).

Raises

• 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 close()¶

This function is a coroutine.

Closes the connection to Discord.

await change_presence(*, activity=None, status=None, shard_id=None)¶

This function is a coroutine.

Changes the client’s presence.

Example:

game = discord.Game("with the API")
await client.change_presence(status=discord.Status.idle, activity=game)

Changed in version 2.0: Removed the afk keyword-only parameter.

Changed in version 2.0: This function will now raise TypeError instead of
InvalidArgument.

Parameters

• activity (Optional[BaseActivity]) – The activity being done. None if no currently active activity is done.

• status (Optional[Status]) – Indicates what status to change to. If None, then
  Status.online is used.

• shard_id (Optional[int]) – The shard_id to change the presence to. If not specified
  or None, then it will change the presence of every
  shard the bot can see.

Raises

TypeError – If the activity parameter is not of proper type.

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.

This implementation checks if any of the shards are rate limited.
For more granular control, consider ShardInfo.is_ws_ratelimited().

New in version 1.6.

AppInfo¶

class discord.AppInfo¶

Represents the application info for the bot provided by Discord.

id¶

The application ID.

Type

int

name¶

The application name.

Type

str

owner¶

The application owner.

Type

User

team¶

The application’s team.

New in version 1.3.

Type

Optional[Team]

description¶

The application description.

Type

str

bot_public¶

Whether the bot can be invited by anyone or if it is locked
to the application owner.

Type

bool

bot_require_code_grant¶

Whether the bot requires the completion of the full oauth2 code
grant flow to join.

Type

bool

rpc_origins¶

A list of RPC origin URLs, if RPC is enabled.

Type

Optional[List[str]]

verify_key¶

The hex encoded key for verification in interactions and the
GameSDK’s GetTicket.

New in version 1.3.

Type

str

guild_id¶

If this application is a game sold on Discord,
this field will be the guild to which it has been linked to.

New in version 1.3.

Type

Optional[int]

primary_sku_id¶

If this application is a game sold on Discord,
this field will be the id of the “Game SKU” that is created,
if it exists.

New in version 1.3.

Type

Optional[int]

slug¶

If this application is a game sold on Discord,
this field will be the URL slug that links to the store page.

New in version 1.3.

Type

Optional[str]

terms_of_service_url¶

The application’s terms of service URL, if set.

New in version 2.0.

Type

Optional[str]

privacy_policy_url¶

The application’s privacy policy URL, if set.

New in version 2.0.

Type

Optional[str]

tags¶

The list of tags describing the functionality of the application.

New in version 2.0.

Type

List[str]

custom_install_url¶

The custom authorization URL for the application, if enabled.

New in version 2.0.

Type

List[str]

install_params¶

The settings for custom authorization URL of application, if enabled.

New in version 2.0.

Type

Optional[AppInstallParams]

property icon¶

Retrieves the application’s icon asset, if any.

Type

Optional[Asset]

property cover_image¶

Retrieves the cover image on a store embed, if any.

This is only available if the application is a game sold on Discord.

Type

Optional[Asset]

property guild¶

If this application is a game sold on Discord,
this field will be the guild to which it has been linked

New in version 1.3.

Type

Optional[Guild]

property flags¶

The application’s flags.

New in version 2.0.

Type

ApplicationFlags

PartialAppInfo¶

class discord.PartialAppInfo¶

Represents a partial AppInfo given by create_invite()

New in version 2.0.

id¶

The application ID.

Type

int

name¶

The application name.

Type

str

description¶

The application description.

Type

str

rpc_origins¶

A list of RPC origin URLs, if RPC is enabled.

Type

Optional[List[str]]

verify_key¶

The hex encoded key for verification in interactions and the
GameSDK’s GetTicket.

Type

str

terms_of_service_url¶

The application’s terms of service URL, if set.

Type

Optional[str]

privacy_policy_url¶

The application’s privacy policy URL, if set.

Type

Optional[str]

property icon¶

Retrieves the application’s icon asset, if any.

Type

Optional[Asset]

property flags¶

The application’s flags.

New in version 2.0.

Type

ApplicationFlags

AppInstallParams¶

class discord.AppInstallParams¶

Represents the settings for custom authorization URL of an application.

New in version 2.0.

scopes¶

The list of OAuth2 scopes
to add the application to a guild with.

Type

List[str]

permissions¶

The permissions to give to application in the guild.

Type

Permissions

Team¶

class discord.Team¶

Represents an application team for a bot provided by Discord.

id¶

The team ID.

Type

int

name¶

The team name

Type

str

owner_id¶

The team’s owner ID.

Type

int

members¶

A list of the members in the team

New in version 1.3.

Type

List[TeamMember]

property icon¶

Retrieves the team’s icon asset, if any.

Type

Optional[Asset]

property owner¶

The team’s owner.

Type

Optional[TeamMember]

TeamMember¶

class discord.TeamMember¶

Represents a team member in a team.

x == y

Checks if two team members are equal.

x != y

Checks if two team members are not equal.

hash(x)

Return the team member’s hash.

str(x)

Returns the team member’s name with discriminator.

New in version 1.3.

name¶

The team member’s username.

Type

str

id¶

The team member’s unique ID.

Type

int

discriminator¶

The team member’s discriminator. This is given when the username has conflicts.

Type

str

bot¶

Specifies if the user is a bot account.

Type

bool

team¶

The team that the member is from.

Type

Team

membership_state¶

The membership state of the member (e.g. invited or accepted)

Type

TeamMembershipState

property accent_color¶

Returns the user’s accent color, if applicable.

A user’s accent color is only shown if they do not have a banner.
This will only be available if the user explicitly sets a color.

There is an alias for this named accent_colour.

New in version 2.0.

Note

This information is only available via Client.fetch_user().

Type

Optional[Colour]

property accent_colour¶

Returns the user’s accent colour, if applicable.

A user’s accent colour is only shown if they do not have a banner.
This will only be available if the user explicitly sets a colour.

There is an alias for this named accent_color.

New in version 2.0.

Note

This information is only available via Client.fetch_user().

Type

Optional[Colour]

property avatar¶

Returns an Asset for the avatar the user has.

If the user does not have a traditional avatar, None is returned.
If you want the avatar that a user has displayed, consider display_avatar.

Type

Optional[Asset]

Returns the user’s banner asset, if available.

New in version 2.0.

Note

This information is only available via Client.fetch_user().

Type

Optional[Asset]

property color¶

A property that returns a color denoting the rendered color
for the user. This always returns Colour.default().

There is an alias for this named colour.

Type

Colour

property colour¶

A property that returns a colour denoting the rendered colour
for the user. This always returns Colour.default().

There is an alias for this named color.

Type

Colour

property created_at¶

Returns the user’s creation time in UTC.

This is when the user’s Discord account was created.

Type

datetime.datetime

property default_avatar¶

Returns the default avatar for a given user. This is calculated by the user’s discriminator.

Type

Asset

property display_avatar¶

Returns the user’s display avatar.

For regular users this is just their default avatar or uploaded avatar.

New in version 2.0.

Type

Asset

property display_name¶

Returns the user’s display name.

For regular users this is just their username, but
if they have a guild specific nickname then that
is returned instead.

Type

str

property mention¶

Returns a string that allows you to mention the given user.

Type

str

mentioned_in(message)¶

Checks if the user is mentioned in the specified message.

Parameters

message (Message) – The message to check if you’re mentioned in.

Returns

Indicates if the user is mentioned in the message.

Return type

bool

property public_flags¶

The publicly available flags the user has.

Type

PublicUserFlags

App Commands¶

discord.on_raw_app_command_permissions_update(payload)¶

Called when application command permissions are updated.

New in version 2.0.

Parameters

payload (RawAppCommandPermissionsUpdateEvent) – The raw event payload data.

discord.on_app_command_completion(interaction, command)¶

Called when a app_commands.Command or app_commands.ContextMenu has
successfully completed without error.

New in version 2.0.

Parameters

• interaction (Interaction) – The interaction of the command.

• command (Union[app_commands.Command, app_commands.ContextMenu]) – The command that completed successfully

AutoMod¶

discord.on_automod_rule_create(rule)¶

Called when a AutoModRule is created.

This requires Intents.auto_moderation_configuration to be enabled.

New in version 2.0.

Parameters

rule (AutoModRule) – The rule that was created.

discord.on_automod_rule_update(rule)¶

Called when a AutoModRule is updated.

This requires Intents.auto_moderation_configuration to be enabled.

New in version 2.0.

Parameters

rule (AutoModRule) – The rule that was updated.

discord.on_automod_rule_delete(rule)¶

Called when a AutoModRule is deleted.

This requires Intents.auto_moderation_configuration to be enabled.

New in version 2.0.

Parameters

rule (AutoModRule) – The rule that was deleted.

discord.on_automod_action(execution)¶

Called when a AutoModAction is created/performed.

This requires Intents.auto_moderation_execution to be enabled.

New in version 2.0.

Parameters

execution (AutoModAction) – The rule execution that was performed.

Channels¶

discord.on_guild_channel_delete(channel)¶

discord.on_guild_channel_create(channel)¶

Called whenever a guild channel is deleted or created.

Note that you can get the guild from guild.

This requires Intents.guilds to be enabled.

Parameters

channel (abc.GuildChannel) – The guild channel that got created or deleted.

discord.on_guild_channel_update(before, after)¶

Called whenever a guild channel is updated. e.g. changed name, topic, permissions.

This requires Intents.guilds to be enabled.

Parameters

• before (abc.GuildChannel) – The updated guild channel’s old info.

• after (abc.GuildChannel) – The updated guild channel’s new info.

discord.on_guild_channel_pins_update(channel, last_pin)¶

Called whenever a message is pinned or unpinned from a guild channel.

This requires Intents.guilds to be enabled.

Parameters

• channel (Union[abc.GuildChannel, Thread]) – The guild channel that had its pins updated.

• last_pin (Optional[datetime.datetime]) – The latest message that was pinned as an aware datetime in UTC. Could be None.

discord.on_private_channel_update(before, after)¶

Called whenever a private group DM is updated. e.g. changed name or topic.

This requires Intents.messages to be enabled.

Parameters

• before (GroupChannel) – The updated group channel’s old info.

• after (GroupChannel) – The updated group channel’s new info.

discord.on_private_channel_pins_update(channel, last_pin)¶

Called whenever a message is pinned or unpinned from a private channel.

Parameters

• channel (abc.PrivateChannel) – The private channel that had its pins updated.

• last_pin (Optional[datetime.datetime]) – The latest message that was pinned as an aware datetime in UTC. Could be None.

discord.on_typing(channel, user, when)¶

Called when someone begins typing a message.

The channel parameter can be a abc.Messageable instance.
Which could either be TextChannel, GroupChannel, or
DMChannel.

If the channel is a TextChannel then the user parameter
is a Member, otherwise it is a User.

If the channel or user could not be found in the internal cache this event
will not be called, you may use on_raw_typing() instead.

This requires Intents.typing to be enabled.

Parameters

• channel (abc.Messageable) – The location where the typing originated from.

• user (Union[User, Member]) – The user that started typing.

• when (datetime.datetime) – When the typing started as an aware datetime in UTC.

discord.on_raw_typing(payload)¶

Called when someone begins typing a message. Unlike on_typing() this
is called regardless of the channel and user being in the internal cache.

This requires Intents.typing to be enabled.

New in version 2.0.

Parameters

payload (RawTypingEvent) – The raw event payload data.

Connection¶

discord.on_connect()¶

Called when the client has successfully connected to Discord. This is not
the same as the client being fully prepared, see on_ready() for that.

The warnings on on_ready() also apply.

discord.on_disconnect()¶

Called when the client has disconnected from Discord, or a connection attempt to Discord has failed.
This could happen either through the internet being disconnected, explicit calls to close,
or Discord terminating the connection one way or the other.

This function can be called many times without a corresponding on_connect() call.

discord.on_shard_connect(shard_id)¶

Similar to on_connect() except used by AutoShardedClient
to denote when a particular shard ID has connected to Discord.

New in version 1.4.

Parameters

shard_id (int) – The shard ID that has connected.

discord.on_shard_disconnect(shard_id)¶

Similar to on_disconnect() except used by AutoShardedClient
to denote when a particular shard ID has disconnected from Discord.

New in version 1.4.

Parameters

shard_id (int) – The shard ID that has disconnected.

Debug¶

discord.on_error(event, *args, **kwargs)¶

Usually when an event raises an uncaught exception, a traceback is
logged to stderr and the exception is ignored. If you want to
change this behaviour and handle the exception for whatever reason
yourself, this event can be overridden. Which, when done, will
suppress the default action of printing the traceback.

The information of the exception raised and the exception itself can
be retrieved with a standard call to sys.exc_info().

Note

on_error will only be dispatched to Client.event().

It will not be received by Client.wait_for(), or, if used,
Bots listeners such as
listen() or listener().

Changed in version 2.0: The traceback is now logged rather than printed.

Parameters

• event (str) – The name of the event that raised the exception.

• args – The positional arguments for the event that raised the
  exception.

• kwargs – The keyword arguments for the event that raised the
  exception.

discord.on_socket_event_type(event_type)¶

Called whenever a websocket event is received from the WebSocket.

This is mainly useful for logging how many events you are receiving
from the Discord gateway.

New in version 2.0.

Parameters

event_type (str) – The event type from Discord that is received, e.g. 'READY'.

discord.on_socket_raw_receive(msg)¶

Called whenever a message is completely received from the WebSocket, before
it’s processed and parsed. This event is always dispatched when a
complete message is received and the passed data is not parsed in any way.

This is only really useful for grabbing the WebSocket stream and
debugging purposes.

This requires setting the enable_debug_events setting in the Client.

Note

This is only for the messages received from the client
WebSocket. The voice WebSocket will not trigger this event.

Parameters

msg (str) – The message passed in from the WebSocket library.

discord.on_socket_raw_send(payload)¶

Called whenever a send operation is done on the WebSocket before the
message is sent. The passed parameter is the message that is being
sent to the WebSocket.

This is only really useful for grabbing the WebSocket stream and
debugging purposes.

This requires setting the enable_debug_events setting in the Client.

Note

This is only for the messages sent from the client
WebSocket. The voice WebSocket will not trigger this event.

Parameters

payload – The message that is about to be passed on to the
WebSocket library. It can be bytes to denote a binary
message or str to denote a regular text message.

Gateway¶

discord.on_ready()¶

Called when the client is done preparing the data received from Discord. Usually after login is successful
and the Client.guilds and co. are filled up.

Warning

This function is not guaranteed to be the first event called.
Likewise, this function is not guaranteed to only be called
once. This library implements reconnection logic and thus will
end up calling this event whenever a RESUME request fails.

discord.on_resumed()¶

Called when the client has resumed a session.

discord.on_shard_ready(shard_id)¶

Similar to on_ready() except used by AutoShardedClient
to denote when a particular shard ID has become ready.

Parameters

shard_id (int) – The shard ID that is ready.

discord.on_shard_resumed(shard_id)¶

Similar to on_resumed() except used by AutoShardedClient
to denote when a particular shard ID has resumed a session.

New in version 1.4.

Parameters

shard_id (int) – The shard ID that has resumed.

Guilds¶

discord.on_guild_available(guild)¶

discord.on_guild_unavailable(guild)¶

Called when a guild becomes available or unavailable. The guild must have
existed in the Client.guilds cache.

This requires Intents.guilds to be enabled.

Parameters

guild – The Guild that has changed availability.

discord.on_guild_join(guild)¶

Called when a Guild is either created by the Client or when the
Client joins a guild.

This requires Intents.guilds to be enabled.

Parameters

guild (Guild) – The guild that was joined.

discord.on_guild_remove(guild)¶

Called when a Guild is removed from the Client.

This happens through, but not limited to, these circumstances:

• The client got banned.

• The client got kicked.

• The client left the guild.

• The client or the guild owner deleted the guild.

In order for this event to be invoked then the Client must have
been part of the guild to begin with. (i.e. it is part of Client.guilds)

This requires Intents.guilds to be enabled.

Parameters

guild (Guild) – The guild that got removed.

discord.on_guild_update(before, after)¶

Called when a Guild updates, for example:

• Changed name

• Changed AFK channel

• Changed AFK timeout

• etc

This requires Intents.guilds to be enabled.

Parameters

• before (Guild) – The guild prior to being updated.

• after (Guild) – The guild after being updated.

discord.on_guild_emojis_update(guild, before, after)¶

Called when a Guild adds or removes Emoji.

This requires Intents.emojis_and_stickers to be enabled.

Parameters

• guild (Guild) – The guild who got their emojis updated.

• before (Sequence[Emoji]) – A list of emojis before the update.

• after (Sequence[Emoji]) – A list of emojis after the update.

discord.on_guild_stickers_update(guild, before, after)¶

Called when a Guild updates its stickers.

This requires Intents.emojis_and_stickers to be enabled.

New in version 2.0.

Parameters

• guild (Guild) – The guild who got their stickers updated.

• before (Sequence[GuildSticker]) – A list of stickers before the update.

• after (Sequence[GuildSticker]) – A list of stickers after the update.

discord.on_invite_create(invite)¶

Called when an Invite is created.
You must have manage_channels to receive this.

New in version 1.3.

Note

There is a rare possibility that the Invite.guild and Invite.channel
attributes will be of Object rather than the respective models.

This requires Intents.invites to be enabled.

Parameters

invite (Invite) – The invite that was created.

discord.on_invite_delete(invite)¶

Called when an Invite is deleted.
You must have manage_channels to receive this.

New in version 1.3.

Note

There is a rare possibility that the Invite.guild and Invite.channel
attributes will be of Object rather than the respective models.

Outside of those two attributes, the only other attribute guaranteed to be
filled by the Discord gateway for this event is Invite.code.

This requires Intents.invites to be enabled.

Parameters

invite (Invite) – The invite that was deleted.

Integrations¶

discord.on_integration_create(integration)¶

Called when an integration is created.

This requires Intents.integrations to be enabled.

New in version 2.0.

Parameters

integration (Integration) – The integration that was created.

discord.on_integration_update(integration)¶

Called when an integration is updated.

This requires Intents.integrations to be enabled.

New in version 2.0.

Parameters

integration (Integration) – The integration that was updated.

discord.on_guild_integrations_update(guild)¶

Called whenever an integration is created, modified, or removed from a guild.

This requires Intents.integrations to be enabled.

New in version 1.4.

Parameters

guild (Guild) – The guild that had its integrations updated.

discord.on_webhooks_update(channel)¶

Called whenever a webhook is created, modified, or removed from a guild channel.

This requires Intents.webhooks to be enabled.

Parameters

channel (abc.GuildChannel) – The channel that had its webhooks updated.

discord.on_raw_integration_delete(payload)¶

Called when an integration is deleted.

This requires Intents.integrations to be enabled.

New in version 2.0.

Parameters

payload (RawIntegrationDeleteEvent) – The raw event payload data.

Interactions¶

discord.on_interaction(interaction)¶

Called when an interaction happened.

This currently happens due to slash command invocations or components being used.

Warning

This is a low level function that is not generally meant to be used.
If you are working with components, consider using the callbacks associated
with the View instead as it provides a nicer user experience.

New in version 2.0.

Parameters

interaction (Interaction) – The interaction data.

Members¶

discord.on_member_join(member)¶

Called when a Member joins a Guild.

This requires Intents.members to be enabled.

Parameters

member (Member) – The member who joined.

discord.on_member_remove(member)¶

Called when a Member leaves a Guild.

If the guild or member could not be found in the internal cache this event
will not be called, you may use on_raw_member_remove() instead.

This requires Intents.members to be enabled.

Parameters

member (Member) – The member who left.

discord.on_raw_member_remove(payload)¶

Called when a Member leaves a Guild.

Unlike on_member_remove()
this is called regardless of the guild or member being in the internal cache.

This requires Intents.members to be enabled.

New in version 2.0.

Parameters

payload (RawMemberRemoveEvent) – The raw event payload data.

discord.on_member_update(before, after)¶

Called when a Member updates their profile.

This is called when one or more of the following things change:

• nickname

• roles

• pending

• timeout

• guild avatar

Due to a Discord limitation, this event is not dispatched when a member’s timeout expires.

This requires Intents.members to be enabled.

Parameters

• before (Member) – The updated member’s old info.

• after (Member) – The updated member’s updated info.

discord.on_user_update(before, after)¶

Called when a User updates their profile.

This is called when one or more of the following things change:

• avatar

• username

• discriminator

This requires Intents.members to be enabled.

Parameters

• before (User) – The updated user’s old info.

• after (User) – The updated user’s updated info.

discord.on_member_ban(guild, user)¶

Called when user gets banned from a Guild.

This requires Intents.bans to be enabled.

Parameters

• guild (Guild) – The guild the user got banned from.

• user (Union[User, Member]) – The user that got banned.
  Can be either User or Member depending if
  the user was in the guild or not at the time of removal.

discord.on_member_unban(guild, user)¶

Called when a User gets unbanned from a Guild.

This requires Intents.bans to be enabled.

Parameters

• guild (Guild) – The guild the user got unbanned from.

• user (User) – The user that got unbanned.

discord.on_presence_update(before, after)¶

Called when a Member updates their presence.

This is called when one or more of the following things change:

• status

• activity

This requires Intents.presences and Intents.members to be enabled.

New in version 2.0.

Parameters

• before (Member) – The updated member’s old info.

• after (Member) – The updated member’s updated info.

Messages¶

discord.on_message(message)¶

Called when a Message is created and sent.

This requires Intents.messages to be enabled.

Warning

Your bot’s own messages and private messages are sent through this
event. This can lead cases of ‘recursion’ depending on how your bot was
programmed. If you want the bot to not reply to itself, consider
checking the user IDs. Note that Bot does not
have this problem.

Parameters

message (Message) – The current message.

discord.on_message_edit(before, after)¶

Called when a Message receives an update event. If the message is not found
in the internal message cache, then these events will not be called.
Messages might not be in cache if the message is too old
or the client is participating in high traffic guilds.

If this occurs increase the max_messages parameter
or use the on_raw_message_edit() event instead.

The following non-exhaustive cases trigger this event:

• A message has been pinned or unpinned.

• The message content has been changed.

• The message has received an embed.

  • For performance reasons, the embed server does not do this in a “consistent” manner.

• The message’s embeds were suppressed or unsuppressed.

• A call message has received an update to its participants or ending time.

This requires Intents.messages to be enabled.

Parameters

• before (Message) – The previous version of the message.

• after (Message) – The current version of the message.

discord.on_message_delete(message)¶

Called when a message is deleted. If the message is not found in the
internal message cache, then this event will not be called.
Messages might not be in cache if the message is too old
or the client is participating in high traffic guilds.

If this occurs increase the max_messages parameter
or use the on_raw_message_delete() event instead.

This requires Intents.messages to be enabled.

Parameters

message (Message) – The deleted message.

discord.on_bulk_message_delete(messages)¶

Called when messages are bulk deleted. If none of the messages deleted
are found in the internal message cache, then this event will not be called.
If individual messages were not found in the internal message cache,
this event will still be called, but the messages not found will not be included in
the messages list. Messages might not be in cache if the message is too old
or the client is participating in high traffic guilds.

If this occurs increase the max_messages parameter
or use the on_raw_bulk_message_delete() event instead.

This requires Intents.messages to be enabled.

Parameters

messages (List[Message]) – The messages that have been deleted.

discord.on_raw_message_edit(payload)¶

Called when a message is edited. Unlike on_message_edit(), this is called
regardless of the state of the internal message cache.

If the message is found in the message cache,
it can be accessed via RawMessageUpdateEvent.cached_message. The cached message represents
the message before it has been edited. For example, if the content of a message is modified and
triggers the on_raw_message_edit() coroutine, the RawMessageUpdateEvent.cached_message
will return a Message object that represents the message before the content was modified.

Due to the inherently raw nature of this event, the data parameter coincides with
the raw data given by the gateway.

Since the data payload can be partial, care must be taken when accessing stuff in the dictionary.
One example of a common case of partial data is when the 'content' key is inaccessible. This
denotes an “embed” only edit, which is an edit in which only the embeds are updated by the Discord
embed server.

This requires Intents.messages to be enabled.

Parameters

payload (RawMessageUpdateEvent) – The raw event payload data.

discord.on_raw_message_delete(payload)¶

Called when a message is deleted. Unlike on_message_delete(), this is
called regardless of the message being in the internal message cache or not.

If the message is found in the message cache,
it can be accessed via RawMessageDeleteEvent.cached_message

This requires Intents.messages to be enabled.

Parameters

payload (RawMessageDeleteEvent) – The raw event payload data.

discord.on_raw_bulk_message_delete(payload)¶

Called when a bulk delete is triggered. Unlike on_bulk_message_delete(), this is
called regardless of the messages being in the internal message cache or not.

If the messages are found in the message cache,
they can be accessed via RawBulkMessageDeleteEvent.cached_messages

This requires Intents.messages to be enabled.

Parameters

payload (RawBulkMessageDeleteEvent) – The raw event payload data.

Reactions¶

discord.on_reaction_add(reaction, user)¶

Called when a message has a reaction added to it. Similar to on_message_edit(),
if the message is not found in the internal message cache, then this
event will not be called. Consider using on_raw_reaction_add() instead.

Note

To get the Message being reacted, access it via Reaction.message.

This requires Intents.reactions to be enabled.

Note

This doesn’t require Intents.members within a guild context,
but due to Discord not providing updated user information in a direct message
it’s required for direct messages to receive this event.
Consider using on_raw_reaction_add() if you need this and do not otherwise want
to enable the members intent.

Parameters

• reaction (Reaction) – The current state of the reaction.

• user (Union[Member, User]) – The user who added the reaction.

discord.on_reaction_remove(reaction, user)¶

Called when a message has a reaction removed from it. Similar to on_message_edit,
if the message is not found in the internal message cache, then this event
will not be called.

Note

To get the message being reacted, access it via Reaction.message.

This requires both Intents.reactions and Intents.members to be enabled.

Note

Consider using on_raw_reaction_remove() if you need this and do not want
to enable the members intent.

Parameters

• reaction (Reaction) – The current state of the reaction.

• user (Union[Member, User]) – The user whose reaction was removed.

discord.on_reaction_clear(message, reactions)¶

Called when a message has all its reactions removed from it. Similar to on_message_edit(),
if the message is not found in the internal message cache, then this event
will not be called. Consider using on_raw_reaction_clear() instead.

This requires Intents.reactions to be enabled.

Parameters

• message (Message) – The message that had its reactions cleared.

• reactions (List[Reaction]) – The reactions that were removed.

discord.on_reaction_clear_emoji(reaction)¶

Called when a message has a specific reaction removed from it. Similar to on_message_edit(),
if the message is not found in the internal message cache, then this event
will not be called. Consider using on_raw_reaction_clear_emoji() instead.

This requires Intents.reactions to be enabled.

New in version 1.3.

Parameters

reaction (Reaction) – The reaction that got cleared.

discord.on_raw_reaction_add(payload)¶

Called when a message has a reaction added. Unlike on_reaction_add(), this is
called regardless of the state of the internal message cache.

This requires Intents.reactions to be enabled.

Parameters

payload (RawReactionActionEvent) – The raw event payload data.

discord.on_raw_reaction_remove(payload)¶

Called when a message has a reaction removed. Unlike on_reaction_remove(), this is
called regardless of the state of the internal message cache.

This requires Intents.reactions to be enabled.

Parameters

payload (RawReactionActionEvent) – The raw event payload data.

discord.on_raw_reaction_clear(payload)¶

Called when a message has all its reactions removed. Unlike on_reaction_clear(),
this is called regardless of the state of the internal message cache.

This requires Intents.reactions to be enabled.

Parameters

payload (RawReactionClearEvent) – The raw event payload data.

discord.on_raw_reaction_clear_emoji(payload)¶

Called when a message has a specific reaction removed from it. Unlike on_reaction_clear_emoji() this is called
regardless of the state of the internal message cache.

This requires Intents.reactions to be enabled.

New in version 1.3.

Parameters

payload (RawReactionClearEmojiEvent) – The raw event payload data.

Roles¶

discord.on_guild_role_create(role)¶

discord.on_guild_role_delete(role)¶

Called when a Guild creates or deletes a new Role.

To get the guild it belongs to, use Role.guild.

This requires Intents.guilds to be enabled.

Parameters

role (Role) – The role that was created or deleted.

discord.on_guild_role_update(before, after)¶

Called when a Role is changed guild-wide.

This requires Intents.guilds to be enabled.

Parameters

• before (Role) – The updated role’s old info.

• after (Role) – The updated role’s updated info.

Scheduled Events¶

discord.on_scheduled_event_create(event)¶

discord.on_scheduled_event_delete(event)¶

Called when a ScheduledEvent is created or deleted.

This requires Intents.guild_scheduled_events to be enabled.

New in version 2.0.

Parameters

event (ScheduledEvent) – The scheduled event that was created or deleted.

discord.on_scheduled_event_update(before, after)¶

Called when a ScheduledEvent is updated.

This requires Intents.guild_scheduled_events to be enabled.

The following, but not limited to, examples illustrate when this event is called:

• The scheduled start/end times are changed.

• The channel is changed.

• The description is changed.

• The status is changed.

• The image is changed.

New in version 2.0.

Parameters

• before (ScheduledEvent) – The scheduled event before the update.

• after (ScheduledEvent) – The scheduled event after the update.

discord.on_scheduled_event_user_add(event, user)¶

discord.on_scheduled_event_user_remove(event, user)¶

Called when a user is added or removed from a ScheduledEvent.

This requires Intents.guild_scheduled_events to be enabled.

New in version 2.0.

Parameters

• event (ScheduledEvent) – The scheduled event that the user was added or removed from.

• user (User) – The user that was added or removed.

Stages¶

discord.on_stage_instance_create(stage_instance)¶

discord.on_stage_instance_delete(stage_instance)¶

Called when a StageInstance is created or deleted for a StageChannel.

New in version 2.0.

Parameters

stage_instance (StageInstance) – The stage instance that was created or deleted.

discord.on_stage_instance_update(before, after)¶

Called when a StageInstance is updated.

The following, but not limited to, examples illustrate when this event is called:

• The topic is changed.

• The privacy level is changed.

New in version 2.0.

Parameters

• before (StageInstance) – The stage instance before the update.

• after (StageInstance) – The stage instance after the update.

Threads¶

discord.on_thread_create(thread)¶

Called whenever a thread is created.

Note that you can get the guild from Thread.guild.

This requires Intents.guilds to be enabled.

New in version 2.0.

Parameters

thread (Thread) – The thread that was created.

discord.on_thread_join(thread)¶

Called whenever a thread is joined.

Note that you can get the guild from Thread.guild.

This requires Intents.guilds to be enabled.

New in version 2.0.

Parameters

thread (Thread) – The thread that got joined.

discord.on_thread_update(before, after)¶

Called whenever a thread is updated. If the thread could
not be found in the internal cache this event will not be called.
Threads will not be in the cache if they are archived.

If you need this information use on_raw_thread_update() instead.

This requires Intents.guilds to be enabled.

New in version 2.0.

Parameters

• before (Thread) – The updated thread’s old info.

• after (Thread) – The updated thread’s new info.

discord.on_thread_remove(thread)¶

Called whenever a thread is removed. This is different from a thread being deleted.

Note that you can get the guild from Thread.guild.

This requires Intents.guilds to be enabled.

Warning

Due to technical limitations, this event might not be called
as soon as one expects. Since the library tracks thread membership
locally, the API only sends updated thread membership status upon being
synced by joining a thread.

New in version 2.0.

Parameters

thread (Thread) – The thread that got removed.

discord.on_thread_delete(thread)¶

Called whenever a thread is deleted. If the thread could
not be found in the internal cache this event will not be called.
Threads will not be in the cache if they are archived.

If you need this information use on_raw_thread_delete() instead.

Note that you can get the guild from Thread.guild.

This requires Intents.guilds to be enabled.

New in version 2.0.

Parameters

thread (Thread) – The thread that got deleted.

discord.on_raw_thread_update(payload)¶

Called whenever a thread is updated. Unlike on_thread_update() this
is called regardless of the thread being in the internal thread cache or not.

This requires Intents.guilds to be enabled.

New in version 2.0.

Parameters

payload (RawThreadUpdateEvent) – The raw event payload data.

discord.on_raw_thread_delete(payload)¶

Called whenever a thread is deleted. Unlike on_thread_delete() this
is called regardless of the thread being in the internal thread cache or not.

This requires Intents.guilds to be enabled.

New in version 2.0.

Parameters

payload (RawThreadDeleteEvent) – The raw event payload data.

discord.on_thread_member_join(member)¶

discord.on_thread_member_remove(member)¶

Called when a ThreadMember leaves or joins a Thread.

You can get the thread a member belongs in by accessing ThreadMember.thread.

This requires Intents.members to be enabled.

New in version 2.0.

Parameters

member (ThreadMember) – The member who joined or left.

discord.on_raw_thread_member_remove(payload)¶

Called when a ThreadMember leaves a Thread. Unlike on_thread_member_remove() this
is called regardless of the member being in the internal thread’s members cache or not.

This requires Intents.members to be enabled.

New in version 2.0.

Parameters

payload – The raw event payload data.

Voice¶

discord.on_voice_state_update(member, before, after)¶

Called when a Member changes their VoiceState.

The following, but not limited to, examples illustrate when this event is called:

• A member joins a voice or stage channel.

• A member leaves a voice or stage channel.

• A member is muted or deafened by their own accord.

• A member is muted or deafened by a guild administrator.

This requires Intents.voice_states to be enabled.

Parameters

• member (Member) – The member whose voice states changed.

• before (VoiceState) – The voice state prior to the changes.

• after (VoiceState) – The voice state after the changes.