Merge branch 'master' into fix/escape

Author: svlandeg

docs/release-notes.md

@@ -2,6 +2,30 @@
 
 ## Latest Changes
 
+## 0.17.3
+
+### Features
+
+* ✨ Allow annotated parsing with a subclass of `Path`. PR [#1183](https://github.com/fastapi/typer/pull/1183) by [@emfdavid](https://github.com/emfdavid).
+
+## 0.17.2
+
+### Fixes
+
+* 🐛 Avoid printing `default: None` in the help section when using Rich. PR [#1120](https://github.com/fastapi/typer/pull/1120) by [@mattmess1221](https://github.com/mattmess1221).
+
+## 0.17.1
+
+### Fixes
+
+* 🐛 Fix markdown formatting in `--help` output. PR [#815](https://github.com/fastapi/typer/pull/815) by [@gar1t](https://github.com/gar1t).
+
+## 0.17.0
+
+### Features
+
+* ⚡️ Lazy-load `rich_utils` to reduce startup time. PR [#1128](https://github.com/fastapi/typer/pull/1128) by [@oefe](https://github.com/oefe).
+
 ### Internal
 
 * ⬆ Bump ruff from 0.12.9 to 0.12.10. PR [#1280](https://github.com/fastapi/typer/pull/1280) by [@dependabot[bot]](https://github.com/apps/dependabot).

tests/assets/print_modules.py

@@ -0,0 +1,15 @@
+import sys
+
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def main():
+    for m in sys.modules:
+        print(m)
+
+
+if __name__ == "__main__":
+    app()

tests/test_annotated.py

@@ -1,3 +1,6 @@
+import sys
+from pathlib import Path
+
 import typer
 from typer.testing import CliRunner
 from typing_extensions import Annotated
@@ -76,3 +79,22 @@ def cmd(force: Annotated[bool, typer.Option("--force")] = False):
     result = runner.invoke(app, ["--force"])
     assert result.exit_code == 0, result.output
     assert "Forcing operation" in result.output
+
+
+def test_annotated_custom_path():
+    app = typer.Typer()
+
+    class CustomPath(Path):
+        # Subclassing Path was not fully supported before 3.12
+        # https://docs.python.org/3.12/whatsnew/3.12.html
+        if sys.version_info < (3, 12):
+            _flavour = type(Path())._flavour
+
+    @app.command()
+    def custom_parser(
+        my_path: Annotated[CustomPath, typer.Argument(parser=CustomPath)],
+    ):
+        assert isinstance(my_path, CustomPath)
+
+    result = runner.invoke(app, "/some/quirky/path/implementation")
+    assert result.exit_code == 0

tests/test_rich_import.py

@@ -0,0 +1,21 @@
+import subprocess
+import sys
+from pathlib import Path
+
+ACCEPTED_MODULES = {"rich._extension", "rich"}
+
+
+def test_rich_not_imported_unnecessary():
+    file_path = Path(__file__).parent / "assets/print_modules.py"
+    result = subprocess.run(
+        [sys.executable, "-m", "coverage", "run", str(file_path)],
+        capture_output=True,
+        encoding="utf-8",
+    )
+    modules = result.stdout.splitlines()
+    modules = [
+        module
+        for module in modules
+        if module not in ACCEPTED_MODULES and module.startswith("rich")
+    ]
+    assert not modules

tests/test_rich_markup_mode.py

@@ -50,7 +50,6 @@ def main(arg: str):
         pytest.param(
             "markdown",
             ["First line", "", "Line 1", "", "Line 2", "", "Line 3", ""],
-            marks=pytest.mark.xfail,
         ),
         pytest.param(
             "rich", ["First line", "", "Line 1", "", "Line 2", "", "Line 3", ""]
@@ -141,7 +140,6 @@ def main(arg: str):
                 "Line 3",
                 "",
             ],
-            marks=pytest.mark.xfail,
         ),
         pytest.param(
             "rich",

tests/test_rich_utils.py

@@ -50,3 +50,32 @@ def main() -> None:
 
     assert result.exit_code == 0
     assert "Show this message" in result.stdout
+
+
+def test_rich_doesnt_print_None_default():
+    app = typer.Typer(rich_markup_mode="rich")
+
+    @app.command()
+    def main(
+        name: str,
+        option_1: str = typer.Option(
+            "option_1_default",
+        ),
+        option_2: str = typer.Option(
+            ...,
+        ),
+    ):
+        print(f"Hello {name}")
+        print(f"First: {option_1}")
+        print(f"Second: {option_2}")
+
+    result = runner.invoke(app, ["--help"])
+    assert "Usage" in result.stdout
+    assert "name" in result.stdout
+    assert "option-1" in result.stdout
+    assert "option-2" in result.stdout
+    assert result.stdout.count("[default: None]") == 0
+    result = runner.invoke(app, ["Rick", "--option-2=Morty"])
+    assert "Hello Rick" in result.stdout
+    assert "First: option_1_default" in result.stdout
+    assert "Second: Morty" in result.stdout

typer/__init__.py

@@ -1,6 +1,6 @@
 """Typer, build great CLIs. Easy to code. Based on Python type hints."""
 
-__version__ = "0.16.1"
+__version__ = "0.17.3"
 
 from shutil import get_terminal_size as get_terminal_size
 

typer/cli.py

@@ -17,7 +17,6 @@
     import rich
 
     has_rich = True
-    from . import rich_utils
 
 except ImportError:  # pragma: no cover
     has_rich = False
@@ -280,8 +279,16 @@ def get_docs_for_click(
 
 def _parse_html(to_parse: bool, input_text: str) -> str:
     if to_parse:
+        from . import rich_utils
+
         return rich_utils.rich_to_html(input_text)
     return input_text
+def _parse_html(input_text: str) -> str:
+    if not has_rich:  # pragma: no cover
+        return input_text
+    from . import rich_utils
+
+    return rich_utils.rich_to_html(input_text)
 
 
 @utils_app.command()

typer/core.py

@@ -35,8 +35,6 @@
 try:
     import rich
 
-    from . import rich_utils
-
     DEFAULT_MARKUP_MODE: MarkupMode = "rich"
 
 except ImportError:  # pragma: no cover
@@ -215,6 +213,8 @@ def _main(
                 raise
             # Typer override
             if rich and rich_markup_mode is not None:
+                from . import rich_utils
+
                 rich_utils.rich_format_error(e)
             else:
                 e.show()
@@ -245,6 +245,8 @@ def _main(
             raise
         # Typer override
         if rich and rich_markup_mode is not None:
+            from . import rich_utils
+
             rich_utils.rich_abort_error()
         else:
             click.echo(_("Aborted!"), file=sys.stderr)
@@ -721,6 +723,8 @@ def format_help(self, ctx: click.Context, formatter: click.HelpFormatter) -> Non
                 else:
                     ctx.obj[MARKUP_MODE_KEY] = self.rich_markup_mode
             return super().format_help(ctx, formatter)
+        from . import rich_utils
+
         return rich_utils.rich_format_help(
             obj=self,
             ctx=ctx,
@@ -784,6 +788,8 @@ def main(
     def format_help(self, ctx: click.Context, formatter: click.HelpFormatter) -> None:
         if not rich or self.rich_markup_mode is None:
             return super().format_help(ctx, formatter)
+        from . import rich_utils
+
         return rich_utils.rich_format_help(
             obj=self,
             ctx=ctx,

typer/main.py

@@ -51,11 +51,6 @@
 
 try:
     import rich
-    from rich.traceback import Traceback
-
-    from . import rich_utils
-
-    console_stderr = rich_utils._get_rich_console(stderr=True)
 
 except ImportError:  # pragma: no cover
     rich = None  # type: ignore
@@ -83,16 +78,19 @@ def except_hook(
     supress_internal_dir_names = [typer_path, click_path]
     exc = exc_value
     if rich:
-        from .rich_utils import MAX_WIDTH
+        from rich.traceback import Traceback
+
+        from . import rich_utils
 
         rich_tb = Traceback.from_exception(
             type(exc),
             exc,
             exc.__traceback__,
             show_locals=exception_config.pretty_exceptions_show_locals,
             suppress=supress_internal_dir_names,
-            width=MAX_WIDTH,
+            width=rich_utils.MAX_WIDTH,
         )
+        console_stderr = rich_utils._get_rich_console(stderr=True)
         console_stderr.print(rich_tb)
         return
     tb_exc = traceback.TracebackException.from_exception(exc)
@@ -622,7 +620,9 @@ def determine_type_convertor(type_: Any) -> Optional[Callable[[Any], Any]]:
 
 def param_path_convertor(value: Optional[str] = None) -> Optional[Path]:
     if value is not None:
-        return Path(value)
+        # allow returning any subclass of Path created by an annotated parser without converting
+        # it back to a Path
+        return value if isinstance(value, Path) else Path(value)
     return None