Skip to content

HDF5File

async_hdf5.HDF5File

An open HDF5 file.

Use open to create an instance.

open async classmethod 

open(
    path: str,
    *,
    store: ObjectStore | ObspecInput,
    block_size: int = 8388608,
    pre_warm_size: int | None = None,
) -> HDF5File

Open an HDF5 file.

Parameters:

  • path (str) –

    The path within the store to the HDF5 file.

  • store (ObjectStore | ObspecInput) –

    The storage backend (e.g. an obstore S3Store, LocalStore, or any object implementing the ObspecInput protocol).

  • block_size (int, default: 8388608 ) –

    The read-ahead block size in bytes for the internal block cache. Defaults to 8 MiB.

  • pre_warm_size (int | None, default: None ) –

    If set, eagerly fetches this many bytes from the start of the file on open. Useful for small files where the entire file fits in a single read.

Returns:

root_group async 

root_group() -> HDF5Group

Get the root group of the file.

Returns: