refactor(commands): rewrite app command storage to support multiple per-guild commands with the same name

changelog/260.bugfix.rst

@@ -0,0 +1 @@
+|commands| Allow registering 2 commands with the same type and name in different guilds.

changelog/260.deprecate.0.rst

@@ -0,0 +1 @@
+|commands| :attr:`.ext.commands.InteractionBot.all_slash_commands`, :attr:`.ext.commands.InteractionBot.all_user_commands`, :attr:`.ext.commands.InteractionBot.all_message_commands` are deprecated.

changelog/260.deprecate.1.rst

@@ -0,0 +1 @@
+|commands| :meth:`.ext.commands.InteractionBot.add_slash_command`, :meth:`.ext.commands.InteractionBot.add_user_command`, :meth:`.ext.commands.InteractionBot.add_message_command` are deprecated.

changelog/260.deprecate.2.rst

@@ -0,0 +1 @@
+|commands| :meth:`.ext.commands.InteractionBot.remove_slash_command`, :meth:`.ext.commands.InteractionBot.remove_user_command`, :meth:`.ext.commands.InteractionBot.remove_message_command` are deprecated.

changelog/260.feature.0.rst

@@ -0,0 +1 @@
+|commands| Add :meth:`.ext.commands.InteractionBot.add_app_command` and :meth:`.ext.commands.InteractionBot.remove_app_command`.

changelog/260.feature.1.rst

@@ -0,0 +1 @@
+|commands| Add ``guild_id`` parameter to :meth:`.ext.commands.InteractionBot.get_slash_command`, :meth:`.ext.commands.InteractionBot.get_user_command`, and :meth:`.ext.commands.InteractionBot.get_message_command`.

changelog/260.feature.2.rst

@@ -0,0 +1 @@
+|commands| Add :class:`.ext.commands.ApplicationCommandRegistrationError`.

disnake/ext/commands/base_core.py

@@ -12,6 +12,7 @@
     Callable,
     Dict,
     List,
+    NamedTuple,
     Optional,
     Tuple,
     TypeVar,
@@ -49,7 +50,7 @@
     ]
 
 
-__all__ = ("InvokableApplicationCommand", "default_member_permissions")
+__all__ = ("AppCmdIndex", "InvokableApplicationCommand", "default_member_permissions")
 
 
 T = TypeVar("T")
@@ -79,6 +80,26 @@ async def wrapped(*args, **kwargs):
     return wrapped
 
 
