cayu.egress.transitions
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.
advance_egress_authority_transition
Section titled “advance_egress_authority_transition”from cayu.egress import advance_egress_authority_transitionBuild the next legal revision without mutating the current record.
advance_egress_authority_transition(current: EgressAuthorityTransitionRecord, *, state: EgressAuthorityTransitionState, reason: str, receipt: EgressAuthorityCutoverReceipt | None=None, environment_fingerprint: str | None=None) -> EgressAuthorityTransitionRecordRelease source · Runtime guarantees · Capability guides
authorized_egress_authority_transition
Section titled “authorized_egress_authority_transition”from cayu.egress import authorized_egress_authority_transitionConvert one trusted adopted profile decision into installation authority.
authorized_egress_authority_transition(*, decision: ExecutionProfileDecision, transition_id: str, environment_name: str, owner_fingerprint: str, source_environment_fingerprint: str) -> EgressAuthorityTransitionRecordRelease source · Runtime guarantees · Capability guides
egress_authority_owner_fingerprint
Section titled “egress_authority_owner_fingerprint”from cayu.egress import egress_authority_owner_fingerprintCommit a private worker ownership token without persisting it.
egress_authority_owner_fingerprint(owner_token: str) -> strRelease source · Runtime guarantees · Capability guides
EGRESS_AUTHORITY_TRANSITION_CHECKPOINT_KEY
Section titled “EGRESS_AUTHORITY_TRANSITION_CHECKPOINT_KEY”from cayu.egress import EGRESS_AUTHORITY_TRANSITION_CHECKPOINT_KEYEGRESS_AUTHORITY_TRANSITION_CHECKPOINT_KEY = 'cayu:egress_authority_transition'Release source · Runtime guarantees · Capability guides
egress_authority_transition_events
Section titled “egress_authority_transition_events”from cayu.egress import egress_authority_transition_eventsProject bounded, deterministic, credential-free evidence for one revision.
egress_authority_transition_events(record: EgressAuthorityTransitionRecord) -> tuple[Event, ...]Release source · Runtime guarantees · Capability guides
EGRESS_AUTHORITY_TRANSITION_SCHEMA_VERSION
Section titled “EGRESS_AUTHORITY_TRANSITION_SCHEMA_VERSION”from cayu.egress import EGRESS_AUTHORITY_TRANSITION_SCHEMA_VERSIONEGRESS_AUTHORITY_TRANSITION_SCHEMA_VERSION = 3Release source · Runtime guarantees · Capability guides
EgressAuthorityAdoptionHandler
Section titled “EgressAuthorityAdoptionHandler”from cayu.egress import EgressAuthorityAdoptionHandlerApplication-owned installer invoked by real profile admission.
The runtime passes the exact sealed decision produced by its profile policy.
Implementations own their retained environment, private worker token, and
transition identity. They must use the supplied coordinator to durably finish
the corresponding transition; the runtime independently reloads and verifies
ACTIVE before admission.
Bases: ABC.
adopt (method)
Section titled “adopt (method)”async EgressAuthorityAdoptionHandler.adopt(decision: ExecutionProfileDecision, *, coordinator: EgressAuthorityTransitionCoordinator, expected_environment_fingerprint: str, factory_result: EnvironmentFactoryResult) -> EgressAuthorityAdoptionResultReturn proof for the exact retained pre-cutover environment.
Release source · Runtime guarantees · Capability guides
EgressAuthorityAdoptionResult
Section titled “EgressAuthorityAdoptionResult”from cayu.egress import EgressAuthorityAdoptionResultRuntime-owned handoff from backend cutover to invocation lifecycle.
The result remains owned by the application handler until the invocation claims it after durable admission. Claiming is single-use, so the exact factory result cannot be adopted by two invocations or cleaned twice.
init (method)
Section titled “init (method)”EgressAuthorityAdoptionResult.__init__(*, transition: EgressAuthorityTransitionRecord, factory_result: EnvironmentFactoryResult, coordinator_authority: object, _token: object) -> Noneenvironment (property)
Section titled “environment (property)”EgressAuthorityAdoptionResult.environment()Return the retained environment for runtime verification only.
Release source · Runtime guarantees · Capability guides
EgressAuthorityTransitionConflict
Section titled “EgressAuthorityTransitionConflict”from cayu.egress import EgressAuthorityTransitionConflictA stale worker attempted to advance a different transition revision.
Bases: RuntimeError.
This type’s implementation and inherited behavior are available in the linked release source.
Release source · Runtime guarantees · Capability guides
EgressAuthorityTransitionCoordinator
Section titled “EgressAuthorityTransitionCoordinator”from cayu.egress import EgressAuthorityTransitionCoordinatorInstall one authorized target and durably classify every outcome.
init (method)
Section titled “init (method)”EgressAuthorityTransitionCoordinator.__init__(store: SessionCheckpointEgressAuthorityTransitionStore, *, expected_source_environment_fingerprint: str | None=None) -> Noneauthorize (method)
Section titled “authorize (method)”async EgressAuthorityTransitionCoordinator.authorize(record: EgressAuthorityTransitionRecord) -> EgressAuthorityTransitionRecordinstall (method)
Section titled “install (method)”async EgressAuthorityTransitionCoordinator.install(*, authorized: EgressAuthorityTransitionRecord, adapter: SandboxEgressAdapter, request: EgressAuthorityCutoverRequest, owner_token: str) -> tuple[EgressAuthorityTransitionRecord, EgressAuthorityCutoverResult | None]reconcile (method)
Section titled “reconcile (method)”async EgressAuthorityTransitionCoordinator.reconcile(*, current: EgressAuthorityTransitionRecord, adapter: SandboxEgressAdapter, request: EgressAuthorityCutoverRequest, owner_token: str) -> EgressAuthorityTransitionRecordActivate only exact backend proof; otherwise persist needs-attention.
Release source · Runtime guarantees · Capability guides
EgressAuthorityTransitionRecord
Section titled “EgressAuthorityTransitionRecord”from cayu.egress import EgressAuthorityTransitionRecordOne reconstructable state in an egress-authority adoption lifecycle.
Bases: BaseModel.
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 |
|---|---|---|
record_type |
Literal['cayu.egress-authority-transition'] |
'cayu.egress-authority-transition' |
schema_version |
Literal[3] |
EGRESS_AUTHORITY_TRANSITION_SCHEMA_VERSION |
transition_id |
str |
Field(max_length=256) |
session_id |
str |
Field(max_length=256) |
environment_name |
str |
Field(max_length=256) |
revision |
StrictInt |
Field(ge=1) |
state |
EgressAuthorityTransitionState |
required |
owner_fingerprint |
str |
required |
expected_authority |
EgressAuthorityIdentity |
required |
target_authority |
EgressAuthorityIdentity |
required |
classification |
EgressAuthorityChangeKind |
required |
policy_identity |
str |
Field(max_length=256) |
actor |
ResolutionActor |
required |
authorization_reason |
str |
Field(max_length=_TEXT_MAX_CHARS) |
reason |
str |
Field(max_length=_TEXT_MAX_CHARS) |
strategy |
EgressAuthorityCutoverStrategy |
required |
source_environment_fingerprint |
str |
required |
environment_fingerprint |
str | None |
None |
receipt |
EgressAuthorityCutoverReceipt | None |
None |
fingerprint |
str |
required |
validate_identity_text (method)
Section titled “validate_identity_text (method)”EgressAuthorityTransitionRecord.validate_identity_text(value: str, info) -> strvalidate_reason (method)
Section titled “validate_reason (method)”EgressAuthorityTransitionRecord.validate_reason(value: str) -> strcopy_actor (method)
Section titled “copy_actor (method)”EgressAuthorityTransitionRecord.copy_actor(value: object) -> ResolutionActorcopy_authority (method)
Section titled “copy_authority (method)”EgressAuthorityTransitionRecord.copy_authority(value: object) -> EgressAuthorityIdentitycopy_receipt (method)
Section titled “copy_receipt (method)”EgressAuthorityTransitionRecord.copy_receipt(value: object) -> EgressAuthorityCutoverReceipt | Nonevalidate_digest (method)
Section titled “validate_digest (method)”EgressAuthorityTransitionRecord.validate_digest(value: str | None, info) -> str | Nonevalidate_transition (method)
Section titled “validate_transition (method)”EgressAuthorityTransitionRecord.validate_transition() -> EgressAuthorityTransitionRecordRelease source · Runtime guarantees · Capability guides
SessionCheckpointEgressAuthorityTransitionStore
Section titled “SessionCheckpointEgressAuthorityTransitionStore”from cayu.egress import SessionCheckpointEgressAuthorityTransitionStoreCAS transition storage using every SessionStore’s atomic checkpoint seam.
init (method)
Section titled “init (method)”SessionCheckpointEgressAuthorityTransitionStore.__init__(session_store: SessionStore, *, event_writer: RuntimeEventWriter | None=None) -> Noneload (method)
Section titled “load (method)”async SessionCheckpointEgressAuthorityTransitionStore.load(session_id: str) -> EgressAuthorityTransitionRecord | Nonecompare_and_set (method)
Section titled “compare_and_set (method)”async SessionCheckpointEgressAuthorityTransitionStore.compare_and_set(*, expected: EgressAuthorityTransitionRecord | None, replacement: EgressAuthorityTransitionRecord) -> EgressAuthorityTransitionRecord