python-automaton-doc 1.2.0-2 / usr / share / doc / python-automaton-doc / html / examples.html

This file is indexed.

/usr/share/doc/python-automaton-doc/html/examples.html is in python-automaton-doc 1.2.0-2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Examples &#8212; automaton  documentation</title>
    
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/tweaks.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="top" title="automaton  documentation" href="index.html" />
    <link rel="next" title="Contributing" href="contributing.html" />
    <link rel="prev" title="Installation" href="installation.html" /> 
  </head>
  <body role="document">
  <div id="header">
    <h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
    <ul id="navigation">
      
      <li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
      <li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
      <li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
      <li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
      <li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
      <li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
      <li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
      
    </ul>
  </div>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="examples">
<h1>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h1>
<div class="section" id="creating-a-simple-machine">
<h2>Creating a simple machine<a class="headerlink" href="#creating-a-simple-machine" title="Permalink to this headline"></a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">automaton</span> <span class="k">import</span> <span class="n">machines</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">machines</span><span class="o">.</span><span class="n">FiniteMachine</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="s1">&#39;up&#39;</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="s1">&#39;down&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;down&#39;</span><span class="p">,</span> <span class="s1">&#39;up&#39;</span><span class="p">,</span> <span class="s1">&#39;jump&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;up&#39;</span><span class="p">,</span> <span class="s1">&#39;down&#39;</span><span class="p">,</span> <span class="s1">&#39;fall&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">default_start_state</span> <span class="o">=</span> <span class="s1">&#39;down&#39;</span>
<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">pformat</span><span class="p">())</span>
</pre></div>
</div>
<p><strong>Expected output:</strong></p>
<div class="highlight-none"><div class="highlight"><pre><span></span>+---------+-------+------+----------+---------+
|  Start  | Event | End  | On Enter | On Exit |
+---------+-------+------+----------+---------+
| down[^] |  jump |  up  |    .     |    .    |
|    up   |  fall | down |    .     |    .    |
+---------+-------+------+----------+---------+
</pre></div>
</div>
</div>
<div class="section" id="transitioning-a-simple-machine">
<h2>Transitioning a simple machine<a class="headerlink" href="#transitioning-a-simple-machine" title="Permalink to this headline"></a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">m</span><span class="o">.</span><span class="n">initialize</span><span class="p">()</span>
<span class="n">m</span><span class="o">.</span><span class="n">process_event</span><span class="p">(</span><span class="s1">&#39;jump&#39;</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">pformat</span><span class="p">())</span>
<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">current_state</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">terminated</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">process_event</span><span class="p">(</span><span class="s1">&#39;fall&#39;</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">pformat</span><span class="p">())</span>
<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">current_state</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">terminated</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>Expected output:</strong></p>
<div class="highlight-none"><div class="highlight"><pre><span></span>+---------+-------+------+----------+---------+
|  Start  | Event | End  | On Enter | On Exit |
+---------+-------+------+----------+---------+
| down[^] |  jump |  up  |    .     |    .    |
|   @up   |  fall | down |    .     |    .    |
+---------+-------+------+----------+---------+
up
False
+----------+-------+------+----------+---------+
|  Start   | Event | End  | On Enter | On Exit |
+----------+-------+------+----------+---------+
| @down[^] |  jump |  up  |    .     |    .    |
|    up    |  fall | down |    .     |    .    |
+----------+-------+------+----------+---------+
down
False
</pre></div>
</div>
</div>
<div class="section" id="running-a-complex-dog-barking-machine">
<h2>Running a complex dog-barking machine<a class="headerlink" href="#running-a-complex-dog-barking-machine" title="Permalink to this headline"></a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">automaton</span> <span class="k">import</span> <span class="n">machines</span>
<span class="kn">from</span> <span class="nn">automaton</span> <span class="k">import</span> <span class="n">runners</span>


<span class="c1"># These reaction functions will get triggered when the registered state</span>
<span class="c1"># and event occur, it is expected to provide a new event that reacts to the</span>
<span class="c1"># new stable state (so that the state-machine can transition to a new</span>
<span class="c1"># stable state, and repeat, until the machine ends up in a terminal</span>
<span class="c1"># state, whereby it will stop...)</span>

