array-api-shape-check 0.1.3__tar.gz → 1.0.1__tar.gz

{array_api_shape_check-0.1.3/src/array_api_shape_check.egg-info → array_api_shape_check-1.0.1}/PKG-INFO

@@ -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/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [ "setuptools>=77.0.3" ]
+
+[project]
+name = "array-api-shape-check"
+version = "1.0.1"
+description = "Check shapes of input arrays easily"
+readme = "README.md"
+license = "MIT"
+authors = [
+  { name = "34j" },
+]
+requires-python = ">=3.12"
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Software Development :: Libraries",
+]
+dependencies = [
+  "attrs>=26.1",
+  "more-itertools>=11.0.2",
+  "numpy>=2.4.4",
+  "types-array-api>=1.1.4",
+]
+urls."Bug Tracker" = "https://github.com/34j/array-api-shape-check/issues"
+urls.Changelog = "https://github.com/34j/array-api-shape-check/blob/main/CHANGELOG.md"
+urls.documentation = "https://array-api-shape-check.readthedocs.io"
+urls.repository = "https://github.com/34j/array-api-shape-check"
+
+[dependency-groups]
+dev = [
+  "coverage",
+  "packaging-34j[test]",
+  "pytest",
+  "pytest-cov",
+  "ty",
+]
+docs = [
+  "packaging-34j[docs]",
+]
+
+[tool.ruff]
+extend = ".venv/ruff.toml"
+
+[tool.pyproject-fmt]
+max_supported_python = "3.14"
+
+[tool.ty]
+terminal.error-on-warning = true
+
+[tool.pytest]
+addopts = [
+  "-v",
+  "-Wonce",
+  "-p no:doctest",
+  "--cov=array_api_shape_check",
+  "--cov-report=term",
+  "--cov-report=xml",
+]
+pythonpath = [ "src" ]

{array_api_shape_check-0.1.3 → array_api_shape_check-1.0.1}/src/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 → array_api_shape_check-1.0.1/src/array_api_shape_check.egg-info}/PKG-INFO

@@ -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/tests/test_main.py

@@ -0,0 +1,43 @@
+import pytest
+
+from array_api_shape_check import InconsistentShapeError, check_shapes
+from array_api_shape_check._main import _get_operand_names  # noqa: PLC2701
+
+
+def test_get_operand_names():
+    def inner(a, b) -> list[str | None]:
+        return _get_operand_names(a, b)
+
+    c = 1
+    assert inner(c, 4 * 4)[0] == "c"
+    # assert inner(c, 4 * 4)[1] is not None
+    # assert "@py_assert" in repr(inner(c, 4 * 4)[1])
+
+
+@pytest.mark.parametrize(
+    ("subscripts", "shapes", "key"),
+    [
+        ("i,i", ((3,), (4,)), "i"),
+        ("ij,ji", ((3, 4), (4, 9)), "i"),
+        ("*BM,*BN", ((2, 3), (4, 3)), "B"),
+    ],
+)
+def test_incompatible_shapes(
+    subscripts: str, shapes: tuple[tuple[int, ...], ...], key: str
+) -> None:
+    with pytest.raises(InconsistentShapeError, match=f"Key {key}") as exc:
+        check_shapes(subscripts, *shapes, names="first,second")
+    assert exc.value.subscript_info.unique[key].shape_broadcasted is None
+
+
+def test_broadcasts_nonconsecutive_subscripts() -> None:
+    info = check_shapes("ij,ji", (1, 4), (4, 9), names="first,second")
+    assert info.unique["i"].shape_broadcasted == (9,)
+    assert info.unique["j"].shape_broadcasted == (4,)
+
+
+def test_reports_all_inconsistent_subscripts() -> None:
+    with pytest.raises(InconsistentShapeError) as exc:
+        check_shapes("ij,ij", (2, 3), (4, 5), names="first,second")
+    assert "Key i" in str(exc.value)
+    assert "Key j" in str(exc.value)

array_api_shape_check-0.1.3/pyproject.toml

