WIP: xp_assert enhancements

Author: mdhaber

src/array_api_extra/_lib/_testing.py

@@ -9,13 +9,15 @@
 from types import ModuleType
 from typing import cast
 
+import numpy as np
 import pytest
 
 from ._utils._compat import (
     array_namespace,
     is_array_api_strict_namespace,
     is_cupy_namespace,
     is_dask_namespace,
+    is_numpy_namespace,
     is_pydata_sparse_namespace,
     is_torch_namespace,
 )
@@ -25,7 +27,11 @@
 
 
 def _check_ns_shape_dtype(
-    actual: Array, desired: Array
+    actual: Array,
+    desired: Array,
+    check_dtype: bool,
+    check_shape: bool,
+    check_scalar: bool,
 ) -> ModuleType:  # numpydoc ignore=RT03
     """
     Assert that namespace, shape and dtype of the two arrays match.
@@ -47,43 +53,64 @@ def _check_ns_shape_dtype(
     msg = f"namespaces do not match: {actual_xp} != f{desired_xp}"
     assert actual_xp == desired_xp, msg
 
-    actual_shape = actual.shape
-    desired_shape = desired.shape
-    if is_dask_namespace(desired_xp):
-        # Dask uses nan instead of None for unknown shapes
-        if any(math.isnan(i) for i in cast(tuple[float, ...], actual_shape)):
-            actual_shape = actual.compute().shape  # type: ignore[attr-defined]  # pyright: ignore[reportAttributeAccessIssue]
-        if any(math.isnan(i) for i in cast(tuple[float, ...], desired_shape)):
-            desired_shape = desired.compute().shape  # type: ignore[attr-defined]  # pyright: ignore[reportAttributeAccessIssue]
-
-    msg = f"shapes do not match: {actual_shape} != f{desired_shape}"
-    assert actual_shape == desired_shape, msg
-
-    msg = f"dtypes do not match: {actual.dtype} != {desired.dtype}"
-    assert actual.dtype == desired.dtype, msg
+    if check_shape:
+        actual_shape = actual.shape
+        desired_shape = desired.shape
+        if is_dask_namespace(desired_xp):
+            # Dask uses nan instead of None for unknown shapes
+            if any(math.isnan(i) for i in cast(tuple[float, ...], actual_shape)):
+                actual_shape = actual.compute().shape  # type: ignore[attr-defined]  # pyright: ignore[reportAttributeAccessIssue]
+            if any(math.isnan(i) for i in cast(tuple[float, ...], desired_shape)):
+                desired_shape = desired.compute().shape  # type: ignore[attr-defined]  # pyright: ignore[reportAttributeAccessIssue]
+
+        msg = f"shapes do not match: {actual_shape} != f{desired_shape}"
+        assert actual_shape == desired_shape, msg
+
+    if check_dtype:
+        msg = f"dtypes do not match: {actual.dtype} != {desired.dtype}"
+        assert actual.dtype == desired.dtype, msg
+
+    if is_numpy_namespace(actual_xp) and check_scalar:
+        # only NumPy distinguishes between scalars and arrays; we do if check_scalar.
+        _msg = (
+            "array-ness does not match:\n Actual: "
+            f"{type(actual)}\n Desired: {type(desired)}"
+        )
+        assert (np.isscalar(actual) and np.isscalar(desired)) or (
+            not np.isscalar(actual) and not np.isscalar(desired)
+        ), _msg
 
     return desired_xp
 
 
 def _prepare_for_test(array: Array, xp: ModuleType) -> Array:
     """
