add enums, do command stuff, add context to interaction

Author: plun1331

discord/commands/core.py

@@ -47,12 +47,13 @@
 
 from ..channel import _threaded_guild_channel_factory
 from ..enums import Enum as DiscordEnum
-from ..enums import MessageType, SlashCommandOptionType, try_enum
+from ..enums import IntegrationType, InteractionContextType, MessageType, SlashCommandOptionType, try_enum
 from ..errors import (
     ApplicationCommandError,
     ApplicationCommandInvokeError,
     CheckFailure,
     ClientException,
+    InvalidArgument,
     ValidationError,
 )
 from ..member import Member
@@ -61,7 +62,7 @@
 from ..role import Role
 from ..threads import Thread
 from ..user import User
-from ..utils import MISSING, async_all, find, maybe_coroutine, utcnow
+from ..utils import MISSING, async_all, find, maybe_coroutine, utcnow, warn_deprecated
 from .context import ApplicationContext, AutocompleteContext
 from .options import Option, OptionChoice
 
@@ -226,11 +227,33 @@ def __init__(self, func: Callable, **kwargs) -> None:
             "__default_member_permissions__",
             kwargs.get("default_member_permissions", None),
         )
-        self.guild_only: bool | None = getattr(
-            func, "__guild_only__", kwargs.get("guild_only", None)
-        )
         self.nsfw: bool | None = getattr(func, "__nsfw__", kwargs.get("nsfw", None))
 
+        integration_types = getattr(
+            func, "__integration_types__", kwargs.get("integration_types", None)
+        )
+        contexts = getattr(
+            func, "__contexts__", kwargs.get("contexts", None)
+        )
+        guild_only = getattr(
+            func, "__guild_only__", kwargs.get("guild_only", MISSING)
+        )
+        if guild_only is not MISSING:
+            warn_deprecated("guild_only", "contexts", "2.6")
+        if contexts and guild_only:
+            raise InvalidArgument("cannot pass both 'contexts' and 'guild_only' to ApplicationCommand")
+        if self.guild_ids and ((contexts is not None) or guild_only or integration_types):
+            raise InvalidArgument("the 'contexts' and 'integration_types' parameters are not available for guild commands")
+
+        self.contexts: set[InteractionContextType] = contexts or {
+            InteractionContextType.guild, 
+            InteractionContextType.bot_dm, 
+            InteractionContextType.private_channel,
+        }
+        if guild_only:
+            self.guild_only: bool | None = guild_only
+        self.integration_types: set[IntegrationType] = integration_types or {IntegrationType.guild_install}
+
     def __repr__(self) -> str:
         return f"<discord.commands.{self.__class__.__name__} name={self.name}>"
 
