feat💥: make subcmds able to inherit checks from base cmds (#1274)

Co-authored-by: Astrea49 <25420078+Astrea49@users.noreply.github.com>

Author: AstreaTSS

interactions/ext/prefixed_commands/command.py

@@ -346,13 +346,6 @@ class PrefixedCommand(BaseCommand):
         ),
         default=True,
     )
-    hierarchical_checking: bool = attrs.field(
-        metadata=docs(
-            "If `True` and if the base of a subcommand, every subcommand underneath it will run this command's checks"
-            " and cooldowns before its own. Otherwise, only the subcommand's checks are checked."
-        ),
-        default=True,
-    )
     help: Optional[str] = attrs.field(repr=False, metadata=docs("The long help text for the command."), default=None)
     brief: Optional[str] = attrs.field(repr=False, metadata=docs("The short help text for the command."), default=None)
     parent: Optional["PrefixedCommand"] = attrs.field(
@@ -638,7 +631,7 @@ def subcommand(
         enabled: bool = True,
         hidden: bool = False,
         ignore_extra: bool = True,
-        hierarchical_checking: bool = True,
+        inherit_checks: bool = True,
     ) -> Callable[..., Self]:
         """
         A decorator to declare a subcommand for a prefixed command.
@@ -654,8 +647,7 @@ def subcommand(
             hidden: If `True`, the default help command (when it is added) does not show this in the help output.
             ignore_extra: If `True`, ignores extraneous strings passed to a command if all its requirements are met \
                 (e.g. ?foo a b c when only expecting a and b). Otherwise, an error is raised.
-            hierarchical_checking: If `True` and if the base of a subcommand, every subcommand underneath it will \
-                run this command's checks before its own. Otherwise, only the subcommand's checks are checked.
+            inherit_checks: If `True`, the subcommand will inherit its checks from the parent command.
         """
 
         def wrapper(func: Callable) -> Self:
@@ -670,7 +662,7 @@ def wrapper(func: Callable) -> Self:
                 enabled=enabled,
                 hidden=hidden,
                 ignore_extra=ignore_extra,
-                hierarchical_checking=hierarchical_checking,
+                checks=self.checks if inherit_checks else [],
             )
             self.add_command(cmd)
             return cmd
@@ -776,7 +768,6 @@ def prefixed_command(
     enabled: bool = True,
     hidden: bool = False,
     ignore_extra: bool = True,
-    hierarchical_checking: bool = True,
 ) -> Callable[..., PrefixedCommand]:
     """
     A decorator to declare a coroutine as a prefixed command.
@@ -792,8 +783,6 @@ def prefixed_command(
         hidden: If `True`, the default help command (when it is added) does not show this in the help output.
         ignore_extra: If `True`, ignores extraneous strings passed to a command if all its requirements are \
             met (e.g. ?foo a b c when only expecting a and b). Otherwise, an error is raised.
-        hierarchical_checking: If `True` and if the base of a subcommand, every subcommand underneath it will \
-            run this command's checks before its own. Otherwise, only the subcommand's checks are checked.
     """
 
     def wrapper(func: Callable) -> PrefixedCommand:
@@ -807,7 +796,6 @@ def wrapper(func: Callable) -> PrefixedCommand:
             enabled=enabled,
             hidden=hidden,
             ignore_extra=ignore_extra,
-            hierarchical_checking=hierarchical_checking,
         )
 
     return wrapper

interactions/ext/prefixed_commands/manager.py

@@ -324,18 +324,6 @@ async def _dispatch_prefixed_commands(self, event: RawGatewayEvent) -> None:
             command = new_command
             content_parameters = content_parameters.removeprefix(first_word).strip()
 
-            if command.subcommands and command.hierarchical_checking:
-                try:
-                    await new_command._can_run(context)  # will error out if we can't run this command
-                except Exception as e:
-                    if new_command.error_callback:
-                        await new_command.error_callback(e, context)
-                    elif new_command.extension and new_command.extension.extension_error:
-                        await new_command.extension.extension_error(e, context)
-                    else:
-                        self.client.dispatch(CommandError(ctx=context, error=e))
-                    return
-
         if not isinstance(command, PrefixedCommand) or not command.enabled:
             return
 

interactions/models/internal/application_commands.py

@@ -613,14 +613,16 @@ def wrapper(call: Callable[..., Coroutine]) -> Callable[..., Coroutine]:
         option_name = option_name.lower()
         return wrapper
 
-    def group(self, name: str = None, description: str = "No Description Set") -> "SlashCommand":
-
+    def group(
+        self, name: str = None, description: str = "No Description Set", inherit_checks: bool = True
+    ) -> "SlashCommand":
         return SlashCommand(
             name=self.name,
             description=self.description,
             group_name=name,
             group_description=description,
             scopes=self.scopes,
+            checks=self.checks if inherit_checks else [],
         )
 
     def subcommand(
@@ -631,6 +633,7 @@ def subcommand(
         group_description: Absent[LocalisedDesc | str] = MISSING,
         options: List[Union[SlashCommandOption, Dict]] = None,
         nsfw: bool = False,
+        inherit_checks: bool = True,
     ) -> Callable[..., "SlashCommand"]:
         def wrapper(call: Callable[..., Coroutine]) -> "SlashCommand":
             nonlocal sub_cmd_description
@@ -654,6 +657,7 @@ def wrapper(call: Callable[..., Coroutine]) -> "SlashCommand":
                 callback=call,
                 scopes=self.scopes,
                 nsfw=nsfw,
+                checks=self.checks if inherit_checks else [],
             )
 
         return wrapper

interactions/models/internal/command.py

@@ -304,6 +304,10 @@ async def _can_run(self, context: "BaseContext") -> bool:
                 await self.max_concurrency.release(context)
             raise
 
+    def add_check(self, check: Callable[..., Awaitable[bool]]) -> None:
+        """Adds a check into the command."""
+        self.checks.append(check)
+
     def error(self, call: Callable[..., Coroutine]) -> Callable[..., Coroutine]:
         """A decorator to declare a coroutine as one that will be run upon an error."""
         if not asyncio.iscoroutinefunction(call):