Merge branch 'main' of https://github.com/microsoft/python-type-stubs into remove-networkx

Author: Avasam

.github/workflows/test.yml

@@ -4,17 +4,25 @@ on: [push, pull_request, workflow_dispatch]
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     timeout-minutes: 10
+    strategy:
+      matrix:
+        # Oldest non-EOL and newest released
+        # scipy-stubs does not support Python 3.9
+        python-version: ["3.10", "3.13"]
+        # Tier 1 OSes
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+      fail-fast: false
 
     steps:
       - name: Check out code
         uses: actions/checkout@v2
 
-      - name: Setup Python
+      - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
-          python-version: "3.11"
+          python-version: ${{ matrix.python-version }}
 
       - name: Cache pip
         uses: actions/cache@v4
@@ -31,9 +39,13 @@ jobs:
         uses: jakebailey/pyright-action@v2
         with:
           pylance-version: latest-prerelease
+          python-version: ${{ matrix.python-version }}
 
       - name: Run mypy tests
-        run: python -m mypy .
+        run: python -m mypy . --python-version=${{ matrix.python-version }}
+
+      - name: Run stubtest
+        run: python tests/run_stubtest.py
 
   hygiene:
     runs-on: ubuntu-latest
@@ -45,4 +57,5 @@ jobs:
 
       - name: Run Ruff Linter
         uses: astral-sh/ruff-action@v3
-      - run: ruff format --check
+      - name: Run Ruff Formatter
+        run: ruff format --check

.gitignore

@@ -357,6 +357,9 @@ MigrationBackup/
 # Python virtual environment
 .venv
 
+# Lock files (like uv.lock)
+*.lock
+
 # Build files from utils
 .eggs
 *.egg-info

.vscode/settings.json

@@ -1,6 +1,8 @@
 {
   "editor.formatOnSave": false,
-  "python.formatting.provider": "black",
   "python.analysis.diagnosticMode": "workspace",
-  "python.analysis.openFilesOnly": false
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "charliermarsh.ruff"
+  }
 }

pyproject.toml

@@ -11,24 +11,24 @@ hygiene = ["ruff ==0.11.*"]
 tests = [
     # Tools used for testing
     "docopt-ng",
-    "mypy ==1.13.*",
+    "mypy ==1.16.*",
     "pyright",
 
-    # Typed libraries and stubs
+    # External type stubs and optional dependencies
     "matplotlib >=3.8",
     "pandas-stubs",
+    "PyOpenGL",
     "pytest",
     "scipy-stubs",
-    "typing_extensions",
-
-    # Untyped libraries, used to prevent "reportMissingImports" and get inferred typing
-    "joblib",
     "types-networkx",
-    "PyOpenGL",
+    "typing_extensions",
+    
+    # The libraries we're stubbing.
+    # Needed for stubtest and downloads their dependencies to get known import symbols
+    "scikit-image",
     "scikit-learn",
     "sympy",
-    "traitlets",
-    "transformers",
+    "vispy",
 ]
 dev = [{ include-group = "hygiene" }, { include-group = "tests" }]
 
@@ -44,7 +44,6 @@ dev = [{ include-group = "hygiene" }, { include-group = "tests" }]
 "skimage-stubs" = "stubs/skimage"
 "sklearn-stubs" = "stubs/sklearn"
 "sympy-stubs" = "stubs/sympy-stubs"
-"transformers-stubs" = "stubs/transformers-stubs"
 "vispy-stubs" = "stubs/vispy"
 
 [tool.ruff]
