add "may_trigger" decorator and tests

Author: aleneum

tests/test_async.py

@@ -464,8 +464,11 @@ def test_may_transition_with_auto_transitions(self):
 
         async def run():
             assert await d.may_to_A()
+            assert await d.may_trigger("to_A")
             assert await d.may_to_B()
+            assert await d.may_trigger("to_B")
             assert await d.may_to_C()
+            assert await d.may_trigger("to_C")
 
         asyncio.run(run())
 
@@ -478,12 +481,18 @@ def test_machine_may_transitions(self):
 
         async def run():
             assert not await m.may_walk()
+            assert not await m.may_trigger("walk")
             assert not await m.may_stop()
+            assert not await m.may_trigger("stop")
             assert await m.may_run()
+            assert await m.may_trigger("run")
             await m.run()
             assert not await m.may_run()
+            assert not await m.may_trigger("run")
             assert not await m.may_stop()
+            assert not await m.may_trigger("stop")
             assert not await m.may_walk()
+            assert not await m.may_trigger("walk")
 
         asyncio.run(run())
 
@@ -495,6 +504,7 @@ def test_may_transition_with_invalid_state(self):
 
         async def run():
             assert not await d.may_walk()
+            assert not await d.may_trigger("walk")
 
         asyncio.run(run())
 
@@ -506,10 +516,14 @@ def test_may_transition_internal(self):
 
         async def run():
             assert await d.may_go()
+            assert await d.may_trigger("go")
             assert not await d.may_wait()
+            assert not await d.may_trigger("wait")
             await d.go()
             assert not await d.may_go()
+            assert not await d.may_trigger("go")
             assert await d.may_wait()
+            assert await d.may_trigger("wait")
 
         asyncio.run(run())
 
@@ -529,17 +543,23 @@ def process_exception(event_data):
         async def run():
             with self.assertRaises(RuntimeError):
                 await stuff.may_raises()
+            with self.assertRaises(RuntimeError):
+                await stuff.may_trigger("raises")
             assert stuff.is_A()
             assert await stuff.may_works()
+            assert await stuff.may_trigger("works")
             assert await stuff.works()
             with self.assertRaises(ValueError):
                 await stuff.may_raises()
+            with self.assertRaises(ValueError):
+                await stuff.may_trigger("raises")
             assert stuff.is_B()
             stuff.machine.on_exception.append(process_exception)
             assert not await stuff.may_raises()
+            assert not await stuff.may_trigger("raises")
             assert await stuff.to_A()
             assert not await stuff.may_raises()
-
+            assert not await stuff.may_trigger("raises")
         asyncio.run(run())
 
     def test_on_final(self):

tests/test_core.py

@@ -1233,22 +1233,31 @@ def test_may_transition(self):
         m.add_transition('stop', 'B', 'C')
         m.add_transition('wait', 'B', None)
         assert d.may_walk()
+        assert d.may_trigger("walk")
         assert not d.may_stop()
+        assert not d.may_trigger("stop")
         assert not d.may_wait()
+        assert not d.may_trigger("wait")
 
         d.walk()
         assert not d.may_walk()
+        assert not d.may_trigger("walk")
         assert d.may_stop()
+        assert d.may_trigger("stop")
         assert d.may_wait()
+        assert d.may_trigger("wait")
 
     def test_may_transition_for_autogenerated_triggers(self):
         states = ['A', 'B', 'C']
         m = Machine(states=states, initial='A')
         assert m.may_to_A()
+        assert m.may_trigger("to_A")
         m.to_A()
         assert m.to_B()
+        assert m.may_trigger("to_B")
         m.to_B()
         assert m.may_to_C()
+        assert m.may_trigger("to_C")
         m.to_C()
 
     def test_may_transition_with_conditions(self):
@@ -1259,18 +1268,14 @@ def test_may_transition_with_conditions(self):
         m.add_transition('stop', 'B', 'C')
         m.add_transition('run', 'A', 'C')
         assert not d.may_walk()
+        assert not d.may_trigger("walk")
         assert not d.may_stop()
+        assert not d.may_trigger("stop")
         assert d.may_run()
+        assert d.may_trigger("run")
         d.run()
         assert not d.may_run()
-
-    def test_may_transition_with_auto_transitions(self):
-        states = ['A', 'B', 'C']
-        d = DummyModel()
-        self.machine_cls(model=d, states=states, initial='A')
-        assert d.may_to_A()
-        assert d.may_to_B()
-        assert d.may_to_C()
+        assert not d.may_trigger("run")
 
     def test_machine_may_transitions(self):
         states = ['A', 'B', 'C']
