Add tool for running stubtest

Walks the ast to find delete_parameter calls and automatically ignores them as their signature is modified at runtime

Could potentially be further modified to respect the alias behavior, which is the majority of the current allowlist

Makes running stubtest easier as now it is just 'python tools/stubtest.py', rather than a long incantation with multiple arguments

Author: ksunden

.github/workflows/mypy-stubtest.yml

@@ -37,10 +37,7 @@ jobs:
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           set -o pipefail
-          MPLBACKEND=agg python -m mypy.stubtest \
-            --mypy-config-file pyproject.toml \
-            --allowlist ci/mypy-stubtest-allowlist.txt \
-            matplotlib | \
+          MPLBACKEND=agg python tools/stubtest.py | \
               reviewdog \
                 -efm '%Eerror: %m' \
                 -efm '%CStub: in file %f:%l' \

ci/mypy-stubtest-allowlist.txt

@@ -55,13 +55,10 @@ matplotlib.cm.unregister_cmap
 matplotlib.collections.PolyCollection.span_where
 
 # 3.8 deprecations
-matplotlib.cbook.get_sample_data
 matplotlib.contour.ContourSet.allkinds
 matplotlib.contour.ContourSet.allsegs
 matplotlib.contour.ContourSet.tcolors
 matplotlib.contour.ContourSet.tlinewidths
-matplotlib.ticker.LogLocator.__init__
-matplotlib.ticker.LogLocator.set_params
 
 # positional-only argument name lacking leading underscores
 matplotlib.axes._base._AxesBase.axis

doc/devel/contribute.rst

@@ -425,11 +425,7 @@ Introducing
      updated on introduction.
    - Items decorated with ``@_api.delete_parameter`` should include a default value hint
      for the deleted parameter, even if it did not previously have one (e.g.
-     ``param: <type> = ...``). Even so, the decorator changes the default value to a
-     sentinel value which should not be included in the type stub. Thus, Mypy Stubtest
-     needs to be informed of the inconsistency by placing the method into
-     :file:`ci/mypy-stubtest-allowlist.txt` under a heading indicating the deprecation
-     version number.
+     ``param: <type> = ...``).
 
 Expiring
 ~~~~~~~~
@@ -452,11 +448,11 @@ Expiring
      will have been updated at introduction, and require no change now.
    - Items decorated with ``@_api.delete_parameter`` will need to be updated to the
      final signature, in the same way as the ``.py`` file signature is updated.
-     The entry in :file:`ci/mypy-stubtest-allowlist.txt` should be removed.
-   - Any other entries in :file:`ci/mypy-stubtest-allowlist.txt` under a version's
-     deprecations should be double checked, as only ``delete_parameter`` should normally
-     require that mechanism for deprecation. For removed items that were not in the stub
-     file, only deleting from the allowlist is required.
+   - Any entries in :file:`ci/mypy-stubtest-allowlist.txt` which indicate a deprecation
+     version should be double checked. In most cases this is not needed, though some
+     items were never type hinted in the first place and were added to this file
+     instead. For removed items that were not in the stub file, only deleting from the
+     allowlist is required.
 
 Adding new API
 --------------

tools/stubtest.py

@@ -0,0 +1,53 @@
+import ast
+import pathlib
+import subprocess
+import sys
+import tempfile
+
+root = pathlib.Path(__file__).parent.parent
+
+lib = root / "lib"
+mpl = lib / "matplotlib"
+
+
+class Visitor(ast.NodeVisitor):
+    def __init__(self, filepath, output):
+        self.filepath = filepath
+        self.context = list(filepath.with_suffix("").relative_to(lib).parts)
+        self.output = output
+
+    def visit_FunctionDef(self, node):
+        if any("delete_parameter" in ast.unparse(line) for line in node.decorator_list):
+            parents = []
+            if hasattr(node, "parent"):
+                parent = node.parent
+                while hasattr(parent, "parent") and not isinstance(parent, ast.Module):
+                    parents.append(parent.name)
+                    parent = parent.parent
+            self.output.write(f"{'.'.join(self.context + parents)}.{node.name}\n")
+
+
+with tempfile.NamedTemporaryFile("wt") as f:
+    for path in mpl.glob("**/*.py"):
+        v = Visitor(path, f)
+        tree = ast.parse(path.read_text())
+
+        # Assign parents to tree so they can be backtraced
+        for node in ast.walk(tree):
+            for child in ast.iter_child_nodes(node):
+                child.parent = node
+
+        v.visit(tree)
+    f.flush()
+    proc = subprocess.run(
+        [
+            "stubtest",
+            "--mypy-config-file=pyproject.toml",
+            "--allowlist=ci/mypy-stubtest-allowlist.txt",
+            f"--allowlist={f.name}",
+            "matplotlib",
+        ],
+        cwd=root,
+    )
+
+sys.exit(proc.returncode)