Skip to main content

Robust statechart for configurable automation rules.

Project description

Superstate

Robust statechart for configurable automation rules.

How to use

A very simple example taken from specs.

>>> from superstate import StateChart

>>> class SimpleMachine(StateChart):
...     state = {
...         'initial': 'created',
...         'states': [
...             {
...                 'name': 'created',
...                 'transitions': [
...                     {'event': 'queue', 'target': 'waiting'},
...                     {'event': 'cancel', 'target': 'canceled'},
...                 ],
...             },
...             {
...                 'name': 'waiting',
...                 'transitions': [
...                     {'event': 'process', 'target': 'processed'},
...                     {'event': 'cancel', 'target': 'canceled'},
...                 ]
...             },
...             {'name': 'processed'},
...             {'name': 'canceled'},
...         ]
...     }

>>> machine = SimpleMachine()
>>> machine.current_state
'AtomicState(created)'

>>> machine.trigger('queue')
>>> machine.current_state
'AtomicState(waiting)'

>>> machine.trigger('process')
>>> machine.current_state
'AtomicState(processed)'

>>> cancel_machine = SimpleMachine()
>>> cancel_machine.current_state
'AtomicState(created)'

>>> cancel_machine.trigger('cancel')
>>> cancel_machine.current_state
'AtomicState(canceled)'

States

A Superstate state machine must have one initial state and at least one other additional state.

A state may have pre and post callbacks, for running some code on state on_entry and on_exit, respectively. These params can be method names (as strings), callables, or lists of method names or callables.

Transitions

Transitions lead the machine from a state to another. Transitions must have both event, and target parameters. The event is the method that have to be called to launch the transition. The target is the state to which the transition will move the machine. This method is automatically created by the Superstate engine.

A transition can have optional action and cond parameters. action is a method (or callable) that will be called when transition is launched. If parameters are passed to the event method, they are passed to the action method, if it accepts these parameters. cond is a method (or callable) that is called to allow or deny the transition, depending on the result of its execution. Both action and cond can be lists.

The same event can be in multiple transitions, going to different states, having their respective needs as selectors. For the transitions having the same event, only one cond should return a true value at a time.

Install

pip install superstate

Test

tox

Attribution

Superstate is forked from https://github.com/nsi-iff/fluidity created by Rodrigo Manhães.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

superstate-1.6.2a0.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

superstate-1.6.2a0-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

Details for the file superstate-1.6.2a0.tar.gz.

File metadata

  • Download URL: superstate-1.6.2a0.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for superstate-1.6.2a0.tar.gz
Algorithm Hash digest
SHA256 a21e5d88fa3282ca7285e6736d559fc5cf0c5865e42edc7e0c9f95457de3fe5b
MD5 84258292437f74505e9fe14b14293d78
BLAKE2b-256 680f26d609d9024bf9da8eaf407078be08b30ac1cd3d97a4aeba8eefa4f91fdb

See more details on using hashes here.

File details

Details for the file superstate-1.6.2a0-py3-none-any.whl.

File metadata

  • Download URL: superstate-1.6.2a0-py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for superstate-1.6.2a0-py3-none-any.whl
Algorithm Hash digest
SHA256 5955327fcd3a159855f30141689ad8d195d71d69d3a9a10ebfb1e6491ff95144
MD5 8c49e282731e2e14f5f0f1873db30009
BLAKE2b-256 22bb7d0b5741d61560657f3fb9677e800c02021a61dac48696388c036a38db5b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page