⬆️ Upgrade coverage and configs (#769)

Author: tiangolo

.coveragerc

@@ -11,3 +11,4 @@ site
 htmlcov
 .pytest_cache
 coverage.xml
+.coverage*

.gitignore

@@ -76,6 +76,27 @@ filterwarnings = [
     'ignore::DeprecationWarning:xdist',
 ]
 
+[tool.coverage.run]
+parallel = true
+data_file = "coverage/.coverage"
+source = [
+    "docs_src",
+    "tests",
+    "typer"
+]
+omit = [
+    "typer/_typing.py"
+]
+context = '${CONTEXT}'
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "@overload",
+    'if __name__ == "__main__":',
+    "if TYPE_CHECKING:",
+]
+
 [tool.mypy]
 strict = true
 

pyproject.toml

@@ -2,7 +2,7 @@
 
 pytest >=4.4.0,<8.0.0
 pytest-cov >=2.10.0,<5.0.0
-coverage[toml] >=6.2,<7.0
+coverage[toml] >=6.2,<8.0
 pytest-xdist >=1.32.0,<4.0.0
 pytest-sugar >=0.9.4,<0.10.0
 mypy ==1.4.1

requirements-tests.txt

@@ -9,4 +9,4 @@ export TERMINAL_WIDTH=3000
 export _TYPER_FORCE_DISABLE_TERMINAL=1
 bash ./scripts/test-files.sh
 # It seems xdist-pytest ensures modified sys.path to import relative modules in examples keeps working
-pytest --cov-config=.coveragerc --cov --cov-report=term-missing -o console_output_style=progress --numprocesses=auto ${@}
+pytest --cov --cov-report=term-missing -o console_output_style=progress --numprocesses=auto ${@}

scripts/test.sh

@@ -23,7 +23,7 @@ def test_show_completion():
 def test_install_completion():
     bash_completion_path: Path = Path.home() / ".bashrc"
     text = ""