@@ -1281,19 +1286,26 @@ def test_machine_may_transitions(self):
         m.add_transition('reset', 'C', 'A')
 
         assert not m.may_walk()
+        assert not m.may_trigger("walk")
         assert not m.may_stop()
+        assert not m.may_trigger("stop")
         assert m.may_run()
+        assert m.may_trigger("run")
         m.run()
         assert not m.may_run()
+        assert not m.may_trigger("run")
         assert not m.may_stop()
+        assert not m.may_trigger("stop")
         assert not m.may_walk()
+        assert not m.may_trigger("walk")
 
     def test_may_transition_with_invalid_state(self):
         states = ['A', 'B', 'C']
         d = DummyModel()
         m = self.machine_cls(model=d, states=states, initial='A', auto_transitions=False)
         m.add_transition('walk', 'A', 'UNKNOWN')
         assert not d.may_walk()
+        assert not d.may_trigger("walk")
 
     def test_may_transition_with_exception(self):
         stuff = Stuff(machine_cls=self.machine_cls, extra_kwargs={"send_event": True})
@@ -1314,11 +1326,15 @@ def process_exception(event_data):
         assert stuff.works()
         with self.assertRaises(ValueError):
             stuff.may_raises()
+        with self.assertRaises(ValueError):
+            stuff.may_trigger("raises")
         assert stuff.is_B()
         stuff.machine.on_exception.append(process_exception)
         assert not stuff.may_raises()
+        assert not stuff.may_trigger("raises")
         assert stuff.to_A()
         assert not stuff.may_raises()
+        assert not stuff.may_trigger("raises")
 
     def test_on_final(self):
         final_mock = MagicMock()

tests/test_enum.py

@@ -171,7 +171,9 @@ class TrafficLight(object):
         m.add_transition('go', self.States.RED, self.States.GREEN)
         m.add_transition('stop', self.States.YELLOW, self.States.RED)
         assert t.may_go()
+        assert t.may_trigger("go")
         assert not t.may_stop()
+        assert not t.may_trigger("stop")
 
 
 @skipIf(enum is None, "enum is not available")

tests/test_nesting.py

@@ -639,14 +639,19 @@ def test_machine_may_transitions_for_generated_triggers(self):
         states = ['A', 'B', {'name': 'C', 'children': ['1', '2', '3']}, 'D']
         m = self.stuff.machine_cls(states=states, initial='A')
         assert m.may_to_A()
+        assert m.may_trigger("to_A")
         m.to_A()
         assert m.may_to_B()
+        assert m.may_trigger("to_B")
         m.to_B()
         assert m.may_to_C()
+        assert m.may_trigger("to_C")
         m.to_C()
         assert m.may_to_C_1()
+        assert m.may_trigger("to_C_1")
         m.to_C_1()
         assert m.may_to_D()
+        assert m.may_trigger("to_D")
         m.to_D()
 
     def test_get_nested_triggers(self):
@@ -957,20 +962,32 @@ def test_machine_may_transitions(self):
             states=states, transitions=transitions, initial='A', auto_transitions=False
         )
         assert m.may_walk()
+        assert m.may_trigger("walk")
         assert not m.may_run()
+        assert not m.may_trigger("run")
         assert not m.may_run_fast()
+        assert not m.may_trigger("run_fast")
         assert not m.may_sprint()
+        assert not m.may_trigger("sprint")
         assert not m.may_wait()
+        assert not m.may_trigger("wait")
 
         m.walk()
         assert not m.may_walk()
+        assert not m.may_trigger("walk")
         assert m.may_run()
+        assert m.may_trigger("run")
         assert not m.may_run_fast()
+        assert not m.may_trigger("run_fast")
         assert m.may_wait()
+        assert m.may_trigger("wait")
 
         m.run()
         assert m.may_run_fast()
+        assert m.may_trigger("run_fast")
         assert m.may_sprint()
+        assert m.may_trigger("sprint")
+
         m.run_fast()
 
     def test_remove_nested_transition(self):

transitions/core.py

@@ -625,6 +625,7 @@ def add_model(self, model, initial=None):
             mod = self if mod is self.self_literal else mod
             if mod not in self.models:
                 self._checked_assignment(mod, 'trigger', partial(self._get_trigger, mod))
+                self._checked_assignment(mod, 'may_trigger', partial(self._can_trigger, mod))
 
                 for trigger in self.events:
                     self._add_trigger_to_model(trigger, mod)