Super State Machine gives you utilities to build finite state machines.
Project description
Super State Machine gives you utilities to build finite state machines.
Free software: BSD license
Documentation: https://super_state_machine.readthedocs.org
Features
Fully tested with Python 2.7, 3.3, 3.4 and PyPy.
Create finite state machines:
>>> from enum import Enum >>> from super_state_machine import machines >>> class Task(machines.StateMachine): ... ... state = 'draft' ... ... class States(Enum): ... ... DRAFT = 'draft' ... SCHEDULED = 'scheduled' ... PROCESSING = 'processing' ... SENT = 'sent' ... FAILED = 'failed' >>> task = Task() >>> task.is_draft False >>> task.set_draft() >>> task.state 'draft' >>> task.state = 'scheduled' >>> task.is_scheduled True >>> task.state = 'process' >>> task.state 'processing' >>> task.state = 'wrong' *** ValueError: Unrecognized value ('wrong').
Define allowed transitions graph, define additional named transitions and checkers:
>>> class Task(machines.StateMachine): ... ... class States(Enum): ... ... DRAFT = 'draft' ... SCHEDULED = 'scheduled' ... PROCESSING = 'processing' ... SENT = 'sent' ... FAILED = 'failed' ... ... class Meta: ... ... allow_empty = False ... initial_state = 'draft' ... transitions = { ... 'draft': ['scheduled', 'failed'], ... 'scheduled': ['failed'], ... 'processing': ['sent', 'failed'] ... } ... named_transitions = [ ... ('process', 'processing', ['scheduled']), ... ('fail', 'failed') ... ] ... named_checkers = [ ... ('can_be_processed', 'processing'), ... ] >>> task = Task() >>> task.state 'draft' >>> task.process() *** TransitionError: Cannot transit from 'draft' to 'processing'. >>> task.set_scheduled() >>> task.can_be_processed True >>> task.process() >>> task.state 'processing' >>> task.fail() >>> task.state 'failed'
Note, that third argument restricts from which states transition will be added to allowed (in case of process, new allowed transition will be added, from ‘scheduled’ to ‘processing’). No argument means all available states, None or empty list won’t add anything beyond defined ones.
Use state machines as properties:
>>> from enum import Enum
>>> from super_state_machine import machines, extras
>>> class Lock(machine.StateMachine):
... class States(Enum):
...
... OPEN = 'open'
... LOCKED = 'locked'
...
... class Meta:
...
... allow_empty = False
... initial_state = 'locked'
... named_transitions = [
... ('open', 'open'),
... ('lock', 'locked'),
... ]
>>> class Safe(object):
...
... lock1 = extras.PropertyMachine(Lock)
... lock2 = extras.PropertyMachine(Lock)
... lock3 = extras.PropertyMachine(Lock)
...
... locks = ['lock1', 'lock2', 'lock3']
...
... def is_locked(self):
... locks = [getattr(self, lock).is_locked for lock in self.locks]
... return any(locks)
...
... def is_open(self):
... locks = [getattr(self, lock).is_open for lock in self.locks]
... return all(locks)
>>> safe = Safe()
>>> safe.lock1
'locked'
>>> safe.is_open
False
>>> safe.lock1.open()
>>> safe.lock1.is_open
True
>>> safe.lock1
'open'
>>> safe.is_open
False
>>> safe.lock2.open()
>>> safe.lock3 = 'open'
>>> safe.is_open
True
History
2.0.2 (2017-03-13)
Fixed requirements for Python > 3.4.
2.0.1 (2017-02-27)
Remove enum34 for Python > 3.4.
Added support for Python 2.6.
2.0 (2016-09-26)
Added force_set method.
Added field machine.
Added support for Python 3.5.
Backward compatibility breaks:
Empty state is now disallowed.
Only full names are allowed, when using scalars, no shortcuts.
Removed support for unhashable types.
1.0 (2014-09-04)
Added all basic features.
0.1.0 (2014-08-08)
First release on PyPI.
Added utilities to create simple state machine.
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
Built Distribution
Hashes for super_state_machine-2.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e038a4c573ab80f157bf726c3036367919704f62cd166eb46837143165035958 |
|
MD5 | 296e32ba7c2ca34e4e4cf0e8715f3bc4 |
|
BLAKE2b-256 | 84ee2c55720ce1c35e00299e57e673945c5d6379f5fc1cbe9e7d0405ca11cc72 |
Hashes for super_state_machine-2.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f615d55970be4ab57f5121a15b60568145effa49e9316a2eaaf51b0b81f3456 |
|
MD5 | f0e60be7403d98115646b818628fadbe |
|
BLAKE2b-256 | 5ac00d5a60657096284b81b70f9a8e3a75de7e433f45b3c5ad17fbd312f15f59 |