feat: add max rank to inspection API capabilities

kgryte · web-flow · commit 6a5767aebf51 · 2024-05-01T21:01:57.000-07:00
PR-URL: #763 Closes: #694 Reviewed-by: Ralf Gommers <ralf.gommers@gmail.com> Reviewed-by: Leo Fang <leo80042@gmail.com>
diff --git a/src/array_api_stubs/_draft/_types.py b/src/array_api_stubs/_draft/_types.py
@@ -140,5 +140,10 @@ def dtypes(
     total=False,
 )
 Capabilities = TypedDict(
-    "Capabilities", {"boolean indexing": bool, "data-dependent shapes": bool}
+    "Capabilities",
+    {
+        "boolean indexing": bool,
+        "data-dependent shapes": bool,
+        "max rank": Optional[int],
+    },
 )
diff --git a/src/array_api_stubs/_draft/info.py b/src/array_api_stubs/_draft/info.py
@@ -56,6 +56,7 @@ def capabilities() -> Capabilities:
 
     -   `"boolean indexing"`: boolean indicating whether an array library supports boolean indexing. If a conforming implementation fully supports boolean indexing in compliance with this specification (see :ref:`indexing`), the corresponding dictionary value must be ``True``; otherwise, the value must be ``False``.
     -   `"data-dependent shapes"`: boolean indicating whether an array library supports data-dependent output shapes. If a conforming implementation fully supports all APIs included in this specification (excluding boolean indexing) which have data-dependent output shapes, as explicitly demarcated throughout the specification, the corresponding dictionary value must be ``True``; otherwise, the value must be ``False``.
+    -   `"max rank"`: maximum number of supported dimensions. If a conforming implementation supports arrays having an arbitrary number of dimensions (potentially infinite), the corresponding dictionary value must be ``None``; otherwise, the value must be a finite integer.
 
     Returns
     -------

Original file line number	Diff line number	Diff line change
`@@ -140,5 +140,10 @@ def dtypes(`
`140`	`140`	`total=False,`
`141`	`141`	`)`
`142`	`142`	`Capabilities = TypedDict(`
`143`		`- "Capabilities", {"boolean indexing": bool, "data-dependent shapes": bool}`
	`143`	`+ "Capabilities",`
	`144`	`+ {`
	`145`	`+ "boolean indexing": bool,`
	`146`	`+ "data-dependent shapes": bool,`
	`147`	`+ "max rank": Optional[int],`
	`148`	`+ },`
`144`	`149`	`)`