Skip to content

Commit f035d45

Browse files
d-v-bjhamman
andauthored
docs/add docstrings to synchronous API (#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 <joe@earthmover.io> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <joe@earthmover.io> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <joe@earthmover.io> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <joe@earthmover.io> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <joe@earthmover.io> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <joe@earthmover.io> * Update src/zarr/api/synchronous.py Co-authored-by: Joe Hamman <joe@earthmover.io> * remove doomed docstring tests * allow bool in create --------- Co-authored-by: Joe Hamman <joe@earthmover.io>
1 parent 4455726 commit f035d45

File tree

5 files changed

+652
-71
lines changed

5 files changed

+652
-71
lines changed

src/zarr/api/asynchronous.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -774,9 +774,9 @@ async def open_group(
774774

775775

776776
async def create(
777-
shape: ChunkCoords,
777+
shape: ChunkCoords | int,
778778
*, # Note: this is a change from v2
779-
chunks: ChunkCoords | None = None, # TODO: v2 allowed chunks=True
779+
chunks: ChunkCoords | int | None = None, # TODO: v2 allowed chunks=True
780780
dtype: npt.DTypeLike | None = None,
781781
compressor: dict[str, JSON] | None = None, # TODO: default and type change
782782
fill_value: Any | None = 0, # TODO: need type
@@ -798,7 +798,7 @@ async def create(
798798
meta_array: Any | None = None, # TODO: need type
799799
attributes: dict[str, JSON] | None = None,
800800
# v3 only
801-
chunk_shape: ChunkCoords | None = None,
801+
chunk_shape: ChunkCoords | int | None = None,
802802
chunk_key_encoding: (
803803
ChunkKeyEncoding
804804
| tuple[Literal["default"], Literal[".", "/"]]
@@ -1104,6 +1104,8 @@ async def open_array(
11041104
----------
11051105
store : Store or str
11061106
Store or path to directory in file system or name of zip file.
1107+
zarr_version : {2, 3, None}, optional
1108+
The zarr format to use when saving. Deprecated in favor of zarr_format.
11071109
zarr_format : {2, 3, None}, optional
11081110
The zarr format to use when saving.
11091111
path : str, optional

0 commit comments

Comments
 (0)