check: verify python with mypy

Verify all our python scripts with mypy during `make check'. Also, install mypy during CI and mention it in the README. Signed-off-by: Vincent Stehlé <[email protected]>
ARM-software · Sep 27, 2023 · 5b64ced · 5b64ced
1 parent 73bce93
commit 5b64ced
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 2 deletions.
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
@@ -31,7 +31,7 @@ jobs:
         run: |
           sudo apt update
           sudo apt install python3-pip latexmk libalgorithm-diff-perl texlive \
-            texlive-latex-extra texlive-humanities flake8
+            texlive-latex-extra texlive-humanities flake8 mypy
 
       - name: 'Install Python required packages'
         run: |

diff --git a/.mypy.ini b/.mypy.ini
@@ -0,0 +1,2 @@
+[mypy]
+strict = true
diff --git a/Makefile b/Makefile
@@ -19,6 +19,7 @@ help:
 check:
 	! grep -r --file=.typos.txt --exclude=.typos.txt --exclude-dir=.git
 	flake8 .
+	mypy .
 	$(SPHINXBUILD) -M linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 # Catch-all target: route all unknown targets to Sphinx using the new

diff --git a/README.rst b/README.rst
@@ -41,7 +41,7 @@ Requirements
 
 * Sphinx version 1.5 or later: http://sphinx-doc.org/en/master/contents.html
 * LaTeX (and pdflatex, and various LaTeX packages)
-* Optionally, for verification: ``flake8``
+* Optionally, for verification: ``flake8`` and ``mypy``
 
 On Debian and Ubuntu
 ^^^^^^^^^^^^^^^^^^^^