cayu.artifacts definitions

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.

ArtifactClosureClaim

from cayu.artifacts import ArtifactClosureClaim

Decorators: @dataclass(frozen=True).

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
store_id	str	required
session_id	str	required
plan_id	str	required
artifacts	tuple[ArtifactClosureItem, ...]	required

Release source · Runtime guarantees · Capability guides

ArtifactClosureItem

from cayu.artifacts import ArtifactClosureItem

Decorators: @dataclass(frozen=True).

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
artifact_id	str	required
size_bytes	int	required
metadata_sha256	str	required

Release source · Runtime guarantees · Capability guides

ArtifactInputMember

from cayu.artifacts import ArtifactInputMember

Exact immutable member identity, including metadata and original bytes.

Bases: ContractValue.

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
resource	ObjectRef	required
content_sha256	InputDigest	required
metadata_sha256	InputDigest	required
size_bytes	InputSize	required

bounded_input (method)

ArtifactInputMember.bounded_input(value: object) -> Any

immutable_fields (method)

ArtifactInputMember.immutable_fields() -> ContractValue

pinned_artifact (method)

ArtifactInputMember.pinned_artifact() -> Self

Release source · Runtime guarantees · Capability guides

copy_artifact_closure_claim

from cayu.artifacts import copy_artifact_closure_claim

copy_artifact_closure_claim(value: ArtifactClosureClaim) -> ArtifactClosureClaim

Release source · Runtime guarantees · Capability guides

FolderInputEntry

from cayu.artifacts import FolderInputEntry

Canonical relative member path; no ambient filesystem lookup is implied.

Bases: ContractValue.

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
path	Annotated[StrictStr, Field(min_length=1, max_length=512)]	required
git_mode	Literal['100644', '100755']	required
member	ArtifactInputMember	required

bounded_input (method)

FolderInputEntry.bounded_input(value: object) -> Any

immutable_fields (method)

FolderInputEntry.immutable_fields() -> ContractValue

canonical_relative_path (method)

FolderInputEntry.canonical_relative_path(value: str) -> str

Release source · Runtime guarantees · Capability guides

FolderInputManifest

from cayu.artifacts import FolderInputManifest

Small artifact-backed folder; member bytes remain at their resource owner.

Paths are ordered, not normalized or silently deduplicated. Multiple paths may reference the same immutable artifact, but contradictory descriptions of the same resource are invalid. Logical bytes count paths; retention counts and physical bytes count distinct resource identities.

Bases: ContractValue.

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
schema_version	Literal[1]	1
entries	tuple[FolderInputEntry, ...]	Field(max_length=MAX_INPUT_MANIFEST_MEMBERS)

bounded_input (method)

FolderInputManifest.bounded_input(value: object) -> Any

immutable_fields (method)

FolderInputManifest.immutable_fields() -> ContractValue

strict_schema_version (method)

FolderInputManifest.strict_schema_version(value: object) -> int

canonical_members (method)

FolderInputManifest.canonical_members() -> Self

logical_bytes (property)

FolderInputManifest.logical_bytes() -> int

retained_members (property)

FolderInputManifest.retained_members() -> tuple[ArtifactInputMember, ...]

Release source · Runtime guarantees · Capability guides

ResourceMaterialReference

from cayu.collaboration import ResourceMaterialReference

Complete expected content; authority comes from the registered native owner.

Bases: ContractValue.

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
schema_version	VersionOne	1
owner	OwnerRef	required
operation	OperationRef	required
template_commitment	MaterialCommitment	required
transfer_commitment	MaterialCommitment	required
preparation_commitment	MaterialCommitment	required

bounded_input (method)

ResourceMaterialReference.bounded_input(value: object) -> Any

immutable_fields (method)

ResourceMaterialReference.immutable_fields() -> ContractValue

coherent (method)

ResourceMaterialReference.coherent()

Release source · Runtime guarantees · Capability guides