<span class="k">def</span> <span class="nf">react_to_squirrel</span><span class="p">(</span><span class="n">old_state</span><span class="p">,</span> <span class="n">new_state</span><span class="p">,</span> <span class="n">event_that_triggered</span><span class="p">):</span>
    <span class="k">return</span> <span class="s2">&quot;gets petted&quot;</span>


<span class="k">def</span> <span class="nf">react_to_wagging</span><span class="p">(</span><span class="n">old_state</span><span class="p">,</span> <span class="n">new_state</span><span class="p">,</span> <span class="n">event_that_triggered</span><span class="p">):</span>
    <span class="k">return</span> <span class="s2">&quot;gets petted&quot;</span>


<span class="n">m</span> <span class="o">=</span> <span class="n">machines</span><span class="o">.</span><span class="n">FiniteMachine</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="s2">&quot;sits&quot;</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="s2">&quot;lies down&quot;</span><span class="p">,</span> <span class="n">terminal</span><span class="o">=</span><span class="kc">True</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="s2">&quot;barks&quot;</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="s2">&quot;wags tail&quot;</span><span class="p">)</span>

<span class="n">m</span><span class="o">.</span><span class="n">default_start_state</span> <span class="o">=</span> <span class="s1">&#39;sits&#39;</span>

<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s2">&quot;sits&quot;</span><span class="p">,</span> <span class="s2">&quot;barks&quot;</span><span class="p">,</span> <span class="s2">&quot;squirrel!&quot;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s2">&quot;barks&quot;</span><span class="p">,</span> <span class="s2">&quot;wags tail&quot;</span><span class="p">,</span> <span class="s2">&quot;gets petted&quot;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s2">&quot;wags tail&quot;</span><span class="p">,</span> <span class="s2">&quot;lies down&quot;</span><span class="p">,</span> <span class="s2">&quot;gets petted&quot;</span><span class="p">)</span>

