salvus.flow.acta.store.base
salvus.flow.acta.store.base salvus flow acta store base Base interface for content-addressed byte storage.
Validate digests before backend access. Existing objects are verified on
put; fetches verify when verify_on_fetch is enabled. Mutable bindings
map keys to digests and must be written atomically.
Functions
observe_writes()
observe_writes()def observe_writes(observer: Callable[[str], None]) -> Iterator[None]: ...Notify observer of every object put in the current context.
Include writes that reuse an existing object.
observerCallable[[str], None] — Callback receiving each content digest.
Classes
ContentStoreBase
ContentStoreBaseclass ContentStoreBase(abc.ABC):
def __init__(self): ...Store immutable byte objects by digest.
Backends implement byte I/O, object listing and timestamps, and mutable bindings. Typed artifact descriptors and payloads are separate objects.
delete()
delete()def delete(self, digest: str) -> None: ...Remove the object stored under digest.
digeststr — A content digest.
delete_binding()
delete_binding()def delete_binding(self, key: str) -> None: ...Remove the binding for key, if there is one.
Leave the target object unchanged.
keystr — The key to unbind, 64 lowercase hex characters.
exists()
exists()def exists(self, digest: str) -> bool: ...Return True if an object with digest is present.
digeststr — A content digest.
fetch_bytes()
fetch_bytes()def fetch_bytes(self, digest: str) -> bytes: ...Return the raw bytes stored under digest.
digeststr — A content digest.
digest first if this backend’s verify_on_fetch is True.fetch_file()
fetch_file()def fetch_file(self, digest: str) -> pathlib.Path: ...Return a read-only local path to the object under digest.
Reuse a local file when verify_on_fetch is false. Otherwise fetch
bytes
under the verification policy and write a temporary file. Missing
objects
and verification errors propagate.
digeststr — A content digest.
0o444 for a temp copy.get_binding()
get_binding()def get_binding(self, key: str) -> str | None: ...Return the digest bound to key, or None if unbound.
keystr — The key to look up, 64 lowercase hex characters.
iter_bindings()
iter_bindings()def iter_bindings(self) -> Iterator[tuple[str, str]]: ...Yield every (key, digest) pair this store currently holds.
Order is unspecified; concurrent writes may change the listing.
iter_digests()
iter_digests()def iter_digests(self) -> Iterator[str]: ...Yield every digest this store currently holds.
Exclude bindings. Order is unspecified; concurrent writes may change the listing.
modified_at()
modified_at()def modified_at(self, digest: str) -> datetime.datetime | None: ...Return when digest was last written, or None if absent.
digeststr — A content digest.
put_binding()
put_binding()def put_binding(self, key: str, digest: str) -> None: ...Bind key to digest, replacing any existing binding.
Validate the key and digest format; the target object need not exist.
keystr — The key to bind, 64 lowercase hex characters.digeststr — The content digest to bind it to.
put_bytes()
put_bytes()def put_bytes(self, data: bytes) -> str: ...Store data and return its digest.
Verify existing objects and reuse them. Raise DigestMismatchError if
stored bytes differ from their digest.
databytes — The bytes to store.
data.put_file()
put_file()def put_file(self, path: pathlib.Path) -> str: ...Store the bytes of an existing file and return its digest.
Hash and stage the same chunks, then write through _write_file.
Verify and reuse an existing object.
pathpathlib.Path — Path to the file whose bytes should be stored.
Exceptions
DigestMismatchError
DigestMismatchErrorRaised when an object’s stored bytes do not match its digest.