⬆️ Add compatibility with Click 8.2

.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

.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

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.
 
 ///
 

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

docs_src/testing/app02/test_main.py

@@ -8,4 +8,4 @@
 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

docs_src/testing/app02_an/test_main.py

@@ -8,4 +8,4 @@
 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

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

pyproject.toml

@@ -34,7 +34,7 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
 ]
 dependencies = [
-    "click >= 8.0.0,<8.2",
+    "click >= 8.0.0",
     "typing-extensions >= 3.7.4.3",
 ]
 readme = "README.md"

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

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

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():

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():

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():

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():

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():

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():

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():

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():

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():

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():

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

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():

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():

tests/test_tutorial/test_parameter_types/test_number/test_tutorial001_an.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():

tests/test_tutorial/test_parameter_types/test_path/test_tutorial002.py

@@ -19,7 +19,8 @@ def test_not_exists(tmpdir):
         config_file.unlink()
     result = runner.invoke(app, ["--config", f"{config_file}"])
     assert result.exit_code != 0
-    assert "Invalid value for '--config': File" in result.output
+    assert "Invalid value for '--config'" in result.output
+    assert "File" in result.output
     assert "does not exist" in result.output
 
 
@@ -35,7 +36,8 @@ def test_exists(tmpdir):
 def test_dir():
     result = runner.invoke(app, ["--config", "./"])
     assert result.exit_code != 0
-    assert "Invalid value for '--config': File './' is a directory." in result.output
+    assert "Invalid value for '--config'" in result.output
+    assert "File './' is a directory." in result.output
 
 
 def test_script():

tests/test_tutorial/test_parameter_types/test_path/test_tutorial002_an.py

@@ -19,7 +19,8 @@ def test_not_exists(tmpdir):
         config_file.unlink()
     result = runner.invoke(app, ["--config", f"{config_file}"])
     assert result.exit_code != 0
-    assert "Invalid value for '--config': File" in result.output
+    assert "Invalid value for '--config'" in result.output
+    assert "File" in result.output
     assert "does not exist" in result.output
 
 
@@ -35,7 +36,8 @@ def test_exists(tmpdir):
 def test_dir():
     result = runner.invoke(app, ["--config", "./"])
     assert result.exit_code != 0
-    assert "Invalid value for '--config': File './' is a directory." in result.output
+    assert "Invalid value for '--config'" in result.output
+    assert "File './' is a directory." in result.output
 
 
 def test_script():

tests/test_types.py

@@ -0,0 +1,34 @@
+from enum import Enum
+
+import typer
+from typer.testing import CliRunner
+
+app = typer.Typer(context_settings={"token_normalize_func": str.lower})
+
+
+class User(str, Enum):
+    rick = "Rick"
+    morty = "Morty"
+
+
+@app.command()
+def hello(name: User = User.rick) -> None:
+    print(f"Hello {name.value}!")
+
+
+runner = CliRunner()
+
+
+def test_enum_choice() -> None:
+    # This test is only for coverage of the new custom TyperChoice class
+    result = runner.invoke(app, ["--name", "morty"], catch_exceptions=False)
+    assert result.exit_code == 0
+    assert "Hello Morty!" in result.output
+
+    result = runner.invoke(app, ["--name", "Rick"])
+    assert result.exit_code == 0
+    assert "Hello Rick!" in result.output
+
+    result = runner.invoke(app, ["--name", "RICK"])
+    assert result.exit_code == 0
+    assert "Hello Rick!" in result.output

typer/_completion_classes.py

@@ -16,6 +16,14 @@
     Shells,
 )
 
+try:
+    from click.shell_completion import split_arg_string as click_split_arg_string
+except ImportError:  # pragma: no cover
+    # TODO: when removing support for Click < 8.2, remove this import
+    from click.parser import (  # type: ignore[no-redef]
+        split_arg_string as click_split_arg_string,
+    )
+
 try:
     import shellingham
 except ImportError:  # pragma: no cover
@@ -43,7 +51,7 @@ def source_vars(self) -> Dict[str, Any]:
         }
 
     def get_completion_args(self) -> Tuple[List[str], str]:
-        cwords = click.parser.split_arg_string(os.environ["COMP_WORDS"])
+        cwords = click_split_arg_string(os.environ["COMP_WORDS"])
         cword = int(os.environ["COMP_CWORD"])
         args = cwords[1:cword]
 
@@ -80,7 +88,7 @@ def source_vars(self) -> Dict[str, Any]:
 
     def get_completion_args(self) -> Tuple[List[str], str]:
         completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "")
-        cwords = click.parser.split_arg_string(completion_args)
+        cwords = click_split_arg_string(completion_args)
         args = cwords[1:]
         if args and not completion_args.endswith(" "):
             incomplete = args[-1]
@@ -131,7 +139,7 @@ def source_vars(self) -> Dict[str, Any]:
 
     def get_completion_args(self) -> Tuple[List[str], str]:
         completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "")
-        cwords = click.parser.split_arg_string(completion_args)
+        cwords = click_split_arg_string(completion_args)
         args = cwords[1:]
         if args and not completion_args.endswith(" "):
             incomplete = args[-1]
@@ -185,7 +193,7 @@ def source_vars(self) -> Dict[str, Any]:
     def get_completion_args(self) -> Tuple[List[str], str]:
         completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "")
         incomplete = os.getenv("_TYPER_COMPLETE_WORD_TO_COMPLETE", "")
-        cwords = click.parser.split_arg_string(completion_args)
+        cwords = click_split_arg_string(completion_args)
         args = cwords[1:-1] if incomplete else cwords[1:]
         return args, incomplete