Skip to content

TYP: isclose shape-typing fix for 2d array-likes #32205

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 1 commit into from
Aug 7, 2026
+20 −16
Merged

TYP: isclose shape-typing fix for 2d array-likes #32205

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
32 changes: 16 additions & 16 deletions numpy/_core/numeric.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1282,58 +1282,58 @@ def allclose(
def isclose(
a: _NumberLike_co,
b: _NumberLike_co,
rtol: ArrayLike = 1e-5,
atol: ArrayLike = 1e-8,
rtol: _ScalarLike_co = 1e-5,
atol: _ScalarLike_co = 1e-8,
equal_nan: py_bool = False,
) -> np.bool: ...
@overload # known shape, same shape or scalar
def isclose[ShapeT: _Shape](
a: np.ndarray[ShapeT],
b: np.ndarray[ShapeT] | _NumberLike_co,
rtol: ArrayLike = 1e-5,
atol: ArrayLike = 1e-8,
rtol: _ScalarLike_co = 1e-5,
atol: _ScalarLike_co = 1e-8,
equal_nan: py_bool = False,
) -> np.ndarray[ShapeT, np.dtype[np.bool]]: ...
@overload # same shape or scalar, known shape
def isclose[ShapeT: _Shape](
a: np.ndarray[ShapeT] | _NumberLike_co,
b: np.ndarray[ShapeT],
rtol: ArrayLike = 1e-5,
atol: ArrayLike = 1e-8,
rtol: _ScalarLike_co = 1e-5,
atol: _ScalarLike_co = 1e-8,
equal_nan: py_bool = False,
) -> np.ndarray[ShapeT, np.dtype[np.bool]]: ...
@overload # 1d sequence, <=1d array-like
def isclose(
a: Sequence[_NumberLike_co],
b: Sequence[_NumberLike_co] | _NumberLike_co | np.ndarray[tuple[int]],
rtol: ArrayLike = 1e-5,
atol: ArrayLike = 1e-8,
rtol: _ScalarLike_co = 1e-5,
atol: _ScalarLike_co = 1e-8,
equal_nan: py_bool = False,
) -> np.ndarray[tuple[int], np.dtype[np.bool]]: ...
@overload # <=1d array-like, 1d sequence
def isclose(
a: Sequence[_NumberLike_co] | _NumberLike_co | np.ndarray[tuple[int]],
b: Sequence[_NumberLike_co],
rtol: ArrayLike = 1e-5,
atol: ArrayLike = 1e-8,
rtol: _ScalarLike_co = 1e-5,
atol: _ScalarLike_co = 1e-8,
equal_nan: py_bool = False,
) -> np.ndarray[tuple[int], np.dtype[np.bool]]: ...
@overload # 2d sequence, <=2d array-like
def isclose(
a: Sequence[Sequence[_NumberLike_co]],
b: Sequence[Sequence[_NumberLike_co]] | Sequence[_NumberLike_co] | _NumberLike_co | np.ndarray[tuple[int] | tuple[int, int]],
rtol: ArrayLike = 1e-5,
atol: ArrayLike = 1e-8,
rtol: _ScalarLike_co = 1e-5,
atol: _ScalarLike_co = 1e-8,
equal_nan: py_bool = False,
) -> np.ndarray[tuple[int], np.dtype[np.bool]]: ...
) -> np.ndarray[tuple[int, int], np.dtype[np.bool]]: ...
@overload # <=2d array-like, 2d sequence
def isclose(
b: Sequence[Sequence[_NumberLike_co]] | Sequence[_NumberLike_co] | _NumberLike_co | np.ndarray[tuple[int] | tuple[int, int]],
a: Sequence[Sequence[_NumberLike_co]],
rtol: ArrayLike = 1e-5,
atol: ArrayLike = 1e-8,
rtol: _ScalarLike_co = 1e-5,
atol: _ScalarLike_co = 1e-8,
equal_nan: py_bool = False,
) -> np.ndarray[tuple[int], np.dtype[np.bool]]: ...
) -> np.ndarray[tuple[int, int], np.dtype[np.bool]]: ...
@overload # unknown shape, unknown shape
def isclose(
a: ArrayLike,
Expand Down
4 changes: 4 additions & 0 deletions numpy/typing/tests/data/reveal/numeric.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ _sub_nd_i8: SubClass
_to_1d_bool: list[bool]
_to_1d_int: list[int]
_to_1d_float: list[float]
_to_2d_float: list[list[float]]
_to_1d_complex: list[complex]

###
Expand Down Expand Up @@ -161,6 +162,9 @@ assert_type(np.allclose(AR_i8, AR_i8), bool)
assert_type(np.isclose(i8, i8), np.bool)
assert_type(np.isclose(i8, AR_i8), npt.NDArray[np.bool])
assert_type(np.isclose(_to_1d_int, _to_1d_int), np.ndarray[tuple[int], np.dtype[np.bool]])
assert_type(np.isclose(_to_1d_int, _to_2d_float), np.ndarray[tuple[int, int], np.dtype[np.bool]])
assert_type(np.isclose(_to_2d_float, _to_1d_int), np.ndarray[tuple[int, int], np.dtype[np.bool]])
assert_type(np.isclose(_to_2d_float, _to_2d_float), np.ndarray[tuple[int, int], np.dtype[np.bool]])
assert_type(np.isclose(AR_i8, AR_i8), npt.NDArray[np.bool])

assert_type(np.array_equal(i8, AR_i8), bool)
Expand Down