TYP: fix stubtest errors in `numpy.lib._function_base_impl` #28527

jorenham · 2025-03-14T22:44:01Z

This fixes the signatures of the following public numpy members:

average
ma.average
median
percentile
corrcoef

Ported from numpy/numtype#233 --- This fixes the signatures of the following public `numpy` members: - `average` - `ma.average` - `median` - `corrcoef`

charris · 2025-03-15T19:30:13Z

I note that there are differences between numpy/lib/_function_base_impl.pyi in main and 2.2.x even after backporting this. Should I backport the whole file at some point? Some of the differences are like:

-    a: _ArrayLikeComplex_co | _ArrayLikeTD64_co | _ArrayLikeDT64_co | _ArrayLikeObject_co,
+    a: _ArrayLikeComplex_co | _ArrayLikeTD64_co | _ArrayLikeTD64_co | _ArrayLikeObject_co,

Which certainly looks suspicious.

jorenham · 2025-03-15T19:47:51Z

I note that there are differences between numpy/lib/_function_base_impl.pyi in main and 2.2.x even after backporting this. Should I backport the whole file at some point? Some of the differences are like:
-    a: _ArrayLikeComplex_co | _ArrayLikeTD64_co | _ArrayLikeDT64_co | _ArrayLikeObject_co,
+    a: _ArrayLikeComplex_co | _ArrayLikeTD64_co | _ArrayLikeTD64_co | _ArrayLikeObject_co,
Which certainly looks suspicious.

This can be traced back to fca2d02#diff-66e41e3d5dbb0f4563cbcc551193d550eb8cfb0f502b806ab5079792d6e9bf3b

charris · 2025-03-15T19:57:09Z

Ah, most of the differences were ruff style cleanups, that is why it wasn't backported. Seems there were some fixes as well.

jorenham · 2025-03-15T20:00:04Z

Ah, most of the differences were ruff style cleanups, that is why it wasn't backported. Seems there were some fixes as well.

Maybe this DT vs TD fix could be smuggled in through another backport PR or something?

charris · 2025-03-15T20:31:37Z

The easy thing to do is just co the file from main. I don't mind the style cleanups, they just weren't worth the effort to backport.

jorenham · 2025-03-15T21:04:12Z

The easy thing to do is just co the file from main. I don't mind the style cleanups, they just weren't worth the effort to backport.

That will cause problems, because several deprecated methods that will be removed in 2.3 should still remain in 2.2.

To illustrate, this is the current diff:

diff --git a/numpy/__init__.pyi b/numpy/__init__.pyi
index 539c5fa53c..812ea117b0 100644
--- a/numpy/__init__.pyi
+++ b/numpy/__init__.pyi
@@ -227,7 +227,7 @@
 # library include `typing_extensions` stubs:
 # https://github.com/python/typeshed/blob/main/stdlib/typing_extensions.pyi
 from _typeshed import StrOrBytesPath, SupportsFlush, SupportsLenAndGetItem, SupportsWrite
-from typing_extensions import CapsuleType, LiteralString, Never, Protocol, Self, TypeVar, Unpack, deprecated, overload
+from typing_extensions import CapsuleType, LiteralString, Never, Protocol, Self, TypeVar, Unpack, overload
 
 from numpy import (
     char,
@@ -880,7 +880,7 @@
 ]  # fmt: skip
 _FloatingCType: TypeAlias = type[ct.c_float | ct.c_double | ct.c_longdouble]
 _IntegerCType: TypeAlias = _UnsignedIntegerCType | _SignedIntegerCType
-_NumberCType: TypeAlias = _IntegerCType | _IntegerCType
+_NumberCType: TypeAlias = _IntegerCType
 _GenericCType: TypeAlias = _NumberCType | type[ct.c_bool | ct.c_char | ct.py_object[Any]]
 
 # some commonly used builtin types that are known to result in a
