Make type_checker selectable (#108)

Author: coretl

README.md

@@ -24,7 +24,7 @@ It integrates the following tools:
 - [pip](https://pip.pypa.io) to manage installation
 - [pytest](https://docs.pytest.org) for code testing and coverage
 - [pre-commit](https://pre-commit.com) to run linting and formatting such as [ruff](https://docs.astral.sh/ruff)
-- [pyright](https://microsoft.github.io/pyright) for static type checking
+- [pyright](https://microsoft.github.io/pyright) or [mypy](https://www.mypy-lang.org) for static type checking
 - [sphinx](https://www.sphinx-doc.org) for tutorials, how-to guides, explanations and reference documentation
 - [tox](https://tox.wiki) to run the above tasks locally and in CI
 - [GitHub Actions](https://docs.github.com/en/actions) to provide CI and deployment to PyPI and GitHub Pages

catalog-info.yaml

@@ -46,10 +46,10 @@ spec:
           ui:field: RepoUrlPicker
           ui:options:
             requestUserCredentials:
-                secretsKey: USER_OAUTH_TOKEN
-                additionalScopes:
-                  github:
-                    - workflow
+              secretsKey: USER_OAUTH_TOKEN
+              additionalScopes:
+                github:
+                  - workflow
             allowedHosts:
               - github.com
         description:
@@ -75,7 +75,17 @@ spec:
           enum:
             - README
             - sphinx
-
+        typeChecker:
+          title: Type Checker
+          description: |
+            What type checker would you like to use?
+            Pyright is recommended for new projects, but it is stricter,
+            so you might need to select mypy for existing projects.
+          type: string
+          default: pyright
+          enum:
+            - pyright
+            - mypy
 
   # This template is meant to be used on top of an existing template.
   # By adding the following and fetching from an absolute URL you can
@@ -86,9 +96,9 @@ spec:
       action: fetch:copier
       input:
         url: .
-        values:        
+        values:
           destination: ${{ parameters.repoUrl | parseRepoUrl }}
-
+          # These are answers for the copier template
           package_name: ${{ parameters.repoUrl | parseRepoUrl | pick('repo') | replace('-', '_') }}
           description: ${{ parameters.description }}
           git_platform: ${{ parameters.repoUrl | parseRepoUrl | pick('host') }}
@@ -100,12 +110,13 @@ spec:
           component_owner: ${{ parameters.owner }}
           docker: ${{ parameters.docker }}
           docs_type: ${{ parameters.docs }}
+          type_checker: ${{ parameters.typeChecker }}
 
     - id: publish
       name: Publish
       action: publish:github
       input:
-        allowedHosts: ['github.com']
+        allowedHosts: ["github.com"]
         description: This is ${{ parameters.name }}
         repoUrl: ${{ parameters.repoUrl }}
         repoVisibility: public

copier.yml

@@ -76,6 +76,16 @@ docs_type:
         - README
         - sphinx
 
+type_checker:
+    type: str
+    help: |
+        What type checker would you like to use?
+        Pyright is recommended for new projects, but it is stricter,
+        so you might need to select mypy for existing projects.
+    choices:
+        - pyright
+        - mypy
+
 # Internal variables
 repo_url:
     type: str

docs/how-to/static-analysis.md

@@ -1,6 +1,6 @@
-# Run static analysis using pyright
+# Run static analysis using pyright or mypy
 
-Static type analysis is done with [pyright](https://microsoft.github.io/pyright/). It checks type definition in source files without running them, and highlights potential issues where types do not match. You can run it with:
+Static type analysis is done with [pyright](https://microsoft.github.io/pyright) or [mypy](https://www.mypy-lang.org) dependent on the settings in `pyproject.toml`. It checks type definition in source files without running them, and highlights potential issues where types do not match. You can run it with:
 
 ```
 $ tox -e type-checking

example-answers.yml

@@ -9,3 +9,4 @@ git_platform: github.com
 github_org: DiamondLightSource
 package_name: python_copier_template_example
 repo_name: python-copier-template-example
+type_checker: pyright

template/pyproject.toml.jinja

@@ -51,10 +51,13 @@ name = "{{ author_name }}"
 
 [tool.setuptools_scm]
 write_to = "src/{{ package_name }}/_version.py"
-
+{% if type_checker=="pyright" %}
 [tool.pyright]
 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
+{% endif %}
 [tool.pytest.ini_options]
 # Run pytest with all our checkers, and don't spam us with massive tracebacks on error
 addopts = """
@@ -86,12 +89,12 @@ passenv = *
 allowlist_externals =
     pytest
     pre-commit
-    pyright
+    {{ type_checker }}
 {% if sphinx %}    sphinx-build
     sphinx-autobuild
 {% endif %}commands =
     pre-commit: pre-commit run --all-files {posargs}
-    type-checking: pyright src tests {posargs}
+    type-checking: {{ type_checker }} src tests {posargs}
     tests: pytest --cov={{ package_name }} --cov-report term --cov-report xml:cov.xml {posargs}
 {% if sphinx %}    docs: sphinx-{posargs:build -EW --keep-going} -T docs build/html
 {% endif %}"""