Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.15.0 / . / pydoc / 2.15.0 / _modules / apache_beam / runners / interactive / display / pipeline_graph_renderer.html
blob: a66044b18443db9408ba3e129ec4dc0b0e913e96 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.runners.interactive.display.pipeline_graph_renderer &mdash; Apache Beam documentation</title>
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../../../../../genindex.html"/>
<link rel="search" title="Search" href="../../../../../search.html"/>
<link rel="top" title="Apache Beam documentation" href="../../../../../index.html"/>
<link rel="up" title="Module code" href="../../../../index.html"/>
<script src="../../../../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../../../../index.html" class="icon icon-home"> Apache Beam
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.internal.html">apache_beam.internal package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.io.html">apache_beam.io package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.testing.html">apache_beam.testing package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.tools.html">apache_beam.tools package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../apache_beam.version.html">apache_beam.version module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../../index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../../../index.html">Module code</a> &raquo;</li>
<li>apache_beam.runners.interactive.display.pipeline_graph_renderer</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for apache_beam.runners.interactive.display.pipeline_graph_renderer</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain 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 &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="sd">&quot;&quot;&quot;For rendering pipeline graph in HTML-compatible format.</span>
<span class="sd">This module is experimental. No backwards-compatibility guarantees.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">division</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
<span class="kn">import</span> <span class="nn">abc</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">from</span> <span class="nn">future.utils</span> <span class="k">import</span> <span class="n">with_metaclass</span>
<span class="kn">from</span> <span class="nn">apache_beam.utils.plugin</span> <span class="k">import</span> <span class="n">BeamPlugin</span>
<div class="viewcode-block" id="PipelineGraphRenderer"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer">[docs]</a><span class="k">class</span> <span class="nc">PipelineGraphRenderer</span><span class="p">(</span><span class="n">with_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="n">BeamPlugin</span><span class="p">)):</span>
<span class="sd">&quot;&quot;&quot;Abstract class for renderers, who decide how pipeline graphs are rendered.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="PipelineGraphRenderer.option"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer.option">[docs]</a> <span class="nd">@classmethod</span>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span> <span class="nf">option</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;The corresponding rendering option for the renderer.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
<div class="viewcode-block" id="PipelineGraphRenderer.render_pipeline_graph"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer.render_pipeline_graph">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span> <span class="nf">render_pipeline_graph</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pipeline_graph</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Renders the pipeline graph in HTML-compatible format.</span>
<span class="sd"> Args:</span>
<span class="sd"> pipeline_graph: (pipeline_graph.PipelineGraph) the graph to be rendererd.</span>
<span class="sd"> Returns:</span>
<span class="sd"> unicode, str or bytes that can be expressed as HTML.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div></div>
<div class="viewcode-block" id="MuteRenderer"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer">[docs]</a><span class="k">class</span> <span class="nc">MuteRenderer</span><span class="p">(</span><span class="n">PipelineGraphRenderer</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Use this renderer to mute the pipeline display.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="MuteRenderer.option"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer.option">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">option</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">&#39;mute&#39;</span></div>
<div class="viewcode-block" id="MuteRenderer.render_pipeline_graph"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer.render_pipeline_graph">[docs]</a> <span class="k">def</span> <span class="nf">render_pipeline_graph</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pipeline_graph</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">&#39;&#39;</span></div></div>
<div class="viewcode-block" id="TextRenderer"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer">[docs]</a><span class="k">class</span> <span class="nc">TextRenderer</span><span class="p">(</span><span class="n">PipelineGraphRenderer</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;This renderer simply returns the dot representation in text format.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="TextRenderer.option"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer.option">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">option</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">&#39;text&#39;</span></div>
<div class="viewcode-block" id="TextRenderer.render_pipeline_graph"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer.render_pipeline_graph">[docs]</a> <span class="k">def</span> <span class="nf">render_pipeline_graph</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pipeline_graph</span><span class="p">):</span>
<span class="k">return</span> <span class="n">pipeline_graph</span><span class="o">.</span><span class="n">get_dot</span><span class="p">()</span></div></div>
<div class="viewcode-block" id="PydotRenderer"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer">[docs]</a><span class="k">class</span> <span class="nc">PydotRenderer</span><span class="p">(</span><span class="n">PipelineGraphRenderer</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;This renderer renders the graph using pydot.</span>
<span class="sd"> It depends on</span>
<span class="sd"> 1. The software Graphviz: https://www.graphviz.org/</span>
<span class="sd"> 2. The python module pydot: https://pypi.org/project/pydot/</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="PydotRenderer.option"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer.option">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">option</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">&#39;graph&#39;</span></div>
<div class="viewcode-block" id="PydotRenderer.render_pipeline_graph"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer.render_pipeline_graph">[docs]</a> <span class="k">def</span> <span class="nf">render_pipeline_graph</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pipeline_graph</span><span class="p">):</span>
<span class="k">return</span> <span class="n">pipeline_graph</span><span class="o">.</span><span class="n">_get_graph</span><span class="p">()</span><span class="o">.</span><span class="n">create_svg</span><span class="p">()</span> <span class="c1"># pylint: disable=protected-access</span></div></div>
<div class="viewcode-block" id="get_renderer"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.display.pipeline_graph_renderer.html#apache_beam.runners.interactive.display.pipeline_graph_renderer.get_renderer">[docs]</a><span class="k">def</span> <span class="nf">get_renderer</span><span class="p">(</span><span class="n">option</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Get an instance of PipelineGraphRenderer given rendering option.</span>
<span class="sd"> Args:</span>
<span class="sd"> option: (str) the rendering option.</span>
<span class="sd"> Returns:</span>
<span class="sd"> (PipelineGraphRenderer)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">option</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s1">&#39;nt&#39;</span><span class="p">:</span>
<span class="n">exists</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">([</span><span class="s1">&#39;where&#39;</span><span class="p">,</span> <span class="s1">&#39;dot.exe&#39;</span><span class="p">])</span> <span class="o">==</span> <span class="mi">0</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">exists</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">([</span><span class="s1">&#39;which&#39;</span><span class="p">,</span> <span class="s1">&#39;dot&#39;</span><span class="p">])</span> <span class="o">==</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">exists</span><span class="p">:</span>
<span class="n">option</span> <span class="o">=</span> <span class="s1">&#39;graph&#39;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">option</span> <span class="o">=</span> <span class="s1">&#39;text&#39;</span>
<span class="n">renderer</span> <span class="o">=</span> <span class="p">[</span><span class="n">r</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">PipelineGraphRenderer</span><span class="o">.</span><span class="n">get_all_subclasses</span><span class="p">()</span>
<span class="k">if</span> <span class="n">option</span> <span class="o">==</span> <span class="n">r</span><span class="o">.</span><span class="n">option</span><span class="p">()]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">()</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span> <span class="n">renderer</span><span class="p">[</span><span class="mi">0</span><span class="p">]()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Found more than one renderer for option: </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span>
<span class="n">option</span><span class="p">)</span></div>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright .
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../../../',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<script type="text/javascript" src="../../../../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>