Merge branch 'master' into dependabot/pip/mkdocs-material-9.6.14

svlandeg · web-flow · commit 20efa80665fb · 2025-06-23T14:42:20.000+02:00
diff --git a/.env b/.env
@@ -0,0 +1,4 @@
+# Environment variables automatically read by VS Code, e.g. running tests
+
+# For tests, a large terminal width
+TERMINAL_WIDTH=3000
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -57,6 +57,7 @@ jobs:
       - name: Install Dependencies
         run: uv pip install -r requirements-tests.txt
       - name: Lint
+        if: matrix.python-version != '3.7' && matrix.python-version != '3.8' && matrix.python-version != '3.9'
         run: bash scripts/lint.sh
       - run: mkdir coverage
       - run: bash ./scripts/test-files.sh
diff --git a/.pre-commit-config.yaml b/.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.6
+    rev: v0.11.13
     hooks:
     -   id: ruff
         args:
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -2,6 +2,39 @@
 
 ## Latest Changes
 
+### Docs
+
+* 📝 Fix reference to `count` parameter in the documentation. PR [#1201](https://github.com/fastapi/typer/pull/1201) by [@PokkaKiyo](https://github.com/PokkaKiyo).
+
+### Internal
+
+* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#1206](https://github.com/fastapi/typer/pull/1206) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
+* ⬆ Bump pillow from 11.1.0 to 11.2.1. PR [#1198](https://github.com/fastapi/typer/pull/1198) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump cairosvg from 2.7.1 to 2.8.2. PR [#1226](https://github.com/fastapi/typer/pull/1226) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump ruff from 0.11.6 to 0.11.13. PR [#1241](https://github.com/fastapi/typer/pull/1241) by [@dependabot[bot]](https://github.com/apps/dependabot).
+
+## 0.16.0
+
+### Upgrades
+
+* ⬆️ Add compatibility with Click 8.2. PR [#1222](https://github.com/fastapi/typer/pull/1222) by [@tiangolo](https://github.com/tiangolo).
+
+When using the `CliRunner` with Click < 8.2, to be able to access the `stderr` output, you needed to set the `mix_stderr` parameter to `True`. Since Click 8.2 (and Typer 0.160 this release supporting it) this is no longer necessary, so this parameter has been removed.
+
+### Refactors
+
+* ✅ Refactor tests for compatibility with Click 8.2. PR [#1230](https://github.com/fastapi/typer/pull/1230) by [@tiangolo](https://github.com/tiangolo).
+
+### Internal
+
+* 🔧 Remove Google Analytics. PR [#1229](https://github.com/fastapi/typer/pull/1229) by [@tiangolo](https://github.com/tiangolo).
+
+## 0.15.4
+
+### Upgrades
+
+* 📌 Pin Click to < 8.2, compatibility for Click >= 8.2 will be added in a future version. PR [#1225](https://github.com/fastapi/typer/pull/1225) by [@tiangolo](https://github.com/tiangolo).
+
 ## 0.15.3
 
 ### Fixes
diff --git a/docs/tutorial/parameter-types/number.md b/docs/tutorial/parameter-types/number.md
@@ -100,7 +100,7 @@ ID is 5
 
 ## Counter *CLI options*
 
-You can make a *CLI option* work as a counter with the `counter` parameter:
+You can make a *CLI option* work as a counter with the `count` parameter:
 
 {* docs_src/parameter_types/number/tutorial003_an.py hl[5] *}
 
diff --git a/docs/tutorial/testing.md b/docs/tutorial/testing.md
@@ -71,7 +71,7 @@ Then we check that the text printed to "standard output" contains the text that
 
 /// tip
 
-You could also check output sent to "standard error" (`stderr`) instead of "standard output" (`stdout`). To do so, make sure your `CliRunner` instance is created with the `mix_stderr=False` argument. You need this setting to be able to access `result.stderr` in tests.
+You could also check the output sent to "standard error" (`stderr`) or "standard output" (`stdout`) independently by accessing `result.stdout` and `result.stderr` in your tests.
 
 ///
 
diff --git a/docs_src/testing/app01/test_main.py b/docs_src/testing/app01/test_main.py
@@ -8,5 +8,5 @@
 def test_app():
     result = runner.invoke(app, ["Camila", "--city", "Berlin"])
     assert result.exit_code == 0
-    assert "Hello Camila" in result.stdout
-    assert "Let's have a coffee in Berlin" in result.stdout
+    assert "Hello Camila" in result.output
+    assert "Let's have a coffee in Berlin" in result.output
diff --git a/docs_src/testing/app02/test_main.py b/docs_src/testing/app02/test_main.py
@@ -8,4 +8,4 @@
 def test_app():
     result = runner.invoke(app, ["Camila"], input="camila@example.com\n")
     assert result.exit_code == 0
-    assert "Hello Camila, your email is: camila@example.com" in result.stdout
+    assert "Hello Camila, your email is: camila@example.com" in result.output
diff --git a/docs_src/testing/app02_an/test_main.py b/docs_src/testing/app02_an/test_main.py
@@ -8,4 +8,4 @@
 def test_app():
     result = runner.invoke(app, ["Camila"], input="camila@example.com\n")
     assert result.exit_code == 0
-    assert "Hello Camila, your email is: camila@example.com" in result.stdout
+    assert "Hello Camila, your email is: camila@example.com" in result.output
diff --git a/docs_src/testing/app03/test_main.py b/docs_src/testing/app03/test_main.py
@@ -12,4 +12,4 @@
 def test_app():
     result = runner.invoke(app, ["--name", "Camila"])
     assert result.exit_code == 0
-    assert "Hello Camila" in result.stdout
+    assert "Hello Camila" in result.output
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -196,22 +196,6 @@ markdown_extensions:
   markdown_include_variants:
 
 extra:
-  analytics:
-    provider: google
-    property: G-T78C5GNRXK
-    feedback:
-      title: Was this page helpful?
-      ratings:
-        - icon: material/emoticon-happy-outline
-          name: This page was helpful
-          data: 1
-          note: >-
-            Thanks for your feedback!
-        - icon: material/emoticon-sad-outline
-          name: This page could be improved
-          data: 0
-          note: >-
-            Thanks for your feedback!
   social:
     - icon: fontawesome/brands/github-alt
       link: https://github.com/fastapi/typer
diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -7,9 +7,9 @@ pyyaml >=5.3.1,<7.0.0
 # For Material for MkDocs, Chinese search
 # jieba==0.42.1
 # For image processing by Material for MkDocs
-pillow==11.1.0
+pillow==11.2.1
 # For image processing by Material for MkDocs
-cairosvg==2.7.1
+cairosvg==2.8.2
 # mkdocstrings[python]==0.25.1
 # Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
 # griffe-typingdoc==0.2.5
diff --git a/requirements-tests.txt b/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.6
+ruff ==0.11.13
 # Needed explicitly by typer-slim
 rich >=10.11.0
 shellingham >=1.3.0
diff --git a/tests/test_completion/test_completion_show.py b/tests/test_completion/test_completion_show.py
@@ -146,4 +146,4 @@ def test_completion_show_invalid_shell():
         shellingham, "detect_shell", return_value=("xshell", "/usr/bin/xshell")
     ):
         result = runner.invoke(app, ["--show-completion"])
-    assert "Shell xshell not supported" in result.stdout
+    assert "Shell xshell not supported" in result.output
diff --git a/tests/test_others.py b/tests/test_others.py
@@ -243,7 +243,7 @@ def main(arg1, arg2: int, arg3: "int", arg4: bool = False, arg5: "bool" = False)
 
     result = runner.invoke(app, ["Hello", "2", "invalid"])
 
-    assert "Invalid value for 'ARG3': 'invalid' is not a valid integer" in result.stdout
+    assert "Invalid value for 'ARG3': 'invalid' is not a valid integer" in result.output
     result = runner.invoke(app, ["Hello", "2", "3", "--arg4", "--arg5"])
     assert (
         "arg1: <class 'str'> Hello\narg2: <class 'int'> 2\narg3: <class 'int'> 3\narg4: <class 'bool'> True\narg5: <class 'bool'> True\n"
diff --git a/tests/test_tutorial/test_arguments/test_optional/test_tutorial001.py b/tests/test_tutorial/test_arguments/test_optional/test_tutorial001.py
@@ -31,7 +31,7 @@ def test_call_no_arg_no_rich():
     typer.core.rich = None
     result = runner.invoke(app)
     assert result.exit_code != 0
-    assert "Error: Missing argument 'NAME'" in result.stdout
+    assert "Error: Missing argument 'NAME'" in result.output
     typer.core.rich = rich
 
 
diff --git a/tests/test_tutorial/test_arguments/test_optional/test_tutorial001_an.py b/tests/test_tutorial/test_arguments/test_optional/test_tutorial001_an.py
@@ -31,7 +31,7 @@ def test_call_no_arg_no_rich():
     typer.core.rich = None
     result = runner.invoke(app)
     assert result.exit_code != 0
-    assert "Error: Missing argument 'NAME'" in result.stdout
+    assert "Error: Missing argument 'NAME'" in result.output
     typer.core.rich = rich
 
 
diff --git a/tests/test_tutorial/test_arguments/test_optional/test_tutorial003.py b/tests/test_tutorial/test_arguments/test_optional/test_tutorial003.py
@@ -31,7 +31,7 @@ def test_call_no_arg_no_rich():
     typer.core.rich = None
     result = runner.invoke(app)
     assert result.exit_code != 0
-    assert "Error: Missing argument 'NAME'" in result.stdout
+    assert "Error: Missing argument 'NAME'" in result.output
     typer.core.rich = rich
 
 
diff --git a/tests/test_tutorial/test_commands/test_index/test_tutorial003.py b/tests/test_tutorial/test_commands/test_index/test_tutorial003.py
@@ -12,7 +12,6 @@
 
 def test_no_arg():
     result = runner.invoke(app)
-    assert result.exit_code == 0
     assert "[OPTIONS] COMMAND [ARGS]..." in result.output
     assert "Commands" in result.output
     assert "create" in result.output
diff --git a/tests/test_tutorial/test_multiple_values/test_arguments_with_multiple_values/test_tutorial002.py b/tests/test_tutorial/test_multiple_values/test_arguments_with_multiple_values/test_tutorial002.py
@@ -30,7 +30,7 @@ def test_defaults():
 def test_invalid_args():
     result = runner.invoke(app, ["Draco", "Hagrid"])
     assert result.exit_code != 0
-    assert "Argument 'names' takes 3 values" in result.stdout
+    assert "Argument 'names' takes 3 values" in result.output
 
 
 def test_valid_args():
diff --git a/tests/test_tutorial/test_multiple_values/test_arguments_with_multiple_values/test_tutorial002_an.py b/tests/test_tutorial/test_multiple_values/test_arguments_with_multiple_values/test_tutorial002_an.py
@@ -32,7 +32,7 @@ def test_defaults():
 def test_invalid_args():
     result = runner.invoke(app, ["Draco", "Hagrid"])
     assert result.exit_code != 0
-    assert "Argument 'names' takes 3 values" in result.stdout
+    assert "Argument 'names' takes 3 values" in result.output
 
 
 def test_valid_args():
diff --git a/tests/test_tutorial/test_options/test_callback/test_tutorial001.py b/tests/test_tutorial/test_options/test_callback/test_tutorial001.py
@@ -21,7 +21,8 @@ def test_1():
 def test_2():
     result = runner.invoke(app, ["--name", "rick"])
     assert result.exit_code != 0
-    assert "Invalid value for '--name': Only Camila is allowed" in result.output
+    assert "Invalid value for '--name'" in result.output
+    assert "Only Camila is allowed" in result.output
 
 
 def test_script():
diff --git a/tests/test_tutorial/test_options/test_callback/test_tutorial001_an.py b/tests/test_tutorial/test_options/test_callback/test_tutorial001_an.py
@@ -21,7 +21,8 @@ def test_1():
 def test_2():
     result = runner.invoke(app, ["--name", "rick"])
     assert result.exit_code != 0
-    assert "Invalid value for '--name': Only Camila is allowed" in result.output
+    assert "Invalid value for '--name'" in result.output
+    assert "Only Camila is allowed" in result.output
 
 
 def test_script():
diff --git a/tests/test_tutorial/test_options/test_callback/test_tutorial003.py b/tests/test_tutorial/test_options/test_callback/test_tutorial003.py
@@ -23,7 +23,8 @@ def test_1():
 def test_2():
     result = runner.invoke(app, ["--name", "rick"])
     assert result.exit_code != 0
-    assert "Invalid value for '--name': Only Camila is allowed" in result.output
+    assert "Invalid value for '--name'" in result.output
+    assert "Only Camila is allowed" in result.output
 
 
 def test_script():
diff --git a/tests/test_tutorial/test_options/test_callback/test_tutorial003_an.py b/tests/test_tutorial/test_options/test_callback/test_tutorial003_an.py
@@ -23,7 +23,8 @@ def test_1():
 def test_2():
     result = runner.invoke(app, ["--name", "rick"])
     assert result.exit_code != 0
-    assert "Invalid value for '--name': Only Camila is allowed" in result.output
+    assert "Invalid value for '--name'" in result.output
+    assert "Only Camila is allowed" in result.output
 
 
 def test_script():
diff --git a/tests/test_tutorial/test_options/test_callback/test_tutorial004.py b/tests/test_tutorial/test_options/test_callback/test_tutorial004.py
@@ -23,7 +23,8 @@ def test_1():
 def test_2():
     result = runner.invoke(app, ["--name", "rick"])
     assert result.exit_code != 0
-    assert "Invalid value for '--name': Only Camila is allowed" in result.output
+    assert "Invalid value for '--name'" in result.output
+    assert "Only Camila is allowed" in result.output
 
 
 def test_script():
diff --git a/tests/test_tutorial/test_options/test_callback/test_tutorial004_an.py b/tests/test_tutorial/test_options/test_callback/test_tutorial004_an.py
@@ -23,7 +23,8 @@ def test_1():
 def test_2():
     result = runner.invoke(app, ["--name", "rick"])
     assert result.exit_code != 0
-    assert "Invalid value for '--name': Only Camila is allowed" in result.output
+    assert "Invalid value for '--name'" in result.output
+    assert "Only Camila is allowed" in result.output
 
 
 def test_script():
diff --git a/tests/test_tutorial/test_options/test_required/test_tutorial001.py b/tests/test_tutorial/test_options/test_required/test_tutorial001.py
@@ -16,7 +16,7 @@
 def test_1():
     result = runner.invoke(app, ["Camila"])
     assert result.exit_code != 0
-    assert "Missing option '--lastname'." in result.output
+    assert "Missing option '--lastname'" in result.output
 
 
 def test_option_lastname():
diff --git a/tests/test_tutorial/test_options/test_required/test_tutorial001_an.py b/tests/test_tutorial/test_options/test_required/test_tutorial001_an.py
@@ -16,7 +16,7 @@
 def test_1():
     result = runner.invoke(app, ["Camila"])
     assert result.exit_code != 0
-    assert "Missing option '--lastname'." in result.output
+    assert "Missing option '--lastname'" in result.output
 
 
 def test_option_lastname():
diff --git a/tests/test_tutorial/test_options/test_version/test_tutorial003.py b/tests/test_tutorial/test_options/test_version/test_tutorial003.py
@@ -22,7 +22,8 @@ def test_1():
 def test_2():
     result = runner.invoke(app, ["--name", "rick"])
     assert result.exit_code != 0
-    assert "Invalid value for '--name': Only Camila is allowed" in result.output
+    assert "Invalid value for '--name'" in result.output
+    assert "Only Camila is allowed" in result.output
 
 
 def test_3():
diff --git a/tests/test_tutorial/test_options/test_version/test_tutorial003_an.py b/tests/test_tutorial/test_options/test_version/test_tutorial003_an.py
@@ -22,7 +22,8 @@ def test_1():
 def test_2():
     result = runner.invoke(app, ["--name", "rick"])
     assert result.exit_code != 0
-    assert "Invalid value for '--name': Only Camila is allowed" in result.output
+    assert "Invalid value for '--name'" in result.output
+    assert "Only Camila is allowed" in result.output
 
 
 def test_3():
diff --git a/tests/test_tutorial/test_parameter_types/test_datetime/test_tutorial001.py b/tests/test_tutorial/test_parameter_types/test_datetime/test_tutorial001.py
@@ -30,7 +30,7 @@ def test_invalid():
     assert result.exit_code != 0
     assert (
         "Invalid value for 'BIRTH:[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]':"
-        in result.stdout
+        in result.output
     )
     assert "'july-19-1989' does not match the formats" in result.output
     assert "%Y-%m-%d" in result.output
diff --git a/tests/test_tutorial/test_parameter_types/test_enum/test_tutorial001.py b/tests/test_tutorial/test_parameter_types/test_enum/test_tutorial001.py
@@ -26,10 +26,17 @@ def test_main():
     assert "Training neural network of type: conv" in result.output
 
 
+def test_main_default():
+    result = runner.invoke(app)
+    assert result.exit_code == 0
+    assert "Training neural network of type: simple" in result.output
+
+
 def test_invalid_case():
     result = runner.invoke(app, ["--network", "CONV"])
     assert result.exit_code != 0
-    assert "Invalid value for '--network': 'CONV' is not one of" in result.output
+    assert "Invalid value for '--network'" in result.output
+    assert "'CONV' is not one of" in result.output
     assert "simple" in result.output
     assert "conv" in result.output
     assert "lstm" in result.output
@@ -38,7 +45,8 @@ def test_invalid_case():
 def test_invalid_other():
     result = runner.invoke(app, ["--network", "capsule"])
     assert result.exit_code != 0
-    assert "Invalid value for '--network': 'capsule' is not one of" in result.output
+    assert "Invalid value for '--network'" in result.output
+    assert "'capsule' is not one of" in result.output
     assert "simple" in result.output
     assert "conv" in result.output
     assert "lstm" in result.output
diff --git a/tests/test_tutorial/test_parameter_types/test_index/test_tutorial001.py b/tests/test_tutorial/test_parameter_types/test_index/test_tutorial001.py
@@ -35,7 +35,8 @@ def test_params():
 def test_invalid():
     result = runner.invoke(app, ["Camila", "--age", "15.3"])
     assert result.exit_code != 0
-    assert "Invalid value for '--age': '15.3' is not a valid integer" in result.output
+    assert "Invalid value for '--age'" in result.output
+    assert "'15.3' is not a valid integer" in result.output
 
 
 def test_script():
diff --git a/tests/test_tutorial/test_parameter_types/test_number/test_tutorial001.py b/tests/test_tutorial/test_parameter_types/test_number/test_tutorial001.py
@@ -53,16 +53,15 @@ def test_invalid_id():
 def test_invalid_age():
     result = runner.invoke(app, ["5", "--age", "15"])
     assert result.exit_code != 0
-    assert "Invalid value for '--age': 15 is not in the range x>=18" in result.output
+    assert "Invalid value for '--age'" in result.output
+    assert "15 is not in the range x>=18" in result.output
 
 
 def test_invalid_score():
     result = runner.invoke(app, ["5", "--age", "20", "--score", "100.5"])
     assert result.exit_code != 0
-    assert (
-        "Invalid value for '--score': 100.5 is not in the range x<=100."
-        in result.output
-    )
+    assert "Invalid value for '--score'" in result.output
+    assert "100.5 is not in the range x<=100." in result.output
 
 
 def test_negative_score():
diff --git a/tests/test_tutorial/test_parameter_types/test_number/test_tutorial001_an.py b/tests/test_tutorial/test_parameter_types/test_number/test_tutorial001_an.py
diff --git a/tests/test_tutorial/test_parameter_types/test_path/test_tutorial002.py b/tests/test_tutorial/test_parameter_types/test_path/test_tutorial002.py
diff --git a/tests/test_tutorial/test_parameter_types/test_path/test_tutorial002_an.py b/tests/test_tutorial/test_parameter_types/test_path/test_tutorial002_an.py
diff --git a/tests/test_tutorial/test_terminating/test_tutorial003.py b/tests/test_tutorial/test_terminating/test_tutorial003.py
diff --git a/tests/test_tutorial/test_using_click/test_tutorial003.py b/tests/test_tutorial/test_using_click/test_tutorial003.py
diff --git a/tests/test_tutorial/test_using_click/test_tutorial004.py b/tests/test_tutorial/test_using_click/test_tutorial004.py
diff --git a/tests/test_types.py b/tests/test_types.py
diff --git a/typer/__init__.py b/typer/__init__.py
diff --git a/typer/_completion_classes.py b/typer/_completion_classes.py
diff --git a/typer/_types.py b/typer/_types.py
diff --git a/typer/core.py b/typer/core.py
diff --git a/typer/main.py b/typer/main.py
diff --git a/typer/rich_utils.py b/typer/rich_utils.py

-Original file line number
+Diff line change
 def test_app():
     result = runner.invoke(app, ["Camila"], input="[email protected]\n")
     assert result.exit_code == 0
 -    assert "Hello Camila, your email is: [email protected]" in result.stdout
 +    assert "Hello Camila, your email is: [email protected]" in result.output