utils.get_hdf5_file#

Back to Module page

Summary#

Returns a hdf5 file object with the given mode, given a source. Warning, if the file is already open in read-only mode, we can’t return a writeable version.

Signature#

def get_hdf5_file(source, mode = 'a', raise_error = False, **creation_kwargs)

Input variables#
Name	Type	Default	Description
`source`			The path to the hdf5 object, or the File object itself
`mode`		‘a’	Mode to open the file in (recommended “r” for read only, and “a” for read/write)
`raise_error`		False	If True, raise an error if the file is not found
`\\creation_kwargs`			Keyword arguments to pass to h5py.File if creating it for the first time

Output variables#

Return annotation	Docstring type	Description
`None`		File object that satisfies the mode conditions. Returns None if source is None, and reuses existing object if it satisfies the conditions 2. Boolean indicating if the file was opened in the function

Docstring#

Returns a hdf5 file object with the given mode, given a source. Warning, if
the file is already open in read-only mode, we can't return a writeable
version.
:param source: The path to the hdf5 object, or the File object itself
:param mode:
    Mode to open the file in (recommended "r" for read only, and "a" for
    read/write)
:param raise_error: If True, raise an error if the file is not found
:param creation_kwargs:
    Keyword arguments to pass to h5py.File if creating it for the first time
:return:
    1. File object that satisfies the mode conditions. Returns None if
       source is None, and reuses existing object if it satisfies
       the conditions
    2. Boolean indicating if the file was opened in the function