Exceptions

Every error the library raises deliberately derives from H5ColError, so except H5ColError catches all of h5col’s own diagnostics while letting genuine bugs surface. Several leaves also derive from ValueError, matching how standard Python code expects bad values to fail.

exception h5col.H5ColError

Bases: Exception

Base class for all h5col errors.

exception h5col.ConformanceError

Bases: H5ColError

A group, dataset, or attribute violates H5Col when read.

exception h5col.SchemaError

Bases: H5ColError, ValueError

An invalid table, column, or filter specification supplied by the caller.

exception h5col.ReservedNameError

Bases: SchemaError

A H5Col reserved name was used where it is not permitted.

exception h5col.OversizedStringError(value: object, max_bytes: int, actual_bytes: int, *, index: int | None = None)

Bases: H5ColError, ValueError

A string value’s encoded byte length exceeds the fixed-length budget.

H5Col forbids silent truncation of fixed-length string columns; H5Col raises this instead of writing a truncated value.

exception h5col.FillValueError

Bases: H5ColError, ValueError

An invalid or inconsistent fill value / valid-range specification.

exception h5col.FilterError

Bases: H5ColError

A problem building or applying a filter pipeline.

exception h5col.ObjectReferenceError

Bases: H5ColError

A problem creating or resolving an HDF5 object reference.

Named ObjectReferenceError to avoid shadowing the built-in ReferenceError.

exception h5col.StaleIndexError

Bases: H5ColError

A search index failed the H5Col validity check and cannot be used.

Raised by index query primitives when the GENERATION/SOURCE_* token comparison fails; consumers must treat such an index as absent (fall back to a scan) rather than partially trust it.

exception h5col.VersionError

Bases: H5ColError

The table’s HEP001 VERSION major exceeds what this library supports.