Skip to content

daft.functions.hdf5_metadata#

hdf5_metadata #

hdf5_metadata(file_expr: Expression, group: str = '/') -> Expression

Collect metadata for groups and datasets under an HDF5 group.

Expression wrapper for Hdf5File.metadata(group).

Parameters:

Name Type Description Default
file_expr Expression

Hdf5File expression.

 required
group str

HDF5 group within the file. Defaults to the root group /.

 '/'

Returns:

Type Description
Expression

Expression containing a list of object metadata structs.
Source code in daft/functions/hdf5.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
def hdf5_metadata(file_expr: Expression, group: str = "/") -> Expression:
    """Collect metadata for groups and datasets under an HDF5 group.

    Expression wrapper for ``Hdf5File.metadata(group)``.

    Args:
        file_expr: ``Hdf5File`` expression.
        group: HDF5 group within the file. Defaults to the root group ``/``.

    Returns:
        Expression containing a list of object metadata structs.
    """
    return cast("Expression", hdf5_metadata_fn(file_expr, group=group))