<span class="n">m</span><span class="o">.</span><span class="n">add_reaction</span><span class="p">(</span><span class="s2">&quot;barks&quot;</span><span class="p">,</span> <span class="s2">&quot;squirrel!&quot;</span><span class="p">,</span> <span class="n">react_to_squirrel</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_reaction</span><span class="p">(</span><span class="s1">&#39;wags tail&#39;</span><span class="p">,</span> <span class="s2">&quot;gets petted&quot;</span><span class="p">,</span> <span class="n">react_to_wagging</span><span class="p">)</span>

<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">pformat</span><span class="p">())</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">runners</span><span class="o">.</span><span class="n">FiniteRunner</span><span class="p">(</span><span class="n">m</span><span class="p">)</span>
<span class="k">for</span> <span class="p">(</span><span class="n">old_state</span><span class="p">,</span> <span class="n">new_state</span><span class="p">)</span> <span class="ow">in</span> <span class="n">r</span><span class="o">.</span><span class="n">run_iter</span><span class="p">(</span><span class="s2">&quot;squirrel!&quot;</span><span class="p">):</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Leaving &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span> <span class="o">%</span> <span class="n">old_state</span><span class="p">)</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Entered &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span> <span class="o">%</span> <span class="n">new_state</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>Expected output:</strong></p>
<div class="highlight-none"><div class="highlight"><pre><span></span>+--------------+-------------+-----------+----------+---------+
|    Start     |    Event    |    End    | On Enter | On Exit |
+--------------+-------------+-----------+----------+---------+
|    barks     | gets petted | wags tail |    .     |    .    |
| lies down[$] |      .      |     .     |    .     |    .    |
|   sits[^]    |  squirrel!  |   barks   |    .     |    .    |
|  wags tail   | gets petted | lies down |    .     |    .    |
+--------------+-------------+-----------+----------+---------+
Leaving &#39;sits&#39;
Entered &#39;barks&#39;
Leaving &#39;barks&#39;
Entered &#39;wags tail&#39;
Leaving &#39;wags tail&#39;
Entered &#39;lies down&#39;
</pre></div>
</div>
</div>
<div class="section" id="creating-a-complex-cd-player-machine">
<h2>Creating a complex CD-player machine<a class="headerlink" href="#creating-a-complex-cd-player-machine" title="Permalink to this headline"></a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">automaton</span> <span class="k">import</span> <span class="n">machines</span>


<span class="k">def</span> <span class="nf">print_on_enter</span><span class="p">(</span><span class="n">new_state</span><span class="p">,</span> <span class="n">triggered_event</span><span class="p">):</span>
   <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Entered &#39;</span><span class="si">%s</span><span class="s2">&#39; due to &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">new_state</span><span class="p">,</span> <span class="n">triggered_event</span><span class="p">))</span>


<span class="k">def</span> <span class="nf">print_on_exit</span><span class="p">(</span><span class="n">old_state</span><span class="p">,</span> <span class="n">triggered_event</span><span class="p">):</span>
   <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Exiting &#39;</span><span class="si">%s</span><span class="s2">&#39; due to &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">old_state</span><span class="p">,</span> <span class="n">triggered_event</span><span class="p">))</span>


<span class="n">m</span> <span class="o">=</span> <span class="n">machines</span><span class="o">.</span><span class="n">FiniteMachine</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="s1">&#39;stopped&#39;</span><span class="p">,</span> <span class="n">on_enter</span><span class="o">=</span><span class="n">print_on_enter</span><span class="p">,</span> <span class="n">on_exit</span><span class="o">=</span><span class="n">print_on_exit</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="s1">&#39;opened&#39;</span><span class="p">,</span>  <span class="n">on_enter</span><span class="o">=</span><span class="n">print_on_enter</span><span class="p">,</span> <span class="n">on_exit</span><span class="o">=</span><span class="n">print_on_exit</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="s1">&#39;closed&#39;</span><span class="p">,</span>  <span class="n">on_enter</span><span class="o">=</span><span class="n">print_on_enter</span><span class="p">,</span> <span class="n">on_exit</span><span class="o">=</span><span class="n">print_on_exit</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="s1">&#39;playing&#39;</span><span class="p">,</span>  <span class="n">on_enter</span><span class="o">=</span><span class="n">print_on_enter</span><span class="p">,</span> <span class="n">on_exit</span><span class="o">=</span><span class="n">print_on_exit</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="s1">&#39;paused&#39;</span><span class="p">,</span>  <span class="n">on_enter</span><span class="o">=</span><span class="n">print_on_enter</span><span class="p">,</span> <span class="n">on_exit</span><span class="o">=</span><span class="n">print_on_exit</span><span class="p">)</span>

<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;stopped&#39;</span><span class="p">,</span> <span class="s1">&#39;playing&#39;</span><span class="p">,</span> <span class="s1">&#39;play&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;stopped&#39;</span><span class="p">,</span> <span class="s1">&#39;opened&#39;</span><span class="p">,</span> <span class="s1">&#39;open_close&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;stopped&#39;</span><span class="p">,</span> <span class="s1">&#39;stopped&#39;</span><span class="p">,</span> <span class="s1">&#39;stop&#39;</span><span class="p">)</span>

<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;opened&#39;</span><span class="p">,</span> <span class="s1">&#39;closed&#39;</span><span class="p">,</span> <span class="s1">&#39;open_close&#39;</span><span class="p">)</span>

<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;closed&#39;</span><span class="p">,</span> <span class="s1">&#39;opened&#39;</span><span class="p">,</span> <span class="s1">&#39;open_close&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;closed&#39;</span><span class="p">,</span> <span class="s1">&#39;stopped&#39;</span><span class="p">,</span> <span class="s1">&#39;cd_detected&#39;</span><span class="p">)</span>

<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;playing&#39;</span><span class="p">,</span> <span class="s1">&#39;stopped&#39;</span><span class="p">,</span> <span class="s1">&#39;stop&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;playing&#39;</span><span class="p">,</span> <span class="s1">&#39;paused&#39;</span><span class="p">,</span> <span class="s1">&#39;pause&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;playing&#39;</span><span class="p">,</span> <span class="s1">&#39;opened&#39;</span><span class="p">,</span> <span class="s1">&#39;open_close&#39;</span><span class="p">)</span>

<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;paused&#39;</span><span class="p">,</span> <span class="s1">&#39;playing&#39;</span><span class="p">,</span> <span class="s1">&#39;play&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;paused&#39;</span><span class="p">,</span> <span class="s1">&#39;stopped&#39;</span><span class="p">,</span> <span class="s1">&#39;stop&#39;</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">add_transition</span><span class="p">(</span><span class="s1">&#39;paused&#39;</span><span class="p">,</span> <span class="s1">&#39;opened&#39;</span><span class="p">,</span> <span class="s1">&#39;open_close&#39;</span><span class="p">)</span>

<span class="n">m</span><span class="o">.</span><span class="n">default_start_state</span> <span class="o">=</span> <span class="s1">&#39;closed&#39;</span>

<span class="n">m</span><span class="o">.</span><span class="n">initialize</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">pformat</span><span class="p">())</span>

<span class="k">for</span> <span class="n">event</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;cd_detected&#39;</span><span class="p">,</span> <span class="s1">&#39;play&#39;</span><span class="p">,</span> <span class="s1">&#39;pause&#39;</span><span class="p">,</span> <span class="s1">&#39;play&#39;</span><span class="p">,</span> <span class="s1">&#39;stop&#39;</span><span class="p">,</span>
              <span class="s1">&#39;open_close&#39;</span><span class="p">,</span> <span class="s1">&#39;open_close&#39;</span><span class="p">]:</span>
    <span class="n">m</span><span class="o">.</span><span class="n">process_event</span><span class="p">(</span><span class="n">event</span><span class="p">)</span>
    <span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">pformat</span><span class="p">())</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=============&quot;</span><span class="p">)</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Current state =&gt; </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">m</span><span class="o">.</span><span class="n">current_state</span><span class="p">)</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=============&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>Expected output:</strong></p>
