fix #74 fix #69

Author: bckohan

.github/workflows/lint.yml

@@ -66,14 +66,6 @@ jobs:
       - name: Run Static Analysis
         run: |
           source .venv/bin/activate
-          ruff format --check django_typer
-          ruff check --no-fix --select I django_typer
-          ruff check django_typer
-          mypy django_typer
-          pyright
-          poetry check
-          pip check
+          ./check.sh --no-fix
           python -m readme_renderer ./README.md -o /tmp/README.html
-          cd ./doc
-          doc8 --ignore-path build --max-line-length 100
           echo "$(poetry env info --path)/bin" >> $GITHUB_PATH

check.sh

@@ -1,8 +1,21 @@
-poetry run ruff format
-poetry run ruff format --line-length 80 django_typer/tests/apps/examples
-poetry run ruff check --fix --select I
-poetry run ruff check --fix
+set -e  # Exit immediately if a command exits with a non-zero status.
+
+if [ "$1" == "--no-fix" ]; then
+    poetry run ruff format --check
+    poetry run ruff format --line-length 80 --check examples
+    poetry run ruff check --select I
+    poetry run ruff check
+else
+    poetry run ruff format
+    poetry run ruff format --line-length 80 examples
+    poetry run ruff check --fix --select I
+    poetry run ruff check --fix
+fi
+
 poetry run mypy django_typer
 pyright
 poetry check
 poetry run pip check
+cd ./doc
+poetry run doc8 --ignore-path build --max-line-length 100 -q
+cd ..

django_typer/__init__.py

@@ -2011,7 +2011,18 @@ def _resolve_help(dj_cmd: "TyperCommand"):
 
     :param dj_cmd: The TyperCommand to resolve the help string for.
     """
-    hlp = dj_cmd.__class__.__doc__
+    hlp = None
+    for cmd_cls in [
+        dj_cmd.__class__,
+        *[
+            c
+            for c in dj_cmd.__class__.__mro__
+            if issubclass(c, TyperCommand) and c is not TyperCommand
+        ],
+    ]:
+        hlp = cmd_cls.__doc__
+        if hlp:
+            break
     if hlp:
         if dj_cmd.typer_app.registered_callback:
             cb = dj_cmd.typer_app.registered_callback
@@ -2154,10 +2165,18 @@ def __new__(
                     "short", pretty_exceptions_short
                 )
 
+            attr_help = attrs.get("help", Default(None))
+            if not help:
+                for base in [base for base in bases if issubclass(base, TyperCommand)]:
+                    if isinstance(help, DefaultPlaceholder):
+                        help = base._help_kwarg  # type: ignore[unreachable]
+                    if isinstance(attr_help, DefaultPlaceholder):
+                        attr_help = base.help
+
             typer_app = Typer(
                 name=name or attrs["__module__"].rsplit(".", maxsplit=1)[-1],
                 # cls=cls,
-                help=help or attrs.get("help", Default(None)),
+                help=help or attr_help,  # pyright: ignore[reportArgumentType]
                 invoke_without_command=invoke_without_command,
                 no_args_is_help=no_args_is_help,
                 subcommand_metavar=subcommand_metavar,
@@ -2187,6 +2206,12 @@ def __new__(
                 **attrs,
                 "typer_app": typer_app,
             }
+        else:
+            # we do this to avoid typing complaints on handle overrides
+            attrs["handle"] = attrs.pop("_run")
+
+        if help:
+            attrs["_help_kwarg"] = help
 
         return super().__new__(mcs, cls_name, bases, attrs)
 
@@ -2206,6 +2231,7 @@ def get_ctor(attr: t.Any) -> t.Optional[t.Callable[..., t.Any]]:
 
             # because we're mapping a non-class based interface onto a class based
             # interface, we have to handle this class mro stuff manually here
+            handle = None  # there can be only one or none
             for cmd_cls, cls_attrs in [
                 *[(base, vars(base)) for base in reversed(bases)],
                 (cls, attrs),
@@ -2222,23 +2248,25 @@ def get_ctor(attr: t.Any) -> t.Optional[t.Callable[..., t.Any]]:
                     elif register := get_ctor(attr):
                         to_register.append(register)
 
-                if cmd_cls._handle:
-                    ctor = get_ctor(cmd_cls._handle)
-                    if ctor:
-                        ctor(
-                            cls,
-                            _name=cls.typer_app.info.name,
-                            _help=getattr(cls, "help", None),
-                        )
-                    else:
-                        cls.typer_app.command(
-                            cls.typer_app.info.name,
-                            help=cls.typer_app.info.help or None,
-                        )(cmd_cls._handle)
+                handle = cmd_cls._handle or handle
 
                 for cmd in to_register:
                     cmd(cls)
 
+            if handle:
+                ctor = get_ctor(handle)
+                if ctor:
+                    ctor(
+                        cls,
+                        _name=cls.typer_app.info.name,
+                        _help=getattr(cls, "help", None),
+                    )
+                else:
+                    cls.typer_app.command(
+                        cls.typer_app.info.name,
+                        help=cls.typer_app.info.help or None,
+                    )(handle)
+
             _add_common_initializer(cls)
 
         super().__init__(cls_name, bases, attrs, **kwargs)
@@ -2619,9 +2647,16 @@ def command2(self, option: t.Optional[str] = None):
     force_color: bool = False
     _handle: t.Callable[..., t.Any]
     _traceback: bool = False
+    _help_kwarg: t.Optional[str] = Default(None)
+
+    help: t.Optional[t.Union[DefaultPlaceholder, str]] = Default(None)  # type: ignore
 
     command_tree: CommandNode
 
+    # allow deriving commands to override handle() from BaseCommand
+    # without triggering static type checking complaints
+    handle = None  # type: ignore
+
     @classmethod
     def initialize(
         cmd,  # pyright: ignore[reportSelfClsParameterName]
@@ -3189,7 +3224,8 @@ def handle(self, option1: bool, option2: bool):
                 ).format(cls=self.__class__)
             )
 
-    def handle(self, *args, **options):
+    @t.no_type_check
+    def _run(self, *args, **options):
         """
         Invoke the underlying Typer app with the given arguments and parameters.
 

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

