array-api-shape-check 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

array_api_shape_check/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.1"
+__version__ = "0.1.3"
 from ._main import (
     InconsistentNdimError,
     InconsistentNdimErrorMultipleSolutions,

array_api_shape_check/_main.py

@@ -23,7 +23,7 @@ class SubscriptInfoFromSubcriptItem:
 @attrs.frozen(kw_only=True)
 class SubscriptInfoFromSubcript:
     all: tuple[tuple[SubscriptInfoFromSubcriptItem, ...], ...]
-    unique: tuple[SubscriptInfoFromSubcriptItem, ...]
+    unique: dict[str, SubscriptInfoFromSubcriptItem]
 
 
 @attrs.frozen(kw_only=True)
@@ -70,33 +70,45 @@ class SubscriptInfoFromShapeItem(SubscriptInfoFromShapeItemUnchecked):
 class SubscriptInfoFromShape:
     all: tuple[tuple[SubscriptInfoFromShapeItem, ...], ...]
     """The subscript info grouped by order, then by operand"""
-    unique: tuple[SubscriptInfoFromShapeItemUnique, ...]
+    unique: dict[str, SubscriptInfoFromShapeItemUnique]
     """The unique subscripts,
     ignoring order and shapes not broadcasted,
     sorted lexicographically by name"""
 
 
 class InconsistentNdimError(ValueError):
-    pass
+    shapes: Sequence[int] | None
+    ndims: Sequence[int]
+    reason: str
 
 
 class InconsistentNdimErrorMultipleSolutions(InconsistentNdimError):
-    def __init__(self, reason: str, *args: object) -> None:
+    def __init__(
+        self, ndims: Sequence[int], reason: str, shapes: Sequence[int] | None = None
+    ) -> None:
+        self.ndims = ndims
+        self.reason = reason
+        self.shapes = shapes
         super().__init__(
             f"Inconsistent ndims: there are multiple possible solutions "
             "to determine the number of dimensions "
-            f"for variable subscripts [{reason}]",
-            *args,
+            f"for variable subscripts [{reason}]"
+            f"\nndims: {ndims}" + (f"\nshapes: {shapes}" if shapes is not None else "")
         )
 
 
 class InconsistentNdimErrorNoSolutions(InconsistentNdimError):
-    def __init__(self, reason: str, *args: object) -> None:
+    def __init__(
+        self, ndims: Sequence[int], reason: str, shapes: Sequence[int] | None = None
+    ) -> None:
+        self.ndims = ndims
+        self.reason = reason
+        self.shapes = shapes
         super().__init__(
             f"Inconsistent ndims: there are no solution "
             f"to determine the number of dimensions "
-            f"for variable subscripts [{reason}]",
-            *args,
+            f"for variable subscripts [{reason}]"
+            f"\nndims: {ndims}" + (f"\nshapes: {shapes}" if shapes is not None else "")
         )
 
 
@@ -157,8 +169,11 @@ def parse_subscripts(subscripts: str, /) -> SubscriptInfoFromSubcript:
 
     Examples
     --------
-    >>> parse_subscripts("ij,*k*l,*li")
-    SubscriptInfoFromSubcript(all=((i, j), (*k, *l), (*l, i)), unique=(i, j, *k, *l))
+    >>> info = parse_subscripts("ij,*k*l,*li")
+    >>> info.all
+    ((i, j), (*k, *l), (*l, i))
+    >>> info.unique
+    {'i': i, 'j': j, 'k': *k, 'l': *l}
 
     """
     # If . other than ...
@@ -181,9 +196,9 @@ def parse_subscripts(subscripts: str, /) -> SubscriptInfoFromSubcript:
                 is_variable = False
         info_all += (info_array,)
 
-    info_unique: set[SubscriptInfoFromSubcriptItem] = {
-        x for info_array in info_all for x in info_array
-    }
+    info_unique = tuple(
+        sorted({x for info_array in info_all for x in info_array}, key=lambda x: x.name)
+    )
     # raise if there are subscripts with same name but different is_variable
     names = set()
     for info in info_unique:
@@ -193,9 +208,7 @@ def parse_subscripts(subscripts: str, /) -> SubscriptInfoFromSubcript:
             )
         names.add(info.name)
 
-    return SubscriptInfoFromSubcript(
-        all=info_all, unique=tuple(sorted(info_unique, key=lambda x: x.name))
-    )
+    return SubscriptInfoFromSubcript(all=info_all, unique={item.name: item for item in info_unique})
 
 
 def parse_variable_ndim(subscripts: str, ndims: Sequence[int], /) -> dict[str, int]:
@@ -253,11 +266,12 @@ def parse_variable_ndim(subscripts: str, ndims: Sequence[int], /) -> dict[str, i
         )
 
     # decide dimensions by solving linear equations
-    info_variable_unique = [subscript for subscript in info.unique if subscript.is_variable]
+    info_variable_unique = [
+        subscript for subscript in info.unique.values() if subscript.is_variable
+    ]
     if len(info_variable_unique) > len(info.all):
-        raise InconsistentNdimErrorMultipleSolutions("number of variables")
+        raise InconsistentNdimErrorMultipleSolutions(ndims, "number of variables")
     rhs = np.asarray(ndims, dtype=int)
-    del ndims
     mat = np.zeros((len(info.all), len(info_variable_unique)), dtype=int)
     for i, info_array in enumerate(info.all):
         for subscript in info_array:
@@ -270,19 +284,19 @@ def parse_variable_ndim(subscripts: str, ndims: Sequence[int], /) -> dict[str, i
     # solve overdetermined linear equations using least squares method
     variable_dims, residuals, rank, _singular_values = np.linalg.lstsq(mat, rhs, rcond=None)
     if rank != len(info_variable_unique):
-        raise InconsistentNdimErrorMultipleSolutions("rank")
+        raise InconsistentNdimErrorMultipleSolutions(ndims, "rank")
     if residuals.size > 0 and not np.isclose(residuals[0], 0):
-        raise InconsistentNdimErrorNoSolutions("residuals")
+        raise InconsistentNdimErrorNoSolutions(ndims, "residuals")
     variable_dims = np.round(variable_dims).astype(int)
     if np.any(variable_dims < 0):
-        raise InconsistentNdimErrorNoSolutions("negative")
+        raise InconsistentNdimErrorNoSolutions(ndims, "negative")
     return {
         subscript.name: int(variable_dims[j]) for j, subscript in enumerate(info_variable_unique)
     }
 
 
 def _parse_shapes(
-    subscripts: str, /, *operands: Array | tuple[int, ...]
+    subscripts: str, /, *operands: Array | tuple[int | None, ...]
 ) -> tuple[tuple[SubscriptInfoFromShapeItemUnchecked, ...], ...]:
     info = parse_subscripts(subscripts)
     if len(info.all) != len(operands):
@@ -306,7 +320,10 @@ def _parse_shapes(
         shapes += (shape,)  # type: ignore
     del operands
     ndims = [len(shape) for shape in shapes]
-    name_to_ndim = defaultdict(lambda: 1, parse_variable_ndim(subscripts, ndims))
+    try:
+        name_to_ndim = defaultdict(lambda: 1, parse_variable_ndim(subscripts, ndims))
+    except InconsistentNdimError as e:
+        raise type(e)(e.ndims, e.reason, shapes) from e
     del subscripts, ndims
     info_all: tuple[tuple[SubscriptInfoFromShapeItemUnchecked, ...], ...] = ()
     for info_array, shape in zip(info.all, shapes, strict=False):
@@ -325,7 +342,7 @@ def _parse_shapes(
 
 
 def check_shapes(
-    subscripts: str, /, *operands: Array | tuple[int, ...], names: str | None = None
+    subscripts: str, /, *operands: Array | tuple[int | None, ...], names: str | None = None
 ) -> SubscriptInfoFromShape:
     """
     Parse variable subscript ndims by solving linear equations.
@@ -363,7 +380,7 @@ def check_shapes(
     >>> info.all
     ((i:1->3, j:4), (*k:(5,), *l:(6, 7)), (*l:(1, 7)->(6, 7), i:3))
     >>> info.unique
-    (i:3, j:4, *k:(5,), *l:(6, 7))
+    {'i': i:3, 'j': j:4, 'k': *k:(5,), 'l': *l:(6, 7)}
 
     Internally `check_shapes()` calls `parse_variable_ndim()`,
     which determines the number of dimensions for variable subscripts by least squares.
@@ -448,7 +465,8 @@ def check_shapes(
         for item in info_array
     }
     result = SubscriptInfoFromShape(
-        all=info_all_new, unique=tuple(sorted(info_unique, key=lambda x: x.name))
+        all=info_all_new,
+        unique={item.name: item for item in sorted(info_unique, key=lambda x: x.name)},
     )
 
     if errors:

{array_api_shape_check-0.1.1.dist-info → array_api_shape_check-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: array-api-shape-check
-Version: 0.1.1
+Version: 0.1.3
 Summary: Check shapes of input arrays easily
 Author-email: 34j <34j.95a2p@simplelogin.com>
 License-Expression: MIT
@@ -82,7 +82,7 @@ Install this via pip (or your favourite package manager):
 >>> info.all
 ((i:1->3, j:4), (*k:(5,), *l:(6, 7)), (*l:(1, 7)->(6, 7), i:3))
 >>> info.unique
-(i:3, j:4, *k:(5,), *l:(6, 7))
+{'i': i:3, 'j': j:4, 'k': *k:(5,), 'l': *l:(6, 7)}
 ```
 
 Internally `check_shapes()` calls `parse_variable_ndim()`, which determines the number of dimensions for variable subscripts by least squares. If this is successful, checks if each subscript is consistent, then finnaly raises error for all inconsistencies at once.

array_api_shape_check-0.1.3.dist-info/RECORD

@@ -0,0 +1,8 @@
+array_api_shape_check/__init__.py,sha256=8i9ZV_x6HXtVd0g7N3ec190lQ1LUC2s93A9p-J3C9WI,940
+array_api_shape_check/_main.py,sha256=LqwDK6OD9ldcUaXmmbG5aBXzOW0gEJuu1iAe9rs2BiY,16652
+array_api_shape_check/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+array_api_shape_check-0.1.3.dist-info/licenses/LICENSE,sha256=Otwb96xcK4QBqXXVdBKpLZVnc4mJuFTa8rsMUEpphMM,1061
+array_api_shape_check-0.1.3.dist-info/METADATA,sha256=of_gXs9JcFp-b0KQwa9Sbf8GIXPvChmU5VGfvBWyYOQ,6213
+array_api_shape_check-0.1.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+array_api_shape_check-0.1.3.dist-info/top_level.txt,sha256=pirw2DeaWnDU_rSg3CZ1MsE-tJWEvndYSQG0illDMkI,22
+array_api_shape_check-0.1.3.dist-info/RECORD,,

array_api_shape_check-0.1.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-array_api_shape_check/__init__.py,sha256=MsV4O9FLovSeq30_Y1MyxZH_RYayQ01KaT7YCRSKx9U,940
-array_api_shape_check/_main.py,sha256=0D9MY4rPLxQgc-bEm4I4ROi-xGL9jrHOnNSy3uF70C8,15947
-array_api_shape_check/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-array_api_shape_check-0.1.1.dist-info/licenses/LICENSE,sha256=Otwb96xcK4QBqXXVdBKpLZVnc4mJuFTa8rsMUEpphMM,1061
-array_api_shape_check-0.1.1.dist-info/METADATA,sha256=iT7COus2b1y0GkqIw6fHI9wVP59e7mVuhi2wONPCatQ,6193
-array_api_shape_check-0.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-array_api_shape_check-0.1.1.dist-info/top_level.txt,sha256=pirw2DeaWnDU_rSg3CZ1MsE-tJWEvndYSQG0illDMkI,22
-array_api_shape_check-0.1.1.dist-info/RECORD,,