Skip to content

CodecChain

zarrista.codec

Zarr v3 codecs for array-to-array, array-to-bytes, and bytes-to-bytes transforms.

zarrista.codec.CodecOptions

Bases: TypedDict

Per-operation codec options for encoding and decoding.

These control runtime behaviour such as concurrency limits and checksum validation. They are passed as keyword arguments to the array read/write methods, e.g. arr.retrieve_chunk([0, 0], validate_checksums=False). All keys are optional; omitted keys fall back to the defaults noted below.

Not importable at runtime

To use this type hint in your code, import it within a TYPE_CHECKING block:

from __future__ import annotations
from typing import TYPE_CHECKING
if TYPE_CHECKING:
    from zarrista.codec import CodecOptions

chunk_concurrent_minimum instance-attribute

chunk_concurrent_minimum: int

Preferred minimum chunk concurrency for multi-chunk operations. The concurrency of internal codecs is adjusted to accommodate the chunk concurrency in accordance with concurrent_target. Defaults to 4.

concurrent_target instance-attribute

concurrent_target: int

Preferred number of concurrent operations. Defaults to the number of threads available to Rayon.

experimental_partial_encoding instance-attribute

experimental_partial_encoding: bool

Whether to use experimental partial encoding. Defaults to False.

store_empty_chunks instance-attribute

store_empty_chunks: bool

Whether to store chunks that are entirely the fill value. Defaults to False.

validate_checksums instance-attribute

validate_checksums: bool

Whether to validate checksums when decoding. Defaults to True.