<div class="highlight-none"><div class="highlight"><pre><span></span>+------------+-------------+---------+----------------+---------------+
|   Start    |    Event    |   End   |    On Enter    |    On Exit    |
+------------+-------------+---------+----------------+---------------+
| @closed[^] | cd_detected | stopped | print_on_enter | print_on_exit |
| @closed[^] |  open_close |  opened | print_on_enter | print_on_exit |
|   opened   |  open_close |  closed | print_on_enter | print_on_exit |
|   paused   |  open_close |  opened | print_on_enter | print_on_exit |
|   paused   |     play    | playing | print_on_enter | print_on_exit |
|   paused   |     stop    | stopped | print_on_enter | print_on_exit |
|  playing   |  open_close |  opened | print_on_enter | print_on_exit |
|  playing   |    pause    |  paused | print_on_enter | print_on_exit |
|  playing   |     stop    | stopped | print_on_enter | print_on_exit |
|  stopped   |  open_close |  opened | print_on_enter | print_on_exit |
|  stopped   |     play    | playing | print_on_enter | print_on_exit |
|  stopped   |     stop    | stopped | print_on_enter | print_on_exit |
+------------+-------------+---------+----------------+---------------+
Exiting &#39;closed&#39; due to &#39;cd_detected&#39;
Entered &#39;stopped&#39; due to &#39;cd_detected&#39;
+-----------+-------------+---------+----------------+---------------+
|   Start   |    Event    |   End   |    On Enter    |    On Exit    |
+-----------+-------------+---------+----------------+---------------+
| closed[^] | cd_detected | stopped | print_on_enter | print_on_exit |
| closed[^] |  open_close |  opened | print_on_enter | print_on_exit |
|   opened  |  open_close |  closed | print_on_enter | print_on_exit |
|   paused  |  open_close |  opened | print_on_enter | print_on_exit |
|   paused  |     play    | playing | print_on_enter | print_on_exit |
|   paused  |     stop    | stopped | print_on_enter | print_on_exit |
|  playing  |  open_close |  opened | print_on_enter | print_on_exit |
|  playing  |    pause    |  paused | print_on_enter | print_on_exit |
|  playing  |     stop    | stopped | print_on_enter | print_on_exit |
|  @stopped |  open_close |  opened | print_on_enter | print_on_exit |
|  @stopped |     play    | playing | print_on_enter | print_on_exit |
|  @stopped |     stop    | stopped | print_on_enter | print_on_exit |
+-----------+-------------+---------+----------------+---------------+
=============
Current state =&gt; stopped
=============
Exiting &#39;stopped&#39; due to &#39;play&#39;
Entered &#39;playing&#39; due to &#39;play&#39;
+-----------+-------------+---------+----------------+---------------+
|   Start   |    Event    |   End   |    On Enter    |    On Exit    |
+-----------+-------------+---------+----------------+---------------+
| closed[^] | cd_detected | stopped | print_on_enter | print_on_exit |
| closed[^] |  open_close |  opened | print_on_enter | print_on_exit |
|   opened  |  open_close |  closed | print_on_enter | print_on_exit |
|   paused  |  open_close |  opened | print_on_enter | print_on_exit |
|   paused  |     play    | playing | print_on_enter | print_on_exit |
|   paused  |     stop    | stopped | print_on_enter | print_on_exit |
|  @playing |  open_close |  opened | print_on_enter | print_on_exit |
|  @playing |    pause    |  paused | print_on_enter | print_on_exit |
|  @playing |     stop    | stopped | print_on_enter | print_on_exit |
|  stopped  |  open_close |  opened | print_on_enter | print_on_exit |
|  stopped  |     play    | playing | print_on_enter | print_on_exit |
|  stopped  |     stop    | stopped | print_on_enter | print_on_exit |
+-----------+-------------+---------+----------------+---------------+
=============
Current state =&gt; playing
=============
Exiting &#39;playing&#39; due to &#39;pause&#39;
Entered &#39;paused&#39; due to &#39;pause&#39;
+-----------+-------------+---------+----------------+---------------+
|   Start   |    Event    |   End   |    On Enter    |    On Exit    |
+-----------+-------------+---------+----------------+---------------+
| closed[^] | cd_detected | stopped | print_on_enter | print_on_exit |
| closed[^] |  open_close |  opened | print_on_enter | print_on_exit |
|   opened  |  open_close |  closed | print_on_enter | print_on_exit |
|  @paused  |  open_close |  opened | print_on_enter | print_on_exit |
|  @paused  |     play    | playing | print_on_enter | print_on_exit |
|  @paused  |     stop    | stopped | print_on_enter | print_on_exit |
|  playing  |  open_close |  opened | print_on_enter | print_on_exit |
|  playing  |    pause    |  paused | print_on_enter | print_on_exit |
|  playing  |     stop    | stopped | print_on_enter | print_on_exit |
|  stopped  |  open_close |  opened | print_on_enter | print_on_exit |
|  stopped  |     play    | playing | print_on_enter | print_on_exit |
|  stopped  |     stop    | stopped | print_on_enter | print_on_exit |
+-----------+-------------+---------+----------------+---------------+
=============
Current state =&gt; paused
=============
Exiting &#39;paused&#39; due to &#39;play&#39;
Entered &#39;playing&#39; due to &#39;play&#39;
+-----------+-------------+---------+----------------+---------------+
|   Start   |    Event    |   End   |    On Enter    |    On Exit    |
+-----------+-------------+---------+----------------+---------------+
| closed[^] | cd_detected | stopped | print_on_enter | print_on_exit |
| closed[^] |  open_close |  opened | print_on_enter | print_on_exit |
|   opened  |  open_close |  closed | print_on_enter | print_on_exit |
|   paused  |  open_close |  opened | print_on_enter | print_on_exit |
|   paused  |     play    | playing | print_on_enter | print_on_exit |
|   paused  |     stop    | stopped | print_on_enter | print_on_exit |
|  @playing |  open_close |  opened | print_on_enter | print_on_exit |
|  @playing |    pause    |  paused | print_on_enter | print_on_exit |
|  @playing |     stop    | stopped | print_on_enter | print_on_exit |
|  stopped  |  open_close |  opened | print_on_enter | print_on_exit |
|  stopped  |     play    | playing | print_on_enter | print_on_exit |
|  stopped  |     stop    | stopped | print_on_enter | print_on_exit |
+-----------+-------------+---------+----------------+---------------+
=============
Current state =&gt; playing
=============
Exiting &#39;playing&#39; due to &#39;stop&#39;
Entered &#39;stopped&#39; due to &#39;stop&#39;
+-----------+-------------+---------+----------------+---------------+
|   Start   |    Event    |   End   |    On Enter    |    On Exit    |
+-----------+-------------+---------+----------------+---------------+
| closed[^] | cd_detected | stopped | print_on_enter | print_on_exit |
| closed[^] |  open_close |  opened | print_on_enter | print_on_exit |
|   opened  |  open_close |  closed | print_on_enter | print_on_exit |
|   paused  |  open_close |  opened | print_on_enter | print_on_exit |
|   paused  |     play    | playing | print_on_enter | print_on_exit |
|   paused  |     stop    | stopped | print_on_enter | print_on_exit |
|  playing  |  open_close |  opened | print_on_enter | print_on_exit |
|  playing  |    pause    |  paused | print_on_enter | print_on_exit |
|  playing  |     stop    | stopped | print_on_enter | print_on_exit |
|  @stopped |  open_close |  opened | print_on_enter | print_on_exit |
|  @stopped |     play    | playing | print_on_enter | print_on_exit |
|  @stopped |     stop    | stopped | print_on_enter | print_on_exit |
+-----------+-------------+---------+----------------+---------------+
=============
Current state =&gt; stopped
=============
Exiting &#39;stopped&#39; due to &#39;open_close&#39;
Entered &#39;opened&#39; due to &#39;open_close&#39;
+-----------+-------------+---------+----------------+---------------+
|   Start   |    Event    |   End   |    On Enter    |    On Exit    |
+-----------+-------------+---------+----------------+---------------+
| closed[^] | cd_detected | stopped | print_on_enter | print_on_exit |
| closed[^] |  open_close |  opened | print_on_enter | print_on_exit |
|  @opened  |  open_close |  closed | print_on_enter | print_on_exit |
|   paused  |  open_close |  opened | print_on_enter | print_on_exit |
|   paused  |     play    | playing | print_on_enter | print_on_exit |
|   paused  |     stop    | stopped | print_on_enter | print_on_exit |
|  playing  |  open_close |  opened | print_on_enter | print_on_exit |
|  playing  |    pause    |  paused | print_on_enter | print_on_exit |
|  playing  |     stop    | stopped | print_on_enter | print_on_exit |
|  stopped  |  open_close |  opened | print_on_enter | print_on_exit |
|  stopped  |     play    | playing | print_on_enter | print_on_exit |
|  stopped  |     stop    | stopped | print_on_enter | print_on_exit |
+-----------+-------------+---------+----------------+---------------+
=============
Current state =&gt; opened
=============
Exiting &#39;opened&#39; due to &#39;open_close&#39;
Entered &#39;closed&#39; due to &#39;open_close&#39;
+------------+-------------+---------+----------------+---------------+
|   Start    |    Event    |   End   |    On Enter    |    On Exit    |
+------------+-------------+---------+----------------+---------------+
| @closed[^] | cd_detected | stopped | print_on_enter | print_on_exit |
| @closed[^] |  open_close |  opened | print_on_enter | print_on_exit |
|   opened   |  open_close |  closed | print_on_enter | print_on_exit |
|   paused   |  open_close |  opened | print_on_enter | print_on_exit |
|   paused   |     play    | playing | print_on_enter | print_on_exit |
|   paused   |     stop    | stopped | print_on_enter | print_on_exit |
|  playing   |  open_close |  opened | print_on_enter | print_on_exit |
|  playing   |    pause    |  paused | print_on_enter | print_on_exit |
|  playing   |     stop    | stopped | print_on_enter | print_on_exit |
|  stopped   |  open_close |  opened | print_on_enter | print_on_exit |
|  stopped   |     play    | playing | print_on_enter | print_on_exit |
|  stopped   |     stop    | stopped | print_on_enter | print_on_exit |
+------------+-------------+---------+----------------+---------------+
=============
Current state =&gt; closed
=============
</pre></div>
</div>
</div>
<div class="section" id="creating-a-complex-cd-player-machine-using-a-state-space">
<h2>Creating a complex CD-player machine (using a state-space)<a class="headerlink" href="#creating-a-complex-cd-player-machine-using-a-state-space" title="Permalink to this headline"></a></h2>
<p>This example is equivalent to the prior one but creates a machine in
a more declarative manner. Instead of calling <code class="docutils literal"><span class="pre">add_state</span></code>
and <code class="docutils literal"><span class="pre">add_transition</span></code> a explicit and declarative format can be used. For
example to create the same machine:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">automaton</span> <span class="k">import</span> <span class="n">machines</span>


