bagofholding.h5.triebag module

class bagofholding.h5.triebag.TrieH5Bag(filepath: str | Path, *args: object, **kwargs: Any)

Bases: Bag, HasH5FileContext, ArrayPacker

A bag using HDF5 files based on h5py.

Uses a trie structure to flatten the stored object. Compared to bagofholding.h5.bag.H5Bag, this is advantageous for file sizes but (currently) has worse scaling for save times.

The resulting HDF5 file cannot be directly related to the structure of the stored object, but must be re-mapped via mapping fields. Metadata is also lumped in with other string data to minimize the number of different h5 groups.

create_group(path: str) → None

classmethod get_bag_info() → BagInfo

get_bespoke_content_class(obj: object) → type[BespokeItem[Any, Self]] | None

list_paths() → list[str]

A list of all available content paths.

load(path: str = 'object', version_validator: Literal['exact', 'semantic-minor', 'semantic-major', 'none'] | Callable[[str, str], bool] = 'exact', version_scraping: dict[str, Callable[[str], str | None]] | None = None) → Any

open_group(path: str) → set[str]

pack_array(obj: ndarray[tuple[int, ...], dtype[int8] | dtype[int16] | dtype[int32] | dtype[int64] | dtype[uint8] | dtype[uint16] | dtype[uint32] | dtype[uint64] | dtype[float16] | dtype[float32] | dtype[float64] | dtype[complex64] | dtype[complex128] | dtype[bool] | dtype[bytes_] | dtype[str_]], path: str) → None

pack_bool(obj: bool, path: str) → None

pack_bytearray(obj: bytearray, path: str) → None

pack_bytes(obj: bytes, path: str) → None

pack_complex(obj: complex, path: str) → None

pack_empty(path: str) → None

pack_float(obj: float, path: str) → None

pack_long(obj: int, path: str) → None

pack_string(obj: str, path: str) → None

unpack_array(path: str) → ndarray[tuple[int, ...], dtype[int8] | dtype[int16] | dtype[int32] | dtype[int64] | dtype[uint8] | dtype[uint16] | dtype[uint32] | dtype[uint64] | dtype[float16] | dtype[float32] | dtype[float64] | dtype[complex64] | dtype[complex128] | dtype[bool] | dtype[bytes_] | dtype[str_]]

unpack_bool(path: str) → bool

unpack_bytearray(path: str) → bytearray

unpack_bytes(path: str) → bytes

unpack_complex(path: str) → complex

unpack_float(path: str) → float

unpack_long(path: str) → int

unpack_string(path: str) → str

property unpacked_trie: StringTrie