✨: add CanArrayAdd protocol

Support addition operator for array classes.

Signed-off-by: Nathaniel Starkman <[email protected]>

Author: nstarman

pyproject.toml

@@ -137,6 +137,8 @@ version_tuple = {version_tuple!r}
       "FBT",    # flake8-boolean-trap
       "FIX",    # flake8-fixme
       "ISC001", # Conflicts with formatter
+      "PLW1641", # Object does not implement `__hash__` method
+      "PYI041", # Use `float` instead of `int | float`
     ]
 
     [tool.ruff.lint.per-file-ignores]

src/array_api_typing/_array.py

@@ -66,10 +66,32 @@ def __neg__(self) -> Self:
         ...
 
 
+class CanArrayAdd(Protocol):
+    """Protocol for array classes that support the addition operator."""
+
+    def __add__(self, other: Self | int | float, /) -> Self:
+        """Calculates the sum for each element of an array instance with the respective element of the array `other`.
+
+        Args:
+            other: addend array. Must be compatible with `self` (see
+            Broadcasting). Should have a numeric data type.
+
+        Returns:
+            Self: an array containing the element-wise sums. The returned array
+            must have a data type determined by Type Promotion Rules.
+
+        See Also:
+            array_api_typing.Add
+
+        """  # noqa: E501
+        ...
+
+
 class Array(
     HasArrayNamespace[NS_co],
     CanArrayPos,
     CanArrayNeg,
+    CanArrayAdd,
     Protocol,
 ):
     """Array API specification for array object attributes and methods."""