+class AppCmdIndex(NamedTuple):
+    """A named tuple used for indexation of :class:`InvokableApplicationCommand`
+    objects stored in bot's cache.
+
+    Attributes
+    ----------
+    type: :class:`disnake.ApplicationCommandType`
+        The type of the application command being stored.
+    name: :class:`str`
+        The name of the application command being stored.
+    guild_id: Optional[:class:`int`]
+        One of the guild IDs this command should be registered to,
+        or ``None`` if it's a global command.
+    """
+
+    type: ApplicationCommandType
+    name: str
+    guild_id: Optional[int]
+
+
 class InvokableApplicationCommand(ABC):
     """A base class that implements the protocol for a bot application command.
 

disnake/ext/commands/cog.py

@@ -27,7 +27,7 @@
 from ._types import _BaseCommand
 from .base_core import InvokableApplicationCommand
 from .ctx_menus_core import InvokableMessageCommand, InvokableUserCommand
-from .slash_core import InvokableSlashCommand
+from .slash_core import InvokableSlashCommand, SubCommand, SubCommandGroup
 
 if TYPE_CHECKING:
     from typing_extensions import Self
@@ -753,22 +753,16 @@ def _inject(self, bot: AnyBot) -> Self:
 
         for index, command in enumerate(self.__cog_app_commands__):
             command.cog = self
+            if isinstance(command, (SubCommand, SubCommandGroup)):
+                continue
             try:
-                if isinstance(command, InvokableSlashCommand):
-                    bot.add_slash_command(command)
-                elif isinstance(command, InvokableUserCommand):
-                    bot.add_user_command(command)
-                elif isinstance(command, InvokableMessageCommand):
-                    bot.add_message_command(command)
+                bot.add_app_command(command)
             except Exception:
                 # undo our additions
                 for to_undo in self.__cog_app_commands__[:index]:
-                    if isinstance(to_undo, InvokableSlashCommand):
-                        bot.remove_slash_command(to_undo.name)
-                    elif isinstance(to_undo, InvokableUserCommand):
-                        bot.remove_user_command(to_undo.name)
-                    elif isinstance(to_undo, InvokableMessageCommand):
-                        bot.remove_message_command(to_undo.name)
+                    bot._remove_app_commands(
+                        to_undo.body.type, to_undo.name, guild_ids=to_undo.guild_ids
+                    )
                 raise
 
         if not hasattr(self.cog_load.__func__, "__cog_special_method__"):
@@ -841,12 +835,9 @@ def _eject(self, bot: AnyBot) -> None:
                     bot.remove_command(command.name)  # type: ignore
 
             for app_command in self.__cog_app_commands__:
-                if isinstance(app_command, InvokableSlashCommand):
-                    bot.remove_slash_command(app_command.name)
-                elif isinstance(app_command, InvokableUserCommand):
-                    bot.remove_user_command(app_command.name)
-                elif isinstance(app_command, InvokableMessageCommand):
-                    bot.remove_message_command(app_command.name)
+                bot._remove_app_commands(
+                    app_command.body.type, app_command.name, guild_ids=app_command.guild_ids
+                )
 
             for name, method_name in self.__cog_listeners__:
                 bot.remove_listener(getattr(self, method_name), name)

disnake/ext/commands/ctx_menus_core.py

@@ -266,9 +266,11 @@ def user_command(
 
     auto_sync: :class:`bool`
         Whether to automatically register the command. Defaults to ``True``.
-    guild_ids: Sequence[:class:`int`]
-        If specified, the client will register the command in these guilds.
-        Otherwise, this command will be registered globally.
+    guild_ids: Optional[Sequence[:class:`int`]]
+        If specified, the client will register the command to these guilds.
+        Otherwise the command will be registered globally, unless
+        parameter ``test_guilds`` is specified in the bot constructor, in which case
+        this command will be registered to those guilds.
     extras: Dict[:class:`str`, Any]
         A dict of user provided extras to attach to the command.
 
@@ -348,9 +350,11 @@ def message_command(
 
     auto_sync: :class:`bool`
         Whether to automatically register the command. Defaults to ``True``.
-    guild_ids: Sequence[:class:`int`]
-        If specified, the client will register the command in these guilds.
-        Otherwise, this command will be registered globally.
+    guild_ids: Optional[Sequence[:class:`int`]]
+        If specified, the client will register the command to these guilds.
+        Otherwise the command will be registered globally, unless
+        parameter ``test_guilds`` is specified in the bot constructor, in which case
+        this command will be registered to those guilds.
     extras: Dict[:class:`str`, Any]
         A dict of user provided extras to attach to the command.
 

disnake/ext/commands/errors.py

@@ -4,6 +4,7 @@
 
 from typing import TYPE_CHECKING, Any, Callable, List, Optional, Tuple, Type, Union
 
+from disnake.enums import ApplicationCommandType
 from disnake.errors import ClientException, DiscordException
 from disnake.utils import humanize_list
 
@@ -74,6 +75,7 @@
     "ExtensionFailed",
     "ExtensionNotFound",
     "CommandRegistrationError",
+    "ApplicationCommandRegistrationError",
     "FlagError",
     "BadFlagArgument",
     "MissingFlagArgument",
@@ -1025,6 +1027,46 @@ def __init__(self, name: str, *, alias_conflict: bool = False) -> None:
         super().__init__(f"The {type_} {name} is already an existing command or alias.")
 
 
+# we inherit CommandRegistrationError for backwards compatibility,
+# because this error replaced CommandRegistrationError in several places
+class ApplicationCommandRegistrationError(CommandRegistrationError):
+    """An exception raised when the app command can't be added
+    because a command with the same key already exists.
+    A key is determined by command type, name, and guild_id.
+
+    This inherits from :exc:`CommandRegistrationError`
+
+    .. versionadded:: 2.10
+
+    Attributes
+    ----------
+    cmd_type: :class:`disnake.ApplicationCommandType`
+        The command type.
+    name: :class:`str`
+        The command name.
+    guild_id: Optional[:class:`int`]
+        The ID of the guild where the command was supposed to be registered
+        or ``None`` if it was a global command.
+    """
+
+    def __init__(
+        self, cmd_type: ApplicationCommandType, name: str, guild_id: Optional[int]
+    ) -> None:
+        self.cmd_type: ApplicationCommandType = cmd_type
+        self.name: str = name
+        self.guild_id: Optional[int] = guild_id
+        # backwards compatibility
+        self.alias_conflict: bool = False
+        # fixed API naming here because no one calls slash commands "chat input"
+        type_ = "slash" if cmd_type is ApplicationCommandType.chat_input else cmd_type.name
+        if guild_id is None:
+            msg = f"Global {type_} command {name} was specified earlier in your code."
+        else:
+            msg = f"Local {type_} command {name} with guild ID {guild_id} was specified earlier in your code."
+        # this bypasses CommandRegistrationError.__init__
+        super(CommandRegistrationError, self).__init__(msg)
+
+
 class FlagError(BadArgument):
     """The base exception type for all flag parsing related errors.