cayu.artifacts.local
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.
LocalArtifactStore
Section titled “LocalArtifactStore”from cayu.artifacts import LocalArtifactStoreLocal filesystem implementation of ArtifactStore.
Decorators: @model_store_surface('artifacts').
Bases: ArtifactStore.
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 |
|---|---|---|
id |
str |
required |
artifact_access_version |
class attribute |
1 |
put_bytes (method)
Section titled “put_bytes (method)”async LocalArtifactStore.put_bytes(content: bytes, *, artifact_id: str | None=None, filename: str, content_type: str | None=None, scope: ArtifactScope=ArtifactScope.SESSION, session_id: str | None=None, agent_name: str | None=None, environment_name: str | None=None, metadata: dict[str, Any] | None=None) -> ArtifactMetadataread_bytes (method)
Section titled “read_bytes (method)”async LocalArtifactStore.read_bytes(artifact_id: str, *, max_bytes: int | None=None) -> ArtifactReadResultread_range (method)
Section titled “read_range (method)”async LocalArtifactStore.read_range(artifact_id: str, *, offset: int, max_bytes: int) -> ArtifactReadResultlist (method)
Section titled “list (method)”async LocalArtifactStore.list(*, scope: ArtifactScope | None=None, session_id: str | None=None, agent_name: str | None=None, environment_name: str | None=None, limit: int | None=None) -> ArtifactListResultsupports_session_closure_claims (property)
Section titled “supports_session_closure_claims (property)”LocalArtifactStore.supports_session_closure_claims() -> boolload_session_closure_claim (method)
Section titled “load_session_closure_claim (method)”async LocalArtifactStore.load_session_closure_claim(session_id: str) -> ArtifactClosureClaim | Noneclaim_session_closure (method)
Section titled “claim_session_closure (method)”async LocalArtifactStore.claim_session_closure(session_id: str, plan_id: str, *, max_records: int, max_bytes: int) -> ArtifactClosureClaimdelete_session_closure_artifact (method)
Section titled “delete_session_closure_artifact (method)”async LocalArtifactStore.delete_session_closure_artifact(claim: ArtifactClosureClaim, artifact_id: str) -> Nonesupports_pins (property)
Section titled “supports_pins (property)”LocalArtifactStore.supports_pins() -> boolpin (method)
Section titled “pin (method)”async LocalArtifactStore.pin(artifact_id: str, *, owner: str) -> Nonerelease_pin (method)
Section titled “release_pin (method)”async LocalArtifactStore.release_pin(artifact_id: str, *, owner: str) -> Nonedelete (method)
Section titled “delete (method)”async LocalArtifactStore.delete(artifact_id: str) -> Noneinit (method)
Section titled “init (method)”LocalArtifactStore.__init__(root: str | Path, *, store_id: str | None=None) -> None