Merge branch 'discord-py-slash-commands:master' into master

Author: FayeDel

discord_slash/client.py

@@ -876,11 +876,11 @@ def wrapper(cmd):
     def permission(self, guild_id: int, permissions: list):
         """
         Decorator that add permissions. This will set the permissions for a single guild, you can use it more than once for each command.
+
         :param guild_id: ID of the guild for the permissions.
         :type guild_id: int
-        :param permissions: Permission requirements of the slash command. Default ``None``.
-        :type permissions: dict
-
+        :param permissions: List of permissions to be set for the specified guild.
+        :type permissions: list
         """
 
         def wrapper(cmd):
@@ -908,9 +908,9 @@ def add_component_callback(
         :param Coroutine callback: The coroutine to be called when the component is interacted with. Must accept a single argument with the type :class:`.context.ComponentContext`.
         :param messages: If specified, only interactions from the message given will be accepted. Can be a message object to check for, or the message ID or list of previous two. Empty list will mean that no interactions are accepted.
         :type messages: Union[discord.Message, int, list]
-        :param components: If specified, only interactions with ``custom_id``s of given components will be accepted. Defaults to the name of ``callback`` if ``use_callback_name=True``. Can be a custom ID (str) or component dict (actionrow or button) or list of previous two.
+        :param components: If specified, only interactions with ``custom_id`` of given components will be accepted. Defaults to the name of ``callback`` if ``use_callback_name=True``. Can be a custom ID (str) or component dict (actionrow or button) or list of previous two.
         :type components: Union[str, dict, list]
-        :param use_callback_name: Whether the ``custom_id`` defaults to the name of ``callback`` if unspecified. If ``False``, either `messages`` or ``components`` must be specified.
+        :param use_callback_name: Whether the ``custom_id`` defaults to the name of ``callback`` if unspecified. If ``False``, either ``messages`` or ``components`` must be specified.
         :type use_callback_name: bool
         :param component_type: The type of the component to avoid collisions with other component types. See :class:`.model.ComponentType`.
         :type component_type: Optional[int]
@@ -961,14 +961,14 @@ def extend_component_callback(
         custom_id: str = None,
     ):
         """
-        Registers existing callback object (:class:`.model.ComponentType`)
+        Registers existing callback object (:class:`.model.ComponentCallbackObject`)
         for specific combination of message_id, custom_id, component_type.
 
         :param callback_obj: callback object.
         :type callback_obj: model.ComponentCallbackObject
         :param message_id: If specified, only removes the callback for the specific message ID.
         :type message_id: Optional[.model]
-        :param custom_id: The `custom_id` of the component.
+        :param custom_id: The ``custom_id`` of the component.
         :type custom_id: Optional[str]
         :raises: .error.DuplicateCustomID, .error.IncorrectFormat
         """
@@ -988,7 +988,7 @@ def get_component_callback(
 
         :param message_id: If specified, only removes the callback for the specific message ID.
         :type message_id: Optional[.model]
-        :param custom_id: The `custom_id` of the component.
+        :param custom_id: The ``custom_id`` of the component.
         :type custom_id: Optional[str]
         :param component_type: The type of the component. See :class:`.model.ComponentType`.
         :type component_type: Optional[int]
@@ -1014,7 +1014,7 @@ def remove_component_callback(
 
         :param message_id: If specified, only removes the callback for the specific message ID.
         :type message_id: Optional[int]
-        :param custom_id: The `custom_id` of the component.
+        :param custom_id: The ``custom_id`` of the component.
         :type custom_id: Optional[str]
         :param component_type: The type of the component. See :class:`.model.ComponentType`.
         :type component_type: Optional[int]
@@ -1067,9 +1067,9 @@ def component_callback(
 
         :param messages: If specified, only interactions from the message given will be accepted. Can be a message object to check for, or the message ID or list of previous two. Empty list will mean that no interactions are accepted.
         :type messages: Union[discord.Message, int, list]
-        :param components: If specified, only interactions with ``custom_id``s of given components will be accepted. Defaults to the name of ``callback`` if ``use_callback_name=True``. Can be a custom ID (str) or component dict (actionrow or button) or list of previous two.
+        :param components: If specified, only interactions with ``custom_id`` of given components will be accepted. Defaults to the name of ``callback`` if ``use_callback_name=True``. Can be a custom ID (str) or component dict (actionrow or button) or list of previous two.
         :type components: Union[str, dict, list]
-        :param use_callback_name: Whether the ``custom_id`` defaults to the name of ``callback`` if unspecified. If ``False``, either `messages`` or ``components`` must be specified.
+        :param use_callback_name: Whether the ``custom_id`` defaults to the name of ``callback`` if unspecified. If ``False``, either ``messages`` or ``components`` must be specified.
         :type use_callback_name: bool
         :param component_type: The type of the component to avoid collisions with other component types. See :class:`.model.ComponentType`.
         :type component_type: Optional[int]

discord_slash/cog_ext.py

@@ -50,8 +50,14 @@ async def ping(self, ctx: SlashContext):
     :param connector: Kwargs connector for the command. Default ``None``.
     :type connector: dict
     """
+    if not permissions:
+        permissions = {}
 
     def wrapper(cmd):
+        decorator_permissions = getattr(cmd, "__permissions__", None)
+        if decorator_permissions:
+            permissions.update(decorator_permissions)
+
         desc = description or inspect.getdoc(cmd)
         if options is None:
             opts = manage_commands.generate_options(cmd, desc, connector)
@@ -138,8 +144,14 @@ async def group_say(self, ctx: SlashContext, text: str):
     base_description = base_description or base_desc
     subcommand_group_description = subcommand_group_description or sub_group_desc
     guild_ids = guild_ids if guild_ids else []
+    if not base_permissions:
+        base_permissions = {}
 
     def wrapper(cmd):
+        decorator_permissions = getattr(cmd, "__permissions__", None)
+        if decorator_permissions:
+            base_permissions.update(decorator_permissions)
+
         desc = description or inspect.getdoc(cmd)
         if options is None:
             opts = manage_commands.generate_options(cmd, desc, connector)
@@ -177,6 +189,25 @@ def wrapper(cmd):
     return wrapper
 
 
+def permission(guild_id: int, permissions: list):
+    """
+    Decorator that add permissions. This will set the permissions for a single guild, you can use it more than once for each command.
+
+    :param guild_id: ID of the guild for the permissions.
+    :type guild_id: int
+    :param permissions: List of permissions to be set for the specified guild.
+    :type permissions: list
+    """
+
+    def wrapper(cmd):
+        if not getattr(cmd, "__permissions__", None):
+            cmd.__permissions__ = {}
+        cmd.__permissions__[guild_id] = permissions
+        return cmd
+
+    return wrapper
+
+
 def cog_component(
     *,
     messages: typing.Union[int, discord.Message, list] = None,
@@ -190,9 +221,9 @@ def cog_component(
 
     :param messages: If specified, only interactions from the message given will be accepted. Can be a message object to check for, or the message ID or list of previous two. Empty list will mean that no interactions are accepted.
     :type messages: Union[discord.Message, int, list]
-    :param components: If specified, only interactions with ``custom_id``s of given components will be accepted. Defaults to the name of ``callback`` if ``use_callback_name=True``. Can be a custom ID (str) or component dict (actionrow or button) or list of previous two.
+    :param components: If specified, only interactions with ``custom_id`` of given components will be accepted. Defaults to the name of ``callback`` if ``use_callback_name=True``. Can be a custom ID (str) or component dict (actionrow or button) or list of previous two.
     :type components: Union[str, dict, list]
-    :param use_callback_name: Whether the ``custom_id`` defaults to the name of ``callback`` if unspecified. If ``False``, either `messages`` or ``components`` must be specified.
+    :param use_callback_name: Whether the ``custom_id`` defaults to the name of ``callback`` if unspecified. If ``False``, either ``messages`` or ``components`` must be specified.
     :type use_callback_name: bool
     :param component_type: The type of the component to avoid collisions with other component types. See :class:`.model.ComponentType`.
     :type component_type: Optional[int]

discord_slash/const.py

@@ -1,5 +1,5 @@
 """Discord Slash Constants"""
 
-__version__ = "2.0.1"
+__version__ = "2.2.0"
 
 BASE_API = "https://discord.com/api/v8"

discord_slash/context.py

@@ -23,13 +23,16 @@ class InteractionContext:
     :ivar bot: discord.py client.
     :ivar _http: :class:`.http.SlashCommandRequest` of the client.
     :ivar _logger: Logger instance.
+    :ivar data: The raw data of the interaction.
+    :ivar values: The values sent with the interaction. Currently for selects.
     :ivar deferred: Whether the command is current deferred (loading state)
     :ivar _deferred_hidden: Internal var to check that state stays the same
     :ivar responded: Whether you have responded with a message to the interaction.
     :ivar guild_id: Guild ID of the command message. If the command was invoked in DM, then it is ``None``
     :ivar author_id: User ID representing author of the command message.
     :ivar channel_id: Channel ID representing channel of the command message.
     :ivar author: User or Member instance of the command invoke.
+
     """
 
     def __init__(
@@ -47,6 +50,8 @@ def __init__(
         self._logger = logger
         self.deferred = False
         self.responded = False
+        self.data = _json["data"]
+        self.values = _json["data"]["values"] if "values" in _json["data"] else None
         self._deferred_hidden = False  # To check if the patch to the deferred response matches
         self.guild_id = int(_json["guild_id"]) if "guild_id" in _json.keys() else None
         self.author_id = int(
@@ -188,15 +193,22 @@ async def send(
                 "The top level of the components list must be made of ActionRows!"
             )
 
+        if allowed_mentions is not None:
+            if self.bot.allowed_mentions is not None:
+                allowed_mentions = self.bot.allowed_mentions.merge(allowed_mentions).to_dict()
+            else:
+                allowed_mentions = allowed_mentions.to_dict()
+        else:
+            if self.bot.allowed_mentions is not None:
+                allowed_mentions = self.bot.allowed_mentions.to_dict()
+            else:
+                allowed_mentions = {}
+
         base = {
             "content": content,
             "tts": tts,
             "embeds": [x.to_dict() for x in embeds] if embeds else [],
-            "allowed_mentions": allowed_mentions.to_dict()
-            if allowed_mentions
-            else self.bot.allowed_mentions.to_dict()
-            if self.bot.allowed_mentions
-            else {},
+            "allowed_mentions": allowed_mentions,
             "components": components or [],
         }
         if hidden:
@@ -283,7 +295,7 @@ class ComponentContext(InteractionContext):
     :ivar component: Component data retrieved from the message. Not available if the origin message was ephemeral.
     :ivar origin_message: The origin message of the component. Not available if the origin message was ephemeral.
     :ivar origin_message_id: The ID of the origin message.
-
+    :ivar selected_options: The options selected (only for selects)
     """
 
     def __init__(
@@ -309,6 +321,8 @@ def __init__(
             )
             self.component = self.origin_message.get_component(self.custom_id)
 
+        self.selected_options = _json["data"]["values"] if self.component_type == 3 else None
+
     async def defer(self, hidden: bool = False, edit_origin: bool = False):
         """
         'Defers' the response, showing a loading state to the user
@@ -373,42 +387,71 @@ async def edit_origin(self, **fields):
         """
         _resp = {}
 
-        content = fields.get("content")
-        if content:
-            _resp["content"] = str(content)
+        try:
+            content = fields["content"]
+        except KeyError:
+            pass
+        else:
+            if content is not None:
+                content = str(content)
+            _resp["content"] = content
+
+        try:
+            components = fields["components"]
+        except KeyError:
+            pass
+        else:
+            if components is None:
+                _resp["components"] = []
+            else:
+                _resp["components"] = components
+
+        try:
+            embeds = fields["embeds"]
+        except KeyError:
+            # Nope
+            pass
+        else:
+            if not isinstance(embeds, list):
+                raise error.IncorrectFormat("Provide a list of embeds.")
+            if len(embeds) > 10:
+                raise error.IncorrectFormat("Do not provide more than 10 embeds.")
+            _resp["embeds"] = [e.to_dict() for e in embeds]
+
+        try:
+            embed = fields["embed"]
+        except KeyError:
+            pass
+        else:
+            if "embeds" in _resp:
+                raise error.IncorrectFormat("You can't use both `embed` and `embeds`!")
+
+            if embed is None:
+                _resp["embeds"] = []
+            else:
+                _resp["embeds"] = [embed.to_dict()]
 
-        embed = fields.get("embed")
-        embeds = fields.get("embeds")
         file = fields.get("file")
         files = fields.get("files")
-        components = fields.get("components")
-
-        if components:
-            _resp["components"] = components
 
-        if embed and embeds:
-            raise error.IncorrectFormat("You can't use both `embed` and `embeds`!")
-        if file and files:
+        if files is not None and file is not None:
             raise error.IncorrectFormat("You can't use both `file` and `files`!")
         if file:
             files = [file]
-        if embed:
-            embeds = [embed]
-        if embeds:
-            if not isinstance(embeds, list):
-                raise error.IncorrectFormat("Provide a list of embeds.")
-            elif len(embeds) > 10:
-                raise error.IncorrectFormat("Do not provide more than 10 embeds.")
-            _resp["embeds"] = [x.to_dict() for x in embeds]
 
         allowed_mentions = fields.get("allowed_mentions")
-        _resp["allowed_mentions"] = (
-            allowed_mentions.to_dict()
-            if allowed_mentions
-            else self.bot.allowed_mentions.to_dict()
-            if self.bot.allowed_mentions
-            else {}
-        )
+        if allowed_mentions is not None:
+            if self.bot.allowed_mentions is not None:
+                _resp["allowed_mentions"] = self.bot.allowed_mentions.merge(
+                    allowed_mentions
+                ).to_dict()
+            else:
+                _resp["allowed_mentions"] = allowed_mentions.to_dict()
+        else:
+            if self.bot.allowed_mentions is not None:
+                _resp["allowed_mentions"] = self.bot.allowed_mentions.to_dict()
+            else:
+                _resp["allowed_mentions"] = {}
 
         if not self.responded:
             if files and not self.deferred:

discord_slash/dpy_overrides.py

@@ -23,7 +23,7 @@ def get_component(self, custom_id: int) -> typing.Optional[dict]:
         """
         for row in self.components:
             for component in row["components"]:
-                if component["custom_id"] == custom_id:
+                if "custom_id" in component and component["custom_id"] == custom_id:
                     return component