cayu.workspaces definitions

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.

WorkspacePathRevision

from cayu.workspaces import WorkspacePathRevision

Content-free Git/workspace state for one bounded relative path.

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
path	str	required
staged	str | None	None
working_tree	str | None	None
untracked	StrictBool	False
ignored	StrictBool	False
present	StrictBool | None	None
tracked	StrictBool | None	None
kind	Literal['file', 'symlink', 'submodule', 'unknown']	'unknown'
content_sha256	str | None	None
index_object_id	str | None	None
index_mode	str | None	None
worktree_mode	str | None	None
renamed_from	str | None	None

validate_path (method)

WorkspacePathRevision.validate_path(value: str) -> str

validate_optional_text (method)

WorkspacePathRevision.validate_optional_text(value: str | None, info) -> str | None

Release source · Runtime guarantees · Capability guides

WorkspacePathRevisionDelta

from cayu.workspaces import WorkspacePathRevisionDelta

One content-free path change between two observations.

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
path	str	required
change	Literal['added', 'modified', 'deleted', 'renamed']	required
renamed_from	str | None	None

validate_path_text (method)

WorkspacePathRevisionDelta.validate_path_text(value: str | None, info) -> str | None

Release source · Runtime guarantees · Capability guides