<span class="k">def</span> <span class="nf">print_on_enter</span><span class="p">(</span><span class="n">new_state</span><span class="p">,</span> <span class="n">triggered_event</span><span class="p">):</span>
   <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Entered &#39;</span><span class="si">%s</span><span class="s2">&#39; due to &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">new_state</span><span class="p">,</span> <span class="n">triggered_event</span><span class="p">))</span>


<span class="k">def</span> <span class="nf">print_on_exit</span><span class="p">(</span><span class="n">old_state</span><span class="p">,</span> <span class="n">triggered_event</span><span class="p">):</span>
   <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Exiting &#39;</span><span class="si">%s</span><span class="s2">&#39; due to &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">old_state</span><span class="p">,</span> <span class="n">triggered_event</span><span class="p">))</span>

<span class="c1"># This will contain all the states and transitions that our machine will</span>
<span class="c1"># allow, the format is relatively simple and designed to be easy to use.</span>
<span class="n">state_space</span> <span class="o">=</span> <span class="p">[</span>
    <span class="p">{</span>
        <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;stopped&#39;</span><span class="p">,</span>
        <span class="s1">&#39;next_states&#39;</span><span class="p">:</span> <span class="p">{</span>
            <span class="c1"># On event &#39;play&#39; transition to the &#39;playing&#39; state.</span>
            <span class="s1">&#39;play&#39;</span><span class="p">:</span> <span class="s1">&#39;playing&#39;</span><span class="p">,</span>
            <span class="s1">&#39;open_close&#39;</span><span class="p">:</span> <span class="s1">&#39;opened&#39;</span><span class="p">,</span>
            <span class="s1">&#39;stop&#39;</span><span class="p">:</span> <span class="s1">&#39;stopped&#39;</span><span class="p">,</span>
        <span class="p">},</span>
        <span class="s1">&#39;on_enter&#39;</span><span class="p">:</span> <span class="n">print_on_enter</span><span class="p">,</span>
        <span class="s1">&#39;on_exit&#39;</span><span class="p">:</span> <span class="n">print_on_exit</span><span class="p">,</span>
    <span class="p">},</span>
    <span class="p">{</span>
        <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;opened&#39;</span><span class="p">,</span>
        <span class="s1">&#39;next_states&#39;</span><span class="p">:</span> <span class="p">{</span>
            <span class="s1">&#39;open_close&#39;</span><span class="p">:</span> <span class="s1">&#39;closed&#39;</span><span class="p">,</span>
        <span class="p">},</span>
        <span class="s1">&#39;on_enter&#39;</span><span class="p">:</span> <span class="n">print_on_enter</span><span class="p">,</span>
        <span class="s1">&#39;on_exit&#39;</span><span class="p">:</span> <span class="n">print_on_exit</span><span class="p">,</span>
    <span class="p">},</span>
    <span class="p">{</span>
        <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;closed&#39;</span><span class="p">,</span>
        <span class="s1">&#39;next_states&#39;</span><span class="p">:</span> <span class="p">{</span>
            <span class="s1">&#39;open_close&#39;</span><span class="p">:</span> <span class="s1">&#39;opened&#39;</span><span class="p">,</span>
            <span class="s1">&#39;cd_detected&#39;</span><span class="p">:</span> <span class="s1">&#39;stopped&#39;</span><span class="p">,</span>
        <span class="p">},</span>
        <span class="s1">&#39;on_enter&#39;</span><span class="p">:</span> <span class="n">print_on_enter</span><span class="p">,</span>
        <span class="s1">&#39;on_exit&#39;</span><span class="p">:</span> <span class="n">print_on_exit</span><span class="p">,</span>
    <span class="p">},</span>
    <span class="p">{</span>
        <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;playing&#39;</span><span class="p">,</span>
        <span class="s1">&#39;next_states&#39;</span><span class="p">:</span> <span class="p">{</span>
            <span class="s1">&#39;stop&#39;</span><span class="p">:</span> <span class="s1">&#39;stopped&#39;</span><span class="p">,</span>
            <span class="s1">&#39;pause&#39;</span><span class="p">:</span> <span class="s1">&#39;paused&#39;</span><span class="p">,</span>
            <span class="s1">&#39;open_close&#39;</span><span class="p">:</span> <span class="s1">&#39;opened&#39;</span><span class="p">,</span>
        <span class="p">},</span>
        <span class="s1">&#39;on_enter&#39;</span><span class="p">:</span> <span class="n">print_on_enter</span><span class="p">,</span>
        <span class="s1">&#39;on_exit&#39;</span><span class="p">:</span> <span class="n">print_on_exit</span><span class="p">,</span>
    <span class="p">},</span>
    <span class="p">{</span>
        <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;paused&#39;</span><span class="p">,</span>
        <span class="s1">&#39;next_states&#39;</span><span class="p">:</span> <span class="p">{</span>
            <span class="s1">&#39;play&#39;</span><span class="p">:</span> <span class="s1">&#39;playing&#39;</span><span class="p">,</span>
            <span class="s1">&#39;stop&#39;</span><span class="p">:</span> <span class="s1">&#39;stopped&#39;</span><span class="p">,</span>
            <span class="s1">&#39;open_close&#39;</span><span class="p">:</span> <span class="s1">&#39;opened&#39;</span><span class="p">,</span>
        <span class="p">},</span>
        <span class="s1">&#39;on_enter&#39;</span><span class="p">:</span> <span class="n">print_on_enter</span><span class="p">,</span>
        <span class="s1">&#39;on_exit&#39;</span><span class="p">:</span> <span class="n">print_on_exit</span><span class="p">,</span>
    <span class="p">},</span>
