fleche.storage.base

Attributes

logger

Exceptions

`SaveError`	Common base class for all non-exit exceptions.
`AmbiguousDigestError`	Inappropriate argument value (of correct type).

Classes

`StorageBase`	Shared functionality between value and call storages.
`Storage`	Abstract base class for defining storage mechanisms.
`Digested`	Helper class that provides a standard way to create an ABC using
`DigestedIterable`	Helper class that provides a standard way to create an ABC using
`DigestedDict`	Helper class that provides a standard way to create an ABC using
`DestructuringStorage`	Abstract base class for defining storage mechanisms.
`CallStorage`	Special storage for saving `Call` instances.
`CallStorageAdapter`	Implement a CallStorage from a generic Storage.

Module Contents

fleche.storage.base.logger[source]

exception fleche.storage.base.SaveError[source]

Bases: Exception

Common base class for all non-exit exceptions.

exception fleche.storage.base.AmbiguousDigestError[source]

Bases: ValueError

Inappropriate argument value (of correct type).

class fleche.storage.base.StorageBase[source]

Bases: abc.ABC

Shared functionality between value and call storages.

abstractmethod list() → Iterable[fleche.digest.Digest][source]

evict(key: fleche.digest.Digest | str) → None[source]: Removes the entry corresponding to the key from the storage.

abstractmethod _evict(key: fleche.digest.Digest) → None[source]

expand(key: fleche.digest.Digest | str) → fleche.digest.Digest[source]: Expands a short-hand digest to the full length one.

shrink(key: fleche.digest.Digest | str) → fleche.digest.Digest[source]: Find the shortest substring that is still an unambigious reference to the same value.

contains(key: fleche.digest.Digest | str) → bool[source]

abstractmethod _contains(key: fleche.digest.Digest) → bool[source]

class fleche.storage.base.Storage[source]

Bases: StorageBase

Abstract base class for defining storage mechanisms.

save(value: Any, key: fleche.digest.Digest | None = None) → fleche.digest.Digest[source]

abstractmethod _save(value: Any, key: fleche.digest.Digest) → fleche.digest.Digest[source]

load(key: fleche.digest.Digest | str) → Any[source]

abstractmethod _load(key: fleche.digest.Digest) → Any[source]

_contains(key: fleche.digest.Digest) → bool[source]

class fleche.storage.base.Digested[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstractmethod underlying()[source]

__digest__()[source]

class fleche.storage.base.DigestedIterable[source]

Bases: Digested

Helper class that provides a standard way to create an ABC using inheritance.

items: Iterable[source]

underlying()[source]

class fleche.storage.base.DigestedDict[source]

Bases: Digested

Helper class that provides a standard way to create an ABC using inheritance.

items: dict[source]

underlying()[source]

class fleche.storage.base.DestructuringStorage[source]

Bases: Storage

Abstract base class for defining storage mechanisms.

storage: Storage[source]

_save(value: Any, key: fleche.digest.Digest) → fleche.digest.Digest[source]

_load(key: fleche.digest.Digest) → Any[source]

_contains(key: fleche.digest.Digest) → bool[source]

_evict(key: fleche.digest.Digest) → None[source]

list() → Iterable[fleche.digest.Digest][source]

class fleche.storage.base.CallStorage[source]

Bases: StorageBase

Special storage for saving Call instances.

save(call: fleche.call.Call) → fleche.digest.Digest[source]

abstractmethod _save(call: fleche.call.Call) → fleche.digest.Digest[source]

load(key: str) → fleche.call.Call[source]

abstractmethod _load(key: fleche.digest.Digest) → fleche.call.Call[source]

transform(func: Callable[[fleche.call.Call], fleche.call.Call] | None = None) → None[source]

Applies a transformation function to all Call objects in the storage.

Parameters:: func (Callable[[Call], Call] | None) – A function that takes a Call and returns a transformed Call. If None, the identity function is used (useful for re-calculating keys).

query(template: fleche.call.QueryCall) → Iterable[fleche.call.Call][source]

Find cached calls that ‘match’ the template.

Returns all calls where the given arguments, results or metadata match exactly the stored ones. Values may be given either as they are or as Digest.

Parameters:: template (Call) – specification for calls to return; use None as wildcard.
Returns:: an iterable over all matching call objects
Return type:: Iterable[Call]

_contains(key: fleche.digest.Digest) → bool[source]

class fleche.storage.base.CallStorageAdapter[source]

Bases: CallStorage

Implement a CallStorage from a generic Storage.

storage: Storage[source]

_save(call: fleche.call.Call) → fleche.digest.Digest[source]

_load(key: fleche.digest.Digest) → fleche.call.Call[source]

_contains(key: fleche.digest.Digest) → bool[source]

_evict(key: fleche.digest.Digest) → None[source]

list() → Iterable[fleche.digest.Digest][source]