cayu.workspaces.references

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.

WorkspaceReferenceBinding

from cayu.workspaces import WorkspaceReferenceBinding

Serializable ownership assertion, not a file or permission certificate.

Create with Workspace.reference_binding() or ToolContext.workspace_reference_binding(). Consume with ToolContext.require_workspace_binding() before using application claims.

Bases: BaseModel.

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[1]	1
identity	WorkspaceIdentity	required
generation	str	required

validate_generation (method)

WorkspaceReferenceBinding.validate_generation(value: str) -> str

require_match (method)

WorkspaceReferenceBinding.require_match(selected: WorkspaceReferenceBinding) -> None

Check against an observed binding; never against reconstructed metadata.

Release source · Runtime guarantees · Capability guides

WorkspaceReferenceBindingError

from cayu.workspaces import WorkspaceReferenceBindingError

An application reference cannot be used for the selected workspace.

Bases: RuntimeError.

init (method)

WorkspaceReferenceBindingError.__init__(code: Literal['workspace_binding_unavailable', 'workspace_binding_mismatch'])

Release source · Runtime guarantees · Capability guides