-    Ensure that the array can be compared with xp.testing or np.testing.
+    Ensure that the array can be compared with np.testing.
 
     This involves transferring it from GPU to CPU memory, densifying it, etc.
     """
     if is_torch_namespace(xp):
-        return array.cpu()  # type: ignore[attr-defined]  # pyright: ignore[reportAttributeAccessIssue]
+        return np.asarray(array.cpu())  # type: ignore[attr-defined, return-value]  # pyright: ignore[reportAttributeAccessIssue, reportUnknownArgumentType, reportReturnType]
     if is_pydata_sparse_namespace(xp):
         return array.todense()  # type: ignore[attr-defined]  # pyright: ignore[reportAttributeAccessIssue]
     if is_array_api_strict_namespace(xp):
         # Note: we deliberately did not add a `.to_device` method in _typing.pyi
         # even if it is required by the standard as many backends don't support it
         return array.to_device(xp.Device("CPU_DEVICE"))  # type: ignore[attr-defined]  # pyright: ignore[reportAttributeAccessIssue]
-    # Note: nothing to do for CuPy, because it uses a bespoke test function
+    if is_cupy_namespace(xp):
+        return xp.asnumpy(array)
     return array
 
 
-def xp_assert_equal(actual: Array, desired: Array, err_msg: str = "") -> None:
+def xp_assert_equal(
+    actual: Array,
+    desired: Array,
+    *,
+    err_msg: str = "",
+    check_dtype: bool = True,
+    check_shape: bool = True,
+    check_scalar: bool = False,
+) -> None:
     """
     Array-API compatible version of `np.testing.assert_array_equal`.
 
@@ -95,34 +122,21 @@ def xp_assert_equal(actual: Array, desired: Array, err_msg: str = "") -> None:
         The expected array (typically hardcoded).
     err_msg : str, optional
         Error message to display 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
+        NumPy only: whether to check agreement between actual and desired types -
+        0d array vs scalar.
 
     See Also
     --------
     xp_assert_close : Similar function for inexact equality checks.
     numpy.testing.assert_array_equal : Similar function for NumPy arrays.
     """
-    xp = _check_ns_shape_dtype(actual, desired)
+    xp = _check_ns_shape_dtype(actual, desired, check_dtype, check_shape, check_scalar)
     actual = _prepare_for_test(actual, xp)
     desired = _prepare_for_test(desired, xp)
-
-    if is_cupy_namespace(xp):
-        xp.testing.assert_array_equal(actual, desired, err_msg=err_msg)
-    elif is_torch_namespace(xp):
-        # PyTorch recommends using `rtol=0, atol=0` like this
-        # to test for exact equality
-        xp.testing.assert_close(
-            actual,
-            desired,
-            rtol=0,
-            atol=0,
-            equal_nan=True,
-            check_dtype=False,
-            msg=err_msg or None,
-        )
-    else:
-        import numpy as np  # pylint: disable=import-outside-toplevel
-
-        np.testing.assert_array_equal(actual, desired, err_msg=err_msg)
+    np.testing.assert_array_equal(actual, desired, err_msg=err_msg)
 
 
 def xp_assert_close(
@@ -132,6 +146,9 @@ def xp_assert_close(
     rtol: float | None = None,
     atol: float = 0,
     err_msg: str = "",
+    check_dtype: bool = True,
+    check_shape: bool = True,
+    check_scalar: bool = False,
 ) -> None:
     """
     Array-API compatible version of `np.testing.assert_allclose`.
