fastsim.api.scenario

Public Python API for fastsim.api.scenario; signatures are extracted directly from FastSim source.

Public symbols 6

class

L31

class ScenarioSection(StrEnum)

The three authored sections in a locked :class:`ScenarioPlan`.

class

L39

class ScenarioReadErrorCode(StrEnum)

Stable error codes emitted by ``fastsim.scenario.read@1``.

class

L49

class ScenarioComponentSelection(object)

Exact Scenario component release selected by a referenced Run.

class

L80

class ScenarioIdentity(object)

Portable identity of the immutable Scenario projected for one Run.

Field	Type	Default
run_id	str	—
plan_digest	str	—
scenario_digest	str	—
source_kind	str	—
selected_component	ScenarioComponentSelection \| None	—
schema	str	SCENARIO_PROJECTION_SCHEMA

class

L112

class ScenarioReadError(RuntimeError)

Typed, bounded failure from ``fastsim.scenario.read@1``.

class

L144

class ScenarioReadService(Protocol)

Read-only, section-scoped projection of one locked ScenarioPlan.

service_id

ScenarioReadService.service_id(self) -> str

available_sections

ScenarioReadService.available_sections(self) -> tuple[ScenarioSection, ...]

identity

ScenarioReadService.identity(self) -> ScenarioIdentity

get

ScenarioReadService.get(self, section: ScenarioSection | str) -> FrozenMapping | None