fleche.storage.pickle_file

Attributes

logger
_HMAC_MIN_KEY_BYTES

Classes

PickleFileBackend	Store values as files on the filesystem using a serialization module.
ValuePickleFile	Bridges ValueStorage with StorageBackend primitives.
CallPickleFile	Bridges CallStorage with StorageBackend primitives.

Functions

_normalize_secret_key(→ list[bytes])

Normalize a secret key value to list[bytes].

Module Contents

fleche.storage.pickle_file.logger

fleche.storage.pickle_file._HMAC_MIN_KEY_BYTES = 32

fleche.storage.pickle_file._normalize_secret_key(key) → list[bytes]

Normalize a secret key value to list[bytes].

Accepts: - bytes: wrapped in a list - str: split on ":" delimiter, each part encoded to UTF-8 - list[bytes]: each element validated for minimum length - list[str]: each element (or colon-delimited parts) encoded to UTF-8

Each resulting key must be at least _HMAC_MIN_KEY_BYTES bytes long.

Raises:

• TypeError – if key or any element is not bytes or str.

• ValueError – if any resulting key is shorter than _HMAC_MIN_KEY_BYTES.

class fleche.storage.pickle_file.PickleFileBackend

Bases: fleche.storage.file.FileStorage

Store values as files on the filesystem using a serialization module.

secret_key: list[bytes] = []

serializer: Any

compress: bool = False

__post_init__()

classmethod with_pickle(*args, **kwargs)

Construct a PickleFileBackend using the standard pickle module.

classmethod with_cloudpickle(*args, **kwargs)

Construct a PickleFileBackend using the cloudpickle module.

classmethod with_dill(*args, **kwargs)

Construct a PickleFileBackend using the dill module.

__getstate__()

__setstate__(state)

_to_file(value: Any, path: pathlib.Path) → None

_from_file(path: pathlib.Path) → Any

class fleche.storage.pickle_file.ValuePickleFile

Bases: fleche.storage.base.ValueMixin, fleche.storage.base.DestructuringMixin, PickleFileBackend

Bridges ValueStorage with StorageBackend primitives.

Implements save and load using put and get. Concrete classes inherit from this and a StorageBackend implementation to get a fully functional value storage.

class fleche.storage.pickle_file.CallPickleFile

Bases: fleche.storage.base.CallMixin, PickleFileBackend

Bridges CallStorage with StorageBackend primitives.

Implements save, load, and query using put and get, deriving the storage key from the call’s lookup key. transform is inherited from CallStorage.

Concrete classes inherit from this and a StorageBackend implementation to get a fully functional call storage.