Added permission decorators; Improved auto sync

Author: EQUENOS

disnake/app_commands.py

@@ -471,13 +471,20 @@ class ApplicationCommandPermissions:
     __slots__ = ("id", "type", "permission")
 
     def __init__(self, *, data: Dict[str, Any]):
-        self.id: int = data["id"]
+        self.id: int = int(data["id"])
         self.type: int = data["type"]
         self.permission: bool = data["permission"]
 
     def __repr__(self):
         return f"<ApplicationCommandPermissions id={self.id!r} type={self.type!r} permission={self.permission!r}>"
 
+    def __eq__(self, other):
+        return (
+            self.id == other.id
+            and self.type == other.type
+            and self.permission == other.permission
+        )
+
     def to_dict(self) -> Dict[str, Any]:
         return {
             "id": self.id,

disnake/client.py

@@ -63,7 +63,7 @@
 from .backoff import ExponentialBackoff
 from .channel import PartialMessageable, _threaded_channel_factory
 from .emoji import Emoji
-from .enums import ChannelType, Status, VoiceRegion
+from .enums import ApplicationCommandType, ChannelType, Status, VoiceRegion
 from .errors import *
 from .flags import ApplicationFlags, Intents
 from .gateway import *
@@ -1134,23 +1134,25 @@ def get_guild_command(self, guild_id: int, id: int) -> Optional[ApplicationComma
         """
         return self._connection._get_guild_application_command(guild_id, id)
 
-    def get_global_command_named(self, name: str) -> Optional[ApplicationCommand]:
+    def get_global_command_named(self, name: str, cmd_type: ApplicationCommandType = None) -> Optional[ApplicationCommand]:
         """
         Returns a global application command matching the specified name.
 
         Parameters
         ----------
         name: :class:`str`
-            The name to search for.
+            The name to look for.
+        cmd_type: :class:`ApplicationCommandType`
+            The type to look for. By default, no types are checked.
         
         Returns
         -------
         :class:`ApplicationCommand`
             The application command.
         """
-        return self._connection._get_global_command_named(name)
+        return self._connection._get_global_command_named(name, cmd_type)
 
-    def get_guild_command_named(self, guild_id: int, name: str) -> Optional[ApplicationCommand]:
+    def get_guild_command_named(self, guild_id: int, name: str, cmd_type: ApplicationCommandType = None) -> Optional[ApplicationCommand]:
         """
         Returns a guild application command matching the name.
 
@@ -1160,13 +1162,15 @@ def get_guild_command_named(self, guild_id: int, name: str) -> Optional[Applicat
             The guild ID to search for.
         name: :class:`str`
             The command name to search for.
+        cmd_type: :class:`ApplicationCommandType`
+            The type to look for. By default, no types are checked.
         
         Returns
         -------
         :class:`ApplicationCommand`
             The application command.
         """
-        return self._connection._get_guild_command_named(guild_id, name)
+        return self._connection._get_guild_command_named(guild_id, name, cmd_type)
 
     # listeners/waiters
 

disnake/ext/commands/base_core.py

@@ -25,15 +25,17 @@
 from typing import (
     Any,
     Callable,
+    Dict,
     List,
+    Mapping,
     Optional,
     TypeVar,
     TYPE_CHECKING
 )
 import asyncio
 import datetime
 
-from disnake.app_commands import ApplicationCommand
+from disnake.app_commands import ApplicationCommand, PartialGuildApplicationCommandPermissions
 from disnake.enums import ApplicationCommandType
 from disnake.utils import async_all, maybe_coroutine
 
@@ -47,7 +49,7 @@
     from .cog import Cog
 
 
-__all__ = ('InvokableApplicationCommand',)
+__all__ = ('InvokableApplicationCommand', 'guild_permissions')
 
 
 T = TypeVar('T')
@@ -81,9 +83,16 @@ def __init__(self, func, *, name: str = None, **kwargs):
         self.qualified_name: str = self.name
         # only an internal feature for now
         self.guild_only: bool = kwargs.get('guild_only', False)
+
         if not isinstance(self.name, str):
             raise TypeError('Name of a command must be a string.')
 
+        try:
+            perms = func.__app_command_permissions__
+        except AttributeError:
+            perms = {}
+        self.permissions: Dict[int, PartialGuildApplicationCommandPermissions] = perms
+
         try:
             checks = func.__commands_checks__
             checks.reverse()
@@ -496,3 +505,34 @@ async def can_run(self, inter: ApplicationCommandInteraction) -> bool:
             return await async_all(predicate(inter) for predicate in predicates)  # type: ignore
         finally:
             inter.application_command = original
+
+
+def guild_permissions(
+    guild_id: int,
+    role_ids: Mapping[int, bool] = None,
+    user_ids: Mapping[int, bool] = None,
+) -> Callable[[T], T]:
+    """
+    A decorator that sets application command permissions in the specified guild.
+    This type of permissions "greys out" the command in the command picker.
+    If you want to change this type of permissions dynamically, this decorator is not useful.
+
+    Parameters
+    ----------
+    guild_id: :class:`int`
+        the ID of the guild to apply the permissions to.
+    role_ids: Mapping[:class:`int`, :class:`bool`]
+        a mapping of role IDs to boolean values indicating the permission. ``True`` = allow, ``False`` = deny.
+    user_ids: Mapping[:class:`int`, :class:`bool`]
+        a mapping of user IDs to boolean values indicating the permission. ``True`` = allow, ``False`` = deny.
+    """
+    perms = PartialGuildApplicationCommandPermissions(0, role_ids=role_ids, user_ids=user_ids)
+    def decorator(func: T) -> T:
+        if isinstance(func, InvokableApplicationCommand):
+            func.permissions[guild_id] = perms
+        else:
+            if not hasattr(func, "__app_command_permissions__"):
+                func.__app_command_permissions__ = {} # type: ignore
+            func.__app_command_permissions__[guild_id] = perms # type: ignore
+        return func
+    return decorator

disnake/ext/commands/bot.py

@@ -138,7 +138,7 @@ class Bot(BotBase, InteractionBotBase, disnake.Client):
     sync_commands: :class:`bool`
         Whether to enable automatic synchronization of application commands in your code.
         Defaults to ``True``, which means that commands in API are automatically synced
-        with the commands in your code. Defaults to ``True``.
+        with the commands in your code.
 
         .. versionadded:: 2.1
     sync_commands_on_cog_unload: :class:`bool`
@@ -151,6 +151,9 @@ class Bot(BotBase, InteractionBotBase, disnake.Client):
         Defaults to ``False``.
 
         .. versionadded:: 2.1
+    sync_permissions: :class:`bool`
+        Whether to enable automatic synchronization of app command permissions in your code.
+        Defaults to ``False``.
     reload: :class:`bool`
         Whether to enable automatic extension reloading on file modification for debugging.
         Whenever you save an extension with reloading enabled the file will be automatically
@@ -199,7 +202,7 @@ class InteractionBot(InteractionBotBase, disnake.Client):
     sync_commands: :class:`bool`
         Whether to enable automatic synchronization of application commands in your code.
         Defaults to ``True``, which means that commands in API are automatically synced
-        with the commands in your code. Defaults to ``True``.
+        with the commands in your code.
 
         .. versionadded:: 2.1
     sync_commands_on_cog_unload: :class:`bool`
@@ -211,6 +214,11 @@ class InteractionBot(InteractionBotBase, disnake.Client):
         Useful for tracking the commands being registered in the API.
         Defaults to ``False``.
 
+        .. versionadded:: 2.1
+    sync_permissions: :class:`bool`
+        Whether to enable automatic synchronization of app command permissions in your code.
+        Defaults to ``False``.
+
         .. versionadded:: 2.1
     reload: :class:`bool`
         Whether to enable automatic extension reloading on file modification for debugging.

disnake/ext/commands/ctx_menus_core.py

@@ -73,7 +73,16 @@ class InvokableUserCommand(InvokableApplicationCommand):
         Whether to sync the command in the API with ``body`` or not.
     """
 
-    def __init__(self, func, *, name: str = None, default_permission: bool = True, guild_ids: Sequence[int] = None, auto_sync: bool = True, **kwargs):
+    def __init__(
+        self,
+        func,
+        *,
+        name: str = None,
+        default_permission: bool = True,
+        guild_ids: Sequence[int] = None,
+        auto_sync: bool = True,
+        **kwargs
+    ):
         super().__init__(func, name=name, **kwargs)
         self.guild_ids: Optional[Sequence[int]] = guild_ids
         self.auto_sync: bool = auto_sync
@@ -130,7 +139,16 @@ class InvokableMessageCommand(InvokableApplicationCommand):
         Whether to sync the command in the API with ``body`` or not.
     """
 
-    def __init__(self, func, *, name: str = None, default_permission: bool = True, guild_ids: Sequence[int] = None, auto_sync: bool = True, **kwargs):
+    def __init__(
+        self,
+        func,
+        *,
+        name: str = None,
+        default_permission: bool = True,
+        guild_ids: Sequence[int] = None,
+        auto_sync: bool = True,
+        **kwargs
+    ):
         super().__init__(func, name=name, **kwargs)
         self.guild_ids: Optional[Sequence[int]] = guild_ids
         self.auto_sync: bool = auto_sync
@@ -174,11 +192,13 @@ def user_command(
 
     Parameters
     ----------
-    auto_sync: :class:`bool`
-        whether to automatically register / edit the command or not. Defaults to ``True``
     name: :class:`str`
         name of the user command you want to respond to (equals to function name by default).
-    guild_ids: List[:class:`int`]
+    default_permission: :class:`bool`
+        whether the command is enabled by default when the app is added to a guild.
+    auto_sync: :class:`bool`
+        whether to automatically register / edit the command or not. 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 in ~1 hour.
 
@@ -198,7 +218,14 @@ def decorator(
             raise TypeError(f"<{func.__qualname__}> must be a coroutine function")
         if hasattr(func, "__command_flag__"):
             raise TypeError("Callback is already a command.")
-        return InvokableUserCommand(func, name=name, default_permission=default_permission, guild_ids=guild_ids, auto_sync=auto_sync, **kwargs)
+        return InvokableUserCommand(
+            func,
+            name=name,
+            default_permission=default_permission,
+            guild_ids=guild_ids,
+            auto_sync=auto_sync,
+            **kwargs
+        )
 
     return decorator
 
@@ -219,11 +246,13 @@ def message_command(
 
     Parameters
     ----------
-    auto_sync: :class:`bool`
-        whether to automatically register / edit the command or not. Defaults to ``True``
     name: :class:`str`
         name of the message command you want to respond to (equals to function name by default).
-    guild_ids: List[:class:`int`]
+    default_permission: :class:`bool`
+        whether the command is enabled by default when the app is added to a guild.
+    auto_sync: :class:`bool`
+        whether to automatically register / edit the command or not. 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 in ~1 hour.
 
@@ -243,6 +272,13 @@ def decorator(
             raise TypeError(f"<{func.__qualname__}> must be a coroutine function")
         if hasattr(func, "__command_flag__"):
             raise TypeError("Callback is already a command.")
-        return InvokableMessageCommand(func, name=name, default_permission=default_permission, guild_ids=guild_ids, auto_sync=auto_sync, **kwargs)
+        return InvokableMessageCommand(
+            func,
+            name=name,
+            default_permission=default_permission,
+            guild_ids=guild_ids,
+            auto_sync=auto_sync,
+            **kwargs
+        )
 
     return decorator