/usr/share/doc/python-automaton-doc/html/_modules/automaton/runners.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 | <!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.runners</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/runners -->
<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.runners</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.runners</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright (C) 2015 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">abc</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">exceptions</span> <span class="k">as</span> <span class="n">excp</span>
<span class="kn">from</span> <span class="nn">automaton</span> <span class="k">import</span> <span class="n">machines</span>
<span class="n">_JUMPER_NOT_FOUND_TPL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"Unable to progress since no reaction (or"</span>
<span class="s2">" sent event) has been made available in"</span>
<span class="s2">" new state '</span><span class="si">%s</span><span class="s2">' (moved to from state '</span><span class="si">%s</span><span class="s2">'"</span>
<span class="s2">" in response to event '</span><span class="si">%s</span><span class="s2">')"</span><span class="p">)</span>
<div class="viewcode-block" id="Runner"><a class="viewcode-back" href="../../reference/index.html#automaton.runners.Runner">[docs]</a><span class="nd">@six</span><span class="o">.</span><span class="n">add_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Runner</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Machine runner used to run a state machine.</span>
<span class="sd"> Only **one** runner per machine should be active at the same time (aka</span>
<span class="sd"> there should not be multiple runners using the same machine instance at</span>
<span class="sd"> the same time).</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">machine</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_machine</span> <span class="o">=</span> <span class="n">machine</span>
<div class="viewcode-block" id="Runner.run"><a class="viewcode-back" href="../../reference/index.html#automaton.runners.Runner.run">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span> <span class="nf">run</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">initialize</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""Runs the state machine, using reactions only."""</span></div>
<div class="viewcode-block" id="Runner.run_iter"><a class="viewcode-back" href="../../reference/index.html#automaton.runners.Runner.run_iter">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span> <span class="nf">run_iter</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">initialize</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""Returns a iterator/generator that will run the state machine.</span>
<span class="sd"> NOTE(harlowja): only one runner iterator/generator should be active for</span>
<span class="sd"> a machine, if this is not observed then it is possible for</span>
<span class="sd"> initialization and other local state to be corrupted and cause issues</span>
<span class="sd"> when running...</span>
<span class="sd"> """</span></div></div>
<div class="viewcode-block" id="FiniteRunner"><a class="viewcode-back" href="../../reference/index.html#automaton.runners.FiniteRunner">[docs]</a><span class="k">class</span> <span class="nc">FiniteRunner</span><span class="p">(</span><span class="n">Runner</span><span class="p">):</span>
<span class="sd">"""Finite machine runner used to run a finite machine.</span>
<span class="sd"> Only **one** runner per machine should be active at the same time (aka</span>
<span class="sd"> there should not be multiple runners using the same machine instance at</span>
<span class="sd"> the same time).</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">machine</span><span class="p">):</span>
<span class="sd">"""Create a runner for the given machine."""</span>
<span class="k">if</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="p">(</span><span class="n">machines</span><span class="o">.</span><span class="n">FiniteMachine</span><span class="p">,)):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"FiniteRunner only works with FiniteMachine(s)"</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">FiniteRunner</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="n">machine</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">run</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">initialize</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="k">for</span> <span class="n">transition</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_iter</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">initialize</span><span class="o">=</span><span class="n">initialize</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">def</span> <span class="nf">run_iter</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">initialize</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="k">if</span> <span class="n">initialize</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_machine</span><span class="o">.</span><span class="n">initialize</span><span class="p">()</span>
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="n">old_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_machine</span><span class="o">.</span><span class="n">current_state</span>
<span class="n">reaction</span><span class="p">,</span> <span class="n">terminal</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_machine</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="n">new_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_machine</span><span class="o">.</span><span class="n">current_state</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">sent_event</span> <span class="o">=</span> <span class="k">yield</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="k">except</span> <span class="ne">GeneratorExit</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">if</span> <span class="n">terminal</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">if</span> <span class="n">reaction</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">sent_event</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">NotFound</span><span class="p">(</span><span class="n">_JUMPER_NOT_FOUND_TPL</span> <span class="o">%</span> <span class="p">(</span><span class="n">new_state</span><span class="p">,</span>
<span class="n">old_state</span><span class="p">,</span>
<span class="n">event</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">sent_event</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">sent_event</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">cb</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span> <span class="o">=</span> <span class="n">reaction</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">cb</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</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></div>
<div class="viewcode-block" id="HierarchicalRunner"><a class="viewcode-back" href="../../reference/index.html#automaton.runners.HierarchicalRunner">[docs]</a><span class="k">class</span> <span class="nc">HierarchicalRunner</span><span class="p">(</span><span class="n">Runner</span><span class="p">):</span>
<span class="sd">"""Hierarchical machine runner used to run a hierarchical machine.</span>
<span class="sd"> Only **one** runner per machine should be active at the same time (aka</span>
<span class="sd"> there should not be multiple runners using the same machine instance at</span>
<span class="sd"> the same time).</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">machine</span><span class="p">):</span>
<span class="sd">"""Create a runner for the given machine."""</span>
<span class="k">if</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="p">(</span><span class="n">machines</span><span class="o">.</span><span class="n">HierarchicalFiniteMachine</span><span class="p">,)):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"HierarchicalRunner only works with"</span>
<span class="s2">" HierarchicalFiniteMachine(s)"</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">HierarchicalRunner</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="n">machine</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">run</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">initialize</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="k">for</span> <span class="n">transition</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_iter</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">initialize</span><span class="o">=</span><span class="n">initialize</span><span class="p">):</span>
<span class="k">pass</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">_process_event</span><span class="p">(</span><span class="n">machines</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="sd">"""Matches a event to the machine hierarchy.</span>
<span class="sd"> If the lowest level machine does not handle the event, then the</span>
<span class="sd"> parent machine is referred to and so on, until there is only one</span>
<span class="sd"> machine left which *must* handle the event.</span>
<span class="sd"> The machine whose ``process_event`` does not throw invalid state or</span>
<span class="sd"> not found exceptions is expected to be the machine that should</span>
<span class="sd"> continue handling events...</span>
<span class="sd"> """</span>
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="n">machine</span> <span class="o">=</span> <span class="n">machines</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">machine</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="k">except</span> <span class="p">(</span><span class="n">excp</span><span class="o">.</span><span class="n">InvalidState</span><span class="p">,</span> <span class="n">excp</span><span class="o">.</span><span class="n">NotFound</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">machines</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">current</span> <span class="o">=</span> <span class="n">machine</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="ow">not</span> <span class="kc">None</span> <span class="ow">and</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="n">machine</span><span class="o">.</span><span class="n">_current</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">machines</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">result</span>
<div class="viewcode-block" id="HierarchicalRunner.run_iter"><a class="viewcode-back" href="../../reference/index.html#automaton.runners.HierarchicalRunner.run_iter">[docs]</a> <span class="k">def</span> <span class="nf">run_iter</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">initialize</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""Returns a iterator/generator that will run the state machine.</span>
<span class="sd"> This will keep a stack (hierarchy) of machines active and jumps through</span>
<span class="sd"> them as needed (depending on which machine handles which event) during</span>
<span class="sd"> the running lifecycle.</span>
<span class="sd"> NOTE(harlowja): only one runner iterator/generator should be active for</span>
<span class="sd"> a machine hierarchy, if this is not observed then it is possible for</span>
<span class="sd"> initialization and other local state to be corrupted and causes issues</span>
<span class="sd"> when running...</span>
<span class="sd"> """</span>
<span class="n">machines</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_machine</span><span class="p">]</span>
<span class="k">if</span> <span class="n">initialize</span><span class="p">:</span>
<span class="n">machines</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">initialize</span><span class="p">()</span>
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="n">old_state</span> <span class="o">=</span> <span class="n">machines</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">current_state</span>
<span class="n">effect</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_process_event</span><span class="p">(</span><span class="n">machines</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span>
<span class="n">new_state</span> <span class="o">=</span> <span class="n">machines</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">current_state</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">machine</span> <span class="o">=</span> <span class="n">effect</span><span class="o">.</span><span class="n">machine</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</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="ow">and</span> <span class="n">machine</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">machines</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
<span class="n">machine</span><span class="o">.</span><span class="n">initialize</span><span class="p">()</span>
<span class="n">machines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">machine</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">sent_event</span> <span class="o">=</span> <span class="k">yield</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="k">except</span> <span class="ne">GeneratorExit</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">machines</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">effect</span><span class="o">.</span><span class="n">terminal</span><span class="p">:</span>
<span class="c1"># Only allow the top level machine to actually terminate the</span>
<span class="c1"># execution, the rest of the nested machines must not handle</span>
<span class="c1"># events if they wish to have the root machine terminate...</span>
<span class="k">break</span>
<span class="k">if</span> <span class="n">effect</span><span class="o">.</span><span class="n">reaction</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">sent_event</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">NotFound</span><span class="p">(</span><span class="n">_JUMPER_NOT_FOUND_TPL</span> <span class="o">%</span> <span class="p">(</span><span class="n">new_state</span><span class="p">,</span>
<span class="n">old_state</span><span class="p">,</span>
<span class="n">event</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">sent_event</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">sent_event</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">cb</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span> <span class="o">=</span> <span class="n">effect</span><span class="o">.</span><span class="n">reaction</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">cb</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</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></div></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/runners" + ".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.runners 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>
|