Google Git
Sign in
apache / beam-site / aa4899384bfb3460196adf6331c744cb480b96df / . / pydoc / 2.38.0 / _modules / apache_beam / runners / sdf_utils.html
blob: 56ec0f2c702cebe999e4baeb5a2e6febd1a9371e [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.sdf_utils &mdash; Apache Beam 2.38.0 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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></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" />
</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 class="version">
2.38.0
</div>
<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.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"><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.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>
</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="../../index.html">Module code</a> &raquo;</li>
<li>apache_beam.runners.sdf_utils</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.sdf_utils</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="c1"># pytype: skip-file</span>
<span class="sd">&quot;&quot;&quot;Common utility class to help SDK harness to execute an SDF. &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">threading</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">NamedTuple</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="kn">import</span> <span class="n">WatermarkEstimatorProvider</span>
<span class="kn">from</span> <span class="nn">apache_beam.utils.timestamp</span> <span class="kn">import</span> <span class="n">Duration</span>
<span class="kn">from</span> <span class="nn">apache_beam.utils.timestamp</span> <span class="kn">import</span> <span class="n">Timestamp</span>
<span class="kn">from</span> <span class="nn">apache_beam.utils.windowed_value</span> <span class="kn">import</span> <span class="n">WindowedValue</span>
<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">apache_beam.io.iobase</span> <span class="kn">import</span> <span class="n">RestrictionProgress</span>
<span class="kn">from</span> <span class="nn">apache_beam.io.iobase</span> <span class="kn">import</span> <span class="n">RestrictionTracker</span>
<span class="kn">from</span> <span class="nn">apache_beam.io.iobase</span> <span class="kn">import</span> <span class="n">WatermarkEstimator</span>
<span class="n">_LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<span class="n">SplitResultPrimary</span> <span class="o">=</span> <span class="n">NamedTuple</span><span class="p">(</span>
<span class="s1">&#39;SplitResultPrimary&#39;</span><span class="p">,</span> <span class="p">[(</span><span class="s1">&#39;primary_value&#39;</span><span class="p">,</span> <span class="n">WindowedValue</span><span class="p">)])</span>
<span class="n">SplitResultResidual</span> <span class="o">=</span> <span class="n">NamedTuple</span><span class="p">(</span>
<span class="s1">&#39;SplitResultResidual&#39;</span><span class="p">,</span>
<span class="p">[(</span><span class="s1">&#39;residual_value&#39;</span><span class="p">,</span> <span class="n">WindowedValue</span><span class="p">),</span> <span class="p">(</span><span class="s1">&#39;current_watermark&#39;</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;deferred_timestamp&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Duration</span><span class="p">])])</span>
<div class="viewcode-block" id="ThreadsafeRestrictionTracker"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker">[docs]</a><span class="k">class</span> <span class="nc">ThreadsafeRestrictionTracker</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;A thread-safe wrapper which wraps a `RestritionTracker`.</span>
<span class="sd"> This wrapper guarantees synchronization of modifying restrictions across</span>
<span class="sd"> multi-thread.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">restriction_tracker</span><span class="p">):</span>
<span class="c1"># type: (RestrictionTracker) -&gt; None</span>
<span class="kn">from</span> <span class="nn">apache_beam.io.iobase</span> <span class="kn">import</span> <span class="n">RestrictionTracker</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">restriction_tracker</span><span class="p">,</span> <span class="n">RestrictionTracker</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;Initialize ThreadsafeRestrictionTracker requires&#39;</span>
<span class="s1">&#39;RestrictionTracker.&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_restriction_tracker</span> <span class="o">=</span> <span class="n">restriction_tracker</span>
<span class="c1"># Records an absolute timestamp when defer_remainder is called.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_timestamp</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">RLock</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_deferred_residual</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># type: Optional[Union[Timestamp, Duration]]</span>
<div class="viewcode-block" id="ThreadsafeRestrictionTracker.current_restriction"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_restriction">[docs]</a> <span class="k">def</span> <span class="nf">current_restriction</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_restriction_tracker</span><span class="o">.</span><span class="n">current_restriction</span><span class="p">()</span></div>
<div class="viewcode-block" id="ThreadsafeRestrictionTracker.try_claim"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_claim">[docs]</a> <span class="k">def</span> <span class="nf">try_claim</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">position</span><span class="p">):</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_restriction_tracker</span><span class="o">.</span><span class="n">try_claim</span><span class="p">(</span><span class="n">position</span><span class="p">)</span></div>
<div class="viewcode-block" id="ThreadsafeRestrictionTracker.defer_remainder"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.defer_remainder">[docs]</a> <span class="k">def</span> <span class="nf">defer_remainder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">deferred_time</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Performs self-checkpoint on current processing restriction with an</span>
<span class="sd"> expected resuming time.</span>
<span class="sd"> Self-checkpoint could happen during processing elements. When executing an</span>
<span class="sd"> DoFn.process(), you may want to stop processing an element and resuming</span>
<span class="sd"> later if current element has been processed quit a long time or you also</span>
<span class="sd"> want to have some outputs from other elements. ``defer_remainder()`` can be</span>
<span class="sd"> called on per element if needed.</span>
<span class="sd"> Args:</span>
<span class="sd"> deferred_time: A relative ``Duration`` that indicates the ideal time gap</span>
<span class="sd"> between now and resuming, or an absolute ``Timestamp`` for resuming</span>
<span class="sd"> execution time. If the time_delay is None, the deferred work will be</span>
<span class="sd"> executed as soon as possible.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Record current time for calculating deferred_time later.</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_timestamp</span> <span class="o">=</span> <span class="n">Timestamp</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
<span class="k">if</span> <span class="n">deferred_time</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">deferred_time</span><span class="p">,</span> <span class="p">(</span><span class="n">Duration</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;The timestamp of deter_remainder() should be a &#39;</span>
<span class="s1">&#39;Duration or a Timestamp, or None.&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span> <span class="o">=</span> <span class="n">deferred_time</span>
<span class="n">checkpoint</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">try_split</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="n">checkpoint</span><span class="p">:</span>
<span class="n">_</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_deferred_residual</span> <span class="o">=</span> <span class="n">checkpoint</span></div>
<div class="viewcode-block" id="ThreadsafeRestrictionTracker.check_done"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.check_done">[docs]</a> <span class="k">def</span> <span class="nf">check_done</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_restriction_tracker</span><span class="o">.</span><span class="n">check_done</span><span class="p">()</span></div>
<div class="viewcode-block" id="ThreadsafeRestrictionTracker.current_progress"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_progress">[docs]</a> <span class="k">def</span> <span class="nf">current_progress</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; RestrictionProgress</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_restriction_tracker</span><span class="o">.</span><span class="n">current_progress</span><span class="p">()</span></div>
<div class="viewcode-block" id="ThreadsafeRestrictionTracker.try_split"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_split">[docs]</a> <span class="k">def</span> <span class="nf">try_split</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fraction_of_remainder</span><span class="p">):</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_restriction_tracker</span><span class="o">.</span><span class="n">try_split</span><span class="p">(</span><span class="n">fraction_of_remainder</span><span class="p">)</span></div>
<div class="viewcode-block" id="ThreadsafeRestrictionTracker.deferred_status"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.deferred_status">[docs]</a> <span class="k">def</span> <span class="nf">deferred_status</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; Optional[Tuple[Any, Duration]]</span>
<span class="sd">&quot;&quot;&quot;Returns deferred work which is produced by ``defer_remainder()``.</span>
<span class="sd"> When there is a self-checkpoint performed, the system needs to fulfill the</span>
<span class="sd"> DelayedBundleApplication with deferred_work for a ProcessBundleResponse.</span>
<span class="sd"> The system calls this API to get deferred_residual with watermark together</span>
<span class="sd"> to help the runner to schedule a future work.</span>
<span class="sd"> Returns: (deferred_residual, time_delay) if having any residual, else None.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_deferred_residual</span><span class="p">:</span>
<span class="c1"># If _deferred_timestamp is None, create Duration(0).</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span> <span class="o">=</span> <span class="n">Duration</span><span class="p">()</span>
<span class="c1"># If an absolute timestamp is provided, calculate the delta between</span>
<span class="c1"># the absoluted time and the time deferred_status() is called.</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span> <span class="o">-</span> <span class="n">Timestamp</span><span class="o">.</span><span class="n">now</span><span class="p">())</span>
<span class="c1"># If a Duration is provided, the deferred time should be:</span>
<span class="c1"># provided duration - the spent time since the defer_remainder() is</span>
<span class="c1"># called.</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span><span class="p">,</span> <span class="n">Duration</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span> <span class="o">-=</span> <span class="p">(</span><span class="n">Timestamp</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_timestamp</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_deferred_residual</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_deferred_timestamp</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="ThreadsafeRestrictionTracker.is_bounded"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.is_bounded">[docs]</a> <span class="k">def</span> <span class="nf">is_bounded</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_restriction_tracker</span><span class="o">.</span><span class="n">is_bounded</span><span class="p">()</span></div></div>
<div class="viewcode-block" id="RestrictionTrackerView"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.RestrictionTrackerView">[docs]</a><span class="k">class</span> <span class="nc">RestrictionTrackerView</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;A DoFn view of thread-safe RestrictionTracker.</span>
<span class="sd"> The RestrictionTrackerView wraps a ThreadsafeRestrictionTracker and only</span>
<span class="sd"> exposes APIs that will be called by a ``DoFn.process()``. During execution</span>
<span class="sd"> time, the RestrictionTrackerView will be fed into the ``DoFn.process`` as a</span>
<span class="sd"> restriction_tracker.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">threadsafe_restriction_tracker</span><span class="p">):</span>
<span class="c1"># type: (ThreadsafeRestrictionTracker) -&gt; None</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">threadsafe_restriction_tracker</span><span class="p">,</span>
<span class="n">ThreadsafeRestrictionTracker</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;Initialize RestrictionTrackerView requires &#39;</span>
<span class="s1">&#39;ThreadsafeRestrictionTracker.&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_threadsafe_restriction_tracker</span> <span class="o">=</span> <span class="n">threadsafe_restriction_tracker</span>
<div class="viewcode-block" id="RestrictionTrackerView.current_restriction"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.RestrictionTrackerView.current_restriction">[docs]</a> <span class="k">def</span> <span class="nf">current_restriction</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_threadsafe_restriction_tracker</span><span class="o">.</span><span class="n">current_restriction</span><span class="p">()</span></div>
<div class="viewcode-block" id="RestrictionTrackerView.try_claim"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.RestrictionTrackerView.try_claim">[docs]</a> <span class="k">def</span> <span class="nf">try_claim</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">position</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_threadsafe_restriction_tracker</span><span class="o">.</span><span class="n">try_claim</span><span class="p">(</span><span class="n">position</span><span class="p">)</span></div>
<div class="viewcode-block" id="RestrictionTrackerView.defer_remainder"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.RestrictionTrackerView.defer_remainder">[docs]</a> <span class="k">def</span> <span class="nf">defer_remainder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">deferred_time</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_threadsafe_restriction_tracker</span><span class="o">.</span><span class="n">defer_remainder</span><span class="p">(</span><span class="n">deferred_time</span><span class="p">)</span></div>
<div class="viewcode-block" id="RestrictionTrackerView.is_bounded"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.RestrictionTrackerView.is_bounded">[docs]</a> <span class="k">def</span> <span class="nf">is_bounded</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_threadsafe_restriction_tracker</span><span class="o">.</span><span class="n">is_bounded</span><span class="p">()</span></div></div>
<div class="viewcode-block" id="ThreadsafeWatermarkEstimator"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator">[docs]</a><span class="k">class</span> <span class="nc">ThreadsafeWatermarkEstimator</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;A threadsafe wrapper which wraps a WatermarkEstimator with locking</span>
<span class="sd"> mechanism to guarantee multi-thread safety.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">watermark_estimator</span><span class="p">):</span>
<span class="c1"># type: (WatermarkEstimator) -&gt; None</span>
<span class="kn">from</span> <span class="nn">apache_beam.io.iobase</span> <span class="kn">import</span> <span class="n">WatermarkEstimator</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">watermark_estimator</span><span class="p">,</span> <span class="n">WatermarkEstimator</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Initializing Threadsafe requires a WatermarkEstimator&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_watermark_estimator</span> <span class="o">=</span> <span class="n">watermark_estimator</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
<span class="k">def</span> <span class="fm">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_watermark_estimator</span><span class="p">,</span> <span class="n">attr</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">method_wrapper</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_watermark_estimator</span><span class="p">,</span> <span class="n">attr</span><span class="p">)(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
<span class="k">return</span> <span class="n">method_wrapper</span>
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="n">attr</span><span class="p">)</span>
<div class="viewcode-block" id="ThreadsafeWatermarkEstimator.get_estimator_state"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.get_estimator_state">[docs]</a> <span class="k">def</span> <span class="nf">get_estimator_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_watermark_estimator</span><span class="o">.</span><span class="n">get_estimator_state</span><span class="p">()</span></div>
<div class="viewcode-block" id="ThreadsafeWatermarkEstimator.current_watermark"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.current_watermark">[docs]</a> <span class="k">def</span> <span class="nf">current_watermark</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; Timestamp</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_watermark_estimator</span><span class="o">.</span><span class="n">current_watermark</span><span class="p">()</span></div>
<div class="viewcode-block" id="ThreadsafeWatermarkEstimator.observe_timestamp"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.observe_timestamp">[docs]</a> <span class="k">def</span> <span class="nf">observe_timestamp</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">):</span>
<span class="c1"># type: (Timestamp) -&gt; None</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">timestamp</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;Input of observe_timestamp should be a Timestamp &#39;</span>
<span class="s1">&#39;object&#39;</span><span class="p">)</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_watermark_estimator</span><span class="o">.</span><span class="n">observe_timestamp</span><span class="p">(</span><span class="n">timestamp</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="NoOpWatermarkEstimatorProvider"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider">[docs]</a><span class="k">class</span> <span class="nc">NoOpWatermarkEstimatorProvider</span><span class="p">(</span><span class="n">WatermarkEstimatorProvider</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;A WatermarkEstimatorProvider which creates NoOpWatermarkEstimator for the</span>
<span class="sd"> framework.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="NoOpWatermarkEstimatorProvider.initial_estimator_state"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.initial_estimator_state">[docs]</a> <span class="k">def</span> <span class="nf">initial_estimator_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="n">restriction</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="NoOpWatermarkEstimatorProvider.create_watermark_estimator"><a class="viewcode-back" href="../../../apache_beam.runners.sdf_utils.html#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.create_watermark_estimator">[docs]</a> <span class="k">def</span> <span class="nf">create_watermark_estimator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">estimator_state</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">apache_beam.io.iobase</span> <span class="kn">import</span> <span class="n">WatermarkEstimator</span>
<span class="k">class</span> <span class="nc">_NoOpWatermarkEstimator</span><span class="p">(</span><span class="n">WatermarkEstimator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;A No-op WatermarkEstimator which is provided for the framework if there</span>
<span class="sd"> is no custom one.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">observe_timestamp</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">def</span> <span class="nf">current_watermark</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">get_estimator_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">_NoOpWatermarkEstimator</span><span class="p">()</span></div></div>
</pre></div>
</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/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>