make stack introspection more bulletproof

Author: bckohan

django_typer/__init__.py

@@ -124,6 +124,7 @@
 )
 from .utils import (
     _command_context,
+    called_from_command_definition,
     called_from_module,
     get_usage_script,
     is_method,
@@ -258,7 +259,7 @@ def handle(
 
 
 class CallableCommand(t.Protocol):
-    def __call__(self, *args: t.Any, **kwargs: t.Any) -> t.Any: ...
+    def __call__(self, *args: t.Any, **kwargs: t.Any) -> t.Any: ...  # pragma: no cover
 
 
 @t.overload  # pragma: no cover
@@ -698,6 +699,10 @@ def grp(self):
     """
 
 
+# staticmethod objects are not picklable which causes problems with deepcopy
+# hence the following mishegoss
+
+
 @t.overload  # pragma: no cover
 def _check_static(
     func: typer.models.CommandFunctionType,
@@ -710,7 +715,8 @@ def _check_static(func: None) -> None: ...
 
 def _check_static(func):
     """
-    Check if a function is a staticmethod and return it if it is.
+    Check if a function is a staticmethod and return it if it is otherwise make
+    it static if it should be but isn't.
     """
     if func and not is_method(func) and not isinstance(func, staticmethod):
         return staticmethod(func)
@@ -805,6 +811,11 @@ def _get_direct_function(
 
 
 class AppFactory(type):
+    """
+    A metaclass used to define/set Command classes into the defining module when
+    the Typer-like functional interface is used.
+    """
+
     def __call__(self, *args, **kwargs) -> "Typer":
         if called_from_module():
             frame = inspect.currentframe()
@@ -819,6 +830,7 @@ class Command(
                 ):
                     pass
 
+                Command.__module__ = cmd_module.__name__  # spoof it hard
                 setattr(cmd_module, "Command", Command)
                 return Command.typer_app
             else:
@@ -2066,7 +2078,7 @@ def __getattr__(cls, name: str) -> t.Any:
             Command.sub_grp or Command.sub_cmd
         """
         if name != "typer_app":
-            if not called_from_module():
+            if called_from_command_definition():
                 if name in cls._defined_groups:
                     return cls._defined_groups[name]
             elif cls.typer_app:
@@ -2528,7 +2540,7 @@ def init(self, ...):
         :param rich_help_panel: the rich help panel to use - if rich is installed
             this can be used to group commands into panels in the help output.
         """
-        if not called_from_module():
+        if called_from_command_definition():
             return initialize(
                 name=name,
                 cls=cls,
@@ -2632,7 +2644,7 @@ def new_command(self, ...):
         :param rich_help_panel: the rich help panel to use - if rich is installed
             this can be used to group commands into panels in the help output.
         """
-        if not called_from_module():
+        if called_from_command_definition():
             return command(
                 name=name,
                 cls=cls,
@@ -2739,7 +2751,7 @@ def grp_command(self, ...):
         :param rich_help_panel: the rich help panel to use - if rich is installed
             this can be used to group commands into panels in the help output.
         """
-        if not called_from_module():
+        if called_from_command_definition():
             return group(
                 name=name,
                 cls=cls,

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

@@ -21,7 +21,7 @@ def command1(self, option: t.Optional[str] = None):
         print("command1")
         return option
 
-    @command()
+    @TyperCommand.command()
     def command2(self, option: t.Optional[str] = None):
         """This is a *markdown* help string"""
         print("command2")

django_typer/tests/test_adapter_pattern.py

@@ -1082,7 +1082,7 @@ def test_group_adapter_precedence(self):
         #     adapted2.__class__.subsub_grp2(),
         #     "adapter2::adapted2()::grp2()::sub_grp2()::subsub_grp2()",
         # )
-        self.assertFalse(hasattr(adapted2.__class__, "subsub_grp2"))
+        self.assertTrue(hasattr(adapted2.__class__, "subsub_grp2"))
         self.assertEqual(
             adapted2.subsub_grp2(),
             "adapter2::adapted2()::grp2()::sub_grp2()::subsub_grp2()",

django_typer/tests/test_interface.py

@@ -262,6 +262,7 @@ def test_action_nargs(self):
         self.assertEqual(multi_parser._actions[8].nargs, 0)
 
     def test_cmd_getattr(self):
+        from django_typer import TyperCommand
         from django_typer.tests.apps.test_app.management.commands.groups import (
             Command as Groups,
         )
@@ -278,3 +279,9 @@ def test_cmd_getattr(self):
             self.assertFalse(True, "should have thrown AttributeError")
         except AttributeError as e:
             pass
+
+        try:
+            TyperCommand.does_not_exist
+            self.assertFalse(True, "should have thrown AttributeError")
+        except AttributeError as e:
+            pass

django_typer/utils.py

@@ -9,6 +9,7 @@
 import shutil
 import sys
 import typing as t
+from functools import partial
 from pathlib import Path
 from threading import local
 from types import MethodType, ModuleType
@@ -163,21 +164,27 @@ def load_command_extensions(command: str) -> int:
     return len(extensions)
 
 
-def called_from_module() -> bool:
+def _check_call_frame(frame_name: str) -> bool:
     """
-    Returns True if the stack frame one frame above where this function is called was at module
-    scope. Regrettable interface simplifying voodoo. This is, at least, reliable.
+    Returns True if the stack frame one frame above where this function has the given
+    name.
+
+    :param frame_name: The name of the frame to check for
     """
     frame = inspect.currentframe()
     for _ in range(0, 2):
         if not frame:
             break
         frame = frame.f_back
     if frame:
-        return frame.f_code.co_name == "<module>"
+        return frame.f_code.co_name == frame_name
     return False
 
 
+called_from_module = partial(_check_call_frame, "<module>")
+called_from_command_definition = partial(_check_call_frame, "Command")
+
+
 def is_method(
     func_or_params: t.Optional[t.Union[t.Callable[..., t.Any], t.List[str]]],
 ) -> t.Optional[bool]: