array-api-shape-check 0.1.2__py3-none-any.whl → 1.0.0__py3-none-any.whl

array_api_shape_check/__init__.py

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

array_api_shape_check/_main.py

@@ -1,8 +1,9 @@
+import inspect
 import re
 from collections import defaultdict
 from collections.abc import Sequence
 from itertools import groupby
-from typing import Any
+from typing import Any, cast
 
 import attrs
 import numpy as np
@@ -34,8 +35,7 @@ class SubscriptInfoFromShapeItemUnchecked(SubscriptInfoFromSubcriptItem):
     def __repr__(self) -> str:
         if self.is_variable:
             return f"*{self.name}:{self.shape_current}"
-        else:
-            return f"{self.name}:{self.shape_current[0]}"
+        return f"{self.name}:{self.shape_current[0]}"
 
 
 @attrs.frozen(kw_only=True)
@@ -46,8 +46,7 @@ class SubscriptInfoFromShapeItemUnique(SubscriptInfoFromSubcriptItem):
     def __repr__(self) -> str:
         if self.is_variable:
             return f"*{self.name}:{self.shape_broadcasted}"
-        else:
-            return f"{self.name}:{self.shape_broadcasted[0]}"
+        return f"{self.name}:{self.shape_broadcasted[0]}"
 
 
 @attrs.frozen(kw_only=True)
@@ -60,10 +59,9 @@ class SubscriptInfoFromShapeItem(SubscriptInfoFromShapeItemUnchecked):
             if self.shape_current != self.shape_broadcasted:
                 return f"*{self.name}:{self.shape_current}->{self.shape_broadcasted}"
             return f"*{self.name}:{self.shape_current}"
-        else:
-            if self.shape_current != self.shape_broadcasted:
-                return f"{self.name}:{self.shape_current[0]}->{self.shape_broadcasted[0]}"
-            return f"{self.name}:{self.shape_current[0]}"
+        if self.shape_current != self.shape_broadcasted:
+            return f"{self.name}:{self.shape_current[0]}->{self.shape_broadcasted[0]}"
+        return f"{self.name}:{self.shape_current[0]}"
 
 
 @attrs.frozen(kw_only=True)
@@ -77,26 +75,38 @@ class SubscriptInfoFromShape:
 
 
 class InconsistentNdimError(ValueError):
-    pass
-
-
-class InconsistentNdimErrorMultipleSolutions(InconsistentNdimError):
-    def __init__(self, reason: str, *args: object) -> None:
+    shapes: Sequence[int] | None
+    ndims: Sequence[int]
+    reason: str
+
+
+class InconsistentNdimErrorMultipleSolutions(InconsistentNdimError):  # noqa: N818
+    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:
+class InconsistentNdimErrorNoSolutions(InconsistentNdimError):  # noqa: N818
+    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 "")
         )
 
 
@@ -109,8 +119,6 @@ class InconsistentShapeError(ValueError):
 
 
 def _get_operand_names(*operands: Any) -> list[str | None]:
-    import inspect
-
     frame = inspect.currentframe()
     if frame is None:
         return [None] * len(operands)
@@ -224,6 +232,10 @@ def parse_variable_ndim(subscripts: str, ndims: Sequence[int], /) -> dict[str, i
     ------
     ValueError
         If the subscript is invalid.
+    InconsistentNdimErrorMultipleSolutions
+        If the variable dimensions cannot be uniquely determined.
+    InconsistentNdimErrorNoSolutions
+        If the variable dimensions have no valid solution.
 
     Examples
     --------
@@ -258,9 +270,8 @@ def parse_variable_ndim(subscripts: str, ndims: Sequence[int], /) -> dict[str, i
         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:
@@ -273,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):
@@ -295,21 +306,25 @@ def _parse_shapes(
         )
     shapes: tuple[tuple[int, ...], ...] = ()
     for operand in operands:
-        shape: tuple[int, ...]  # type: ignore
         if isinstance(operand, tuple):
-            shape = operand
+            if None in operand:
+                raise ValueError("Operand shape cannot contain None")
+            shape = cast("tuple[int, ...]", operand)
         elif hasattr(operand, "shape"):
             if None in operand.shape:
                 raise ValueError("Operand shape cannot contain None")
-            shape = operand.shape
+            shape = cast("tuple[int, ...]", operand.shape)
         else:
             raise TypeError(
                 f"Invalid operand: expected an array or a shape tuple, but got {type(operand)}"
             )
-        shapes += (shape,)  # type: ignore
+        shapes += (shape,)
     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):
