jshiffer/slixmpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added documentation for transition_ctx and removed some superfluous comment lines

Browse Source
This commit is contained in:
Thom Nichols 2010-06-07 14:41:42 -04:00
parent 9464736551
commit 34dc236126
2 changed files with 26 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
sleekxmpp/xmlstream/statemachine.py
View File

@ -105,6 +105,32 @@ class StateMachine(object):
def transition_ctx(self, from_state, to_state, wait=0.0): def transition_ctx(self, from_state, to_state, wait=0.0):
'''
Use the state machine as a context manager. The transition occurs on /exit/ from
the `with` context, so long as no exception is thrown. For example:
::
with state_machine.transition_ctx('one','two', wait=5) as locked:
if locked:
# the state machine is currently locked in state 'one', and will
# transition to 'two' when the 'with' statement ends, so long as
# no exception is thrown.
print 'Currently locked in state one: %s' % state_machine['one']
else:
# The 'wait' timed out, and no lock has been acquired
print 'Timed out before entering state "one"'
print 'Since no exception was thrown, we are now in state "two": %s' % state_machine['two']
The other main difference between this method and `transition()` is that the
state machine is locked for the duration of the `with` statement (normally,
after a `transition() occurs, the state machine is immediately unlocked and
available to another thread to call `transition()` again.
'''
if not from_state in self.__states: if not from_state in self.__states:
raise ValueError( "StateMachine does not contain from_state %s." % state ) raise ValueError( "StateMachine does not contain from_state %s." % state )
if not to_state in self.__states: if not to_state in self.__states:

5
tests/test_statemachine.py
View File

@ -15,9 +15,7 @@ class testStateMachine(unittest.TestCase):
def testDefaults(self): def testDefaults(self):
"Test ensure transitions occur correctly in a single thread" "Test ensure transitions occur correctly in a single thread"
s = sm.StateMachine(('one','two','three')) s = sm.StateMachine(('one','two','three'))
# self.assertTrue(s.one)
self.assertTrue(s['one']) self.assertTrue(s['one'])
# self.failIf(s.two)
self.failIf(s['two']) self.failIf(s['two'])
try: try:
s['booga'] s['booga']
@ -31,12 +29,9 @@ class testStateMachine(unittest.TestCase):
def testTransitions(self): def testTransitions(self):
"Test ensure transitions occur correctly in a single thread" "Test ensure transitions occur correctly in a single thread"
s = sm.StateMachine(('one','two','three')) s = sm.StateMachine(('one','two','three'))
# self.assertTrue(s.one)
self.assertTrue( s.transition('one', 'two') ) self.assertTrue( s.transition('one', 'two') )
# self.assertTrue( s.two )
self.assertTrue( s['two'] ) self.assertTrue( s['two'] )
# self.failIf( s.one )
self.failIf( s['one'] ) self.failIf( s['one'] )
self.assertTrue( s.transition('two', 'three') ) self.assertTrue( s.transition('two', 'three') )