cayu.collaboration.recipient_preparation
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.
ForkRecipientCreationPreparation
Section titled “ForkRecipientCreationPreparation”from cayu.collaboration import ForkRecipientCreationPreparationBases: MaterialRecipientCreationPreparation.
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 |
VersionOne |
1 |
base |
FreshRecipientPreparation |
required |
blueprint_commitment |
NativeCommitment |
required |
creation |
SessionCreationTarget |
required |
selection |
ForkRetainedSelection |
required |
resources |
tuple[ResourceMaterialReference, ...] |
Field(default=(), max_length=32) |
bounded_input (method)
Section titled “bounded_input (method)”ForkRecipientCreationPreparation.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ForkRecipientCreationPreparation.immutable_fields() -> ContractValuereceiver (property)
Section titled “receiver (property)”ForkRecipientCreationPreparation.receiver()execution_profile_json (property)
Section titled “execution_profile_json (property)”ForkRecipientCreationPreparation.execution_profile_json()historical_definition_commitment (property)
Section titled “historical_definition_commitment (property)”ForkRecipientCreationPreparation.historical_definition_commitment()budget_binding_json (property)
Section titled “budget_binding_json (property)”ForkRecipientCreationPreparation.budget_binding_json()coherent (method)
Section titled “coherent (method)”ForkRecipientCreationPreparation.coherent()Release source · Runtime guarantees · Capability guides
ForkRecipientPreparation
Section titled “ForkRecipientPreparation”from cayu.collaboration import ForkRecipientPreparationFrozen base preflight and exact view admission, before acquiring history.
The base’s unadmitted creation proposal freezes request/profile/definition and sponsor data. Its resource-free creation permit MUST NOT be registered for this FORK. The material-bound target is resolved and durably retained separately after native selection/adoption, before child creation.
Bases: ContractValue.
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 |
VersionOne |
1 |
base |
FreshRecipientPreparation |
required |
view |
ContextViewSelectionTarget |
required |
bounded_input (method)
Section titled “bounded_input (method)”ForkRecipientPreparation.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ForkRecipientPreparation.immutable_fields() -> ContractValuecoherent (method)
Section titled “coherent (method)”ForkRecipientPreparation.coherent()Release source · Runtime guarantees · Capability guides
FreshRecipientPreparation
Section titled “FreshRecipientPreparation”from cayu.collaboration import FreshRecipientPreparationExact future creation, pinned native profile/definition and sponsor.
SessionStore has not assigned an incarnation. The creation operation is the identity of this proposal; a requested public ID is never substituted for it.
Bases: ContractValue.
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 |
VersionOne |
1 |
receiver |
ObjectRef |
required |
creation |
SessionCreationTarget |
required |
request_json |
StrictStr |
required |
execution_profile_json |
StrictStr |
required |
historical_definition_commitment |
NativeCommitment |
required |
budget_binding_json |
StrictStr |
required |
bounded_input (method)
Section titled “bounded_input (method)”FreshRecipientPreparation.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”FreshRecipientPreparation.immutable_fields() -> ContractValuerequest_snapshot (method)
Section titled “request_snapshot (method)”FreshRecipientPreparation.request_snapshot(value: str) -> strprofile_snapshot (method)
Section titled “profile_snapshot (method)”FreshRecipientPreparation.profile_snapshot(value: str) -> strbudget_snapshot (method)
Section titled “budget_snapshot (method)”FreshRecipientPreparation.budget_snapshot(value: str) -> strcreation_request (property)
Section titled “creation_request (property)”FreshRecipientPreparation.creation_request() -> RecipientSessionCreationRequestcoherent (method)
Section titled “coherent (method)”FreshRecipientPreparation.coherent() -> FreshRecipientPreparationRelease source · Runtime guarantees · Capability guides
ResourceRecipientCreationPreparation
Section titled “ResourceRecipientCreationPreparation”from cayu.collaboration import ResourceRecipientCreationPreparationFRESH creation with authenticated material, but no inherited history.
Bases: MaterialRecipientCreationPreparation.
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 |
VersionOne |
1 |
base |
FreshRecipientPreparation |
required |
blueprint_commitment |
NativeCommitment |
required |
creation |
SessionCreationTarget |
required |
selection |
None |
None |
resources |
tuple[ResourceMaterialReference, ...] |
Field(min_length=1, max_length=32) |
bounded_input (method)
Section titled “bounded_input (method)”ResourceRecipientCreationPreparation.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ResourceRecipientCreationPreparation.immutable_fields() -> ContractValuereceiver (property)
Section titled “receiver (property)”ResourceRecipientCreationPreparation.receiver()execution_profile_json (property)
Section titled “execution_profile_json (property)”ResourceRecipientCreationPreparation.execution_profile_json()historical_definition_commitment (property)
Section titled “historical_definition_commitment (property)”ResourceRecipientCreationPreparation.historical_definition_commitment()budget_binding_json (property)
Section titled “budget_binding_json (property)”ResourceRecipientCreationPreparation.budget_binding_json()coherent (method)
Section titled “coherent (method)”ResourceRecipientCreationPreparation.coherent()