compression -> compressors, shard_shape -> shards, chunk_shape -> chunks

Author: d-v-b

src/zarr/core/group.py

@@ -1001,10 +1001,10 @@ async def create_array(
         *,
         shape: ShapeLike,
         dtype: npt.DTypeLike,
-        chunk_shape: ChunkCoords | Literal["auto"] = "auto",
-        shard_shape: ChunkCoords | Literal["auto"] | None = None,
+        chunks: ChunkCoords | Literal["auto"] = "auto",
+        shards: ChunkCoords | Literal["auto"] | None = None,
         filters: Iterable[dict[str, JSON] | Codec] = (),
-        compression: Iterable[dict[str, JSON] | Codec] = (),
+        compressors: Iterable[dict[str, JSON] | Codec] = (),
         fill_value: Any | None = 0,
         order: MemoryOrder | None = "C",
         attributes: dict[str, JSON] | None = None,
@@ -1028,9 +1028,9 @@ async def create_array(
             Shape of the array.
         dtype : npt.DTypeLike
             Data type of the array.
-        chunk_shape : ChunkCoords | Literal["auto"], default is "auto".
+        chunks : ChunkCoords | Literal["auto"], default is "auto".
             Chunk shape of the array.
-        shard_shape : ChunkCoords, optional
+        shards : ChunkCoords, optional
             Shard shape of the array. The default value of ``None`` results in no sharding at all.
         filters : Iterable[Codec], optional
             List of filters to apply to the array.
@@ -1064,10 +1064,10 @@ async def create_array(
             name=name,
             shape=shape,
             dtype=dtype,
-            chunks=chunk_shape,
-            shards=shard_shape,
+            chunks=chunks,
+            shards=shards,
             filters=filters,
-            compressors=compression,
+            compressors=compressors,
             fill_value=fill_value,
             order=order,
             zarr_format=self.metadata.zarr_format,
@@ -1725,8 +1725,8 @@ def __getitem__(self, path: str) -> Array | Group:
         --------
         >>> import zarr
         >>> group = Group.from_store(zarr.storage.MemoryStore()
-        >>> group.create_array(name="subarray", shape=(10,), chunk_shape=(10,))
-        >>> group.create_group(name="subgroup").create_array(name="subarray", shape=(10,), chunk_shape=(10,))
+        >>> group.create_array(name="subarray", shape=(10,), chunks=(10,))
+        >>> group.create_group(name="subgroup").create_array(name="subarray", shape=(10,), chunks=(10,))
         >>> group["subarray"]
         <Array memory://132270269438272/subarray shape=(10,) dtype=float64>
         >>> group["subgroup"]
@@ -1760,7 +1760,7 @@ def get(self, path: str, default: DefaultT | None = None) -> Array | Group | Def
         --------
         >>> import zarr
         >>> group = Group.from_store(zarr.storage.MemoryStore()
-        >>> group.create_array(name="subarray", shape=(10,), chunk_shape=(10,))
+        >>> group.create_array(name="subarray", shape=(10,), chunks=(10,))
         >>> group.create_group(name="subgroup")
         >>> group.get("subarray")
         <Array memory://132270269438272/subarray shape=(10,) dtype=float64>
@@ -1786,7 +1786,7 @@ def __delitem__(self, key: str) -> None:
         --------
         >>> import zarr
         >>> group = Group.from_store(zarr.storage.MemoryStore()
-        >>> group.create_array(name="subarray", shape=(10,), chunk_shape=(10,))
+        >>> group.create_array(name="subarray", shape=(10,), chunks=(10,))
         >>> del group["subarray"]
         >>> "subarray" in group
         False
@@ -1801,8 +1801,8 @@ def __iter__(self) -> Iterator[str]:
         >>> g1 = zarr.group()
         >>> g2 = g1.create_group('foo')
         >>> g3 = g1.create_group('bar')
-        >>> d1 = g1.create_array('baz', shape=(10,), chunk_shape=(10,))
-        >>> d2 = g1.create_array('quux', shape=(10,), chunk_shape=(10,))
+        >>> d1 = g1.create_array('baz', shape=(10,), chunks=(10,))
+        >>> d2 = g1.create_array('quux', shape=(10,), chunks=(10,))
         >>> for name in g1:
         ...     print(name)
         baz
@@ -1993,8 +1993,8 @@ def keys(self) -> Generator[str, None]:
         >>> g1 = zarr.group()
         >>> g2 = g1.create_group('foo')
         >>> g3 = g1.create_group('bar')
-        >>> d1 = g1.create_array('baz', shape=(10,), chunk_shape=(10,))
-        >>> d2 = g1.create_array('quux', shape=(10,), chunk_shape=(10,))
+        >>> d1 = g1.create_array('baz', shape=(10,), chunks=(10,))
+        >>> d2 = g1.create_array('quux', shape=(10,), chunks=(10,))
         >>> for name in g1.keys():
         ...     print(name)
         baz
@@ -2012,7 +2012,7 @@ def __contains__(self, member: str) -> bool:
         >>> import zarr
         >>> g1 = zarr.group()
         >>> g2 = g1.create_group('foo')
-        >>> d1 = g1.create_array('bar', shape=(10,), chunk_shape=(10,))
+        >>> d1 = g1.create_array('bar', shape=(10,), chunks=(10,))
         >>> 'foo' in g1
         True
         >>> 'bar' in g1
@@ -2075,7 +2075,7 @@ def arrays(self) -> Generator[tuple[str, Array], None]:
         --------
         >>> import zarr
         >>> group = zarr.group()
-        >>> group.create_array("subarray", shape=(10,), chunk_shape=(10,))
+        >>> group.create_array("subarray", shape=(10,), chunks=(10,))
         >>> for name, subarray in group.arrays():
         ...     print(name, subarray)
         subarray <Array memory://140198565357056/subarray shape=(10,) dtype=float64>
@@ -2090,7 +2090,7 @@ def array_keys(self) -> Generator[str, None]:
         --------
         >>> import zarr
         >>> group = zarr.group()
-        >>> group.create_array("subarray", shape=(10,), chunk_shape=(10,))
+        >>> group.create_array("subarray", shape=(10,), chunks=(10,))
         >>> for name in group.array_keys():
         ...     print(name)
         subarray
@@ -2106,7 +2106,7 @@ def array_values(self) -> Generator[Array, None]:
         --------
         >>> import zarr
         >>> group = zarr.group()
-        >>> group.create_array("subarray", shape=(10,), chunk_shape=(10,))
+        >>> group.create_array("subarray", shape=(10,), chunks=(10,))
         >>> for subarray in group.array_values():
         ...     print(subarray)
         <Array memory://140198565357056/subarray shape=(10,) dtype=float64>
@@ -2196,10 +2196,10 @@ def create_array(
         *,
         shape: ShapeLike,
         dtype: npt.DTypeLike,
-        chunk_shape: ChunkCoords | Literal["auto"] = "auto",
-        shard_shape: ChunkCoords | None = None,
+        chunks: ChunkCoords | Literal["auto"] = "auto",
+        shards: ChunkCoords | None = None,
         filters: Iterable[dict[str, JSON] | Codec] | Literal["auto"] = "auto",
-        compression: Iterable[dict[str, JSON] | Codec] | Codec | Literal["auto"] = "auto",
+        compressors: Iterable[dict[str, JSON] | Codec] | Codec | Literal["auto"] = "auto",
         fill_value: Any | None = 0,
         order: MemoryOrder | None = "C",
         attributes: dict[str, JSON] | None = None,
@@ -2216,16 +2216,16 @@ def create_array(
 
         Parameters
         ----------
-        path : str
+        name : str
             The name of the array relative to the group. If ``path`` is ``None``, the array will be located
             at the root of the store.
         shape : ChunkCoords
             Shape of the array.
         dtype : npt.DTypeLike
             Data type of the array.
-        chunk_shape : ChunkCoords | Literal["auto"], default is "auto"
+        chunks : ChunkCoords | Literal["auto"], default is "auto"
             Chunk shape of the array.
-        shard_shape : ChunkCoords, optional
+        shards : ChunkCoords, optional
             Shard shape of the array. The default value of ``None`` results in no sharding at all.
         filters : Iterable[Codec], optional
             List of filters to apply to the array.
@@ -2260,12 +2260,12 @@ def create_array(
                     name=name,
                     shape=shape,
                     dtype=dtype,
-                    chunk_shape=chunk_shape,
-                    shard_shape=shard_shape,
+                    chunks=chunks,
+                    shards=shards,
                     fill_value=fill_value,
                     attributes=attributes,
                     chunk_key_encoding=chunk_key_encoding,
-                    compression=compression,
+                    compressors=compressors,
                     dimension_names=dimension_names,
                     order=order,
                     filters=filters,
@@ -2530,10 +2530,10 @@ def array(
         *,
         shape: ShapeLike,
         dtype: npt.DTypeLike,
-        chunk_shape: ChunkCoords | Literal["auto"] = "auto",
-        shard_shape: ChunkCoords | Literal["auto"] | None = None,
+        chunks: ChunkCoords | Literal["auto"] = "auto",
+        shards: ChunkCoords | Literal["auto"] | None = None,
         filters: Iterable[dict[str, JSON] | Codec] = (),
-        compression: Iterable[dict[str, JSON] | Codec] = (),
+        compressors: Iterable[dict[str, JSON] | Codec] = (),
         fill_value: Any | None = 0,
         order: MemoryOrder | None = "C",
         attributes: dict[str, JSON] | None = None,
@@ -2550,16 +2550,16 @@ def array(
 
         Parameters
         ----------
-        path : str
+        name : str
             The name of the array relative to the group. If ``path`` is ``None``, the array will be located
             at the root of the store.
         shape : ChunkCoords
             Shape of the array.
         dtype : npt.DTypeLike
             Data type of the array.
-        chunk_shape : ChunkCoords
+        chunks : ChunkCoords
             Chunk shape of the array.
-        shard_shape : ChunkCoords, optional
+        shards : ChunkCoords, optional
             Shard shape of the array. The default value of ``None`` results in no sharding at all.
         filters : Iterable[Codec], optional
             List of filters to apply to the array.
@@ -2594,12 +2594,12 @@ def array(
                     name=name,
                     shape=shape,
                     dtype=dtype,
-                    chunk_shape=chunk_shape,
-                    shard_shape=shard_shape,
+                    chunks=chunks,
+                    shards=shards,
                     fill_value=fill_value,
                     attributes=attributes,
                     chunk_key_encoding=chunk_key_encoding,
-                    compression=compression,
+                    compressors=compressors,
                     dimension_names=dimension_names,
                     order=order,
                     filters=filters,

tests/test_api.py

@@ -1125,11 +1125,11 @@ async def test_create_array_v3(store: MemoryStore) -> None:
         store=store,
         dtype="uint8",
         shape=(10,),
-        shard_shape=(4,),
-        chunk_shape=(4,),
+        shards=(4,),
+        chunks=(4,),
         zarr_format=3,
         filters=(TransposeCodec(order=(0,)),),
-        compression=ZstdCodec(level=3),
+        compressors=ZstdCodec(level=3),
     )
 
 
@@ -1143,9 +1143,9 @@ async def test_create_array_v2(store: MemoryStore) -> None:
         store=store,
         dtype=dtype,
         shape=(10,),
-        shard_shape=None,
-        chunk_shape=(4,),
+        shards=None,
+        chunks=(4,),
         zarr_format=2,
         filters=(Delta(dtype=dtype),),
-        compression=Zstd(level=3),
+        compressors=Zstd(level=3),
     )

tests/test_array.py

@@ -925,6 +925,6 @@ def test_auto_partition_auto_shards(
             expected_shards += (cs,)
 
     auto_shards, _ = _auto_partition(
-        array_shape=array_shape, chunk_shape=chunk_shape, shard_shape="auto", dtype=dtype
+        array_shape=array_shape, chunks=chunk_shape, shards="auto", dtype=dtype
     )
     assert auto_shards == expected_shards

tests/test_group.py

@@ -874,9 +874,7 @@ async def test_asyncgroup_getitem(store: Store, zarr_format: ZarrFormat) -> None
     agroup = await AsyncGroup.from_store(store=store, zarr_format=zarr_format)
 
     array_name = "sub_array"
-    sub_array = await agroup.create_array(
-        name=array_name, shape=(10,), dtype="uint8", chunk_shape=(2,)
-    )
+    sub_array = await agroup.create_array(name=array_name, shape=(10,), dtype="uint8", chunks=(2,))
     assert await agroup.getitem(array_name) == sub_array
 
     sub_group_path = "sub_group"
@@ -898,7 +896,7 @@ async def test_asyncgroup_delitem(store: Store, zarr_format: ZarrFormat) -> None
         name=array_name,
         shape=(10,),
         dtype="uint8",
-        chunk_shape=(2,),
+        chunks=(2,),
         attributes={"foo": 100},
     )
     await agroup.delitem(array_name)
@@ -964,7 +962,7 @@ async def test_asyncgroup_create_array(
         name=sub_node_path,
         shape=shape,
         dtype=dtype,
-        chunk_shape=chunk_shape,
+        chunks=chunk_shape,
         attributes=attributes,
     )
     assert isinstance(subnode, AsyncArray)
@@ -1105,7 +1103,7 @@ async def test_require_group(store: LocalStore | MemoryStore, zarr_format: ZarrF
         assert foo_group.attrs == {}
 
     _ = await foo_group.create_array(
-        "bar", shape=(10,), dtype="uint8", chunk_shape=(2,), attributes={"foo": 100}
+        "bar", shape=(10,), dtype="uint8", chunks=(2,), attributes={"foo": 100}
     )
 
     # test that overwriting a group w/ children fails