Merge pull request numpy#28527 from jorenham/numtype/233

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

Author: charris

numpy/lib/_function_base_impl.pyi

@@ -1,57 +1,60 @@
-from collections.abc import Sequence, Callable, Iterable
+# ruff: noqa: ANN401
+from collections.abc import Callable, Iterable, Sequence
 from typing import (
-    Concatenate,
-    Literal as L,
     Any,
+    Concatenate,
     ParamSpec,
-    TypeAlias,
-    TypeVar,
-    overload,
     Protocol,
     SupportsIndex,
     SupportsInt,
-    TypeGuard,
-    type_check_only
+    TypeAlias,
+    TypeVar,
+    overload,
+    type_check_only,
 )
-from typing_extensions import deprecated
+from typing import Literal as L
+
+from _typeshed import Incomplete
+from typing_extensions import TypeIs, deprecated
 
 import numpy as np
 from numpy import (
-    vectorize,
+    _OrderKACF,
+    bool_,
+    complex128,
+    complexfloating,
+    datetime64,
+    float64,
+    floating,
     generic,
     integer,
-    floating,
-    complexfloating,
     intp,
-    float64,
-    complex128,
-    timedelta64,
-    datetime64,
     object_,
-    bool_,
-    _OrderKACF,
+    timedelta64,
+    vectorize,
 )
 from numpy._core.multiarray import bincount
+from numpy._globals import _NoValueType
 from numpy._typing import (
-    NDArray,
     ArrayLike,
     DTypeLike,
+    NDArray,
     _ArrayLike,
-    _DTypeLike,
-    _ShapeLike,
     _ArrayLikeBool_co,
-    _ArrayLikeInt_co,
-    _ArrayLikeFloat_co,
     _ArrayLikeComplex_co,
-    _ArrayLikeNumber_co,
-    _ArrayLikeTD64_co,
     _ArrayLikeDT64_co,
+    _ArrayLikeFloat_co,
+    _ArrayLikeInt_co,
+    _ArrayLikeNumber_co,
     _ArrayLikeObject_co,
-    _FloatLike_co,
+    _ArrayLikeTD64_co,
     _ComplexLike_co,
+    _DTypeLike,
+    _FloatLike_co,
+    _NestedSequence,
     _NumberLike_co,
     _ScalarLike_co,
-    _NestedSequence
+    _ShapeLike,
 )
 
 __all__ = [
@@ -109,12 +112,14 @@ _MeshgridIdx: TypeAlias = L['ij', 'xy']
 
 @type_check_only
 class _TrimZerosSequence(Protocol[_T_co]):
-    def __len__(self) -> int: ...
+    def __len__(self, /) -> int: ...
     @overload
     def __getitem__(self, key: int, /) -> object: ...
     @overload
     def __getitem__(self, key: slice, /) -> _T_co: ...
 
+###
+
 @overload
 def rot90(
     m: _ArrayLike[_SCT],
@@ -137,72 +142,62 @@ def flip(m: _ArrayLike[_SCT], axis: None | _ShapeLike = ...) -> NDArray[_SCT]: .
 @overload
 def flip(m: ArrayLike, axis: None | _ShapeLike = ...) -> NDArray[Any]: ...
 
-def iterable(y: object) -> TypeGuard[Iterable[Any]]: ...
+def iterable(y: object) -> TypeIs[Iterable[Any]]: ...
 
 @overload
 def average(
     a: _ArrayLikeFloat_co,
-    axis: None = ...,
-    weights: None | _ArrayLikeFloat_co = ...,
-    returned: L[False] = ...,
-    keepdims: L[False] = ...,
-) -> floating[Any]: ...
-@overload
-def average(
-    a: _ArrayLikeComplex_co,
-    axis: None = ...,
-    weights: None | _ArrayLikeComplex_co = ...,
-    returned: L[False] = ...,
-    keepdims: L[False] = ...,
-) -> complexfloating[Any, Any]: ...
-@overload
-def average(
-    a: _ArrayLikeObject_co,
-    axis: None = ...,
-    weights: None | Any = ...,
-    returned: L[False] = ...,
-    keepdims: L[False] = ...,
-) -> Any: ...
+    axis: None = None,
+    weights: _ArrayLikeFloat_co | None = None,
+    returned: L[False] = False,
+    *,
+    keepdims: L[False] | _NoValueType = ...,
+) -> floating: ...
 @overload
 def average(
     a: _ArrayLikeFloat_co,
-    axis: None = ...,
-    weights: None | _ArrayLikeFloat_co = ...,
-    returned: L[True] = ...,
-    keepdims: L[False] = ...,
-) -> _2Tuple[floating[Any]]: ...
+    axis: None = None,
+    weights: _ArrayLikeFloat_co | None = None,
+    *,
+    returned: L[True],
+    keepdims: L[False] | _NoValueType = ...,
+) -> _2Tuple[floating]: ...
 @overload
 def average(
     a: _ArrayLikeComplex_co,
-    axis: None = ...,
-    weights: None | _ArrayLikeComplex_co = ...,
-    returned: L[True] = ...,
-    keepdims: L[False] = ...,
-) -> _2Tuple[complexfloating[Any, Any]]: ...
+    axis: None = None,
+    weights: _ArrayLikeComplex_co | None = None,
+    returned: L[False] = False,
+    *,
+    keepdims: L[False] | _NoValueType = ...,
+) -> complexfloating: ...
 @overload
 def average(
-    a: _ArrayLikeObject_co,
-    axis: None = ...,
-    weights: None | Any = ...,
-    returned: L[True] = ...,
-    keepdims: L[False] = ...,
-) -> _2Tuple[Any]: ...
+    a: _ArrayLikeComplex_co,
+    axis: None = None,
+    weights: _ArrayLikeComplex_co | None = None,
+    *,
+    returned: L[True],
+    keepdims: L[False] | _NoValueType = ...,
+) -> _2Tuple[complexfloating]: ...
 @overload
 def average(
     a: _ArrayLikeComplex_co | _ArrayLikeObject_co,
-    axis: None | _ShapeLike = ...,
-    weights: None | Any = ...,
-    returned: L[False] = ...,
-    keepdims: bool = ...,
-) -> Any: ...
+    axis: _ShapeLike | None = None,
+    weights: object | None = None,
+    *,
+    returned: L[True],
+    keepdims: bool | bool_ | _NoValueType = ...,
+) -> _2Tuple[Incomplete]: ...
 @overload
 def average(
     a: _ArrayLikeComplex_co | _ArrayLikeObject_co,
-    axis: None | _ShapeLike = ...,
-    weights: None | Any = ...,
-    returned: L[True] = ...,
-    keepdims: bool = ...,
-) -> _2Tuple[Any]: ...
+    axis: _ShapeLike | None = None,
+    weights: object | None = None,
+    returned: bool | bool_ = False,
+    *,
+    keepdims: bool | bool_ | _NoValueType = ...,
+) -> Incomplete: ...
 
 @overload
 def asarray_chkfinite(
@@ -481,38 +476,46 @@ def cov(
     dtype: DTypeLike,
 ) -> NDArray[Any]: ...
 
-# NOTE `bias` and `ddof` have been deprecated
+# NOTE `bias` and `ddof` are deprecated and ignored
 @overload
 def corrcoef(
     m: _ArrayLikeFloat_co,
-    y: None | _ArrayLikeFloat_co = ...,
-    rowvar: bool = ...,
+    y: _ArrayLikeFloat_co | None = None,
+    rowvar: bool = True,
+    bias: _NoValueType = ...,
+    ddof: _NoValueType = ...,
     *,
-    dtype: None = ...,
-) -> NDArray[floating[Any]]: ...
+    dtype: None = None,
+) -> NDArray[floating]: ...
 @overload
 def corrcoef(
     m: _ArrayLikeComplex_co,
-    y: None | _ArrayLikeComplex_co = ...,
-    rowvar: bool = ...,
+    y: _ArrayLikeComplex_co | None = None,
+    rowvar: bool = True,
+    bias: _NoValueType = ...,
+    ddof: _NoValueType = ...,
     *,
-    dtype: None = ...,
-) -> NDArray[complexfloating[Any, Any]]: ...
+    dtype: None = None,
+) -> NDArray[complexfloating]: ...
 @overload
 def corrcoef(
     m: _ArrayLikeComplex_co,
-    y: None | _ArrayLikeComplex_co = ...,
-    rowvar: bool = ...,
+    y: _ArrayLikeComplex_co | None = None,
+    rowvar: bool = True,
+    bias: _NoValueType = ...,
+    ddof: _NoValueType = ...,
     *,
     dtype: _DTypeLike[_SCT],
 ) -> NDArray[_SCT]: ...
 @overload
 def corrcoef(
     m: _ArrayLikeComplex_co,
-    y: None | _ArrayLikeComplex_co = ...,
-    rowvar: bool = ...,
+    y: _ArrayLikeComplex_co | None = None,
+    rowvar: bool = True,
+    bias: _NoValueType = ...,
+    ddof: _NoValueType = ...,
     *,
-    dtype: DTypeLike,
+    dtype: DTypeLike | None = None,
 ) -> NDArray[Any]: ...
 
 def blackman(M: _FloatLike_co) -> NDArray[floating[Any]]: ...
