array-api-extra 0.10.3__py3-none-any.whl → 0.11.0__py3-none-any.whl

array_api_extra/__init__.py

@@ -29,7 +29,7 @@ from ._lib._funcs import (
 )
 from ._lib._lazy import lazy_apply
 
-__version__ = "0.10.3"
+__version__ = "0.11.0"
 
 # pylint: disable=duplicate-code
 __all__ = [

array_api_extra/_delegation.py

@@ -15,7 +15,7 @@ from ._lib._utils._compat import (
     is_torch_namespace,
 )
 from ._lib._utils._compat import device as get_device
-from ._lib._utils._helpers import asarrays, eager_shape
+from ._lib._utils._helpers import asarrays, deprecated, eager_shape
 from ._lib._utils._typing import Array, DType
 
 __all__ = [
@@ -83,19 +83,23 @@ def atleast_nd(x: Array, /, *, ndim: int, xp: ModuleType | None = None) -> Array
     return _funcs.atleast_nd(x, ndim=ndim, xp=xp)
 
 
+@deprecated(
+    "`xpx.broadcast_shapes` is deprecated and will be removed in v1.0.0. "
+    "`xp.broadcast_shapes` exists in the standard as of v2025.12."
+)
 def broadcast_shapes(
     *shapes: tuple[float | None, ...], xp: ModuleType | None = None
 ) -> tuple[int | None, ...]:
     """
     Compute the shape of the broadcasted arrays.
 
+    .. deprecated:: 0.11.0
+        :func:`broadcast_shapes` is deprecated and will be removed in v1.0.0.
+        :func:`array_api.broadcast_shapes` exists in the standard as of v2025.12.
+
     Duplicates :func:`numpy.broadcast_shapes`, with additional support for
     None and NaN sizes.
 
-    This is equivalent to ``xp.broadcast_arrays(arr1, arr2, ...)[0].shape``
-    without needing to worry about the backend potentially deep copying
-    the arrays.
-
     Parameters
     ----------
     *shapes : tuple[int | None, ...]
@@ -300,18 +304,25 @@ def create_diagonal(
     return _funcs.create_diagonal(x, offset=offset, xp=xp)
 
 
+@deprecated(
+    "`xpx.expand_dims` is deprecated and will be removed in v1.0.0. "
+    "`xp.expand_dims` with support for a tuple of ints in `axis` "
+    "exists in the standard as of v2025.12."
+)
 def expand_dims(
     a: Array, /, *, axis: int | tuple[int, ...] = (0,), xp: ModuleType | None = None
 ) -> Array:
     """
     Expand the shape of an array.
 
+    .. deprecated:: 0.11.0
+        :func:`expand_dims` is deprecated and will be removed in v1.0.0.
+        :func:`array_api.expand_dims` with support for a tuple of ints in `axis`
+        exists in the standard as of v2025.12.
+
     Insert (a) new axis/axes that will appear at the position(s) specified by
     `axis` in the expanded array shape.
 
-    This is ``xp.expand_dims`` for `axis` an int *or a tuple of ints*.
-    Roughly equivalent to ``numpy.expand_dims`` for NumPy arrays.
-
     Parameters
     ----------
     a : array
@@ -804,7 +815,7 @@ def searchsorted(
     Find the indices into a sorted array ``x1`` such that if the elements in ``x2``
     were inserted before the indices, the resulting array would remain sorted.
 
-    The behavior of this function is similar to that of `array_api.searchsorted`,
+    The behavior of this function is similar to that of :func:`array_api.searchsorted`,
     but it relaxes the requirement that `x1` must be one-dimensional.
     This function is vectorized, treating slices along the last axis
     as elements and preceding axes as batch (or "loop") dimensions.
@@ -1220,8 +1231,8 @@ def isin(
     """
     Determine whether each element in `a` is present in `b`.
 
-    Return a boolean array of the same shape as `a` that is True for elements
-    that are in `b` and False otherwise.
+    This is :func:`array_api.isin`, with additional `assume_unique`
+    and `kind` parameters.
 
     Parameters
     ----------

array_api_extra/_lib/_utils/_helpers.py

@@ -2,10 +2,12 @@
 
 from __future__ import annotations
 
+import functools
 import io
 import math
 import pickle
 import types
+import warnings
 from collections.abc import Callable, Generator, Iterable, Iterator
 from functools import wraps
 from types import ModuleType
@@ -48,6 +50,7 @@ T = TypeVar("T")
 __all__ = [
     "asarrays",
     "capabilities",
+    "deprecated",
     "eager_shape",
     "in1d",
     "is_python_scalar",
@@ -58,6 +61,26 @@ __all__ = [
 ]
 
 
+def deprecated(
+    msg: str, stacklevel: int = 2
+) -> Callable[[Callable[P, T]], Callable[P, T]]:  # numpydoc ignore=PR01,RT01
+    """Deprecate a function by emitting a warning on use."""
+
+    def decorate(func: Callable[P, T]) -> Callable[P, T]:  # numpydoc ignore=GL08
+        @functools.wraps(func)
+        def wrapper(*args: P.args, **kwargs: P.kwargs) -> T:  # numpydoc ignore=GL08
+            warnings.warn(
+                msg,
+                category=DeprecationWarning,
+                stacklevel=stacklevel,
+            )
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorate
+
+
 def in1d(
     x1: Array,
     x2: Array,

array_api_extra/testing.py

@@ -598,22 +598,23 @@ def _check_ns_shape_dtype(
     np = _require_numpy()
 
     actual_xp = array_namespace(actual)  # Raises on Python scalars and lists
-    desired_xp = array_namespace(desired)
 
     if xp is not None:
         _msg = (
-            "Namespace of desired array does not match the `xp` argument.\n"
-            f"Desired array's namespace: {desired_xp.__name__}\n"
+            "Namespace of actual array does not match the `xp` argument.\n"
+            f"Actual array's namespace: {actual_xp.__name__}\n"
             f"Expected namespace: {xp.__name__}."
         )
-        assert desired_xp == xp, _msg
-
-    _msg = (
-        "Namespaces of actual and desired arrays do not match.\n"
-        f"Actual: {actual_xp.__name__}\n"
-        f"Desired: {desired_xp.__name__}."
-    )
-    assert actual_xp == desired_xp, _msg
+        assert actual_xp == xp, _msg
+        desired_xp = xp
+    else:
+        desired_xp = array_namespace(desired)
+        _msg = (
+            "Namespaces of actual and desired arrays do not match.\n"
+            f"Actual: {actual_xp.__name__}\n"
+            f"Desired: {desired_xp.__name__}."
+        )
+        assert actual_xp == desired_xp, _msg
 
     if is_numpy_namespace(actual_xp) and check_scalar:
         # only NumPy distinguishes between scalars and arrays; we do if check_scalar.
@@ -650,6 +651,7 @@ def _check_ns_shape_dtype(
         msg = f"sizes do not match: {actual_size} != {desired_size}"
         assert actual_size == desired_size, msg
 
+    desired = desired_xp.asarray(desired)
     if check_dtype:
         msg = f"dtypes do not match: {actual.dtype} != {desired.dtype}"
         assert actual.dtype == desired.dtype, msg
@@ -774,6 +776,7 @@ def assert_close(
 
     Array arguments to `atol` and `rtol` must be valid input to :class:`float`.
     """
+    __tracebackhide__ = True
     actual, desired, xp, np = _check_ns_shape_dtype(
         actual, desired, check_dtype, check_shape, check_scalar, xp
     )
@@ -857,6 +860,7 @@ def assert_equal(
     assert_close : Similar function for inexact equality checks.
     numpy.testing.assert_array_equal : Similar function for NumPy arrays.
     """
+    __tracebackhide__ = True
     actual, desired, xp, np = _check_ns_shape_dtype(
         actual, desired, check_dtype, check_shape, check_scalar, xp
     )
@@ -918,6 +922,7 @@ def assert_less(
     assert_close : Similar function for inexact equality checks.
     numpy.testing.assert_array_less : Similar function for NumPy arrays.
     """
+    __tracebackhide__ = True
     x, y, xp, np = _check_ns_shape_dtype(
         x, y, check_dtype, check_shape, check_scalar, xp
     )

array_api_extra/tests/conftest.py

@@ -128,6 +128,9 @@ def xp(
     # Possibly wrap module with array_api_compat
     xp = array_namespace(xp.empty(0))
 
+    if library.like(Backend.ARRAY_API_STRICT):
+        xp.set_array_api_strict_flags(api_version="2025.12")
+
     if library == Backend.ARRAY_API_STRICTEST:
         with xp.ArrayAPIStrictFlags(
             boolean_indexing=False,

array_api_extra/tests/test_deprecation.py

@@ -0,0 +1,15 @@
+from types import ModuleType
+
+import pytest
+
+from array_api_extra import broadcast_shapes, expand_dims
+
+
+class TestDeprecatedFunctions:
+    def test_broadcast_shapes(self, xp: ModuleType):
+        with pytest.raises(DeprecationWarning, match=r"removed in v1.0.0"):
+            _ = broadcast_shapes((2, 3), (2, 1), xp=xp)
+
+    def test_expand_dims(self, xp: ModuleType):
+        with pytest.raises(DeprecationWarning, match=r"removed in v1.0.0"):
+            _ = expand_dims(xp.ones(2), axis=0, xp=xp)

array_api_extra/tests/test_funcs.py

@@ -488,6 +488,7 @@ class TestAtLeastND:
         assert_equal(y, xp.asarray([[[[[[[[[3.0]], [[2.0]]]]]]]]]))
 
 
+@pytest.mark.filterwarnings("ignore:.*removed in v1.0.0.*:DeprecationWarning")
 class TestBroadcastShapes:
     def test_delegates_known_integer_shapes(self, monkeypatch: pytest.MonkeyPatch):
         calls = []
@@ -828,6 +829,7 @@ class TestDefaultDType:
         assert default_dtype(xp, "complex floating") == xp.complex64
 
 
+@pytest.mark.filterwarnings(r"ignore:.*removed in v1.0.0.*:DeprecationWarning")
 class TestExpandDims:
     def test_single_axis(self, xp: ModuleType):
         """Trivial case where xpx.expand_dims doesn't add anything to xp.expand_dims"""

array_api_extra/tests/test_testing.py

@@ -81,10 +81,11 @@ class TestAssertEqualCloseLess:
             func(xp.asarray(0), 0)
         with pytest.raises(TypeError, match="list is not a supported array type"):
             func(xp.asarray([0]), [0])
+        func(xp.asarray(0), xp.asarray(1 if func is assert_less else 0), xp=xp)
         with (
             pytest.raises(
                 AssertionError,
-                match="Namespace of desired array does not match the `xp` argument",
+                match="Namespace of actual array does not match the `xp` argument",
             ),
         ):
             func(xp.asarray(0), xp.asarray(0), xp=np)

{array_api_extra-0.10.3.dist-info → array_api_extra-0.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: array-api-extra
-Version: 0.10.3
+Version: 0.11.0
 Summary: Extra array functions built on top of the array API standard.
 Author-Email: Lucas Colley <lucas.colley8@gmail.com>
 License-Expression: MIT
@@ -130,6 +130,7 @@ This project exists thanks to the following contributors
       <td align="center" valign="top" width="14.28%"><a href="http://steppi.github.io"><img src="https://avatars.githubusercontent.com/u/1953382?v=4?s=100" width="100px;" alt="Albert Steppi"/><br /><sub><b>Albert Steppi</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/commits?author=steppi" title="Code">💻</a> <a href="#ideas-steppi" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/data-apis/array-api-extra/commits?author=steppi" title="Tests">⚠️</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/prady0t"><img src="https://avatars.githubusercontent.com/u/99216956?v=4?s=100" width="100px;" alt="Pradyot Ranjan"/><br /><sub><b>Pradyot Ranjan</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/commits?author=prady0t" title="Code">💻</a> <a href="https://github.com/data-apis/array-api-extra/commits?author=prady0t" title="Documentation">📖</a> <a href="#ideas-prady0t" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/data-apis/array-api-extra/commits?author=prady0t" title="Tests">⚠️</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/lundybernard"><img src="https://avatars.githubusercontent.com/u/17297695?v=4?s=100" width="100px;" alt="Lundy Bernard"/><br /><sub><b>Lundy Bernard</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/pulls?q=is%3Apr+reviewed-by%3Alundybernard" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Cyril-36"><img src="https://avatars.githubusercontent.com/u/138621648?v=4?s=100" width="100px;" alt="Chaitanya Pudota"/><br /><sub><b>Chaitanya Pudota</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/commits?author=Cyril-36" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

{array_api_extra-0.10.3.dist-info → array_api_extra-0.11.0.dist-info}/RECORD

@@ -1,9 +1,10 @@
-array_api_extra-0.10.3.dist-info/METADATA,sha256=g78TkA9OPq7CJGBKyf9NR7e9RUbdDx2UAvmARQnQY94,20220
-array_api_extra-0.10.3.dist-info/WHEEL,sha256=5J4neoE7k6LMgx4Fz1FHgBiO3YevhJGtNQ3muDrdLQM,75
-array_api_extra-0.10.3.dist-info/licenses/LICENSE,sha256=WElDmP4Uf9znamiy3s1MCM46HqI3ttZ4UAHBX4IsbtY,1097
-array_api_extra/__init__.py,sha256=odvk8MxQ5ErbJZikYT4YhZ-5bcsK7WHkC0eshCGE_L0,995
-array_api_extra/_delegation.py,sha256=8kTLW-nuETTuZnfVsbZZEwmoytZ5GvftDUVNzwmR48E,41854
-array_api_extra/testing.py,sha256=eBsY1WO0G8du2FTZi4Q7jKvvTUDOaKJR2r5BNoKlVa4,36385
+array_api_extra-0.11.0.dist-info/METADATA,sha256=T_IXJ_m-X_R-xxBfH9BtBjPRpsYmbX9Pe9R9XJeDthM,20577
+array_api_extra-0.11.0.dist-info/WHEEL,sha256=5J4neoE7k6LMgx4Fz1FHgBiO3YevhJGtNQ3muDrdLQM,75
+array_api_extra-0.11.0.dist-info/licenses/LICENSE,sha256=WElDmP4Uf9znamiy3s1MCM46HqI3ttZ4UAHBX4IsbtY,1097
+array_api_extra/__init__.py,sha256=JkiNKaBRN77esjadhofAQoWDURapapJbukZ6P1uZ98E,995
+array_api_extra/_delegation.py,sha256=qORUZOA3RVlG2ddbzHl_ycidTITPRcAjgkGplPCSZSg,42316
+array_api_extra/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+array_api_extra/testing.py,sha256=WWzhqiCk0ERgpNf9XtForYR22FmxrbbYrORsqVqEpWc,36571
 array_api_extra/_lib/__init__.py,sha256=Mht4YV9Rpkzg5kORPlgjOOXk4y7bvdngowS6KGSHqNE,36
 array_api_extra/_lib/_at.py,sha256=7SSK_xlyQJtyE6YT3MKtGSkiRUdhl1WXHZQoVZUBCWo,15821
 array_api_extra/_lib/_backends.py,sha256=sJJ38eOA_ej-GXWwrZBDjrHiLNJbsyH6RyP9-h7jmLY,2170
@@ -13,18 +14,19 @@ array_api_extra/_lib/_testing.py,sha256=7LFCLWAGD0aGOeCGXYfd8bHbVKe1q9yECy3yTpZW
 array_api_extra/_lib/_utils/__init__.py,sha256=8ICffM2MprXpWZd8ia0-5ZTnKtDfeZD0gExLveDrXZs,49
 array_api_extra/_lib/_utils/_compat.py,sha256=4A5a_S4qo88_H8LKmQal2e_1PVQAY1eInKDZsCgPNYU,1812
 array_api_extra/_lib/_utils/_compat.pyi,sha256=6QexmJx0rPSEtvVQAt2HbS87F8njDMsD9UhyIJsen8c,1720
-array_api_extra/_lib/_utils/_helpers.py,sha256=vC9vy2_4E7SyDCOk5Q4pxrMx4mLrmVTc8xacDhtmGj0,18657
+array_api_extra/_lib/_utils/_helpers.py,sha256=IGit80yi2j2z1LppsgbxgJciF2P_a-zP88bIe5SJRjk,19330
 array_api_extra/_lib/_utils/_typing.py,sha256=0NSYWpdXH58Dx9T7HsNPM0NW2iPlTZS6xOrR-5tFOYc,228
 array_api_extra/_lib/_utils/_typing.pyi,sha256=tfmj1bK5a1RWFc8qXR10FhLlXBwzyItFrN0zcXTWntM,4665
 array_api_extra/tests/__init__.py,sha256=GhZu68trXNtwWKcx-VzlMf34Rzu76O2xZC8OOVO_400,56
-array_api_extra/tests/conftest.py,sha256=f1_9k-s5MRHbOQjazHp41UiMkUsRB0qtxgHVncjQstg,8464
+array_api_extra/tests/conftest.py,sha256=nUnjNvue4cLM0CHUSlbyXUbS0kUixHawqMpmT75gJas,8573
 array_api_extra/tests/test_at.py,sha256=S5LS-sX0Wp-X1UI3RBTNIsf7E1WZIAesVSnghJwXaqU,11333
-array_api_extra/tests/test_funcs.py,sha256=p_CLq0RSBwuoNv1jxOs_L6uDrBHH_nhleC67-i1D9l8,71346
+array_api_extra/tests/test_deprecation.py,sha256=CAnfkERt6iW7Y6WrKzlO_Fe6YAFF2vf5st0MMPtRvQA,501
+array_api_extra/tests/test_funcs.py,sha256=b8dO319ow0dAvNTfp45VnA4raYd36twCYyeIjpCBw2g,71505
 array_api_extra/tests/test_helpers.py,sha256=TE3TpmJbkQKQGSxl857JGVOL8TS4WdGhi0ZiG098-wU,14470
 array_api_extra/tests/test_lazy.py,sha256=OF0OgQ1ZkogVJXUT5CrdBYzNk-KvuTjuUSP10GDUhzM,15633
-array_api_extra/tests/test_testing.py,sha256=rWLc2JTiuq0cAMbBxv-Y3-OrFFUtIQBMkKTEaxfC7T4,23577
+array_api_extra/tests/test_testing.py,sha256=9X7724DKN4a_Dj-01lAh0SfemKlMdlLa6IlaVWmFVvw,23656
 array_api_extra/tests/test_version.py,sha256=Jq62FYkngisYvklCZz6rqCAyaehvtX16h7RQ39GYazo,155
 array_api_extra/vendor_tests/__init__.py,sha256=M5dKkq1u6J2453lWeKDqjK-6jUhd9Qn6SABBZOXwicc,54
 array_api_extra/vendor_tests/_array_api_compat_vendor.py,sha256=Wy5ImPjXOZV2RKKaSyR9wPh0vzi09PEW1CLhBIH0rnE,688
 array_api_extra/vendor_tests/test_vendor.py,sha256=QrzrB_PT56q2UNFdvPv-uoAykMwuWc5MyXjfOU5ooRU,2272
-array_api_extra-0.10.3.dist-info/RECORD,,
+array_api_extra-0.11.0.dist-info/RECORD,,