Merge pull request numpy#265 from numpy/tox

🔧🐛 configure tox & fix python-specific issues

Author: jorenham

pyproject.toml

@@ -52,7 +52,7 @@ dev = [
     "ruff>=0.9.9",
 ]
 numpy = ["numtype[numpy]"]
-orjson = ["orjson>=3.10.15"]  # speeds up mypy cache, but is missing 3.13t wheels
+orjson = ["orjson>=3.10.15"] # speeds up mypy cache, but is missing 3.13t wheels
 
 [tool.uv]
 default-groups = ["dev", "numpy", "orjson"]
@@ -82,7 +82,6 @@ packages = [
 
 
 [tool.mypy]
-python_version = "3.10"
 mypy_path = "src"
 explicit_package_bases = true
 
@@ -124,7 +123,6 @@ stubPath = "src"
 venvPath = "."
 venv = ".venv"
 pythonPlatform = "All"
-pythonVersion = "3.10"
 typeCheckingMode = "strict"
 
 deprecateTypingAliases = true
@@ -246,6 +244,50 @@ preview = true
         allow-dunder-method-names = ["__array__", "__array_ufunc__"]
 
 
+[tool.tox]
+min_version = "4"
+requires = ["tox-uv>=1"]
+env_list = ["lint", "test", "pyright", "3.13", "3.12", "3.11", "3.10"]
+
+    [tool.tox.env_run_base]
+    description = "Run stubtest under {base_python}"
+    commands = [
+        ["uv", "run", "-q", "-p={base_python}", "--active", "tool/stubtest.py", "--concise"],
+    ]
+
+    [tool.tox.env.pre-commit]
+    description = "pre-commit"
+    skip_install = true
+    commands = [["uvx", "pre-commit", "run", "-a", "--show-diff-on-failure"]]
+
+    [tool.tox.env.lint]
+    description = "lint"
+    runner = "uv-venv-lock-runner"
+    dependency_groups = ["dev"]
+    commands = [
+        ["ruff", "check", "--show-fixes"],
+        ["ruff", "format", "--check"],
+    ]
+
+    [tool.tox.env.test]
+    description = "pytest"
+    runner = "uv-venv-lock-runner"
+    dependency_groups = ["dev", "numpy"]
+    commands = [["pytest"]]
+
+    [tool.tox.env.pyright]
+    description = "basedpyright"
+    runner = "uv-venv-lock-runner"
+    dependency_groups = ["dev"]
+    commands = [["basedpyright", "--threads=3"]]
+
+    [tool.tox.env.mypy]
+    description = "mypy"
+    runner = "uv-venv-lock-runner"
+    dependency_groups = ["dev", "orjson"]
+    commands = [["mypy", {replace = "posargs", default = ["."], extend = true}]]
+
+
 [tool.typos.default]
 extend-ignore-identifiers-re = ['ND|nd']
 

src/numpy-stubs/__init__.pyi

@@ -23,10 +23,9 @@ from typing import (
     TypedDict,
     final,
     overload,
-    runtime_checkable,
     type_check_only,
 )
-from typing_extensions import CapsuleType, LiteralString, Never, Protocol, Self, TypeVar, Unpack, deprecated, override
+from typing_extensions import Buffer, CapsuleType, LiteralString, Never, Protocol, Self, TypeVar, Unpack, deprecated, override
 
 from . import (
     __config__ as __config__,
@@ -463,22 +462,6 @@ from .lib._utils_impl import get_include, info, show_runtime
 from .matrixlib import asmatrix, bmat, matrix
 from .version import __version__
 
-@runtime_checkable
-class _Buffer(Protocol):
-    def __buffer__(self, flags: int, /) -> memoryview: ...
-
-if sys.version_info >= (3, 12):
-    _SupportsBuffer: TypeAlias = _Buffer
-else:
-    import array as _array
-    import mmap as _mmap
-
-    from numpy import distutils as distutils  # noqa: ICN003
-
-    _SupportsBuffer: TypeAlias = (
-        _Buffer | bytes | bytearray | memoryview | _array.array[Any] | _mmap.mmap | NDArray[Any] | generic
-    )
-
 __all__ = [  # noqa: RUF022
     # __numpy_submodules__
     "char", "core", "ctypeslib", "dtypes", "exceptions", "f2py", "fft", "lib", "linalg", "ma", "polynomial", "random", "rec",
@@ -1561,8 +1544,8 @@ class _ArrayOrScalarCommon:
     @property
     def device(self) -> _Device: ...
 
-    if sys.version_info >= (3, 12):
-        def __buffer__(self, flags: int, /) -> memoryview: ...
+    # typeshed forces us to lie about this on python<3.12
+    def __buffer__(self, flags: int, /) -> memoryview: ...
 
     #
     @property
@@ -1993,7 +1976,7 @@ class ndarray(_ArrayOrScalarCommon, Generic[_ShapeT_co, _DTypeT_co]):
         cls,
         shape: _ShapeLike,
         dtype: DTypeLike = float,  # noqa: PYI011
-        buffer: _SupportsBuffer | None = None,
+        buffer: Buffer | None = None,
         offset: CanIndex = 0,
         strides: _ShapeLike | None = None,
         order: _OrderKACF | None = None,
@@ -2107,7 +2090,7 @@ class ndarray(_ArrayOrScalarCommon, Generic[_ShapeT_co, _DTypeT_co]):
     @overload  # == 1-d
     def __iter__(self: ndarray[tuple[int], dtype[_ScalarT]], /) -> Iterator[_ScalarT]: ...
     @overload  # >= 2-d
-    def __iter__(self: ndarray[tuple[int, int, *tuple[int, ...]], dtype[_ScalarT]], /) -> Iterator[NDArray[_ScalarT]]: ...
+    def __iter__(self: ndarray[tuple[int, int, Unpack[tuple[int, ...]]], dtype[_ScalarT]], /) -> Iterator[NDArray[_ScalarT]]: ...
     @overload  # ?-d
     def __iter__(self, /) -> Iterator[Any]: ...
 
@@ -3836,9 +3819,6 @@ class generic(_ArrayOrScalarCommon, Generic[_ItemT_co]):
     @abc.abstractmethod
     def __init__(self, /, *args: Any, **kwargs: Any) -> None: ...
 
-    if sys.version_info >= (3, 12):
-        def __buffer__(self, flags: int, /) -> memoryview: ...
-
     #
     @overload
     def __array__(self, dtype: None = None, /) -> ndarray[tuple[()], dtype[Self]]: ...
@@ -4083,7 +4063,7 @@ class generic(_ArrayOrScalarCommon, Generic[_ItemT_co]):
         *sizes6_: CanIndex,
         order: _OrderACF = "C",
         copy: py_bool | None = None,
-    ) -> ndarray[tuple[L[1], L[1], L[1], L[1], L[1], *tuple[L[1], ...]], dtype[Self]]: ...
+    ) -> ndarray[tuple[L[1], L[1], L[1], L[1], L[1], Unpack[tuple[L[1], ...]]], dtype[Self]]: ...
 
     #
     @overload
@@ -6557,9 +6537,6 @@ class bytes_(character[bytes], bytes):  # type: ignore[misc]
     @overload
     def __init__(self, s: str, /, encoding: str, errors: str = ...) -> None: ...
 
-    #
-    def __bytes__(self, /) -> bytes: ...
-
 class str_(character[str], str):  # type: ignore[misc]
     @overload
     def __new__(cls, value: object = ..., /) -> Self: ...

src/numpy-stubs/_core/_multiarray_umath.pyi

@@ -19,7 +19,7 @@ from typing import (
     overload,
     type_check_only,
 )
-from typing_extensions import CapsuleType, Self, TypeAliasType, TypeVar, Unpack, deprecated
+from typing_extensions import Buffer, CapsuleType, Self, TypeAliasType, TypeVar, Unpack, deprecated
 
 import numpy as np
 import numpy.typing as npt
@@ -30,7 +30,6 @@ from numpy import (  # noqa: ICN003
     _ModeKind,
     _OrderCF,
     _OrderKACF,
-    _SupportsBuffer,
     # NOTE: These implicitly re-exported ufuncs are defined in this ext-module at runtime
     absolute as absolute,
     add as add,
@@ -1165,23 +1164,23 @@ def fromiter(
 #
 @overload
 def frombuffer(
-    buffer: _SupportsBuffer,
+    buffer: Buffer,
     *,
     count: SupportsIndex = -1,
     offset: SupportsIndex = 0,
     **kwargs: Unpack[_KwargsL],
 ) -> _Array[np.float64]: ...
 @overload
 def frombuffer(
-    buffer: _SupportsBuffer,
+    buffer: Buffer,
     dtype: _DTypeLike[_ScalarT],
     count: SupportsIndex = -1,
     offset: SupportsIndex = 0,
     **kwargs: Unpack[_KwargsL],
 ) -> _Array[_ScalarT]: ...
 @overload
 def frombuffer(
-    buffer: _SupportsBuffer,
+    buffer: Buffer,
     dtype: npt.DTypeLike,
     count: SupportsIndex = -1,
     offset: SupportsIndex = 0,

src/numpy-stubs/_core/defchararray.pyi

@@ -1,9 +1,9 @@
 from _typeshed import ConvertibleToInt
 from typing import Any, Literal as L, SupportsIndex, TypeAlias, overload
-from typing_extensions import Never, Self, TypeVar, override
+from typing_extensions import Buffer, Never, Self, TypeVar, override
 
 import numpy as np
-from numpy import _OrderKACF as _Order, _SortKind, _SupportsBuffer  # noqa: ICN003
+from numpy import _OrderKACF as _Order, _SortKind  # noqa: ICN003
 from numpy._typing import (
     NDArray,
     _ArrayLikeAnyString_co as _ToAnyCharND,
@@ -158,7 +158,7 @@ class chararray(np.ndarray[_ShapeT_co, _DTypeT_co]):
         shape: _ToShape,
         itemsize: ConvertibleToInt = 1,
         unicode: L[False] = False,
-        buffer: _SupportsBuffer | None = None,
+        buffer: Buffer | None = None,
         offset: SupportsIndex = 0,
         strides: _ToShape | None = None,
         order: _Order = "C",
@@ -169,7 +169,7 @@ class chararray(np.ndarray[_ShapeT_co, _DTypeT_co]):
         shape: _ToShape,
         itemsize: ConvertibleToInt,
         unicode: L[True],
-        buffer: _SupportsBuffer | None = None,
+        buffer: Buffer | None = None,
         offset: SupportsIndex = 0,
         strides: _ToShape | None = None,
         order: _Order = "C",
@@ -181,7 +181,7 @@ class chararray(np.ndarray[_ShapeT_co, _DTypeT_co]):
         itemsize: ConvertibleToInt = 1,
         *,
         unicode: L[True],
-        buffer: _SupportsBuffer | None = None,
+        buffer: Buffer | None = None,
         offset: SupportsIndex = 0,
         strides: _ToShape | None = None,
         order: _Order = "C",

src/numpy-stubs/_core/fromnumeric.pyi

@@ -208,7 +208,7 @@ def reshape(
     copy: bool | None = None,
 ) -> np.ndarray[tuple[int], np.dtype[_ScalarT]]: ...
 @overload  # shape: _AnyShape
-def reshape(
+def reshape(  # type: ignore[overload-overlap]
     a: _ToArray1_nd[_ScalarT],
     /,
     shape: _AnyShapeT,
@@ -218,7 +218,7 @@ def reshape(
     copy: bool | None = None,
 ) -> Array[_ScalarT, _AnyShapeT]: ...
 @overload  # shape: Sequence[index]
-def reshape(
+def reshape(  # type: ignore[overload-overlap]
     a: _ToArray1_nd[_ScalarT],
     /,
     shape: Sequence[CanIndex],
@@ -486,9 +486,9 @@ def searchsorted(
 @overload
 def resize(a: _ToArray1_nd[_ScalarT], new_shape: CanIndex) -> Array_1d[_ScalarT]: ...
 @overload
-def resize(a: _ToArray1_nd[_ScalarT], new_shape: _AnyShapeT) -> Array[_ScalarT, _AnyShapeT]: ...
+def resize(a: _ToArray1_nd[_ScalarT], new_shape: _AnyShapeT) -> Array[_ScalarT, _AnyShapeT]: ...  # type: ignore[overload-overlap]
 @overload
-def resize(a: _ToArray1_nd[_ScalarT], new_shape: Sequence[CanIndex]) -> Array[_ScalarT]: ...
+def resize(a: _ToArray1_nd[_ScalarT], new_shape: Sequence[CanIndex]) -> Array[_ScalarT]: ...  # type: ignore[overload-overlap]
 @overload
 def resize(a: ArrayLike, new_shape: CanIndex) -> Array_1d[Any]: ...
 @overload

src/numpy-stubs/_core/records.pyi

@@ -1,10 +1,10 @@
 from _typeshed import StrOrBytesPath
 from collections.abc import Iterable, Sequence
 from typing import IO, Any, ClassVar, Literal as L, Protocol, SupportsIndex, TypeAlias, overload, type_check_only
-from typing_extensions import TypeVar
+from typing_extensions import Buffer, TypeVar
 
 import numpy as np
-from numpy import _ByteOrder, _OrderKACF, _SupportsBuffer  # noqa: ICN003
+from numpy import _ByteOrder, _OrderKACF  # noqa: ICN003
 from numpy._typing import ArrayLike, DTypeLike, NDArray, _ArrayLikeVoid_co, _NestedSequence, _ShapeLike
 
 __all__ = [
@@ -66,7 +66,7 @@ class recarray(np.ndarray[_ShapeT_co, _DTypeT_co]):
         subtype,
         shape: _ShapeLike,
         dtype: None = None,
-        buf: _SupportsBuffer | None = None,
+        buf: Buffer | None = None,
         offset: SupportsIndex = 0,
         strides: _ShapeLike | None = None,
         *,
@@ -82,7 +82,7 @@ class recarray(np.ndarray[_ShapeT_co, _DTypeT_co]):
         subtype,
         shape: _ShapeLike,
         dtype: DTypeLike,
-        buf: _SupportsBuffer | None = None,
+        buf: Buffer | None = None,
         offset: SupportsIndex = ...,
         strides: _ShapeLike | None = None,
         formats: None = None,
@@ -158,7 +158,7 @@ def fromrecords(
 # exported in `numpy.rec`
 @overload
 def fromstring(
-    datastring: _SupportsBuffer,
+    datastring: Buffer,
     dtype: DTypeLike,
     shape: _ShapeLike | None = None,
     offset: int = 0,
@@ -170,7 +170,7 @@ def fromstring(
 ) -> _RecArray[record]: ...
 @overload
 def fromstring(
-    datastring: _SupportsBuffer,
+    datastring: Buffer,
     dtype: None = None,
     shape: _ShapeLike | None = None,
     offset: int = 0,
@@ -214,7 +214,7 @@ def fromfile(
 
 # exported in `numpy.rec`
 @overload
-def array(
+def array(  # type: ignore[overload-overlap]
     obj: _SCT | NDArray[_SCT],
     dtype: None = None,
     shape: _ShapeLike | None = None,

src/numpy-stubs/_core/shape_base.pyi

@@ -39,7 +39,7 @@ def atleast_1d(a0: _Array1T, /) -> _Array1T: ...
 @overload
 def atleast_1d(a0: _Array1T0, a1: _Array1T1, /) -> tuple[_Array1T0, _Array1T1]: ...
 @overload
-def atleast_1d(a0: _Array1T, a1: _Array1T, /, *arys: _Array1T) -> tuple[_Array1T, ...]: ...
+def atleast_1d(a0: _Array1T, a1: _Array1T, /, *arys: _Array1T) -> tuple[_Array1T, ...]: ...  # type: ignore[overload-overlap]
 @overload
 def atleast_1d(a0: _ArrayLike[_SCT], /) -> NDArray[_SCT]: ...
 @overload
@@ -59,7 +59,7 @@ def atleast_2d(a0: _Array2T, /) -> _Array2T: ...
 @overload
 def atleast_2d(a0: _Array2T0, a1: _Array2T1, /) -> tuple[_Array2T0, _Array2T1]: ...
 @overload
-def atleast_2d(a0: _Array2T, a1: _Array2T, /, *arys: _Array2T) -> tuple[_Array2T, ...]: ...
+def atleast_2d(a0: _Array2T, a1: _Array2T, /, *arys: _Array2T) -> tuple[_Array2T, ...]: ...  # type: ignore[overload-overlap]
 @overload
 def atleast_2d(a0: _ArrayLike[_SCT], /) -> NDArray[_SCT]: ...
 @overload
@@ -79,7 +79,7 @@ def atleast_3d(a0: _Array3T, /) -> _Array3T: ...
 @overload
 def atleast_3d(a0: _Array3T0, a1: _Array3T1, /) -> tuple[_Array3T0, _Array3T1]: ...
 @overload
-def atleast_3d(a0: _Array3T, a1: _Array3T, /, *arys: _Array3T) -> tuple[_Array3T, ...]: ...
+def atleast_3d(a0: _Array3T, a1: _Array3T, /, *arys: _Array3T) -> tuple[_Array3T, ...]: ...  # type: ignore[overload-overlap]
 @overload
 def atleast_3d(a0: _ArrayLike[_SCT], /) -> NDArray[_SCT]: ...
 @overload

src/numpy-stubs/_typing/_array_like.pyi

@@ -1,7 +1,6 @@
-import sys
 from collections.abc import Callable, Collection, Sequence
 from typing import Any, Protocol, TypeAlias, runtime_checkable
-from typing_extensions import TypeVar
+from typing_extensions import Buffer, TypeVar
 
 import numpy as np
 from numpy.dtypes import StringDType
@@ -10,12 +9,6 @@ from ._nbit_base import _64Bit
 from ._nested_sequence import _NestedSequence
 from ._shape import _Shape
 
-if sys.version_info >= (3, 12):
-    from collections.abc import Buffer as _Buffer
-else:
-    class _Buffer(Protocol):
-        def __buffer__(self, flags: int, /) -> memoryview: ...
-
 _T = TypeVar("_T")
 _ScalarType = TypeVar("_ScalarType", bound=np.generic)
 _ScalarType_co = TypeVar("_ScalarType_co", bound=np.generic, covariant=True)
@@ -55,7 +48,7 @@ _ArrayLike: TypeAlias = _SupportsArray[np.dtype[_ScalarType]] | _NestedSequence[
 # and another one for the rest
 _DualArrayLike: TypeAlias = _SupportsArray[_DType] | _T | _NestedSequence[_T] | _NestedSequence[_SupportsArray[_DType]]
 
-ArrayLike: TypeAlias = _Buffer | _DualArrayLike[np.dtype[Any], complex | str | bytes]
+ArrayLike: TypeAlias = _DualArrayLike[np.dtype[Any], complex | str | bytes] | Buffer
 
 # `ArrayLike<X>_co`: array-like objects that can be coerced into `X`
 # given the casting rules `same_kind`