<span class="p">]</span>

<span class="n">m</span> <span class="o">=</span> <span class="n">machines</span><span class="o">.</span><span class="n">FiniteMachine</span><span class="o">.</span><span class="n">build</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="n">default_start_state</span> <span class="o">=</span> <span class="s1">&#39;closed&#39;</span>
<span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">pformat</span><span class="p">())</span>
</pre></div>
</div>
<p><strong>Expected output:</strong></p>
<div class="highlight-none"><div class="highlight"><pre><span></span>+-----------+-------------+---------+----------------+---------------+
|   Start   |    Event    |   End   |    On Enter    |    On Exit    |
+-----------+-------------+---------+----------------+---------------+
| closed[^] | cd_detected | stopped | print_on_enter | print_on_exit |
| closed[^] |  open_close |  opened | print_on_enter | print_on_exit |
|   opened  |  open_close |  closed | print_on_enter | print_on_exit |
|   paused  |  open_close |  opened | print_on_enter | print_on_exit |
|   paused  |     play    | playing | print_on_enter | print_on_exit |
|   paused  |     stop    | stopped | print_on_enter | print_on_exit |
|  playing  |  open_close |  opened | print_on_enter | print_on_exit |
|  playing  |    pause    |  paused | print_on_enter | print_on_exit |
|  playing  |     stop    | stopped | print_on_enter | print_on_exit |
|  stopped  |  open_close |  opened | print_on_enter | print_on_exit |
|  stopped  |     play    | playing | print_on_enter | print_on_exit |
|  stopped  |     stop    | stopped | print_on_enter | print_on_exit |
+-----------+-------------+---------+----------------+---------------+
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">As can be seen the two tables from this example and the prior one are
exactly the same.</p>
</div>
</div>
</div>


          </div>
        </div>
      </div>
