array-api-strict 2.1__tar.gz → 2.1.1__tar.gz

{array_api_strict-2.1 → array_api_strict-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: array_api_strict
-Version: 2.1
+Version: 2.1.1
 Summary: A strict, minimal implementation of the Python array API standard.
 Home-page: https://data-apis.org/array-api-strict/
 Author: Consortium for Python Data API Standards

{array_api_strict-2.1 → array_api_strict-2.1.1}/array_api_strict/_array_object.py

@@ -66,6 +66,8 @@ ALL_DEVICES = (CPU_DEVICE, Device("device1"), Device("device2"))
 
 _default = object()
 
+_allow_array = False
+
 class Array:
     """
     n-d array object for the array API namespace.
@@ -145,30 +147,35 @@ class Array:
             mid = np.array2string(self._array, separator=', ', prefix=prefix, suffix=suffix)
         return prefix + mid + suffix
 
-    # This function is not required by the spec, but we implement it here for
-    # convenience so that np.asarray(array_api_strict.Array) will work.
+    # Disallow __array__, meaning calling `np.func()` on an array_api_strict
+    # array will give an error. If we don't explicitly disallow it, NumPy
+    # defaults to creating an object dtype array, which would lead to
+    # confusing error messages at best and surprising bugs at worst.
+    #
+    # The alternative of course is to just support __array__, which is what we
+    # used to do. But this isn't actually supported by the standard, so it can
+    # lead to code assuming np.asarray(other_array) would always work in the
+    # standard.
     def __array__(self, dtype: None | np.dtype[Any] = None, copy: None | bool = None) -> npt.NDArray[Any]:
-        """
-        Warning: this method is NOT part of the array API spec. Implementers
-        of other libraries need not include it, and users should not assume it
-        will be present in other implementations.
-
-        """
-        if self._device != CPU_DEVICE:
-            raise RuntimeError(f"Can not convert array on the '{self._device}' device to a Numpy array.")
-        # copy keyword is new in 2.0.0; for older versions don't use it
-        # retry without that keyword.
-        if np.__version__[0] < '2':
-            return np.asarray(self._array, dtype=dtype)
-        elif np.__version__.startswith('2.0.0-dev0'):
-            # Handle dev version for which we can't know based on version
-            # number whether or not the copy keyword is supported.
-            try:
-                return np.asarray(self._array, dtype=dtype, copy=copy)
-            except TypeError:
+        # We have to allow this to be internally enabled as there's no other
+        # easy way to parse a list of Array objects in asarray().
+        if _allow_array:
+            if self._device != CPU_DEVICE:
+                raise RuntimeError(f"Can not convert array on the '{self._device}' device to a Numpy array.")
+            # copy keyword is new in 2.0.0; for older versions don't use it
+            # retry without that keyword.
+            if np.__version__[0] < '2':
                 return np.asarray(self._array, dtype=dtype)
-        else:
-            return np.asarray(self._array, dtype=dtype, copy=copy)
+            elif np.__version__.startswith('2.0.0-dev0'):
+                # Handle dev version for which we can't know based on version
+                # number whether or not the copy keyword is supported.
+                try:
+                    return np.asarray(self._array, dtype=dtype, copy=copy)
+                except TypeError:
+                    return np.asarray(self._array, dtype=dtype)
+            else:
+                return np.asarray(self._array, dtype=dtype, copy=copy)
+        raise ValueError("Conversion from an array_api_strict array to a NumPy ndarray is not supported")
 
     # These are various helper functions to make the array behavior match the
     # spec in places where it either deviates from or is more strict than
@@ -274,7 +281,7 @@ class Array:
         # behavior for integers within the bounds of the integer dtype.
         # Outside of those bounds we use the default NumPy behavior (either
         # cast or raise OverflowError).
-        return Array._new(np.array(scalar, dtype=self.dtype._np_dtype), device=CPU_DEVICE)
+        return Array._new(np.array(scalar, dtype=self.dtype._np_dtype), device=self.device)
 
     @staticmethod
     def _normalize_two_args(x1, x2) -> Tuple[Array, Array]:

{array_api_strict-2.1 → array_api_strict-2.1.1}/array_api_strict/_creation_functions.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-
+from contextlib import contextmanager
 from typing import TYPE_CHECKING, List, Optional, Tuple, Union
 
 if TYPE_CHECKING:
@@ -16,6 +16,19 @@ from ._flags import get_array_api_strict_flags
 
 import numpy as np
 
+@contextmanager
+def allow_array():
+    """
+    Temporarily enable Array.__array__. This is needed for np.array to parse
+    list of lists of Array objects.
+    """
+    from . import _array_object
+    original_value = _array_object._allow_array
+    try:
+        _array_object._allow_array = True
+        yield
+    finally:
+        _array_object._allow_array = original_value
 
 def _check_valid_dtype(dtype):
     # Note: Only spelling dtypes as the dtype objects is supported.
@@ -67,6 +80,8 @@ def asarray(
     if dtype is not None:
         _np_dtype = dtype._np_dtype
     _check_device(device)
+    if isinstance(obj, Array) and device is None:
+        device = obj.device
 
     if np.__version__[0] < '2':
         if copy is False:
@@ -97,7 +112,8 @@ def asarray(
         # Give a better error message in this case. NumPy would convert this
         # to an object array. TODO: This won't handle large integers in lists.
         raise OverflowError("Integer out of bounds for array dtypes")
-    res = np.array(obj, dtype=_np_dtype, copy=copy)
+    with allow_array():
+        res = np.array(obj, dtype=_np_dtype, copy=copy)
     return Array._new(res, device=device)
 
 
@@ -158,6 +174,8 @@ def empty_like(
 
     _check_valid_dtype(dtype)
     _check_device(device)
+    if device is None:
+        device = x.device
 
     if dtype is not None:
         dtype = dtype._np_dtype
@@ -260,6 +278,8 @@ def full_like(
 
     _check_valid_dtype(dtype)
     _check_device(device)
+    if device is None:
+        device = x.device
 
     if dtype is not None:
         dtype = dtype._np_dtype

{array_api_strict-2.1 → array_api_strict-2.1.1}/array_api_strict/_elementwise_functions.py

@@ -14,6 +14,7 @@ from ._dtypes import (
 from ._array_object import Array
 from ._flags import requires_api_version
 from ._creation_functions import asarray
+from ._data_type_functions import broadcast_to, iinfo
 
 from typing import Optional, Union
 
@@ -325,14 +326,51 @@ def clip(
     if min is not None and max is not None and np.any(min > max):
         raise ValueError("min must be less than or equal to max")
 
-    result = np.clip(x._array, min, max)
-    # Note: NumPy applies type promotion, but the standard specifies the
-    # return dtype should be the same as x
-    if result.dtype != x.dtype._np_dtype:
-        # TODO: I'm not completely sure this always gives the correct thing
-        # for integer dtypes. See https://github.com/numpy/numpy/issues/24976
-        result = result.astype(x.dtype._np_dtype)
-    return Array._new(result, device=x.device)
+    # np.clip does type promotion but the array API clip requires that the
+    # output have the same dtype as x. We do this instead of just downcasting
+    # the result of xp.clip() to handle some corner cases better (e.g.,
+    # avoiding uint64 -> float64 promotion).
+
+    # Note: cases where min or max overflow (integer) or round (float) in the
+    # wrong direction when downcasting to x.dtype are unspecified. This code
+    # just does whatever NumPy does when it downcasts in the assignment, but
+    # other behavior could be preferred, especially for integers. For example,
+    # this code produces:
+
+    # >>> clip(asarray(0, dtype=int8), asarray(128, dtype=int16), None)
+    # -128
+
+    # but an answer of 0 might be preferred. See
+    # https://github.com/numpy/numpy/issues/24976 for more discussion on this issue.
+
+    # At least handle the case of Python integers correctly (see
+    # https://github.com/numpy/numpy/pull/26892).
+    if type(min) is int and min <= iinfo(x.dtype).min:
+        min = None
+    if type(max) is int and max >= iinfo(x.dtype).max:
+        max = None
+
+    def _isscalar(a):
+        return isinstance(a, (int, float, type(None)))
+    min_shape = () if _isscalar(min) else min.shape
+    max_shape = () if _isscalar(max) else max.shape
+
+    result_shape = np.broadcast_shapes(x.shape, min_shape, max_shape)
+
+    out = asarray(broadcast_to(x, result_shape), copy=True)._array
+    device = x.device
+    x = x._array
+
+    if min is not None:
+        a = np.broadcast_to(np.asarray(min), result_shape)
+        ia = (out < a) | np.isnan(a)
+
+        out[ia] = a[ia]
+    if max is not None:
+        b = np.broadcast_to(np.asarray(max), result_shape)
+        ib = (out > b) | np.isnan(b)
+        out[ib] = b[ib]
+    return Array._new(out, device=device)
 
 def conj(x: Array, /) -> Array:
     """
@@ -855,6 +893,8 @@ def sign(x: Array, /) -> Array:
     """
     if x.dtype not in _numeric_dtypes:
         raise TypeError("Only numeric dtypes are allowed in sign")
+    if x.dtype in _complex_floating_dtypes:
+        return x/abs(x)
     return Array._new(np.sign(x._array), device=x.device)
 
 

{array_api_strict-2.1 → array_api_strict-2.1.1}/array_api_strict/_linalg.py

@@ -267,6 +267,8 @@ def pinv(x: Array, /, *, rtol: Optional[Union[float, Array]] = None) -> Array:
     # default tolerance by max(M, N).
     if rtol is None:
         rtol = max(x.shape[-2:]) * finfo(x.dtype).eps
+    if isinstance(rtol, Array):
+        rtol = rtol._array
     return Array._new(np.linalg.pinv(x._array, rcond=rtol), device=x.device)
 
 @requires_extension('linalg')

{array_api_strict-2.1 → array_api_strict-2.1.1}/array_api_strict/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-10-18T12:46:30-0600",
+ "date": "2024-11-07T13:18:01-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "c89d77a82e2ef7772c26f6cd10cd4b101ce3f90d",
- "version": "2.1"
+ "full-revisionid": "6e59494cbfd3ed949cf2009f778fc4cfdfc3eb04",
+ "version": "2.1.1"
 }
 '''  # END VERSION_JSON
 

{array_api_strict-2.1 → array_api_strict-2.1.1}/array_api_strict/tests/test_array_object.py

@@ -6,7 +6,7 @@ import numpy as np
 import pytest
 
 from .. import ones, asarray, result_type, all, equal
-from .._array_object import Array, CPU_DEVICE
+from .._array_object import Array, CPU_DEVICE, Device
 from .._dtypes import (
     _all_dtypes,
     _boolean_dtypes,
@@ -88,6 +88,14 @@ def test_validate_index():
     assert_raises(IndexError, lambda: a[0])
     assert_raises(IndexError, lambda: a[:])
 
+def test_promoted_scalar_inherits_device():
+    device1 = Device("device1")
+    x = asarray([1., 2, 3], device=device1)
+
+    y = x ** 2
+
+    assert y.device == device1
+
 def test_operators():
     # For every operator, we test that it works for the required type
     # combinations and raises TypeError otherwise
@@ -342,23 +350,19 @@ def test_array_properties():
     assert isinstance(b.mT, Array)
     assert b.mT.shape == (3, 2)
 
-def test___array__():
-    a = ones((2, 3), dtype=int16)
-    assert np.asarray(a) is a._array
-    b = np.asarray(a, dtype=np.float64)
-    assert np.all(np.equal(b, np.ones((2, 3), dtype=np.float64)))
-    assert b.dtype == np.float64
 
 def test_array_conversion():
     # Check that arrays on the CPU device can be converted to NumPy
-    # but arrays on other devices can't
+    # but arrays on other devices can't. Note this is testing the logic in
+    # __array__, which is only used in asarray when converting lists of
+    # arrays.
     a = ones((2, 3))
-    np.asarray(a)
+    asarray([a])
 
     for device in ("device1", "device2"):
         a = ones((2, 3), device=array_api_strict.Device(device))
         with pytest.raises(RuntimeError, match="Can not convert array"):
-            np.asarray(a)
+            asarray([a])
 
 def test_allow_newaxis():
     a = ones(5)

{array_api_strict-2.1 → array_api_strict-2.1.1}/array_api_strict/tests/test_creation_functions.py

@@ -22,8 +22,8 @@ from .._creation_functions import (
     zeros,
     zeros_like,
 )
-from .._dtypes import float32, float64
-from .._array_object import Array, CPU_DEVICE
+from .._dtypes import int16, float32, float64
+from .._array_object import Array, CPU_DEVICE, Device
 from .._flags import set_array_api_strict_flags
 
 def test_asarray_errors():
@@ -97,6 +97,30 @@ def test_asarray_copy():
     a[0] = 0
     assert all(b[0] == 0)
 
+def test_asarray_list_of_lists():
+    a = asarray(1, dtype=int16)
+    b = asarray([1], dtype=int16)
+    res = asarray([a, a])
+    assert res.shape == (2,)
+    assert res.dtype == int16
+    assert all(res == asarray([1, 1]))
+
+    res = asarray([b, b])
+    assert res.shape == (2, 1)
+    assert res.dtype == int16
+    assert all(res == asarray([[1], [1]]))
+
+
+def test_asarray_device_inference():
+    assert asarray([1, 2, 3]).device == CPU_DEVICE
+
+    x = asarray([1, 2, 3])
+    assert asarray(x).device == CPU_DEVICE
+
+    device1 = Device("device1")
+    x = asarray([1, 2, 3], device=device1)
+    assert asarray(x).device == device1
+
 def test_arange_errors():
     arange(1, device=CPU_DEVICE)  # Doesn't error
     assert_raises(ValueError, lambda: arange(1, device="cpu"))

{array_api_strict-2.1 → array_api_strict-2.1.1}/array_api_strict.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: array_api_strict
-Version: 2.1
+Version: 2.1.1
 Summary: A strict, minimal implementation of the Python array API standard.
 Home-page: https://data-apis.org/array-api-strict/
 Author: Consortium for Python Data API Standards