@@ -148,6 +165,11 @@ def xp_assert_close(
         Absolute tolerance. Default: 0.
     err_msg : str, optional
         Error message to display 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
+        NumPy only: whether to check agreement between actual and desired types -
+        0d array vs scalar.
 
     See Also
     --------
@@ -159,7 +181,7 @@ def xp_assert_close(
     -----
     The default `atol` and `rtol` differ from `xp.all(xpx.isclose(a, b))`.
     """
-    xp = _check_ns_shape_dtype(actual, desired)
+    xp = _check_ns_shape_dtype(actual, desired, check_dtype, check_shape, check_scalar)
 
     floating = xp.isdtype(actual.dtype, ("real floating", "complex floating"))
     if rtol is None and floating:
@@ -173,26 +195,15 @@ def xp_assert_close(
     actual = _prepare_for_test(actual, xp)
     desired = _prepare_for_test(desired, xp)
 
-    if is_cupy_namespace(xp):
-        xp.testing.assert_allclose(
-            actual, desired, rtol=rtol, atol=atol, err_msg=err_msg
-        )
-    elif is_torch_namespace(xp):
-        xp.testing.assert_close(
-            actual, desired, rtol=rtol, atol=atol, equal_nan=True, msg=err_msg or None
-        )
-    else:
-        import numpy as np  # pylint: disable=import-outside-toplevel
-
-        # JAX/Dask arrays work directly with `np.testing`
-        assert isinstance(rtol, float)
-        np.testing.assert_allclose(  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue]
-            actual,  # pyright: ignore[reportArgumentType]
-            desired,  # pyright: ignore[reportArgumentType]
-            rtol=rtol,
-            atol=atol,
-            err_msg=err_msg,
-        )
+    # JAX/Dask arrays work directly with `np.testing`
+    assert isinstance(rtol, float)
+    np.testing.assert_allclose(  # type: ignore[call-overload]  # pyright: ignore[reportCallIssue]
+        actual,  # pyright: ignore[reportArgumentType]
+        desired,  # pyright: ignore[reportArgumentType]
+        rtol=rtol,
+        atol=atol,
+        err_msg=err_msg,
+    )
 
 
 def xfail(request: pytest.FixtureRequest, reason: str) -> None:

tests/test_testing.py

@@ -1,4 +1,5 @@
 from collections.abc import Callable
+from contextlib import nullcontext
 from types import ModuleType
 from typing import cast
 
@@ -24,7 +25,9 @@
         xp_assert_equal,
         pytest.param(
             xp_assert_close,
-            marks=pytest.mark.xfail_xp_backend(Backend.SPARSE, reason="no isdtype"),
+            marks=pytest.mark.xfail_xp_backend(
+                Backend.SPARSE, reason="no isdtype", strict=False
+            ),
         ),
     ],
 )
@@ -60,6 +63,53 @@ def test_assert_close_equal_namespace(xp: ModuleType, func: Callable[..., None])
         func(xp.asarray([0]), [0])
 
 
+@param_assert_equal_close
+@pytest.mark.parametrize("check_shape", [False, True])
+def test_assert_close_equal_shape(  # type: ignore[explicit-any]
+    xp: ModuleType,
+    func: Callable[..., None],
+    check_shape: bool,
+):
+    context = (
+        pytest.raises(AssertionError, match="shapes do not match")
+        if check_shape
+        else nullcontext()
+    )
+    with context:
+        func(xp.asarray([0, 0]), xp.asarray(0), check_shape=check_shape)
+
+
+@param_assert_equal_close
+@pytest.mark.parametrize("check_dtype", [False, True])
+def test_assert_close_equal_dtype(  # type: ignore[explicit-any]
+    xp: ModuleType,
+    func: Callable[..., None],
+    check_dtype: bool,
+):
+    context = (
+        pytest.raises(AssertionError, match="dtypes do not match")
+        if check_dtype
+        else nullcontext()
+    )
+    with context:
+        func(xp.asarray(0.0), xp.asarray(0), check_dtype=check_dtype)
+
+
+@pytest.mark.parametrize("func", [xp_assert_equal, xp_assert_close])
+@pytest.mark.parametrize("check_scalar", [False, True])
+def test_assert_close_equal_scalar(  # type: ignore[explicit-any]
+    func: Callable[..., None],
+    check_scalar: bool,
+):
+    context = (
+        pytest.raises(AssertionError, match="array-ness does not match")
+        if check_scalar
+        else nullcontext()
+    )
+    with context:
+        func(np.asarray(0), np.asarray(0)[()], check_scalar=check_scalar)
+
+
 @pytest.mark.xfail_xp_backend(Backend.SPARSE, reason="no isdtype")
 def test_assert_close_tolerance(xp: ModuleType):
     xp_assert_close(xp.asarray([100.0]), xp.asarray([102.0]), rtol=0.03)