<div class="sphinxsidebar">
    <div class="sphinxsidebarwrapper">
            <h3><a href="index.html">Table Of Contents</a></h3>
            <ul>
<li><a class="reference internal" href="#">Examples</a><ul>
<li><a class="reference internal" href="#creating-a-simple-machine">Creating a simple machine</a></li>
<li><a class="reference internal" href="#transitioning-a-simple-machine">Transitioning a simple machine</a></li>
<li><a class="reference internal" href="#running-a-complex-dog-barking-machine">Running a complex dog-barking machine</a></li>
<li><a class="reference internal" href="#creating-a-complex-cd-player-machine">Creating a complex CD-player machine</a></li>
<li><a class="reference internal" href="#creating-a-complex-cd-player-machine-using-a-state-space">Creating a complex CD-player machine (using a state-space)</a></li>
</ul>
</li>
</ul>

            <h4>Previous topic</h4>
            <p class="topless"><a href="installation.html"
                                  title="previous chapter">Installation</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="contributing.html"
                                  title="next chapter">Contributing</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/examples.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
    </div>
</div>

      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="contributing.html" title="Contributing"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="installation.html" title="Installation"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">automaton  documentation</a> &#187;</li> 
      </ul>
    </div>

    <div class="footer" role="contentinfo">
        &#169; Copyright 2016, OpenStack Foundation.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
    </div>
<script type="text/javascript">
try {
//Tracking docs.openstack.org/developer/<projectname> only
//The URL is built from the project variable in conf.py
var pageTracker = _gat._getTracker("UA-17511903-1");
pageTracker._setCookiePath("/developer/automaton");
pageTracker._trackPageview();
} catch(err) {}</script>

  </body>
</html>

APT Browse - Built by Thomas Orozco.