Changelog

This page keeps a detailed human friendly rendering of what’s new and changed in specific versions.

v2.9.0a [UNRELEASED]

Deprecations

• disnake.utils.search_directory() will be removed in a future version, in favor of disnake.ext.commands.Bot.find_extensions() which is the most common usecase and is more consistent. (#796)

New Features

• Add Guild.max_stage_video_channel_users. (#741)

• [ext.commands] Improve Bot.load_extensions, add Bot.find_extensions. (#796)

  • Better support for more complex extension hierarchies.

  • New package, ignore, and load_callback parameters.

• Add features related to role subscriptions. (#904)

  • MessageType.role_subscription_purchase

  • RoleTags.subscription_listing_id, RoleTags.is_available_for_purchase, and RoleTags.is_subscription

• Add oldest_first parameter to Guild.audit_logs(). (#919)

• Add MessageFlags.suppress_notifications. (#929)

• Add flags parameter to message send and edit methods. (#929)

• New message types that are sent within StageChannel instances: (#942)

  • MessageType.stage_start, MessageType.stage_end, MessageType.stage_speaker, and MessageType.stage_topic.

• Add support for setting user_limit and video_quality_mode when creating a StageChannel with Guild.create_stage_channel(). (#942)

• Add edit support for user_limit to StageChannel.edit(). (#942)

• Messages can now be sent within StageChannel instances. (#942)

  • StageChannel now inherits from abc.Messageable

  • New StageChannel properties:

    .nsfw, .slowmode_delay, .last_message_id, .last_message

  • New StageChannel methods:

    .is_nsfw, .get_partial_message, .delete_messages, .purge, .webhooks, .create_webhook

  • Add nsfw and slowmode_delay parameters to Guild.create_stage_channel() and CategoryChannel.create_stage_channel()

  • Add nsfw and slowmode_delay parameters to StageChannel.edit()

  • Add text related permission support to StageChannel.permissions_for().

• Cleanup general error raising to be less confusing. (#950)

  • Overall, most errors about incorrect types no longer include the internal error in their traceback.

• Add support for AutoModBlockMessageAction.custom_message (#954)

• Support comparison of VoiceRegion objects. (#962)

• [ext.commands] Add Bot.get_listeners(). (#976)

• Add ApplicationFlags.application_auto_moderation_rule_create_badge (#988)

Bug Fixes

• Fix VoiceClient not continuing to play audio when moving between channels. (#845)

• Fix KeepAlive logging un-intentionally attempting to interpolate stack trace logger calls (#940)

• Fix VoiceChannel.permissions_for() not disabling Permissions.manage_webhooks when the user cannot connect to the channel. (#942)

• RawTypingEvent.timestamp is now a timezone-aware datetime instead of a naive one. (#945)

• [ext.commands] Allow referencing the same ParamInfo instance in multiple signatures. (#946)

• Fix attribute error when attempting to access DMChannel.flags under certain circumstances. (#960)

• Fix voice connection discovery using incorrect packet sizes. (#967)

• Fix Guild.get_or_fetch_members() not caching anything in the case of 1 unresolved ID. (#974)

Documentation

• Update automod rule limits. (#931)

• [ext.commands] Fix commands extension events being duplicated in search results. (#944)

• Remove incorrect documentation for InvokableApplicationCommand.invoke(). (#961)

• Add a searchbox for filtering the sidebar on the API Reference pages. (#963)

Miscellaneous

• Change dependency and environment management to use pdm. (#836, #953)

  Please check CONTRIBUTING.md for more details.

• Change the main linter to ruff instead of flake8. (#935)

• Update Sphinx to v6.0.1. (#936)

• Support PyNaCl v1.5. (#968)

v2.8.1

Bug Fixes

• Fix VoiceClient not continuing to play audio when moving between channels. (#845)

• Fix KeepAlive logging un-intentionally attempting to interpolate stack trace logger calls (#940)

• Fix attribute error when attempting to access DMChannel.flags under certain circumstances. (#960)

• Fix voice connection discovery using incorrect packet sizes. (#967)

Documentation

• Update automod rule limits. (#931)

v2.8.0

This release comes with support for NSFW application commands, the on_audit_log_entry_create() event, and a new Event enum for use with methods like Client.wait_for().

Breaking Changes

• StickerPack.cover_sticker_id, .cover_sticker and .banner are now optional and may return None. (#912)

• AuditLogEntry.user may now be an Object if the user cannot be found, particularly in entries from the on_audit_log_entry_create() event. (#920)

New Features

• Add GuildBuilder and Client.guild_builder() for full coverage of the guild creation endpoint. (#578)

• Support regex within automod using AutoModTriggerMetadata.regex_patterns. (#794)

• Add File.closed and File.bytes_length properties. (#839)

• Add TextChannel.default_thread_slowmode_delay. (#854)

• Add support for NSFW application commands. (#865)

  • Add ApplicationCommand.nsfw.

  • Add nsfw parameter to command constructors and decorators.

• Add UserFlags.active_developer and PublicUserFlags.active_developer. (#866)

• Adds reasons/descriptions to ConnectionClosed errors. (#873)

• Update AutoModTriggerMetadata overloads to allow passing allow_list to keyword-based rules. (#877)

• The PublicUserFlags.discord_certified_moderator is now an alias of PublicUserFlags.moderator_programs_alumni. (#883)

• Add ForumChannel.default_layout, and default_layout parameter to channel edit methods. (#885, #903)

• Add Locale.id (Indonesian) locale. (#890)

• Adds Event enumeration to use in Client.wait_for(), disnake.ext.commands.Bot.wait_for() and in disnake.ext.commands.Bot.listen() decorator. (#895)

• Add new MessageType.interaction_premium_upsell and MessageType.guild_application_premium_subscription message types. (#905)

• Add application role connection features. (#906)

  • Add ApplicationRoleConnectionMetadata and ApplicationRoleConnectionMetadataType types.

  • Add Client.fetch_role_connection_metadata and Client.edit_role_connection_metadata methods.

  • Add RoleTags.is_linked_role and AppInfo.role_connections_verification_url attributes.

• Add StickerFormatType.gif. (#910)

• Add support for the on_audit_log_entry_create() gateway event, and add Intents.moderation intent. Intents.bans is now an alias of Intents.moderation. (#915)

• Add flags property to Member. (#918)

• Add fallback to Object for AuditLogEntry.user (#920)

Bug Fixes

• [ext.commands] Fix help_command parameter annotations to allow None value. (#849)

• Fix user cache memory leak where unused objects weren’t being evicted (provided that Intents.members is enabled). (#858)

• Fix Message.author.public_flags always being 0 when the member cache is disabled. (#870)

• Export missing ThreadWithMessage class. (#879)

• Add previously missing applied_tags parameter to all ForumChannel.create_thread() overloads. (#880)

• Fix conversion of custom emoji strings (e.g. <:this:934852112221872198>) in Message.add_reaction() and similar methods to more strictly adhere to the API documentation. (#887)

• Fix Client.delete_guild_command() not updating the local command cache. (#907)

• Fix errors when trying to deserialize stickers with unknown formats. (#911)

• Make StickerPack.cover_sticker_id, .cover_sticker and .banner optional. (#912)

• Fix handling of ECONNRESET errors on Linux. (#921)

Documentation

• Enable OpenSearch, allowing easy integration of the search functionality into browsers. (#859)

• Clarify types of optional Invite attributes. (#864)

• Remove documentation regarding private threads requiring boosts. (#872)

• Update AutoModTriggerMetadata field limits. (#877)

Miscellaneous

• Declare a PEP 517 build backend in pyproject.toml, and use PEP 621 to define most package metadata. (#830)

v2.7.2

Bug Fixes

• Fix VoiceClient not continuing to play audio when moving between channels. (#845)

• Fix KeepAlive logging un-intentionally attempting to interpolate stack trace logger calls (#940)

• Fix attribute error when attempting to access DMChannel.flags under certain circumstances. (#960)

• Fix voice connection discovery using incorrect packet sizes. (#967)

v2.7.1

Bug Fixes

• Fix Message.author.public_flags always being 0 when the member cache is disabled. (#870)

• Export missing ThreadWithMessage class. (#879)

• Fix Client.delete_guild_command() not updating the local command cache. (#907)

• Fix errors when trying to deserialize stickers with unknown formats. (#911)

v2.7.0

This release comes with support for python 3.11 and new selects.

Breaking Changes

• Properly document that Message.system_content may return None. While this is documented as a breaking change, this function always could return None if the message type was not recognised. (#766)

• Rename InteractionDataResolved.get() to get_by_id(). (#814)

Deprecations

• Rename ApplicationCommandInteractionDataResolved to InteractionDataResolved. (#814)

• [ext.commands] Deprecate the sync_commands, sync_commands_debug, and sync_commands_on_cog_unload parameters of Bot and InteractionBot. These have been replaced with the command_sync_flags parameter which takes a CommandSyncFlags instance. (#806)

New Features

• Update Message.system_content to be accurate to the client as of October 2022. (#766)

  • This also properly documents that it is possible to return None.

• Add type hints to all flag constructors, now supporting type-checking for creating flag classes (e.g. Intents(members=True)) which used to be untyped. (#778)

• Add GuildScheduledEvent.start(), .end and .cancel shortcuts. (#781)

• Support Python 3.11. (#785, #827, #829, #833)

• Improve the cli, allowing the usage of ext.commands.InteractionBot, ext.commands.AutoShardedInteractionBot. (#791)

• Add new select menu components. (#800, #803)

  • Add new ComponentType values.

  • Add UserSelectMenu, RoleSelectMenu, MentionableSelectMenu, ChannelSelectMenu components.

  • Add ui.UserSelect, ui.RoleSelect, ui.MentionableSelect, ui.ChannelSelect UI types.

  • Add ui.user_select(), ui.role_select(), ui.mentionable_select(), ui.channel_select() decorators.

  • Add ui.ActionRow.add_user_select(), add_role_select(), add_mentionable_select(), add_channel_select()

  • Renamed string select types for clarity (previous names will continue to work):

    • SelectMenu -> StringSelectMenu

    • ui.Select -> ui.StringSelect

    • ui.select() -> ui.string_select()

    • ui.ActionRow.add_select() -> ui.ActionRow.add_string_select()

  • Add MessageInteraction.resolved_values and MessageInteractionData.resolved.

• Support delete_after parameter when sending ephemeral interaction responses. (#816)

• Allow slowmode_delay parameter of ForumChannel.create_thread() to be optional. (#822)

• Add suppress_embeds parameter to Interaction.edit_original_response() and InteractionMessage.edit(). (#832)

• [ext.commands] Add CommandSyncFlags to provide sync configuration to Bot and InteractionBot (and their autosharded variants) as command_sync_flags. (#265, #433, #468, #806)

Bug Fixes

• Add the missing attributes for PermissionOverwrite: use_application_commands and use_embedded_activities. (#777)

• Ensure that embed fields are copied properly by Embed.copy() and that the copied embed is completely separate from the original one. (#792)

• Fix an issue with Member.ban() erroring when the delete_message_days parameter was provided. (#810)

• Try to get threads used in interactions (like threads in command arguments) from the cache first, before creating a new instance. (#814)

• Fix creation of threads in text channels without Permissions.manage_threads. (#818)

• Fix off-by-one error in AutoModKeywordPresets values. (#820)

• Update event loop handling to avoid warnings when running on Python 3.11. (#827)

• [ext.commands] Fix a case where optional variadic arguments could have infinite loops in parsing depending on the user input. (#825)

Documentation

• Speed up page load by changing hoverxref tooltips to be lazily loaded. (#393)

• Remove reference to the v1.0 migration guide from the main index page, and move legacy changelogs to a separate page. (#697)

• Update sphinx from version 5.1 to 5.3. (#764, #821)

• Add a note warning mentioning that using a disnake.File object as file kwarg makes a disnake.Embed not reusable. (#786)

• Update broken Discord API Docs links, add :ddocs: role for easily creating links to the API documentation. (#793)

• Add a custom 404 page for when the navigated page does not exist. (#797)

Miscellaneous

• Increase the upper bound for the aiohttp dependency from <3.9 to <4. (#789)

• Use importlib.metadata instead of the deprecated pkg_resources in the cli for displaying the version. (#791)

• [ext.commands] Add missing py.typed marker. (#784)

• [ext.tasks] Add missing py.typed marker. (#784)

v2.6.3

This maintainence release contains backports from v2.8.0.

Bug Fixes

• Fix Message.author.public_flags always being 0 when the member cache is disabled. (#870)

• Export missing ThreadWithMessage class. (#879)

• Fix Client.delete_guild_command() not updating the local command cache. (#907)

• Fix errors when trying to deserialize stickers with unknown formats. (#911)

v2.6.2

This maintainence release contains backports from v2.7.0.

Bug Fixes

• Fix creation of threads in text channels without Permissions.manage_threads. (#818)

• Fix off-by-one error in AutoModKeywordPresets values. (#820)

• [ext.commands] Fix a case where optional variadic arguments could have infinite loops in parsing depending on the user input. (#825)

v2.6.1

This maintainence release contains backports from v2.7.0.

Bug Fixes

• Ensure that embed fields are copied properly by Embed.copy() and that the copied embed is completely separate from the original one. (#792)

• Fix an issue with Member.ban() erroring when the delete_message_days parameter was provided. (#810)

v2.6.0

This release adds support for new forum channel features (like tags) as well as auto moderation, among other things. See below for more.

Also note the breaking changes listed below, which may require additional code changes.

Breaking Changes

• Update Client classes such that their initialization kwargs are explicitly stated and typehinted. (#371)

  • Replaced **kwargs / **options with explicit keyword arguments for the __init__ methods of Client, ext.commands.Bot, ext.commands.InteractionBot, all AutoSharded* variants, and all relevant parent classes.

• Call new disnake.on_gateway_error() instead of letting exceptions propagate that occurred while deserializing a received gateway event. (#401)

• Rework Embed internals. (#435)

  • Embed.set_footer() now requires the text parameter.

  • Embed.type is now optional, although this could previously be Embed.Empty.

  • EmptyEmbed and Embed.Empty are deprecated in favor of None, have been removed from the documentation, and will result in type-checking errors.

• Refactor ui.ActionRow with complete typings. (#462)

  • ui.ActionRow.children now returns an immutable Sequence instead of a list.

• Remove InvalidArgument and replace it with TypeError and ValueError. (#471)

• Rename channel_id parameter to channel on Guild.create_scheduled_event and GuildScheduledEvent.edit(). (#548, #590)

• Raise TypeError instead of ValueError in GuildScheduledEvent validation. (#560)

• Assume the local timezone instead of UTC when providing naive datetimes to scheduled event related methods. (#579)

• Update ModalInteraction typings. (#583)

  • ModalInteraction.walk_components is replaced by ModalInteraction.walk_raw_components().

• Change the default of the ignore_timeout parameter for all permissions_for methods to False. (#672)

• Update activity attributes to match API types. (#685)

  • Make Spotify.start, Spotify.end, Spotify.duration optional.

  • Remove Activity.timestamps, values are accessible through Activity.start, Activity.end.

  • Change type of Activity.buttons to List[str].

• Remove WidgetMember.nick; WidgetMember.name contains the member’s nickname, if set. (#736)

• [ext.commands] Change has_permissions and bot_has_permissions checks to take timeouts into consideration. (#318, #672)

• [ext.commands] Change commands.register_injection to now return an instance of Injection. (#669)

• [ext.commands] Changed parameters of SubCommand and SubCommandGroup to now require their parent command. (#759)

  • This only affects code that creates an instance of SubCommand or SubCommandGroup manually by calling their constructors.

• [ext.tasks] Change ext.tasks.Loop to use keyword-only parameters. (#655)

Deprecations

• EmptyEmbed and Embed.Empty are deprecated in favor of None, have been removed from the documentation, and will result in type-checking errors. (#435, #768)

• The delete_message_days parameter of Guild.ban() and Member.ban() is deprecated in favour of clean_history_duration. (#659)

• [ext.commands] Using command_prefix=None with Bot is now deprecated in favour of InteractionBot. (#689)

New Features

• Add custom type support for disnake.ui.button() and disnake.ui.select() decorators using cls parameter. (#281)

• Add disnake.on_gateway_error(), Client.on_gateway_error() and enable_gateway_error_handler client parameter. (#401)

• Update channel edit method annotations. (#418)

  • slowmode_delay and default_auto_archive_duration are now optional.

  • category may now be any abc.Snowflake, not necessarily a CategoryChannel.

• Add new ui.ActionRow methods: insert_item(), clear_items(), remove_item(), pop(), as well as an index parameter for add_button(). (#462)

  • Also support item access/deletion through row[i].

• Expose the icon and recipient data for Invites whose target is a channel of type ChannelType.group. (#498)

• Implement auto moderation. (#530, #698, #757)

  • New types: AutoModAction, AutoModTriggerMetadata, AutoModRule, AutoModActionExecution

  • New enums: AutoModTriggerType, AutoModEventType, AutoModActionType

  • New flags: AutoModKeywordPresets

  • New methods: Guild.create_automod_rule(), Guild.fetch_automod_rule(), Guild.fetch_automod_rules()

  • New intents: Intents.automod_configuration, Intents.automod_execution (+ Intents.automod shortcut for both)

  • New events: on_automod_rule_create(), on_automod_rule_update(), on_automod_rule_delete(), on_automod_action_execution()

  • + all the relevant AuditLogEntry and AuditLogChanges fields.

• Expose additional provided objects by Discord in audit log handling. (#532)

  • Also adds PartialIntegration, and an integration attribute on AuditLogEntry.extra when the type is AuditLogAction.application_command_permission_update.

• Add Webhook.application_id for accessing the ID of the app that created the webhook, if any. (#534)

• Use SessionStartLimit.remaining when attempting to connect to Discord. (#537)

  • Now raises SessionStartLimitReached if there are not enough remaining starts to start the client.

• Add multiple converters for previously undocumented fields for audit logs. (#546)

  AuditLogDiff can now have the following attributes with the specified types:

  • flags — ChannelFlags

  • system_channel_flags — SystemChannelFlags

  AuditLogDiff.unicode_emoji, used for role icons, was renamed to AuditLogDiff.emoji.

• Implement ChannelFlags on all channel types. (#547)

• Make all *InteractionData dataclasses dicts (MessageInteractionData, ApplicationCommandInteractionData, and so on). (#549)

• Add support for Webhook in ForumChannel instances. (#550)

• Add GuildScheduledEvent.created_at and GuildScheduledEvent.url properties. (#561)

• Add the Embed.check_limits() method to check if an Embed would be rejected from Discord. (#567)

• Add bitrate parameter to Guild.create_stage_channel(). (#571)

• Add Guild.edit_mfa_level() for modifying the guild’s MFA level. (#574)

• Add the slowmode_delay parameter to Guild.create_voice_channel(). (#582)

• Add ModalInteractionData.components. (#583)

• Add the Interaction.app_permissions property, which shows the app permissions in the channel. (#586)

• Allow entity_type parameter Guild.create_scheduled_event to be missing. (#590)

• Add min_length and max_length support to Option and ext.commands.Param. (#593)

• Add AllowedMentions.from_message for constructing an allowed mentions object from a Message. (#603)

• Add support of more operators to all Flag classes. This list includes Intents and Permissions. (#605, #615, #616)

  • &, |, ^, and ~ bitwise operator support.

  • <, <=, >, and >= comparsion operator support.

  • Support | operators between flag instances and flag values.

  • Support ~ operator on flag values, which create a flag instance with all except this specific flag enabled.

  • Support | operators between flag values which create a flag instance with both flag values enabled.

• Support passing raw integer value to Intents constructor. (#613)

• Add GuildScheduledEventStatus.cancelled as an alias for canceled. (#630)

• Add on_raw_member_remove() and on_raw_member_update() events, with the RawGuildMemberRemoveEvent model. (#638)

• Add Thread.message_count, Thread.total_message_sent and Message.position attributes. (#640)

• Add support for setting ChannelFlags directly when editing a channel or thread. (#642)

• Add ApplicationFlags.application_command_badge flag which shows whether an application has at least one globally registered application command. (#649)

• Add support for Interaction.data which guarantees that every subclass of Interaction has the data attribute. (#654)

• Add clean_history_duration parameter to Guild.ban() and Member.ban(). (#659)

• Add Game.assets. (#685)

• Add permission typings to all methods that take permissions directly, for example disnake.abc.GuildChannel.set_permissions() and disnake.ext.commands.bot_has_permissions() to name a few. (#708)

• Add GatewayParams for configuring gateway connection parameters (e.g. disabling compression). (#709)

• Add resume_gateway_url handling to gateway/websocket resume flow. (#709, #769)

• Add support for modifying the INVITES_DISABLED guild feature using Guild.edit(). (#718)

• Implement remaining forum channel features. (#724)

  • Add ForumTag dataclass.

  • Add ForumChannel.available_tags and Thread.applied_tags.

  • Add ForumChannel.get_tag(), ForumChannel.get_tag_by_name(), Thread.add_tags() and Thread.remove_tags().

  • Add ForumChannel.default_thread_slowmode_delay, ForumChannel.default_reaction, and ForumChannel.default_sort_order.

  • Add ChannelFlags.require_tag and ForumChannel.requires_tag.

  • New audit log fields for the above features.

• Add BotIntegration.scopes. (#729)

• Return the disnake.ui.View instance from View.add_item, View.remove_item and View.clear_items to allow for fluent-style chaining. (#733)

• Add Widget.presence_count. (#736)

• Add InteractionResponse.type, which contains the type of the response made, if any. (#737)

• Add aliases to the original_message methods. (#738)

  • Interaction.original_response() is aliased to Interaction.original_message()

  • Interaction.edit_original_response() is aliased to Interaction.edit_original_message()

  • Interaction.delete_original_response() is aliased to Interaction.delete_original_message()

• Change ForumChannel.create_thread() to not require the content parameter to be provided. (#739)

  • Like TextChannel.send(), at least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

• Return the disnake.ui.ActionRow instance on multiple methods to allow for fluent-style chaining. (#740)

  • This applies to ActionRow.append_item, ActionRow.insert_item, ActionRow.add_button, ActionRow.add_select, ActionRow.add_text_input, ActionRow.clear_items, and ActionRow.remove_item.

• Add support for equality checks between two disnake.Embeds. (#742)

• Add Permissions.use_embedded_activities as an alias for Permissions.start_embedded_activities. (#754)

• Add Permissions.use_application_commands as an alias for Permissions.use_slash_commands. (#755)

• Support setting with_message parameter of InteractionResponse.defer for modal interactions to False. (#758)

• [ext.commands] Add a way to get the parent or root commands of slash commands. (#277)

  • Add InvokableSlashCommand.parent, SubCommandGroup.parent, and SubCommand.parent.

  • Add InvokableSlashCommand.parents, SubCommandGroup.parents, and SubCommand.parents.

  • Add InvokableSlashCommand.root_parent, SubCommandGroup.root_parent, and SubCommand.root_parent.

• [ext.commands] Introduce commands.String for defining string option length limitations. (#593)

• [ext.commands] Add support for Union[User, Role] and Union[User, Member, Role] annotations in slash commands. (#595)

• [ext.commands] Add support for injected parameters autocompletion (#670)

  • Add Injection.autocomplete decorator

  • Add injection as a decorator interface for inject

  • Add autocompleters keyword-only argument to Injection, inject, and register_injection

• [ext.tasks] Add support for subclassing ext.tasks.Loop and using subclasses in ext.tasks.loop() decorator. (#655)

Bug Fixes

• Update incorrect channel edit method annotations. (#418)

  • Fix sync_permissions parameter type.

  • Remove topic parameter from StageChannel.edit(), add bitrate.

• Properly close sockets when receiving a voice server update event. (#488)

• Warn the user that bools are not supported for default_member_permissions. (#520)

• Update the Guild Iterator to not get stuck in an infinite loop. (#526)

  • Add a missing import for the scheduled event user iterator.

• Change the default guild GuildSticker limit to 5. (#531)

• Handle optional Locale instances (no longer create an enum value). (#533)

• Update the type field handling for audit logs. (#535)

  • AuditLogDiff.type objects are no longer always ChannelType instances.

• Dispatch disnake.on_reaction_remove() for Thread instances. (#536)

• Update Guild.bitrate_limit to use the correct value for the VIP_REGIONS feature flag. (#538)

• Handle ThreadAutoArchiveDuration instances for default_auto_archive_duration when editing channels. (#568)

• Assume that None is an empty channel name and keep channel.name a string. (#569)

• Remove the $ prefix from IDENTIFY payload properties. (#572)

• Replace old application command objects in cogs with the new/copied objects. (#575)

• Fix opus function calls on arm64 macOS. (#620)

• Improve channel/guild fallback in resolved interaction data, using PartialMessageable for unhandled/unknown channels instead of using None. (#646)

• Check the type of the provided parameter when validating names to improve end-user errors when passing an incorrect object to slash command and option names. (#653)

• Make the ext.commands.default_member_permissions() decorator always work in cogs. (#678)

• Fix Spotify.start, Spotify.end, Spotify.duration raising KeyError instead of returning None, improve activity typing. (#685)

• Fixes message initialization failing with threads and no intents by explicitly checking we have a guild object where one is required. (#699, #712)

• Fixed an issue where it would be possible to remove other features when enabling or disabling the COMMUNITY feature for a Guild. (#705)

• Fix invalid widget fields. (#736)

  • Widget.invite_url and Widget.fetch_invite are now optional.

  • WidgetMember.avatar and WidgetMember.activity now work properly and no longer always raise an exception or return None.

• No longer use deprecated @! syntax for mentioning users. (#743)

• Fix creation of forum threads without Permissions.manage_threads. (#746)

• Don’t count initial message in forum threads towards Thread.message_count and Thread.total_message_sent. (#747)

• [ext.commands] Handle VoiceChannel in commands.is_nsfw(). (#536)

• [ext.commands] Handle Union[User, Member] annotations on slash commands arguments when using the decorator interface. (#584)

• [ext.commands] Change has_permissions and bot_has_permissions checks to work with interations in guilds that only added the applications.commands scope, and in DMs. (#673)

• [ext.commands] Fix edge case with parsing command annotations that contain a union of non-type objects, like Optional[Literal[1, 2, 3]]. (#770)

Documentation

• Add sidebar-navigable sub-sections to Event Reference section of API Reference documentation. (#460)

• Remove notes that global application command rollout takes up to an hour. (#518)

• Update sphinx from 4.4.0 to version 5.1, and take advantage of new options. (#522, #565)

• Update the requests intersphinx url to the new url of the requests documentation. (#539)

• Build an htmlzip version of the documentation for downloading. (#541)

• Fix broken Range references. (#542)

• Expand and complete the attribute documentation for AuditLogDiff. (#546)

• Add note about currently required client override for slash localisations. (#553)

• Restructure the examples/ directory, and update + clean up all examples. (#562, #716)

• Clarify vanity invite handling in Guild.invites. (#576)

• Clarify the targets of Permissions.is_strict_subset() and Permissions.is_strict_superset(). (#612)

• Clarify when the user is a Member or a User in disnake.on_member_ban() events. (#623)

• Update InteractionReference.name description, now includes group and subcommand. (#625, #648)

• Note that Interaction.channel may be a PartialMessageable in inaccessible threads, in addition to DMs. (#632)

• Fix the grammatical errors in Guild channel properties. (#645)

• Update fields listed in on_user_update() and on_member_update() docs. (#671)

• Add previously missing inherited attributes to activity types. (#685)

• Add documentation for the strict parameter to Client.get_or_fetch_user() and Guild.get_or_fetch_member(). (#710)

• Remove note about application command localization requiring a client build override. (#711)

• Change references to public guilds to reference the COMMUNITY feature instead. (#720)

• Clarify Thread.delete() criteria for threads in forum channels. (#745)

• Clarify behavior of kwargs in flag methods when both a flag and an alias are given. (#749)

• [ext.commands] Document the i18n attribute on ext.commands.Bot and ext.commands.InteractionBot classes. (#652)

• [ext.commands] Document commands.Injection. (#669)

• [ext.commands] Improve documentation around using None for Bot.command_prefix. (#689)

Miscellaneous

• Refactor the test bot to be easier to use for all users. (#247)

• Refactor channel edit overloads and internals, improving typing. (#418)

• Run pyright on examples and fix any typing issues uncovered by this change. (#519)

• Add initial testing framework. (#529)

• Explicitly type activity types with literal return values. (#543)

• Explicitly type channel types with literal return values. (#543)

• Update PyPI url and minor wording in the README. (#556)

• Add flake8 as our linter. (#557)

• Update pyright to 1.1.254. (#559)

• Add generic parameters to user/message command decorators. (#563)

  • Update default parameter type to improve compatibilty with callable/dynamic defaults.

• Run docs creation in GitHub actions to test for warnings before a pull is merged. (#564)

• Add more typing overrides to GuildCommandInteraction. (#580)

• Rework internal typings for interaction payloads. (#588)

• Add typings for all gateway payloads. (#594)

• Add towncrier and sphinxcontrib-towncrier to manage changelogs. (#600)

  • Use towncrier for changelog management.

  • Use sphinxcontrib-towncrier to build changelogs for the in-development documentation.

• Expand contributing documentation to include more information on creating pull requests and writing features. (#601)

• Add flake8-comprehensions for catching inefficient comphrehensions. (#602)

• Resolve minor flake8 issues. (#606)

  • Don’t use star imports except in __init__.py files.

  • Don’t use ambigious variable names.

  • Don’t use setattr and getattr with constant variable names.

• Add flake8-pytest-style for linting pytest specific features with flake8. (#608)

• Replace all TypeVar instances with typing_extensions.Self across the entire library where possible. (#610)

• Remove the internal fill_with_flags decorator for flags classes and use the built in object.__init_subclass__() method. (#616, #660)

• Add slice to ui.ActionRow __getattr__ and __delattr__ annotations. (#624)

• Update and standardise all internal Snowflake regexes to match between 17 and 19 characters (inclusive). (#651)

• Rename internal module disnake.ext.commands.flags to disnake.ext.commands.flag_converter. (#667)

• Improve parallel documentation build speed. (#690)

• Limit installation of cchardet in the [speed] extra to Python versions below 3.10 (see aiohttp#6857). (#702)

• Update annotation and description of options parameter of ui.ActionRow.add_select to match ui.Select. (#744)

• Update typings to explicitly specify optional types for parameters with a None default. (#751)

• Adopt SPDX License Headers across all project files. (#756)

v2.5.3

This is a maintenance release with backports from v2.6.0.

Bug Fixes

• Fix creation of forum threads without Permissions.manage_threads. (#746)

• [ext.commands] Fix edge case with parsing command annotations that contain a union of non-type objects, like Optional[Literal[1, 2, 3]]. (#771)

Miscellaneous

• Limit installation of cchardet in the [speed] extra to Python versions below 3.10 (see aiohttp#6857). (#772)

v2.5.2

This release is a bugfix release with backports from upto v2.6.0.

Bug Fixes

• Warn the user that bools are not supported for default_member_permissions. (#520)

• Update the Guild Iterator to not get stuck in an infinite loop. (#526)

  • Add a missing import for the scheduled event user iterator.

• Change the default guild GuildSticker limit to 5. (#531)

• Handle optional Locale instances (no longer create an enum value). (#533)

• [ext.commands] Handle VoiceChannel in commands.is_nsfw(). (#536)

• Dispatch disnake.on_reaction_remove() for Thread instances. (#536)

• Update Guild.bitrate_limit to use the correct value for the VIP_REGIONS feature flag. (#538)

• Make all *InteractionData dataclasses dicts (MessageInteractionData, ApplicationCommandInteractionData, and so on). (#549)

• Handle ThreadAutoArchiveDuration instances for default_auto_archive_duration when editing channels. (#568)

• Assume that None is an empty channel name and keep channel.name a string. (#569)

• Remove the $ prefix from IDENTIFY payload properties. (#572)

• Replace old application command objects in cogs with the new/copied objects. (#575)

• [ext.commands] Handle Union[User, Member] annotations on slash commands arguments when using the decorator interface. (#584)

• Fix opus function calls on arm64 macOS. (#620)

• Improve channel/guild fallback in resolved interaction data, using PartialMessageable for unhandled/unknown channels instead of using None. (#646)

Documentation

• Remove notes that global application command rollout takes up to an hour. (#518)

• Update the requests intersphinx url to the new url of the requests documentation. (#539)

• Clarify the targets of Permissions.is_strict_subset() and Permissions.is_strict_superset(). (#612)

• Update InteractionReference.name description, now includes group and subcommand. (#625, #648)

v2.5.1

Bug Fixes

• [ext.commands] Fix autocomplete() decorator in cogs (#521)

v2.5.0

This version adds support for API v10 (which comes with a few breaking changes), forum channels, localizations, permissions v2, improves API coverage by adding support for previously missing features like guild previews, widgets, or welcome screens, and contains several miscellaneous enhancements and bugfixes.

Regarding the message content intent: Note that earlier versions will continue working fine after the message content intent deadline (August 31st 2022), as long as the intent is enabled in the developer portal. However, from this version (2.5.0) onward, the intent needs to be enabled in the developer portal and your code. See this page of the guide for more information. If you do not have access to the intent yet, you can temporarily continue using API v9 by calling disnake.http._workaround_set_api_version(9) before connecting, which will keep sending message content before the intent deadline, even with the intent disabled.

Breaking Changes

• The message_content intent is now required to receive message content and related fields, see above (#353)

• The new permissions v2 system revamped application command permissions, with the most notable changes being the removal of default_permission and commands.guild_permissions in favor of new fields/methods - see below for all new changes (#405)

• TextChannel.create_thread() now requires either a message or a type parameter (#355)

• GuildScheduledEvent.fetch_users() and Guild.bans() now return an async iterator instead of a list of users (#428, #442)

• Guild.audit_logs() no longer supports the oldest_first parameter (#473)

• Store channels have been removed as they’re not supported by Discord any longer (#438)

• on_thread_join() will no longer be invoked when a new thread is created, see on_thread_create() (#445)

• The voice region enum was replaced with a generic VoiceRegion data class (#477)

• locale attributes are now of type Locale instead of str (#439)

• Invite.revoked and Thread.archiver_id have been removed (deprecated in 2.4) (#455)

• Slash command names and option names are no longer automatically converted to lowercase, an InvalidArgument exception is now raised instead (#422)

• The interaction parameter of ui.Item.callback() can no longer be passed as a kwarg (#311)

• The youtube, awkword and sketchy_artist PartyTypes no longer work and have been removed (#408, #409)

• Trying to defer an interaction response that does not support deferring (e.g. autocomplete) will now raise a TypeError (#505)

• [ext.commands] Failure to convert an input parameter annotated as LargeInt now raises a LargeIntConversionFailure (#362)

Deprecations

• Public stages and stage discoverability are deprecated and no longer supported (#287)

• Voice regions on guild level are deprecated and no longer have any effect; they should be set on a per-channel basis instead (#357, #374)

• Guild.create_integration(), Integration.delete(), StreamIntegration.edit() and StreamIntegration.sync() can’t be used by bots anymore and will be removed in a future version (#361)

• AppInfo.summary, PartialAppInfo.summary and IntegrationApplication.summary are deprecated, use .description instead (#369)

• The suppress parameter for edit methods has been deprecated in favor of suppress_embeds, with unchanged functionality (#474)

New Features

• Support API v10 (#353)

  • New intent: Intents.message_content

  • [ext.commands] New warning: MessageContentPrefixWarning

• Add forum channels (#448, #479, #504, #512)

  • Add ForumChannel

  • Add CategoryChannel.forum_channels, Guild.forum_channels

  • Add CategoryChannel.create_forum_channel, Guild.create_forum_channel

  • Add ChannelFlags, Thread.flags, Thread.is_pinned

  • Add pinned parameter to Thread.edit()

  • Add Permissions.create_forum_threads, alias of send_messages

  • [ext.commands] Add ForumChannelConverter

• Add application command localizations, see Localizations (#269)

  • Add Localized, LocalizationProtocol, LocalizationStore

  • Most name and description parameters now also accept a Localized object

  • Update docstring parsing to accommodate for localizations

  • Add Client.i18n

  • Add localization_provider and strict_localization parameters to Client

  • Add with_localizations parameter to Client.fetch_global_commands(), Client.fetch_guild_commands()

  • Add LocalizationWarning, LocalizationKeyError

  • Add utils.as_valid_locale()

  • Add localization example

• Support permissions v2, see Permissions (#405)

  • Breaking changes:

    • Remove support for default_permission

    • Remove GuildApplicationCommandPermissions.edit(), PartialGuildApplicationCommandPermissions, UnresolvedGuildApplicationCommandPermissions

    • Remove Client.edit_command_permissions(), Client.bulk_edit_command_permissions(), Client.edit_command_permissions(), Client.edit_command_permissions()

    • Remove Guild.get_command_permissions(), Guild.edit_command_permissions(), Guild.bulk_edit_command_permissions()

    • Update behavior of GuildCommandInteraction annotation to automatically set dm_permission=False instead of adding a local check, remove support for subcommands

    • Add ApplicationCommandPermissionType enum, change type of ApplicationCommandPermissions.type to support channel targets

    • [ext.commands] Remove guild_permissions() decorator

    • [ext.commands] Remove sync_permissions parameter from Bot

  • New features:

    • Add dm_permission and default_member_permissions parameters to application command objects and decorators

    • Add dm_permission, default_member_permissions attributes to ApplicationCommand and InvokableApplicationCommand

    • Add ApplicationCommandPermissions.is_everyone() and ApplicationCommandPermissions.is_all_channels()

    • Add AuditLogAction.application_command_permission_update enum value and AuditLogDiff.command_permissions

    • Add on_application_command_permissions_update() event

    • [ext.commands] Add default_member_permissions() decorator, alternative to identically named parameter

• Add guild previews (#359)

  • Add GuildPreview

  • Add Client.fetch_guild_preview()

• Add guild widget settings and widget url (#360, #365)

  • Add WidgetSettings, WidgetStyle

  • Add Guild.widget_settings(), Guild.widget_image_url()

  • Add Widget.image_url()

  • Change Guild.edit_widget() return type

• Add guild welcome screens (#339)

  • Add WelcomeScreen, WelcomeScreenChannel

  • Add Guild.welcome_screen(), Guild.edit_welcome_screen()

  • Add Invite.guild_welcome_screen

• Support List[str] and Dict[str, str] in option parameter of disnake.ui.Select (#326)

• Add Guild.search_members() (#358, #388)

• Add ModalInteraction.message (#363, #400)

• Support InteractionResponse.edit_message() for modal interactions, if modal was sent in response to component interaction (#364, #400)

• Support reason parameter in Message.create_thread() and Thread.delete() (#366)

• Add StageInstance.guild_scheduled_event and StageInstance.guild_scheduled_event_id (#394)

• Add SessionStartLimit and Client.session_start_limit (#402)

• Add PartialInviteGuild.premium_subscription_count (#410)

• Allow passing asset types for most image parameters, in addition to bytes (#415)

• Update GuildScheduledEvent.fetch_users() and Guild.bans() to be async iterators supporting pagination (#428, #442)

• Add AuditLogDiff.image for scheduled event images (#432)

• Add Locale enum (#439)

• Add notify_everyone parameter to StageChannel.create_instance() (#440)

• Add to_file() method to assets, emojis, stickers (#443, #475)

• Add on_thread_create() event (#445)

• Support reason parameter in Thread.edit() (#454)

• Add default_auto_archive_duration parameter to Guild.create_text_channel(), add nsfw parameter to Guild.create_voice_channel() (#456)

• Allow providing attachments=None to clear attachments when editing a message (#457)

• Add __repr__ methods to interaction data types (#458)

• Add VoiceChannel.delete_messages(), VoiceChannel.purge(), VoiceChannel.webhooks(), VoiceChannel.create_webhook(), and improve VoiceChannel.permissions_for() (#461)

• Add AppInfo.tags, AppInfo.install_params, AppInfo.custom_install_url (#463)

• Add TextChannel.last_pin_timestamp, DMChannel.last_pin_timestamp, Thread.last_pin_timestamp (#464)

• Add MessageType.auto_moderation_action (#465)

• Add temporary workaround for setting API version to avoid message content intent requirement until deadline (#467)

• Add Interaction.expires_at and Interaction.is_expired, automatically fall back to message edit/delete if interaction expired (#469)

• Add suppress_embeds parameter to message send methods (#474)

• Add VoiceRegion (replacing voice region enum), Client.fetch_voice_regions(), Guild.fetch_voice_regions() (#477)

• Add Member.role_icon property (#485)

• Add debug logging of webhook request/response data (#486)

• Add on_raw_thread_delete(), on_raw_thread_member_remove() and on_raw_thread_update() events (#495)

• Support creating news channels using Guild.create_text_channel() (#497)

• Add Guild.vanity_url_code, add option to Guild.vanity_invite() to use cached invite code (#502)

• Add Message.application_id (#513)

• [ext.commands] Add GuildScheduledEventConverter and GuildScheduledEventNotFound (#376)

• [ext.commands] Add extras to application commands (#483)

• [ext.commands] Add slash_command_attrs, user_command_attrs and message_command_attrs Cog parameters (#501)

Bug Fixes

• Improve components exception message (#352)

• Use proper HTTP method for joining threads, remove unused methods (#356)

• Fix missing create_public_threads permission in Permissions.private_channel (#373)

• Ensure token is of type str (#375)

• Improve abc.Messageable.send() typing and fix annotations of HTTP methods (#378)

• Fix shadowed disnake.message module (#380)

• Fix missing/incorrect __slots__ (#381)

• Fix PartialInviteChannel.__str__ (#383)

• Fix role icon/emoji editing (#403)

• Remove cached scheduled events if associated channel was deleted (#406)

• Update some types/parameters of roles, scheduled events and voice states (#407)

• Allow content parameters in send/edit methods to be positional (#411)

• Fix gateway ratelimiter being too strict (#413)

• Fix caching of stage instances andd scheduled events (#416)

• Fix memory leaks on shard reconnect (#424, #425)

• Improve PartialMessageable channel handling (#426)

• Use asyncio.iscoroutinefunction() instead of inspect.iscoroutinefunction() (#427)

• Fix read() for activity emojis (#430)

• Don’t automatically enable logging if autoreload is enabled (#431)

• Support embed images in InteractionResponse.edit_message() (#466)

• Fix after parameter of Guild.audit_logs() (#473)

• Add __str__ to ApplicationCommand, improve sync debug output (#478)

• Don’t require a topic when creating a stage channel (#480)

• Update and add missing overloads (#482)

• Make disnake.types.interactions importable at runtime (#493)

• Raise TypeError instead of silently returning when trying to defer an unsupported interaction type (#505)

• Fix delay of after callback in AudioPlayer when stopping (#508)

• [ext.commands] Make conversion exceptions in slash commands propagate cleanly as documented (#362)

• [ext.commands] Fix clean_content converter (#396)

• [ext.commands] Fix usage of custom converters with Param (#398)

• [ext.commands] Support interactions in UserConverter, MemberConverter (#429)

• [ext.commands] Fix unloading of listeners with custom names (#444)

• [ext.commands] Fix parameter name conflicts in slash commands (#503)

Documentation

• Disable mathjax in documentation to improve loading times (#370)

• Update return type of Guild.create_template() (#372)

• Add documentation for GuildCommandInteraction, UserCommandInteraction, and MessageCommandInteraction (#374)

• Fix several bugs of redesign (#377)

• Update broken references (#419)

• Fix duplicate search results, improve scoring (#423)

• Add search hotkeys ctrl+k, /, s (#434)

• Fix string escape warnings (#436)

• Add several previously missing documentation entries (#446, #470)

• Add autocomplete decorator example (#472)

• Update docs of ABCs to mention subclasses (#506)

• Update on_member_update() documentation to include new and future attributes (#510)

• Fix miscellaneous issues, improve formatting (#511)

Miscellaneous

• Fix remaining pyright issues, add pyright CI (#311, #387, #514)

• Update dev dependencies and CI (#345, #386, #451)

• Improve _WebhookState typing (#391)

• Improve basic_bot.py example (#399)

• Add low-level component example (#452)

• Update Discord server invite links (#476)

v2.4.1

This release is a bugfix release with backports from v2.5.0 up to v2.5.2.

Bug Fixes

• Fix missing create_public_threads permission in Permissions.private_channel (#373)

• Fix PartialInviteChannel.__str__ (#383)

• Fix role icon/emoji editing (#403)

• Remove cached scheduled events if associated channel was deleted (#406)

• Update some types/parameters of roles, scheduled events and voice states (#407)

• Allow content parameters in send/edit methods to be positional (#411)

• Fix gateway ratelimiter being too strict (#413)

• Fix caching of stage instances andd scheduled events (#416)

• Fix memory leaks on shard reconnect (#424, #425)

• Improve PartialMessageable channel handling (#426)

• Fix read() for activity emojis (#430)

• Fix delay of after callback in AudioPlayer when stopping (#508)

• Change the default guild GuildSticker limit to 5. (#531)

• Dispatch disnake.on_reaction_remove() for Thread instances. (#536)

• Update Guild.bitrate_limit to use the correct value for the VIP_REGIONS feature flag. (#538)

• Remove the $ prefix from IDENTIFY payload properties. (#572)

• Fix opus function calls on arm64 macOS. (#620)

• Improve channel/guild fallback in resolved interaction data, using PartialMessageable for unhandled/unknown channels instead of using None. (#646)

• [ext.commands] Fix clean_content converter (#396)

• [ext.commands] Support interactions in UserConverter, MemberConverter (#429)

• [ext.commands] Fix unloading of listeners with custom names (#444)

• [ext.commands] Handle VoiceChannel in commands.is_nsfw(). (#536)

Documentation

• Update the requests intersphinx url to the new url of the requests documentation. (#539)

Miscellaneous

• Update dev dependencies and CI (#451)

v2.4.0

This version contains many new features, including attachment options, modals, and the ability to directly send message components without views, as well as several fixes and other general improvements.

Breaking Changes

• The constructor of ApplicationCommand and its subtypes no longer accepts **kwargs for setting internal values (#249)

  • This shouldn’t affect anyone, as **kwargs was only used for setting fields returned by the API and had no effect if the user set them

• Interaction.permissions now returns proper permission values in DMs (#321)

• The reason parameter for sticker endpoints in HTTPClient is now kwarg-only

Deprecations

• Thread.archiver_id is not being provided by the API anymore and will be removed in a future version (#295)

• Invite.revoked is not being provided by the API anymore and will be removed in a future version (#309)

New Features

• Add Interaction.locale and Interaction.guild_locale properties to interactions (#225)

• Add ui.ActionRow and components kwarg to send methods (#224)

• Add ui.WrappedComponent as a base class for all UI components (#253)

  • ui.Item now inherits from ui.WrappedComponent. It’s no longer a base class for all UI components.

• Implement modals and text inputs (#253)

  • Add TextInput component.

  • Add ui.Modal as a high-level implementation of modals.

  • Add ui.TextInput for modals. It inherits from ui.WrappedComponent and adds more functionality on top of TextInput.

  • Add InteractionResponse.send_modal() to support new interaction response type.

  • Add on_modal_submit() event.

• Add MessageFlags.failed_to_mention_roles_in_thread (#238)

• Use logger for application command sync debug (#230)

• [ext.commands] Improve application command sync algorithm (#240)

• Use HTTP API v9 (#250)

• [ext.commands] Add commands.Range, see Number Ranges (#237, #276, #316)

• [ext.commands] Add Bot.load_extensions and utils.search_directory() (#245)

• [ext.commands] Add commands.LargeInt (#264)

• Add with_message parameter to InteractionResponse.defer() to support deferring component interaction responses with messages (#248)

• Add Widget.edit() (#266)

• Add the ability to specify a default color for embeds (#203)

• Add PartialInviteGuild.nsfw_level and PartialInviteGuild.vanity_url_code (#297)

• Add Thread.create_timestamp (#285)

• Add Message.thread (#291)

• Add Permissions.events and Permissions.private_channel, improve existing factory methods (#286, #321)

• Support images in GuildScheduledEvent (#280)

• Add PartyType.sketch_heads and PartyType.ocho (#306)

• Support Thread annotations in slash commands (#305)

• Interaction.bot, Interaction.client, Interaction.channel and Interaction.channel_id are no longer optional (#279)

• Support timeouts in abc.GuildChannel.permissions_for() and other channel types (#289)

• Support disnake.Attachment options in slash commands (#226)

• Add attachments parameter to InteractionResponse.edit_message() (#335)

• Add Guild.get_or_fetch_members() with an alias Guild.getch_members() (#322).

• Add abc.GuildChannel.jump_url, DMChannel.jump_url and Thread.jump_url (#319)

Bug Fixes

• Fix missing support for reason parameter in some methods (#266)

• Improve validation of slash command and option names (#267)

• [ext.commands] Fix typing of ctx parameter in Converter (#292)

• Fix Guild.get_command() never returning any commands (#333)

• Return list of members from Guild.chunk() (#334)

• Fix handling of uppercase slash command names (#346)

• Fix permissions annotation of abc.GuildChannel.set_permissions() (#349)

• Fix tasks.loop usage with fixed times (#337)

Documentation

• Show tooltips when hovering over links (#236, #242)

• General content improvements/adjustments (#275)

• Slight redesign and general layout improvements (#278)

Miscellaneous

• Improve examples (#209, #262, #270, #307, #332, #341)

• Improve typing/annotations of several parts of the library (#249, #256, #263, #279, #292, #299, #308)

• Add additional pre-commit hooks for development (#233)

• Add taskipy for development (#234)

• Improve member deserialization (#304)

• Split application command objects into separate types for data returned by the API (#299)

• Update README banner (#343)

v2.3.2

Bug Fixes

• Fix invalid default value for application command option descriptions (#338)

v2.3.1

Bug Fixes

• [ext.commands] Fix Python 3.10 union type annotations in slash commands (#231)

• Fix double @ when mentioning default role (#244)

• Fix a command sync bug which prevented registering two application commands with the same name but different types (#254)

• Fix GuildScheduledEvent.fetch_users() (#274)

• Fix bug when editing a View with URL buttons that resulted in the row attribute being reset (#252)

• [ext.commands] Fix MessageConverter not defaulting to current channel if no channel ID specified (#284)

• Fix attachment descriptions not working after recent API change (#241)

• Fix incorrect type check in Guild.create_scheduled_event() using StagePrivacyLevel instead of GuildScheduledEventPrivacyLevel (#263)

• [ext.commands] Fix exceptions that occurred when using a Union in a slash command parameter annotation

• [ext.commands] Fix dynamic command cooldowns (#320)

• Fix type-checking of guild_ids / test_guilds parameters which could break application command caching (#300, #325)

• Fix Guild.create_sticker() not working when no description was provided (#328)

Documentation

• Fix guild_permissions() documentation

• Fix missing dropdown icon (#235)

Miscellaneous

• Add isort and black pre-commit hooks, run isort (#169, #173, #233)

• Rename tests directory (#232)

v2.3.0

This version contains several new features and fixes, notably support for guild scheduled events, guild timeouts, and a slash command rework with parameter injections, as well as several documentation fixes.

Note: the Version Guarantees have been updated to more accurately reflect the versioning scheme this library is following.

Breaking Changes

• The supported aiohttp version range changed from >=3.6.0,<3.8.0 to >=3.7.0,<3.9.0

• Due to the upcoming text-in-voice feature (not yet released at the time of writing), many methods/properties that previously returned a TextChannel can now also return a VoiceChannel, which shares many but not all of its methods. Also see the details for text-in-voice under “New Features” below, which include a few important things to note.

• Slash command internals have undergone an extensive rework, and while existing code should still work as before, it is recommended that you do some testing using the new implementation first

• Bot.get_slash_command may now also return SubCommandGroup or SubCommand instances, see documentation

• disnake.types.ThreadArchiveDuration is now ThreadArchiveDurationLiteral, to avoid confusion with the new ThreadArchiveDuration enum

Deprecations

• The role_ids and user_ids parameters for guild_permissions are now roles and users respectively; the old parameter names will be removed in a future version

New Features

• Add guild scheduled events (#151, #217)

  • New intent: Intents.guild_scheduled_events (enabled by default)

  • New types

    • GuildScheduledEvent

    • GuildScheduledEventMetadata

    • GuildScheduledEventEntityType

    • GuildScheduledEventStatus

    • GuildScheduledEventPrivacyLevel

  • Guild additions/changes

    • Guild.scheduled_events

    • Guild.get_scheduled_event()

    • Guild.fetch_scheduled_event()

    • Guild.fetch_scheduled_events()

    • Guild.create_scheduled_event()

  • Invite additions/changes

    • Invite.guild_scheduled_event

    • guild_scheduled_event parameter on abc.GuildChannel.create_invite()

    • guild_scheduled_event_id parameter on Client.fetch_invite()

    • Include event URL parameter in Invite.url if applicable

    • Support parsing scheduled event ID from invite URLs

  • New events

    • on_guild_scheduled_event_create()

    • on_guild_scheduled_event_update()

    • on_guild_scheduled_event_delete()

    • on_guild_scheduled_event_subscribe() and on_raw_guild_scheduled_event_subscribe()

    • on_guild_scheduled_event_unsubscribe() and on_raw_guild_scheduled_event_unsubscribe()

  • New audit log actions

    • AuditLogAction.guild_scheduled_event_create

    • AuditLogAction.guild_scheduled_event_update

    • AuditLogAction.guild_scheduled_event_delete

• Add guild timeouts (#161, #221, #223)

  • Guild.timeout()

  • Member.timeout()

  • Member.current_timeout

  • timeout parameter on Member.edit()

  • New permission: Permissions.moderate_members

• Add preliminary support for text-in-voice (#162, #177)

  • Many methods/properties that previously returned a TextChannel can now also return a VoiceChannel, which shares many but not all of its methods

  • Important notes:

    • This feature is only available in a very limited number of servers at the time of writing this, and the API is still being developed; therefore, expect changes in the future

    • Text-in-voice currently does not support these text channel features (note: this is not guaranteed to be an exhaustive list): threads, webhooks, nsfw flags, slowmode

    • The nsfw and slowmode_delay values/parameters are currently not supported by the API and are still TBD

    • Pinned messages are currently not exposed in the client UI, and while the API for them works, their future is uncertain

  • VoiceChannel now inherits from abc.Messageable

  • New VoiceChannel properties: .nsfw, .slowmode_delay, .last_message_id, .last_message

  • New VoiceChannel methods: .is_nsfw, .get_partial_message

  • nsfw and slowmode_delay parameters for VoiceChannel.edit()

• [ext.commands] Add parameter injections (example) (#130)

  • inject

  • register_injection

  • converter_method

• Add attachment descriptions (see File, Attachment) (#100)

• Add on_raw_typing() event (#176)

• Add Guild.approximate_member_count and Guild.approximate_presence_count (available on manually fetched guilds) (#139)

• Add Permissions.start_embedded_activities (#160)

• Add ThreadArchiveDuration enum, containing the currently valid values for the thread auto-archive feature (#187)

• [ext.commands] Add PermissionsConverter, which allows the conversion of a value or a (list of) permission names to a Permissions instance (using a Permissions annotation)

• Add AppInfo.flags

• [ext.commands] Add channel_types parameter to Param/ParamInfo (#130)

• Add support for setting slowmode_delay on thread creation (TextChannel.create_thread(), Message.create_thread()) (#132)

• Add invitable parameter to TextChannel.create_thread() (#132)

• Add fail_if_not_exists parameter to Message.reply() (#199, #211)

• [ext.commands] Bot.get_slash_command now works similar to Bot.get_command, in that it can also return subcommands/groups for inputs like "foo bar" (#149)

• Add new aliases for ApplicationCommandInteraction: CommandInteraction, CmdInteraction, CommandInter, CmdInter, AppCommandInteraction

• Add a base class for warnings emitted by this library, DiscordWarning (#118)

• Add new warnings (emitted instead of just using print for warnings): ConfigWarning, SyncWarning (#118)

• Add new voice channel activities: (#145, #148, #183)

  • PartyType.watch_together

  • PartyType.checkers

  • PartyType.spellcast

  • PartyType.awkword

  • PartyType.sketchy_artist

• Add new flags/enum values: (#148, #194)

  • MessageType.context_menu_command

  • Status.streaming

  • SystemChannelFlags.join_notification_replies

  • MessageFlags.loading

  • UserFlags.http_interactions_bot, PublicUserFlags.http_interactions_bot

  • UserFlags.spammer, PublicUserFlags.spammer

Bug Fixes

• Fix dispatch of typing events in DMs (#176)

• Try to retrieve objects in received interactions from cache first (fixing properties like Member.status on member parameters for commands) (#182, #213)

• Fix return type annotation of ui.button() and ui.select() decorators (#163)

• Fix incorrect URL returned by Template.url

• Fix sending local files in embeds with interactions/webhooks if only one embed was specified (#193)

• Fix leftover uses of json, which didn’t use orjson if available (#184)

• Fix Message.channel type being DMChannel for ephemeral messages in on_message() (#197)

• Fix command/option name validation (#210)

• Always close files after completing HTTP requests (#124)

• [ext.commands] Fix unnecessary application command sync without changes

• [ext.commands] Fix incorrect detection of deprecated guild commands in sync algorithm while sync is in progress (#205)

Documentation

• Move documentation to https://docs.disnake.dev/

• Update Version Guarantees (#200)

• Clarify Interaction.original_message() documentation regarding different response types (#140)

• Clarify Interaction.send() documentation (#188)

• Redirect searches for color to colour (#153)

• Add documentation for new guild feature values (#148)

• Add documentation for several methods/properties: (#153)

  • Client.global_application_commands

  • Client.global_slash_commands

  • Client.global_user_commands

  • Client.global_message_commands

  • Bot.on_slash_command_error

  • Bot.on_user_command_error

  • Bot.on_message_command_error

  • on_slash_command_completion

  • on_user_command_completion

  • on_message_command_completion

  • ApplicationCommandInteraction.bot

  • InvokableApplicationCommand

• Fix incorrect type for Invite.channel in documentation

• Add additional information about application command sync algorithm and syncing commands in sharded bots (#205)

Miscellaneous

• Add Python 3.10 to package classifiers (#127)

• Change supported aiohttp version range from >=3.6.0,<3.8.0 to >=3.7.0,<3.9.0 (#119, #164)

• Add guide for configuring inviting a bot through its profile (#153)

• Rewrite project README (#191)

• Improve examples (#143)

v2.2.3

Bug Fixes

• Fix invalid default value for application command option descriptions (#338)

v2.2.2

Bug Fixes

• Fix channel conversion in audit log entries

• Fix improper error handling in context menu commands

• Supply ApplicationCommandInteraction.application_command in autocomplete callbacks

• Fix Select.append_option not raising an error if 25 options have already been added

• Improve check for options parameter on slash commands and subcommands

• Improve parameter parsing for converters

• Fix warning related to new option properties

Documentation

• Update repository links to new organization

• Fix duplicate entries in documentation

• Fix incorrect versionadded tags

• Add documentation for InteractionBot and AutoShardedInteractionBot

v2.2.1

Bug Fixes

• Fixed error related to guild member count

v2.2.0

New Features

• Add Interaction.send()

• Add kwarg attachments to edit methods

• Add kwargs file and files to InteractionResponse.edit_message(), PartialMessage.edit() and Message.edit()

• Add kwarg file to Embed.set_image() and Embed.set_thumbnail()

• Add kwarg delay to Interaction.delete_original_message() and WebhookMessage.delete()

• Add kwarg delete_after to InteractionResponse.send_message() and WebhookMessage.send()

• [ext.commands] Add InvokableSlashCommand.autocomplete (alternative method of adding autocomplete functions)

• [ext.commands] Add SubCommand.autocomplete (alternative method of adding autocomplete functions)

• [ext.commands] Add Cog.cog_load

• [ext.commands] Error handlers now can cancel each other by returning True

v2.1.5

New Features

• Add InteractionReference

• Add UnresolvedGuildApplicationCommandPermissions

• Add Message.interaction

• Add kwargs min_value and max_value in Option

• [ext.commands] Add kwarg min_value (with aliases ge, gt) to Param

• [ext.commands] Add kwarg max_value (with aliases le, lt) to Param

• [ext.commands] Add kwarg owner to guild_permissions

Bug Fixes

• Command deletions on reconnections

• Pending sync tasks on loop termination

v2.1.4

Bug Fixes

• Fixed some issues with application command permissions synchronisation

v2.1.3

New Features

• Add GuildApplicationCommandPermissions

• Add PartialGuildApplicationCommandPermissions

• Add ApplicationCommandInteraction.filled_options property

• Add on_slash_command_completion

• Add on_user_command_completion

• Add on_message_command_completion

• [ext.commands] Add AutoShardedInteractionBot

• [ext.commands] Add InteractionBot

• [ext.commands] Add guild_permissions

• [ext.commands] Add kwargs sync_commands_on_cog_unload and sync_permissions to InteractionBotBase

Bug Fixes

• Music

• default_permission kwarg in user / message commands

• Commands no longer sync during the loop termination

v2.1.2

This is the first stable version of this discord.py 2.0 fork.

New Features

• Add interaction hierarchy. Interaction is now the base class for other interaction types, such as ApplicationCommandInteraction and MessageInteraction.

• Add interaction data wrappers: ApplicationCommandInteractionData and MessageInteractionData.

• Add interaction data option wrapper: ApplicationCommandInteractionDataOption

• Add Client.bulk_edit_command_permissions()

• Add Client.bulk_overwrite_global_commands()

• Add Client.bulk_overwrite_guild_commands()

• Add Client.create_global_command()

• Add Client.create_guild_command()

• Add Client.delete_global_command()

• Add Client.delete_guild_command()

• Add Client.edit_command_permissions()

• Add Client.edit_global_command()

• Add Client.edit_guild_command()

• Add Client.fetch_command_permissions()

• Add Client.fetch_global_commands()

• Add Client.fetch_global_command()

• Add Client.fetch_guild_commands()

• Add Client.fetch_guild_command()

• Add Client.get_global_command()

• Add Client.get_global_command_named()

• Add Client.get_guild_application_commands()

• Add Client.get_guild_slash_commands()

• Add Client.get_guild_user_commands()

• Add Client.get_guild_message_commands()

• Add Client.get_guild_command()

• Add Client.get_guild_command_named()

• Add Client.global_application_commands

• Add Client.global_slash_commands

• Add Client.global_user_commands

• Add Client.global_message_commands

• [ext.commands] Support for slash commands and context menus.

• [ext.commands] Add InvokableApplicationCommand - the base class for invokable slash commands and context menus.

• [ext.commands] Add InvokableSlashCommand for slash command management.

• [ext.commands] Add SubCommand for slash sub-command management.

• [ext.commands] Add SubCommandGroup for slash sub-command group management.

• [ext.commands] Add InvokableUserCommand for user command management (context menus).

• [ext.commands] Add InvokableMessageCommand for message command management (context menus).

• [ext.commands] Add ParamInfo for wrapping annotations.

• [ext.commands] Add slash_command for slash command definitions.

• [ext.commands] Add user_command for user command definitions (context menus).

• [ext.commands] Add message_command for message command definitions (context menus).

• [ext.commands] Add Param (with an alias param) in case ParamInfo causes linter errors.

• [ext.commands] Add Bot.slash_command for slash command definitions.

• [ext.commands] Add Bot.user_command for user command definitions (context menus).

• [ext.commands] Add Bot.message_command for message command definitions (context menus).

• [ext.commands] Add Bot.after_slash_command_invoke - a decorator for post-invoke hooks for slash commands.

• [ext.commands] Add Bot.after_user_command_invoke - a decorator for post-invoke hooks for user commands.

• [ext.commands] Add Bot.after_message_command_invoke - a decorator for post-invoke hooks for message commands.

• [ext.commands] Add Bot.before_slash_command_invoke - a decorator for pre-invoke hooks for slash commands.

• [ext.commands] Add Bot.before_user_command_invoke - a decorator for pre-invoke hooks for user commands.

• [ext.commands] Add Bot.before_message_command_invoke - a decorator for pre-invoke hooks for message commands.

• [ext.commands] Add Bot.add_slash_command

• [ext.commands] Add Bot.add_user_command

• [ext.commands] Add Bot.add_message_command

• [ext.commands] Add Bot.remove_slash_command

• [ext.commands] Add Bot.remove_user_command

• [ext.commands] Add Bot.remove_message_command

• [ext.commands] Add Bot.get_slash_command

• [ext.commands] Add Bot.get_user_command

• [ext.commands] Add Bot.get_message_command

• [ext.commands] Add Bot.slash_command_check

• [ext.commands] Add Bot.slash_command_check_once

• [ext.commands] Add Bot.user_command_check

• [ext.commands] Add Bot.user_command_check_once

• [ext.commands] Add Bot.message_command_check

• [ext.commands] Add Bot.message_command_check_once

• [ext.commands] Add Cog.cog_slash_command_check

• [ext.commands] Add Cog.cog_user_command_check

• [ext.commands] Add Cog.cog_message_command_check

• [ext.commands] Add Cog.cog_slash_command_error

• [ext.commands] Add Cog.cog_user_command_error

• [ext.commands] Add Cog.cog_message_command_error

• [ext.commands] Add Cog.cog_before_slash_command_invoke

• [ext.commands] Add Cog.cog_after_slash_command_invoke

• [ext.commands] Add Cog.cog_before_user_command_invoke

• [ext.commands] Add Cog.cog_after_user_command_invoke

• [ext.commands] Add Cog.cog_before_message_command_invoke

• [ext.commands] Add Cog.cog_after_message_command_invoke

• [ext.commands] Add Cog.bot_slash_command_check

• [ext.commands] Add Cog.bot_slash_command_check_once

• [ext.commands] Add Cog.bot_user_command_check

• [ext.commands] Add Cog.bot_user_command_check_once

• [ext.commands] Add Cog.bot_message_command_check

• [ext.commands] Add Cog.bot_message_command_check_once

Legacy Changelog

Changelogs for older versions (0.x, 1.x) can be found on the Legacy Changelog page.