Added group and command decorators with their classes

Author: marcusfrdk

click_with_alias/__init__.py

@@ -0,0 +1,4 @@
+""" This module is the entry point for the package. """
+
+from .command import command
+from .group import group

click_with_alias/_aliased_command.py

@@ -0,0 +1,11 @@
+""" AliasedCommand class for Click commands with alias support. """
+
+import click
+
+
+class AliasedCommand(click.Command):
+    """A Click command that supports aliasing."""
+
+    def __init__(self, *args, **kwargs):
+        self.aliases = kwargs.pop("aliases", [])
+        super().__init__(*args, **kwargs)

click_with_alias/_aliased_group.py

@@ -0,0 +1,54 @@
+""" AliasedGroup class for click_with_alias. """
+
+import click
+
+
+class AliasedGroup(click.Group):
+    """A Click group that supports aliasing."""
+
+    def add_command(self, cmd: click.Command, name=None) -> None:
+        """
+        Add a command to the group.
+
+        Args:
+            cmd: click.Command - The command to add.
+            name: str - The name of the command.
+        Returns:
+            None
+        Raises:
+            ValueError: If the command name is already taken.
+        """
+        aliases = getattr(cmd, "aliases", [])
+        super().add_command(cmd, name)
+        for alias in aliases:
+            super().add_command(cmd, alias)
+
+    def format_commands(
+        self, ctx: click.Context, formatter: click.HelpFormatter
+    ) -> None:
+        """
+        Format the commands for the group.
+
+        Args:
+            ctx: click.Context - The click context.
+            formatter: click.HelpFormatter - The help formatter.
+        Returns:
+            None
+        Raises:
+            None
+        """
+        commands = {}
+        for name, cmd in self.commands.items():
+            if name == cmd.name:
+                aliases = getattr(cmd, "aliases", [])
+                if aliases:
+                    name = f"{name} ({', '.join(aliases)})"
+                commands[name] = cmd
+
+        rows = [
+            (name, cmd.get_short_help_str()) for name, cmd in commands.items()
+        ]
+
+        if rows:
+            with formatter.section("Commands"):
+                formatter.write_dl(rows)

click_with_alias/command.py

@@ -0,0 +1,50 @@
+""" The command decorator with alias support. """
+
+from typing import Callable
+
+import click
+
+from ._aliased_command import AliasedCommand
+
+
+def command(
+    name: str, *args, aliases: list[str] = None, **kwargs
+) -> click.Command:
+    """
+    The command decorator with aliasing support which replaces the default Click command decorator.
+
+    Usage:
+        @command(name="my_command)
+
+        @command(name="my_command), aliases=["mc])
+    Args:
+        name: str - The name of the command.
+        aliases: list[str] - The list of aliases for the command.
+        *args: Any - Additional arguments.
+        **kwargs: Any - Additional keyword arguments.
+    Returns:
+        click.Command - The Click command decorator.
+    Raises:
+        None
+    """
+
+    command_decorator = click.command(
+        name=name, cls=AliasedCommand, *args, **kwargs
+    )
+
+    def decorator(fn: Callable) -> click.Command:
+        """
+        Decorator for creating a command.
+
+        Args:
+            fn: Callable - The function to decorate.
+        Returns:
+            click.Command - The Click command.
+        Raises:
+            None
+        """
+        cmd = command_decorator(fn)
+        cmd.aliases = aliases or []
+        return cmd
+
+    return decorator

click_with_alias/group.py

@@ -0,0 +1,40 @@
+""" The group decorator with alias support. """
+
+import click
+
+from ._aliased_group import AliasedGroup
+
+
+def group(
+    *args, name: str = None, aliases: list[str] = None, **kwargs
+) -> click.Group:
+    """
+    The group decorator with aliasing support
+    which replaces the default Click group decorator.
+
+    Usage:
+        @group(name="my_group)
+
+        @group(name="my_group", aliases=["mg"])
+    Args:
+        name: str - The name of the group.
+        aliases: list[str] - The list of aliases for the group.
+        *args: Any - Additional arguments.
+        **kwargs: Any - Additional keyword arguments.
+    Returns:
+        click.Group - The Click group decorator.
+    Raises:
+        None
+    """
+
+    def decorator(func) -> click.Group:
+        """Decorator for creating a group."""
+        inferred_name = name or func.__name__
+        group_decorator = click.group(
+            name=inferred_name, cls=AliasedGroup, *args, **kwargs
+        )
+        cmd = group_decorator(func)
+        cmd.aliases = aliases or []
+        return cmd
+
+    return decorator