scistag.filestag.bundle

Helps to bundle a list of common data types such as bytes, dictionaries and numpy arrays in a zip file.

Module attributes

IS_TUPLE_FLAG	A flag which is attached to a list property if it was originally a tuple and need to be backconverted upon reading.
BI_SIMPLE_ELEMENT_FLAG	Additional entry which can be stored in the simple_elements list to further specify details about a simple element if required
TUPLE	Defines the input/output type tuple
LIST	Defines the input/output type list
DICT	Defines the input/output type dict
BUNDLE_INFO_NAME	Filename of the bundle info within the zip archive
BundleToBytesCallback	Function definition for plugins which help converting data types of various kinds to bytes.
UnpackFromBytesCallback	Helper function for converting data back from bytes to their original type

Functions

_register_base_types

Registers the base types which can be bundled

Classes

Bundle	The bundle class is able to store a list, a tuple or a dictionary in a zip file.
BundleElementInfo	Defines a single bundle element
BundleInfo	Defines the bundle information
BundlingOptions	Options for bundling the data
UnpackOptions	Options for bundling the data