Skip to content

ENH: testing: add verbose and equal_nan options #730

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
lucascolley merged 1 commit into from
May 13, 2026
+18 −2
Merged

ENH: testing: add verbose and equal_nan options #730

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
20 changes: 18 additions & 2 deletions src/array_api_extra/_lib/_testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ def xp_assert_equal(
desired: Array,
*,
err_msg: str = "",
verbose: bool = True,
check_dtype: bool = True,
check_shape: bool = True,
check_scalar: bool = False,
Expand All @@ -154,6 +155,8 @@ def xp_assert_equal(
The expected array (typically hardcoded).
err_msg : str, optional
Error message to display on failure.
verbose: bool, default: True
Whether to include the conflicting arrays in the error message on failure.
check_dtype, check_shape : bool, default: True
Whether to check agreement between actual and desired dtypes and shapes
check_scalar : bool, default: False
Expand All @@ -170,14 +173,17 @@ def xp_assert_equal(
return
actual_np = as_numpy_array(actual, xp=xp)
desired_np = as_numpy_array(desired, xp=xp)
np.testing.assert_array_equal(actual_np, desired_np, err_msg=err_msg)
np.testing.assert_array_equal(
actual_np, desired_np, err_msg=err_msg, verbose=verbose
)


def xp_assert_less(
x: Array,
y: Array,
*,
err_msg: str = "",
verbose: bool = True,
check_dtype: bool = True,
check_shape: bool = True,
check_scalar: bool = False,
Expand All @@ -191,6 +197,8 @@ def xp_assert_less(
The arrays to compare according to ``x < y`` (elementwise).
err_msg : str, optional
Error message to display on failure.
verbose: bool, default: True
Whether to include the conflicting arrays in the error message on failure.
check_dtype, check_shape : bool, default: True
Whether to check agreement between actual and desired dtypes and shapes
check_scalar : bool, default: False
Expand All @@ -207,7 +215,7 @@ def xp_assert_less(
return
x_np = as_numpy_array(x, xp=xp)
y_np = as_numpy_array(y, xp=xp)
np.testing.assert_array_less(x_np, y_np, err_msg=err_msg)
np.testing.assert_array_less(x_np, y_np, err_msg=err_msg, verbose=verbose)


def xp_assert_close(
Expand All @@ -216,7 +224,9 @@ def xp_assert_close(
*,
rtol: float | None = None,
atol: float = 0,
equal_nan: bool = True,
err_msg: str = "",
verbose: bool = True,
check_dtype: bool = True,
check_shape: bool = True,
check_scalar: bool = False,
Expand All @@ -234,8 +244,12 @@ def xp_assert_close(
Relative tolerance. Default: dtype-dependent.
atol : float, optional
Absolute tolerance. Default: 0.
equal_nan : bool, default: True
Whether to consider NaNs in corresponding locations as equal.
err_msg : str, optional
Error message to display on failure.
verbose: bool, default: True
Whether to include the conflicting arrays in the error message on failure.
check_dtype, check_shape : bool, default: True
Whether to check agreement between actual and desired dtypes and shapes
check_scalar : bool, default: False
Expand Down Expand Up @@ -272,7 +286,9 @@ def xp_assert_close(
desired_np,
rtol=rtol, # pyright: ignore[reportArgumentType]
atol=atol,
equal_nan=equal_nan,
err_msg=err_msg,
verbose=verbose,
)


Expand Down