@@ -56,10 +55,13 @@ target-version = "py39"
 extend-select = [
     "FA", # flake8-future-annotations
     "I", # isort
+    "PGH", # pygrep-hooks
+    "PGH", # pygrep-hooks and blanket-noqa
+    "PIE790", # unnecessary-placeholder
     "PYI", # flake8-pyi
+    "RUF", # Ruff-specific and unused-noqa
     "UP", # pyupgrade
     "W", # pycodestyle Warning
-    "PIE790", # unnecessary-placeholder
 ]
 ignore = [
     ###
@@ -76,16 +78,17 @@ ignore = [
     "PYI014",
     "PYI053",
 
-    # TODO: Fixing these would change which symbols are even visible for Pylance.
-    # Which may negatively affect users, especially if the symbol wasn't meant to be re-exported.
-    # Manually evaluate each violation.
-    "F401",
-
     # TODO: Investigate and fix or configure
     "PYI051", # Request for autofix: https://github.com/astral-sh/ruff/issues/14185
 ]
+
 [tool.ruff.lint.per-file-ignores]
 "*.pyi" = [
+    # Ruff 0.8.0 added sorting of __all__ and __slots_.
+    # There is no consensus in typeshed on whether they want to apply this to stubs, so keeping the status quo.
+    # See https://github.com/python/typeshed/pull/13108
+    "RUF022", # `__all__` is not sorted
+    "RUF023", # `{}.__slots__` is not sorted
     ###
     # Rules that are out of the control of stub authors:
     ###
@@ -99,6 +102,13 @@ ignore = [
 # We keep docstrings in sklearn
 "stubs/sklearn/**" = ["PYI021"]
 
+# TODO: For public modules, manually evaluate each violation.
+# Removing unused imports change which symbols are even visible for Pylance.
+# Which may negatively affect users, especially if the symbol wasn't meant to be re-exported.
+# We do assume no public re-exports were meant from private modules
+"!_*.pyi" = ["F401"]
+"__init__.pyi" = ["F401"]
+
 [tool.ruff.lint.isort]
 combine-as-imports = true
 extra-standard-library = [
@@ -108,7 +118,7 @@ extra-standard-library = [
 ]
 
 [tool.pyright]
-exclude = ["build", ".git"]
+exclude = ["build", ".git", ".venv*"]
 stubPath = "./stubs"
 pythonversion = "3.9" # Target oldest supported Python version
 typeCheckingMode = "standard"
@@ -134,24 +144,46 @@ reportSelfClsParameterName = false
 reportUnsupportedDunderAll = "error"
 
 [tool.mypy]
-python_version = "3.9" # Target oldest supported Python version
 strict = true
 check_untyped_defs = true # Strict check on all defs
 show_column_numbers = true
+# Not all imports in these stubs are gonna be typed
+# Don't infer symbols from untyped packages as Any
+follow_untyped_imports = true
 warn_unused_ignores = false # Change from pandas
 # Partial stubs are acceptable
 disallow_any_generics = false
 disallow_incomplete_defs = false
 disallow_untyped_defs = false
 # Suppressing errors
 disable_error_code = [
-    # Not all imports in these stubs are gonna be typed
-    "import-untyped",
+    # mypy's overload implementation differs from pyright
+    # `assert-type` issues is tests mostly comme from checking overloads
+    # Since this project is specific to Pylance, just ignore them
+    "assert-type",
+    # Incompatible overrides are out of our stubs' control
+    # as they are inherited from the implementation.
+    "override",
     # TODO
-    "valid-type", # 967 errors in 115 files
-    "override", # 790 errors in 220 files
-    "assignment", # 773 errors in 172 files
-    "misc", # 692 errors in 132 files
-    "attr-defined", # 202 errors in 75 files
-    "assert-type", # 6 errors in 1 file
+    "assignment", # 744 errors in 155 files
+]
+
+[[tool.mypy.overrides]]
+# follow_untyped_imports = true will cause stubtest to run mypy on the source
+# So disable it for partial stubs
+module = ["sympy.*"]
+follow_untyped_imports = false
+disable_error_code = ["import-untyped", "misc"]
+
+[[tool.mypy.overrides]]
+# These modules are to be removed soon, not worth solving many issues
+module = ["matplotlib.*", "networkx.*"]
+disable_error_code = [
+    "assignment",
+    "misc",
 ]
+[[tool.mypy.overrides]]
+module = ["skimage.*", "sklearn.*"]
+# TODO: Too many untyped decorators still left
+# https://github.com/python/mypy/issues/19148
+disable_error_code = ["misc"]

stubs/matplotlib/_afm.pyi

@@ -1,5 +1,3 @@
-import numpy as np
-
 from ._typing import *
 
 CharMetrics = ...

stubs/matplotlib/_mathtext.pyi

@@ -1,12 +1,19 @@
 import enum
 import functools
-from sre_parse import State
-from tkinter.tix import HList
+import sys
+from _typeshed import Incomplete
 from typing import Literal
 
 from .font_manager import FontProperties
 from .mathtext import MathtextBackend
 
+# tkinter.tix was removed from Python 3.13
+# Recent matplotlib versions define HList in this module
+if sys.version_info >= (3, 13):
+    HList = Incomplete
+else:
+    from tkinter.tix import HList
+
 def get_unicode_index(symbol: str, math: bool = True) -> int: ...
 
 class Fonts:
@@ -143,14 +150,23 @@ class List(Box):
 
 class Hlist(List):
     def __init__(
-        self, elements, w: float = 0, m: Literal["exactly", "additional"] = "additional", do_kern: bool = True
+        self,
+        elements,
+        w: float = 0,
+        m: Literal["exactly", "additional"] = "additional",
+        do_kern: bool = True,
     ) -> None: ...
     def kern(self) -> None: ...
     def hpack(self, w: float = 0, m: Literal["exactly", "additional"] = "additional") -> None: ...
 
 class Vlist(List):
     def __init__(self, elements, h=0, m=...) -> None: ...
-    def vpack(self, h: float = ..., m: Literal["exactly", "additional"] = "additional", l: float = ...) -> None: ...
+    def vpack(
+        self,
+        h: float = ...,
+        m: Literal["exactly", "additional"] = "additional",
+        l: float = ...,
+    ) -> None: ...
 
 class Rule(Box):
     def __init__(self, width: float, height: float, depth: float, state) -> None: ...

stubs/matplotlib/_typing.pyi

@@ -1,14 +1,12 @@
-import decimal
 import io
 import typing_extensions
+from decimal import Decimal as Decimal
 
-import numpy.typing
 import pandas as pd
+from numpy.typing import ArrayLike as ArrayLike
 
-Decimal = decimal.Decimal
 PythonScalar: typing_extensions.TypeAlias = str | int | float | bool
 
-ArrayLike = numpy.typing.ArrayLike
 FileLike = io.IOBase
 PathLike = str
 

stubs/matplotlib/axes/_axes.pyi

@@ -1,6 +1,5 @@
 import datetime
 from collections.abc import Sequence
-from re import L
 from typing import Callable, Literal, overload
 
 import matplotlib.tri as mtri

stubs/matplotlib/axes/_secondary_axes.pyi

@@ -1,6 +1,5 @@
 from typing import Callable, Literal
 
-import numpy as np
 from matplotlib._typing import *
 from matplotlib.axes._base import _AxesBase
 from matplotlib.transforms import Transform

stubs/matplotlib/backend_bases.pyi

@@ -310,7 +310,7 @@ class FigureCanvasBase:
     def mpl_connect(self, s: str, func: Callable) -> int: ...
     def mpl_disconnect(self, cid: int): ...
     _timer_cls = TimerBase
-    def new_timer(self, interval: int = ..., callbacks: list[tuple[Callable, tuple, dict]] = ...) -> _timer_cls: ...
+    def new_timer(self, interval: int = ..., callbacks: list[tuple[Callable, tuple, dict]] = ...) -> TimerBase: ...
     def flush_events(self) -> None: ...
     def start_event_loop(self, timeout: int = ...) -> None: ...
     def stop_event_loop(self) -> None: ...