cayu.environments 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.

DEFAULT_SYNC_BINDING_STAGING_CAPACITY

from cayu.environments import DEFAULT_SYNC_BINDING_STAGING_CAPACITY

DEFAULT_SYNC_BINDING_STAGING_CAPACITY = SyncBindingStagingCapacity()

Release source · Runtime guarantees · Capability guides

DEFAULT_SYNC_STAGING_MAX_BYTES

from cayu.environments import DEFAULT_SYNC_STAGING_MAX_BYTES

DEFAULT_SYNC_STAGING_MAX_BYTES = 512 * 1024 * 1024

Release source · Runtime guarantees · Capability guides

DEFAULT_SYNC_STAGING_MAX_CONCURRENCY

from cayu.environments import DEFAULT_SYNC_STAGING_MAX_CONCURRENCY

DEFAULT_SYNC_STAGING_MAX_CONCURRENCY = 4

Release source · Runtime guarantees · Capability guides

SyncBindingStagingCapacity

from cayu.environments import SyncBindingStagingCapacity

Fair process-local governor for aggregate SyncBinding staging resources.

Transfer slots and byte reservations are separately queued. Existing admitted transfers receive byte reservations before new transfers so a full slot queue cannot deadlock the work that must release those slots. Each queue remains FIFO.

init (method)

SyncBindingStagingCapacity.__init__(*, max_concurrency: int=DEFAULT_SYNC_STAGING_MAX_CONCURRENCY, max_staged_bytes: int=DEFAULT_SYNC_STAGING_MAX_BYTES, reuse_sealed_archives: bool=True) -> None

snapshot (method)

SyncBindingStagingCapacity.snapshot() -> SyncBindingStagingSnapshot

Release source · Runtime guarantees · Capability guides

SyncBindingStagingCapacityError

from cayu.environments import SyncBindingStagingCapacityError

A SyncBinding transfer cannot fit inside its staging capacity domain.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

SyncBindingStagingSnapshot

from cayu.environments import SyncBindingStagingSnapshot

Bounded content-free state for one process-local staging capacity domain.

Decorators: @dataclass(frozen=True, slots=True).

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
max_concurrency	int	required
max_staged_bytes	int	required
active_transfers	int	required
staged_bytes	int	required
waiting_transfers	int	required
waiting_bytes	int	required
shared_archives	int	required
archive_references	int	required
peak_active_transfers	int	required
peak_staged_bytes	int	required
total_transfer_admissions	int	required
total_archive_builds	int	required
total_archive_reuses	int	required
total_archive_cleanups	int	required
total_transfer_wait_seconds	float	required
total_byte_wait_seconds	float	required
oldest_transfer_wait_seconds	float	required
oldest_byte_wait_seconds	float	required

Release source · Runtime guarantees · Capability guides