@@ -898,11 +898,11 @@
 _ByteOrderChar: TypeAlias = L["<", ">", "=", "|"]
 # can be anything, is case-insensitive, and only the first character matters
 _ByteOrder: TypeAlias = L[
-    "S",                # swap the current order (default)
-    "<", "L", "little", # little-endian
-    ">", "B", "big",    # big endian
-    "=", "N", "native", # native order
-    "|", "I",           # ignore
+    "S",                 # swap the current order (default)
+    "<", "L", "little",  # little-endian
+    ">", "B", "big",     # big endian
+    "=", "N", "native",  # native order
+    "|", "I",            # ignore
 ]  # fmt: skip
 _DTypeKind: TypeAlias = L[
     "b",  # boolean
@@ -982,9 +982,9 @@
 
 _CastingKind: TypeAlias = L["no", "equiv", "safe", "same_kind", "unsafe"]
 
-_OrderKACF: TypeAlias = L[None, "K", "A", "C", "F"]
-_OrderACF: TypeAlias = L[None, "A", "C", "F"]
-_OrderCF: TypeAlias = L[None, "C", "F"]
+_OrderKACF: TypeAlias = L["K", "A", "C", "F"] | None
+_OrderACF: TypeAlias = L["A", "C", "F"] | None
+_OrderCF: TypeAlias = L["C", "F"] | None
 
 _ModeKind: TypeAlias = L["raise", "wrap", "clip"]
 _PartitionKind: TypeAlias = L["introselect"]
@@ -999,7 +999,7 @@
 _SortSide: TypeAlias = L["left", "right"]
 
 _ConvertibleToInt: TypeAlias = SupportsInt | SupportsIndex | _CharLike_co
-_ConvertibleToFloat: TypeAlias =  SupportsFloat | SupportsIndex | _CharLike_co
+_ConvertibleToFloat: TypeAlias = SupportsFloat | SupportsIndex | _CharLike_co
 if sys.version_info >= (3, 11):
     _ConvertibleToComplex: TypeAlias = SupportsComplex | SupportsFloat | SupportsIndex | _CharLike_co
 else:
@@ -1049,7 +1049,7 @@
 
 _DT64Date: TypeAlias = _HasDateAttributes | L["TODAY", "today", b"TODAY", b"today"]
 _DT64Now: TypeAlias = L["NOW", "now", b"NOW", b"now"]
-_NaTValue: TypeAlias = L["NAT","NaT", "nat",b"NAT", b"NaT", b"nat"]
+_NaTValue: TypeAlias = L["NAT", "NaT", "nat", b"NAT", b"NaT", b"nat"]
 
 _MonthUnit: TypeAlias = L["Y", "M", b"Y", b"M"]
 _DayUnit: TypeAlias = L["W", "D", b"W", b"D"]
@@ -1082,8 +1082,7 @@ def tell(self) -> SupportsIndex: ...
     def seek(self, offset: int, whence: int, /) -> object: ...
 
 @type_check_only
-class _SupportsFileMethodsRW(SupportsWrite[bytes], _SupportsFileMethods, Protocol):
-    pass
+class _SupportsFileMethodsRW(SupportsWrite[bytes], _SupportsFileMethods, Protocol): ...
 
 @type_check_only
 class _SupportsItem(Protocol[_T_co]):
@@ -1150,7 +1149,6 @@ def month(self) -> int: ...
     @property
     def year(self) -> int: ...
 
-
 ### Mixins (for internal use only)
 
 @type_check_only
@@ -1635,7 +1633,6 @@ def str(self) -> LiteralString: ...
     @property
     def type(self) -> type[_SCT_co]: ...
 
-
 @final
 class flatiter(Generic[_ArrayT_co]):
     __hash__: ClassVar[None]
@@ -1713,8 +1710,6 @@ def copy(self, order: _OrderKACF = ...) -> Self: ...
     def dump(self, file: StrOrBytesPath | SupportsWrite[bytes]) -> None: ...
     def dumps(self) -> bytes: ...
     def tobytes(self, order: _OrderKACF = ...) -> bytes: ...
-    # NOTE: `tostring()` is deprecated and therefore excluded
-    # def tostring(self, order=...): ...
     def tofile(self, fid: StrOrBytesPath | _SupportsFileMethods, sep: str = ..., format: str = ...) -> None: ...
     # generics and 0d arrays return builtin scalars
     def tolist(self) -> Any: ...
@@ -3903,8 +3898,6 @@ def __int__(self: np.bool[L[False]], /) -> L[0]: ...
     def __int__(self: np.bool[L[True]], /) -> L[1]: ...
     @overload
     def __int__(self, /) -> L[0, 1]: ...
-    @deprecated("In future, it will be an error for 'np.bool' scalars to be interpreted as an index")
-    def __index__(self, /) -> L[0, 1]: ...
     def __abs__(self) -> Self: ...
 
     @overload
@@ -4279,7 +4272,6 @@ def __rmod__(self, other: _Float64_co, /) -> float64: ...  # type: ignore[overri
     def __divmod__(self, other: _Float64_co, /) -> _2Tuple[float64]: ...  # type: ignore[override]
     def __rdivmod__(self, other: _Float64_co, /) -> _2Tuple[float64]: ...  # type: ignore[override]
 
-
 half: TypeAlias = floating[_NBitHalf]
 single: TypeAlias = floating[_NBitSingle]
 double: TypeAlias = floating[_NBitDouble]
@@ -4308,11 +4300,6 @@ def imag(self) -> floating[_NBit2]: ...  # type: ignore[override]
     # NOTE: `__complex__` is technically defined in the concrete subtypes
     def __complex__(self, /) -> complex: ...
     def __abs__(self, /) -> floating[_NBit1 | _NBit2]: ...  # type: ignore[override]
-    @deprecated(
-        "The Python built-in `round` is deprecated for complex scalars, and will raise a `TypeError` in a future release. "
-        "Use `np.round` or `scalar.round` instead."
-    )
-    def __round__(self, /, ndigits: SupportsIndex | None = None) -> Self: ...
 
     @overload
     def __add__(self, other: _Complex64_co, /) -> complexfloating[_NBit1, _NBit2]: ...
@@ -5036,7 +5023,6 @@ def __new__(
         cls, dtype: str
     ) -> finfo[floating[Any]]: ...
 
-
 class iinfo(Generic[_IntegerT_co]):
     dtype: Final[dtype[_IntegerT_co]]
     kind: Final[LiteralString]
@@ -5269,7 +5255,6 @@ def integ(
         k: None | _ArrayLikeComplex_co | _ArrayLikeObject_co = ...,
     ) -> poly1d: ...
 
-
 class matrix(ndarray[_2DShapeT_co, _DType_co]):
     __array_priority__: ClassVar[float]
     def __new__(
@@ -5406,7 +5391,7 @@ def flatten(self, /, order: _OrderKACF = "C") -> matrix[tuple[L[1], int], _DType
     @property
     def T(self) -> matrix[_2D, _DType_co]: ...
     @property
-    def I(self) -> matrix[_2D, Any]: ...
+    def I(self) -> matrix[_2D, Any]: ...  # noqa: E743
     @property
     def A(self) -> ndarray[_2DShapeT_co, _DType_co]: ...
     @property
@@ -5419,7 +5404,6 @@ def getA(self) -> ndarray[_2DShapeT_co, _DType_co]: ...
     def getA1(self) -> ndarray[_Shape, _DType_co]: ...
     def getH(self) -> matrix[_2D, _DType_co]: ...
 
-
 def from_dlpack(
     x: _SupportsDLPack[None],
     /,

TYP: fix stubtest errors in numpy.lib._function_base_impl

a7b7b5b

Ported from numpy/numtype#233 --- This fixes the signatures of the following public `numpy` members: - `average` - `ma.average` - `median` - `corrcoef`

jorenham added 09 - Backport-Candidate PRs tagged should be backported 41 - Static typing numtype Isssue/PR related to numpy/numtype labels Mar 14, 2025

charris merged commit 19e8c4b into numpy:main Mar 15, 2025
75 checks passed

jorenham deleted the numtype/233 branch March 15, 2025 19:06

charris removed the 09 - Backport-Candidate PRs tagged should be backported label Mar 15, 2025

This comment was marked as outdated.

Sign in to view

charris mentioned this pull request Mar 15, 2025

TYP: Backport typing fixes from main (3) #28534

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

TYP: fix stubtest errors in `numpy.lib._function_base_impl` #28527

TYP: fix stubtest errors in `numpy.lib._function_base_impl` #28527

Uh oh!

jorenham commented Mar 14, 2025

Uh oh!

Uh oh!

charris commented Mar 15, 2025

Uh oh!

This comment was marked as outdated.

jorenham commented Mar 15, 2025

Uh oh!

charris commented Mar 15, 2025

Uh oh!

jorenham commented Mar 15, 2025

Uh oh!

charris commented Mar 15, 2025

Uh oh!

jorenham commented Mar 15, 2025 •

edited

Loading

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

TYP: fix stubtest errors in numpy.lib._function_base_impl #28527

TYP: fix stubtest errors in numpy.lib._function_base_impl #28527

Uh oh!

Conversation

jorenham commented Mar 14, 2025

Uh oh!

Uh oh!

charris commented Mar 15, 2025

Uh oh!

This comment was marked as outdated.

jorenham commented Mar 15, 2025

Uh oh!

charris commented Mar 15, 2025

Uh oh!

jorenham commented Mar 15, 2025

Uh oh!

charris commented Mar 15, 2025

Uh oh!

jorenham commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

TYP: fix stubtest errors in `numpy.lib._function_base_impl` #28527

TYP: fix stubtest errors in `numpy.lib._function_base_impl` #28527

jorenham commented Mar 15, 2025 •

edited

Loading