State
SP state API wrappers.
kxi.sp.state.Unpickle (IntEnum)
An enumeration.
kxi.sp.state.Unpickle.auto
kxi.sp.state.Unpickle.false
kxi.sp.state.Unpickle.true
kxi.sp.state.Pickle (IntEnum)
An enumeration.
kxi.sp.state.Pickle.false
kxi.sp.state.Pickle.true
kxi.sp.state.get
Get the state of an operator.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
operator |
Union[str, pykx.wrappers.SymbolAtom, pykx.wrappers.Dictionary] |
The operator, specified as a configuration dictionary or name. |
required |
metadata |
Dictionary |
The metadata dictionary, provided for specialized data retrieval. |
required |
unpickle |
Unpickle |
A |
<Unpickle.auto: 2> |
Returns:
Type | Description |
---|---|
Any |
The data that was stored in the operator's state. |
kxi.sp.state.set
Set the state of an operator.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
operator |
Union[str, pykx.wrappers.SymbolAtom, pykx.wrappers.Dictionary] |
The operator, specified as a configuration dictionary or name. |
required |
metadata |
Dictionary |
The metadata dictionary, provided for specialized data storage. |
required |
data |
Any |
The data to be stored. By default the data will be converted to a |
required |
pickle |
Pickle |
A |
<Pickle.false: 0> |
Returns:
Type | Description |
---|---|
Any |
The data that was stored in the operator's state. |