saealib.core.StateStore#

class saealib.core.StateStore(initial=None, *, generation=0)[source]#

Bases: object

Own versioned state values and consume each instance after a move.

Parameters:

initial (Mapping[StateKey, object] | None)
generation (int)

Methods

`__init__`
`apply_patch`	Apply `patch` and return the new store, consuming this store.
`contains`	Return whether `key` is present in this store.
`get`	Return the value for `key` or raise `KeyError` if absent.
`view`	Create a read-only view limited to the supplied declared keys.

Method Details

StateStore.__init__(initial=None, *, generation=0)[source]#

Parameters:

initial (Mapping[StateKey, object] | None)
generation (int)

Return type:

None

StateStore.apply_patch(patch)[source]#

Apply patch and return the new store, consuming this store.

All update kinds, targets, and PopulationRowUpdate operations are validated against shadow populations before any owned value is changed. If preflight fails, this store remains live and its values are unchanged. After successful preflight, the operations are committed in write order and this store is consumed.

Parameters:: patch (StatePatch)
Return type:: StateStore

StateStore.contains(key)[source]#

Return whether key is present in this store.

Parameters:: key (StateKey)
Return type:: bool

StateStore.get(key)[source]#

Return the value for key or raise KeyError if absent.

Parameters:: key (StateKey[ValueT])
Return type:: ValueT

StateStore.view(reads, *, context=None, dispatch=None)[source]#

Create a read-only view limited to the supplied declared keys.

Parameters:

reads (Iterable[StateKey] | StateContract)
context (object | None)
dispatch (Callable[[object], None] | None)

Return type:

StateView