Merge pull request #27618 from dstansby/stubtest-tox

QuLogic · web-flow · commit fd332aa038f9 · 2024-01-16T18:29:00.000-05:00
Add option of running stubtest using tox
diff --git a/.github/workflows/mypy-stubtest.yml b/.github/workflows/mypy-stubtest.yml
@@ -18,12 +18,6 @@ jobs:
         with:
           python-version: 3.9
 
-      - name: Install mypy
-        run: |
-          pip3 install -r requirements/testing/mypy.txt \
-            -r requirements/testing/all.txt
-          pip3 install .
-
       - name: Set up reviewdog
         run: |
           mkdir -p "$HOME/bin"
@@ -32,13 +26,16 @@ jobs:
               sh -s -- -b "$HOME/bin"
           echo "$HOME/bin" >> $GITHUB_PATH
 
+      - name: Install tox
+        run: python -m pip install tox
+
       - name: Run mypy stubtest
         env:
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           set -o pipefail
-          MPLBACKEND=agg python tools/stubtest.py | \
-              sed -e "s!$pythonLocation/lib/python3.9/site-packages!lib!g" | \
+          tox -e stubtest | \
+              sed -e "s!.tox/stubtest/lib/python3.9/site-packages!lib!g" | \
               reviewdog \
                 -efm '%Eerror: %m' \
                 -efm '%CStub: in file %f:%l' \
diff --git a/.gitignore b/.gitignore
@@ -31,6 +31,7 @@
 ################
 # meson-python working directory
 build
+.mesonpy*
 
 # meson-python/build frontend dist directory
 dist
diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -88,9 +88,8 @@ We generally use `stub files
 the type information for ``colors.py``. A notable exception is ``pyplot.py``,
 which is type hinted inline.
 
-Type hints are checked by the mypy :ref:`pre-commit hook <pre-commit-hooks>`
-and can often be verified using ``tools\stubtest.py`` and occasionally may
-require the use of ``tools\check_typehints.py``.
+Type hints are checked by the mypy :ref:`pre-commit hook <pre-commit-hooks>`,
+can often be verified by running ``tox -e stubtest``.
 
 New modules and files: installation
 ===================================
diff --git a/environment.yml b/environment.yml
@@ -46,6 +46,7 @@ dependencies:
       - sphinxcontrib-svg2pdfconverter>=1.1.0
       - pikepdf
   # testing
+  - black<24
   - coverage
   - flake8>=3.8
   - flake8-docstrings>=1.4.0
@@ -64,4 +65,4 @@ dependencies:
   - pytest-xdist
   - tornado
   - pytz
-  - black<24
+  - tox
diff --git a/tox.ini b/tox.ini
@@ -4,7 +4,7 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = py38, py39, py310
+envlist = py38, py39, py310, stubtest
 
 [testenv]
 changedir = /tmp
@@ -25,3 +25,12 @@ commands =
 deps =
     pytest
     pytz
+
+[testenv:stubtest]
+changedir = {tox_root}
+commands =
+    python tools/stubtest.py
+usedevelop = False
+deps =
+    -r requirements/testing/mypy.txt
+    -r requirements/testing/all.txt
