Merge pull request #662 from Dorukyum/commandpermission

Rename Permission to CommandPermission

Author: Middledot

discord/commands/commands.py

@@ -35,7 +35,7 @@
 
 from .context import ApplicationContext, AutocompleteContext
 from .errors import ApplicationCommandError, CheckFailure, ApplicationCommandInvokeError
-from .permissions import Permission
+from .permissions import CommandPermission
 from ..enums import SlashCommandOptionType, ChannelType
 from ..errors import ValidationError, ClientException
 from ..member import Member
@@ -355,7 +355,7 @@ class SlashCommand(ApplicationCommand):
         isn't one.
     default_permission: :class:`bool`
         Whether the command is enabled by default when it is added to a guild.
-    permissions: List[:class:`Permission`]
+    permissions: List[:class:`CommandPermission`]
         The permissions for this command.
 
         .. note::
@@ -420,7 +420,7 @@ def __init__(self, func: Callable, *args, **kwargs) -> None:
 
         # Permissions
         self.default_permission = kwargs.get("default_permission", True)
-        self.permissions: List[Permission] = getattr(func, "__app_cmd_perms__", []) + kwargs.get("permissions", [])
+        self.permissions: List[CommandPermission] = getattr(func, "__app_cmd_perms__", []) + kwargs.get("permissions", [])
         if self.permissions and self.default_permission:
             self.default_permission = False
 
@@ -800,7 +800,7 @@ def __init__(
 
         # Permissions
         self.default_permission = kwargs.get("default_permission", True)
-        self.permissions: List[Permission] = kwargs.get("permissions", [])
+        self.permissions: List[CommandPermission] = kwargs.get("permissions", [])
         if self.permissions and self.default_permission:
             self.default_permission = False
 

discord/commands/permissions.py

@@ -26,15 +26,15 @@
 from typing import Union, Dict, Callable
 
 __all__ = (
-    "Permission",
+    "CommandPermission",
     "has_role",
     "has_any_role",
     "is_user",
     "is_owner",
     "permission",
 )
 
-class Permission:
+class CommandPermission:
     """The class used in the application command decorators
     to hash permission data into a dictionary using the
     :meth:`to_dict` method to be sent to the discord API later on.
@@ -87,9 +87,9 @@ def permission(role_id: int = None, user_id: int = None, permission: bool = True
     """
     def decorator(func: Callable):
         if not role_id is None:
-            app_cmd_perm = Permission(role_id, 1, permission, guild_id)
+            app_cmd_perm = CommandPermission(role_id, 1, permission, guild_id)
         elif not user_id is None:
-            app_cmd_perm = Permission(user_id, 2, permission, guild_id)
+            app_cmd_perm = CommandPermission(user_id, 2, permission, guild_id)
         else:
             raise ValueError("role_id or user_id must be specified!")
 
@@ -126,7 +126,7 @@ def decorator(func: Callable):
             func.__app_cmd_perms__ = []
 
         # Permissions (Will Convert ID later in register_commands if needed)
-        app_cmd_perm = Permission(item, 1, True, guild_id) #{"id": item, "type": 1, "permission": True}
+        app_cmd_perm = CommandPermission(item, 1, True, guild_id) #{"id": item, "type": 1, "permission": True}
 
         # Append
         func.__app_cmd_perms__.append(app_cmd_perm)
@@ -159,7 +159,7 @@ def decorator(func: Callable):
 
         # Permissions (Will Convert ID later in register_commands if needed)
         for item in items:
-            app_cmd_perm = Permission(item, 1, True, guild_id) #{"id": item, "type": 1, "permission": True}
+            app_cmd_perm = CommandPermission(item, 1, True, guild_id) #{"id": item, "type": 1, "permission": True}
 
             # Append
             func.__app_cmd_perms__.append(app_cmd_perm)
@@ -189,7 +189,7 @@ def decorator(func: Callable):
             func.__app_cmd_perms__ = []
 
         # Permissions (Will Convert ID later in register_commands if needed)
-        app_cmd_perm = Permission(user, 2, True, guild_id) #{"id": user, "type": 2, "permission": True}
+        app_cmd_perm = CommandPermission(user, 2, True, guild_id) #{"id": user, "type": 2, "permission": True}
 
         # Append
         func.__app_cmd_perms__.append(app_cmd_perm)
@@ -218,7 +218,7 @@ def decorator(func: Callable):
             func.__app_cmd_perms__ = []
 
         # Permissions (Will Convert ID later in register_commands if needed)
-        app_cmd_perm = Permission("owner", 2, True, guild_id) #{"id": "owner", "type": 2, "permission": True}
+        app_cmd_perm = CommandPermission("owner", 2, True, guild_id) #{"id": "owner", "type": 2, "permission": True}
 
         # Append
         func.__app_cmd_perms__.append(app_cmd_perm)

examples/app_commands/slash_cog_groups.py

@@ -1,5 +1,5 @@
 import discord
-from discord.commands import SlashCommandGroup, Permission
+from discord.commands import SlashCommandGroup, CommandPermission
 from discord.ext import commands
 
 bot = discord.Bot(debug_guild=..., owner_id=...)  # main file
@@ -19,7 +19,7 @@ def __init__(self, bot):
         "secret_greetings",
         "Secret greetings",
         permissions=[
-            Permission(
+            CommandPermission(
                 "owner", 2, True
             )  # Ensures the owner_id user can access this, and no one else
         ],

examples/app_commands/slash_perms.py

@@ -24,8 +24,12 @@
 # Ex: @permissions.has_role("Admin", guild_id=GUILD_ID)
 # --------------------------------------------
 # or supply permissions directly in @bot.slash_command
-# @bot.slash_command(default_permission=False,
-#                   permissions=[permissions.Permission(id=ID, type=TYPE, permission=True, guild_id=GUILD_ID)])
+# @bot.slash_command(
+#     default_permission=False,
+#     permissions=[
+#          permissions.CommandPermission(id=ID, type=TYPE, permission=True, guild_id=GUILD_ID)
+#     ]
+# )
 
 # Note: Please replace token, GUILD_ID, USER_ID and ROLE_NAME.
 
@@ -78,7 +82,7 @@ async def permission_decorator(ctx):
 @bot.slash_command(
     guild_ids=[GUILD_ID],
     default_permission=False,
-    permissions=[permissions.Permission(id=USER_ID, type=2, permission=True)],
+    permissions=[permissions.CommandPermission(id=USER_ID, type=2, permission=True)],
 )
 async def permission_kwarg(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring