fix help issues #69

Author: Brian Kohan

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

@@ -13,7 +13,7 @@ class Command(BaseCommand, help=_("")):
     Now class docstring is used!
     """
 
-    help = None
+    help = ""
 
     def handle(self, arg1: str, arg2: str, arg3: float = 0.5, arg4: int = 1):
         assert self.__class__ == Command

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

@@ -0,0 +1,21 @@
+import json
+
+from django.utils.translation import gettext_lazy as _
+
+from .help_precedence8 import Command as BaseCommand
+
+
+# if you really want to use a class docstring to override a base class help at
+# higher precedence you can unset the base class help attribute by setting the
+# higher precedence values to empty strings
+class Command(BaseCommand, help=None):
+    """
+    Now class docstring is used!
+    """
+
+    help = None
+
+    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/test_help_precedence.py

@@ -148,6 +148,15 @@ def test_help_precedence15(self):
         )
         self.assertIn("Now class docstring is used!", buffer.getvalue())
 
+    def test_help_precedence16(self):
+        buffer = StringIO()
+        cmd = get_command("help_precedence16", stdout=buffer, no_color=True)
+        cmd.print_help("./manage.py", "help_precedence16")
+        self.assertNotIn(
+            "Test minimal TyperCommand subclass - typer param", buffer.getvalue()
+        )
+        self.assertIn("Now class docstring is used!", buffer.getvalue())
+
     @pytest.mark.skip()
     def test_help_from_other_dir(self):
         """

doc/source/howto.rst

@@ -652,6 +652,26 @@ The precedence order, for a simple command is as follows:
                 4: Function docstring is last priority and is not subject to translation.
                 """
 
+The rule for how helps are resolved when inheriting from other commands is that higher precedence
+helps in base classes will be chosen over lower priority helps in deriving classes. However, if
+you would like to use a docstring as the help in a derived class instead of the high priority
+help in a base class you can set the equivalent priority help in the deriving class to the empty
+string:
+
+.. code-block:: python
+
+    class Command(TyperCommand, help=_("High precedence help defined in base class.")):
+        ...
+
+    ...
+
+    from upstream.management.commands.command import Command as BaseCommand
+    class Command(BaseCommand, help=None):
+        """
+        Docstring will be used as help.
+        """
+
+
 
 Document Commands w/Sphinx
 --------------------------