refac: Removing all internal references in code and docs to deprecated features (#309)

Author: fgmacedo

README.rst

@@ -91,7 +91,7 @@ Define your state machine:
 ...         return "Running {} from {} to {}{}".format(
 ...             event_data.event,
 ...             event_data.transition.source.id,
-...             event_data.transition.destination.id,
+...             event_data.transition.target.id,
 ...             message,
 ...         )
 ...

docs/actions.md

@@ -299,15 +299,15 @@ Actions and Guards will be executed in the following order:
 
 - `on_exit_state()`
 
-- `on_exit_<state_identifier>()`
+- `on_exit_<state.id>()`
 
 - `on_transition()`
 
 - `on_<event>()`
 
 - `on_enter_state()`
 
-- `on_enter_<state_identifier>()`
+- `on_enter_<state.id>()`
 
 - `after_<event>()`
 

docs/auto_examples/traffic_light_machine.ipynb

@@ -26,7 +26,7 @@
       },
       "outputs": [],
       "source": [
-        "from statemachine import StateMachine, State\n\n\nclass TrafficLightMachine(StateMachine):\n    \"A traffic light machine\"\n    green = State(\"Green\", initial=True)\n    yellow = State(\"Yellow\")\n    red = State(\"Red\")\n\n    cycle = green.to(yellow) | yellow.to(red) | red.to(green)\n\n    def on_cycle(self, event_data=None):\n        return \"Running {} from {} to {}\".format(\n            event_data.event,\n            event_data.transition.source.identifier,\n            event_data.transition.destination.identifier,\n        )"
+        "from statemachine import StateMachine, State\n\n\nclass TrafficLightMachine(StateMachine):\n    \"A traffic light machine\"\n    green = State(\"Green\", initial=True)\n    yellow = State(\"Yellow\")\n    red = State(\"Red\")\n\n    cycle = green.to(yellow) | yellow.to(red) | red.to(green)\n\n    def on_cycle(self, event_data=None):\n        return \"Running {} from {} to {}\".format(\n            event_data.event,\n            event_data.source.id,\n            event_data.target.id,\n        )"
       ]
     }
   ],

docs/auto_examples/traffic_light_machine.py

@@ -20,6 +20,6 @@ class TrafficLightMachine(StateMachine):
     def on_cycle(self, event_data=None):
         return "Running {} from {} to {}".format(
             event_data.event,
-            event_data.transition.source.identifier,
-            event_data.transition.destination.identifier,
+            event_data.source.id,
+            event_data.target.id,
         )

docs/auto_examples/traffic_light_machine.py.md5

@@ -1 +1 @@
-0af5cdeaa4a1943efbf042b8716ba3f4
+19e658cb602d79aa1479dce8e9def1b3

docs/auto_examples/traffic_light_machine.rst

@@ -53,8 +53,8 @@ Demonstrates the concept of ``cycle`` states.
         def on_cycle(self, event_data=None):
             return "Running {} from {} to {}".format(
                 event_data.event,
-                event_data.transition.source.identifier,
-                event_data.transition.destination.identifier,
+                event_data.source.id,
+                event_data.target.id,
             )
 
 

docs/examples/traffic_light_machine.ipynb

@@ -33,8 +33,8 @@
     "    def on_cycle(self, event_data=None):\n",
     "        return \"Running {} from {} to {}\".format(\n",
     "            event_data.event.name,\n",
-    "            event_data.transition.source.identifier,\n",
-    "            event_data.transition.destination.identifier,\n",
+    "            event_data.transition.source.id,\n",
+    "            event_data.transition.target.id,\n",
     "        )\n",
     "    \n",
     "    def on_enter_state(self):\n",