-    if bash_completion_path.is_file():  # pragma: nocover
+    if bash_completion_path.is_file():  # pragma: no cover
         text = bash_completion_path.read_text()
     result = subprocess.run(
         [

tests/test_completion/test_completion.py

@@ -72,7 +72,7 @@ def test_completion_install_bash():
 def test_completion_install_zsh():
     completion_path: Path = Path.home() / ".zshrc"
     text = ""
-    if not completion_path.is_file():  # pragma: nocover
+    if not completion_path.is_file():  # pragma: no cover
         completion_path.write_text('echo "custom .zshrc"')
     if completion_path.is_file():
         text = completion_path.read_text()
@@ -148,7 +148,7 @@ def test_completion_install_powershell():
     )
     completion_path_bytes = f"{completion_path}\n".encode("windows-1252")
     text = ""
-    if completion_path.is_file():  # pragma: nocover
+    if completion_path.is_file():  # pragma: no cover
         text = completion_path.read_text()
 
     with mock.patch.object(

tests/test_completion/test_completion_install.py

@@ -94,11 +94,11 @@ def test_callback_too_many_parameters():
     app = typer.Typer()
 
     def name_callback(ctx, param, val1, val2):
-        pass  # pragma: nocover
+        pass  # pragma: no cover
 
     @app.command()
     def main(name: str = typer.Option(..., callback=name_callback)):
-        pass  # pragma: nocover
+        pass  # pragma: no cover
 
     with pytest.raises(click.ClickException) as exc_info:
         runner.invoke(app, ["--name", "Camila"])
@@ -199,11 +199,11 @@ def test_autocompletion_too_many_parameters():
     app = typer.Typer()
 
     def name_callback(ctx, args, incomplete, val2):
-        pass  # pragma: nocover
+        pass  # pragma: no cover
 
     @app.command()
     def main(name: str = typer.Option(..., autocompletion=name_callback)):
-        pass  # pragma: nocover
+        pass  # pragma: no cover
 
     with pytest.raises(click.ClickException) as exc_info:
         runner.invoke(app, ["--name", "Camila"])
@@ -236,7 +236,7 @@ def test_context_settings_inheritance_single_command():
 
     @app.command()
     def main(name: str):
-        pass  # pragma: nocover
+        pass  # pragma: no cover
 
     result = runner.invoke(app, ["main", "-h"])
     assert "Show this message and exit." in result.stdout

tests/test_others.py

@@ -15,7 +15,7 @@
 
 def test_main(tmpdir):
     config_file = Path(tmpdir) / "config.txt"
-    if config_file.exists():  # pragma no cover
+    if config_file.exists():  # pragma: no cover
         config_file.unlink()
     result = runner.invoke(app, ["--config", f"{config_file}"])
     text = config_file.read_text()

tests/test_tutorial/test_parameter_types/test_file/test_tutorial002.py

@@ -15,7 +15,7 @@
 
 def test_main(tmpdir):
     config_file = Path(tmpdir) / "config.txt"
-    if config_file.exists():  # pragma no cover
+    if config_file.exists():  # pragma: no cover
         config_file.unlink()
     result = runner.invoke(app, ["--config", f"{config_file}"])
     text = config_file.read_text()

tests/test_tutorial/test_parameter_types/test_file/test_tutorial002_an.py

@@ -15,7 +15,7 @@
 
 def test_main(tmpdir):
     binary_file = Path(tmpdir) / "config.txt"
-    if binary_file.exists():  # pragma no cover
+    if binary_file.exists():  # pragma: no cover
         binary_file.unlink()
     result = runner.invoke(app, ["--file", f"{binary_file}"])
     text = binary_file.read_text()

tests/test_tutorial/test_parameter_types/test_file/test_tutorial004.py

@@ -15,7 +15,7 @@
 
 def test_main(tmpdir):
     binary_file = Path(tmpdir) / "config.txt"
-    if binary_file.exists():  # pragma no cover
+    if binary_file.exists():  # pragma: no cover
         binary_file.unlink()
     result = runner.invoke(app, ["--file", f"{binary_file}"])
     text = binary_file.read_text()

tests/test_tutorial/test_parameter_types/test_file/test_tutorial004_an.py

@@ -15,7 +15,7 @@
 
 def test_main(tmpdir):
     config_file = Path(tmpdir) / "config.txt"
-    if config_file.exists():  # pragma no cover
+    if config_file.exists():  # pragma: no cover
         config_file.unlink()
         config_file.write_text("")
     result = runner.invoke(app, ["--config", f"{config_file}"])

tests/test_tutorial/test_parameter_types/test_file/test_tutorial005.py

@@ -15,7 +15,7 @@
 
 def test_main(tmpdir):
     config_file = Path(tmpdir) / "config.txt"
-    if config_file.exists():  # pragma no cover
+    if config_file.exists():  # pragma: no cover
         config_file.unlink()
         config_file.write_text("")
     result = runner.invoke(app, ["--config", f"{config_file}"])

tests/test_tutorial/test_parameter_types/test_file/test_tutorial005_an.py

@@ -23,7 +23,7 @@ def test_no_path(tmpdir):
 
 def test_not_exists(tmpdir):
     config_file = Path(tmpdir) / "config.txt"
-    if config_file.exists():  # pragma no cover
+    if config_file.exists():  # pragma: no cover
         config_file.unlink()
     result = runner.invoke(app, ["--config", f"{config_file}"])
     assert result.exit_code == 0

tests/test_tutorial/test_parameter_types/test_path/test_tutorial001.py

@@ -23,7 +23,7 @@ def test_no_path(tmpdir):
 
 def test_not_exists(tmpdir):
     config_file = Path(tmpdir) / "config.txt"
-    if config_file.exists():  # pragma no cover
+    if config_file.exists():  # pragma: no cover
         config_file.unlink()
     result = runner.invoke(app, ["--config", f"{config_file}"])
     assert result.exit_code == 0

tests/test_tutorial/test_parameter_types/test_path/test_tutorial001_an.py

@@ -15,7 +15,7 @@
 
 def test_not_exists(tmpdir):
     config_file = Path(tmpdir) / "config.txt"
-    if config_file.exists():  # pragma no cover
+    if config_file.exists():  # pragma: no cover
         config_file.unlink()
     result = runner.invoke(app, ["--config", f"{config_file}"])
     assert result.exit_code != 0

tests/test_tutorial/test_parameter_types/test_path/test_tutorial002.py

@@ -15,7 +15,7 @@
 
 def test_not_exists(tmpdir):
     config_file = Path(tmpdir) / "config.txt"
-    if config_file.exists():  # pragma no cover
+    if config_file.exists():  # pragma: no cover
         config_file.unlink()
     result = runner.invoke(app, ["--config", f"{config_file}"])
     assert result.exit_code != 0

tests/test_tutorial/test_parameter_types/test_path/test_tutorial002_an.py

@@ -17,7 +17,7 @@
 
 try:
     import shellingham
-except ImportError:  # pragma: nocover
+except ImportError:  # pragma: no cover
     shellingham = None
 
 

typer/_completion_classes.py

@@ -9,7 +9,7 @@
 
 try:
     import shellingham
-except ImportError:  # pragma: nocover
+except ImportError:  # pragma: no cover
     shellingham = None
 
 
@@ -108,7 +108,7 @@ def install_bash(*, prog_name: str, complete_var: str, shell: str) -> Path:
         rc_content = rc_path.read_text()
     completion_init_lines = [f"source {completion_path}"]
     for line in completion_init_lines:
-        if line not in rc_content:  # pragma: nocover
+        if line not in rc_content:  # pragma: no cover
             rc_content += f"\n{line}"
     rc_content += "\n"
     rc_path.write_text(rc_content)
@@ -135,7 +135,7 @@ def install_zsh(*, prog_name: str, complete_var: str, shell: str) -> Path:
         "fpath+=~/.zfunc",
     ]
     for line in completion_init_lines:
-        if line not in zshrc_content:  # pragma: nocover
+        if line not in zshrc_content:  # pragma: no cover
             zshrc_content += f"\n{line}"
     zshrc_content += "\n"
     zshrc_path.write_text(zshrc_content)
@@ -176,17 +176,17 @@ def install_powershell(*, prog_name: str, complete_var: str, shell: str) -> Path
         check=True,
         stdout=subprocess.PIPE,
     )
