discord.py

The discord.ui package provides a suite of helpers for building component-based user interfaces. It includes classes for managing views, layouts, modals, and individual UI elements like buttons, select menus, and text inputs.

Key components include:

• Views: View and LayoutView for managing groups of components.
• Modals: Modal for pop-up forms.
• Items: Button, Select (and specialized versions like UserSelect, RoleSelect, etc.), TextInput, and ActionRow.
• Advanced Layouts (v2.6+): Container, Section, Separator, TextDisplay, Thumbnail, MediaGallery, File, Label, FileUpload, RadioGroup, and CheckboxGroup.

While discord.py provides low-level interaction with the Discord API, discord.ext.commands is a high-level extension designed specifically for building extensible, flexible, and powerful bot command frameworks. Instead of manually handling message parsing and command routing, you should use this extension to manage bot commands efficiently.

import discord
from discord.ext import commands

# Typical setup involves using commands.Bot instead of discord.Client
bot = commands.Bot(command_prefix='!', intents=discord.Intents.all())

To improve performance, several attributes that previously returned a list now return a read-only sequence. This is transparent for reading, but will raise errors if you attempt to modify them directly (e.g., using .append()).

To convert a sequence back into a list, wrap it in the list() constructor.

Affected attributes:

• Client.guilds
• Client.emojis
• Client.private_channels
• Guild.roles
• Guild.channels
• Guild.members

# If you need to modify the sequence, convert it to a list first
my_list = list(guild.roles)
my_list.append(new_role)

The AutoShardedClient has been redesigned for better multi-process cluster support. Key capabilities include:

• Shard Information: Use AutoShardedClient.get_shard or the shards attribute to access ShardInfo objects.
• Shard Control: ShardInfo allows you to manually reconnect or disconnect specific shards.
• Lifecycle Hooks: Use Client.before_identify_hook to execute logic before the IDENTIFY payload is sent.
• Shard Events: New events are available for monitoring shard status: on_shard_connect, on_shard_disconnect, and on_shard_resumed.

Discord Models (e.g., User, Message, Guild, Member) are classes representing data received from the Discord API.

Important Constraints:

• Read-Only: You should not attempt to modify model instances directly.
• Do Not Instantiate: You should not create your own instances of these classes (e.g., do not call User() to create a user).
• Accessing Models: To obtain a model instance, you should retrieve it from the library's cache or via attributes provided in Discord API events. A common way to find a specific model is using the utils.find function.
• Slots: Most model classes use __slots__, meaning you cannot add dynamic attributes to them.

The library uses Abstract Base Classes (ABCs) to define common behaviors and interfaces.

Important: You should not instantiate these classes directly. They are designed to be used with isinstance() and issubclass() to check if an object implements a specific interface (e.g., checking if a channel is Messageable).

All ABCs in this library are subclasses of typing.Protocol, allowing for structural subtyping.

discord.py provides support for managing and interacting with Discord webhooks via the Webhook and SyncWebhook classes.

• Webhook: Used for asynchronous webhook operations. It works with WebhookMessage objects.
• SyncWebhook: Used for synchronous webhook operations (blocking), which is useful in environments where an event loop is not available or preferred. It works with SyncWebhookMessage objects.

# Note: Specific method calls are not provided in this segment, but the classes are:
# from discord import Webhook, SyncWebhook

The command extension provides custom events that trigger during the command lifecycle. These are distinct from standard Discord API events:

• on_command(ctx): Called when a command is found and is about to be invoked. This triggers regardless of whether the command succeeds or fails.
• on_command_completion(ctx): Called only when a command successfully completes (all checks passed and user input was correct).
• on_command_error(ctx, error): An error handler called when an error is raised inside a command (e.g., user input error, check failure, or code error). You can define a global handler using Bot.on_command_error or specific command error handlers using Command.error().

Flag classes now have a custom __bool__ implementation. Evaluating them in a boolean context (e.g., if obj:) will only return True if at least one flag is enabled. If no flags are set, they will evaluate to False.

# The following classes follow this behavior:
# Intents, MemberCacheFlags, MessageFlags, Permissions,
# PublicUserFlags, SystemChannelFlags

# If no intents are enabled, this will be False:
if intents:  # might be False even if the object exists
    ...