@@ -52,76 +52,7 @@
    "outputs": [
     {
      "data": {
-      "image/svg+xml": [
-       "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n",
-       "<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\"\n",
-       " \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n",
-       "<!-- Generated by graphviz version 2.40.1 (20161225.0304)\n",
-       " -->\n",
-       "<!-- Title: list Pages: 1 -->\n",
-       "<svg width=\"543pt\" height=\"93pt\"\n",
-       " viewBox=\"0.00 0.00 543.00 93.00\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n",
-       "<g id=\"graph0\" class=\"graph\" transform=\"scale(1 1) rotate(0) translate(4 89)\">\n",
-       "<title>list</title>\n",
-       "<polygon fill=\"#ffffff\" stroke=\"transparent\" points=\"-4,4 -4,-89 539,-89 539,4 -4,4\"/>\n",
-       "<text text-anchor=\"middle\" x=\"267.5\" y=\"-7\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">TrafficLightMachine</text>\n",
-       "<!-- i -->\n",
-       "<g id=\"node1\" class=\"node\">\n",
-       "<title>i</title>\n",
-       "<ellipse fill=\"#000000\" stroke=\"#000000\" cx=\"7\" cy=\"-37\" rx=\"7\" ry=\"7\"/>\n",
-       "<text text-anchor=\"middle\" x=\"7\" y=\"-36.7\" font-family=\"Times,serif\" font-size=\"1.00\" fill=\"#000000\">i</text>\n",
-       "</g>\n",
-       "<!-- green -->\n",
-       "<g id=\"node2\" class=\"node\">\n",
-       "<title>green</title>\n",
-       "<path fill=\"#40e0d0\" stroke=\"#000000\" stroke-width=\"2\" d=\"M144,-55C144,-55 63,-55 63,-55 57,-55 51,-49 51,-43 51,-43 51,-31 51,-31 51,-25 57,-19 63,-19 63,-19 144,-19 144,-19 150,-19 156,-25 156,-31 156,-31 156,-43 156,-43 156,-49 150,-55 144,-55\"/>\n",
-       "<text text-anchor=\"middle\" x=\"103.5\" y=\"-40\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">Green</text>\n",
-       "<text text-anchor=\"middle\" x=\"103.5\" y=\"-29\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">entry / on_enter_state</text>\n",
-       "</g>\n",
-       "<!-- i&#45;&gt;green -->\n",
-       "<g id=\"edge1\" class=\"edge\">\n",
-       "<title>i&#45;&gt;green</title>\n",
-       "<path fill=\"none\" stroke=\"#0000ff\" d=\"M14.2532,-37C20.4952,-37 30.1691,-37 40.8829,-37\"/>\n",
-       "<polygon fill=\"#0000ff\" stroke=\"#0000ff\" points=\"40.9459,-40.5001 50.9459,-37 40.9459,-33.5001 40.9459,-40.5001\"/>\n",
-       "</g>\n",
-       "<!-- yellow -->\n",
-       "<g id=\"node3\" class=\"node\">\n",
-       "<title>yellow</title>\n",
-       "<path fill=\"#ffffff\" stroke=\"#000000\" d=\"M304,-85C304,-85 223,-85 223,-85 217,-85 211,-79 211,-73 211,-73 211,-61 211,-61 211,-55 217,-49 223,-49 223,-49 304,-49 304,-49 310,-49 316,-55 316,-61 316,-61 316,-73 316,-73 316,-79 310,-85 304,-85\"/>\n",
-       "<text text-anchor=\"middle\" x=\"263.5\" y=\"-70\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">Yellow</text>\n",
-       "<text text-anchor=\"middle\" x=\"263.5\" y=\"-59\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">entry / on_enter_state</text>\n",
-       "</g>\n",
-       "<!-- green&#45;&gt;yellow -->\n",
-       "<g id=\"edge2\" class=\"edge\">\n",
-       "<title>green&#45;&gt;yellow</title>\n",
-       "<path fill=\"none\" stroke=\"#0000ff\" d=\"M156.3334,-46.9063C170.6072,-49.5826 186.1902,-52.5044 200.9416,-55.2703\"/>\n",
-       "<polygon fill=\"#0000ff\" stroke=\"#0000ff\" points=\"200.5211,-58.7524 210.9949,-57.1553 201.8112,-51.8723 200.5211,-58.7524\"/>\n",
-       "<text text-anchor=\"middle\" x=\"183.5\" y=\"-54.8\" font-family=\"Times,serif\" font-size=\"9.00\" fill=\"#000000\">cycle</text>\n",
-       "</g>\n",
-       "<!-- red -->\n",
-       "<g id=\"node4\" class=\"node\">\n",
-       "<title>red</title>\n",
-       "<path fill=\"#ffffff\" stroke=\"#000000\" d=\"M523,-55C523,-55 383,-55 383,-55 377,-55 371,-49 371,-43 371,-43 371,-31 371,-31 371,-25 377,-19 383,-19 383,-19 523,-19 523,-19 529,-19 535,-25 535,-31 535,-31 535,-43 535,-43 535,-49 529,-55 523,-55\"/>\n",
-       "<text text-anchor=\"middle\" x=\"453\" y=\"-40\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">Red</text>\n",
-       "<text text-anchor=\"middle\" x=\"453\" y=\"-29\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">entry / on_enter_state, on_enter_red</text>\n",
-       "</g>\n",
-       "<!-- yellow&#45;&gt;red -->\n",
-       "<g id=\"edge4\" class=\"edge\">\n",
-       "<title>yellow&#45;&gt;red</title>\n",
-       "<path fill=\"none\" stroke=\"#0000ff\" d=\"M316.0347,-58.6832C329.9618,-56.4783 345.4185,-54.0314 360.7861,-51.5985\"/>\n",
-       "<polygon fill=\"#0000ff\" stroke=\"#0000ff\" points=\"361.5254,-55.0251 370.8551,-50.0045 360.4308,-48.1112 361.5254,-55.0251\"/>\n",
-       "<text text-anchor=\"middle\" x=\"343.5\" y=\"-57.8\" font-family=\"Times,serif\" font-size=\"9.00\" fill=\"#000000\">cycle</text>\n",
-       "</g>\n",
-       "<!-- red&#45;&gt;green -->\n",
-       "<g id=\"edge3\" class=\"edge\">\n",
-       "<title>red&#45;&gt;green</title>\n",
-       "<path fill=\"none\" stroke=\"#0000ff\" d=\"M370.8015,-32.1163C352.753,-31.2349 333.737,-30.4528 316,-30 269.3485,-28.809 257.642,-28.483 211,-30 196.4955,-30.4717 180.9077,-31.3006 166.2257,-32.2268\"/>\n",
-       "<polygon fill=\"#0000ff\" stroke=\"#0000ff\" points=\"165.9807,-28.7352 156.2304,-32.8803 166.4375,-35.7203 165.9807,-28.7352\"/>\n",
-       "<text text-anchor=\"middle\" x=\"263.5\" y=\"-32.8\" font-family=\"Times,serif\" font-size=\"9.00\" fill=\"#000000\">cycle</text>\n",
-       "</g>\n",
-       "</g>\n",
-       "</svg>\n"
-      ],
+      "image/svg+xml": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\"\n \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n<!-- Generated by graphviz version 2.40.1 (20161225.0304)\n -->\n<!-- Title: list Pages: 1 -->\n<svg width=\"543pt\" height=\"93pt\"\n viewBox=\"0.00 0.00 543.00 93.00\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n<g id=\"graph0\" class=\"graph\" transform=\"scale(1 1) rotate(0) translate(4 89)\">\n<title>list</title>\n<polygon fill=\"#ffffff\" stroke=\"transparent\" points=\"-4,4 -4,-89 539,-89 539,4 -4,4\"/>\n<text text-anchor=\"middle\" x=\"267.5\" y=\"-7\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">TrafficLightMachine</text>\n<!-- i -->\n<g id=\"node1\" class=\"node\">\n<title>i</title>\n<ellipse fill=\"#000000\" stroke=\"#000000\" cx=\"7\" cy=\"-37\" rx=\"7\" ry=\"7\"/>\n<text text-anchor=\"middle\" x=\"7\" y=\"-36.7\" font-family=\"Times,serif\" font-size=\"1.00\" fill=\"#000000\">i</text>\n</g>\n<!-- green -->\n<g id=\"node2\" class=\"node\">\n<title>green</title>\n<path fill=\"#40e0d0\" stroke=\"#000000\" stroke-width=\"2\" d=\"M144,-55C144,-55 63,-55 63,-55 57,-55 51,-49 51,-43 51,-43 51,-31 51,-31 51,-25 57,-19 63,-19 63,-19 144,-19 144,-19 150,-19 156,-25 156,-31 156,-31 156,-43 156,-43 156,-49 150,-55 144,-55\"/>\n<text text-anchor=\"middle\" x=\"103.5\" y=\"-40\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">Green</text>\n<text text-anchor=\"middle\" x=\"103.5\" y=\"-29\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">entry / on_enter_state</text>\n</g>\n<!-- i&#45;&gt;green -->\n<g id=\"edge1\" class=\"edge\">\n<title>i&#45;&gt;green</title>\n<path fill=\"none\" stroke=\"#0000ff\" d=\"M14.2532,-37C20.4952,-37 30.1691,-37 40.8829,-37\"/>\n<polygon fill=\"#0000ff\" stroke=\"#0000ff\" points=\"40.9459,-40.5001 50.9459,-37 40.9459,-33.5001 40.9459,-40.5001\"/>\n</g>\n<!-- yellow -->\n<g id=\"node3\" class=\"node\">\n<title>yellow</title>\n<path fill=\"#ffffff\" stroke=\"#000000\" d=\"M304,-85C304,-85 223,-85 223,-85 217,-85 211,-79 211,-73 211,-73 211,-61 211,-61 211,-55 217,-49 223,-49 223,-49 304,-49 304,-49 310,-49 316,-55 316,-61 316,-61 316,-73 316,-73 316,-79 310,-85 304,-85\"/>\n<text text-anchor=\"middle\" x=\"263.5\" y=\"-70\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">Yellow</text>\n<text text-anchor=\"middle\" x=\"263.5\" y=\"-59\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">entry / on_enter_state</text>\n</g>\n<!-- green&#45;&gt;yellow -->\n<g id=\"edge2\" class=\"edge\">\n<title>green&#45;&gt;yellow</title>\n<path fill=\"none\" stroke=\"#0000ff\" d=\"M156.3334,-46.9063C170.6072,-49.5826 186.1902,-52.5044 200.9416,-55.2703\"/>\n<polygon fill=\"#0000ff\" stroke=\"#0000ff\" points=\"200.5211,-58.7524 210.9949,-57.1553 201.8112,-51.8723 200.5211,-58.7524\"/>\n<text text-anchor=\"middle\" x=\"183.5\" y=\"-54.8\" font-family=\"Times,serif\" font-size=\"9.00\" fill=\"#000000\">cycle</text>\n</g>\n<!-- red -->\n<g id=\"node4\" class=\"node\">\n<title>red</title>\n<path fill=\"#ffffff\" stroke=\"#000000\" d=\"M523,-55C523,-55 383,-55 383,-55 377,-55 371,-49 371,-43 371,-43 371,-31 371,-31 371,-25 377,-19 383,-19 383,-19 523,-19 523,-19 529,-19 535,-25 535,-31 535,-31 535,-43 535,-43 535,-49 529,-55 523,-55\"/>\n<text text-anchor=\"middle\" x=\"453\" y=\"-40\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">Red</text>\n<text text-anchor=\"middle\" x=\"453\" y=\"-29\" font-family=\"Times,serif\" font-size=\"10.00\" fill=\"#000000\">entry / on_enter_state, on_enter_red</text>\n</g>\n<!-- yellow&#45;&gt;red -->\n<g id=\"edge4\" class=\"edge\">\n<title>yellow&#45;&gt;red</title>\n<path fill=\"none\" stroke=\"#0000ff\" d=\"M316.0347,-58.6832C329.9618,-56.4783 345.4185,-54.0314 360.7861,-51.5985\"/>\n<polygon fill=\"#0000ff\" stroke=\"#0000ff\" points=\"361.5254,-55.0251 370.8551,-50.0045 360.4308,-48.1112 361.5254,-55.0251\"/>\n<text text-anchor=\"middle\" x=\"343.5\" y=\"-57.8\" font-family=\"Times,serif\" font-size=\"9.00\" fill=\"#000000\">cycle</text>\n</g>\n<!-- red&#45;&gt;green -->\n<g id=\"edge3\" class=\"edge\">\n<title>red&#45;&gt;green</title>\n<path fill=\"none\" stroke=\"#0000ff\" d=\"M370.8015,-32.1163C352.753,-31.2349 333.737,-30.4528 316,-30 269.3485,-28.809 257.642,-28.483 211,-30 196.4955,-30.4717 180.9077,-31.3006 166.2257,-32.2268\"/>\n<polygon fill=\"#0000ff\" stroke=\"#0000ff\" points=\"165.9807,-28.7352 156.2304,-32.8803 166.4375,-35.7203 165.9807,-28.7352\"/>\n<text text-anchor=\"middle\" x=\"263.5\" y=\"-32.8\" font-family=\"Times,serif\" font-size=\"9.00\" fill=\"#000000\">cycle</text>\n</g>\n</g>\n</svg>\n",
       "text/plain": [
        "TrafficLightMachine(model=Model(state=green), state_field='state', current_state='green')"
       ]
@@ -153,7 +84,12 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.1"
+   "version": "3.8.1 (default, Dec 21 2019, 08:49:15) \n[GCC 7.4.0]"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "94f282d658e0bedff3dcf13b7bf6b556458ab0ae44b675c100fba6f748b54e7d"
+   }
   }
  },
  "nbformat": 4,

