/usr/share/doc/python-automaton-doc/html/_modules/automaton/converters/pydot.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 | <!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>automaton.converters.pydot — 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="up" title="Module code" href="../../index.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">
<h1>Source code for automaton.converters.pydot</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</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">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">pydot</span>
<span class="n">PYDOT_AVAILABLE</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="n">PYDOT_AVAILABLE</span> <span class="o">=</span> <span class="kc">False</span>
<div class="viewcode-block" id="convert"><a class="viewcode-back" href="../../../api.html#automaton.converters.pydot.convert">[docs]</a><span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="n">machine</span><span class="p">,</span> <span class="n">graph_name</span><span class="p">,</span>
<span class="n">graph_attrs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">node_attrs_cb</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">edge_attrs_cb</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">add_start_state</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">name_translations</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Translates the state machine into a pydot graph.</span>
<span class="sd"> :param machine: state machine to convert</span>
<span class="sd"> :type machine: FiniteMachine</span>
<span class="sd"> :param graph_name: name of the graph to be created</span>
<span class="sd"> :type graph_name: string</span>
<span class="sd"> :param graph_attrs: any initial graph attributes to set</span>
<span class="sd"> (see http://www.graphviz.org/doc/info/attrs.html for</span>
<span class="sd"> what these can be)</span>
<span class="sd"> :type graph_attrs: dict</span>
<span class="sd"> :param node_attrs_cb: a callback that takes one argument ``state``</span>
<span class="sd"> and is expected to return a dict of node attributes</span>
<span class="sd"> (see http://www.graphviz.org/doc/info/attrs.html for</span>
<span class="sd"> what these can be)</span>
<span class="sd"> :type node_attrs_cb: callback</span>
<span class="sd"> :param edge_attrs_cb: a callback that takes three arguments ``start_state,</span>
<span class="sd"> event, end_state`` and is expected to return a dict</span>
<span class="sd"> of edge attributes (see</span>
<span class="sd"> http://www.graphviz.org/doc/info/attrs.html for</span>
<span class="sd"> what these can be)</span>
<span class="sd"> :type edge_attrs_cb: callback</span>
<span class="sd"> :param add_start_state: when enabled this creates a *private* start state</span>
<span class="sd"> with the name ``__start__`` that will be a point</span>
<span class="sd"> node that will have a dotted edge to the</span>
<span class="sd"> ``default_start_state`` that your machine may have</span>
<span class="sd"> defined (if your machine has no actively defined</span>
<span class="sd"> ``default_start_state`` then this does nothing,</span>
<span class="sd"> even if enabled)</span>
<span class="sd"> :type add_start_state: bool</span>
<span class="sd"> :param name_translations: a dict that provides alternative ``state``</span>
<span class="sd"> string names for each state</span>
<span class="sd"> :type name_translations: dict</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">PYDOT_AVAILABLE</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">"pydot (or pydot2 or equivalent) is required"</span>
<span class="s2">" to convert a state machine into a pydot"</span>
<span class="s2">" graph"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">name_translations</span><span class="p">:</span>
<span class="n">name_translations</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">graph_kwargs</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'rankdir'</span><span class="p">:</span> <span class="s1">'LR'</span><span class="p">,</span>
<span class="s1">'nodesep'</span><span class="p">:</span> <span class="s1">'0.25'</span><span class="p">,</span>
<span class="s1">'overlap'</span><span class="p">:</span> <span class="s1">'false'</span><span class="p">,</span>
<span class="s1">'ranksep'</span><span class="p">:</span> <span class="s1">'0.5'</span><span class="p">,</span>
<span class="s1">'size'</span><span class="p">:</span> <span class="s2">"11x8.5"</span><span class="p">,</span>
<span class="s1">'splines'</span><span class="p">:</span> <span class="s1">'true'</span><span class="p">,</span>
<span class="s1">'ordering'</span><span class="p">:</span> <span class="s1">'in'</span><span class="p">,</span>
<span class="p">}</span>
<span class="k">if</span> <span class="n">graph_attrs</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">graph_kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">graph_attrs</span><span class="p">)</span>
<span class="n">graph_kwargs</span><span class="p">[</span><span class="s1">'graph_name'</span><span class="p">]</span> <span class="o">=</span> <span class="n">graph_name</span>
<span class="n">g</span> <span class="o">=</span> <span class="n">pydot</span><span class="o">.</span><span class="n">Dot</span><span class="p">(</span><span class="o">**</span><span class="n">graph_kwargs</span><span class="p">)</span>
<span class="n">node_attrs</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'fontsize'</span><span class="p">:</span> <span class="s1">'11'</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">nodes</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="p">(</span><span class="n">start_state</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">end_state</span><span class="p">)</span> <span class="ow">in</span> <span class="n">machine</span><span class="p">:</span>
<span class="k">if</span> <span class="n">start_state</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">nodes</span><span class="p">:</span>
<span class="n">start_node_attrs</span> <span class="o">=</span> <span class="n">node_attrs</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="k">if</span> <span class="n">node_attrs_cb</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">start_node_attrs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">node_attrs_cb</span><span class="p">(</span><span class="n">start_state</span><span class="p">))</span>
<span class="n">pretty_start_state</span> <span class="o">=</span> <span class="n">name_translations</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">start_state</span><span class="p">,</span>
<span class="n">start_state</span><span class="p">)</span>
<span class="n">nodes</span><span class="p">[</span><span class="n">start_state</span><span class="p">]</span> <span class="o">=</span> <span class="n">pydot</span><span class="o">.</span><span class="n">Node</span><span class="p">(</span><span class="n">pretty_start_state</span><span class="p">,</span>
<span class="o">**</span><span class="n">start_node_attrs</span><span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">nodes</span><span class="p">[</span><span class="n">start_state</span><span class="p">])</span>
<span class="k">if</span> <span class="n">end_state</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">nodes</span><span class="p">:</span>
<span class="n">end_node_attrs</span> <span class="o">=</span> <span class="n">node_attrs</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="k">if</span> <span class="n">node_attrs_cb</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">end_node_attrs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">node_attrs_cb</span><span class="p">(</span><span class="n">end_state</span><span class="p">))</span>
<span class="n">pretty_end_state</span> <span class="o">=</span> <span class="n">name_translations</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">end_state</span><span class="p">,</span> <span class="n">end_state</span><span class="p">)</span>
<span class="n">nodes</span><span class="p">[</span><span class="n">end_state</span><span class="p">]</span> <span class="o">=</span> <span class="n">pydot</span><span class="o">.</span><span class="n">Node</span><span class="p">(</span><span class="n">pretty_end_state</span><span class="p">,</span> <span class="o">**</span><span class="n">end_node_attrs</span><span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">nodes</span><span class="p">[</span><span class="n">end_state</span><span class="p">])</span>
<span class="n">edge_attrs</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="n">edge_attrs_cb</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">edge_attrs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">edge_attrs_cb</span><span class="p">(</span><span class="n">start_state</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">end_state</span><span class="p">))</span>
<span class="n">g</span><span class="o">.</span><span class="n">add_edge</span><span class="p">(</span><span class="n">pydot</span><span class="o">.</span><span class="n">Edge</span><span class="p">(</span><span class="n">nodes</span><span class="p">[</span><span class="n">start_state</span><span class="p">],</span> <span class="n">nodes</span><span class="p">[</span><span class="n">end_state</span><span class="p">],</span>
<span class="o">**</span><span class="n">edge_attrs</span><span class="p">))</span>
<span class="k">if</span> <span class="n">add_start_state</span> <span class="ow">and</span> <span class="n">machine</span><span class="o">.</span><span class="n">default_start_state</span><span class="p">:</span>
<span class="n">start</span> <span class="o">=</span> <span class="n">pydot</span><span class="o">.</span><span class="n">Node</span><span class="p">(</span><span class="s2">"__start__"</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="s2">"point"</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="s2">"0.1"</span><span class="p">,</span>
<span class="n">xlabel</span><span class="o">=</span><span class="s1">'start'</span><span class="p">,</span> <span class="n">fontcolor</span><span class="o">=</span><span class="s1">'green'</span><span class="p">,</span> <span class="o">**</span><span class="n">node_attrs</span><span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">start</span><span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">add_edge</span><span class="p">(</span><span class="n">pydot</span><span class="o">.</span><span class="n">Edge</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">nodes</span><span class="p">[</span><span class="n">machine</span><span class="o">.</span><span class="n">default_start_state</span><span class="p">],</span>
<span class="n">style</span><span class="o">=</span><span class="s1">'dotted'</span><span class="p">))</span>
<span class="k">return</span> <span class="n">g</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<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="nav-item nav-item-0"><a href="../../../index.html">automaton documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© 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>
|