zarr.testing.store

Classes

StoreTests

Module Contents

class zarr.testing.store.StoreTests

Bases: Generic[S, B]

abstract get(store: S, key: str) → zarr.core.buffer.Buffer

Async:

Retrieve a value from a storage backend, by key. This should not use any store methods. Bypassing the store methods allows them to be tested.

open_kwargs(store_kwargs: dict[str, Any]) → dict[str, Any]

abstract set(store: S, key: str, value: zarr.core.buffer.Buffer) → None

Async:

Insert a value into a storage backend, with a specific key. This should not use any store methods. Bypassing the store methods allows them to be tested.

async store(open_kwargs: dict[str, Any]) → zarr.abc.store.Store

abstract store_kwargs() → dict[str, Any]

Kwargs for instantiating a store

async store_not_open(store_kwargs: dict[str, Any]) → zarr.abc.store.Store

async test_clear(store: S) → None

async test_delete(store: S) → None

async test_delete_dir(store: S) → None

async test_exists(store: S) → None

async test_get(

store: S,

key: str,

data: bytes,

byte_range: zarr.abc.store.ByteRequest,

) → None

Ensure that data can be read from the store using the store.get method.

async test_get_many(store: S) → None

Ensure that multiple keys can be retrieved at once with the _get_many method.

async test_get_not_open(store_not_open: S) → None

Ensure that data can be read from the store that isn’t yet open using the store.get method.

async test_get_partial_values(

store: S,

key_ranges: list[tuple[str, zarr.abc.store.ByteRequest]],

) → None

async test_get_raises(store: S) → None

Ensure that a ValueError is raise for invalid byte range syntax

async test_getsize(store: S, key: str, data: bytes) → None

Test the result of store.getsize().

async test_getsize_prefix(store: S) → None

Test the result of store.getsize_prefix().

async test_getsize_raises(store: S) → None

Test that getsize() raise a FileNotFoundError if the key doesn’t exist.

async test_is_empty(store: S) → None

async test_list(store: S) → None

async test_list_dir(store: S) → None

async test_list_empty_path(store: S) → None

Verify that list and list_prefix work correctly when path is an empty string, i.e. no unwanted replacement occurs.

async test_list_prefix(store: S) → None

Test that the list_prefix method works as intended. Given a prefix, it should return all the keys in storage that start with this prefix.

async test_read_only_store_raises(open_kwargs: dict[str, Any]) → None

async test_serializable_store(store: S) → None

async test_set(store: S, key: str, data: bytes) → None

Ensure that data can be written to the store using the store.set method.

async test_set_if_not_exists(store: S) → None

async test_set_many(store: S) → None

Test that a dict of key : value pairs can be inserted into the store via the _set_many method.

async test_set_not_open(store_not_open: S) → None

Ensure that data can be written to the store that’s not yet open using the store.set method.

async test_store_context_manager(open_kwargs: dict[str, Any]) → None

test_store_eq(store: S, store_kwargs: dict[str, Any]) → None

async test_store_open_read_only(open_kwargs: dict[str, Any], read_only: bool) → None

test_store_read_only(store: S) → None

abstract test_store_repr(store: S) → None

abstract test_store_supports_listing(store: S) → None

abstract test_store_supports_partial_writes(store: S) → None

abstract test_store_supports_writes(store: S) → None

test_store_type(store: S) → None

buffer_cls: type[B]

store_cls: type[S]