Module H5I

Functional API

Identifier interface for object inspection.

h5py.h5i.dec_ref(ObjectID obj)

Decrement the reference count for the given object.

This function is provided for debugging only. Reference counting is automatically synchronized with Python, and you can easily break ObjectID instances by abusing this function.

h5py.h5i.get_file_id(ObjectID obj) → FileID

Obtain an identifier for the file in which this object resides.

h5py.h5i.get_name(ObjectID obj) → STRING name, or None

Determine (a) name of an HDF5 object. Because an object has as many names as there are hard links to it, this may not be unique.

If the identifier is invalid or is not associated with a name (in the case of transient datatypes, dataspaces, etc), returns None.

For some reason, this does not work on dereferenced objects.

h5py.h5i.get_ref(ObjectID obj) → INT

Retrieve the reference count for the given object.

h5py.h5i.get_type(ObjectID obj) → INT type_code

Determine the HDF5 typecode of an arbitrary HDF5 object. The return value is always one of the type constants defined in this module; if the ID is invalid, BADID is returned.

h5py.h5i.inc_ref(ObjectID obj)

Increment the reference count for the given object.

This function is provided for debugging only. Reference counting is automatically synchronized with Python, and you can easily break ObjectID instances by abusing this function.

Module constants

Identifier classes

h5py.h5i.BADID
h5py.h5i.FILE
h5py.h5i.GROUP
h5py.h5i.DATASPACE
h5py.h5i.DATASET
h5py.h5i.ATTR
h5py.h5i.REFERENCE
h5py.h5i.GENPROP_CLS
h5py.h5i.GENPROP_LST
h5py.h5i.DATATYPE

Table Of Contents

Previous topic

Module H5G

Next topic

Module H5L

This Page