Group

zarrista.Group

A Zarr group.

attrs property

attrs: dict[str, JSONValue]

The group's user attributes as a dict.

consolidated_metadata property

consolidated_metadata: ConsolidatedMetadataV3 | None

The consolidated metadata, if present in the group metadata.

metadata property

metadata: GroupMetadataV3

The group's full Zarr v3 metadata.

path property

path: str

The group's path in the store.

__getitem__

__getitem__(name: str) -> Array | Group

Open a direct child array or group by name.

array_keys

array_keys() -> list[str]

Names of the direct child arrays.

child

child(name: str) -> Array | Group

Open a direct child array or group by name.

child_array_paths

child_array_paths() -> list[str]

Return the full paths of the group's direct child arrays.

child_arrays

child_arrays() -> list[Array]

Return the direct child arrays of the group.

child_group_paths

child_group_paths() -> list[str]

Return the full paths of the group's direct child groups.

child_groups

child_groups() -> list[Group]

Return the direct child groups of the group.

child_paths

child_paths() -> list[str]

Return the full paths of the group's direct children.

erase_metadata

erase_metadata() -> None

Erase the group metadata from the store. Succeeds if it does not exist.

group_keys

group_keys() -> list[str]

Names of the direct child groups.

open staticmethod

open(store: FilesystemStore | MemoryStore, path: str = '/') -> Group

Open the group stored at path in store.

store_metadata

store_metadata() -> None

Write the group metadata to the store.

traverse

traverse() -> list[Array | Group]

Return every node under the group, recursively.

zarrista.AsyncGroup

A Zarr group backed by an async store.

attrs property

attrs: dict[str, JSONValue]

The group's user attributes as a dict.

consolidated_metadata property

consolidated_metadata: ConsolidatedMetadataV3 | None

The consolidated metadata, if present in the group metadata.

metadata property

metadata: GroupMetadataV3

The group's full Zarr v3 metadata.

path property

path: str

The group's path in the store.

array_keys async

array_keys() -> list[str]

Names of the direct child arrays.

child_array_paths async

child_array_paths() -> list[str]

Return the full paths of the group's direct child arrays.

child_arrays async

child_arrays() -> list[AsyncArray]

Return the direct child arrays of the group.

child_group_paths async

child_group_paths() -> list[str]

Return the full paths of the group's direct child groups.

child_groups async

child_groups() -> list[AsyncGroup]

Return the direct child groups of the group.

child_paths async

child_paths() -> list[str]

Return the full paths of the group's direct children.

erase_metadata async

erase_metadata() -> None

Erase the group metadata from the store. Succeeds if it does not exist.

group_keys async

group_keys() -> list[str]

Names of the direct child groups.

open_async async staticmethod

open_async(store: AsyncStore, path: str = '/') -> AsyncGroup

Open the group stored at path in store.

store may be an obstore ObjectStore or an icechunk Session.

open_child_async async

open_child_async(name: str) -> AsyncArray | AsyncGroup

Open a direct child array or group by name.

store_metadata async

store_metadata() -> None

Write the group metadata to the store.

traverse async

traverse() -> list[AsyncArray | AsyncGroup]

Return every node under the group, recursively.