@@ -274,6 +297,19 @@ def callback(
         unwrap = unwrap_function(function)
         self.module = unwrap.__module__
 
+    @property
+    def guild_only(self) -> bool:
+        warn_deprecated("guild_only", "contexts", "2.6")
+        return InteractionContextType.guild in self.contexts and len(self.contexts) == 1
+
+    @guild_only.setter
+    def guild_only(self, value: bool) -> None:
+        warn_deprecated("guild_only", "contexts", "2.6")
+        if value:
+            self.contexts = {InteractionContextType.guild}
+        else:
+            self.contexts = {InteractionContextType.guild, InteractionContextType.bot_dm, InteractionContextType.private_channel}
+
     def _prepare_cooldowns(self, ctx: ApplicationContext):
         if self._buckets.valid:
             current = datetime.datetime.now().timestamp()
@@ -631,6 +667,9 @@ class SlashCommand(ApplicationCommand):
         Returns a string that allows you to mention the slash command.
     guild_only: :class:`bool`
         Whether the command should only be usable inside a guild.
+        
+        .. deprecated:: 2.6
+            Use the ``contexts`` parameter instead.
     nsfw: :class:`bool`
         Whether the command should be restricted to 18+ channels and users.
         Apps intending to be listed in the App Directory cannot have NSFW commands.
@@ -654,6 +693,10 @@ class SlashCommand(ApplicationCommand):
     description_localizations: Dict[:class:`str`, :class:`str`]
         The description localizations for this command. The values of this should be ``"locale": "description"``.
         See `here <https://discord.com/developers/docs/reference#locales>`_ for a list of valid locales.
+    integration_types: set[:class:`IntegrationType`]
+        The installation contexts where this command is available. Cannot be set if this is a guild command.
+    contexts: set[:class:`InteractionContextType`]
+        The interaction contexts where this command is available. Cannot be set if this is a guild command.
     """
 
     type = 1
@@ -881,9 +924,6 @@ def to_dict(self) -> dict:
         if self.is_subcommand:
             as_dict["type"] = SlashCommandOptionType.sub_command.value
 
-        if self.guild_only is not None:
-            as_dict["dm_permission"] = not self.guild_only
-
         if self.nsfw is not None:
             as_dict["nsfw"] = self.nsfw
 
@@ -892,6 +932,10 @@ def to_dict(self) -> dict:
                 self.default_member_permissions.value
             )
 
+        if not self.guild_ids:
+            as_dict["integration_types"] = [it.value for it in self.integration_types]
+            as_dict["contexts"] = [ctx.value for ctx in self.contexts]
+
         return as_dict
 
     async def _invoke(self, ctx: ApplicationContext) -> None:
@@ -1100,6 +1144,9 @@ class SlashCommandGroup(ApplicationCommand):
         isn't one.
     guild_only: :class:`bool`
         Whether the command should only be usable inside a guild.
+
+        .. deprecated:: 2.6
+            Use the ``contexts`` parameter instead.
     nsfw: :class:`bool`
         Whether the command should be restricted to 18+ channels and users.
         Apps intending to be listed in the App Directory cannot have NSFW commands.
@@ -1118,6 +1165,10 @@ class SlashCommandGroup(ApplicationCommand):
     description_localizations: Dict[:class:`str`, :class:`str`]
         The description localizations for this command. The values of this should be ``"locale": "description"``.
         See `here <https://discord.com/developers/docs/reference#locales>`_ for a list of valid locales.
+    integration_types: set[:class:`IntegrationType`]
+        The installation contexts where this command is available. Cannot be set if this is a guild command.
+    contexts: set[:class:`InteractionContextType`]
+        The interaction contexts where this command is available. Cannot be set if this is a guild command.
     """
 
     __initial_commands__: list[SlashCommand | SlashCommandGroup]
@@ -1174,12 +1225,28 @@ def __init__(
         self.id = None
 
         # Permissions
-        self.default_member_permissions: Permissions | None = kwargs.get(
-            "default_member_permissions", None
-        )
-        self.guild_only: bool | None = kwargs.get("guild_only", None)
+        self.default_member_permissions: Permissions | None = kwargs.get("default_member_permissions", None)
         self.nsfw: bool | None = kwargs.get("nsfw", None)
 
+        integration_types = kwargs.get("integration_types", None)
+        contexts = kwargs.get("contexts", None)
+        guild_only = kwargs.get("guild_only", MISSING)
+        if guild_only is not MISSING:
+            warn_deprecated("guild_only", "contexts", "2.6")
+        if contexts and guild_only:
+            raise InvalidArgument("cannot pass both 'contexts' and 'guild_only' to ApplicationCommand")
+        if self.guild_ids and ((contexts is not None) or guild_only or integration_types):
+            raise InvalidArgument("the 'contexts' and 'integration_types' parameters are not available for guild commands")
+
+        self.contexts: set[InteractionContextType] = contexts or {
+            InteractionContextType.guild, 
+            InteractionContextType.bot_dm, 
+            InteractionContextType.private_channel,
+        }
+        if guild_only:
+            self.guild_only: bool | None = guild_only
+        self.integration_types: set[IntegrationType] = integration_types or {IntegrationType.guild_install}
+
         self.name_localizations: dict[str, str] = kwargs.get(
             "name_localizations", MISSING
         )
@@ -1218,6 +1285,19 @@ def __init__(
     def module(self) -> str | None:
         return self.__module__
 
+    @property
+    def guild_only(self) -> bool:
+        warn_deprecated("guild_only", "contexts", "2.6")
+        return InteractionContextType.guild in self.contexts and len(self.contexts) == 1
+
+    @guild_only.setter
+    def guild_only(self, value: bool) -> None:
+        warn_deprecated("guild_only", "contexts", "2.6")
+        if value:
+            self.contexts = {InteractionContextType.guild}
+        else:
+            self.contexts = {InteractionContextType.guild, InteractionContextType.bot_dm, InteractionContextType.private_channel}
+
     def to_dict(self) -> dict:
         as_dict = {
             "name": self.name,
@@ -1232,9 +1312,6 @@ def to_dict(self) -> dict:
         if self.parent is not None:
             as_dict["type"] = self.input_type.value
 
-        if self.guild_only is not None:
-            as_dict["dm_permission"] = not self.guild_only
-
         if self.nsfw is not None:
             as_dict["nsfw"] = self.nsfw
 
@@ -1243,6 +1320,10 @@ def to_dict(self) -> dict:
                 self.default_member_permissions.value
             )
 
+        if not self.guild_ids:
+            as_dict["integration_types"] = [it.value for it in self.integration_types]
+            as_dict["contexts"] = [ctx.value for ctx in self.contexts]
+
         return as_dict
 
     def add_command(self, command: SlashCommand) -> None:
@@ -1476,6 +1557,9 @@ class ContextMenuCommand(ApplicationCommand):
         The ids of the guilds where this command will be registered.
     guild_only: :class:`bool`
         Whether the command should only be usable inside a guild.
+        
+        .. deprecated:: 2.6
+            Use the ``contexts`` parameter instead.
     nsfw: :class:`bool`
         Whether the command should be restricted to 18+ channels and users.
         Apps intending to be listed in the App Directory cannot have NSFW commands.
@@ -1496,6 +1580,10 @@ class ContextMenuCommand(ApplicationCommand):
     name_localizations: Dict[:class:`str`, :class:`str`]
         The name localizations for this command. The values of this should be ``"locale": "name"``. See
         `here <https://discord.com/developers/docs/reference#locales>`_ for a list of valid locales.
+    integration_types: set[:class:`IntegrationType`]
+        The installation contexts where this command is available. Cannot be set if this is a guild command.
+    contexts: set[:class:`InteractionContextType`]
+        The interaction contexts where this command is available. Cannot be set if this is a guild command.
     """
 
     def __new__(cls, *args, **kwargs) -> ContextMenuCommand:

discord/enums.py

@@ -1020,6 +1020,22 @@ class EntitlementOwnerType(Enum):
     user = 2
 
 
+class IntegrationType(Enum):
+    """The application's integration type"""
+
+    guild_install = 1
+    user_install = 2
+
+
+class InteractionContextType(Enum):
+    """The interaction's context type"""
+
+    guild = 0
+    bot_dm = 1
+    private_channel = 2
+
+
+
 T = TypeVar("T")
 
 

discord/interactions.py

@@ -30,7 +30,7 @@
 
 from . import utils
 from .channel import ChannelType, PartialMessageable, _threaded_channel_factory
-from .enums import InteractionResponseType, InteractionType, try_enum
+from .enums import InteractionResponseType, InteractionContextType, InteractionType, try_enum
 from .errors import ClientException, InteractionResponded, InvalidArgument
 from .file import File
 from .flags import MessageFlags
@@ -131,7 +131,12 @@ class Interaction:
         The guilds preferred locale, if invoked in a guild.
     custom_id: Optional[:class:`str`]
         The custom ID for the interaction.
+    authorizing_integration_owners: Any
+        TODO
+    context: Optional[:class:`InteractionContextType`]
+        The context in which this command was executed.
     """
+    # TODO: authorizing_integration_owners
 
     __slots__: tuple[str, ...] = (
         "id",
@@ -149,6 +154,7 @@ class Interaction:
         "version",
         "custom_id",
         "entitlements",
+        "context",
         "_channel_data",
         "_message_data",
         "_guild_data",
@@ -188,6 +194,7 @@ def _from_data(self, data: InteractionPayload):
         self.entitlements: list[Entitlement] = [
             Entitlement(data=e, state=self._state) for e in data.get("entitlements", [])
         ]
+        self.context: InteractionContextType | None = try_enum(InteractionContextType, data["context"]) if "context" in data else None
 
         self.message: Message | None = None
         self.channel = None

discord/message.py

@@ -847,6 +847,7 @@ def __init__(
             self.interaction = MessageInteraction(data=data["interaction"], state=state)
         except KeyError:
             self.interaction = None
+        # TODO: deprecate and replace with interaction_metadata
 
         self.thread: Thread | None
         try: