h5py API reference

87 public APIs from h5py (h5py/h5py) — 25 classes, 19 functions, 43 methods. Signatures extracted by static analysis of the actual source.

Repository: h5py/h5py

Kind	Count
Classes	25
Functions	19
Methods	43

API list

classapi_gen.Line

Represents one line from the api_functions.txt file.

funcci.fix_paths.main()

Copy HDF5 DLLs into installed h5py package

funcdocs_api.automod.getsig(docstring)

Get (sig, return) from a docstring, or None.

funcdocs_api.automod.replace_param(istr)

Replace parameter lists.

classh5py._hl.attrs.AttributeManager

Allows dictionary-style access to an HDF5 object's attributes.

funch5py._hl.attrs.AttributeManager.iter_cb(name, *args)

Callback to gather attribute names

classh5py._hl.base.Empty

Proxy object to represent empty/null dataspaces (a.k.a H5S_NULL).

classh5py._hl.base.HLObject

Base class for high-level interface objects.

methodh5py._hl.base.HLObject.attrs()

Attributes attached to this object

methodh5py._hl.base.HLObject.id()

Low-level identifier appropriate for this object

methodh5py._hl.base.HLObject.name()

Return the full name of this object.

methodh5py._hl.base.HLObject.parent()

Return the parent group of this object.

methodh5py._hl.base.HLObject.ref()

An (opaque) HDF5 reference to this object

methodh5py._hl.base.HLObject.regionref()

Create a region reference (Datasets only).

classh5py._hl.base.ItemsViewHDF5

Wraps e.g.

classh5py._hl.base.ValuesViewHDF5

Wraps e.g.

funch5py._hl.base.default_lapl()

Default link access property list

funch5py._hl.base.default_lcpl()

Default link creation property list

funch5py._hl.base.is_empty_dataspace(obj)

Check if an object's dataspace is empty

funch5py._hl.compat.filename_decode(filename)

Decode filename used by HDF5 library.

funch5py._hl.compat.filename_encode(filename)

Encode filename for use in the HDF5 library.

classh5py._hl.dataset.AsStrView

Wrapper to decode strings on reading the dataset

classh5py._hl.dataset.AsTypeView

Wrapper to convert data on reading from a dataset.

classh5py._hl.dataset.ChunkIterator

Class to iterate through list of chunks of a given dataset

classh5py._hl.dataset.CollectiveContext

Manages collective I/O in MPI mode

classh5py._hl.dataset.Dataset

Represents an HDF5 dataset

methodh5py._hl.dataset.Dataset.chunks()

Dataset chunks (or None)

methodh5py._hl.dataset.Dataset.compression()

Compression strategy (or None)

methodh5py._hl.dataset.Dataset.compression_opts()

Compression setting.

methodh5py._hl.dataset.Dataset.dtype()

Numpy dtype representing the datatype

methodh5py._hl.dataset.Dataset.external()

External file settings.

methodh5py._hl.dataset.Dataset.fillvalue()

Fill value for this dataset (0 by default)

methodh5py._hl.dataset.Dataset.fletcher32()

Fletcher32 filter is present (T/F)

methodh5py._hl.dataset.Dataset.is_virtual()

Check if this is a virtual dataset

methodh5py._hl.dataset.Dataset.iter_chunks(sel=None)

Return chunk iterator.

methodh5py._hl.dataset.Dataset.len()

The size of the first axis.

methodh5py._hl.dataset.Dataset.scaleoffset()

Scale/offset filter settings.

methodh5py._hl.dataset.Dataset.shuffle()

Shuffle filter present (T/F)

classh5py._hl.dataset.FieldsView

Wrapper to extract named fields from a dataset with a struct dtype

classh5py._hl.datatype.Datatype

Represents an HDF5 named datatype stored in a file.

methodh5py._hl.datatype.Datatype.dtype()

Numpy dtype equivalent for this datatype

classh5py._hl.dims.DimensionManager

Represents a collection of dimension associated with a dataset.

