Python Finite State Machines made easy.
Project description
===============================
Python State Machine
===============================
.. image:: https://img.shields.io/pypi/v/python-statemachine.svg
:target: https://pypi.python.org/pypi/python-statemachine
.. image:: https://img.shields.io/travis/fgmacedo/python-statemachine.svg?branch=master
:target: https://travis-ci.org/fgmacedo/python-statemachine
:alt: Build status
.. image:: https://codecov.io/gh/fgmacedo/python-statemachine/branch/master/graph/badge.svg
:target: https://codecov.io/gh/fgmacedo/python-statemachine
:alt: Coverage report
.. image:: https://readthedocs.org/projects/python-statemachine/badge/?version=latest
:target: https://python-statemachine.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/fgmacedo/python-statemachine/shield.svg
:target: https://pyup.io/repos/github/fgmacedo/python-statemachine/
:alt: Updates
Python `finite-state machines <https://en.wikipedia.org/wiki/Finite-state_machine>`_ made easy.
* Free software: MIT license
* Documentation: https://python-statemachine.readthedocs.io.
Getting started
===============
To install Python State Machine, run this command in your terminal:
.. code-block:: console
$ pip install python-statemachine
Define your state machine::
from statemachine import StateMachine, State
class TrafficLightMachine(StateMachine):
green = State('Green', initial=True)
yellow = State('Yellow')
red = State('Red')
slowdown = green.to(yellow)
stop = yellow.to(red)
go = red.to(green)
You can now create an instance:
>>> traffic_light = TrafficLightMachine()
And inspect about the current state:
>>> traffic_light.current_state
State('Green', identifier='green', value='green', initial=True)
>>> traffic_light.current_state == TrafficLightMachine.green == traffic_light.green
True
For each state, there's a dinamically created property in the form ``is_<state.identifier>``, that
returns ``True`` if the current status matches the query:
>>> traffic_light.is_green
True
>>> traffic_light.is_yellow
False
>>> traffic_light.is_red
False
Query about metadata:
>>> [s.identifier for s in m.states]
['green', 'red', 'yellow']
>>> [t.identifier for t in m.transitions]
['go', 'slowdown', 'stop']
Call a transition:
>>> traffic_light.slowdown()
And check for the current status:
>>> traffic_light.current_state
State('Yellow', identifier='yellow', value='yellow', initial=False)
>>> traffic_light.is_yellow
True
You can't run a transition from an invalid state:
>>> traffic_light.is_yellow
True
>>> traffic_light.slowdown()
Traceback (most recent call last):
...
LookupError: Can't slowdown when in Yellow.
You can also trigger events in an alternative way, calling the ``run(<transition.identificer>)`` method:
>>> traffic_light.is_yellow
True
>>> traffic_light.run('stop')
>>> traffic_light.is_red
True
A state machine can be instantiated with an initial value:
>>> machine = TrafficLightMachine(start_value='red')
>>> traffic_light.is_red
True
Models
------
If you need to persist the current state on another object, or you're using the
state machine to control the flow of another object, you can pass this object
to the ``StateMachine`` constructor:
>>> class MyModel(object):
... def __init__(self, state):
... self.state = state
...
>>> obj = MyModel(state='red')
>>> traffic_light = TrafficLightMachine(obj)
>>> traffic_light.is_red
True
>>> obj.state
'red'
>>> obj.state = 'green'
>>> traffic_light.is_green
True
>>> traffic_light.slowdown()
>>> obj.state
'yellow'
>>> traffic_light.is_yellow
True
Events
------
Docs needed.
Mixins
------
Docs needed.
History
=======
0.6.0 (2017-08-25)
------------------
* Auto-discovering `statemachine`/`statemachines` under a Django project when
they are requested using the mixin/registry feature.
0.5.1 (2017-07-24)
------------------
* Fix bug on ``CombinedTransition._can_run`` not allowing transitions to run if there are more than
two transitions combined.
0.5.0 (2017-07-13)
------------------
* Custom exceptions.
* Duplicated definition of ``on_execute`` callback is not allowed.
* Fix bug on ``StateMachine.on_<transition.identifier>`` being called with extra ``self`` param.
0.4.2 (2017-07-10)
------------------
* Python 3.6 support.
* Drop official support for Python 3.3.
* `Transition` can be used as decorator for `on_execute` callback definition.
* `Transition` can point to multiple destination states.
0.3.0 (2017-03-22)
------------------
* README getting started section.
* Tests to state machine without model.
0.2.0 (2017-03-22)
------------------
* ``State`` can hold a value that will be assigned to the model as the state value.
* Travis-CI integration.
* RTD integration.
0.1.0 (2017-03-21)
------------------
* First release on PyPI.
Python State Machine
===============================
.. image:: https://img.shields.io/pypi/v/python-statemachine.svg
:target: https://pypi.python.org/pypi/python-statemachine
.. image:: https://img.shields.io/travis/fgmacedo/python-statemachine.svg?branch=master
:target: https://travis-ci.org/fgmacedo/python-statemachine
:alt: Build status
.. image:: https://codecov.io/gh/fgmacedo/python-statemachine/branch/master/graph/badge.svg
:target: https://codecov.io/gh/fgmacedo/python-statemachine
:alt: Coverage report
.. image:: https://readthedocs.org/projects/python-statemachine/badge/?version=latest
:target: https://python-statemachine.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/fgmacedo/python-statemachine/shield.svg
:target: https://pyup.io/repos/github/fgmacedo/python-statemachine/
:alt: Updates
Python `finite-state machines <https://en.wikipedia.org/wiki/Finite-state_machine>`_ made easy.
* Free software: MIT license
* Documentation: https://python-statemachine.readthedocs.io.
Getting started
===============
To install Python State Machine, run this command in your terminal:
.. code-block:: console
$ pip install python-statemachine
Define your state machine::
from statemachine import StateMachine, State
class TrafficLightMachine(StateMachine):
green = State('Green', initial=True)
yellow = State('Yellow')
red = State('Red')
slowdown = green.to(yellow)
stop = yellow.to(red)
go = red.to(green)
You can now create an instance:
>>> traffic_light = TrafficLightMachine()
And inspect about the current state:
>>> traffic_light.current_state
State('Green', identifier='green', value='green', initial=True)
>>> traffic_light.current_state == TrafficLightMachine.green == traffic_light.green
True
For each state, there's a dinamically created property in the form ``is_<state.identifier>``, that
returns ``True`` if the current status matches the query:
>>> traffic_light.is_green
True
>>> traffic_light.is_yellow
False
>>> traffic_light.is_red
False
Query about metadata:
>>> [s.identifier for s in m.states]
['green', 'red', 'yellow']
>>> [t.identifier for t in m.transitions]
['go', 'slowdown', 'stop']
Call a transition:
>>> traffic_light.slowdown()
And check for the current status:
>>> traffic_light.current_state
State('Yellow', identifier='yellow', value='yellow', initial=False)
>>> traffic_light.is_yellow
True
You can't run a transition from an invalid state:
>>> traffic_light.is_yellow
True
>>> traffic_light.slowdown()
Traceback (most recent call last):
...
LookupError: Can't slowdown when in Yellow.
You can also trigger events in an alternative way, calling the ``run(<transition.identificer>)`` method:
>>> traffic_light.is_yellow
True
>>> traffic_light.run('stop')
>>> traffic_light.is_red
True
A state machine can be instantiated with an initial value:
>>> machine = TrafficLightMachine(start_value='red')
>>> traffic_light.is_red
True
Models
------
If you need to persist the current state on another object, or you're using the
state machine to control the flow of another object, you can pass this object
to the ``StateMachine`` constructor:
>>> class MyModel(object):
... def __init__(self, state):
... self.state = state
...
>>> obj = MyModel(state='red')
>>> traffic_light = TrafficLightMachine(obj)
>>> traffic_light.is_red
True
>>> obj.state
'red'
>>> obj.state = 'green'
>>> traffic_light.is_green
True
>>> traffic_light.slowdown()
>>> obj.state
'yellow'
>>> traffic_light.is_yellow
True
Events
------
Docs needed.
Mixins
------
Docs needed.
History
=======
0.6.0 (2017-08-25)
------------------
* Auto-discovering `statemachine`/`statemachines` under a Django project when
they are requested using the mixin/registry feature.
0.5.1 (2017-07-24)
------------------
* Fix bug on ``CombinedTransition._can_run`` not allowing transitions to run if there are more than
two transitions combined.
0.5.0 (2017-07-13)
------------------
* Custom exceptions.
* Duplicated definition of ``on_execute`` callback is not allowed.
* Fix bug on ``StateMachine.on_<transition.identifier>`` being called with extra ``self`` param.
0.4.2 (2017-07-10)
------------------
* Python 3.6 support.
* Drop official support for Python 3.3.
* `Transition` can be used as decorator for `on_execute` callback definition.
* `Transition` can point to multiple destination states.
0.3.0 (2017-03-22)
------------------
* README getting started section.
* Tests to state machine without model.
0.2.0 (2017-03-22)
------------------
* ``State`` can hold a value that will be assigned to the model as the state value.
* Travis-CI integration.
* RTD integration.
0.1.0 (2017-03-21)
------------------
* First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python-statemachine-0.6.0.tar.gz
(21.7 kB
view hashes)
Built Distribution
Close
Hashes for python-statemachine-0.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5e40687372aaa405a6c42dcb897f528d4117f3f5f616a246ed8ddea6b164b39 |
|
MD5 | 178cbf32c32dd8493744a5c3ad02ff36 |
|
BLAKE2b-256 | 4c380e38317f2355f2fa217f263f2b59e0a7ed3b9a33467700add1599bd628a6 |
Close
Hashes for python_statemachine-0.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f102e4def617bf75c5c3c709516471241c808fa8950eeb9a5e8d42e39e89be3a |
|
MD5 | 8180243369a5a03a57c5015da1a66fda |
|
BLAKE2b-256 | e88efbba0e217768e66e6bb126ce6a56756ad26fa1b1bd66d3c7320b691babf6 |