@@ -1,149 +0,0 @@
-[build-system]
-build-backend = "setuptools.build_meta"
-requires = [ "setuptools>=77.0.3" ]
-
-[project]
-name = "array-api-shape-check"
-version = "0.1.3"
-description = "Check shapes of input arrays easily"
-readme = "README.md"
-license = "MIT"
-authors = [
-  { name = "34j", email = "34j.95a2p@simplelogin.com" },
-]
-requires-python = ">=3.12"
-classifiers = [
-  "Development Status :: 2 - Pre-Alpha",
-  "Intended Audience :: Developers",
-  "Natural Language :: English",
-  "Operating System :: OS Independent",
-  "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.12",
-  "Programming Language :: Python :: 3.13",
-  "Programming Language :: Python :: 3.14",
-  "Topic :: Software Development :: Libraries",
-]
-dependencies = [
-  "attrs>=26.1",
-  "more-itertools>=11.0.2",
-  "numpy>=2.4.4",
-  "types-array-api>=1.1.4",
-]
-urls."Bug Tracker" = "https://github.com/34j/array-api-shape-check/issues"
-urls.Changelog = "https://github.com/34j/array-api-shape-check/blob/main/CHANGELOG.md"
-urls.documentation = "https://array-api-shape-check.readthedocs.io"
-urls.repository = "https://github.com/34j/array-api-shape-check"
-
-[dependency-groups]
-dev = [
-  "coverage",
-  "numpy>=2.4.4",
-  "pytest==9.*",
-  "pytest-cov==7.*",
-  "sybil[pytest]",
-  "ty",
-]
-docs = [
-  "furo; python_version>='3.12'",
-  "myst-parser; python_version>='3.12'",
-  "sphinx==9.*; python_version>='3.12'",
-  "sphinx-autobuild; python_version>='3.12'",
-]
-
-[tool.ruff]
-line-length = 100
-preview = true
-format.docstring-code-format = true
-lint.select = [
-  "B",   # flake8-bugbear
-  "C4",  # flake8-comprehensions
-  "D",   # flake8-docstrings
-  "E",   # pycodestyle
-  "F",   # pyflake
-  "I",   # isort
-  "RUF", # ruff specific
-  "S",   # flake8-bandit
-  "UP",  # pyupgrade
-  "W",   # pycodestyle
-]
-lint.ignore = [
-  "D100", # Missing docstring in public module
-  "D104", # Missing docstring in public package
-  "D107", # Missing docstring in `__init__`
-  "D203", # 1 blank line required before class docstring
-  "D212", # Multi-line docstring summary should start at the first line
-  "D401", # First line of docstring should be in imperative mood
-]
-lint.per-file-ignores."conftest.py" = [ "D100" ]
-lint.per-file-ignores."docs/conf.py" = [ "D100" ]
-lint.per-file-ignores."setup.py" = [ "D100" ]
-lint.per-file-ignores."tests/**/*" = [
-  "D100",
-  "D101",
-  "D102",
-  "D103",
-  "D104",
-  "S101",
-]
-lint.isort.known-first-party = [ "array_api_shape_check", "tests" ]
-
-[tool.pyproject-fmt]
-max_supported_python = "3.14"
-
-[tool.ty]
-terminal.error-on-warning = true
-src.exclude = [ "docs/" ]
-
-[tool.pytest]
-minversion = "9.0"
-addopts = [
-  "-v",
-  "-Wonce",
-  "-p no:doctest",
-  "--cov=array_api_shape_check",
-  "--cov-report=term",
-  "--cov-report=xml",
-]
-pythonpath = [ "src" ]
-
-[tool.coverage]
-run.branch = true
-paths.source = [
-  "src",
-  ".tox/**/site-packages",
-]
-report.exclude_lines = [
-  "@overload",
-  'if __name__ == "__main__":',
-  "if TYPE_CHECKING",
-  "pragma: no cover",
-  "raise NotImplementedError",
-]
-
-[tool.semantic_release]
-allow_zero_version = true
-version_toml = [ "pyproject.toml:project.version" ]
-version_variables = [
-  "src/array_api_shape_check/__init__.py:__version__",
-  "docs/conf.py:release",
-]
-build_command = """
-pip install uv
-uv lock
-git add uv.lock
-uv build
-"""
-branches.main.match = "main"
-branches.noop.match = "(?!main$)"
-branches.noop.prerelease = true
-changelog.exclude_commit_patterns = [
-  "chore(?:\\([^)]*?\\))?: .+",
-  "ci(?:\\([^)]*?\\))?: .+",
-  "refactor(?:\\([^)]*?\\))?: .+",
-  "style(?:\\([^)]*?\\))?: .+",
-  "test(?:\\([^)]*?\\))?: .+",
-  "build\\((?!deps\\): .+)",
-  "Merged? .*",
-  "Initial [Cc]ommit.*",         # codespell:ignore
-]
-changelog.environment.keep_trailing_newline = true

array_api_shape_check-0.1.3/tests/test_main.py

@@ -1,11 +0,0 @@
-from array_api_shape_check._main import _get_operand_names
-
-
-def test_get_operand_names():
-    def inner(a, b) -> list[str | None]:
-        return _get_operand_names(a, b)
-
-    c = 1
-    assert inner(c, 4 * 4)[0] == "c"
-    # assert inner(c, 4 * 4)[1] is not None
-    # assert "@py_assert" in repr(inner(c, 4 * 4)[1])