-    if result.returncode != 0:  # pragma: nocover
+    if result.returncode != 0:  # pragma: no cover
         click.echo("Couldn't get PowerShell user profile", err=True)
         raise click.exceptions.Exit(result.returncode)
     path_str = ""
-    if isinstance(result.stdout, str):  # pragma: nocover
+    if isinstance(result.stdout, str):  # pragma: no cover
         path_str = result.stdout
     if isinstance(result.stdout, bytes):
         try:
             # PowerShell would be predominant in Windows
             path_str = result.stdout.decode("windows-1252")
-        except UnicodeDecodeError:  # pragma: nocover
+        except UnicodeDecodeError:  # pragma: no cover
             try:
                 path_str = result.stdout.decode("utf8")
             except UnicodeDecodeError:

typer/_completion_shared.py

@@ -12,7 +12,7 @@
 
 try:
     import shellingham
-except ImportError:  # pragma: nocover
+except ImportError:  # pragma: no cover
     shellingham = None
 
 
@@ -34,7 +34,7 @@ def get_completion_inspect_parameters() -> Tuple[ParamMeta, ParamMeta]:
 
 def install_callback(ctx: click.Context, param: click.Parameter, value: Any) -> Any:
     if not value or ctx.resilient_parsing:
-        return value  # pragma no cover
+        return value  # pragma: no cover
     if isinstance(value, str):
         shell, path = install(shell=value)
     else:
@@ -46,7 +46,7 @@ def install_callback(ctx: click.Context, param: click.Parameter, value: Any) ->
 
 def show_callback(ctx: click.Context, param: click.Parameter, value: Any) -> Any:
     if not value or ctx.resilient_parsing:
-        return value  # pragma no cover
+        return value  # pragma: no cover
     prog_name = ctx.find_root().info_name
     assert prog_name
     complete_var = "_{}_COMPLETE".format(prog_name.replace("-", "_").upper())
@@ -82,7 +82,7 @@ def _install_completion_placeholder_function(
         help="Show completion for the current shell, to copy it or customize the installation.",
     ),
 ) -> Any:
-    pass  # pragma no cover
+    pass  # pragma: no cover
 
 
 def _install_completion_no_auto_placeholder_function(
@@ -99,7 +99,7 @@ def _install_completion_no_auto_placeholder_function(
         help="Show completion for the specified shell, to copy it or customize the installation.",
     ),
 ) -> Any:
-    pass  # pragma no cover
+    pass  # pragma: no cover
 
 
 # Re-implement Click's shell_complete to add error message with:

typer/completion.py

@@ -36,7 +36,7 @@
 
     from . import rich_utils
 
-except ImportError:  # pragma: nocover
+except ImportError:  # pragma: no cover
     rich = None  # type: ignore
 
 MarkupMode = Literal["markdown", "rich", None]

typer/core.py

@@ -43,7 +43,7 @@
 
     console_stderr = Console(stderr=True)
 
-except ImportError:  # pragma: nocover
+except ImportError:  # pragma: no cover
     rich = None  # type: ignore
 
 _original_except_hook = sys.excepthook
@@ -370,7 +370,7 @@ def get_command(typer_instance: Typer) -> click.Command:
         return click_command
     raise RuntimeError(
         "Could not get a command for this Typer instance"
-    )  # pragma no cover
+    )  # pragma: no cover
 
 
 def get_group_name(typer_info: TyperInfo) -> Optional[str]:
@@ -781,7 +781,7 @@ def get_click_type(
             [item.value for item in annotation],
             case_sensitive=parameter_info.case_sensitive,
         )
-    raise RuntimeError(f"Type not yet supported: {annotation}")  # pragma no cover
+    raise RuntimeError(f"Type not yet supported: {annotation}")  # pragma: no cover
 
 
 def lenient_issubclass(
@@ -949,7 +949,7 @@ def get_click_param(
             ),
             convertor,
         )
-    raise AssertionError("A click.Parameter should be returned")  # pragma no cover
+    raise AssertionError("A click.Parameter should be returned")  # pragma: no cover
 
 
 def get_param_callback(