cayu.collaboration.planning

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.

ConfiguredRequestPlanningPolicy

from cayu.collaboration import ConfiguredRequestPlanningPolicy

Closed, deterministic strategy with reconstructable immutable configuration.

A rule matches one exact effective-input revision. Otherwise the required default applies. No callback, model, ambient application state or implicit clock participates in evaluation. Owner-time eligibility is checked later by the durable planning owner, not inferred from this strategy’s choice.

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
algorithm	Literal['input_revision_rules_v1']	'input_revision_rules_v1'
reference	ObjectRef	required
limits	RequestPlanningLimits	required
rules	tuple[RequestPlanningRule, ...]	Field(max_length=MAX_REQUEST_PLANNING_RULES)
default	RequestPlanningDecision	required

bounded_input (method)

ConfiguredRequestPlanningPolicy.bounded_input(value: object) -> Any

immutable_fields (method)

ConfiguredRequestPlanningPolicy.immutable_fields() -> ContractValue

canonical_rules (method)

ConfiguredRequestPlanningPolicy.canonical_rules() -> ConfiguredRequestPlanningPolicy

Release source · Runtime guarantees · Capability guides

planning_policy_commitment

from cayu.collaboration import planning_policy_commitment

Complete canonical configuration identity, not proof of registration.

planning_policy_commitment(policy: ConfiguredRequestPlanningPolicy, *, redactor: SecretRedactor) -> str

Release source · Runtime guarantees · Capability guides

RequestPlanningClarify

from cayu.collaboration import RequestPlanningClarify

An exact native question proposal; disclosure must still be authenticated.

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
decision	Literal['clarify']	'clarify'
opening	ClarificationOpenCommand	required
source	SessionExportRequest	required

bounded_input (method)

RequestPlanningClarify.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningClarify.immutable_fields() -> ContractValue

exact_source (method)

RequestPlanningClarify.exact_source() -> RequestPlanningClarify

Release source · Runtime guarantees · Capability guides

RequestPlanningContinue

from cayu.collaboration import RequestPlanningContinue

Frozen selection data; the native receiver must authenticate it again.

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
decision	Literal['continue']	'continue'
prepared	PreparedRecipientAdmission	required

bounded_input (method)

RequestPlanningContinue.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningContinue.immutable_fields() -> ContractValue

exact_kind (method)

RequestPlanningContinue.exact_kind() -> RequestPlanningContinue

Release source · Runtime guarantees · Capability guides

RequestPlanningControl

from cayu.collaboration import RequestPlanningControl

Exact disposition of one retained revision; never a new execution permit.

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	RequestPlanningRequest	required
expected_revision	Generation	required
kind	Literal['cancelled', 'expired']	required
initiator	InitiatorBinding	required

bounded_input (method)

RequestPlanningControl.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningControl.immutable_fields() -> ContractValue

same_owner (method)

RequestPlanningControl.same_owner() -> RequestPlanningControl

Release source · Runtime guarantees · Capability guides

RequestPlanningDecline

from cayu.collaboration import RequestPlanningDecline

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
decision	Literal['decline']	'decline'
reason	Identifier	required

bounded_input (method)

RequestPlanningDecline.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningDecline.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestPlanningDefer

from cayu.collaboration import RequestPlanningDefer

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
decision	Literal['defer']	'defer'
prerequisite	Annotated[RequestPlanningTimer | RequestPlanningPrerequisite, Field(discriminator='kind')]	required

bounded_input (method)

RequestPlanningDefer.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningDefer.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestPlanningFork

from cayu.collaboration import RequestPlanningFork

Frozen source selection and child preflight; native owners supply authority.

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
decision	Literal['fork']	'fork'
preparation	ForkRecipientPreparation	required
resources	tuple[RequestPlanningResource, ...]	Field(default=(), max_length=MAX_REQUEST_PLANNING_RESOURCES)

bounded_input (method)

RequestPlanningFork.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningFork.immutable_fields() -> ContractValue

resource_destinations (method)

RequestPlanningFork.resource_destinations()

Release source · Runtime guarantees · Capability guides

