Support pyright strict mode in template

- Add an option to the template to enable strict mode if pyright is selected as the type checker.
- Default to standard type checking, the user must actively select it
- Set config to strict if the user selects both pyright and strict mode (we do not support mypy strict mode)
- Modify tests, remove "manual" enabling of strict mode now the template can do it for us

Author: callumforrester

copier.yml

@@ -122,6 +122,18 @@ type_checker:
         - pyright
         - mypy
 
+strict_typing:
+    type: bool
+    when: >-
+        {{ type_checker == 'pyright' }}
+    default: false
+    help: |
+        Would you like to run pyright in strict mode?
+        It is excellent for building consistent, maintainable projects but difficult to adopt on top 
+        of legacy code and projects with many external dependencies. 
+        The recommended approach is to start with strict mode and disable it if it 
+        becomes too costly to maintain.
+
 pypi:
     type: bool
     help: Would you like the wheel and source distribution to be automatically uploaded to PyPI when a release is made?

example-answers.yml

@@ -12,4 +12,5 @@ github_org: DiamondLightSource
 package_name: python_copier_template_example
 repo_name: python-copier-template-example
 type_checker: pyright
+strict_typing: false
 pypi: true

template/pyproject.toml.jinja

@@ -51,9 +51,11 @@ name = "{{ author_name }}"
 [tool.setuptools_scm]
 version_file = "src/{{ package_name }}/_version.py"
 {% if type_checker=="pyright" %}
-[tool.pyright]
+[tool.pyright]{% if strict_typing %}
+typeCheckingMode = "strict"
+{% else %}
 typeCheckingMode = "standard"
-reportMissingImports = false # Ignore missing stubs in imported modules
+{% endif %}reportMissingImports = false # Ignore missing stubs in imported modules
 {% endif %}{% if type_checker=="mypy" %}
 [tool.mypy]
 ignore_missing_imports = true # Ignore missing stubs in imported modules

tests/test_example.py

@@ -48,9 +48,11 @@ def test_template_defaults(tmp_path: Path):
     copy_project(tmp_path)
     run = make_venv(tmp_path)
     container_doc = tmp_path / "docs" / "how-to" / "run-container.md"
+    pyproject_toml = tmp_path / "pyproject.toml"
     assert container_doc.exists()
     catalog_info = tmp_path / "catalog-info.yaml"
     assert catalog_info.exists()
+    assert 'typeCheckingMode = "standard"' in pyproject_toml.read_text()
     run("./venv/bin/tox -p")
     if not run_pipe("git tag --points-at HEAD"):
         # Only run linkcheck if not on a tag, as the CI might not have pushed
@@ -213,21 +215,26 @@ def __init__(self):
         run("ruff check")
 
 
-def test_works_in_pyright_strict_mode(tmp_path: Path):
-    copy_project(tmp_path)
+def test_pyright_works_in_strict_typing_mode(tmp_path: Path):
+    copy_project(tmp_path, type_checker="pyright", strict_typing=True)
     pyproject_toml = tmp_path / "pyproject.toml"
 
-    # Enable strict mode
-    run_pipe(
-        'sed -i \'s|typeCheckingMode = "standard"|typeCheckingMode = "strict"|\''
-        f" {pyproject_toml}"
-    )
+    # Check strict mode is configured
+    assert 'typeCheckingMode = "strict"' in pyproject_toml.read_text()
 
     # Ensure pyright is still happy
     run = make_venv(tmp_path)
     run(f"./venv/bin/pyright {tmp_path}")
 
 
+def test_ignores_mypy_strict_mode(tmp_path: Path):
+    copy_project(tmp_path, type_checker="mypy", strict_typing=True)
+    pyproject_toml = tmp_path / "pyproject.toml"
+
+    # Check strict mode is not configured
+    assert "typeCheckingMode =" not in pyproject_toml.read_text()
+
+
 def test_works_with_pydocstyle(tmp_path: Path):
     copy_project(tmp_path)
     pyproject_toml = tmp_path / "pyproject.toml"