cayu.coding_products
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.
admit_coding_product_request
Section titled “admit_coding_product_request”from cayu import admit_coding_product_requestObserve exact source authority and construct one immutable product request.
async admit_coding_product_request(*, product_run_id: str, session_id: str, agent_name: str, task_id: str, messages: Sequence[Message], source_workspace: Workspace, source_origin_id: str, source_destination_id: str, source_git_baseline: CodingGitBaselineAuthority, runtime: CodingRuntimeAuthority, settlement: CodingSettlementPolicy | None=None, observation_limits: WorkspaceRevisionObservationLimits | None=None, parent_session_id: str | None=None, causal_budget_id: str | None=None) -> CodingProductRequestRelease source · Runtime guarantees · Capability guides
admit_or_recover_coding_product_request
Section titled “admit_or_recover_coding_product_request”from cayu import admit_or_recover_coding_product_requestRecover immutable admission authority or create and retain it exactly once.
async admit_or_recover_coding_product_request(*, repository: CodingProductArtifactRepository, product_run_id: str, session_id: str, agent_name: str, task_id: str, messages: Sequence[Message], source_workspace: Workspace, source_origin_id: str, source_destination_id: str, source_git_baseline: CodingGitBaselineAuthority, runtime: CodingRuntimeAuthority, settlement: CodingSettlementPolicy | None=None, observation_limits: WorkspaceRevisionObservationLimits | None=None, parent_session_id: str | None=None, causal_budget_id: str | None=None) -> CodingProductRequestRelease source · Runtime guarantees · Capability guides
coding_product_completion_decision
Section titled “coding_product_completion_decision”from cayu import coding_product_completion_decisionEvaluate exact candidate evidence without granting application authority.
coding_product_completion_decision(request: CodingProductRequest, candidate: CodingProductCandidate, *, evidence: WorkEvidenceReference, public_authority_alias_codec: PublicAuthorityAliasCodec | None=None) -> CompletionVerifierDecisionRelease source · Runtime guarantees · Capability guides
CODING_PRODUCT_EVIDENCE_KIND
Section titled “CODING_PRODUCT_EVIDENCE_KIND”from cayu import CODING_PRODUCT_EVIDENCE_KINDCODING_PRODUCT_EVIDENCE_KIND = 'coding_product_evidence'Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_MAX_EVENT_BYTES
Section titled “CODING_PRODUCT_MAX_EVENT_BYTES”from cayu import CODING_PRODUCT_MAX_EVENT_BYTESCODING_PRODUCT_MAX_EVENT_BYTES = 16 * 1024 * 1024Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_MAX_EVENTS
Section titled “CODING_PRODUCT_MAX_EVENTS”from cayu import CODING_PRODUCT_MAX_EVENTSCODING_PRODUCT_MAX_EVENTS = 20000Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_MAX_GIT_DIFF_BYTES
Section titled “CODING_PRODUCT_MAX_GIT_DIFF_BYTES”from cayu import CODING_PRODUCT_MAX_GIT_DIFF_BYTESCODING_PRODUCT_MAX_GIT_DIFF_BYTES = 1024 * 1024Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_MAX_LIFECYCLE_RECEIPTS
Section titled “CODING_PRODUCT_MAX_LIFECYCLE_RECEIPTS”from cayu import CODING_PRODUCT_MAX_LIFECYCLE_RECEIPTSCODING_PRODUCT_MAX_LIFECYCLE_RECEIPTS = 64Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_MAX_MUTATION_ARTIFACT_BYTES
Section titled “CODING_PRODUCT_MAX_MUTATION_ARTIFACT_BYTES”from cayu import CODING_PRODUCT_MAX_MUTATION_ARTIFACT_BYTESCODING_PRODUCT_MAX_MUTATION_ARTIFACT_BYTES = 3 * 1024 * 1024Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_MAX_RESULT_BYTES
Section titled “CODING_PRODUCT_MAX_RESULT_BYTES”from cayu import CODING_PRODUCT_MAX_RESULT_BYTESCODING_PRODUCT_MAX_RESULT_BYTES = 1024 * 1024Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_MAX_SOURCE_ARTIFACT_BYTES
Section titled “CODING_PRODUCT_MAX_SOURCE_ARTIFACT_BYTES”from cayu import CODING_PRODUCT_MAX_SOURCE_ARTIFACT_BYTESCODING_PRODUCT_MAX_SOURCE_ARTIFACT_BYTES = 16 * 1024 * 1024Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_MAX_TOOL_OUTPUT_ARTIFACT_BYTES
Section titled “CODING_PRODUCT_MAX_TOOL_OUTPUT_ARTIFACT_BYTES”from cayu import CODING_PRODUCT_MAX_TOOL_OUTPUT_ARTIFACT_BYTESCODING_PRODUCT_MAX_TOOL_OUTPUT_ARTIFACT_BYTES = 1024 * 1024Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_RESULT_KIND
Section titled “CODING_PRODUCT_RESULT_KIND”from cayu import CODING_PRODUCT_RESULT_KINDCODING_PRODUCT_RESULT_KIND = 'coding_product_result'Release source · Runtime guarantees · Capability guides
CODING_PRODUCT_SCHEMA_VERSION
Section titled “CODING_PRODUCT_SCHEMA_VERSION”from cayu import CODING_PRODUCT_SCHEMA_VERSIONCODING_PRODUCT_SCHEMA_VERSION = 'cayu.coding_product.v1'Release source · Runtime guarantees · Capability guides
coding_product_work_contract
Section titled “coding_product_work_contract”from cayu import coding_product_work_contractBuild the exact WorkContract used by the product verifier and resolver.
coding_product_work_contract(request: CodingProductRequest, repository: CodingProductArtifactRepository) -> WorkContractRelease source · Runtime guarantees · Capability guides
CodingArtifactReference
Section titled “CodingArtifactReference”from cayu import CodingArtifactReferenceBases: _FrozenCodingModel.
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 |
|---|---|---|
artifact_id |
str |
required |
sha256 |
str |
required |
size_bytes |
StrictInt |
Field(ge=0) |
content_type |
str |
'application/json' |
validate_identity (method)
Section titled “validate_identity (method)”CodingArtifactReference.validate_identity(value: str, info) -> strvalidate_sha256 (method)
Section titled “validate_sha256 (method)”CodingArtifactReference.validate_sha256(value: str) -> strRelease source · Runtime guarantees · Capability guides
CodingCheckEvidence
Section titled “CodingCheckEvidence”from cayu import CodingCheckEvidenceBases: _FrozenCodingModel.
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 |
|---|---|---|
check |
str |
required |
event_id |
str |
required |
profile_fingerprint |
str |
required |
status |
str |
required |
exit_code |
StrictInt | None |
None |
output_sha256 |
str | None |
None |
output_artifact |
CodingArtifactReference | None |
None |
duration_ms |
StrictInt | None |
Field(default=None, ge=0) |
stdout_truncated |
StrictBool |
False |
stderr_truncated |
StrictBool |
False |
stdout_runner_truncated |
StrictBool |
False |
stderr_runner_truncated |
StrictBool |
False |
stdout_projection_truncated |
StrictBool |
False |
stderr_projection_truncated |
StrictBool |
False |
output_artifact_status |
str | None |
None |
timed_out |
StrictBool |
False |
cancelled |
StrictBool |
False |
workspace_mutation_settlement |
str | None |
None |
workspace_revision |
str | None |
None |
validate_optional_identity (method)
Section titled “validate_optional_identity (method)”CodingCheckEvidence.validate_optional_identity(value: str | None, info) -> str | Nonevalidate_optional_fingerprint (method)
Section titled “validate_optional_fingerprint (method)”CodingCheckEvidence.validate_optional_fingerprint(value: str | None, info) -> str | Nonesettled_pass (property)
Section titled “settled_pass (property)”CodingCheckEvidence.settled_pass() -> boolRelease source · Runtime guarantees · Capability guides
CodingCommandEvidence
Section titled “CodingCommandEvidence”from cayu import CodingCommandEvidenceBases: _FrozenCodingModel.
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 |
|---|---|---|
selector |
str |
required |
event_id |
str |
required |
selector_fingerprint |
str |
required |
argv_sha256 |
str | None |
None |
status |
str |
required |
exit_code |
StrictInt | None |
None |
duration_ms |
StrictInt | None |
Field(default=None, ge=0) |
output_sha256 |
str | None |
None |
output_artifact |
CodingArtifactReference | None |
None |
output_truncated |
StrictBool |
False |
output_runner_truncated |
StrictBool |
False |
output_projection_truncated |
StrictBool |
False |
output_artifact_status |
str | None |
None |
exit_code_admitted |
StrictBool |
False |
output_collection_complete |
StrictBool |
False |
output_publication_complete |
StrictBool |
False |
timed_out |
StrictBool |
False |
cancelled |
StrictBool |
False |
workspace_mutation_settlement |
str | None |
None |
validate_optional_identity (method)
Section titled “validate_optional_identity (method)”CodingCommandEvidence.validate_optional_identity(value: str | None, info) -> str | Nonevalidate_optional_fingerprint (method)
Section titled “validate_optional_fingerprint (method)”CodingCommandEvidence.validate_optional_fingerprint(value: str | None, info) -> str | Nonesettled (property)
Section titled “settled (property)”CodingCommandEvidence.settled() -> boolRelease source · Runtime guarantees · Capability guides
CodingGitBaselineAuthority
Section titled “CodingGitBaselineAuthority”from cayu import CodingGitBaselineAuthorityApplication-observed clean Git state for the admitted source tree.
Bases: _FrozenCodingModel.
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 |
|---|---|---|
head_revision |
str |
required |
staged_entries_sha256 |
str |
required |
tracked_flags_sha256 |
str |
required |
status_sha256 |
str |
required |
diff_sha256 |
str |
required |
clean |
Literal[True] |
True |
validate_head_revision (method)
Section titled “validate_head_revision (method)”CodingGitBaselineAuthority.validate_head_revision(value: str) -> strvalidate_git_digest (method)
Section titled “validate_git_digest (method)”CodingGitBaselineAuthority.validate_git_digest(value: str, info) -> strRelease source · Runtime guarantees · Capability guides
CodingGitEntry
Section titled “CodingGitEntry”from cayu import CodingGitEntryBases: _FrozenCodingModel.
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 |
|---|---|---|
path |
str |
required |
index |
str |
required |
worktree |
str |
required |
renamed_from |
str | None |
None |
validate_entry_text (method)
Section titled “validate_entry_text (method)”CodingGitEntry.validate_entry_text(value: str | None, info) -> str | Nonevalidate_status_code (method)
Section titled “validate_status_code (method)”CodingGitEntry.validate_status_code(value: str, info) -> strRelease source · Runtime guarantees · Capability guides
CodingGitEvidence
Section titled “CodingGitEvidence”from cayu import CodingGitEvidenceBases: _FrozenCodingModel.
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 |
|---|---|---|
event_id |
str |
required |
mode |
Literal['diff'] |
'diff' |
scope |
str |
required |
artifact |
CodingArtifactReference |
required |
entries |
tuple[CodingGitEntry, ...] |
() |
entry_count |
StrictInt |
Field(ge=0) |
truncated |
StrictBool |
False |
binary_omitted |
StrictBool |
False |
validate_identity (method)
Section titled “validate_identity (method)”CodingGitEvidence.validate_identity(value: str, info) -> strvalidate_entry_count (method)
Section titled “validate_entry_count (method)”CodingGitEvidence.validate_entry_count() -> CodingGitEvidenceRelease source · Runtime guarantees · Capability guides
CodingGitStatusEvidence
Section titled “CodingGitStatusEvidence”from cayu import CodingGitStatusEvidenceBases: _FrozenCodingModel.
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 |
|---|---|---|
event_id |
str |
required |
mode |
Literal['status'] |
'status' |
scope |
str |
required |
entries |
tuple[CodingGitEntry, ...] |
() |
truncated |
StrictBool |
False |
validate_identity (method)
Section titled “validate_identity (method)”CodingGitStatusEvidence.validate_identity(value: str, info) -> strRelease source · Runtime guarantees · Capability guides
CodingGitSummaryEntry
Section titled “CodingGitSummaryEntry”from cayu import CodingGitSummaryEntryBases: CodingGitEntry.
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 |
|---|---|---|
path |
str |
required |
index |
str |
required |
worktree |
str |
required |
renamed_from |
str | None |
None |
additions |
StrictInt | None |
Field(default=None, ge=0) |
deletions |
StrictInt | None |
Field(default=None, ge=0) |
count_kind |
Literal['text', 'binary', 'untracked', 'unknown'] |
required |
validate_entry_text (method)
Section titled “validate_entry_text (method)”CodingGitSummaryEntry.validate_entry_text(value: str | None, info) -> str | Nonevalidate_status_code (method)
Section titled “validate_status_code (method)”CodingGitSummaryEntry.validate_status_code(value: str, info) -> strRelease source · Runtime guarantees · Capability guides
CodingGitSummaryEvidence
Section titled “CodingGitSummaryEvidence”from cayu import CodingGitSummaryEvidenceBases: _FrozenCodingModel.
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 |
|---|---|---|
event_id |
str |
required |
mode |
Literal['summary'] |
'summary' |
scope |
str |
required |
entries |
tuple[CodingGitSummaryEntry, ...] |
() |
truncated |
StrictBool |
False |
validate_identity (method)
Section titled “validate_identity (method)”CodingGitSummaryEvidence.validate_identity(value: str, info) -> strRelease source · Runtime guarantees · Capability guides
CodingLifecycleReceipt
Section titled “CodingLifecycleReceipt”from cayu import CodingLifecycleReceiptOne append-only, idempotently addressable product-state transition.
Bases: _FrozenCodingModel.
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 |
|---|---|---|
schema_version |
Literal['cayu.coding_product_lifecycle.v1'] |
'cayu.coding_product_lifecycle.v1' |
product_run_id |
str |
required |
session_id |
str |
required |
request_fingerprint |
str |
required |
ordinal |
StrictInt |
Field(ge=1, le=CODING_PRODUCT_MAX_LIFECYCLE_RECEIPTS) |
prior_state |
CodingProductState | None |
None |
state |
CodingProductState |
required |
evidence_sha256 |
str | None |
None |
reason_code |
str | None |
None |
validate_optional_identity (method)
Section titled “validate_optional_identity (method)”CodingLifecycleReceipt.validate_optional_identity(value: str | None, info) -> str | Nonevalidate_request_fingerprint (method)
Section titled “validate_request_fingerprint (method)”CodingLifecycleReceipt.validate_request_fingerprint(value: str) -> strvalidate_evidence_sha256 (method)
Section titled “validate_evidence_sha256 (method)”CodingLifecycleReceipt.validate_evidence_sha256(value: str | None) -> str | Nonevalidate_transition (method)
Section titled “validate_transition (method)”CodingLifecycleReceipt.validate_transition() -> CodingLifecycleReceiptRelease source · Runtime guarantees · Capability guides
CodingMutationEvidence
Section titled “CodingMutationEvidence”from cayu import CodingMutationEvidenceBases: _FrozenCodingModel.
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 |
|---|---|---|
tool_name |
str |
required |
event_id |
str |
required |
outcome |
str |
required |
operation_identity |
str | None |
None |
artifact |
CodingArtifactReference | None |
None |
evidence_sha256 |
str |
required |
requires_fresh_read |
StrictBool |
False |
validate_optional_identity (method)
Section titled “validate_optional_identity (method)”CodingMutationEvidence.validate_optional_identity(value: str | None, info) -> str | Nonevalidate_evidence_sha256 (method)
Section titled “validate_evidence_sha256 (method)”CodingMutationEvidence.validate_evidence_sha256(value: str) -> strsettled (property)
Section titled “settled (property)”CodingMutationEvidence.settled() -> boolRelease source · Runtime guarantees · Capability guides
CodingProductAdmissionError
Section titled “CodingProductAdmissionError”from cayu import CodingProductAdmissionErrorThe application-supplied product authority cannot be admitted.
Bases: ValueError.
This type’s implementation and inherited behavior are available in the linked release source.
Release source · Runtime guarantees · Capability guides
CodingProductArtifactRepository
Section titled “CodingProductArtifactRepository”from cayu import CodingProductArtifactRepositoryDurable append-only lifecycle and result storage over an ArtifactStore.
init (method)
Section titled “init (method)”CodingProductArtifactRepository.__init__(store: ArtifactStore) -> Noneconfiguration_fingerprint (property)
Section titled “configuration_fingerprint (property)”CodingProductArtifactRepository.configuration_fingerprint() -> strlifecycle_artifact_id (method)
Section titled “lifecycle_artifact_id (method)”CodingProductArtifactRepository.lifecycle_artifact_id(product_run_id: str, ordinal: int) -> strrequest_artifact_id (method)
Section titled “request_artifact_id (method)”CodingProductArtifactRepository.request_artifact_id(product_run_id: str) -> strexecution_claim_artifact_id (method)
Section titled “execution_claim_artifact_id (method)”CodingProductArtifactRepository.execution_claim_artifact_id(product_run_id: str) -> stracquire_execution_claim (method)
Section titled “acquire_execution_claim (method)”async CodingProductArtifactRepository.acquire_execution_claim(request: CodingProductRequest, *, claim_id: str) -> CodingArtifactReferenceAtomically fence one stable product identity before session dispatch.
validate_candidate_artifacts (method)
Section titled “validate_candidate_artifacts (method)”async CodingProductArtifactRepository.validate_candidate_artifacts(candidate: CodingProductCandidate) -> NoneReconstruct every artifact capable of supporting a successful candidate.
load_request (method)
Section titled “load_request (method)”async CodingProductArtifactRepository.load_request(product_run_id: str, *, session_id: str) -> CodingProductRequestLoad the exact admitted request used to recover a stable product run.
ensure_request (method)
Section titled “ensure_request (method)”async CodingProductArtifactRepository.ensure_request(request: CodingProductRequest) -> CodingArtifactReferencePublish once or verify the already-admitted immutable request authority.
append_lifecycle (method)
Section titled “append_lifecycle (method)”async CodingProductArtifactRepository.append_lifecycle(receipt: CodingLifecycleReceipt) -> CodingArtifactReferenceload_lifecycle (method)
Section titled “load_lifecycle (method)”async CodingProductArtifactRepository.load_lifecycle(product_run_id: str, *, session_id: str, request_fingerprint: str) -> tuple[tuple[CodingLifecycleReceipt, ...], tuple[str, ...]]load_initial_source_observation (method)
Section titled “load_initial_source_observation (method)”async CodingProductArtifactRepository.load_initial_source_observation(request: CodingProductRequest) -> WorkspaceRevisionObservationRead the exact retained baseline; this does not authorize execution.
publish_source_observation (method)
Section titled “publish_source_observation (method)”async CodingProductArtifactRepository.publish_source_observation(*, session_id: str, agent_name: str, environment_name: str, phase: Literal['initial', 'final'], observation: WorkspaceRevisionObservation) -> CodingSourceObservationEvidenceRetain one bounded complete source manifest by immutable content identity.
publish_candidate (method)
Section titled “publish_candidate (method)”async CodingProductArtifactRepository.publish_candidate(candidate: CodingProductCandidate) -> CodingProductPublicationread_candidate (method)
Section titled “read_candidate (method)”async CodingProductArtifactRepository.read_candidate(reference: CompletionResultReference) -> CodingProductCandidateload_publication (method)
Section titled “load_publication (method)”async CodingProductArtifactRepository.load_publication(*, request_fingerprint: str, digest: str) -> CodingProductPublicationReconstruct one content-addressed result after acknowledgement loss.
publish_git_diff (method)
Section titled “publish_git_diff (method)”async CodingProductArtifactRepository.publish_git_diff(*, session_id: str, agent_name: str, environment_name: str, event_id: str, content: str) -> CodingArtifactReferenceRelease source · Runtime guarantees · Capability guides
CodingProductCandidate
Section titled “CodingProductCandidate”from cayu import CodingProductCandidateBounded candidate evidence evaluated before patch-ready success.
Bases: _FrozenCodingModel.
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 |
|---|---|---|
schema_version |
Literal['cayu.coding_product_result.v1'] |
'cayu.coding_product_result.v1' |
product_run_id |
str |
required |
request_fingerprint |
str |
required |
session_id |
str |
required |
agent_name |
str |
required |
interaction_id |
str | None |
None |
task_id |
str |
required |
state |
CodingProductState |
required |
source_origin_id |
str |
required |
source_workspace_id |
str |
required |
source_destination_id |
str |
required |
initial_revision |
str |
required |
initial_git |
CodingGitBaselineAuthority |
required |
final_revision |
str | None |
None |
initial_source |
CodingSourceObservationEvidence |
required |
final_source |
CodingSourceObservationEvidence |
required |
runtime |
CodingRuntimeAuthority |
required |
checks |
tuple[CodingCheckEvidence, ...] |
() |
commands |
tuple[CodingCommandEvidence, ...] |
() |
mutations |
tuple[CodingMutationEvidence, ...] |
() |
git_status |
CodingGitStatusEvidence | None |
None |
git_summary |
CodingGitSummaryEvidence | None |
None |
git |
CodingGitEvidence | None |
None |
review |
CodingReviewSettlement |
required |
publication |
CodingPublicationEvidence |
required |
lifecycle_receipt_ids |
tuple[str, ...] |
() |
external_delivery_performed |
StrictBool |
False |
remaining_delivery_action |
Literal['commit_push_or_provider_delivery'] |
'commit_push_or_provider_delivery' |
warnings |
tuple[str, ...] |
(_TRUSTED_DOCKER_WARNING,) |
validate_identity (method)
Section titled “validate_identity (method)”CodingProductCandidate.validate_identity(value: str, info) -> strvalidate_optional_interaction_id (method)
Section titled “validate_optional_interaction_id (method)”CodingProductCandidate.validate_optional_interaction_id(value: str | None) -> str | Nonevalidate_optional_fingerprint (method)
Section titled “validate_optional_fingerprint (method)”CodingProductCandidate.validate_optional_fingerprint(value: str | None, info) -> str | Nonevalidate_check_order (method)
Section titled “validate_check_order (method)”CodingProductCandidate.validate_check_order(value: tuple[CodingCheckEvidence, ...])validate_lifecycle_ids (method)
Section titled “validate_lifecycle_ids (method)”CodingProductCandidate.validate_lifecycle_ids(value: tuple[str, ...]) -> tuple[str, ...]validate_patch_ready_claim (method)
Section titled “validate_patch_ready_claim (method)”CodingProductCandidate.validate_patch_ready_claim() -> CodingProductCandidatedigest (property)
Section titled “digest (property)”CodingProductCandidate.digest() -> strRelease source · Runtime guarantees · Capability guides
CodingProductCompletionVerifier
Section titled “CodingProductCompletionVerifier”from cayu import CodingProductCompletionVerifierDeterministically verify one exact candidate artifact.
Bases: DeterministicCompletionVerifier.
execution_profile_identity (property)
Section titled “execution_profile_identity (property)”CodingProductCompletionVerifier.execution_profile_identity() -> ExecutionProfileBehaviorIdentityexecution_profile_components (property)
Section titled “execution_profile_components (property)”CodingProductCompletionVerifier.execution_profile_components() -> tuple[CompletionVerifierProfileComponentDeclaration, ...]Return stable identities for other decision-bearing dependencies.
verify (method)
Section titled “verify (method)”async CodingProductCompletionVerifier.verify(request: CompletionVerifierRequest) -> CompletionVerifierDecisioninit (method)
Section titled “init (method)”CodingProductCompletionVerifier.__init__(request: CodingProductRequest, repository: CodingProductArtifactRepository, *, public_authority_alias_codec: PublicAuthorityAliasCodec | None=None) -> NoneRelease source · Runtime guarantees · Capability guides
CodingProductEvidenceError
Section titled “CodingProductEvidenceError”from cayu import CodingProductEvidenceErrorRuntime evidence cannot support an authoritative product result.
Bases: ValueError.
This type’s implementation and inherited behavior are available in the linked release source.
Release source · Runtime guarantees · Capability guides
CodingProductExecutionInspection
Section titled “CodingProductExecutionInspection”from cayu import CodingProductExecutionInspectionRead-only exact-release projection, not caller-supplied cleanup authority.
Decorators: @dataclass(frozen=True).
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 |
|---|---|---|
request_fingerprint |
str |
required |
release_fingerprint |
str |
required |
events |
tuple[Event, ...] |
required |
tool_call_ordinals |
tuple[int | None, ...] |
required |
Release source · Runtime guarantees · Capability guides
CodingProductPublication
Section titled “CodingProductPublication”from cayu import CodingProductPublicationDecorators: @dataclass(frozen=True).
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 |
|---|---|---|
candidate |
CodingProductCandidate |
required |
result_reference |
CompletionResultReference |
required |
evidence_reference |
WorkEvidenceReference |
required |
artifact |
CodingArtifactReference |
required |
Release source · Runtime guarantees · Capability guides
CodingProductReconstructionRequiredError
Section titled “CodingProductReconstructionRequiredError”from cayu import CodingProductReconstructionRequiredErrorDurable evidence must be reconciled before execution can continue.
Bases: RuntimeError.
This type’s implementation and inherited behavior are available in the linked release source.
Release source · Runtime guarantees · Capability guides
CodingProductRequest
Section titled “CodingProductRequest”from cayu import CodingProductRequestComplete immutable application authority for one coding-product run.
Bases: _FrozenCodingModel.
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 |
|---|---|---|
schema_version |
Literal['cayu.coding_product.v1'] |
CODING_PRODUCT_SCHEMA_VERSION |
product_run_id |
str |
required |
session_id |
str |
required |
agent_name |
str |
required |
source |
CodingSourceAuthority |
required |
task |
CodingTaskAuthority |
required |
runtime |
CodingRuntimeAuthority |
required |
settlement |
CodingSettlementPolicy |
Field(default_factory=CodingSettlementPolicy) |
parent_session_id |
str | None |
None |
causal_budget_id |
str | None |
None |
validate_optional_lineage (method)
Section titled “validate_optional_lineage (method)”CodingProductRequest.validate_optional_lineage(value: str | None, info) -> str | Nonevalidate_identity (method)
Section titled “validate_identity (method)”CodingProductRequest.validate_identity(value: str, info) -> strvalidate_distinct_authority (method)
Section titled “validate_distinct_authority (method)”CodingProductRequest.validate_distinct_authority() -> CodingProductRequestfingerprint (property)
Section titled “fingerprint (property)”CodingProductRequest.fingerprint() -> strRelease source · Runtime guarantees · Capability guides
CodingProductResultResolver
Section titled “CodingProductResultResolver”from cayu import CodingProductResultResolverResolve only the accepted immutable coding-product result artifact.
Bases: CompletionResultResolver.
resolve (method)
Section titled “resolve (method)”async CodingProductResultResolver.resolve(request: CompletionResultResolverRequest) -> dict[str, object]init (method)
Section titled “init (method)”CodingProductResultResolver.__init__(request: CodingProductRequest, repository: CodingProductArtifactRepository) -> NoneRelease source · Runtime guarantees · Capability guides
CodingProductRunner
Section titled “CodingProductRunner”from cayu import CodingProductRunnerRun one ordinary Cayu session and retain authoritative product evidence.
init (method)
Section titled “init (method)”CodingProductRunner.__init__(app: CayuApp, *, source_workspace: Workspace, repository: CodingProductArtifactRepository, source_git_authority_validator: Callable[[CodingGitBaselineAuthority], Awaitable[None]], observation_limits: WorkspaceRevisionObservationLimits | None=None) -> Nonerun (method)
Section titled “run (method)”async CodingProductRunner.run(request: CodingProductRequest, run_request: RunRequest, *, review_settlement: CodingReviewSettlement | None=None) -> CodingProductPublicationExecute, compile, and durably publish one bounded coding-product result.
recover_settled_execution (method)
Section titled “recover_settled_execution (method)”async CodingProductRunner.recover_settled_execution(request: CodingProductRequest, *, review_settlement: CodingReviewSettlement | None=None) -> CodingProductPublicationPublish an exact settled original invocation without executing it again.
Unfinished or resumed invocations require registered Runtime recovery; this entrance does not grant continuation or clear the execution claim.
inspect_settled_execution (method)
Section titled “inspect_settled_execution (method)”async CodingProductRunner.inspect_settled_execution(request: CodingProductRequest) -> CodingProductExecutionInspectionRead an exact original invocation with durable Runtime release evidence.
This does not publish a product, resume execution, or establish that an enclosing application worker has stopped. Consumers must separately reconcile that owner and any ambiguous external effects. An interrupted invocation is not evidence of a successful coding result.
Release source · Runtime guarantees · Capability guides
CodingProductState
Section titled “CodingProductState”from cayu import CodingProductStateDurable product states, including every non-success settlement class.
Bases: StrEnum.
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 |
|---|---|---|
ADMITTED |
class attribute |
'admitted' |
PREPARING_WORKSPACE |
class attribute |
'preparing_workspace' |
ACTIVE |
class attribute |
'active' |
CHECKS_NOT_RUN |
class attribute |
'checks_not_run' |
CHECKS_FAILED |
class attribute |
'checks_failed' |
SOURCE_CONFLICT |
class attribute |
'source_conflict' |
TOOLCHAIN_REBUILD_REQUIRED |
class attribute |
'toolchain_rebuild_required' |
REVIEW_REQUIRED |
class attribute |
'review_required' |
HUMAN_INPUT_REQUIRED |
class attribute |
'human_input_required' |
READY_TO_PUBLISH |
class attribute |
'ready_to_publish' |
PUBLISHING |
class attribute |
'publishing' |
PATCH_READY_FOR_DELIVERY |
class attribute |
'patch_ready_for_delivery' |
BLOCKED |
class attribute |
'blocked' |
DENIED |
class attribute |
'denied' |
CANCELLED |
class attribute |
'cancelled' |
FAILED |
class attribute |
'failed' |
PARTIAL |
class attribute |
'partial' |
AMBIGUOUS |
class attribute |
'ambiguous' |
RECONSTRUCTION_REQUIRED |
class attribute |
'reconstruction_required' |
Release source · Runtime guarantees · Capability guides
CodingPublicationEvidence
Section titled “CodingPublicationEvidence”from cayu import CodingPublicationEvidenceBases: _FrozenCodingModel.
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 |
|---|---|---|
event_id |
str |
required |
destination_id |
str |
required |
outcome |
Literal['copied', 'unchanged', 'conflicted', 'partial', 'failed', 'cancelled', 'ambiguous'] |
required |
baseline_revision |
str |
required |
final_revision |
str | None |
None |
snapshot_id |
str | None |
None |
snapshot_sha256 |
str | None |
None |
receipt_sha256 |
str | None |
None |
destination_workspace_id |
str | None |
None |
workload_workspace_id |
str | None |
None |
source_conflict_policy |
Literal['require_revision'] | None |
None |
sync_back |
Literal['always'] | None |
None |
delete_missing |
StrictBool | None |
None |
copied_files |
StrictInt | None |
Field(default=None, ge=0) |
copied_bytes |
StrictInt | None |
Field(default=None, ge=0) |
deleted_files |
StrictInt | None |
Field(default=None, ge=0) |
detail_code |
str | None |
None |
validate_optional_identity (method)
Section titled “validate_optional_identity (method)”CodingPublicationEvidence.validate_optional_identity(value: str | None, info) -> str | Nonevalidate_optional_revision (method)
Section titled “validate_optional_revision (method)”CodingPublicationEvidence.validate_optional_revision(value: str | None, info) -> str | Nonesettled (property)
Section titled “settled (property)”CodingPublicationEvidence.settled() -> boolvalidate_settled_receipt_integrity (method)
Section titled “validate_settled_receipt_integrity (method)”CodingPublicationEvidence.validate_settled_receipt_integrity() -> CodingPublicationEvidenceRelease source · Runtime guarantees · Capability guides
CodingReviewSettlement
Section titled “CodingReviewSettlement”from cayu import CodingReviewSettlementBases: _FrozenCodingModel.
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 |
|---|---|---|
reviewer |
Literal['not_required', 'passed', 'required', 'failed', 'ambiguous'] |
required |
human |
Literal['not_required', 'approved', 'required', 'denied', 'ambiguous'] |
required |
reviewer_event_id |
str | None |
None |
human_event_id |
str | None |
None |
validate_optional_identity (method)
Section titled “validate_optional_identity (method)”CodingReviewSettlement.validate_optional_identity(value: str | None, info) -> str | NoneRelease source · Runtime guarantees · Capability guides
CodingRuntimeAuthority
Section titled “CodingRuntimeAuthority”from cayu import CodingRuntimeAuthorityExact admitted Docker, tool, policy, approval, and redaction identity.
Bases: _FrozenCodingModel.
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 |
|---|---|---|
execution_kind |
Literal['trusted_repository_docker'] |
'trusted_repository_docker' |
environment_name |
str |
'coding' |
network |
Literal['none'] |
'none' |
credential_visibility |
Literal['non_possession'] |
'non_possession' |
toolchain_profile_id |
str |
required |
toolchain_profile_revision |
str |
required |
toolchain_profile_fingerprint |
str |
required |
image_fingerprint |
str |
required |
dependency_identity |
str |
required |
execution_profile_fingerprint |
str |
required |
tool_manifest_fingerprint |
str |
required |
tool_policy_fingerprint |
str |
required |
approval_policy_fingerprint |
str |
required |
redaction_profile_fingerprint |
str |
required |
validate_identity (method)
Section titled “validate_identity (method)”CodingRuntimeAuthority.validate_identity(value: str, info) -> strvalidate_fingerprint (method)
Section titled “validate_fingerprint (method)”CodingRuntimeAuthority.validate_fingerprint(value: str, info) -> strRelease source · Runtime guarantees · Capability guides
CodingSettlementPolicy
Section titled “CodingSettlementPolicy”from cayu import CodingSettlementPolicyFinite application-owned completion gates.
Bases: _FrozenCodingModel.
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 |
|---|---|---|
required_checks |
tuple[str, ...] |
('format', 'lint', 'test') |
reviewer_required |
StrictBool |
True |
human_approval_required |
StrictBool |
False |
max_events |
StrictInt |
Field(default=CODING_PRODUCT_MAX_EVENTS, ge=1, le=100000) |
max_event_bytes |
StrictInt |
Field(default=CODING_PRODUCT_MAX_EVENT_BYTES, ge=1024, le=128 * 1024 * 1024) |
max_result_bytes |
StrictInt |
Field(default=CODING_PRODUCT_MAX_RESULT_BYTES, ge=4096, le=CODING_PRODUCT_MAX_RESULT_BYTES) |
validate_required_checks (method)
Section titled “validate_required_checks (method)”CodingSettlementPolicy.validate_required_checks(value: tuple[str, ...]) -> tuple[str, ...]Release source · Runtime guarantees · Capability guides
CodingSourceAuthority
Section titled “CodingSourceAuthority”from cayu import CodingSourceAuthorityApplication-owned source origin, immutable baseline, and destination.
Bases: _FrozenCodingModel.
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 |
|---|---|---|
origin_id |
str |
required |
workspace_id |
str |
required |
baseline_revision |
str |
required |
destination_id |
str |
required |
path_scope |
Literal['complete'] |
'complete' |
git_baseline |
CodingGitBaselineAuthority |
required |
observation_limits |
WorkspaceRevisionObservationLimits |
required |
validate_identity (method)
Section titled “validate_identity (method)”CodingSourceAuthority.validate_identity(value: str, info) -> strvalidate_baseline (method)
Section titled “validate_baseline (method)”CodingSourceAuthority.validate_baseline(value: str) -> strRelease source · Runtime guarantees · Capability guides
CodingSourceObservationEvidence
Section titled “CodingSourceObservationEvidence”from cayu import CodingSourceObservationEvidenceBounded source-manifest evidence retained outside the product result.
Bases: _FrozenCodingModel.
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 |
|---|---|---|
observer |
str |
required |
workspace_id |
str |
required |
status |
WorkspaceRevisionObservationStatus |
required |
path_scope |
Literal['complete', 'changed'] |
required |
revision |
str | None |
None |
total_paths |
StrictInt |
Field(ge=0) |
artifact |
CodingArtifactReference |
required |
validate_identity (method)
Section titled “validate_identity (method)”CodingSourceObservationEvidence.validate_identity(value: str, info) -> strvalidate_revision (method)
Section titled “validate_revision (method)”CodingSourceObservationEvidence.validate_revision(value: str | None) -> str | Nonevalidate_supported_observation (method)
Section titled “validate_supported_observation (method)”CodingSourceObservationEvidence.validate_supported_observation() -> CodingSourceObservationEvidenceRelease source · Runtime guarantees · Capability guides
CodingTaskAuthority
Section titled “CodingTaskAuthority”from cayu import CodingTaskAuthorityImmutable application task identity without copying task prose into evidence.
Bases: _FrozenCodingModel.
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 |
|---|---|---|
task_id |
str |
required |
instruction_sha256 |
str |
required |
validate_task_id (method)
Section titled “validate_task_id (method)”CodingTaskAuthority.validate_task_id(value: str) -> strvalidate_instruction_sha256 (method)
Section titled “validate_instruction_sha256 (method)”CodingTaskAuthority.validate_instruction_sha256(value: str) -> strRelease source · Runtime guarantees · Capability guides
collect_coding_product_events
Section titled “collect_coding_product_events”from cayu import collect_coding_product_eventsCollect an already bounded event stream for application-level composition tests.
async collect_coding_product_events(events: AsyncIterator[Event]) -> tuple[Event, ...]Release source · Runtime guarantees · Capability guides
compile_coding_product_candidate
Section titled “compile_coding_product_candidate”from cayu import compile_coding_product_candidateCompile bounded public runtime events into verifier-ready product evidence.
async compile_coding_product_candidate(request: CodingProductRequest, events: Sequence[Event], *, initial_observation: WorkspaceRevisionObservation, final_observation: WorkspaceRevisionObservation, repository: CodingProductArtifactRepository, lifecycle_receipt_ids: tuple[str, ...]=(), review_settlement: CodingReviewSettlement | None=None, public_authority_alias_codec: PublicAuthorityAliasCodec | None=None) -> CodingProductCandidateRelease source · Runtime guarantees · Capability guides
register_coding_product_contract
Section titled “register_coding_product_contract”from cayu import register_coding_product_contractPublish and reconstruct the exact verifier/resolver during app startup.
async register_coding_product_contract(app: CayuApp, request: CodingProductRequest, repository: CodingProductArtifactRepository) -> WorkContract