Convert check_shape to raising instead of returning bool/rename to validate_shapes

Author: ksunden

data_prototype/containers.py

@@ -44,15 +44,36 @@ class Desc:
     units: str = "naive"
 
     @staticmethod
-    def check_shapes(*args: tuple[ShapeSpec, "Desc"], broadcast=False) -> bool:
+    def validate_shapes(
+        specification: dict[str, ShapeSpec | "Desc"],
+        actual: dict[str, ShapeSpec | "Desc"],
+        *,
+        broadcast=False,
+    ) -> bool:
         specvars: dict[str, int | tuple[str, int]] = {}
-        for spec, desc in args:
+        for fieldname in specification:
+            spec = specification[fieldname]
+            if fieldname not in actual:
+                raise KeyError(
+                    f"Actual is missing {fieldname!r}, required by specification."
+                )
+            desc = actual[fieldname]
+            if isinstance(spec, Desc):
+                spec = spec.shape
+            if isinstance(desc, Desc):
+                desc = desc.shape
             if not broadcast:
-                if len(spec) != len(desc.shape):
-                    return False
-            elif len(desc.shape) > len(spec):
-                return False
-            for speccomp, desccomp in zip(spec[::-1], desc.shape[::-1]):
+                if len(spec) != len(desc):
+                    raise ValueError(
+                        f"{fieldname!r} shape {desc} incompatible with specification "
+                        f"{spec}."
+                    )
+            elif len(desc) > len(spec):
+                raise ValueError(
+                    f"{fieldname!r} shape {desc} incompatible with specification "
+                    f"{spec}."
+                )
+            for speccomp, desccomp in zip(spec[::-1], desc[::-1]):
                 if broadcast and desccomp == 1:
                     continue
                 if isinstance(speccomp, str):
@@ -65,12 +86,15 @@ def check_shapes(*args: tuple[ShapeSpec, "Desc"], broadcast=False) -> bool:
                         entry = desccomp - specoff
 
                     if specv in specvars and entry != specvars[specv]:
-                        return False
+                        raise ValueError(f"Found two incompatible values for {specv!r}")
 
                     specvars[specv] = entry
                 elif speccomp != desccomp:
-                    return False
-        return True
+                    raise ValueError(
+                        f"{fieldname!r} shape {desc} incompatible with specification "
+                        f"{spec}"
+                    )
+        return None
 
 
 class DataContainer(Protocol):

data_prototype/tests/test_check_shape.py

@@ -30,9 +30,9 @@
 def test_passing_no_broadcast(
     spec: list[tuple[int | str, ...]], actual: list[tuple[int | str, ...]]
 ):
-    assert Desc.check_shapes(
-        *[(s, Desc(dtype=float, shape=a)) for s, a in zip(spec, actual)]
-    )
+    spec = {var: shape for var, shape in zip("abcdefg", spec)}
+    actual = {var: shape for var, shape in zip("abcdefg", actual)}
+    Desc.validate_shapes(spec, actual)
 
 
 @pytest.mark.parametrize(
@@ -55,9 +55,10 @@ def test_passing_no_broadcast(
 def test_failing_no_broadcast(
     spec: list[tuple[int | str, ...]], actual: list[tuple[int | str, ...]]
 ):
-    assert not Desc.check_shapes(
-        *[(s, Desc(dtype=float, shape=a)) for s, a in zip(spec, actual)]
-    )
+    spec = {var: shape for var, shape in zip("abcdefg", spec)}
+    actual = {var: shape for var, shape in zip("abcdefg", actual)}
+    with pytest.raises(ValueError):
+        Desc.validate_shapes(spec, actual)
 
 
 @pytest.mark.parametrize(
@@ -90,9 +91,9 @@ def test_failing_no_broadcast(
 def test_passing_broadcast(
     spec: list[tuple[int | str, ...]], actual: list[tuple[int | str, ...]]
 ):
-    assert Desc.check_shapes(
-        *[(s, Desc(dtype=float, shape=a)) for s, a in zip(spec, actual)], broadcast=True
-    )
+    spec = {var: shape for var, shape in zip("abcdefg", spec)}
+    actual = {var: shape for var, shape in zip("abcdefg", actual)}
+    Desc.validate_shapes(spec, actual, broadcast=True)
 
 
 @pytest.mark.parametrize(
@@ -113,6 +114,20 @@ def test_passing_broadcast(
 def test_failing_broadcast(
     spec: list[tuple[int | str, ...]], actual: list[tuple[int | str, ...]]
 ):
-    assert not Desc.check_shapes(
-        *[(s, Desc(dtype=float, shape=a)) for s, a in zip(spec, actual)], broadcast=True
-    )
+    spec = {var: shape for var, shape in zip("abcdefg", spec)}
+    actual = {var: shape for var, shape in zip("abcdefg", actual)}
+    with pytest.raises(ValueError):
+        Desc.validate_shapes(spec, actual, broadcast=True)
+
+
+def test_desc_object():
+    spec = {"a": Desc(("N",), float), "b": Desc(("N+1",), float)}
+    actual = {"a": Desc((3,), float), "b": Desc((4,), float)}
+    Desc.validate_shapes(spec, actual)
+
+
+def test_missing_key():
+    spec = {"a": Desc(("N",), float), "b": Desc(("N+1",), float)}
+    actual = {"a": Desc((3,), float)}
+    with pytest.raises(KeyError):
+        Desc.validate_shapes(spec, actual)