zarr.api.asynchronous

Functions

array(...)	Create an array filled with data.
consolidate_metadata(→ zarr.core.group.AsyncGroup)	Consolidate the metadata of all nodes in a hierarchy.
copy(→ tuple[int, int, int])
copy_all(→ tuple[int, int, int])
copy_store(→ tuple[int, int, int])
create(...)	Create an array.
create_array(...)	Create an array.
empty(...)	Create an empty array.
empty_like(...)	Create an empty array like a.
full(...)	Create an array, with fill_value being used as the default value for
full_like(...)	Create a filled array like a.
group(→ zarr.core.group.AsyncGroup)	Create a group.
load(→ zarr.core.buffer.NDArrayLike | dict[str, ...)	Load data from an array or group into memory.
ones(...)	Create an array, with one being used as the default value for
ones_like(...)	Create an array of ones like a.
open(...)	Convenience function to open a group or array using file-mode-like semantics.
open_array(...)	Open an array using file-mode-like semantics.
open_consolidated(→ zarr.core.group.AsyncGroup)	Alias for open_group() with use_consolidated=True.
open_group(→ zarr.core.group.AsyncGroup)	Open a group using file-mode-like semantics.
open_like(...)	Open a persistent array like a.
save(→ None)	Convenience function to save an array or group of arrays to the local file system.
save_array(→ None)	Convenience function to save a NumPy array to the local file system, following a
save_group(→ None)	Convenience function to save several NumPy arrays to the local file system, following a
tree(→ Any)	Provide a rich display of the hierarchy.
zeros(...)	Create an array, with zero being used as the default value for
zeros_like(...)	Create an array of zeros like a.

Module Contents

async zarr.api.asynchronous.array(

data: numpy.typing.ArrayLike,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an array filled with data.

Parameters:

dataarray_like

The data to fill the array with.

**kwargs

Passed through to create().

Returns:

arrayarray

The new array.

async zarr.api.asynchronous.consolidate_metadata(

store: zarr.storage.StoreLike,

path: str | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

) → zarr.core.group.AsyncGroup

Consolidate the metadata of all nodes in a hierarchy.

Upon completion, the metadata of the root node in the Zarr hierarchy will be updated to include all the metadata of child nodes.

Parameters:

storeStoreLike

The store-like object whose metadata you wish to consolidate.

pathstr, optional

A path to a group in the store to consolidate at. Only children below that group will be consolidated.

By default, the root node is used so all the metadata in the store is consolidated.

zarr_format{2, 3, None}, optional

The zarr format of the hierarchy. By default the zarr format is inferred.

Returns:

group: AsyncGroup

The group, with the consolidated_metadata field set to include the metadata of each child node.

async zarr.api.asynchronous.copy(*args: Any, **kwargs: Any) → tuple[int, int, int]

async zarr.api.asynchronous.copy_all(*args: Any, **kwargs: Any) → tuple[int, int, int]

async zarr.api.asynchronous.copy_store(*args: Any, **kwargs: Any) → tuple[int, int, int]

async zarr.api.asynchronous.create(

shape: zarr.core.common.ChunkCoords | int,

*,

chunks: zarr.core.common.ChunkCoords | int | None = None,

dtype: numpy.typing.DTypeLike | None = None,

compressor: dict[str, zarr.core.common.JSON] | None = None,

fill_value: Any | None = 0,

order: zarr.core.common.MemoryOrder | None = None,

store: str | zarr.storage.StoreLike | None = None,

synchronizer: Any | None = None,

overwrite: bool = False,

path: PathLike | None = None,

chunk_store: zarr.storage.StoreLike | None = None,

filters: list[dict[str, zarr.core.common.JSON]] | None = None,

cache_metadata: bool | None = None,

cache_attrs: bool | None = None,

read_only: bool | None = None,

object_codec: zarr.abc.codec.Codec | None = None,

dimension_separator: Literal['.', '/'] | None = None,

write_empty_chunks: bool | None = None,

zarr_version: zarr.core.common.ZarrFormat | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

meta_array: Any | None = None,

attributes: dict[str, zarr.core.common.JSON] | None = None,

chunk_shape: zarr.core.common.ChunkCoords | int | None = None,

chunk_key_encoding: zarr.core.chunk_key_encodings.ChunkKeyEncoding | tuple[Literal['default'], Literal['.', '/']] | tuple[Literal['v2'], Literal['.', '/']] | None = None,

codecs: collections.abc.Iterable[zarr.abc.codec.Codec | dict[str, zarr.core.common.JSON]] | None = None,

dimension_names: collections.abc.Iterable[str] | None = None,

storage_options: dict[str, Any] | None = None,

config: zarr.core.array_spec.ArrayConfig | zarr.core.array_spec.ArrayConfigLike | None = None,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an array.

Parameters:

shapeint or tuple of ints

Array shape.

chunksint or tuple of ints, optional

The shape of the array’s chunks. Zarr format 2 only. Zarr format 3 arrays should use chunk_shape instead. If not specified, default values are guessed based on the shape and dtype.

dtypestr or dtype, optional

NumPy dtype.

chunk_shapeint or tuple of ints, optional

The shape of the Array’s chunks (default is None). Zarr format 3 only. Zarr format 2 arrays should use chunks instead.

chunk_key_encodingChunkKeyEncoding, optional

A specification of how the chunk keys are represented in storage. Zarr format 3 only. Zarr format 2 arrays should use dimension_separator instead. Default is ("default", "/").

codecsSequence of Codecs or dicts, optional

An iterable of Codec or dict serializations of Codecs. The elements of this collection specify the transformation from array values to stored bytes. Zarr format 3 only. Zarr format 2 arrays should use filters and compressor instead.

If no codecs are provided, default codecs will be used:

• For numeric arrays, the default is BytesCodec and ZstdCodec.

• For Unicode strings, the default is VLenUTF8Codec and ZstdCodec.

• For bytes or objects, the default is VLenBytesCodec and ZstdCodec.

These defaults can be changed by modifying the value of array.v3_default_filters, array.v3_default_serializer and array.v3_default_compressors in zarr.core.config.

compressorCodec, optional

Primary compressor to compress chunk data. Zarr format 2 only. Zarr format 3 arrays should use codecs instead.

If neither compressor nor filters are provided, a default compressor will be used:

• For numeric arrays, the default is ZstdCodec.

• For Unicode strings, the default is VLenUTF8Codec.

• For bytes or objects, the default is VLenBytesCodec.

These defaults can be changed by modifying the value of array.v2_default_compressor in zarr.core.config.

fill_valueobject

Default value to use for uninitialized portions of the array.

order{‘C’, ‘F’}, optional

Deprecated in favor of the config keyword argument. Pass {'order': <value>} to create instead of using this parameter. Memory layout to be used within each chunk. If not specified, the array.order parameter in the global config will be used.

storeStore or str

Store or path to directory in file system or name of zip file.

synchronizerobject, optional

Array synchronizer.

overwritebool, optional

If True, delete all pre-existing data in store at path before creating the array.

pathstr, optional

Path under which array is stored.

chunk_storeMutableMapping, optional

Separate storage for chunks. If not provided, store will be used for storage of both chunks and metadata.

filterssequence of Codecs, optional

Sequence of filters to use to encode chunk data prior to compression. Zarr format 2 only. If no filters are provided, a default set of filters will be used. These defaults can be changed by modifying the value of array.v2_default_filters in zarr.core.config.

cache_metadatabool, optional

If True, array configuration metadata will be cached for the lifetime of the object. If False, array metadata will be reloaded prior to all data access and modification operations (may incur overhead depending on storage and data access pattern).

cache_attrsbool, optional

If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations.

read_onlybool, optional

True if array should be protected against modification.

object_codecCodec, optional

A codec to encode object arrays, only needed if dtype=object.

dimension_separator{‘.’, ‘/’}, optional

Separator placed between the dimensions of a chunk. Zarr format 2 only. Zarr format 3 arrays should use chunk_key_encoding instead. Default is “.”.

write_empty_chunksbool, optional

Deprecated in favor of the config keyword argument. Pass {'write_empty_chunks': <value>} to create instead of using this parameter. If True, all chunks will be stored regardless of their contents. If False, each chunk is compared to the array’s fill value prior to storing. If a chunk is uniformly equal to the fill value, then that chunk is not be stored, and the store entry for that chunk’s key is deleted.

zarr_format{2, 3, None}, optional

The zarr format to use when saving. Default is 3.

meta_arrayarray-like, optional

An array instance to use for determining arrays to create and return to users. Use numpy.empty(()) by default.

storage_optionsdict

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

configArrayConfig or ArrayConfigLike, optional

Runtime configuration of the array. If provided, will override the default values from zarr.config.array.

Returns:

zarray

The array.

async zarr.api.asynchronous.create_array(

store: str | zarr.storage.StoreLike,

*,

name: str | None = None,

shape: zarr.core.common.ShapeLike,

dtype: numpy.typing.DTypeLike,

chunks: zarr.core.common.ChunkCoords | Literal['auto'] = 'auto',

shards: ShardsLike | None = None,

filters: FiltersLike = 'auto',

compressors: CompressorsLike = 'auto',

serializer: SerializerLike = 'auto',

fill_value: Any | None = None,

order: zarr.core.common.MemoryOrder | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = 3,

attributes: dict[str, zarr.core.common.JSON] | None = None,

chunk_key_encoding: zarr.core.chunk_key_encodings.ChunkKeyEncoding | zarr.core.chunk_key_encodings.ChunkKeyEncodingLike | None = None,

dimension_names: collections.abc.Iterable[str] | None = None,

storage_options: dict[str, Any] | None = None,

overwrite: bool = False,

config: zarr.core.array_spec.ArrayConfig | zarr.core.array_spec.ArrayConfigLike | None = None,

) → AsyncArray[zarr.core.metadata.ArrayV2Metadata] | AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an array.

Parameters:

storestr or Store

Store or path to directory in file system or name of zip file.

namestr or None, optional

The name of the array within the store. If name is None, the array will be located at the root of the store.

shapeChunkCoords

Shape of the array.

dtypenpt.DTypeLike

Data type of the array.

chunksChunkCoords, optional

Chunk shape of the array. If not specified, default are guessed based on the shape and dtype.

shardsChunkCoords, optional

Shard shape of the array. The default value of None results in no sharding at all.

filtersIterable[Codec], optional

Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes.

For Zarr format 3, a “filter” is a codec that takes an array and returns an array, and these values must be instances of ArrayArrayCodec, or dict representations of ArrayArrayCodec. If no filters are provided, a default set of filters will be used. These defaults can be changed by modifying the value of array.v3_default_filters in zarr.core.config. Use None to omit default filters.

For Zarr format 2, a “filter” can be any numcodecs codec; you should ensure that the the order if your filters is consistent with the behavior of each filter. If no filters are provided, a default set of filters will be used. These defaults can be changed by modifying the value of array.v2_default_filters in zarr.core.config. Use None to omit default filters.

compressorsIterable[Codec], optional

List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes.

For Zarr format 3, a “compressor” is a codec that takes a bytestream, and returns another bytestream. Multiple compressors my be provided for Zarr format 3. If no compressors are provided, a default set of compressors will be used. These defaults can be changed by modifying the value of array.v3_default_compressors in zarr.core.config. Use None to omit default compressors.

For Zarr format 2, a “compressor” can be any numcodecs codec. Only a single compressor may be provided for Zarr format 2. If no compressor is provided, a default compressor will be used. in zarr.core.config. Use None to omit the default compressor.

serializerdict[str, JSON] | ArrayBytesCodec, optional

Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. If no serializer is provided, a default serializer will be used. These defaults can be changed by modifying the value of array.v3_default_serializer in zarr.core.config.

fill_valueAny, optional

Fill value for the array.

order{“C”, “F”}, optional

The memory of the array (default is “C”). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the config parameter, e.g. {'config': 'C'}. If no order is provided, a default order will be used. This default can be changed by modifying the value of array.order in zarr.core.config.

zarr_format{2, 3}, optional

The zarr format to use when saving.

attributesdict, optional

Attributes for the array.

chunk_key_encodingChunkKeyEncoding, optional

A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is {"name": "default", "separator": "/"}}. For Zarr format 2, the default is {"name": "v2", "separator": "."}}.

dimension_namesIterable[str], optional

The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter.

storage_optionsdict, optional

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

overwritebool, default False

Whether to overwrite an array with the same name in the store, if one exists.

configArrayConfig or ArrayConfigLike, optional

Runtime configuration for the array.

Returns:

AsyncArray

The array.

Examples

>>> import zarr
>>> store = zarr.storage.MemoryStore(mode='w')
>>> async_arr = await zarr.api.asynchronous.create_array(
>>>     store=store,
>>>     shape=(100,100),
>>>     chunks=(10,10),
>>>     dtype='i4',
>>>     fill_value=0)
<AsyncArray memory://140349042942400 shape=(100, 100) dtype=int32>

async zarr.api.asynchronous.empty(

shape: zarr.core.common.ChunkCoords,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an empty array.

Parameters:

shapeint or tuple of int

Shape of the empty array.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Notes

The contents of an empty Zarr array are not defined. On attempting to retrieve data from an empty Zarr array, any values may be returned, and these are not guaranteed to be stable from one access to the next.

async zarr.api.asynchronous.empty_like(

a: ArrayLike,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an empty array like a.

Parameters:

aarray-like

The array to create an empty array like.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

async zarr.api.asynchronous.full(

shape: zarr.core.common.ChunkCoords,

fill_value: Any,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an array, with fill_value being used as the default value for uninitialized portions of the array.

Parameters:

shapeint or tuple of int

Shape of the empty array.

fill_valuescalar

Fill value.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

async zarr.api.asynchronous.full_like(

a: ArrayLike,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create a filled array like a.

Parameters:

aarray-like

The array to create an empty array like.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

async zarr.api.asynchronous.group(

*,

store: zarr.storage.StoreLike | None = None,

overwrite: bool = False,

chunk_store: zarr.storage.StoreLike | None = None,

cache_attrs: bool | None = None,

synchronizer: Any | None = None,

path: str | None = None,

zarr_version: zarr.core.common.ZarrFormat | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

meta_array: Any | None = None,

attributes: dict[str, zarr.core.common.JSON] | None = None,

storage_options: dict[str, Any] | None = None,

) → zarr.core.group.AsyncGroup

Create a group.

Parameters:

storeStore or str, optional

Store or path to directory in file system.

overwritebool, optional

If True, delete any pre-existing data in store at path before creating the group.

chunk_storeStore, optional

Separate storage for chunks. If not provided, store will be used for storage of both chunks and metadata.

cache_attrsbool, optional

If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations.

synchronizerobject, optional

Array synchronizer.

pathstr, optional

Group path within store.

meta_arrayarray-like, optional

An array instance to use for determining arrays to create and return to users. Use numpy.empty(()) by default.

zarr_format{2, 3, None}, optional

The zarr format to use when saving.

storage_optionsdict

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

Returns:

ggroup

The new group.

async zarr.api.asynchronous.load(

*,

store: zarr.storage.StoreLike,

path: str | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

zarr_version: zarr.core.common.ZarrFormat | None = None,

) → zarr.core.buffer.NDArrayLike | dict[str, zarr.core.buffer.NDArrayLike]

Load data from an array or group into memory.

Parameters:

storeStore or str

Store or path to directory in file system or name of zip file.

pathstr or None, optional

The path within the store from which to load.

Returns:

out

If the path contains an array, out will be a numpy array. If the path contains a group, out will be a dict-like object where keys are array names and values are numpy arrays.

See also

save, savez

Notes

If loading data from a group of arrays, data will not be immediately loaded into memory. Rather, arrays will be loaded into memory as they are requested.

async zarr.api.asynchronous.ones(

shape: zarr.core.common.ChunkCoords,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an array, with one being used as the default value for uninitialized portions of the array.

Parameters:

shapeint or tuple of int

Shape of the empty array.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

async zarr.api.asynchronous.ones_like(

a: ArrayLike,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an array of ones like a.

Parameters:

aarray-like

The array to create an empty array like.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

async zarr.api.asynchronous.open(

*,

store: zarr.storage.StoreLike | None = None,

mode: zarr.core.common.AccessModeLiteral = 'a',

zarr_version: zarr.core.common.ZarrFormat | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

path: str | None = None,

storage_options: dict[str, Any] | None = None,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata] | zarr.core.group.AsyncGroup

Convenience function to open a group or array using file-mode-like semantics.

Parameters:

storeStore or str, optional

Store or path to directory in file system or name of zip file.

mode{‘r’, ‘r+’, ‘a’, ‘w’, ‘w-‘}, optional

Persistence mode: ‘r’ means read only (must exist); ‘r+’ means read/write (must exist); ‘a’ means read/write (create if doesn’t exist); ‘w’ means create (overwrite if exists); ‘w-’ means create (fail if exists).

zarr_format{2, 3, None}, optional

The zarr format to use when saving.

pathstr or None, optional

The path within the store to open.

storage_optionsdict

If the store is backed by an fsspec-based implementation, then this dict will be passed to the Store constructor for that implementation. Ignored otherwise.

**kwargs

Additional parameters are passed through to zarr.creation.open_array() or zarr.hierarchy.open_group().

Returns:

zarray or group

Return type depends on what exists in the given store.

async zarr.api.asynchronous.open_array(

*,

store: zarr.storage.StoreLike | None = None,

zarr_version: zarr.core.common.ZarrFormat | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

path: PathLike = '',

storage_options: dict[str, Any] | None = None,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Open an array using file-mode-like semantics.

Parameters:

storeStore 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.

pathstr, optional

Path in store to array.

storage_optionsdict

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

**kwargs

Any keyword arguments to pass to create().

Returns:

AsyncArray

The opened array.

async zarr.api.asynchronous.open_consolidated(

*args: Any,

use_consolidated: Literal[True] = True,

**kwargs: Any,

) → zarr.core.group.AsyncGroup

Alias for open_group() with use_consolidated=True.

async zarr.api.asynchronous.open_group(

store: zarr.storage.StoreLike | None = None,

*,

mode: zarr.core.common.AccessModeLiteral = 'a',

cache_attrs: bool | None = None,

synchronizer: Any = None,

path: str | None = None,

chunk_store: zarr.storage.StoreLike | None = None,

storage_options: dict[str, Any] | None = None,

zarr_version: zarr.core.common.ZarrFormat | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

meta_array: Any | None = None,

attributes: dict[str, zarr.core.common.JSON] | None = None,

use_consolidated: bool | str | None = None,

) → zarr.core.group.AsyncGroup

Open a group using file-mode-like semantics.

Parameters:

storeStore, str, or mapping, optional

Store or path to directory in file system or name of zip file.

Strings are interpreted as paths on the local file system and used as the root argument to zarr.storage.LocalStore.

Dictionaries are used as the store_dict argument in zarr.storage.MemoryStore`.

By default (store=None) a new zarr.storage.MemoryStore is created.

mode{‘r’, ‘r+’, ‘a’, ‘w’, ‘w-‘}, optional

Persistence mode: ‘r’ means read only (must exist); ‘r+’ means read/write (must exist); ‘a’ means read/write (create if doesn’t exist); ‘w’ means create (overwrite if exists); ‘w-’ means create (fail if exists).

cache_attrsbool, optional

If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations.

synchronizerobject, optional

Array synchronizer.

pathstr, optional

Group path within store.

chunk_storeStore or str, optional

Store or path to directory in file system or name of zip file.

storage_optionsdict

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

meta_arrayarray-like, optional

An array instance to use for determining arrays to create and return to users. Use numpy.empty(()) by default.

attributesdict

A dictionary of JSON-serializable values with user-defined attributes.

use_consolidatedbool or str, default None

Whether to use consolidated metadata.

By default, consolidated metadata is used if it’s present in the store (in the zarr.json for Zarr format 3 and in the .zmetadata file for Zarr format 2).

To explicitly require consolidated metadata, set use_consolidated=True, which will raise an exception if consolidated metadata is not found.

To explicitly not use consolidated metadata, set use_consolidated=False, which will fall back to using the regular, non consolidated metadata.

Zarr format 2 allowed configuring the key storing the consolidated metadata (.zmetadata by default). Specify the custom key as use_consolidated to load consolidated metadata from a non-default key.

Returns:

ggroup

The new group.

async zarr.api.asynchronous.open_like(

a: ArrayLike,

path: str,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata]

Open a persistent array like a.

Parameters:

aArray

The shape and data-type of a define these same attributes of the returned array.

pathstr

The path to the new array.

**kwargs

Any keyword arguments to pass to the array constructor.

Returns:

AsyncArray

The opened array.

async zarr.api.asynchronous.save(

store: zarr.storage.StoreLike,

*args: zarr.core.buffer.NDArrayLike,

zarr_version: zarr.core.common.ZarrFormat | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

path: str | None = None,

**kwargs: Any,

) → None

Convenience function to save an array or group of arrays to the local file system.

Parameters:

storeStore or str

Store or path to directory in file system or name of zip file.

*argsndarray

NumPy arrays with data to save.

zarr_format{2, 3, None}, optional

The zarr format to use when saving.

pathstr or None, optional

The path within the group where the arrays will be saved.

**kwargs

NumPy arrays with data to save.

async zarr.api.asynchronous.save_array(

store: zarr.storage.StoreLike,

arr: zarr.core.buffer.NDArrayLike,

*,

zarr_version: zarr.core.common.ZarrFormat | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

path: str | None = None,

storage_options: dict[str, Any] | None = None,

**kwargs: Any,

) → None

Convenience function to save a NumPy array to the local file system, following a similar API to the NumPy save() function.

Parameters:

storeStore or str

Store or path to directory in file system or name of zip file.

arrndarray

NumPy array with data to save.

zarr_format{2, 3, None}, optional

The zarr format to use when saving (default is 3 if not specified).

pathstr or None, optional

The path within the store where the array will be saved.

storage_optionsdict

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

**kwargs

Passed through to create(), e.g., compressor.

async zarr.api.asynchronous.save_group(

store: zarr.storage.StoreLike,

*args: zarr.core.buffer.NDArrayLike,

zarr_version: zarr.core.common.ZarrFormat | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

path: str | None = None,

storage_options: dict[str, Any] | None = None,

**kwargs: zarr.core.buffer.NDArrayLike,

) → None

Convenience function to save several NumPy arrays to the local file system, following a similar API to the NumPy savez()/savez_compressed() functions.

Parameters:

storeStore or str

Store or path to directory in file system or name of zip file.

*argsndarray

NumPy arrays with data to save.

zarr_format{2, 3, None}, optional

The zarr format to use when saving.

pathstr or None, optional

Path within the store where the group will be saved.

storage_optionsdict

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

**kwargs

NumPy arrays with data to save.

async zarr.api.asynchronous.tree(

grp: zarr.core.group.AsyncGroup,

expand: bool | None = None,

level: int | None = None,

) → Any

Provide a rich display of the hierarchy.

Deprecated since version 3.0.0: zarr.tree() is deprecated and will be removed in a future release. Use group.tree() instead.

Parameters:

grpGroup

Zarr or h5py group.

expandbool, optional

Only relevant for HTML representation. If True, tree will be fully expanded.

levelint, optional

Maximum depth to descend into hierarchy.

Returns:

TreeRepr

A pretty-printable object displaying the hierarchy.

async zarr.api.asynchronous.zeros(

shape: zarr.core.common.ChunkCoords,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an array, with zero being used as the default value for uninitialized portions of the array.

Parameters:

shapeint or tuple of int

Shape of the empty array.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

async zarr.api.asynchronous.zeros_like(

a: ArrayLike,

**kwargs: Any,

) → zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV2Metadata] | zarr.core.array.AsyncArray[zarr.core.metadata.ArrayV3Metadata]

Create an array of zeros like a.

Parameters:

aarray-like

The array to create an empty array like.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.