Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
State machine for django models.
Python

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
states2
.gitignore
CHANGELOG.rst
LICENCSE.txt
README.rst
setup.py

README.rst

Django States (v2)

Authors: - Jonathan Slenders, City Live nv - Gert van Gool, City Live nv

Description

State engine for django models. Define a state graph for a model and remember the state of each object. State transitions can be logged for objects.

Usage example

It's basically these two things:

  • Derived your model from StateModel
  • Add a Machine class to your model, for the state machine
from states2.models import StateMachine, StateDefinition, StateTransition
from states2.models import StateModel

class PurchaseStateMachine(StateMachine):
   log_transitions = True


   class initiated(StateDefinition):
       description = _('Purchase initiated')
       initial = True

   class paid(StateDefinition):
       description = _('Purchase paid')

       def handler(self, instance):
           code_to_execute_when_arriving_in_this_state()

   class shipped(StateDefinition):
       description = _('Purchase shipped')


   class mark_paid(StateTransition):
       from_state = 'initiated'
       to_state = 'paid'
       description = 'Mark this purchase as paid'

   class ship(StateTransition):
       from_state = 'paid'
       to_state = 'shipped'
       description = 'Ship purchase'

       def handler(transition, instance, user):
           code_to_execute_during_this_transition()

       def has_permission(transition, instance, user):
           return true_when_user_can_make_this_transition()

class Purchase(StateModel):
    Machine = PurchaseStateMachine
    ... (other fields for a purchase)

You may of course nest the Machine class, like you would usually do for Meta.

This will create the necessary models. if log_transitions is enabled, another model is created. Everything should be compatible with South.

Usage example:

p = Purchase()

# Will automatically create state object for this purchase, in the
# initial state.
p.save()
p.make_transition('initiate', request.user) # User parameter is optional
p.state # Will return 'paid'
p.state_description # Will return 'Purchase paid'

# Will return all the state transitions for this instance.
p.state_transitions.all()

# The user who triggered this transition
p.state_transitions.all()[0].user

# Will return 'complete' or 'failed', depending on the state of this
# state transition.
p.state_transitions.all()[0].state

# Returns an iterator of possible transitions for this purchase.
p.possible_transitions

For better transition control, override:

  • has_permission(self, instance, user):

    Check whether this user is allowed to make this transition.

  • handler(self, instance, user):

    Code to run during this transition. When an exception has been raised in here, the transition will not be made.

Get all objects in a certain state:

Purchase.objects.filter(state='initiated')

Actions for the Django Admin (see admin actions):

class PurchaseAdmin(admin.ModelAdmin);
    actions = Purchase.Machine.get_admin_actions()
Something went wrong with that request. Please try again.