Skip to content

🐛 fix incorrect function parameter defaults #725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jorenham merged 1 commit into from
Oct 8, 2025
Merged

🐛 fix incorrect function parameter defaults #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions src/numpy-stubs/_core/einsumfunc.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ __all__ = ["einsum", "einsum_path"]

_ArrayT = TypeVar("_ArrayT", bound=_nt.Array[_nt.co_complex])

# TODO (@jorenham): Annotate the `Sequence` value (numpy/numtype#724)
_OptimizeKind: TypeAlias = bool | Literal["greedy", "optimal"] | Sequence[Incomplete]
_CastingSafe: TypeAlias = Literal["no", "equiv", "safe", "same_kind"]
_CastingUnsafe: TypeAlias = Literal["unsafe"]
Expand All @@ -41,7 +42,7 @@ def einsum(
/,
*operands: _ArrayLikeBool_co,
out: None = None,
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
dtype: _DTypeLikeBool | None = None,
order: _OrderKACF = "K",
casting: _CastingSafe = "safe",
Expand All @@ -55,7 +56,7 @@ def einsum(
dtype: _DTypeLikeUInt | None = None,
order: _OrderKACF = "K",
casting: _CastingSafe = "safe",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> Incomplete: ...
@overload
def einsum(
Expand All @@ -66,7 +67,7 @@ def einsum(
dtype: _DTypeLikeInt | None = None,
order: _OrderKACF = "K",
casting: _CastingSafe = "safe",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> Incomplete: ...
@overload
def einsum(
Expand All @@ -77,7 +78,7 @@ def einsum(
dtype: _DTypeLikeFloat | None = None,
order: _OrderKACF = "K",
casting: _CastingSafe = "safe",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> Incomplete: ...
@overload
def einsum(
Expand All @@ -88,7 +89,7 @@ def einsum(
dtype: _DTypeLikeComplex | None = None,
order: _OrderKACF = "K",
casting: _CastingSafe = "safe",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> Incomplete: ...
@overload
def einsum(
Expand All @@ -99,7 +100,7 @@ def einsum(
dtype: _DTypeLikeComplex_co | None = None,
out: None = None,
order: _OrderKACF = "K",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> Incomplete: ...
@overload
def einsum(
Expand All @@ -110,7 +111,7 @@ def einsum(
dtype: _DTypeLikeComplex_co | None = None,
order: _OrderKACF = "K",
casting: _CastingSafe = "safe",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> _ArrayT: ...
@overload
def einsum(
Expand All @@ -121,7 +122,7 @@ def einsum(
casting: _CastingUnsafe,
dtype: _DTypeLikeComplex_co | None = None,
order: _OrderKACF = "K",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> _ArrayT: ...
@overload
def einsum(
Expand All @@ -132,7 +133,7 @@ def einsum(
dtype: _DTypeLikeObject | None = None,
order: _OrderKACF = "K",
casting: _CastingSafe = "safe",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> Incomplete: ...
@overload
def einsum(
Expand All @@ -143,7 +144,7 @@ def einsum(
dtype: _DTypeLikeObject | None = None,
out: None = None,
order: _OrderKACF = "K",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> Incomplete: ...
@overload
def einsum(
Expand All @@ -154,7 +155,7 @@ def einsum(
dtype: _DTypeLikeObject | None = None,
order: _OrderKACF = "K",
casting: _CastingSafe = "safe",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> _ArrayT: ...
@overload
def einsum(
Expand All @@ -165,13 +166,12 @@ def einsum(
casting: _CastingUnsafe,
dtype: _DTypeLikeObject | None = None,
order: _OrderKACF = "K",
optimize: _OptimizeKind | None = None,
optimize: _OptimizeKind = False,
) -> _ArrayT: ...

# TODO (@jorenham): Annotate the `Sequence` value (numpy/numtype#724)
# NOTE: `einsum_call` is a hidden kwarg unavailable for public use.
# It is therefore excluded from the signatures below.
# NOTE: In practice the list consists of a `str` (first element)
# and a variable number of integer tuples.
def einsum_path(
subscripts: str | _ArrayLikeInt_co,
/,
Expand Down
6 changes: 3 additions & 3 deletions src/numpy-stubs/_core/fromnumeric.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,15 +230,15 @@ def matrix_transpose(x: ArrayLike, /) -> _nt.Array[Incomplete]: ...
def partition(
a: _nt._ToArray_nd[_ScalarT],
kth: _nt.ToInteger_nd,
axis: CanIndex | None = None,
axis: CanIndex | None = -1,
kind: _PartitionKind = "introselect",
order: _Order | None = None,
) -> _nt.Array[_ScalarT]: ...
@overload
def partition(
a: ArrayLike,
kth: _nt.ToInteger_nd,
axis: CanIndex | None = None,
axis: CanIndex | None = -1,
kind: _PartitionKind = "introselect",
order: _Order | None = None,
) -> _nt.Array[Incomplete]: ...
Expand Down Expand Up @@ -266,7 +266,7 @@ def sort(
def sort(
a: _nt.CanArray0D[_ScalarT],
axis: None,
kind: CanIndex | None = -1,
kind: CanIndex | None = None,
order: _Order | None = None,
*,
stable: bool | None = None,
Expand Down
26 changes: 13 additions & 13 deletions src/numpy-stubs/_core/numeric.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2075,34 +2075,34 @@ def correlate(

#
@overload
def convolve(a: _nt.ToBool_1d, v: _nt.ToBool_1d, mode: _Mode = "valid") -> _nt.Array1D[np.bool]: ...
def convolve(a: _nt.ToBool_1d, v: _nt.ToBool_1d, mode: _Mode = "full") -> _nt.Array1D[np.bool]: ...
@overload
def convolve(a: _nt.ToUInteger_1d, v: _nt.CoUInt64_1d, mode: _Mode = "valid") -> _nt.Array1D[np.unsignedinteger]: ...
def convolve(a: _nt.ToUInteger_1d, v: _nt.CoUInt64_1d, mode: _Mode = "full") -> _nt.Array1D[np.unsignedinteger]: ...
@overload
def convolve(a: _nt.CoUInt64_1d, v: _nt.ToUInteger_1d, mode: _Mode = "valid") -> _nt.Array1D[np.unsignedinteger]: ...
def convolve(a: _nt.CoUInt64_1d, v: _nt.ToUInteger_1d, mode: _Mode = "full") -> _nt.Array1D[np.unsignedinteger]: ...
@overload
def convolve(a: _nt.ToSInteger_1d, v: _nt.CoInt64_1d, mode: _Mode = "valid") -> _nt.Array1D[np.signedinteger]: ...
def convolve(a: _nt.ToSInteger_1d, v: _nt.CoInt64_1d, mode: _Mode = "full") -> _nt.Array1D[np.signedinteger]: ...
@overload
def convolve(a: _nt.CoInt64_1d, v: _nt.ToSInteger_1d, mode: _Mode = "valid") -> _nt.Array1D[np.signedinteger]: ...
def convolve(a: _nt.CoInt64_1d, v: _nt.ToSInteger_1d, mode: _Mode = "full") -> _nt.Array1D[np.signedinteger]: ...
@overload
def convolve(a: _nt.ToFloating_1d, v: _nt.CoFloating_1d, mode: _Mode = "valid") -> _nt.Array1D[np.floating]: ...
def convolve(a: _nt.ToFloating_1d, v: _nt.CoFloating_1d, mode: _Mode = "full") -> _nt.Array1D[np.floating]: ...
@overload
def convolve(a: _nt.CoFloating_1d, v: _nt.ToFloating_1d, mode: _Mode = "valid") -> _nt.Array1D[np.floating]: ...
def convolve(a: _nt.CoFloating_1d, v: _nt.ToFloating_1d, mode: _Mode = "full") -> _nt.Array1D[np.floating]: ...
@overload
def convolve(a: _nt.ToComplex_1d, v: _nt.CoComplex_1d, mode: _Mode = "valid") -> _nt.Array1D[np.complexfloating]: ...
def convolve(a: _nt.ToComplex_1d, v: _nt.CoComplex_1d, mode: _Mode = "full") -> _nt.Array1D[np.complexfloating]: ...
@overload
def convolve(a: _nt.CoComplex_1d, v: _nt.ToComplex_1d, mode: _Mode = "valid") -> _nt.Array1D[np.complexfloating]: ...
def convolve(a: _nt.CoComplex_1d, v: _nt.ToComplex_1d, mode: _Mode = "full") -> _nt.Array1D[np.complexfloating]: ...
@overload
def convolve(a: _nt.ToTimeDelta_1d, v: _nt.CoTimeDelta_1d, mode: _Mode = "valid") -> _nt.Array1D[np.timedelta64]: ...
def convolve(a: _nt.ToTimeDelta_1d, v: _nt.CoTimeDelta_1d, mode: _Mode = "full") -> _nt.Array1D[np.timedelta64]: ...
@overload
def convolve(a: _nt.CoTimeDelta_1d, v: _nt.ToTimeDelta_1d, mode: _Mode = "valid") -> _nt.Array1D[np.timedelta64]: ...
def convolve(a: _nt.CoTimeDelta_1d, v: _nt.ToTimeDelta_1d, mode: _Mode = "full") -> _nt.Array1D[np.timedelta64]: ...
@overload
def convolve(a: _nt.ToObject_1d, v: _nt.ToObject_1d, mode: _Mode = "valid") -> _nt.Array1D[np.object_]: ...
def convolve(a: _nt.ToObject_1d, v: _nt.ToObject_1d, mode: _Mode = "full") -> _nt.Array1D[np.object_]: ...
@overload
def convolve(
a: _nt.CoComplex_1d | _nt.CoTimeDelta_1d | _nt.ToObject_1d,
v: _nt.CoComplex_1d | _nt.CoTimeDelta_1d | _nt.ToObject_1d,
mode: _Mode = "valid",
mode: _Mode = "full",
) -> _nt.Array1D[Any]: ...

#
Expand Down