← Python SDK / output

PYTHONPUBLIC API

fastsim.api.output

Current public Python API for fastsim.api.output; signatures are extracted directly from the vNext AST.

RunOutputError RunOutputPolicy RunOutputCommitReceipt RunOutputAbortReceipt RunOutputValidationReceipt RunOutputFileLease RunOutputReadbackLease RunOutputTransaction RunOutputService

Public symbols 9

class

RunOutputError

L24

class RunOutputError(RuntimeError)

Stable fail-closed error raised by the output capability.

class

RunOutputPolicy

L39

class RunOutputPolicy(object)

Trusted deployment policy with a pre-opened canonical local root. The descriptor is private and never enters a Run document, ExecutionPlan, lockfile, manifest, or plugin grant. Each composed Run duplicates the pinned descriptor, so the caller may close its policy after ``open_plan`` returns.

closed

RunOutputPolicy.closed(self) -> bool

No public docstring is provided in the current source.

RunOutputPolicy.close(self) -> None

No public docstring is provided in the current source.

class

RunOutputCommitReceipt

L197

class RunOutputCommitReceipt(object)

No public docstring is provided in the current source.

Field	Type	Default
run_id	str	—
plugin_instance	str	—
transaction_id	str	—
logical_name	str	—
format	str	—
bytes_written	int	—
integrity	str	—
sha256	str \| None	—
committed_monotonic_ns	int	—
schema	str	field(default='fastsim-run-output-commit/2', init=False)

class

RunOutputAbortReceipt

L223

class RunOutputAbortReceipt(object)

No public docstring is provided in the current source.

Field	Type	Default
run_id	str	—
plugin_instance	str	—
transaction_id	str	—
reason_code	str	—
bytes_written	int	—
preserved_incomplete	bool	—
incomplete_logical_name	str \| None	—
schema	str	field(default='fastsim-run-output-abort/1', init=False)

class

RunOutputValidationReceipt

L247

class RunOutputValidationReceipt(object)

Small format-neutral proof produced by an independent validator worker.

Field	Type	Default
validator_schema	str	—
validation_profile	str	—
integrity	str	—
validated_bytes	int	—
content_sha256	str \| None	—
footer_identity	str	—
schema	str	field(default='fastsim-run-output-validation/2', init=False)

class

RunOutputFileLease

L280

class RunOutputFileLease(Protocol)

No public docstring is provided in the current source.

closed

RunOutputFileLease.closed(self) -> bool

No public docstring is provided in the current source.

bytes_written

RunOutputFileLease.bytes_written(self) -> int

No public docstring is provided in the current source.

handoff_to_worker

RunOutputFileLease.handoff_to_worker(self, worker_identity: int) -> None

No public docstring is provided in the current source.

write

RunOutputFileLease.write(self, data: memoryview) -> int

No public docstring is provided in the current source.

flush

RunOutputFileLease.flush(self) -> None

No public docstring is provided in the current source.

RunOutputFileLease.close(self) -> None

No public docstring is provided in the current source.

class

RunOutputReadbackLease

L297

class RunOutputReadbackLease(Protocol)

No public docstring is provided in the current source.

closed

RunOutputReadbackLease.closed(self) -> bool

No public docstring is provided in the current source.

size_bytes

RunOutputReadbackLease.size_bytes(self) -> int

No public docstring is provided in the current source.

handoff_to_worker

RunOutputReadbackLease.handoff_to_worker(self, worker_identity: int) -> None

No public docstring is provided in the current source.

readinto

RunOutputReadbackLease.readinto(self, buffer: memoryview) -> int

No public docstring is provided in the current source.

seek

RunOutputReadbackLease.seek(self, offset: int, whence: int=os.SEEK_SET) -> int

No public docstring is provided in the current source.

tell

RunOutputReadbackLease.tell(self) -> int

No public docstring is provided in the current source.

RunOutputReadbackLease.close(self) -> None

No public docstring is provided in the current source.

class

RunOutputTransaction

L316

class RunOutputTransaction(Protocol)

No public docstring is provided in the current source.

integrity

RunOutputTransaction.integrity(self) -> str

No public docstring is provided in the current source.

transaction_id

RunOutputTransaction.transaction_id(self) -> str

No public docstring is provided in the current source.

logical_name

RunOutputTransaction.logical_name(self) -> str

No public docstring is provided in the current source.

open_stream

RunOutputTransaction.open_stream(self) -> RunOutputFileLease

No public docstring is provided in the current source.

seal

RunOutputTransaction.seal(self, lease: RunOutputFileLease) -> None

No public docstring is provided in the current source.

open_readback

RunOutputTransaction.open_readback(self) -> RunOutputReadbackLease

No public docstring is provided in the current source.

confirm_validation

RunOutputTransaction.confirm_validation(self, readback_lease: RunOutputReadbackLease, validation_receipt: RunOutputValidationReceipt) -> None

No public docstring is provided in the current source.

commit

RunOutputTransaction.commit(self) -> RunOutputCommitReceipt

No public docstring is provided in the current source.

abort

RunOutputTransaction.abort(self, reason_code: str='PLUGIN_ABORTED') -> RunOutputAbortReceipt

No public docstring is provided in the current source.

class

RunOutputService

L344

class RunOutputService(Protocol)

No public docstring is provided in the current source.

service_id

RunOutputService.service_id(self) -> str

No public docstring is provided in the current source.

begin_primary

RunOutputService.begin_primary(self, logical_name: str, format: str, idempotency_key: str) -> RunOutputTransaction

No public docstring is provided in the current source.