blob: 7c6494f696759f3a97155de63316b752ae26de17 [file] [log] [blame]
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>apache_beam.runners.direct.sdf_direct_runner module &mdash; Apache Beam 2.68.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=2388e03a"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.runners.direct.test_direct_runner module" href="apache_beam.runners.direct.test_direct_runner.html" />
<link rel="prev" title="apache_beam.runners.direct.executor module" href="apache_beam.runners.direct.executor.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" aria-label="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="Navigation menu">
<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.dataframe.html">apache_beam.dataframe 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.dask.html">apache_beam.runners.dask package</a></li>
<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.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.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>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml 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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="breadcrumb-item"><a href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li>
<li class="breadcrumb-item active">apache_beam.runners.direct.sdf_direct_runner module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.runners.direct.sdf_direct_runner.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">
<section id="module-apache_beam.runners.direct.sdf_direct_runner">
<span id="apache-beam-runners-direct-sdf-direct-runner-module"></span><h1>apache_beam.runners.direct.sdf_direct_runner module<a class="headerlink" href="#module-apache_beam.runners.direct.sdf_direct_runner" title="Link to this heading"></a></h1>
<p>This module contains Splittable DoFn logic that is specific to DirectRunner.</p>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SplittableParDoOverride">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">SplittableParDoOverride</span></span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SplittableParDoOverride"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SplittableParDoOverride" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">PTransformOverride</span></code></p>
<p>A transform override for ParDo transformss of SplittableDoFns.</p>
<p>Replaces the ParDo transform with a SplittableParDo transform that performs
SDF specific logic.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SplittableParDoOverride.matches">
<span class="sig-name descname"><span class="pre">matches</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">applied_ptransform</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SplittableParDoOverride.matches"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SplittableParDoOverride.matches" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SplittableParDoOverride.get_replacement_transform_for_applied_ptransform">
<span class="sig-name descname"><span class="pre">get_replacement_transform_for_applied_ptransform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">applied_ptransform</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SplittableParDoOverride.get_replacement_transform_for_applied_ptransform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SplittableParDoOverride.get_replacement_transform_for_applied_ptransform" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SplittableParDo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">SplittableParDo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ptransform</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SplittableParDo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SplittableParDo" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">PTransform</span></code></a></p>
<p>A transform that processes a PCollection using a Splittable DoFn.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SplittableParDo.expand">
<span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pcoll</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SplittableParDo.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SplittableParDo.expand" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ElementAndRestriction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">ElementAndRestriction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restriction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watermark_estimator_state</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ElementAndRestriction"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ElementAndRestriction" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A holder for an element, restriction, and watermark estimator state.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.PairWithRestrictionFn">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">PairWithRestrictionFn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">do_fn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#PairWithRestrictionFn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.PairWithRestrictionFn" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p>
<p>A transform that pairs each element with a restriction.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.PairWithRestrictionFn.start_bundle">
<span class="sig-name descname"><span class="pre">start_bundle</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#PairWithRestrictionFn.start_bundle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.PairWithRestrictionFn.start_bundle" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.PairWithRestrictionFn.process">
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">WindowParam</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#PairWithRestrictionFn.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.PairWithRestrictionFn.process" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SplitRestrictionFn">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">SplitRestrictionFn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">do_fn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SplitRestrictionFn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SplitRestrictionFn" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p>
<p>A transform that perform initial splitting of Splittable DoFn inputs.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SplitRestrictionFn.start_bundle">
<span class="sig-name descname"><span class="pre">start_bundle</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SplitRestrictionFn.start_bundle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SplitRestrictionFn.start_bundle" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SplitRestrictionFn.process">
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element_and_restriction</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SplitRestrictionFn.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SplitRestrictionFn.process" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ExplodeWindowsFn">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">ExplodeWindowsFn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">unused_args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">unused_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ExplodeWindowsFn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ExplodeWindowsFn" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p>
<p>A transform that forces the runner to explode windows.</p>
<p>This is done to make sure that Splittable DoFn proceses an element for each of
the windows that element belongs to.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ExplodeWindowsFn.process">
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">WindowParam</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ExplodeWindowsFn.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ExplodeWindowsFn.process" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.RandomUniqueKeyFn">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">RandomUniqueKeyFn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">unused_args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">unused_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#RandomUniqueKeyFn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.RandomUniqueKeyFn" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p>
<p>A transform that assigns a unique key to each element.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.RandomUniqueKeyFn.process">
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">WindowParam</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#RandomUniqueKeyFn.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.RandomUniqueKeyFn.process" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElements">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">ProcessKeyedElements</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sdf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_coder</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restriction_coder</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">windowing_strategy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ptransform_args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ptransform_kwargs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ptransform_side_inputs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessKeyedElements"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElements" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">PTransform</span></code></a></p>
<p>A primitive transform that performs SplittableDoFn magic.</p>
<p>Input to this transform should be a PCollection of keyed ElementAndRestriction
objects.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElements.expand">
<span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pcoll</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessKeyedElements.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElements.expand" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItemsOverride">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">ProcessKeyedElementsViaKeyedWorkItemsOverride</span></span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessKeyedElementsViaKeyedWorkItemsOverride"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItemsOverride" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">PTransformOverride</span></code></p>
<p>A transform override for ProcessElements transform.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItemsOverride.matches">
<span class="sig-name descname"><span class="pre">matches</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">applied_ptransform</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessKeyedElementsViaKeyedWorkItemsOverride.matches"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItemsOverride.matches" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItemsOverride.get_replacement_transform_for_applied_ptransform">
<span class="sig-name descname"><span class="pre">get_replacement_transform_for_applied_ptransform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">applied_ptransform</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessKeyedElementsViaKeyedWorkItemsOverride.get_replacement_transform_for_applied_ptransform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItemsOverride.get_replacement_transform_for_applied_ptransform" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItems">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">ProcessKeyedElementsViaKeyedWorkItems</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">process_keyed_elements_transform</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessKeyedElementsViaKeyedWorkItems"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItems" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">PTransform</span></code></a></p>
<p>A transform that processes Splittable DoFn input via KeyedWorkItems.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItems.expand">
<span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pcoll</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessKeyedElementsViaKeyedWorkItems.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessKeyedElementsViaKeyedWorkItems.expand" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessElements">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">ProcessElements</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">process_keyed_elements_transform</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessElements"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessElements" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">PTransform</span></code></a></p>
<p>A primitive transform for processing keyed elements or KeyedWorkItems.</p>
<p>Will be evaluated by
<cite>runners.direct.transform_evaluator._ProcessElementsEvaluator</cite>.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessElements.expand">
<span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pcoll</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessElements.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessElements.expand" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessElements.new_process_fn">
<span class="sig-name descname"><span class="pre">new_process_fn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sdf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessElements.new_process_fn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessElements.new_process_fn" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessFn">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">ProcessFn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sdf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args_for_invoker</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kwargs_for_invoker</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessFn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessFn" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p>
<p>A <cite>DoFn</cite> that executes machineary for invoking a Splittable <cite>DoFn</cite>.</p>
<p>Input to the <cite>ParDo</cite> step that includes a <cite>ProcessFn</cite> will be a <cite>PCollection</cite>
of <cite>ElementAndRestriction</cite> objects.</p>
<p>This class is mainly responsible for following.
(1) setup environment for properly invoking a Splittable <cite>DoFn</cite>.
(2) invoke <cite>process()</cite> method of a Splittable <cite>DoFn</cite>.
(3) after the <cite>process()</cite> invocation of the Splittable <cite>DoFn</cite>, determine if a
re-invocation of the element is needed. If this is the case, set state and
a timer for a re-invocation and hold output watermark till this
re-invocation.
(4) after the final invocation of a given element clear any previous state set
for re-invoking the element and release the output watermark.</p>
<dl class="py property">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessFn.step_context">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">step_context</span></span><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessFn.step_context" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessFn.set_process_element_invoker">
<span class="sig-name descname"><span class="pre">set_process_element_invoker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">process_element_invoker</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessFn.set_process_element_invoker"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessFn.set_process_element_invoker" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.ProcessFn.process">
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">TimestampParam</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">WindowParam</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#ProcessFn.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.ProcessFn.process" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SDFProcessElementInvoker">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.direct.sdf_direct_runner.</span></span><span class="sig-name descname"><span class="pre">SDFProcessElementInvoker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_num_outputs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_duration</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SDFProcessElementInvoker"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SDFProcessElementInvoker" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A utility that invokes SDF <cite>process()</cite> method and requests checkpoints.</p>
<p>This class is responsible for invoking the <cite>process()</cite> method of a Splittable
<cite>DoFn</cite> and making sure that invocation terminated properly. Based on the input
configuration, this class may decide to request a checkpoint for a <cite>process()</cite>
execution so that runner can process current output and resume the invocation
at a later time.</p>
<p>More specifically, when initializing a <cite>SDFProcessElementInvoker</cite>, caller may
specify the number of output elements or processing time after which a
checkpoint should be requested. This class is responsible for properly
requesting a checkpoint based on either of these criteria.
When the <cite>process()</cite> call of Splittable <cite>DoFn</cite> ends, this class performs
validations to make sure that processing ended gracefully and returns a
<cite>SDFProcessElementInvoker.Result</cite> that contains information which can be used
by the caller to perform another <cite>process()</cite> invocation for the residual.</p>
<p>A <cite>process()</cite> invocation may decide to give up processing voluntarily by
returning a <cite>ProcessContinuation</cite> object (see documentation of
<cite>ProcessContinuation</cite> for more details). So if a ‘ProcessContinuation’ is
produced this class ends the execution and performs steps to finalize the
current invocation.</p>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SDFProcessElementInvoker.Result">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">residual_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">process_continuation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">future_output_watermark</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SDFProcessElementInvoker.Result"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SDFProcessElementInvoker.Result" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Returned as a result of a <cite>invoke_process_element()</cite> invocation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>residual_restriction</strong> – a restriction for the unprocessed part of the
element.</p></li>
<li><p><strong>process_continuation</strong> – a <cite>ProcessContinuation</cite> if one was returned as the
last element of the SDF <cite>process()</cite> invocation.</p></li>
<li><p><strong>future_output_watermark</strong> – output watermark of the results that will be
produced when invoking the Splittable <cite>DoFn</cite>
for the current element with
<cite>residual_restriction</cite>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SDFProcessElementInvoker.test_method">
<span class="sig-name descname"><span class="pre">test_method</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SDFProcessElementInvoker.test_method"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SDFProcessElementInvoker.test_method" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.direct.sdf_direct_runner.SDFProcessElementInvoker.invoke_process_element">
<span class="sig-name descname"><span class="pre">invoke_process_element</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sdf_invoker</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_processor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restriction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watermark_estimator_state</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/direct/sdf_direct_runner.html#SDFProcessElementInvoker.invoke_process_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.direct.sdf_direct_runner.SDFProcessElementInvoker.invoke_process_element" title="Link to this definition"></a></dt>
<dd><p>Invokes <cite>process()</cite> method of a Splittable <cite>DoFn</cite> for a given element.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sdf_invoker</strong> – a <cite>DoFnInvoker</cite> for the Splittable <cite>DoFn</cite>.</p></li>
<li><p><strong>element</strong> – the element to process</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>a <cite>SDFProcessElementInvoker.Result</cite> object.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="apache_beam.runners.direct.executor.html" class="btn btn-neutral float-left" title="apache_beam.runners.direct.executor module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="apache_beam.runners.direct.test_direct_runner.html" class="btn btn-neutral float-right" title="apache_beam.runners.direct.test_direct_runner module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright %Y, Apache Beam.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>