✨ HasNDim

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

Author: nstarman

src/array_api_typing/__init__.py

@@ -6,6 +6,7 @@
     "HasDType",
     "HasDevice",
     "HasMatrixTranspose",
+    "HasNDim",
     "__version__",
     "__version_tuple__",
 )
@@ -16,5 +17,6 @@
     HasDevice,
     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,6 +101,20 @@ 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],

tests/integration/test_numpy1p0.pyi

@@ -53,6 +53,13 @@ _: xpt.HasMatrixTranspose = nparr
 _: xpt.HasMatrixTranspose = nparr_i32
 _: xpt.HasMatrixTranspose = nparr_f32
 
+# =========================================================
+# `xpt.HasNDim`
+
+_: xpt.HasNDim = nparr
+_: xpt.HasNDim = nparr_i32
+_: xpt.HasNDim = nparr_f32
+
 # =========================================================
 # `xpt.Array`
 

tests/integration/test_numpy2p0.pyi

@@ -61,6 +61,14 @@ _: xpt.HasMatrixTranspose = nparr_i32
 _: xpt.HasMatrixTranspose = nparr_f32
 _: xpt.HasMatrixTranspose = nparr_b
 
+# =========================================================
+# `xpt.HasNDim`
+
+_: xpt.HasNDim = nparr
+_: xpt.HasNDim = nparr_i32
+_: xpt.HasNDim = nparr_f32
+_: xpt.HasNDim = nparr_b
+
 # =========================================================
 # `xpt.Array`