RequestPlanningFresh

from cayu.collaboration import RequestPlanningFresh

Frozen native preparation, consumed only through its retained stage 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
decision	Literal['fresh']	'fresh'
preparation	FreshRecipientPreparation	required
resources	tuple[RequestPlanningResource, ...]	Field(default=(), max_length=MAX_REQUEST_PLANNING_RESOURCES)

bounded_input (method)

RequestPlanningFresh.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningFresh.immutable_fields() -> ContractValue

resource_destinations (method)

RequestPlanningFresh.resource_destinations()

Release source · Runtime guarantees · Capability guides

RequestPlanningLimits

from cayu.collaboration import RequestPlanningLimits

Required finite ceilings; store/application limits may only narrow them.

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
max_generations	StrictInt	Field(ge=1, le=MAX_REQUEST_PLANNING_GENERATIONS)
max_stages	StrictInt	Field(ge=1, le=MAX_REQUEST_PLANNING_STAGES)
max_resources	StrictInt	Field(ge=0, le=MAX_REQUEST_PLANNING_RESOURCES)
max_record_bytes	StrictInt	Field(ge=1, le=MAX_REQUEST_PLANNING_RECORD_BYTES)
max_recovery_items	StrictInt	Field(ge=1, le=MAX_REQUEST_PLANNING_PAGE)

bounded_input (method)

RequestPlanningLimits.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningLimits.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestPlanningPredecessor

from cayu.collaboration import RequestPlanningPredecessor

Exact state being replaced; a reference alone is not successor authority.

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
revision	Generation	required

bounded_input (method)

RequestPlanningPredecessor.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningPredecessor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestPlanningPrerequisite

from cayu.collaboration import RequestPlanningPrerequisite

Expected receiving-owner evidence, not a receipt supplied by a caller.

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
kind	Literal['admission']	'admission'
reader	ObjectRef	required
expected	RequestAdmissionCommand	required
deadline_at_ms	Millis	required

bounded_input (method)

RequestPlanningPrerequisite.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningPrerequisite.immutable_fields() -> ContractValue

pinned_reader (method)

RequestPlanningPrerequisite.pinned_reader() -> RequestPlanningPrerequisite

Release source · Runtime guarantees · Capability guides

RequestPlanningRequest

from cayu.collaboration import RequestPlanningRequest

Complete caller expectation; policy registration and authority remain external.

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
mode	Literal['request_plan']	'request_plan'
operation	OperationRef	required
expected	RequestCommand	required
expected_revision	Generation	required
expected_input_revision	PlanningInputRevision	required
expected_input_sha256	Commitment	required
planning_generation	StrictInt	Field(ge=1, le=MAX_REQUEST_PLANNING_GENERATIONS)
admission_operation	OperationRef	required
admission_generation	Generation	required
initiator	InitiatorBinding	required
policy	ObjectRef	required
policy_sha256	Commitment	required
limits	RequestPlanningLimits	required
deadline_at_ms	Millis	required
predecessor	RequestPlanningPredecessor | None	required

bounded_input (method)

RequestPlanningRequest.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningRequest.immutable_fields() -> ContractValue

coherent (method)

RequestPlanningRequest.coherent() -> RequestPlanningRequest

Release source · Runtime guarantees · Capability guides

RequestPlanningRule

from cayu.collaboration import RequestPlanningRule

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
input_revision	PlanningInputRevision	required
proposal	RequestPlanningDecision	required

bounded_input (method)

RequestPlanningRule.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningRule.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestPlanningTimer

from cayu.collaboration import RequestPlanningTimer

Absolute owner-time threshold, not a renewed relative timeout.

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
kind	Literal['timer']	'timer'
not_before_ms	Millis	required
deadline_at_ms	Millis	required

bounded_input (method)

RequestPlanningTimer.bounded_input(value: object) -> Any

immutable_fields (method)

RequestPlanningTimer.immutable_fields() -> ContractValue

finite_interval (method)

RequestPlanningTimer.finite_interval() -> RequestPlanningTimer

Release source · Runtime guarantees · Capability guides