make commands callable

Author: bckohan

django_typer/__init__.py

@@ -257,6 +257,10 @@ def handle(
     }
 
 
+class CallableCommand(t.Protocol):
+    def __call__(self, *args: t.Any, **kwargs: t.Any) -> t.Any: ...
+
+
 @t.overload  # pragma: no cover
 def get_command(  # type: ignore[overload-overlap]
     command_name: str,
@@ -265,7 +269,7 @@ def get_command(  # type: ignore[overload-overlap]
     no_color: bool = False,
     force_color: bool = False,
     **kwargs,
-) -> BaseCommand: ...
+) -> CallableCommand: ...
 
 
 @t.overload  # pragma: no cover
@@ -344,6 +348,13 @@ def get_command(
         from myapp.management.commands import Command as Hierarchy
         hierarchy: Hierarchy = get_command('hierarchy', Hierarchy)
 
+    .. note::
+
+        If get_command fetches a BaseCommand that does not implement __call__ get_command will
+        make the command callable by adding a __call__ method that calls the handle method of
+        the BaseCommand. This allows you to call the command like get_command("command")() with
+        confidence.
+
     :param command_name: the name of the command to get
     :param path: the path walking down the group/command tree
     :param stdout: the stdout stream to use
@@ -367,6 +378,13 @@ def get_command(
     if path and (isinstance(path[0], str) or len(path) > 1):
         return t.cast(TyperCommand, cmd).get_subcommand(*path).callback
 
+    if not hasattr(cmd, "__call__"):
+        setattr(
+            cmd.__class__,
+            "__call__",
+            lambda self, *args, **options: self.handle(*args, **options),
+        )
+
     return cmd
 
 

django_typer/management/commands/shellcompletion.py

@@ -589,7 +589,7 @@ def get_completion() -> None:
                                 cmd_str=cmd_str
                             )
                         ) from err
-                    return  # otherwise nowhere to go - just empty out
+                    raise  # otherwise nowhere to go
 
                 if isinstance(cmd, TyperCommand):  # type: ignore[unreachable]
                     # this will exit out so no return is needed here

django_typer/tests/apps/test_app/management/commands/base.py

@@ -0,0 +1,6 @@
+from django.core.management import BaseCommand
+
+
+class Command(BaseCommand):
+    def handle(self, *args, **options):
+        return f"base({args}, {options})"

django_typer/tests/test_basics.py

@@ -118,3 +118,10 @@ def test_renaming(self):
         self.assertEqual(get_command("rename", TyperCommand)(), "handle")
         self.assertEqual(get_command("rename", Rename).subcommand1(), "subcommand1")
         self.assertEqual(get_command("rename", Rename).subcommand2(), "subcommand2")
+
+    def test_get_command_make_callable(self):
+        args = (1, 2, 3)
+        kwargs = {"named": "test!"}
+        self.assertEqual(
+            get_command("base")(*args, **kwargs), f"base({args}, {kwargs})"
+        )