docs/releases/0.9.0.md

@@ -26,9 +26,6 @@ Parameters sent with the event trigger will now be propagated to the transition
 
 >>> sm = CampaignMachine()
 
->>> sm.run("produce", approver="Gandalf")  # event oriented
-Approved by: Gandalf
-
 >>> sm.produce(approver="Aragorn")  # imperatite
 Approved by: Aragorn
 

docs/releases/1.0.0.md

@@ -90,12 +90,11 @@ See {ref}`dynamic-dispatch` for more details.
 ## Backwards incompatible changes in 1.0
 
 
-### Multiple destinations from the same origin state
+### Multiple targets from the same origin state
 
 Prior to this release, as we didn't have {ref}`validators-and-guards`, there wasn't an elegant way
-to declare multiples destinations starting from the same pair (event, state). But the library
-allowed a near-hackish way, by declaring a destination state as the result of the `on_<event>`
-callback.
+to declare multiples target states starting from the same pair (event, state). But the library
+allowed a near-hackish way, by declaring a target state as the result of the `on_<event>` callback.
 
 So, the previous code (not valid anymore):
 
@@ -201,8 +200,9 @@ with pytest.raises(exceptions.InvalidDefinition):
   {ref}`dynamic-dispatch` rules. Previously it only accepted the `state` param.
 - `Transition.__init__` param `on_execute` renamed to simply `on`, and now follows the
 {ref}`dynamic-dispatch`.
