Skip to content

cayu.snapshots.containers

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

AGENT_BUNDLE_CONTAINER_EXTENSION

Section titled “AGENT_BUNDLE_CONTAINER_EXTENSION”
from cayu.snapshots import AGENT_BUNDLE_CONTAINER_EXTENSION
AGENT_BUNDLE_CONTAINER_EXTENSION = '.cayu'

Release source · Runtime guarantees · Capability guides

AGENT_BUNDLE_CONTAINER_MAX_BYTES

Section titled “AGENT_BUNDLE_CONTAINER_MAX_BYTES”
from cayu.snapshots import AGENT_BUNDLE_CONTAINER_MAX_BYTES
AGENT_BUNDLE_CONTAINER_MAX_BYTES = AGENT_BUNDLE_MAX_TOTAL_BYTES + AGENT_BUNDLE_MAX_INDEX_BYTES + AGENT_BUNDLE_CONTAINER_MAX_METADATA_BYTES

Release source · Runtime guarantees · Capability guides

AGENT_BUNDLE_CONTAINER_MAX_ENTRIES

Section titled “AGENT_BUNDLE_CONTAINER_MAX_ENTRIES”
from cayu.snapshots import AGENT_BUNDLE_CONTAINER_MAX_ENTRIES
AGENT_BUNDLE_CONTAINER_MAX_ENTRIES = AGENT_BUNDLE_MAX_OBJECTS + 2

Release source · Runtime guarantees · Capability guides

AGENT_BUNDLE_CONTAINER_MEDIA_TYPE

Section titled “AGENT_BUNDLE_CONTAINER_MEDIA_TYPE”
from cayu.snapshots import AGENT_BUNDLE_CONTAINER_MEDIA_TYPE
AGENT_BUNDLE_CONTAINER_MEDIA_TYPE = 'application/vnd.cayu.agent-bundle'

Release source · Runtime guarantees · Capability guides

AGENT_BUNDLE_CONTAINER_MIMETYPE_ENTRY

Section titled “AGENT_BUNDLE_CONTAINER_MIMETYPE_ENTRY”
from cayu.snapshots import AGENT_BUNDLE_CONTAINER_MIMETYPE_ENTRY
AGENT_BUNDLE_CONTAINER_MIMETYPE_ENTRY = 'mimetype'

Release source · Runtime guarantees · Capability guides

AGENT_BUNDLE_CONTAINER_SCHEMA_VERSION

Section titled “AGENT_BUNDLE_CONTAINER_SCHEMA_VERSION”
from cayu.snapshots import AGENT_BUNDLE_CONTAINER_SCHEMA_VERSION
AGENT_BUNDLE_CONTAINER_SCHEMA_VERSION = 1

Release source · Runtime guarantees · Capability guides

AgentBundleContainerInspection

Section titled “AgentBundleContainerInspection”
from cayu.snapshots import AgentBundleContainerInspection

Bounded safe metadata reported after complete container validation.

Bases: _ContainerModel.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
record_type Literal['cayu.agent-bundle-container'] _CONTAINER_RECORD_TYPE
schema_version Literal[1] AGENT_BUNDLE_CONTAINER_SCHEMA_VERSION
media_type Literal['application/vnd.cayu.agent-bundle'] AGENT_BUNDLE_CONTAINER_MEDIA_TYPE
transport_sha256 StrictStr required
container_bytes StrictInt Field(ge=1, le=AGENT_BUNDLE_CONTAINER_MAX_BYTES)
bundle_id StrictStr required
snapshot_root StrictStr required
profile StrictStr required
mode AgentBundleMode required
object_count StrictInt Field(ge=1, le=AGENT_BUNDLE_MAX_OBJECTS)
transferred_object_count StrictInt Field(ge=1, le=AGENT_BUNDLE_MAX_OBJECTS)
logical_closure_bytes StrictInt Field(ge=1, le=AGENT_BUNDLE_MAX_TOTAL_BYTES)
transferred_bytes StrictInt Field(ge=0, le=AGENT_BUNDLE_MAX_TOTAL_BYTES)
destination_inventory_fingerprint StrictStr required
requires_preexisting_objects StrictBool required
unresolved_external_bindings tuple[StrictStr, ...] required

Release source · Runtime guarantees · Capability guides

AgentBundleContainerReceipt

Section titled “AgentBundleContainerReceipt”
from cayu.snapshots import AgentBundleContainerReceipt

Receipt for one verified representation conversion.

Bases: _ContainerModel.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
inspection AgentBundleContainerInspection required
bundle AgentBundle required

Release source · Runtime guarantees · Capability guides

inspect_agent_bundle_container

Section titled “inspect_agent_bundle_container”
from cayu.snapshots import inspect_agent_bundle_container

Validate every transferred byte and return bounded safe metadata.

inspect_agent_bundle_container(source: BinarySource) -> AgentBundleContainerInspection

Release source · Runtime guarantees · Capability guides

pack_agent_bundle

Section titled “pack_agent_bundle”
from cayu.snapshots import pack_agent_bundle

Pack one canonical directory bundle into deterministic .cayu bytes.

pack_agent_bundle(source: str | os.PathLike[str], destination: BinaryDestination) -> AgentBundleContainerReceipt

Release source · Runtime guarantees · Capability guides

unpack_agent_bundle_container

Section titled “unpack_agent_bundle_container”
from cayu.snapshots import unpack_agent_bundle_container

Unpack exact declared entries into a canonical directory atomically.

unpack_agent_bundle_container(source: BinarySource, destination: str | os.PathLike[str]) -> AgentBundleContainerReceipt

Release source · Runtime guarantees · Capability guides