Merge branch 'main' into metrics

Author: debonte

.github/workflows/test.yml

@@ -1,41 +1,51 @@
-name: 'Test'
+name: "Test"
 
 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
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
       - name: Install dependencies
-        run:
-          python -m pip install -r tests/requirements.txt
+        run: python -m pip install --group tests
 
       - name: Run pyright tests
         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
@@ -47,6 +57,5 @@ jobs:
 
       - name: Run Ruff Linter
         uses: astral-sh/ruff-action@v3
-        with:
-          version: "0.9.*"
-      - 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

@@ -4,7 +4,34 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "microsoft-python-type-stubs"
-dynamic = ["version"]
+version = "0"
+
+[dependency-groups]
+hygiene = ["ruff ==0.11.*"]
+tests = [
+    # Tools used for testing
+    "docopt-ng",
+    "mypy ==1.15.*",
+    "pyright",
+
+    # External type stubs and optional dependencies
+    "PyOpenGL",
+    "matplotlib >=3.8",
+    "pandas-stubs",
+    "pytest",
+    "scipy-stubs",
+    "typing_extensions",
+
+    # The libraries we're stubbing.
+    # Needed for stubtest and downloads their dependencies to get known import symbols
+    "networkx",
+    "scikit-image",
+    "scikit-learn",
+    "sympy",
+    "vispy",
+]
+dev = [{ include-group = "hygiene" }, { include-group = "tests" }]
+
 
 # Allow these stubs to be installed from GitHub
 # We need an explicit mapping instead of just
@@ -18,7 +45,6 @@ dynamic = ["version"]
 "skimage-stubs" = "stubs/skimage"
 "sklearn-stubs" = "stubs/sklearn"
 "sympy-stubs" = "stubs/sympy-stubs"
-"transformers-stubs" = "stubs/transformers-stubs"
 "vispy-stubs" = "stubs/vispy"
 
 [tool.ruff]
@@ -27,36 +53,55 @@ line-length = 130
 target-version = "py39"
 
 [tool.ruff.lint]
-# TODO: Use extend-select instead to get base E and F rules that don't conflict with the formatter
-select = [
+extend-select = [
     "FA", # flake8-future-annotations
     "I", # isort
     "PYI", # flake8-pyi
+    "UP", # pyupgrade
+    "W", # pycodestyle Warning
+    "PIE790", # unnecessary-placeholder
 ]
 ignore = [
     ###
     # Rules we don't want or don't agree with
     ###
+
+    # Used for direct, non-subclass type comparison, for example: `type(val) is str`
+    # see https://github.com/astral-sh/ruff/issues/6465
+    "E721", # Do not compare types, use `isinstance()`
+
     # Typeshed doesn't want complex or non-literal defaults, or long strings, for maintenance and testing reasons.
     # This doesn't affect us, let's have more complete stubs.
     "PYI011",
     "PYI014",
     "PYI053",
 
-    # TODO: Handle in its own PR
-    "PYI021", # https://github.com/microsoft/python-type-stubs/pull/343
-
     # TODO: Investigate and fix or configure
-    "PYI001",
-    "PYI002",
-    "PYI017",
-    "PYI019", # Request for more autofixes: https://github.com/astral-sh/ruff/issues/15798
-    "PYI024",
-    "PYI048",
     "PYI051", # Request for autofix: https://github.com/astral-sh/ruff/issues/14185
-    "PYI052",
 ]
 
+[tool.ruff.lint.per-file-ignores]
+"*.pyi" = [
+    ###
+    # Rules that are out of the control of stub authors:
+    ###
+    "E743", # Ambiguous function name; stubs must follow implementation
+    "F403", # `from . import *` used; unable to detect undefined names
+    # Stubs can sometimes re-export entire modules.
+    # Issues with using a star-imported name will be caught by type-checkers.
+    "F405", # may be undefined, or defined from star imports
+]
+
+# 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 = [
@@ -66,10 +111,9 @@ extra-standard-library = [
 ]
 
 [tool.pyright]
-exclude = ["build", ".git"]
+exclude = ["build", ".git", ".venv*"]
 stubPath = "./stubs"
-# Target oldest supported Python version
-pythonversion = "3.9"
+pythonversion = "3.9" # Target oldest supported Python version
 typeCheckingMode = "standard"
 # Partial stubs are acceptable
 reportUnknownArgumentType = false
@@ -93,42 +137,46 @@ reportSelfClsParameterName = false
 reportUnsupportedDunderAll = "error"
 
 [tool.mypy]
-# Target oldest supported Python version
-python_version = "3.9"
-# Allow dynamic typing
-disallow_any_unimported = false # TODO
-disallow_any_expr = false # TODO
-disallow_any_decorated = false # TODO
-disallow_any_explicit = false # TODO
-disallow_any_generics = false # TODO
-disallow_subclassing_any = false # TODO
-# Untyped definitions and calls
-disallow_untyped_calls = false # TODO
-disallow_untyped_defs = false # TODO
-disallow_incomplete_defs = false # TODO
-check_untyped_defs = true
-disallow_untyped_decorators = true
-# Configuring warnings
-warn_redundant_casts = true
+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",
-    # TODO
+    # 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
+    "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",
-    "attr-defined",
-    "import-not-found",
     "misc",
-    "name-defined",
-    "no-redef",
-    "operator",
-    "override",
-    "return",
-    "type-var",
-    "valid-type",
-    "var-annotated",
 ]
-# Configuring error messages
-show_column_numbers = true
+[[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/__init__.pyi

@@ -1,5 +1,6 @@
 import contextlib
-from typing import Generator, Literal
+from collections.abc import Generator
+from typing import Literal
 
 import numpy as np
 from packaging.version import parse as parse_version

stubs/matplotlib/_afm.pyi

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

stubs/matplotlib/_api/__init__.pyi

@@ -1,5 +1,6 @@
 import functools
-from typing import Any, Callable, Generator, Iterable, Type
+from collections.abc import Generator, Iterable
+from typing import Callable
 
 from .deprecation import MatplotlibDeprecationWarning
 
@@ -19,5 +20,5 @@ def select_matching_signature(funcs: list[Callable], *args, **kwargs): ...
 def recursive_subclasses(cls) -> Generator: ...
 def warn_external(
     message: MatplotlibDeprecationWarning | PendingDeprecationWarning | str,
-    category: None | Type[MatplotlibDeprecationWarning] = ...,
+    category: None | type[MatplotlibDeprecationWarning] = ...,
 ) -> None: ...

stubs/matplotlib/_api/deprecation.pyi

@@ -1,6 +1,7 @@
 import contextlib
+from collections.abc import Iterator
 from functools import partial
-from typing import Callable, Iterator
+from typing import Callable
 
 class MatplotlibDeprecationWarning(DeprecationWarning): ...
 

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:
@@ -64,7 +71,7 @@ class DejaVuSansFonts(DejaVuFonts): ...
 
 class StixFonts(UnicodeFonts):
     def __init__(self, *args, **kwargs) -> None: ...
-    @functools.lru_cache()
+    @functools.lru_cache
     def get_sized_alternatives_for_symbol(self, fontname, sym) -> list[tuple]: ...
 
 class StixSansFonts(StixFonts): ...
@@ -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/_pylab_helpers.pyi

@@ -1,4 +1,4 @@
-from typing import Any, List, OrderedDict
+from collections import OrderedDict
 
 from .backend_bases import FigureManagerBase
 from .figure import Figure