fixes #39

Author: bckohan

django_typer/__init__.py

@@ -113,7 +113,7 @@
     from typing import ParamSpec
 
 
-VERSION = (1, 0, 3)
+VERSION = (1, 0, 4)
 
 __title__ = "Django Typer"
 __version__ = ".".join(str(i) for i in VERSION)

django_typer/parsers.py

@@ -77,11 +77,11 @@ def handle(
     case_insensitive: bool = False
     on_error: t.Optional[error_handler] = None
 
-    _lookup = ""
+    _lookup: str = ""
     _field: Field
     _completer: ModelObjectCompleter
 
-    __name__ = "ModelObjectParser"  # typer internals expect this
+    __name__: str = "MODEL"  # typer internals expect this
 
     def __init__(
         self,
@@ -105,7 +105,7 @@ def __init__(
         self._field = field
         if self.case_insensitive and "iexact" in self._field.get_lookups():
             self._lookup = "__iexact"
-        self.name = (
+        self.__name__ = (
             str(self.model_cls._meta.verbose_name)
             if self.model_cls._meta.verbose_name
             else self.model_cls.__name__
@@ -191,3 +191,6 @@ def handle(
         raise CommandError(
             _("{label} does not match any installed app label.").format(label=label)
         ) from err
+
+
+parse_app_label.__name__ = "APP_LABEL"

django_typer/tests/polls/management/commands/poll_as_option.py

@@ -0,0 +1,35 @@
+import sys
+import typing as t
+
+if sys.version_info < (3, 9):
+    from typing_extensions import Annotated
+else:
+    from typing import Annotated
+
+from typer import Option
+
+from django_typer import TyperCommand, model_parser_completer
+from django_typer.tests.polls.models import Question as Poll
+
+
+class Command(TyperCommand):
+    help = "Closes the specified poll for voting"
+
+    def handle(
+        self,
+        polls: Annotated[
+            t.List[Poll],
+            Option(**model_parser_completer(Poll, help_field="question_text")),
+        ],
+        delete: Annotated[
+            bool, Option(help="Delete poll instead of closing it.")
+        ] = False,
+    ):
+        for poll in polls:
+            poll.opened = False
+            poll.save()
+            self.stdout.write(
+                self.style.SUCCESS(f'Successfully closed poll "{poll.id}"')
+            )
+            if delete:
+                poll.delete()

django_typer/tests/tests.py

@@ -1902,6 +1902,15 @@ def tearDown(self) -> None:
         ShellCompleteTester.objects.all().delete()
         return super().tearDown()
 
+    def test_model_object_parser_metavar(self):
+        result = run_command("poll_as_option", "--help")
+        found = False
+        for line in result[0].splitlines():
+            if "--polls" in line:
+                self.assertTrue("POLL" in line)
+                found = True
+        self.assertTrue(found)
+
     def test_model_object_parser_idempotency(self):
         from django_typer.parsers import ModelObjectParser
         from django_typer.tests.polls.models import Question
@@ -2585,13 +2594,6 @@ def test_option_complete(self):
         with self.assertRaises(CommandError):
             call_command("shellcompletion", "complete", "noargs cmd ", shell="zsh")
 
-    def test_model_parser_name(self):
-        from django_typer.parsers import ModelObjectParser
-        from django_typer.tests.polls.models import Question
-
-        parser = ModelObjectParser(Question)
-        self.assertEqual(parser.name, "Poll")
-
     def test_unsupported_field(self):
         from django_typer.completers import ModelObjectCompleter
 

doc/source/changelog.rst

@@ -2,6 +2,11 @@
 Change Log
 ==========
 
+v1.0.4
+======
+
+* Fixed `METAVAR when ModelObjectParser supplied should default to model name <https://github.com/bckohan/django-typer/issues/39>`_
+
 v1.0.3
 ======
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-typer"
-version = "1.0.3"
+version = "1.0.4"
 description = "Use Typer to define the CLI for your Django management commands."
 authors = ["Brian Kohan <[email protected]>"]
 license = "MIT"