saealib.core.StateContract#

class saealib.core.StateContract(*, reads=(), writes=(), exports=(), reads_enumerable=True)[source]#

Bases: object

Declare state keys read, written, or exported by a component.

Parameters:

  • reads (tuple[StateKey[object], ...])

  • writes (tuple[StateKey[object], ...])

  • exports (tuple[StateKey[object], ...])

  • reads_enumerable (bool)

Methods

__init__

Method Details

StateContract.__init__(*, reads=(), writes=(), exports=(), reads_enumerable=True)#
Parameters:

  • reads (tuple[StateKey[object], ...])

  • writes (tuple[StateKey[object], ...])

  • exports (tuple[StateKey[object], ...])

  • reads_enumerable (bool)

Return type:

None