Skip to content

TYP: std and var shape-typing and improved dtypes #31154

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
charris merged 2 commits into from
Apr 5, 2026
Merged

TYP: std and var shape-typing and improved dtypes #31154

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e842a33
TYP: ``std`` and ``var`` shape-typing and improved dtypes
jorenham Apr 4, 2026
54aaa7c
TYP: ``ndarray.std`` and ``ndarray.var`` shape-typing and improved dt…
jorenham Apr 4, 2026
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
Prev Previous commit
TYP: ndarray.std and ndarray.var shape-typing and improved dt… 
…ypes
  • Loading branch information
@jorenham
jorenham committed Apr 4, 2026
commit 54aaa7ccb6dded8ce78e83d7c2432cc192271bd1
370 changes: 370 additions & 0 deletions numpy/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2484,6 +2484,376 @@ class ndarray(_ArrayOrScalarCommon, Generic[_ShapeT_co, _DTypeT_co]):
where: _ArrayLikeBool_co | _NoValueType = ...,
) -> ndarray[_ShapeT_co]: ...

# keep in sync with `ndarray.mean` above
@override # type: ignore[override]
@overload # +integer | ~object_
def std(
self: NDArray[integer | bool_ | object_],
axis: None = None,
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> float64: ...
@overload # +integer, axis: <given>
def std(
self: NDArray[integer | bool_],
axis: int | tuple[int, ...],
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> NDArray[float64]: ...
@overload # +integer, keepdims=True
def std(
self: NDArray[integer | bool_],
axis: int | tuple[int, ...] | None = None,
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray[_ShapeT_co, dtype[float64]]: ...
@overload # ~inexact | timedelta64
def std[ScalarT: inexact | timedelta64](
self: NDArray[ScalarT],
axis: None = None,
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ScalarT: ...
@overload # ~inexact | timedelta64, axis: <given>
def std[ScalarT: inexact | timedelta64 | object_](
self: NDArray[ScalarT],
axis: int | tuple[int, ...],
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> NDArray[ScalarT]: ...
@overload # ~inexact | timedelta64 | object_, keepdims=True
def std[ArrayT: NDArray[inexact | timedelta64 | object_]](
self: ArrayT,
axis: int | tuple[int, ...] | None = None,
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ArrayT: ...
@overload # dtype: ScalarT
def std[ScalarT: generic](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: None = None,
*,
dtype: _DTypeLike[ScalarT],
out: None = None,
ddof: float = 0,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ScalarT: ...
@overload # dtype: ScalarT (keyword), keepdims=True
def std[ScalarT: generic](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...] | None = None,
*,
dtype: _DTypeLike[ScalarT],
out: None = None,
ddof: float = 0,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray[_ShapeT_co, dtype[ScalarT]]: ...
@overload # dtype: ScalarT (positional), keepdims=True
def std[ScalarT: generic](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...] | None,
dtype: _DTypeLike[ScalarT],
out: None = None,
ddof: float = 0,
*,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray[_ShapeT_co, dtype[ScalarT]]: ...
@overload # axis: <given>, dtype: ScalarT
def std[ScalarT: generic](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...],
dtype: _DTypeLike[ScalarT],
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> NDArray[ScalarT]: ...
@overload # out: ArrayT
def std[ArrayT: ndarray](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...] | None = None,
dtype: DTypeLike | None = None,
*,
out: ArrayT,
ddof: float = 0,
keepdims: py_bool | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ArrayT: ...
@overload # fallback
def std(
self: NDArray[number | bool_ | timedelta64 | object_],
axis: None = None,
dtype: DTypeLike | None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> Any: ...
@overload # fallback, axis: <given>
def std(
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...],
dtype: DTypeLike | None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray: ...
@overload # fallback, keepdims=True
def std( # pyright: ignore[reportIncompatibleMethodOverride]
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...] | None = None,
dtype: DTypeLike | None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray[_ShapeT_co]: ...

# keep in sync with `ndarray.std` above
@override # type: ignore[override]
@overload # +integer | ~object_
def var(
self: NDArray[integer | bool_ | object_],
axis: None = None,
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> float64: ...
@overload # +integer, axis: <given>
def var(
self: NDArray[integer | bool_],
axis: int | tuple[int, ...],
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> NDArray[float64]: ...
@overload # +integer, keepdims=True
def var(
self: NDArray[integer | bool_],
axis: int | tuple[int, ...] | None = None,
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray[_ShapeT_co, dtype[float64]]: ...
@overload # ~inexact | timedelta64
def var[ScalarT: inexact | timedelta64](
self: NDArray[ScalarT],
axis: None = None,
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ScalarT: ...
@overload # ~inexact | timedelta64, axis: <given>
def var[ScalarT: inexact | timedelta64 | object_](
self: NDArray[ScalarT],
axis: int | tuple[int, ...],
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> NDArray[ScalarT]: ...
@overload # ~inexact | timedelta64 | object_, keepdims=True
def var[ArrayT: NDArray[inexact | timedelta64 | object_]](
self: ArrayT,
axis: int | tuple[int, ...] | None = None,
dtype: None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ArrayT: ...
@overload # dtype: ScalarT
def var[ScalarT: generic](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: None = None,
*,
dtype: _DTypeLike[ScalarT],
out: None = None,
ddof: float = 0,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ScalarT: ...
@overload # dtype: ScalarT (keyword), keepdims=True
def var[ScalarT: generic](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...] | None = None,
*,
dtype: _DTypeLike[ScalarT],
out: None = None,
ddof: float = 0,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray[_ShapeT_co, dtype[ScalarT]]: ...
@overload # dtype: ScalarT (positional), keepdims=True
def var[ScalarT: generic](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...] | None,
dtype: _DTypeLike[ScalarT],
out: None = None,
ddof: float = 0,
*,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray[_ShapeT_co, dtype[ScalarT]]: ...
@overload # axis: <given>, dtype: ScalarT
def var[ScalarT: generic](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...],
dtype: _DTypeLike[ScalarT],
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> NDArray[ScalarT]: ...
@overload # out: ArrayT
def var[ArrayT: ndarray](
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...] | None = None,
dtype: DTypeLike | None = None,
*,
out: ArrayT,
ddof: float = 0,
keepdims: py_bool | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ArrayT: ...
@overload # fallback
def var(
self: NDArray[number | bool_ | timedelta64 | object_],
axis: None = None,
dtype: DTypeLike | None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> Any: ...
@overload # fallback, axis: <given>
def var(
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...],
dtype: DTypeLike | None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[False] | _NoValueType = ...,
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray: ...
@overload # fallback, keepdims=True
def var( # pyright: ignore[reportIncompatibleMethodOverride]
self: NDArray[number | bool_ | timedelta64 | object_],
axis: int | tuple[int, ...] | None = None,
dtype: DTypeLike | None = None,
out: None = None,
ddof: float = 0,
*,
keepdims: L[True],
where: _ArrayLikeBool_co | _NoValueType = ...,
mean: _ArrayLikeNumber_co | _NoValueType = ...,
correction: float | _NoValueType = ...,
) -> ndarray[_ShapeT_co]: ...

#
@overload
def partition(
Expand Down
Loading
Loading