✨ HasNDim

Signed-off-by: nstarman <[email protected]>

Author: nstarman

src/array_api_typing/__init__.py

@@ -5,6 +5,7 @@
     "HasArrayNamespace",
     "HasDType",
     "HasMatrixTranspose",
+    "HasNDim",
     "__version__",
     "__version_tuple__",
 )
@@ -14,5 +15,6 @@
     HasArrayNamespace,
     HasDType,
     HasMatrixTranspose,
+    HasNDim,
 )
 from ._version import version as __version__, version_tuple as __version_tuple__

src/array_api_typing/_array.py

@@ -4,6 +4,7 @@
     "HasDType",
     "HasDevice",
     "HasMatrixTranspose",
+    "HasNDim",
 )
 
 from types import ModuleType
@@ -100,11 +101,26 @@ def mT(self) -> Self:  # noqa: N802
         ...
 
 
+class HasNDim(Protocol):
+    """Protocol for array classes that have a number of dimensions attribute."""
+
+    @property
+    def ndim(self) -> int:
+        """Number of array dimensions (axes).
+
+        Returns:
+            int: number of array dimensions (axes).
+
+        """
+        ...
+
+
 class Array(
     # ------ Attributes -------
     HasDType[DTypeT_co],
     HasDevice,
     HasMatrixTranspose,
+    HasNDim,
     # ------- Methods ---------
     HasArrayNamespace[NamespaceT_co],
     # -------------------------

tests/integration/test_numpy1p0.pyi

@@ -63,3 +63,7 @@ assert_type(x_i32.device, object)
 # Check Attribute `.mT`
 assert_type(x_f32.mT, xpt.Array[dtype[Any]])
 assert_type(x_i32.mT, xpt.Array[dtype[Any]])
+
+# Check Attribute `.ndim`
+assert_type(x_f32.ndim, int)
+assert_type(x_i32.ndim, int)

tests/integration/test_numpy2p0.pyi

@@ -71,3 +71,8 @@ assert_type(x_b.device, object)
 assert_type(x_f32.mT, xpt.Array[np.dtype[F32]])
 assert_type(x_i32.mT, xpt.Array[np.dtype[I32]])
 assert_type(x_b.mT, xpt.Array[np.dtype[B]])
+
+# Check Attribute `.ndim`
+assert_type(x_f32.ndim, int)
+assert_type(x_i32.ndim, int)
+assert_type(x_b.ndim, int)