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

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,43 +35,50 @@ 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)
-class SubscriptInfoFromShapeItemUnique(SubscriptInfoFromSubcriptItem):
-    shape_broadcasted: tuple[int, ...]
-    """The shape after broadcasting with other subscripts with the same name"""
+class SubscriptInfoFromShapeItemUnique[BroadcastShape: tuple[int, ...] | None](
+    SubscriptInfoFromSubcriptItem
+):
+    shape_broadcasted: BroadcastShape
+    """The broadcast shape, or None for an inconsistent subscript."""
 
     def __repr__(self) -> str:
         if self.is_variable:
             return f"*{self.name}:{self.shape_broadcasted}"
-        else:
-            return f"{self.name}:{self.shape_broadcasted[0]}"
+        if self.shape_broadcasted is None:
+            return f"{self.name}:None"
+        return f"{self.name}:{cast('tuple[int, ...]', self.shape_broadcasted)[0]}"
 
 
 @attrs.frozen(kw_only=True)
-class SubscriptInfoFromShapeItem(SubscriptInfoFromShapeItemUnchecked):
-    shape_broadcasted: tuple[int, ...]
-    """The shape after broadcasting with other subscripts with the same name"""
+class SubscriptInfoFromShapeItem[BroadcastShape: tuple[int, ...] | None](
+    SubscriptInfoFromShapeItemUnchecked
+):
+    shape_broadcasted: BroadcastShape
+    """The broadcast shape, or None for an inconsistent subscript."""
 
     def __repr__(self) -> str:
+        if self.shape_broadcasted is None:
+            current = self.shape_current if self.is_variable else self.shape_current[0]
+            return f"{'*' if self.is_variable else ''}{self.name}:{current}->None"
         if self.is_variable:
             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:
+            broadcasted = cast("tuple[int, ...]", self.shape_broadcasted)
+            return f"{self.name}:{self.shape_current[0]}->{broadcasted[0]}"
+        return f"{self.name}:{self.shape_current[0]}"
 
 
 @attrs.frozen(kw_only=True)
-class SubscriptInfoFromShape:
-    all: tuple[tuple[SubscriptInfoFromShapeItem, ...], ...]
+class SubscriptInfoFromShape[BroadcastShape: tuple[int, ...] | None]:
+    all: tuple[tuple[SubscriptInfoFromShapeItem[BroadcastShape], ...], ...]
     """The subscript info grouped by order, then by operand"""
-    unique: dict[str, SubscriptInfoFromShapeItemUnique]
+    unique: dict[str, SubscriptInfoFromShapeItemUnique[BroadcastShape]]
     """The unique subscripts,
     ignoring order and shapes not broadcasted,
     sorted lexicographically by name"""
@@ -82,7 +90,7 @@ class InconsistentNdimError(ValueError):
     reason: str
 
 
-class InconsistentNdimErrorMultipleSolutions(InconsistentNdimError):
+class InconsistentNdimErrorMultipleSolutions(InconsistentNdimError):  # noqa: N818
     def __init__(
         self, ndims: Sequence[int], reason: str, shapes: Sequence[int] | None = None
     ) -> None:
@@ -97,7 +105,7 @@ class InconsistentNdimErrorMultipleSolutions(InconsistentNdimError):
         )
 
 
-class InconsistentNdimErrorNoSolutions(InconsistentNdimError):
+class InconsistentNdimErrorNoSolutions(InconsistentNdimError):  # noqa: N818
     def __init__(
         self, ndims: Sequence[int], reason: str, shapes: Sequence[int] | None = None
     ) -> None:
@@ -113,16 +121,19 @@ class InconsistentNdimErrorNoSolutions(InconsistentNdimError):
 
 
 class InconsistentShapeError(ValueError):
-    subscript_info: SubscriptInfoFromShape
+    subscript_info: SubscriptInfoFromShape[tuple[int, ...] | None]
 
-    def __init__(self, subscript_info: SubscriptInfoFromShape, reason: str, *args: object) -> None:
+    def __init__(
+        self,
+        subscript_info: SubscriptInfoFromShape[tuple[int, ...] | None],
+        reason: str,
+        *args: object,
+    ) -> None:
         super().__init__("Inconsistent shapes: " + str(subscript_info.all) + f"\n {reason}", *args)
         self.subscript_info = subscript_info
 
 
 def _get_operand_names(*operands: Any) -> list[str | None]:
-    import inspect
-
     frame = inspect.currentframe()
     if frame is None:
         return [None] * len(operands)
@@ -236,6 +247,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
     --------
@@ -306,18 +321,19 @@ 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]
     try:
@@ -336,14 +352,14 @@ 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 | None, ...], names: str | None = None
-) -> SubscriptInfoFromShape:
+) -> SubscriptInfoFromShape[tuple[int, ...]]:
     """
     Parse variable subscript ndims by solving linear equations.
 
@@ -373,6 +389,8 @@ def check_shapes(
     ------
     ValueError
         If the subscript is invalid.
+    InconsistentShapeError
+        If the operand shapes are inconsistent.
 
     Examples
     --------
@@ -432,12 +450,15 @@ def check_shapes(
     info_flatten_keyed = [(i, item) for i, info_array in enumerate(info_all) for item in info_array]
     errors = []
     shape_broadcasted = {}
-    for key, group in groupby(info_flatten_keyed, key=lambda x: x[1].name):
+    for key, group in groupby(
+        sorted(info_flatten_keyed, key=lambda x: x[1].name), key=lambda x: x[1].name
+    ):
         group_list = list(group)
         shapes = [item.shape_current for _, item in group_list]
         try:
             shape_broadcasted[key] = np.broadcast_shapes(*shapes)
         except ValueError:
+            shape_broadcasted[key] = None
             inner_text = ", ".join([f"{shape} ({names_[i]})" for i, shape in group_list])
             errors.append(f"Key {key}: shapes {inner_text} are not broadcastable")
 
@@ -450,7 +471,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,)
@@ -459,7 +480,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
@@ -472,4 +493,5 @@ def check_shapes(
     if errors:
         raise InconsistentShapeError(result, "\n".join(errors))
 
-    return result
+    # No broadcast shape can be None unless an inconsistency was recorded.
+    return cast("SubscriptInfoFromShape[tuple[int, ...]]", result)

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

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: array-api-shape-check
-Version: 0.1.3
+Version: 1.0.1
 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.1.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=jKI3eDWql14v2oXesGXeZE9_114hfp5D8TUaqKbMAY4,17808
+array_api_shape_check/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+array_api_shape_check-1.0.1.dist-info/licenses/LICENSE,sha256=Otwb96xcK4QBqXXVdBKpLZVnc4mJuFTa8rsMUEpphMM,1061
+array_api_shape_check-1.0.1.dist-info/METADATA,sha256=0DwyMEHAVpY908iaOjNLGR8uFSxDLLRfebEFnm0I89I,6179
+array_api_shape_check-1.0.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+array_api_shape_check-1.0.1.dist-info/top_level.txt,sha256=pirw2DeaWnDU_rSg3CZ1MsE-tJWEvndYSQG0illDMkI,22
+array_api_shape_check-1.0.1.dist-info/RECORD,,

{array_api_shape_check-0.1.3.dist-info → array_api_shape_check-1.0.1.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.3.dist-info/RECORD

@@ -1,8 +0,0 @@
-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,,