/usr/share/doc/python-automaton-doc/html/_modules/automaton/machines.html is in python-automaton-doc 1.14.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type"/>
<title>OpenStack Docs: automaton.machines</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- Bootstrap CSS -->
<link href="../../_static/css/bootstrap.min.css" rel="stylesheet">
<!-- Pygments CSS -->
<link href="../../_static/css/native.css" rel="stylesheet">
<!-- Fonts -->
<link href="../../_static/css/font-awesome.min.css" rel="stylesheet">
<!-- Custom CSS -->
<link href="../../_static/css/combined.css" rel="stylesheet">
</head>
<body>
<!-- TEMPLATE_NAME: _modules/automaton/machines -->
<script type="text/javascript">
(function(w,d,t,u,n,s,e){w['SwiftypeObject']=n;w[n]=w[n]||function(){
(w[n].q=w[n].q||[]).push(arguments);};s=d.createElement(t);
e=d.getElementsByTagName(t)[0];s.async=1;s.src=u;e.parentNode.insertBefore(s,e);
})(window,document,'script','//s.swiftypecdn.com/install/v2/st.js','_st');
_st('install','aDn5L_vgZ2yzRcE893kK','2.0.0');
</script>
<nav class="navbar navbar-default" role="navigation">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button class="navbar-toggle" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse" type="button">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<div class="brand-wrapper">
<a class="navbar-brand" href="index.html"></a>
</div>
</div>
</div>
<!-- /.container -->
</nav>
<div class="container docs-book-wrapper">
<div class="row">
<div class="col-lg-9 col-md-8 col-sm-8 col-lg-push-3 col-md-push-4 col-sm-push-4">
<div class="row">
<div class="col-lg-8">
<h2>automaton.machines</h2>
</div>
<div class="docs-actions">
<a id="logABugLink1" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a>
</div>
</div>
<div class="row docs-byline">
<div class="docs-updated">updated: 2018-01-23 17:06</div>
</div>
<div class="row">
<div class="col-lg-12">
<div class="docs-body">
<h1>Source code for automaton.machines</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright (C) 2014 Yahoo! Inc. All Rights Reserved.</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License"); you may</span>
<span class="c1"># not use this file except in compliance with the License. You may obtain</span>
<span class="c1"># a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span>
<span class="c1"># WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span>
<span class="c1"># License for the specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="kn">import</span> <span class="nn">collections</span>
<span class="kn">import</span> <span class="nn">prettytable</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">from</span> <span class="nn">automaton</span> <span class="k">import</span> <span class="n">_utils</span> <span class="k">as</span> <span class="n">utils</span>
<span class="kn">from</span> <span class="nn">automaton</span> <span class="k">import</span> <span class="n">exceptions</span> <span class="k">as</span> <span class="n">excp</span>
<div class="viewcode-block" id="State"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.State">[docs]</a><span class="k">class</span> <span class="nc">State</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Container that defines needed components of a single state.</span>
<span class="sd"> Usage of this and the :meth:`~.FiniteMachine.build` make creating finite</span>
<span class="sd"> state machines that much easier.</span>
<span class="sd"> :ivar name: The name of the state.</span>
<span class="sd"> :ivar is_terminal: Whether this state is terminal (or not).</span>
<span class="sd"> :ivar next_states: Dictionary of 'event' -> 'next state name' (or none).</span>
<span class="sd"> :ivar on_enter: callback that will be called when the state is entered.</span>
<span class="sd"> :ivar on_exit: callback that will be called when the state is exited.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span>
<span class="n">is_terminal</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">next_states</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">on_enter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">on_exit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">is_terminal</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">is_terminal</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">next_states</span> <span class="o">=</span> <span class="n">next_states</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_enter</span> <span class="o">=</span> <span class="n">on_enter</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_exit</span> <span class="o">=</span> <span class="n">on_exit</span></div>
<span class="k">def</span> <span class="nf">_convert_to_states</span><span class="p">(</span><span class="n">state_space</span><span class="p">):</span>
<span class="c1"># NOTE(harlowja): if provided dicts, convert them...</span>
<span class="k">for</span> <span class="n">state</span> <span class="ow">in</span> <span class="n">state_space</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">state</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">state</span> <span class="o">=</span> <span class="n">State</span><span class="p">(</span><span class="o">**</span><span class="n">state</span><span class="p">)</span>
<span class="k">yield</span> <span class="n">state</span>
<span class="k">def</span> <span class="nf">_orderedkeys</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">sort</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="k">if</span> <span class="n">sort</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="k">class</span> <span class="nc">_Jump</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""A FSM transition tracks this data while jumping."""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">on_enter</span><span class="p">,</span> <span class="n">on_exit</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_enter</span> <span class="o">=</span> <span class="n">on_enter</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_exit</span> <span class="o">=</span> <span class="n">on_exit</span>
<div class="viewcode-block" id="FiniteMachine"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine">[docs]</a><span class="k">class</span> <span class="nc">FiniteMachine</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""A finite state machine.</span>
<span class="sd"> This state machine can be used to automatically run a given set of</span>
<span class="sd"> transitions and states in response to events (either from callbacks or from</span>
<span class="sd"> generator/iterator send() values, see PEP 342). On each triggered event, a</span>
<span class="sd"> ``on_enter`` and ``on_exit`` callback can also be provided which will be</span>
<span class="sd"> called to perform some type of action on leaving a prior state and before</span>
<span class="sd"> entering a new state.</span>
<span class="sd"> NOTE(harlowja): reactions will *only* be called when the generator/iterator</span>
<span class="sd"> from :py:meth:`~automaton.runners.Runner.run_iter` does *not* send</span>
<span class="sd"> back a new event (they will always be called if the</span>
<span class="sd"> :py:meth:`~automaton.runners.Runner.run` method is used). This allows</span>
<span class="sd"> for two unique ways (these ways can also be intermixed) to use this state</span>
<span class="sd"> machine when using :py:meth:`~automaton.runners.Runner.run`; one</span>
<span class="sd"> where *external* event trigger the next state transition and one</span>
<span class="sd"> where *internal* reaction callbacks trigger the next state</span>
<span class="sd"> transition. The other way to use this</span>
<span class="sd"> state machine is to skip using :py:meth:`~automaton.runners.Runner.run`</span>
<span class="sd"> or :py:meth:`~automaton.runners.Runner.run_iter`</span>
<span class="sd"> completely and use the :meth:`~.FiniteMachine.process_event` method</span>
<span class="sd"> explicitly and trigger the events via</span>
<span class="sd"> some *external* functionality/triggers...</span>
<span class="sd"> """</span>
<span class="c1">#: The result of processing an event (cause and effect...)</span>
<span class="n">Effect</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span><span class="s1">'Effect'</span><span class="p">,</span> <span class="s1">'reaction,terminal'</span><span class="p">)</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">_effect_builder</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">new_state</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">Effect</span><span class="p">(</span><span class="n">new_state</span><span class="p">[</span><span class="s1">'reactions'</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">event</span><span class="p">),</span>
<span class="n">new_state</span><span class="p">[</span><span class="s2">"terminal"</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_states</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">OrderedDict</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_default_start_state</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">frozen</span> <span class="o">=</span> <span class="kc">False</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">default_start_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Sets the *default* start state that the machine should use.</span>
<span class="sd"> NOTE(harlowja): this will be used by ``initialize`` but only if that</span>
<span class="sd"> function is not given its own ``start_state`` that overrides this</span>
<span class="sd"> default.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default_start_state</span>
<span class="nd">@default_start_state</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">default_start_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">frozen</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">FrozenMachine</span><span class="p">()</span>
<span class="k">if</span> <span class="n">state</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">NotFound</span><span class="p">(</span><span class="s2">"Can not set the default start state to"</span>
<span class="s2">" undefined state '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">state</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_default_start_state</span> <span class="o">=</span> <span class="n">state</span>
<div class="viewcode-block" id="FiniteMachine.build"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.build">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">state_space</span><span class="p">):</span>
<span class="sd">"""Builds a machine from a state space listing.</span>
<span class="sd"> Each element of this list must be an instance</span>
<span class="sd"> of :py:class:`.State` or a ``dict`` with equivalent keys that</span>
<span class="sd"> can be used to construct a :py:class:`.State` instance.</span>
<span class="sd"> """</span>
<span class="n">state_space</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">_convert_to_states</span><span class="p">(</span><span class="n">state_space</span><span class="p">))</span>
<span class="n">m</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
<span class="k">for</span> <span class="n">state</span> <span class="ow">in</span> <span class="n">state_space</span><span class="p">:</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_state</span><span class="p">(</span><span class="n">state</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
<span class="n">terminal</span><span class="o">=</span><span class="n">state</span><span class="o">.</span><span class="n">is_terminal</span><span class="p">,</span>
<span class="n">on_enter</span><span class="o">=</span><span class="n">state</span><span class="o">.</span><span class="n">on_enter</span><span class="p">,</span>
<span class="n">on_exit</span><span class="o">=</span><span class="n">state</span><span class="o">.</span><span class="n">on_exit</span><span class="p">)</span>
<span class="k">for</span> <span class="n">state</span> <span class="ow">in</span> <span class="n">state_space</span><span class="p">:</span>
<span class="k">if</span> <span class="n">state</span><span class="o">.</span><span class="n">next_states</span><span class="p">:</span>
<span class="k">for</span> <span class="n">event</span><span class="p">,</span> <span class="n">next_state</span> <span class="ow">in</span> <span class="n">state</span><span class="o">.</span><span class="n">next_states</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">next_state</span><span class="p">,</span> <span class="n">State</span><span class="p">):</span>
<span class="n">next_state</span> <span class="o">=</span> <span class="n">next_state</span><span class="o">.</span><span class="n">name</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="n">state</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">next_state</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span>
<span class="k">return</span> <span class="n">m</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">current_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The current state the machine is in (or none if not initialized)."""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current</span><span class="o">.</span><span class="n">name</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">terminated</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns whether the state machine is in a terminal state."""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_current</span><span class="o">.</span><span class="n">name</span><span class="p">][</span><span class="s1">'terminal'</span><span class="p">]</span>
<div class="viewcode-block" id="FiniteMachine.add_state"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.add_state">[docs]</a> <span class="k">def</span> <span class="nf">add_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">,</span> <span class="n">terminal</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">on_enter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">on_exit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Adds a given state to the state machine.</span>
<span class="sd"> The ``on_enter`` and ``on_exit`` callbacks, if provided will be</span>
<span class="sd"> expected to take two positional parameters, these being the state</span>
<span class="sd"> being exited (for ``on_exit``) or the state being entered (for</span>
<span class="sd"> ``on_enter``) and a second parameter which is the event that is</span>
<span class="sd"> being processed that caused the state transition.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">frozen</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">FrozenMachine</span><span class="p">()</span>
<span class="k">if</span> <span class="n">state</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">Duplicate</span><span class="p">(</span><span class="s2">"State '</span><span class="si">%s</span><span class="s2">' already defined"</span> <span class="o">%</span> <span class="n">state</span><span class="p">)</span>
<span class="k">if</span> <span class="n">on_enter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">six</span><span class="o">.</span><span class="n">callable</span><span class="p">(</span><span class="n">on_enter</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"On enter callback must be callable"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">on_exit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">six</span><span class="o">.</span><span class="n">callable</span><span class="p">(</span><span class="n">on_exit</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"On exit callback must be callable"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">state</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'terminal'</span><span class="p">:</span> <span class="nb">bool</span><span class="p">(</span><span class="n">terminal</span><span class="p">),</span>
<span class="s1">'reactions'</span><span class="p">:</span> <span class="p">{},</span>
<span class="s1">'on_enter'</span><span class="p">:</span> <span class="n">on_enter</span><span class="p">,</span>
<span class="s1">'on_exit'</span><span class="p">:</span> <span class="n">on_exit</span><span class="p">,</span>
<span class="p">}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">state</span><span class="p">]</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">OrderedDict</span><span class="p">()</span></div>
<div class="viewcode-block" id="FiniteMachine.is_actionable_event"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.is_actionable_event">[docs]</a> <span class="k">def</span> <span class="nf">is_actionable_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="sd">"""Check whether the event is actionable in the current state."""</span>
<span class="n">current</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current</span>
<span class="k">if</span> <span class="n">current</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">event</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">current</span><span class="o">.</span><span class="n">name</span><span class="p">]:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="FiniteMachine.add_reaction"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.add_reaction">[docs]</a> <span class="k">def</span> <span class="nf">add_reaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">reaction</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""Adds a reaction that may get triggered by the given event & state.</span>
<span class="sd"> Reaction callbacks may (depending on how the state machine is ran) be</span>
<span class="sd"> used after an event is processed (and a transition occurs) to cause the</span>
<span class="sd"> machine to react to the newly arrived at stable state.</span>
<span class="sd"> These callbacks are expected to accept three default positional</span>
<span class="sd"> parameters (although more can be passed in via *args and **kwargs,</span>
<span class="sd"> these will automatically get provided to the callback when it is</span>
<span class="sd"> activated *ontop* of the three default). The three default parameters</span>
<span class="sd"> are the last stable state, the new stable state and the event that</span>
<span class="sd"> caused the transition to this new stable state to be arrived at.</span>
<span class="sd"> The expected result of a callback is expected to be a new event that</span>
<span class="sd"> the callback wants the state machine to react to. This new event</span>
<span class="sd"> may (depending on how the state machine is ran) get processed (and</span>
<span class="sd"> this process typically repeats) until the state machine reaches a</span>
<span class="sd"> terminal state.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">frozen</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">FrozenMachine</span><span class="p">()</span>
<span class="k">if</span> <span class="n">state</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">NotFound</span><span class="p">(</span><span class="s2">"Can not add a reaction to event '</span><span class="si">%s</span><span class="s2">' for an"</span>
<span class="s2">" undefined state '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">state</span><span class="p">))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">six</span><span class="o">.</span><span class="n">callable</span><span class="p">(</span><span class="n">reaction</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Reaction callback must be callable"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">event</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="s1">'reactions'</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="s1">'reactions'</span><span class="p">][</span><span class="n">event</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">reaction</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">Duplicate</span><span class="p">(</span><span class="s2">"State '</span><span class="si">%s</span><span class="s2">' reaction to event '</span><span class="si">%s</span><span class="s2">'"</span>
<span class="s2">" already defined"</span> <span class="o">%</span> <span class="p">(</span><span class="n">state</span><span class="p">,</span> <span class="n">event</span><span class="p">))</span></div>
<div class="viewcode-block" id="FiniteMachine.add_transition"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.add_transition">[docs]</a> <span class="k">def</span> <span class="nf">add_transition</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">replace</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""Adds an allowed transition from start -> end for the given event.</span>
<span class="sd"> :param start: starting state</span>
<span class="sd"> :param end: ending state</span>
<span class="sd"> :param event: event that causes start state to</span>
<span class="sd"> transition to end state</span>
<span class="sd"> :param replace: replace existing event instead of raising a</span>
<span class="sd"> :py:class:`~automaton.exceptions.Duplicate` exception</span>
<span class="sd"> when the transition already exists.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">frozen</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">FrozenMachine</span><span class="p">()</span>
<span class="k">if</span> <span class="n">start</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">NotFound</span><span class="p">(</span><span class="s2">"Can not add a transition on event '</span><span class="si">%s</span><span class="s2">' that"</span>
<span class="s2">" starts in a undefined state '</span><span class="si">%s</span><span class="s2">'"</span>
<span class="o">%</span> <span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">start</span><span class="p">))</span>
<span class="k">if</span> <span class="n">end</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">NotFound</span><span class="p">(</span><span class="s2">"Can not add a transition on event '</span><span class="si">%s</span><span class="s2">' that"</span>
<span class="s2">" ends in a undefined state '</span><span class="si">%s</span><span class="s2">'"</span>
<span class="o">%</span> <span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">end</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">start</span><span class="p">][</span><span class="s1">'terminal'</span><span class="p">]:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">InvalidState</span><span class="p">(</span><span class="s2">"Can not add a transition on event '</span><span class="si">%s</span><span class="s2">'"</span>
<span class="s2">" that starts in the terminal state '</span><span class="si">%s</span><span class="s2">'"</span>
<span class="o">%</span> <span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">start</span><span class="p">))</span>
<span class="k">if</span> <span class="n">event</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">start</span><span class="p">]</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">replace</span><span class="p">:</span>
<span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">start</span><span class="p">][</span><span class="n">event</span><span class="p">]</span>
<span class="k">if</span> <span class="n">target</span><span class="o">.</span><span class="n">name</span> <span class="o">!=</span> <span class="n">end</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">Duplicate</span><span class="p">(</span><span class="s2">"Cannot add transition from"</span>
<span class="s2">" '</span><span class="si">%(start_state)s</span><span class="s2">' to '</span><span class="si">%(end_state)s</span><span class="s2">'"</span>
<span class="s2">" on event '</span><span class="si">%(event)s</span><span class="s2">' because a"</span>
<span class="s2">" transition from '</span><span class="si">%(start_state)s</span><span class="s2">'"</span>
<span class="s2">" to '</span><span class="si">%(existing_end_state)s</span><span class="s2">' on"</span>
<span class="s2">" event '</span><span class="si">%(event)s</span><span class="s2">' already exists."</span>
<span class="o">%</span> <span class="p">{</span><span class="s1">'existing_end_state'</span><span class="p">:</span> <span class="n">target</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
<span class="s1">'end_state'</span><span class="p">:</span> <span class="n">end</span><span class="p">,</span> <span class="s1">'event'</span><span class="p">:</span> <span class="n">event</span><span class="p">,</span>
<span class="s1">'start_state'</span><span class="p">:</span> <span class="n">start</span><span class="p">})</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">target</span> <span class="o">=</span> <span class="n">_Jump</span><span class="p">(</span><span class="n">end</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">end</span><span class="p">][</span><span class="s1">'on_enter'</span><span class="p">],</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">start</span><span class="p">][</span><span class="s1">'on_exit'</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">start</span><span class="p">][</span><span class="n">event</span><span class="p">]</span> <span class="o">=</span> <span class="n">target</span></div>
<span class="k">def</span> <span class="nf">_pre_process_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="n">current</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current</span>
<span class="k">if</span> <span class="n">current</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">NotInitialized</span><span class="p">(</span><span class="s2">"Can not process event '</span><span class="si">%s</span><span class="s2">'; the state"</span>
<span class="s2">" machine hasn't been initialized"</span>
<span class="o">%</span> <span class="n">event</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">current</span><span class="o">.</span><span class="n">name</span><span class="p">][</span><span class="s1">'terminal'</span><span class="p">]:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">InvalidState</span><span class="p">(</span><span class="s2">"Can not transition from terminal"</span>
<span class="s2">" state '</span><span class="si">%s</span><span class="s2">' on event '</span><span class="si">%s</span><span class="s2">'"</span>
<span class="o">%</span> <span class="p">(</span><span class="n">current</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">event</span><span class="p">))</span>
<span class="k">if</span> <span class="n">event</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">current</span><span class="o">.</span><span class="n">name</span><span class="p">]:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">NotFound</span><span class="p">(</span><span class="s2">"Can not transition from state '</span><span class="si">%s</span><span class="s2">' on"</span>
<span class="s2">" event '</span><span class="si">%s</span><span class="s2">' (no defined transition)"</span>
<span class="o">%</span> <span class="p">(</span><span class="n">current</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">event</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_post_process_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">result</span><span class="p">):</span>
<span class="k">return</span> <span class="n">result</span>
<div class="viewcode-block" id="FiniteMachine.process_event"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.process_event">[docs]</a> <span class="k">def</span> <span class="nf">process_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="sd">"""Trigger a state change in response to the provided event.</span>
<span class="sd"> :returns: Effect this is either a :py:class:`.FiniteMachine.Effect` or</span>
<span class="sd"> an ``Effect`` from a subclass of :py:class:`.FiniteMachine`.</span>
<span class="sd"> See the appropriate named tuple for a description of the</span>
<span class="sd"> actual items in the tuple. For</span>
<span class="sd"> example, :py:class:`.FiniteMachine.Effect`'s</span>
<span class="sd"> first item is ``reaction``: one could invoke this reaction's</span>
<span class="sd"> callback to react to the new stable state.</span>
<span class="sd"> :rtype: namedtuple</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_pre_process_event</span><span class="p">(</span><span class="n">event</span><span class="p">)</span>
<span class="n">current</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current</span>
<span class="n">replacement</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">current</span><span class="o">.</span><span class="n">name</span><span class="p">][</span><span class="n">event</span><span class="p">]</span>
<span class="k">if</span> <span class="n">current</span><span class="o">.</span><span class="n">on_exit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">current</span><span class="o">.</span><span class="n">on_exit</span><span class="p">(</span><span class="n">current</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span>
<span class="k">if</span> <span class="n">replacement</span><span class="o">.</span><span class="n">on_enter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">replacement</span><span class="o">.</span><span class="n">on_enter</span><span class="p">(</span><span class="n">replacement</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current</span> <span class="o">=</span> <span class="n">replacement</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_effect_builder</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">replacement</span><span class="o">.</span><span class="n">name</span><span class="p">],</span> <span class="n">event</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_post_process_event</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
<div class="viewcode-block" id="FiniteMachine.initialize"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.initialize">[docs]</a> <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start_state</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Sets up the state machine (sets current state to start state...).</span>
<span class="sd"> :param start_state: explicit start state to use to initialize the</span>
<span class="sd"> state machine to. If ``None`` is provided then</span>
<span class="sd"> the machine's default start state will be used</span>
<span class="sd"> instead.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">start_state</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">start_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default_start_state</span>
<span class="k">if</span> <span class="n">start_state</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">NotFound</span><span class="p">(</span><span class="s2">"Can not start from a undefined"</span>
<span class="s2">" state '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">start_state</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">start_state</span><span class="p">][</span><span class="s1">'terminal'</span><span class="p">]:</span>
<span class="k">raise</span> <span class="n">excp</span><span class="o">.</span><span class="n">InvalidState</span><span class="p">(</span><span class="s2">"Can not start from a terminal"</span>
<span class="s2">" state '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">start_state</span><span class="p">))</span>
<span class="c1"># No on enter will be called, since we are priming the state machine</span>
<span class="c1"># and have not really transitioned from anything to get here, we will</span>
<span class="c1"># though allow on_exit to be called on the event that causes this</span>
<span class="c1"># to be moved from...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current</span> <span class="o">=</span> <span class="n">_Jump</span><span class="p">(</span><span class="n">start_state</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">start_state</span><span class="p">][</span><span class="s1">'on_exit'</span><span class="p">])</span></div>
<div class="viewcode-block" id="FiniteMachine.copy"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.copy">[docs]</a> <span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">shallow</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">unfreeze</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""Copies the current state machine.</span>
<span class="sd"> NOTE(harlowja): the copy will be left in an *uninitialized* state.</span>
<span class="sd"> NOTE(harlowja): when a shallow copy is requested the copy will share</span>
<span class="sd"> the same transition table and state table as the</span>
<span class="sd"> source; this can be advantageous if you have a machine</span>
<span class="sd"> and transitions + states that is defined somewhere</span>
<span class="sd"> and want to use copies to run with (the copies have</span>
<span class="sd"> the current state that is different between machines).</span>
<span class="sd"> """</span>
<span class="n">c</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)()</span>
<span class="n">c</span><span class="o">.</span><span class="n">_default_start_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default_start_state</span>
<span class="k">if</span> <span class="n">unfreeze</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">frozen</span><span class="p">:</span>
<span class="n">c</span><span class="o">.</span><span class="n">frozen</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">c</span><span class="o">.</span><span class="n">frozen</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">frozen</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">shallow</span><span class="p">:</span>
<span class="k">for</span> <span class="n">state</span><span class="p">,</span> <span class="n">data</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">copied_data</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">copied_data</span><span class="p">[</span><span class="s1">'reactions'</span><span class="p">]</span> <span class="o">=</span> <span class="n">copied_data</span><span class="p">[</span><span class="s1">'reactions'</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">c</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">state</span><span class="p">]</span> <span class="o">=</span> <span class="n">copied_data</span>
<span class="k">for</span> <span class="n">state</span><span class="p">,</span> <span class="n">data</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">c</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">state</span><span class="p">]</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">c</span><span class="o">.</span><span class="n">_transitions</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span>
<span class="n">c</span><span class="o">.</span><span class="n">_states</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span>
<span class="k">return</span> <span class="n">c</span></div>
<div class="viewcode-block" id="FiniteMachine.__contains__"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.__contains__">[docs]</a> <span class="k">def</span> <span class="nf">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
<span class="sd">"""Returns if this state exists in the machines known states."""</span>
<span class="k">return</span> <span class="n">state</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span></div>
<div class="viewcode-block" id="FiniteMachine.freeze"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.freeze">[docs]</a> <span class="k">def</span> <span class="nf">freeze</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Freezes & stops addition of states, transitions, reactions..."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">frozen</span> <span class="o">=</span> <span class="kc">True</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">states</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns the state names."""</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">))</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">events</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns how many events exist."""</span>
<span class="n">c</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">state</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">):</span>
<span class="n">c</span> <span class="o">+=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">state</span><span class="p">])</span>
<span class="k">return</span> <span class="n">c</span>
<div class="viewcode-block" id="FiniteMachine.__iter__"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.__iter__">[docs]</a> <span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Iterates over (start, event, end) transition tuples."""</span>
<span class="k">for</span> <span class="n">state</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">):</span>
<span class="k">for</span> <span class="n">event</span><span class="p">,</span> <span class="n">target</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">state</span><span class="p">]</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">yield</span> <span class="p">(</span><span class="n">state</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">target</span><span class="o">.</span><span class="n">name</span><span class="p">)</span></div>
<div class="viewcode-block" id="FiniteMachine.pformat"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.FiniteMachine.pformat">[docs]</a> <span class="k">def</span> <span class="nf">pformat</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sort</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">empty</span><span class="o">=</span><span class="s1">'.'</span><span class="p">):</span>
<span class="sd">"""Pretty formats the state + transition table into a string.</span>
<span class="sd"> NOTE(harlowja): the sort parameter can be provided to sort the states</span>
<span class="sd"> and transitions by sort order; with it being provided as false the rows</span>
<span class="sd"> will be iterated in addition order instead.</span>
<span class="sd"> """</span>
<span class="n">tbl</span> <span class="o">=</span> <span class="n">prettytable</span><span class="o">.</span><span class="n">PrettyTable</span><span class="p">([</span><span class="s2">"Start"</span><span class="p">,</span> <span class="s2">"Event"</span><span class="p">,</span> <span class="s2">"End"</span><span class="p">,</span>
<span class="s2">"On Enter"</span><span class="p">,</span> <span class="s2">"On Exit"</span><span class="p">])</span>
<span class="k">for</span> <span class="n">state</span> <span class="ow">in</span> <span class="n">_orderedkeys</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">,</span> <span class="n">sort</span><span class="o">=</span><span class="n">sort</span><span class="p">):</span>
<span class="n">prefix_markings</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">current_state</span> <span class="o">==</span> <span class="n">state</span><span class="p">:</span>
<span class="n">prefix_markings</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"@"</span><span class="p">)</span>
<span class="n">postfix_markings</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_start_state</span> <span class="o">==</span> <span class="n">state</span><span class="p">:</span>
<span class="n">postfix_markings</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"^"</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="s1">'terminal'</span><span class="p">]:</span>
<span class="n">postfix_markings</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"$"</span><span class="p">)</span>
<span class="n">pretty_state</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prefix_markings</span><span class="p">),</span> <span class="n">state</span><span class="p">)</span>
<span class="k">if</span> <span class="n">postfix_markings</span><span class="p">:</span>
<span class="n">pretty_state</span> <span class="o">+=</span> <span class="s2">"[</span><span class="si">%s</span><span class="s2">]"</span> <span class="o">%</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">postfix_markings</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">state</span><span class="p">]:</span>
<span class="k">for</span> <span class="n">event</span> <span class="ow">in</span> <span class="n">_orderedkeys</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">state</span><span class="p">],</span>
<span class="n">sort</span><span class="o">=</span><span class="n">sort</span><span class="p">):</span>
<span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transitions</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="n">event</span><span class="p">]</span>
<span class="n">row</span> <span class="o">=</span> <span class="p">[</span><span class="n">pretty_state</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">target</span><span class="o">.</span><span class="n">name</span><span class="p">]</span>
<span class="k">if</span> <span class="n">target</span><span class="o">.</span><span class="n">on_enter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">row</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">utils</span><span class="o">.</span><span class="n">get_callback_name</span><span class="p">(</span><span class="n">target</span><span class="o">.</span><span class="n">on_enter</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">row</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">empty</span><span class="p">)</span>
<span class="k">if</span> <span class="n">target</span><span class="o">.</span><span class="n">on_exit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">row</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">utils</span><span class="o">.</span><span class="n">get_callback_name</span><span class="p">(</span><span class="n">target</span><span class="o">.</span><span class="n">on_exit</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">row</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">empty</span><span class="p">)</span>
<span class="n">tbl</span><span class="o">.</span><span class="n">add_row</span><span class="p">(</span><span class="n">row</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">on_enter</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="s1">'on_enter'</span><span class="p">]</span>
<span class="k">if</span> <span class="n">on_enter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">on_enter</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">get_callback_name</span><span class="p">(</span><span class="n">on_enter</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">on_enter</span> <span class="o">=</span> <span class="n">empty</span>
<span class="n">on_exit</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="s1">'on_exit'</span><span class="p">]</span>
<span class="k">if</span> <span class="n">on_exit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">on_exit</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">get_callback_name</span><span class="p">(</span><span class="n">on_exit</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">on_exit</span> <span class="o">=</span> <span class="n">empty</span>
<span class="n">tbl</span><span class="o">.</span><span class="n">add_row</span><span class="p">([</span><span class="n">pretty_state</span><span class="p">,</span> <span class="n">empty</span><span class="p">,</span> <span class="n">empty</span><span class="p">,</span> <span class="n">on_enter</span><span class="p">,</span> <span class="n">on_exit</span><span class="p">])</span>
<span class="k">return</span> <span class="n">tbl</span><span class="o">.</span><span class="n">get_string</span><span class="p">()</span></div></div>
<div class="viewcode-block" id="HierarchicalFiniteMachine"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.HierarchicalFiniteMachine">[docs]</a><span class="k">class</span> <span class="nc">HierarchicalFiniteMachine</span><span class="p">(</span><span class="n">FiniteMachine</span><span class="p">):</span>
<span class="sd">"""A fsm that understands how to run in a hierarchical mode."""</span>
<span class="c1">#: The result of processing an event (cause and effect...)</span>
<span class="n">Effect</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span><span class="s1">'Effect'</span><span class="p">,</span>
<span class="s1">'reaction,terminal,machine'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">HierarchicalFiniteMachine</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_nested_machines</span> <span class="o">=</span> <span class="p">{}</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">_effect_builder</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">new_state</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">Effect</span><span class="p">(</span><span class="n">new_state</span><span class="p">[</span><span class="s1">'reactions'</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">event</span><span class="p">),</span>
<span class="n">new_state</span><span class="p">[</span><span class="s2">"terminal"</span><span class="p">],</span> <span class="n">new_state</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'machine'</span><span class="p">))</span>
<div class="viewcode-block" id="HierarchicalFiniteMachine.add_state"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.HierarchicalFiniteMachine.add_state">[docs]</a> <span class="k">def</span> <span class="nf">add_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">,</span>
<span class="n">terminal</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">on_enter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">on_exit</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">machine</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Adds a given state to the state machine.</span>
<span class="sd"> :param machine: the nested state machine that will be transitioned</span>
<span class="sd"> into when this state is entered</span>
<span class="sd"> :type machine: :py:class:`.FiniteMachine`</span>
<span class="sd"> Further arguments are interpreted as</span>
<span class="sd"> for :py:meth:`.FiniteMachine.add_state`.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">machine</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">machine</span><span class="p">,</span> <span class="n">FiniteMachine</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"Nested state machines must themselves be state machines"</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">HierarchicalFiniteMachine</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">add_state</span><span class="p">(</span>
<span class="n">state</span><span class="p">,</span> <span class="n">terminal</span><span class="o">=</span><span class="n">terminal</span><span class="p">,</span> <span class="n">on_enter</span><span class="o">=</span><span class="n">on_enter</span><span class="p">,</span> <span class="n">on_exit</span><span class="o">=</span><span class="n">on_exit</span><span class="p">)</span>
<span class="k">if</span> <span class="n">machine</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="s1">'machine'</span><span class="p">]</span> <span class="o">=</span> <span class="n">machine</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_nested_machines</span><span class="p">[</span><span class="n">state</span><span class="p">]</span> <span class="o">=</span> <span class="n">machine</span></div>
<span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">shallow</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">unfreeze</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="n">c</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">HierarchicalFiniteMachine</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">shallow</span><span class="o">=</span><span class="n">shallow</span><span class="p">,</span>
<span class="n">unfreeze</span><span class="o">=</span><span class="n">unfreeze</span><span class="p">)</span>
<span class="k">if</span> <span class="n">shallow</span><span class="p">:</span>
<span class="n">c</span><span class="o">.</span><span class="n">_nested_machines</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_nested_machines</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">c</span><span class="o">.</span><span class="n">_nested_machines</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_nested_machines</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="k">return</span> <span class="n">c</span>
<div class="viewcode-block" id="HierarchicalFiniteMachine.initialize"><a class="viewcode-back" href="../../reference/index.html#automaton.machines.HierarchicalFiniteMachine.initialize">[docs]</a> <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start_state</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">nested_start_state_fetcher</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Sets up the state machine (sets current state to start state...).</span>
<span class="sd"> :param start_state: explicit start state to use to initialize the</span>
<span class="sd"> state machine to. If ``None`` is provided then the</span>
<span class="sd"> machine's default start state will be used</span>
<span class="sd"> instead.</span>
<span class="sd"> :param nested_start_state_fetcher: A callback that can return start</span>
<span class="sd"> states for any nested machines</span>
<span class="sd"> **only**. If not ``None`` then it</span>
<span class="sd"> will be provided a single argument,</span>
<span class="sd"> the machine to provide a starting</span>
<span class="sd"> state for and it is expected to</span>
<span class="sd"> return a starting state (or</span>
<span class="sd"> ``None``) for each machine called</span>
<span class="sd"> with. Do note that this callback</span>
<span class="sd"> will also be passed to other nested</span>
<span class="sd"> state machines as well, so it will</span>
<span class="sd"> also be used to initialize any state</span>
<span class="sd"> machines they contain (recursively).</span>
<span class="sd"> """</span>
<span class="nb">super</span><span class="p">(</span><span class="n">HierarchicalFiniteMachine</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">initialize</span><span class="p">(</span>
<span class="n">start_state</span><span class="o">=</span><span class="n">start_state</span><span class="p">)</span>
<span class="k">for</span> <span class="n">data</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">itervalues</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_states</span><span class="p">):</span>
<span class="k">if</span> <span class="s1">'machine'</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
<span class="n">nested_machine</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="s1">'machine'</span><span class="p">]</span>
<span class="n">nested_start_state</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">nested_start_state_fetcher</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">nested_start_state</span> <span class="o">=</span> <span class="n">nested_start_state_fetcher</span><span class="p">(</span>
<span class="n">nested_machine</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">nested_machine</span><span class="p">,</span> <span class="n">HierarchicalFiniteMachine</span><span class="p">):</span>
<span class="n">nested_machine</span><span class="o">.</span><span class="n">initialize</span><span class="p">(</span>
<span class="n">start_state</span><span class="o">=</span><span class="n">nested_start_state</span><span class="p">,</span>
<span class="n">nested_start_state_fetcher</span><span class="o">=</span><span class="n">nested_start_state_fetcher</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">nested_machine</span><span class="o">.</span><span class="n">initialize</span><span class="p">(</span><span class="n">start_state</span><span class="o">=</span><span class="n">nested_start_state</span><span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">nested_machines</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Dictionary of **all** nested state machines this machine may use."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_nested_machines</span></div>
</pre></div>
</div>
</div>
</div>
<div class="docs-actions">
<a id="logABugLink3" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a>
</div>
<div class="row docs-byline bottom">
<div class="docs-updated">updated: 2018-01-23 17:06</div>
</div>
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8 docs-license">
<a href="https://creativecommons.org/licenses/by/3.0/">
<img src="../../_static/images/docs/license.png" alt="Creative Commons Attribution 3.0 License"/>
</a>
<p>
Except where otherwise noted, this document is licensed under
<a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>. See all <a href="http://www.openstack.org/legal">
OpenStack Legal Documents</a>.
</p>
</div>
<div class="col-lg-4 col-md-4 col-sm-4 docs-actions-wrapper">
<!-- ID buglinkbottom added so that pre-filled doc bugs
are sent to Launchpad projects related to the
document -->
<a href="#" id="logABugLink2" class="docs-footer-actions"><i class="fa fa-bug"></i> found an error? report a bug</a>
<a href="http://ask.openstack.org" class="docs-footer-actions"><i class="fa fa-question-circle"></i> questions?</a>
</div>
</div>
</div>
<div class="col-lg-3 col-md-4 col-sm-4 col-lg-pull-9 col-md-pull-8 col-sm-pull-8 docs-sidebar">
<div class="btn-group docs-sidebar-releases">
<button onclick="location.href='/'" class="btn docs-sidebar-home" data-toggle="tooltip" data-placement="top" title="Docs Home"><i class="fa fa-arrow-circle-o-left"></i></button>
<button href="#" type="button" data-toggle="dropdown" class="btn docs-sidebar-release-select">OpenStack Documentation<i class="fa fa-caret-down"></i></button>
<ul class="dropdown-menu docs-sidebar-dropdown" role="menu" aria-labelledby="dLabel">
<li role="presentation" class="dropdown-header">Guides</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#install-guides">Install Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#user-guides">User Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#configuration-guides">Configuration Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#ops-and-admin-guides">Operations and Administration Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#api-guides">API Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#contributor-guides">Contributor Guides</a></li>
<li role="presentation" class="dropdown-header">Languages</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/de/">Deutsch (German)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/fr/">Français (French)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/id/">Bahasa Indonesia (Indonesian)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/it/">Italiano (Italian)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/ja/">日本語 (Japanese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/ko_KR/">한국어 (Korean)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/pt_BR/">Português (Portuguese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/zh_CN/">简体中文 (Simplified Chinese)</a></li>
</ul>
</div>
<div class="docs-sidebar-toc">
<div class="docs-sidebar-section" id="table-of-contents">
<a href="../../index.html" class="docs-sidebar-section-title"><h4>automaton </h4></a>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../user/index.html">automaton User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../reference/index.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install/index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributor/index.html">Contributing</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row footer-links">
<div class="col-lg-2 col-sm-2">
<h3>OpenStack</h3>
<ul>
<li><a href="http://openstack.org/projects/">Projects</a></li>
<li><a href="http://openstack.org/projects/openstack-security/">OpenStack Security</a></li>
<li><a href="http://openstack.org/projects/openstack-faq/">Common Questions</a></li>
<li><a href="http://openstack.org/blog/">Blog</a></li>
<li><a href="http://openstack.org/news/">News</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Community</h3>
<ul>
<li><a href="http://openstack.org/community/">User Groups</a></li>
<li><a href="http://openstack.org/community/events/">Events</a></li>
<li><a href="http://openstack.org/community/jobs/">Jobs</a></li>
<li><a href="http://openstack.org/foundation/companies/">Companies</a></li>
<li><a href="http://docs.openstack.org/infra/manual/developers.html">Contribute</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Documentation</h3>
<ul>
<li><a href="http://docs.openstack.org">OpenStack Manuals</a></li>
<li><a href="http://openstack.org/software/start/">Getting Started</a></li>
<li><a href="http://developer.openstack.org">API Documentation</a></li>
<li><a href="https://wiki.openstack.org">Wiki</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Branding & Legal</h3>
<ul>
<li><a href="http://openstack.org/brand/">Logos & Guidelines</a></li>
<li><a href="http://openstack.org/brand/openstack-trademark-policy/">Trademark Policy</a></li>
<li><a href="http://openstack.org/privacy/">Privacy Policy</a></li>
<li><a href="https://wiki.openstack.org/wiki/How_To_Contribute#Contributor_License_Agreement">OpenStack CLA</a></li>
</ul>
</div>
<div class="col-lg-4 col-sm-4">
<h3>Stay In Touch</h3>
<a href="https://twitter.com/OpenStack" target="_blank" class="social-icons footer-twitter"></a>
<a href="https://www.facebook.com/openstack" target="_blank" class="social-icons footer-facebook"></a>
<a href="https://www.linkedin.com/company/openstack" target="_blank" class="social-icons footer-linkedin"></a>
<a href="https://www.youtube.com/user/OpenStackFoundation" target="_blank" class="social-icons footer-youtube"></a>
<p class="fine-print">
The OpenStack project is provided under the
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>. Openstack.org is powered by
<a href="http://rackspace.com" target="_blank">Rackspace Cloud Computing</a>.
</p>
</div>
</div>
</div>
</footer>
<!-- jQuery -->
<script type="text/javascript" src="../../_static/js/jquery-3.2.1.min.js"></script>
<!-- Bootstrap JavaScript -->
<script type="text/javascript" src="../../_static/js/bootstrap.min.js"></script>
<!-- The rest of the JS -->
<script type="text/javascript" src="../../_static/js/navigation.js"></script>
<!-- Docs JS -->
<script type="text/javascript" src="../../_static/js/docs.js"></script>
<!-- Popovers -->
<script type="text/javascript" src="../../_static/js/webui-popover.js"></script>
<!-- standard sphinx include libraries, which allow search highlighting -->
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/searchtools.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
SOURCELINK_SUFFIX: '.txt',
HAS_SOURCE: true
};
</script>
<!-- Javascript for page -->
<script language="JavaScript">
/* build a description of this page including SHA, source location on git repo,
build time and the project's launchpad bug tag. Set the HREF of the bug
buttons */
var lineFeed = "%0A";
var gitURL = "Source: Can't derive source file URL";
/* there have been cases where "pagename" wasn't set; better check for it */
/* The URL of the source file on Git is based on the giturl variable
in conf.py, which must be manually initialized to the source file
URL in Git.
"pagename" is a standard sphinx parameter containing the name of
the source file, without extension. */
var sourceFile = "_modules/automaton/machines" + ".rst";
gitURL = "Source: https://git.openstack.org/cgit/openstack/automaton/tree/doc/source" + "/" + sourceFile;
/* gitsha, project and bug_tag rely on variables in conf.py */
var gitSha = "SHA: unknown";
var bugProject = "automaton";
var bugTitle = "automaton.machines in automaton";
var fieldTags = "";
var useStoryboard = "";
/* "last_updated" is the build date and time. It relies on the
conf.py variable "html_last_updated_fmt", which should include
year/month/day as well as hours and minutes */
var buildstring = "Release: on 2018-01-23 17:06";
var fieldComment = encodeURI(buildstring) +
lineFeed + encodeURI(gitSha) +
lineFeed + encodeURI(gitURL) ;
logABug(bugTitle, bugProject, fieldComment, fieldTags);
</script>
</body>
</html>
|