Add mypy to reviewdog workflow

ksunden · ksunden · commit 4fe4fab542b2 · 2023-03-30T12:31:22.000-05:00
add numpy to mypy and explicitly use pyproject.toml for config

update reviewdog filter

Add explicit inline excludes

Add deps to mypy run

remove numpy from mypy, add python-dateutil

Add default dependencies to mypy deps

mypy requirements fix python version requirement

psutil stubs plus sphinx install

Add ignore missing imports (cycler and a handful of others do not _yet_ have released type hints)

add follow imports skip to mypy ci

remove explicit extra excludes in mypy ci, rely on config

Add back pipe mypy ci

follow imports silent mypy ci

Add comment about ignore missing imports in mypy ci

bump reviewdog mypy to py3.9
diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml
@@ -38,6 +38,40 @@ jobs:
           flake8 --docstring-convention=all | \
             reviewdog -f=pep8 -name=flake8 \
               -tee -reporter=github-check -filter-mode nofilter
+  mypy:
+    name: mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python 3
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Install mypy
+        run: pip3 install -r requirements/testing/mypy.txt -r requirements/testing/all.txt
+
+      - name: Set up reviewdog
+        run: |
+          mkdir -p "$HOME/bin"
+          curl -sfL \
+            https://github.com/reviewdog/reviewdog/raw/master/install.sh | \
+              sh -s -- -b "$HOME/bin"
+          echo "$HOME/bin" >> $GITHUB_PATH
+
+      - name: Run mypy
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -o pipefail
+          # the ignore missing imports can be removed when typed cycler is released and used
+          mypy --config pyproject.toml lib/matplotlib \
+             --ignore-missing-imports \
+             --follow-imports silent | \
+            reviewdog -f=mypy -name=mypy \
+              -tee -reporter=github-check -filter-mode nofilter
+
 
   eslint:
     name: eslint
diff --git a/requirements/testing/mypy.txt b/requirements/testing/mypy.txt
@@ -0,0 +1,27 @@
+# Extra pip requirements for the GitHub Actions flake8 build
+
+mypy
+
+# Extra stubs distributed separately from the main pypi package
+pandas-stubs
+types-pillow
+types-python-dateutil
+types-psutil
+
+sphinx
+
+# Default requirements, included here because mpl itself does not
+# need to be installed for mypy to run, but deps are needed
+# and pip has no --deps-only install command
+contourpy>=1.0.1
+cycler>=0.10
+fonttools>=4.22.0
+kiwisolver>=1.0.1
+numpy>=1.19
+packaging>=20.0
+pillow>=6.2.0
+pyparsing>=2.3.1
+python-dateutil>=2.7
+setuptools_scm>=7
+
+importlib-resources>=3.2.0 ; python_version < "3.10"