@@ -584,7 +587,6 @@ def median(
     a: _ArrayLikeFloat_co | _ArrayLikeComplex_co | _ArrayLikeTD64_co | _ArrayLikeObject_co,
     axis: None | _ShapeLike,
     out: _ArrayType,
-    /,
     overwrite_input: bool = ...,
     keepdims: bool = ...,
 ) -> _ArrayType: ...
@@ -752,7 +754,6 @@ def percentile(
     q: _ArrayLikeFloat_co,
     axis: None | _ShapeLike,
     out: _ArrayType,
-    /,
     overwrite_input: bool = ...,
     method: _MethodKind = ...,
     keepdims: bool = ...,

numpy/ma/extras.pyi

@@ -1,6 +1,8 @@
 from typing import Any
 
+from numpy.lib._function_base_impl import average
 from numpy.lib._index_tricks_impl import AxisConcatenator
+
 from .core import dot, mask_rowcols
 
 __all__ = [
@@ -88,7 +90,6 @@ diagflat: _fromnxfunction_single
 
 def apply_along_axis(func1d, axis, arr, *args, **kwargs): ...
 def apply_over_axes(func, a, axes): ...
-def average(a, axis=..., weights=..., returned=..., keepdims=...): ...
 def median(a, axis=..., out=..., overwrite_input=..., keepdims=...): ...
 def compress_nd(x, axis=...): ...
 def compress_rowcols(x, axis=...): ...