Switch from mypy to pyright for static type checking (#23)

* Switch from mypy to pyright for static type checking

* Remove script version of pyright

Author: gahjelle

.github/workflows/lint.yml

@@ -19,12 +19,19 @@ jobs:
           python-version: "3.13"
       - name: Install dependencies
         run: |
+          python -m venv .venv/
+          source .venv/bin/activate
           python -m pip install --upgrade pip
           python -m pip install --group ci
           python -m pip install .
-      - name: Run ruff check
-        run: ruff check --output-format=github src/ tests/ examples/
-      - name: Run ruff format
-        run: ruff format --diff src/ tests/ examples/
-      - name: Run mypy
-        run: python -m mypy src/ tests/ examples/
+      - name: Permanently activate venv
+        run: echo "$PWD/.venv/bin" >> $GITHUB_PATH
+      - name: Run ruff check linter
+        run: |
+          ruff check --output-format=github src/ tests/ examples/
+      - name: Run ruff format formatter
+        run: |
+          ruff format --diff src/ tests/ examples/
+      - uses: jakebailey/pyright-action@v2
+        with:
+          pylance-version: latest-release

.pre-commit-config.yaml

@@ -20,11 +20,11 @@ repos:
       - id: ruff-format
         args: [src/, tests/, examples/]
 
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.17.1
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.404
     hooks:
-      - id: mypy
-        additional_dependencies: [pydantic>=2.0, pyplugs>=0.5.4 , pytest>=8.4.1, rich>=14.1.0, tomli-w>=1.2.0]
+    - id: pyright
+      args: ["--venvpath", "."]
 
   - repo: https://github.com/rhysd/actionlint
     rev: v1.7.7

README.md

@@ -4,9 +4,9 @@
 [![Python versions](https://img.shields.io/pypi/pyversions/configaroo.svg)](https://pypi.org/project/configaroo/)
 [![License](https://img.shields.io/pypi/l/configaroo.svg)](https://github.com/gahjelle/configaroo/blob/main/LICENSE)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![Linted](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml)
+[![Linted with Ruff](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml)
 [![Tested with Pytest](https://github.com/gahjelle/configaroo/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/gahjelle/configaroo/actions/workflows/test.yml)
-[![Type checked with mypy](https://img.shields.io/badge/type%20checked-mypy-green)](http://mypy-lang.org/)
+[![Type checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
 
 Configaroo is a light configuration package for Python that offers the following features:
 

pyproject.toml

@@ -36,13 +36,14 @@ changelog = "https://github.com/gahjelle/configaroo/releases"
 
 [dependency-groups]
 build = ["build>=1.2.2.post1", "twine>=6.1.0"]
-ci = ["mypy>=1.17.1", "pytest>=8.4.1", "rich>=14.1.0", "ruff>=0.12.7", "tomli-w>=1.2.0"]
+ci = ["pytest>=8.4.1", "rich>=14.1.0", "ruff>=0.12.7", "tomli-w>=1.2.0"]
 dev = [
     { include-group = "ci" },
     { include-group = "test" },
     "bumpver>=2024.1130",
     "ipython>=8.36.0",
     "pre-commit>=4.2.0",
+    "pyright>=1.1.404",
 ]
 test = ["pytest>=8.4.1", "pytest-cov>=6.2.1", "tomli-w>=1.2.0"]
 
@@ -74,9 +75,15 @@ ignore = [
 "tests/test_*.py" = ["PLR2004", "S101", "SLF001", "UP018"]
 "tests/*/test_*.py" = ["S101"]
 
-[tool.mypy]
-python_version = "3.11"
-strict = true
+[tool.pyright]
+pythonVersion = "3.11"
+typeCheckingMode = "strict"
+verboseOutput = false
+include = ["src/", "tests/", "examples/"]
+venv = ".venv"
+
+reportUnknownArgumentType = "none"
+reportUnknownMemberType = "none"
 
 [tool.bumpver]
 current_version = "v0.5.0"

src/configaroo/configuration.py

@@ -155,7 +155,7 @@ def add_envs_from_model(
         self,
         model: type[BaseModel],
         prefix: str = "",
-        types: type | UnionType = str | bool | int | float,
+        types: type | UnionType = str | bool | int | float,  # pyright: ignore[reportArgumentType]
     ) -> Self:
         """Add environment variables to configuration based on the given model.
 

tests/test_configuration.py

@@ -127,12 +127,12 @@ def test_find_pyproject_toml() -> None:
 
 def test_find_foreign_caller() -> None:
     """Test that a foreign caller (outside of configaroo) can be identified."""
-    assert configuration._get_foreign_path() == Path(__file__)
+    assert configuration._get_foreign_path() == Path(__file__)  # pyright: ignore[reportPrivateUsage]
 
 
 def test_incomplete_formatter() -> None:
     """Test that the incomplete formatter can handle fields that aren't replaced."""
-    formatted = configuration._incomplete_format(
+    formatted = configuration._incomplete_format(  # pyright: ignore[reportPrivateUsage]
         "{number:5.1f} {non_existent} {string!r} {name}",
         {"number": 3.14, "string": "platypus", "name": "Geir Arne"},
     )