@@ -322,13 +337,13 @@ def _parse_shapes(
                     shape_current=shape[: name_to_ndim[item.name]],
                 ),
             )
-            shape = shape[name_to_ndim[item.name] :]
+            shape = shape[name_to_ndim[item.name] :]  # noqa: PLW2901
         info_all += (info_array_new,)
     return info_all
 
 
 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.
@@ -359,6 +374,8 @@ def check_shapes(
     ------
     ValueError
         If the subscript is invalid.
+    InconsistentShapeError
+        If the operand shapes are inconsistent.
 
     Examples
     --------
@@ -436,7 +453,7 @@ def check_shapes(
                     name=item.name,
                     is_variable=item.is_variable,
                     shape_current=item.shape_current,
-                    shape_broadcasted=shape_broadcasted.get(item.name),  # type: ignore
+                    shape_broadcasted=shape_broadcasted[item.name],
                 ),
             )
         info_all_new += (info_array_new,)
@@ -445,7 +462,7 @@ def check_shapes(
         SubscriptInfoFromShapeItemUnique(
             name=item.name,
             is_variable=item.is_variable,
-            shape_broadcasted=shape_broadcasted.get(item.name),  # type: ignore
+            shape_broadcasted=shape_broadcasted[item.name],
         )
         for info_array in info_all_new
         for item in info_array

{array_api_shape_check-0.1.2.dist-info → array_api_shape_check-1.0.0.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: array-api-shape-check
-Version: 0.1.2
+Version: 1.0.0
 Summary: Check shapes of input arrays easily
-Author-email: 34j <34j.95a2p@simplelogin.com>
+Author: 34j
 License-Expression: MIT
 Project-URL: Bug Tracker, https://github.com/34j/array-api-shape-check/issues
 Project-URL: Changelog, https://github.com/34j/array-api-shape-check/blob/main/CHANGELOG.md

array_api_shape_check-1.0.0.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=VXDxm8ds6mjq9qiJ4BFNWJWXxjBZKMXZ7WafYvuICt4,16965
+array_api_shape_check/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+array_api_shape_check-1.0.0.dist-info/licenses/LICENSE,sha256=Otwb96xcK4QBqXXVdBKpLZVnc4mJuFTa8rsMUEpphMM,1061
+array_api_shape_check-1.0.0.dist-info/METADATA,sha256=6cj-qjtOx_MV44WBn5-mLIY2XnChx71cQNG8V_74jQY,6179
+array_api_shape_check-1.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+array_api_shape_check-1.0.0.dist-info/top_level.txt,sha256=pirw2DeaWnDU_rSg3CZ1MsE-tJWEvndYSQG0illDMkI,22
+array_api_shape_check-1.0.0.dist-info/RECORD,,

{array_api_shape_check-0.1.2.dist-info → array_api_shape_check-1.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (84.2.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

array_api_shape_check-0.1.2.dist-info/RECORD

@@ -1,8 +0,0 @@
-array_api_shape_check/__init__.py,sha256=peDt2aytKiIHNe9K5YRB8VJG15wxDIt0bKm7Z6Wu8s8,940
-array_api_shape_check/_main.py,sha256=kqGml_xsXX1CtieBZDyyd_m-_kBqe-F-oj4PVpfKsek,16029
-array_api_shape_check/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-array_api_shape_check-0.1.2.dist-info/licenses/LICENSE,sha256=Otwb96xcK4QBqXXVdBKpLZVnc4mJuFTa8rsMUEpphMM,1061
-array_api_shape_check-0.1.2.dist-info/METADATA,sha256=bQKTAYo0XcoLyASUyChwsJ0RdNwlb-CBN5oHQrGkgV4,6213
-array_api_shape_check-0.1.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-array_api_shape_check-0.1.2.dist-info/top_level.txt,sha256=pirw2DeaWnDU_rSg3CZ1MsE-tJWEvndYSQG0illDMkI,22
-array_api_shape_check-0.1.2.dist-info/RECORD,,