docs/add docstrings to synchronous API (zarr-developers#2549)

* add docstrings and complete function signatures to synchronous api, and tests for the above * clean up types and docstrings * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <[email protected]> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <[email protected]> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <[email protected]> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <[email protected]> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <[email protected]> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <[email protected]> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <[email protected]> * remove doomed docstring tests * allow bool in create --------- Co-authored-by: Joe Hamman <[email protected]>
jhamman · Dec 18, 2024 · f035d45 · f035d45
1 parent 4455726
commit f035d45
Show file tree

Hide file tree

Showing 5 changed files with 652 additions and 71 deletions.
diff --git a/src/zarr/api/asynchronous.py b/src/zarr/api/asynchronous.py
@@ -774,9 +774,9 @@ async def open_group(
 
 
 async def create(
-    shape: ChunkCoords,
+    shape: ChunkCoords | int,
     *,  # Note: this is a change from v2
-    chunks: ChunkCoords | None = None,  # TODO: v2 allowed chunks=True
+    chunks: ChunkCoords | int | None = None,  # TODO: v2 allowed chunks=True
     dtype: npt.DTypeLike | None = None,
     compressor: dict[str, JSON] | None = None,  # TODO: default and type change
     fill_value: Any | None = 0,  # TODO: need type
@@ -798,7 +798,7 @@ async def create(
     meta_array: Any | None = None,  # TODO: need type
     attributes: dict[str, JSON] | None = None,
     # v3 only
-    chunk_shape: ChunkCoords | None = None,
+    chunk_shape: ChunkCoords | int | None = None,
     chunk_key_encoding: (
         ChunkKeyEncoding
         | tuple[Literal["default"], Literal[".", "/"]]
@@ -1104,6 +1104,8 @@ async def open_array(
     ----------
     store : Store or str
         Store or path to directory in file system or name of zip file.
+    zarr_version : {2, 3, None}, optional
+        The zarr format to use when saving. Deprecated in favor of zarr_format.
     zarr_format : {2, 3, None}, optional
         The zarr format to use when saving.
     path : str, optional