Source code for automaton.runners

#    Copyright (C) 2015 Yahoo! Inc. All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

import abc

from automaton import exceptions as excp
from automaton import machines


_JUMPER_NOT_FOUND_TPL = ("Unable to progress since no reaction (or"
                         " sent event) has been made available in"
                         " new state '%s' (moved to from state '%s'"
                         " in response to event '%s')")


[docs] class Runner(metaclass=abc.ABCMeta): """Machine runner used to run a state machine. Only **one** runner per machine should be active at the same time (aka there should not be multiple runners using the same machine instance at the same time). """ def __init__(self, machine): self._machine = machine
[docs] @abc.abstractmethod def run(self, event, initialize=True): """Runs the state machine, using reactions only."""
[docs] @abc.abstractmethod def run_iter(self, event, initialize=True): """Returns a iterator/generator that will run the state machine. NOTE(harlowja): only one runner iterator/generator should be active for a machine, if this is not observed then it is possible for initialization and other local state to be corrupted and cause issues when running... """
[docs] class FiniteRunner(Runner): """Finite machine runner used to run a finite machine. Only **one** runner per machine should be active at the same time (aka there should not be multiple runners using the same machine instance at the same time). """ def __init__(self, machine): """Create a runner for the given machine.""" if not isinstance(machine, (machines.FiniteMachine,)): raise TypeError("FiniteRunner only works with FiniteMachine(s)") super(FiniteRunner, self).__init__(machine)
[docs] def run(self, event, initialize=True): for transition in self.run_iter(event, initialize=initialize): pass
[docs] def run_iter(self, event, initialize=True): if initialize: self._machine.initialize() while True: old_state = self._machine.current_state reaction, terminal = self._machine.process_event(event) new_state = self._machine.current_state try: sent_event = yield (old_state, new_state) except GeneratorExit: break if terminal: break if reaction is None and sent_event is None: raise excp.NotFound(_JUMPER_NOT_FOUND_TPL % (new_state, old_state, event)) elif sent_event is not None: event = sent_event else: cb, args, kwargs = reaction event = cb(old_state, new_state, event, *args, **kwargs)
[docs] class HierarchicalRunner(Runner): """Hierarchical machine runner used to run a hierarchical machine. Only **one** runner per machine should be active at the same time (aka there should not be multiple runners using the same machine instance at the same time). """ def __init__(self, machine): """Create a runner for the given machine.""" if not isinstance(machine, (machines.HierarchicalFiniteMachine,)): raise TypeError("HierarchicalRunner only works with" " HierarchicalFiniteMachine(s)") super(HierarchicalRunner, self).__init__(machine)
[docs] def run(self, event, initialize=True): for transition in self.run_iter(event, initialize=initialize): pass
@staticmethod def _process_event(machines, event): """Matches a event to the machine hierarchy. If the lowest level machine does not handle the event, then the parent machine is referred to and so on, until there is only one machine left which *must* handle the event. The machine whose ``process_event`` does not throw invalid state or not found exceptions is expected to be the machine that should continue handling events... """ while True: machine = machines[-1] try: result = machine.process_event(event) except (excp.InvalidState, excp.NotFound): if len(machines) == 1: raise else: current = machine._current if current is not None and current.on_exit is not None: current.on_exit(current.name, event) machine._current = None machines.pop() else: return result
[docs] def run_iter(self, event, initialize=True): """Returns a iterator/generator that will run the state machine. This will keep a stack (hierarchy) of machines active and jumps through them as needed (depending on which machine handles which event) during the running lifecycle. NOTE(harlowja): only one runner iterator/generator should be active for a machine hierarchy, if this is not observed then it is possible for initialization and other local state to be corrupted and causes issues when running... """ machines = [self._machine] if initialize: machines[-1].initialize() while True: old_state = machines[-1].current_state effect = self._process_event(machines, event) new_state = machines[-1].current_state try: machine = effect.machine except AttributeError: pass else: if machine is not None and machine is not machines[-1]: machine.initialize() machines.append(machine) try: sent_event = yield (old_state, new_state) except GeneratorExit: break if len(machines) == 1 and effect.terminal: # Only allow the top level machine to actually terminate the # execution, the rest of the nested machines must not handle # events if they wish to have the root machine terminate... break if effect.reaction is None and sent_event is None: raise excp.NotFound(_JUMPER_NOT_FOUND_TPL % (new_state, old_state, event)) elif sent_event is not None: event = sent_event else: cb, args, kwargs = effect.reaction event = cb(old_state, new_state, event, *args, **kwargs)