Merge branch 'master' into feature/rich_expand

Author: svlandeg

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.0
+    rev: v0.11.2
     hooks:
     -   id: ruff
         args:

docs/release-notes.md

@@ -4,10 +4,13 @@
 
 ### Fixes
 
+* 🐛 Ensure that autocompletion works for `Path` arguments/options. PR [#1138](https://github.com/fastapi/typer/pull/1138) by [@svlandeg](https://github.com/svlandeg).
 * 🐛 Fix newline after header in help text, and add more tests for the behaviour of `rich_markup_mode` . PR [#964](https://github.com/fastapi/typer/pull/964) by [@svlandeg](https://github.com/svlandeg).
 
 ### Internal
 
+* ⬆ Bump ruff from 0.11.1 to 0.11.2. PR [#1186](https://github.com/fastapi/typer/pull/1186) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#1187](https://github.com/fastapi/typer/pull/1187) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
 * ⬆ Bump ruff from 0.11.0 to 0.11.1. PR [#1185](https://github.com/fastapi/typer/pull/1185) by [@dependabot[bot]](https://github.com/apps/dependabot).
 * ⬆ Bump ruff from 0.9.10 to 0.11.0. PR [#1180](https://github.com/fastapi/typer/pull/1180) by [@dependabot[bot]](https://github.com/apps/dependabot).
 * ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#1181](https://github.com/fastapi/typer/pull/1181) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).

requirements-tests.txt

@@ -6,7 +6,7 @@ coverage[toml] >=6.2,<8.0
 pytest-xdist >=1.32.0,<4.0.0
 pytest-sugar >=0.9.4,<1.1.0
 mypy ==1.4.1
-ruff ==0.11.1
+ruff ==0.11.2
 # Needed explicitly by typer-slim
 rich >=10.11.0
 shellingham >=1.3.0

tests/test_completion/path_example.py

@@ -0,0 +1,14 @@
+from pathlib import Path
+
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def f(p: Path):
+    print(p)
+
+
+if __name__ == "__main__":
+    app()

tests/test_completion/test_completion_path.py

@@ -0,0 +1,30 @@
+import os
+import subprocess
+import sys
+
+from . import path_example as mod
+
+
+def test_script():
+    result = subprocess.run(
+        [sys.executable, "-m", "coverage", "run", mod.__file__, "path/to/deadpool"],
+        capture_output=True,
+        encoding="utf-8",
+    )
+    assert result.returncode == 0
+    assert "deadpool" in result.stdout
+
+
+def test_completion_path_bash():
+    result = subprocess.run(
+        [sys.executable, "-m", "coverage", "run", mod.__file__, " "],
+        capture_output=True,
+        encoding="utf-8",
+        env={
+            **os.environ,
+            "_PATH_EXAMPLE.PY_COMPLETE": "complete_bash",
+            "COMP_WORDS": "path_example.py ",
+            "COMP_CWORD": "2",
+        },
+    )
+    assert result.returncode == 0

typer/main.py

@@ -44,6 +44,7 @@
     ParamMeta,
     Required,
     TyperInfo,
+    TyperPath,
 )
 from .utils import get_params_from_function
 
@@ -753,7 +754,7 @@ def get_click_type(
         or parameter_info.path_type
         or parameter_info.resolve_path
     ):
-        return click.Path(
+        return TyperPath(
             exists=parameter_info.exists,
             file_okay=parameter_info.file_okay,
             dir_okay=parameter_info.dir_okay,

typer/models.py

@@ -531,3 +531,14 @@ def __init__(
         self.pretty_exceptions_enable = pretty_exceptions_enable
         self.pretty_exceptions_show_locals = pretty_exceptions_show_locals
         self.pretty_exceptions_short = pretty_exceptions_short
+
+
+class TyperPath(click.Path):
+    # Overwrite Click's behaviour to be compatible with Typer's autocompletion system
+    def shell_complete(
+        self, ctx: click.Context, param: click.Parameter, incomplete: str
+    ) -> List[click.shell_completion.CompletionItem]:
+        """Return an empty list so that the autocompletion functionality
+        will work properly from the commandline.
+        """
+        return []