classh5py._hl.dims.DimensionProxy

Represents an HDF5 "dimension".

methodh5py._hl.dims.DimensionProxy.attach_scale(dset)

Attach a scale to this dimension.

methodh5py._hl.dims.DimensionProxy.detach_scale(dset)

Remove a scale from this dimension.

funch5py._hl.dims.DimensionProxy.f(dsid)

Iterate over scales to find a matching name

methodh5py._hl.dims.DimensionProxy.label()

Get or set the dimension scale label

classh5py._hl.files.File

Represents an HDF5 file.

methodh5py._hl.files.File.atomic()

Set/get MPI-IO atomic mode

methodh5py._hl.files.File.attrs()

Attributes attached to this object

methodh5py._hl.files.File.close()

Close the file.

methodh5py._hl.files.File.driver()

Low-level HDF5 file driver used to open file

methodh5py._hl.files.File.filename()

File name on disk

methodh5py._hl.files.File.flush()

Tell the HDF5 library to flush its buffers.

methodh5py._hl.files.File.meta_block_size()

Meta block size (in bytes)

methodh5py._hl.files.File.mode()

Python mode used to open file

methodh5py._hl.files.File.swmr_mode()

Controls single-writer multiple-reader mode

methodh5py._hl.files.File.userblock_size()

User block size (in bytes)

funch5py._hl.files.register_driver(name, set_fapl)

funch5py._hl.files.unregister_driver(name)

Unregister a custom driver.

funch5py._hl.filters.rq_tuple(tpl, name)

Check if chunks/maxshape match dataset rank

classh5py._hl.group.ExternalLink

Represents an HDF5 external link.

methodh5py._hl.group.ExternalLink.path()

Soft link path, i.e.

classh5py._hl.group.Group

Represents an HDF5 group.

method

h5py._hl.group.Group.copy(source, dest, name=None, shallow=False, expand_soft=False, expand_external=False, expand_refs=False, without_attrs=False)

Copy an object or group.

methodh5py._hl.group.Group.create_dataset_like(name, other, **kwupdate)

Create a dataset similar to `other`.

methodh5py._hl.group.Group.create_group(name, track_order=None, *track_times=False)

Create and return a new subgroup.

methodh5py._hl.group.Group.move(source, dest)

Move a link to a new location in the file.

methodh5py._hl.group.Group.visititems_links(func)

Recursively visit links in this group.

classh5py._hl.group.HardLink

Represents a hard link in an HDF5 file.

classh5py._hl.group.SoftLink

Represents a symbolic ("soft") link in an HDF5 file.

methodh5py._hl.group.SoftLink.path()

Soft link value.

classh5py._hl.selections.PointSelection

Represents a point-wise selection.

classh5py._hl.selections.Selection

Base class for HDF5 dataspace selections.

methodh5py._hl.selections.Selection.broadcast(source_shape)

Get an iterable for broadcasting

methodh5py._hl.selections.Selection.id()

SpaceID instance

methodh5py._hl.selections.Selection.nselect()

Number of elements currently selected

methodh5py._hl.selections.Selection.shape()

Shape of whole dataspace

classh5py._hl.selections2.ScalarReadSelection

Implements slicing for scalar datasets.

funch5py._hl.selections2.read_dtypes(dataset_dtype, names)

Returns a 2-tuple containing: 1.

funch5py._hl.selections2.read_selections_scalar(dsid, args)

Returns a 2-tuple containing: 1.

funch5py._hl.selections2.select_read(fspace, args)

Top-level dispatch function for reading.

classh5py._hl.vds.VirtualLayout

Object for building a virtual dataset.

classh5py._hl.vds.VirtualSource

Source definition for virtual data sets.

funch5py.ipy_completer.load_ipython_extension(ip=None)

Load completer function into IPython

funcsetup_configure.load_stashed_config()

Load settings dict from the pickle file

funcsetup_configure.stash_config(dct)

Save settings dict to the pickle file.

About this data

These signatures were extracted from the public source of h5py/h5py using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries