Mondaic

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()

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.

Parameters
  • observer Callable[[str], None] — Callback receiving each content digest.
Returns Iterator[None]

Classes

ContentStoreBase

class 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.

Methods
delete()
def delete(self, digest: str) -> None: ...

Remove the object stored under digest.

Parameters
  • digest str — A content digest.
Returns None
delete_binding()
def delete_binding(self, key: str) -> None: ...

Remove the binding for key, if there is one.

Leave the target object unchanged.

Parameters
  • key str — The key to unbind, 64 lowercase hex characters.
Returns None
exists()
def exists(self, digest: str) -> bool: ...

Return True if an object with digest is present.

Parameters
  • digest str — A content digest.
Returns bool
fetch_bytes()
def fetch_bytes(self, digest: str) -> bytes: ...

Return the raw bytes stored under digest.

Parameters
  • digest str — A content digest.
Returns bytes — The object’s bytes, re-verified against digest first if this backend’s verify_on_fetch is True.
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.

Parameters
  • digest str — A content digest.
Returns pathlib.Path — A path to the object’s bytes, mode 0o444 for a temp copy.
get_binding()
def get_binding(self, key: str) -> str | None: ...

Return the digest bound to key, or None if unbound.

Parameters
  • key str — The key to look up, 64 lowercase hex characters.
Returns str | None
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.

Returns Iterator[tuple[str, str]]
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.

Returns Iterator[str]
modified_at()
def modified_at(self, digest: str) -> datetime.datetime | None: ...

Return when digest was last written, or None if absent.

Parameters
  • digest str — A content digest.
Returns datetime.datetime | None
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.

Parameters
  • key str — The key to bind, 64 lowercase hex characters.
  • digest str — The content digest to bind it to.
Returns None
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.

Parameters
  • data bytes — The bytes to store.
Returns str — The content digest of data.
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.

Parameters
  • path pathlib.Path — Path to the file whose bytes should be stored.
Returns str — The content digest of the file’s contents.

Exceptions

DigestMismatchError

Raised when an object’s stored bytes do not match its digest.