blob: e660d1ab4efec30097354574138dc4bc0635d680 [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.direct.transform_evaluator module &mdash; Apache Beam documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.runners.direct.util module" href="apache_beam.runners.direct.util.html" />
<link rel="prev" title="apache_beam.runners.direct.test_stream_impl module" href="apache_beam.runners.direct.test_stream_impl.html" />
</head>
<body class="wy-body-for-nav">
<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 class="current">
<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.ml.html">apache_beam.ml 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 current"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.direct.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.internal.html">apache_beam.runners.internal package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li>
</ul>
</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" 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="apache_beam.runners.html">apache_beam.runners package</a> &raquo;</li>
<li><a href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a> &raquo;</li>
<li>apache_beam.runners.direct.transform_evaluator module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.runners.direct.transform_evaluator.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-apache_beam.runners.direct.transform_evaluator">
<span id="apache-beam-runners-direct-transform-evaluator-module"></span><h1>apache_beam.runners.direct.transform_evaluator module<a class="headerlink" href="#module-apache_beam.runners.direct.transform_evaluator" title="Permalink to this headline"></a></h1>
<p>An evaluator of a specific application of a transform.</p>
<dl class="class">
<dt id="apache_beam.runners.direct.transform_evaluator.TransformEvaluatorRegistry">
<em class="property">class </em><code class="descclassname">apache_beam.runners.direct.transform_evaluator.</code><code class="descname">TransformEvaluatorRegistry</code><span class="sig-paren">(</span><em>evaluation_context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/transform_evaluator.html#TransformEvaluatorRegistry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.direct.transform_evaluator.TransformEvaluatorRegistry" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>For internal use only; no backwards-compatibility guarantees.</p>
<p>Creates instances of TransformEvaluator for the application of a transform.</p>
<dl class="method">
<dt id="apache_beam.runners.direct.transform_evaluator.TransformEvaluatorRegistry.get_evaluator">
<code class="descname">get_evaluator</code><span class="sig-paren">(</span><em>applied_ptransform</em>, <em>input_committed_bundle</em>, <em>side_inputs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/transform_evaluator.html#TransformEvaluatorRegistry.get_evaluator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.direct.transform_evaluator.TransformEvaluatorRegistry.get_evaluator" title="Permalink to this definition"></a></dt>
<dd><p>Returns a TransformEvaluator suitable for processing given inputs.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.direct.transform_evaluator.TransformEvaluatorRegistry.get_root_bundle_provider">
<code class="descname">get_root_bundle_provider</code><span class="sig-paren">(</span><em>applied_ptransform</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/transform_evaluator.html#TransformEvaluatorRegistry.get_root_bundle_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.direct.transform_evaluator.TransformEvaluatorRegistry.get_root_bundle_provider" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.direct.transform_evaluator.TransformEvaluatorRegistry.should_execute_serially">
<code class="descname">should_execute_serially</code><span class="sig-paren">(</span><em>applied_ptransform</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/transform_evaluator.html#TransformEvaluatorRegistry.should_execute_serially"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.direct.transform_evaluator.TransformEvaluatorRegistry.should_execute_serially" title="Permalink to this definition"></a></dt>
<dd><p>Returns True if this applied_ptransform should run one bundle at a time.</p>
<p>Some TransformEvaluators use a global state object to keep track of their
global execution state. For example evaluator for _GroupByKeyOnly uses this
state as an in memory dictionary to buffer keys.</p>
<p>Serially executed evaluators will act as syncing point in the graph and
execution will not move forward until they receive all of their inputs. Once
they receive all of their input, they will release the combined output.
Their output may consist of multiple bundles as they may divide their output
into pieces before releasing.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>applied_ptransform</strong> – Transform to be used for execution.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if executor should execute applied_ptransform serially.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.direct.transform_evaluator.RootBundleProvider">
<em class="property">class </em><code class="descclassname">apache_beam.runners.direct.transform_evaluator.</code><code class="descname">RootBundleProvider</code><span class="sig-paren">(</span><em>evaluation_context</em>, <em>applied_ptransform</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/transform_evaluator.html#RootBundleProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.direct.transform_evaluator.RootBundleProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Provides bundles for the initial execution of a root transform.</p>
<dl class="method">
<dt id="apache_beam.runners.direct.transform_evaluator.RootBundleProvider.get_root_bundles">
<code class="descname">get_root_bundles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/transform_evaluator.html#RootBundleProvider.get_root_bundles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.direct.transform_evaluator.RootBundleProvider.get_root_bundles" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.direct.transform_evaluator.DefaultRootBundleProvider">
<em class="property">class </em><code class="descclassname">apache_beam.runners.direct.transform_evaluator.</code><code class="descname">DefaultRootBundleProvider</code><span class="sig-paren">(</span><em>evaluation_context</em>, <em>applied_ptransform</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/transform_evaluator.html#DefaultRootBundleProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.direct.transform_evaluator.DefaultRootBundleProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.runners.direct.transform_evaluator.RootBundleProvider" title="apache_beam.runners.direct.transform_evaluator.RootBundleProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.runners.direct.transform_evaluator.RootBundleProvider</span></code></a></p>
<p>Provides an empty bundle by default for root transforms.</p>
<dl class="method">
<dt id="apache_beam.runners.direct.transform_evaluator.DefaultRootBundleProvider.get_root_bundles">
<code class="descname">get_root_bundles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/transform_evaluator.html#DefaultRootBundleProvider.get_root_bundles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.direct.transform_evaluator.DefaultRootBundleProvider.get_root_bundles" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.runners.direct.util.html" class="btn btn-neutral float-right" title="apache_beam.runners.direct.util module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.runners.direct.test_stream_impl.html" class="btn btn-neutral float-left" title="apache_beam.runners.direct.test_stream_impl module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<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/rtfd/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">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>