cayu.collaboration.lifecycle

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.

CollaborationHistoryUnavailable

from cayu.collaboration import CollaborationHistoryUnavailable

A retained-history cursor no longer proves complete traversal.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

CollaborationNamespaceRetired

from cayu.collaboration import CollaborationNamespaceRetired

Fresh admission is forbidden; inspect namespace evidence separately.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

LifecycleCommand

from cayu.collaboration import LifecycleCommand

Bases: ExpectedOperation[LifecycleIntent].

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
operation	OperationRef	required
kind	Literal['namespace_seal', 'namespace_rotate', 'namespace_retire', 'namespace_prune', 'participant_lifecycle']	required
schema_version	VersionOne	1
mode	Literal['lifecycle']	'lifecycle'
source	OwnerRef	required
destination	OwnerRef	required
initiator	InitiatorBinding	required
receipt_stage	Literal['committed']	'committed'
intent	IntentT	required

bounded_input (method)

LifecycleCommand.bounded_input(value: object) -> Any

immutable_fields (method)

LifecycleCommand.immutable_fields() -> ContractValue

operation_scope (method)

LifecycleCommand.operation_scope() -> ExpectedOperation[IntentT]

exact_control_authority (method)

LifecycleCommand.exact_control_authority() -> LifecycleCommand

Release source · Runtime guarantees · Capability guides

LifecycleIntent

from cayu.collaboration import LifecycleIntent

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
request	LifecycleRequest	required
limits	CollaborationLimits	required

bounded_input (method)

LifecycleIntent.bounded_input(value: object) -> Any

immutable_fields (method)

LifecycleIntent.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

LifecycleReceipt

from cayu.collaboration import LifecycleReceipt

Immutable accepted transition, not a claim about later live state.

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
expected	LifecycleCommand	required
namespace	NamespaceSnapshot | None	None
successor	NamespaceSnapshot | None	None
participant	ParticipantSnapshot | None	None
event	ParticipantEvent	required
removed_records	Counter	0
pruned_through	Counter | None	None
retention_revision	Generation | None	None
complete	StrictBool | None	None

bounded_input (method)

LifecycleReceipt.bounded_input(value: object) -> Any

immutable_fields (method)

LifecycleReceipt.immutable_fields() -> ContractValue

exact_transition (method)

LifecycleReceipt.exact_transition() -> LifecycleReceipt

Release source · Runtime guarantees · Capability guides

NamespaceInspection

from cayu.collaboration import NamespaceInspection

Current state, distinct from immutable bootstrap and control receipts.

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
current	NamespaceSnapshot	required
retired_through	Counter	required
pruned_through	Counter	required
retention_revision	Generation	required
retained_generations	Generation	required

bounded_input (method)

NamespaceInspection.bounded_input(value: object) -> Any

immutable_fields (method)

NamespaceInspection.immutable_fields() -> ContractValue

ordered_floors (method)

NamespaceInspection.ordered_floors() -> NamespaceInspection

Release source · Runtime guarantees · Capability guides

NamespacePrune

from cayu.collaboration import NamespacePrune

One exact bounded batch; a fresh key is required for a later batch.

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
operation	OperationRef	required
namespace	NamespaceRef	required
expected_retention_revision	Generation	required
max_records	Annotated[StrictInt, Field(ge=1, le=32)]	32
kind	Literal['namespace_prune']	'namespace_prune'

bounded_input (method)

NamespacePrune.bounded_input(value: object) -> Any

immutable_fields (method)

NamespacePrune.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

NamespaceRef

from cayu.collaboration import NamespaceRef

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
owner	OwnerRef	required
namespace_incarnation	Identifier	required
generation	Generation	required

bounded_input (method)

NamespaceRef.bounded_input(value: object) -> Any

immutable_fields (method)

NamespaceRef.immutable_fields() -> ContractValue

operation (method)

NamespaceRef.operation(caller_key: str) -> OperationRef

Release source · Runtime guarantees · Capability guides

NamespaceRetire

from cayu.collaboration import NamespaceRetire

Retire the next contiguous generation from a later control generation.

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
operation	OperationRef	required
namespace	NamespaceRef	required
expected_revision	Generation	required
expected_retired_through	Counter	required
kind	Literal['namespace_retire']	'namespace_retire'

bounded_input (method)

NamespaceRetire.bounded_input(value: object) -> Any

immutable_fields (method)

NamespaceRetire.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

NamespaceRetirementEvidence

from cayu.collaboration import NamespaceRetirementEvidence

Admission rejection evidence, never a replacement for an exact receipt.

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
namespace	NamespaceRef	required
retired_through	Generation	required
pruned_through	Counter	required
content	Literal['retained', 'partial', 'pruned']	required

bounded_input (method)

NamespaceRetirementEvidence.bounded_input(value: object) -> Any

immutable_fields (method)

NamespaceRetirementEvidence.immutable_fields() -> ContractValue

proven_floor (method)

NamespaceRetirementEvidence.proven_floor() -> NamespaceRetirementEvidence

Release source · Runtime guarantees · Capability guides

NamespaceRotate

from cayu.collaboration import NamespaceRotate

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
operation	OperationRef	required
namespace	NamespaceRef	required
expected_revision	Generation	required
kind	Literal['namespace_rotate']	'namespace_rotate'

bounded_input (method)

NamespaceRotate.bounded_input(value: object) -> Any

immutable_fields (method)

NamespaceRotate.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

NamespaceSeal

from cayu.collaboration import NamespaceSeal

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
operation	OperationRef	required
namespace	NamespaceRef	required
expected_revision	Generation	required
kind	Literal['namespace_seal']	'namespace_seal'

bounded_input (method)

NamespaceSeal.bounded_input(value: object) -> Any

immutable_fields (method)

NamespaceSeal.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

NamespaceSnapshot

from cayu.collaboration import NamespaceSnapshot

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
reference	NamespaceRef	required
revision	Generation	required
state	NamespaceState	required
outstanding_obligations	Counter	required
content	Literal['retained', 'partial']	'retained'

bounded_input (method)

NamespaceSnapshot.bounded_input(value: object) -> Any

immutable_fields (method)

NamespaceSnapshot.immutable_fields() -> ContractValue

retired_is_settled (method)

NamespaceSnapshot.retired_is_settled() -> NamespaceSnapshot

Release source · Runtime guarantees · Capability guides

ParticipantLifecycleChange

from cayu.collaboration import ParticipantLifecycleChange

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
operation	OperationRef	required
participant	ParticipantRef	required
expected_lifecycle_revision	Generation	required
state	LifecycleState	required
control_policy	Literal['settle_registered']	'settle_registered'
kind	Literal['participant_lifecycle']	'participant_lifecycle'

bounded_input (method)

ParticipantLifecycleChange.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantLifecycleChange.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides