Source code for parpe.hdf5

"""Convenience functions for working with HDF5 files"""
import h5py
from typing import Collection
from numbers import Number




def write_string_array(f: h5py.Group,
                       path: str,
                       strings: Collection) -> None:
    """
    Write string array to hdf5

    Arguments:
        f: h5py.File
        path: path of the dataset to create
        strings: list of strings
    """
    dt = h5py.special_dtype(vlen=str)
    dset = f.create_dataset(path, (len(strings),), dtype=dt)
    dset[:] = [str(s).encode('utf8') for s in strings]
    f.file.flush()





def write_float_array(f: h5py.Group,
                      path: str,
                      values: Collection[Number],
                      dtype='f8') -> None:
    """
    Write float array to hdf5

    Arguments:
        f: h5py.File
        path: path of the dataset to create
        values: array to write
        dtype: datatype
    """
    dset = f.create_dataset(path, (len(values),), dtype=dtype)
    dset[:] = values
    f.flush()





def write_int_array(f: h5py.Group,
                    path: str,
                    values: Collection[int],
                    dtype='<i4'):
    """
    Write integer array to hdf5

    Arguments:
        f: h5py.File
        path: path of the dataset to create
        values: array to write
        dtype: datatype
    """
    dset = f.create_dataset(path, (len(values),), dtype=dtype)
    dset[:] = values
    f.flush()