fixe for #42

Author: bckohan

django_typer/__init__.py

@@ -114,7 +114,7 @@
     from typing import ParamSpec
 
 
-VERSION = (1, 0, 4)
+VERSION = (1, 0, 5)
 
 __title__ = "Django Typer"
 __version__ = ".".join(str(i) for i in VERSION)
@@ -402,6 +402,27 @@ class Converter:
         infrastructure the conversion happens.
         """
 
+    def get_params(self, ctx: click.Context) -> t.List[click.Parameter]:
+        """
+        We override get_params to check to make sure that prompt_required is not set for parameters
+        that have already been prompted for during the initial parse phase. We have to do this
+        because of we're stuffing the click infrastructure into the django infrastructure and the
+        django infrastructure forces a two step parse process whereas click does not easily support
+        separating these.
+
+        There may be a more sound approach than this?
+        """
+        modified = []
+        params = super().get_params(ctx)
+        for param in params:
+            if getattr(param, "prompt_required", None) and getattr(
+                ctx, "supplied_params", {}
+            ).get(param.name, None):
+                param = deepcopy(param)
+                setattr(param, "prompt_required", False)
+            modified.append(param)
+        return modified
+
     def shell_complete(
         self, ctx: click.Context, incomplete: str
     ) -> t.List[CompletionItem]:

django_typer/tests/test_app/management/commands/prompt.py

@@ -0,0 +1,67 @@
+import sys
+import typing as t
+
+if sys.version_info < (3, 9):
+    from typing_extensions import Annotated
+else:
+    from typing import Annotated
+
+from django.utils.translation import gettext_lazy as _
+from typer import Option
+
+from django_typer import TyperCommand, command, group
+
+
+class Command(TyperCommand):
+
+    help = _("Test password prompt")
+
+    @command()
+    def cmd1(
+        self,
+        username: str,
+        password: Annotated[
+            t.Optional[str], Option("-p", hide_input=True, prompt=True)
+        ] = None,
+    ):
+        return f"{username} {password}"
+
+    @command()
+    def cmd2(
+        self,
+        username: str,
+        password: Annotated[
+            t.Optional[str],
+            Option("-p", hide_input=True, prompt=True, prompt_required=False),
+        ] = None,
+    ):
+        return f"{username} {password}"
+
+    @command()
+    def cmd3(
+        self,
+        username: str,
+        password: Annotated[
+            str, Option("-p", hide_input=True, prompt=True, prompt_required=False)
+        ] = "default",
+    ):
+        return f"{username} {password}"
+
+    @group()
+    def group1(
+        self,
+        flag: Annotated[
+            str, Option("-f", hide_input=True, prompt=True, prompt_required=True)
+        ],
+    ):
+        self.flag = flag
+
+    @group1.command()
+    def cmd4(
+        self,
+        username: str,
+        password: Annotated[
+            t.Optional[str], Option("-p", hide_input=True, prompt=True)
+        ] = None,
+    ):
+        return f"{self.flag} {username} {password}"

django_typer/tests/tests.py

@@ -11,6 +11,7 @@
 from typing import Any, Tuple
 
 import django
+import pexpect
 import pytest
 import typer
 from click.exceptions import UsageError
@@ -62,7 +63,20 @@ def get_named_arguments(function):
     ]
 
 
-def run_command(command, *args, parse_json=True) -> Tuple[str, str]:
+def interact(command, *args, **kwargs):
+    cwd = os.getcwd()
+    try:
+        os.chdir(manage_py.parent)
+        return pexpect.spawn(
+            " ".join([sys.executable, f"./{manage_py.name}", command, *args]),
+            env=os.environ,
+            **kwargs,
+        )
+    finally:
+        os.chdir(cwd)
+
+
+def run_command(command, *args, parse_json=True, **kwargs) -> Tuple[str, str]:
     # we want to use the same test database that was created for the test suite run
     cwd = os.getcwd()
     try:
@@ -73,6 +87,7 @@ def run_command(command, *args, parse_json=True) -> Tuple[str, str]:
             capture_output=True,
             text=True,
             env=env,
+            **kwargs,
         )
 
         # Check the return code to ensure the script ran successfully
@@ -2753,3 +2768,93 @@ def test_handle_as_init_direct(self):
         self.assertEqual(get_command("handle_as_init")(), "handle")
         self.assertEqual(get_command("handle_as_init", "subcommand")(), "subcommand")
         self.assertEqual(get_command("handle_as_init").subcommand(), "subcommand")
+
+
+class TestPromptOptions(TestCase):
+
+    def test_run_with_option_prompt(self):
+
+        cmd = interact("prompt", "--no-color", "cmd1", "bckohan")
+        cmd.expect("Password: ")
+        cmd.sendline("test_password")
+
+        result = cmd.read().decode("utf-8").strip().splitlines()[0]
+        self.assertEqual(result, "bckohan test_password")
+
+        cmd = interact("prompt", "--no-color", "cmd2", "bckohan")
+        result = cmd.read().decode("utf-8").strip().splitlines()[0]
+        self.assertEqual(result, "bckohan None")
+
+        cmd = interact("prompt", "--no-color", "cmd2", "bckohan", "-p")
+        cmd.expect("Password: ")
+        cmd.sendline("test_password2")
+        result = cmd.read().decode("utf-8").strip().splitlines()[0]
+        self.assertEqual(result, "bckohan test_password2")
+
+        cmd = interact("prompt", "--no-color", "cmd3", "bckohan")
+        result = cmd.read().decode("utf-8").strip().splitlines()[0]
+        self.assertEqual(result, "bckohan default")
+
+        cmd = interact("prompt", "--no-color", "cmd3", "bckohan", "-p")
+        cmd.expect(r"Password \[default\]: ")
+        cmd.sendline("test_password3")
+        result = cmd.read().decode("utf-8").strip().splitlines()[0]
+        self.assertEqual(result, "bckohan test_password3")
+
+        cmd = interact("prompt", "--no-color", "group1", "cmd4", "bckohan")
+        cmd.expect(r"Flag: ")
+        cmd.sendline("test_flag")
+        cmd.expect(r"Password: ")
+        cmd.sendline("test_password4")
+        result = cmd.read().decode("utf-8").strip().splitlines()[0]
+        self.assertEqual(result, "test_flag bckohan test_password4")
+
+    def test_call_with_option_prompt(self):
+        self.assertEqual(
+            call_command(
+                "prompt", "--no-color", "cmd1", "bckohan", password="test_password"
+            ),
+            "bckohan test_password",
+        )
+
+        self.assertEqual(
+            call_command("prompt", "--no-color", "cmd2", "bckohan"), "bckohan None"
+        )
+
+        self.assertEqual(
+            call_command(
+                "prompt", "--no-color", "cmd2", "bckohan", "-p", "test_password2"
+            ),
+            "bckohan test_password2",
+        )
+
+        self.assertEqual(
+            call_command("prompt", "--no-color", "cmd3", "bckohan"), "bckohan default"
+        )
+
+        self.assertEqual(
+            call_command(
+                "prompt", "--no-color", "cmd3", "bckohan", password="test_password3"
+            ),
+            "bckohan test_password3",
+        )
+
+        self.assertEqual(
+            call_command(
+                "prompt",
+                "--no-color",
+                "group1",
+                "-f",
+                "test_flag",
+                "cmd4",
+                "bckohan",
+                password="test_password4",
+            ),
+            "test_flag bckohan test_password4",
+        )
+
+        # this doesn't work!
+        # self.assertEqual(
+        #     call_command('prompt', '--no-color', 'group1', 'cmd4', 'bckohan', flag='test_flag', password='test_password4'),
+        #     'test_flag bckohan test_password4'
+        # )

django_typer/tests/typer_test.py

@@ -1,18 +1,26 @@
 #!/usr/bin/env python
+import typing as t
+
 import typer
 
 app = typer.Typer(name="test")
 state = {"verbose": False}
 
 
 @app.command()
-def create(username: str, flag: bool = False):
+def create(
+    username: str,
+    password: t.Annotated[
+        t.Optional[str],
+        typer.Option("--password", hide_input=True, prompt=True),
+    ] = None,
+):
     if state["verbose"]:
         print("About to create a user")
     print(f"Creating user: {username}")
     if state["verbose"]:
         print("Just created a user")
-    print(f"flag: {flag}")
+    print(f"password: {password}")
 
 
 @app.command(epilog="Delete Epilog")
@@ -25,7 +33,7 @@ def delete(username: str):
 
 
 @app.callback(epilog="Main Epilog")
-def main(arg: int, verbose: bool = False):
+def main(verbose: bool = False):
     """
     Manage users in the awesome CLI app.
     """

doc/source/changelog.rst

@@ -2,6 +2,12 @@
 Change Log
 ==========
 
+v1.0.5
+======
+
+* Fixed `Options with prompt=True are prompted twice <https://github.com/bckohan/django-typer/issues/42>`_
+
+
 v1.0.4
 ======
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-typer"
-version = "1.0.4"
+version = "1.0.5"
 description = "Use Typer to define the CLI for your Django management commands."
 authors = ["Brian Kohan <[email protected]>"]
 license = "MIT"
@@ -87,6 +87,7 @@ scipy = [
     { version = "<=1.10", markers = "python_version <= '3.8'" },
 ]
 django-stubs = "^4.2.7"
+pexpect = "^4.9.0"
 
 [tool.poetry.extras]
 rich = ["rich"]