Skip to content

HDF5Group

async_hdf5.HDF5Group

An HDF5 group — a container for datasets and other groups.

name property 

name: str

The name of this group.

attributes async 

attributes() -> dict[str, Any]

Read all attributes on this group.

Returns:

  • dict[str, Any] –

    A dict mapping attribute names to decoded Python values.

children async 

children() -> list[str]

List the names of all immediate children.

Returns:

  • list[str] –

    A list of child names.

dataset async 

dataset(name: str) -> HDF5Dataset

Open a child dataset by name.

Parameters:

  • name (str) –

    The name of the child dataset.

Returns:

Raises:

  • RuntimeError –

    If the child does not exist or is not a dataset.

dataset_names async 

dataset_names() -> list[str]

List the names of child datasets.

Returns:

  • list[str] –

    A list of child dataset names.

group async 

group(name: str) -> HDF5Group

Open a child group by name.

Parameters:

  • name (str) –

    The name of the child group.

Returns:

Raises:

  • RuntimeError –

    If the child does not exist or is not a group.

group_names async 

group_names() -> list[str]

List the names of child groups.

Returns:

  • list[str] –

    A list of child group names.

navigate async 

navigate(path: str) -> HDF5Group

Navigate to a group by /-separated path.

Parameters:

  • path (str) –

    A /-separated path relative to this group (e.g. "level1/level2").

Returns:

Raises:

  • RuntimeError –

    If any component along the path is not found.