Add mypy as pre-commit hook (#467)

* [refactor] Run mypy as part of the pre-commit hooks.

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>

* [ci] Use pre-commit directly, instead of starting it via a tox environment.

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>

* [refactor] Removed obsolete "lint" tox environment.

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>

* [ci] Run lint step with Python 3.11.

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>

* [ci] Extracted environment variable for the latest Python version.

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>

* [ci] Avoid checking out unnecessary Git history during deployment step.

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>

* [ci] Avoid checking out unnecessary Git history during test step.

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>

* [ci] Removed obsolete USING_COVERAGE env variable.

We record coverage for all interpreters and merge them afterwards. There is no longer a need to specify the environment we want to use for measuring coverage.

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>

Author: seifertm

.github/workflows/main.yml

@@ -9,6 +9,9 @@ on:
     branches: [master]
   workflow_dispatch:
 
+env:
+  PYTHON_LATEST: 3.11
+
 jobs:
   lint:
     name: Run linters
@@ -22,16 +25,18 @@ jobs:
         fetch-depth: 0
     - uses: actions/setup-python@v4
       with:
-        python-version: '3.10'
+        python-version: ${{ env.PYTHON_LATEST }}
     - name: Install GitHub matcher for ActionLint checker
       run: |
         echo "::add-matcher::.github/actionlint-matcher.json"
+    - name: Install pre-commit
+      run: python -m pip install pre-commit
+    - name: Run pre-commit checks
+      run: pre-commit run --all-files --show-diff-on-failure
     - name: Install check-wheel-content, and twine
       run: python -m pip install build check-wheel-contents tox twine
     - name: Build package
       run: python -m build
-    - name: Run tox for linter
-      run: python -m tox -e lint
     - name: List result
       run: ls -l dist
     - name: Check wheel contents
@@ -52,17 +57,13 @@ jobs:
   test:
     name: Python ${{ matrix.python-version }}
     runs-on: ubuntu-latest
-    env:
-      USING_COVERAGE: 3.7,3.8,3.9,3.10,3.11
 
     strategy:
       matrix:
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
 
     steps:
     - uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
     - uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
@@ -81,7 +82,6 @@ jobs:
       with:
         name: coverage-per-interpreter
         path: .coverage.*
-      if: ${{ contains(env.USING_COVERAGE, matrix.python-version) }}
 
   check:
     name: Check
@@ -96,7 +96,7 @@ jobs:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v4
       with:
-        python-version: 3.11
+        python-version: ${{ env.PYTHON_LATEST }}
     - name: Install Coverage.py
       run: |
         set -xe
@@ -128,8 +128,6 @@ jobs:
         sudo apt-get install -y pandoc
     - name: Checkout
       uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
     - name: Download distributions
       uses: actions/download-artifact@v3
       with:

.pre-commit-config.yaml

@@ -36,6 +36,11 @@ repos:
   - id: check-xml
   - id: check-yaml
   - id: debug-statements
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v0.991
+  hooks:
+  - id: mypy
+    exclude: ^(docs|tests)/.*
 - repo: https://github.com/pycqa/flake8
   rev: 5.0.4
   hooks:

Makefile

@@ -20,15 +20,6 @@ clean-test: ## remove test and coverage artifacts
 	rm -f .coverage
 	rm -fr htmlcov/
 
-lint:
-# CI env-var is set by GitHub actions
-ifdef CI
-	python -m pre_commit run --all-files --show-diff-on-failure
-else
-	python -m pre_commit run --all-files
-endif
-	python -m mypy pytest_asyncio
-
 test:
 	coverage run --parallel-mode --omit */_version.py -m pytest tests
 

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 minversion = 3.14.0
-envlist = py37, py38, py39, py310, py311, lint, pytest-min
+envlist = py37, py38, py39, py310, py311, pytest-min
 isolated_build = true
 passenv =
     CI
@@ -23,16 +23,6 @@ commands = make test
 allowlist_externals =
     make
 
-[testenv:lint]
-basepython = python3.10
-extras = testing
-deps =
-    pre-commit == 2.16.0
-commands =
-    make lint
-allowlist_externals =
-    make
-
 [gh-actions]
 python =
     3.7: py37, pytest-min