@@ -1,5 +1,5 @@
 from click import get_current_context
-
+import typing as t
 from django_typer import TyperCommand, command, initialize
 
 

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

@@ -0,0 +1,13 @@
+import json
+
+from django.utils.translation import gettext_lazy as _
+
+from .help_precedence9 import Command as BaseCommand
+
+
+# should inherit docstring up from base
+class Command(BaseCommand):
+    def handle(self, arg1: str, arg2: str, arg3: float = 0.5, arg4: int = 1):
+        assert self.__class__ == Command
+        opts = {"arg1": arg1, "arg2": arg2, "arg3": arg3, "arg4": arg4}
+        return json.dumps(opts)

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

@@ -0,0 +1,16 @@
+import json
+
+from django.utils.translation import gettext_lazy as _
+
+from .help_precedence9 import Command as BaseCommand
+
+
+class Command(BaseCommand):
+    """
+    This docstring overrides base docstring.
+    """
+
+    def handle(self, arg1: str, arg2: str, arg3: float = 0.5, arg4: int = 1):
+        assert self.__class__ == Command
+        opts = {"arg1": arg1, "arg2": arg2, "arg3": arg3, "arg4": arg4}
+        return json.dumps(opts)

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

@@ -0,0 +1,13 @@
+import json
+
+from django.utils.translation import gettext_lazy as _
+
+from .help_precedence10 import Command as BaseCommand
+
+
+# should inherit docstring up from multiple levels up
+class Command(BaseCommand):
+    def handle(self, arg1: str, arg2: str, arg3: float = 0.5, arg4: int = 1):
+        assert self.__class__ == Command
+        opts = {"arg1": arg1, "arg2": arg2, "arg3": arg3, "arg4": arg4}
+        return json.dumps(opts)

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

@@ -0,0 +1,18 @@
+import json
+
+from django.utils.translation import gettext_lazy as _
+
+from .help_precedence8 import Command as BaseCommand
+
+
+# helps defined upstream at higher precedence override those at lower precedence
+# locally
+class Command(BaseCommand):
+    """
+    Override higher precedence inherit.
+    """
+
+    def handle(self, arg1: str, arg2: str, arg3: float = 0.5, arg4: int = 1):
+        assert self.__class__ == Command
+        opts = {"arg1": arg1, "arg2": arg2, "arg3": arg3, "arg4": arg4}
+        return json.dumps(opts)

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

@@ -0,0 +1,13 @@
+import json
+
+from django.utils.translation import gettext_lazy as _
+
+from .help_precedence8 import Command as BaseCommand
+
+
+# inherits docstring from base
+class Command(BaseCommand):
+    def handle(self, arg1: str, arg2: str, arg3: float = 0.5, arg4: int = 1):
+        assert self.__class__ == Command
+        opts = {"arg1": arg1, "arg2": arg2, "arg3": arg3, "arg4": arg4}
+        return json.dumps(opts)