-- `Transition.destinations` removed in favor of `Transition.destination`. Now each transition only
-points to a unique target. Each `source->destination` pair is holded by a single `Transition`.
+- `Transition.destinations` removed in favor of `Transition.target` (following SCXML convention).
+Now each transition only points to a unique target. Each `source->target` pair is holded by a
+single `Transition`.
 
 ## Deprecated features in 1.0
 

docs/transitions.md

@@ -102,7 +102,7 @@ When an {ref}`event` is sent to a stamemachine:
 
 1. Uses the current {ref}`state` to check for available transitions.
 1. For each possible transition, it checks for those that matches the received {ref}`event`.
-1. The destination state, if the transition succeeds, is determined by a transisition
+1. The target state, if the transition succeeds, is determined by a transisition
    that an event matches and;
 1. All {ref}`validators-and-guards`, including {ref}`actions`
    atached to the `on_<event>` and `before_<event>` callbacks.
@@ -119,18 +119,18 @@ By direct calling the event:
 >>> machine.cycle()
 'Running cycle from green to yellow'
 
->>> machine.current_state.identifier
+>>> machine.current_state.id
 'yellow'
 
 ```
 
 In a running (interpreted) machine, events are `sent`:
 
 ```py
->>> machine.run("cycle")
+>>> machine.send("cycle")
 'Running cycle from yellow to red'
 
->>> machine.current_state.identifier
+>>> machine.current_state.id
 'red'
 
 ```
@@ -151,13 +151,13 @@ This action is executed before the transition associated with `cycle` event is a
 can also raise an exception at this point to stop a transition to occur.
 
 ```py
->>> machine.current_state.identifier
+>>> machine.current_state.id
 'red'
 
 >>> machine.cycle()
 'Running cycle from red to green'
 
->>> machine.current_state.identifier
+>>> machine.current_state.id
 'green'
 
 ```