Merge pull request #131 from hugovk/add-types

Add type hints to release.py and run mypy on CI

Author: hugovk

.github/workflows/lint.yml

@@ -14,12 +14,20 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5.1.0
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
           cache: pip
       - uses: pre-commit/[email protected]
 
+      - name: Install dependencies
+        run: |
+          python3 -m pip install -U pip
+          python3 -m pip install -U tox
+
+      - name: Mypy
+        run: tox -e mypy
+
       - name: Run PSScriptAnalyzer on PowerShell scripts
         shell: pwsh
         run: |

.github/workflows/test.yml

@@ -17,9 +17,9 @@ jobs:
           cache: pip
           cache-dependency-path: dev-requirements.txt
       - run: |
-          python -m pip install -r dev-requirements.txt
+          python -m pip install tox
       - run: |
-          pytest tests/ --cov . --cov tests --cov-report term --cov-report xml
+          tox -e py
 
       - name: Upload coverage
         uses: codecov/[email protected]

.pre-commit-config.yaml

@@ -35,6 +35,21 @@ repos:
     hooks:
       - id: actionlint
 
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: 2.1.3
+    hooks:
+      - id: pyproject-fmt
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.18
+    hooks:
+      - id: validate-pyproject
+
+  - repo: https://github.com/tox-dev/tox-ini-fmt
+    rev: 1.3.1
+    hooks:
+      - id: tox-ini-fmt
+
   - repo: meta
     hooks:
       - id: check-hooks-apply

mypy-requirements.txt

@@ -0,0 +1,3 @@
+mypy==1.10
+pytest
+pytest-mock

pyproject.toml

@@ -0,0 +1,19 @@
+[tool.mypy]
+python_version = "3.12"
+pretty = true
+strict = true
+
+# Extra checks that aren't included in --strict
+enable_error_code = "ignore-without-code,redundant-expr,truthy-iterable"
+extra_checks = true
+warn_unreachable = true
+
+exclude = [
+  "^add-to-pydotorg.py$",
+  "^buildbotapi.py$",
+  "^run_release.py$",
+  "^sbom.py$",
+  "^tests/test_release_tag.py$",
+  "^tests/test_sbom.py$",
+  "^windows-release/purge.py$",
+]