blob: f7a5d14e61deaea433d5b2d7ea5df4288b21cf40 [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.io.restriction_trackers &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.io.restriction_trackers</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.io.restriction_trackers</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="sd">&quot;&quot;&quot;`iobase.RestrictionTracker` implementations provided with Apache Beam.&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</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">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.range_trackers</span> <span class="kn">import</span> <span class="n">OffsetRangeTracker</span>
<div class="viewcode-block" id="OffsetRange"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRange">[docs]</a><span class="k">class</span> <span class="nc">OffsetRange</span><span class="p">(</span><span class="nb">object</span><span class="p">):</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">start</span><span class="p">,</span> <span class="n">stop</span><span class="p">):</span>
<span class="k">if</span> <span class="n">start</span> <span class="o">&gt;</span> <span class="n">stop</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;Start offset must be not be larger than the stop offset. &#39;</span>
<span class="s1">&#39;Received </span><span class="si">%d</span><span class="s1"> and </span><span class="si">%d</span><span class="s1"> respectively.&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">stop</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">start</span> <span class="o">=</span> <span class="n">start</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stop</span> <span class="o">=</span> <span class="n">stop</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">OffsetRange</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">start</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">start</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">stop</span>
<span class="k">def</span> <span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">((</span><span class="nb">type</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">start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">))</span>
<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">&#39;OffsetRange(start=</span><span class="si">%s</span><span class="s1">, stop=</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">)</span>
<div class="viewcode-block" id="OffsetRange.split"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRange.split">[docs]</a> <span class="k">def</span> <span class="nf">split</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">desired_num_offsets_per_split</span><span class="p">,</span> <span class="n">min_num_offsets_per_split</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="n">current_split_start</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">start</span>
<span class="n">max_split_size</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span>
<span class="n">desired_num_offsets_per_split</span><span class="p">,</span> <span class="n">min_num_offsets_per_split</span><span class="p">)</span>
<span class="k">while</span> <span class="n">current_split_start</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">:</span>
<span class="n">current_split_stop</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">current_split_start</span> <span class="o">+</span> <span class="n">max_split_size</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">)</span>
<span class="n">remaining</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span> <span class="o">-</span> <span class="n">current_split_stop</span>
<span class="c1"># Avoiding a small split at the end.</span>
<span class="k">if</span> <span class="p">(</span><span class="n">remaining</span> <span class="o">&lt;</span> <span class="n">desired_num_offsets_per_split</span> <span class="o">//</span> <span class="mi">4</span> <span class="ow">or</span>
<span class="n">remaining</span> <span class="o">&lt;</span> <span class="n">min_num_offsets_per_split</span><span class="p">):</span>
<span class="n">current_split_stop</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span>
<span class="k">yield</span> <span class="n">OffsetRange</span><span class="p">(</span><span class="n">current_split_start</span><span class="p">,</span> <span class="n">current_split_stop</span><span class="p">)</span>
<span class="n">current_split_start</span> <span class="o">=</span> <span class="n">current_split_stop</span></div>
<div class="viewcode-block" id="OffsetRange.split_at"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRange.split_at">[docs]</a> <span class="k">def</span> <span class="nf">split_at</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">split_pos</span><span class="p">):</span>
<span class="c1"># type: (...) -&gt; Tuple[OffsetRange, OffsetRange]</span>
<span class="k">return</span> <span class="n">OffsetRange</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">,</span> <span class="n">split_pos</span><span class="p">),</span> <span class="n">OffsetRange</span><span class="p">(</span><span class="n">split_pos</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">)</span></div>
<div class="viewcode-block" id="OffsetRange.new_tracker"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRange.new_tracker">[docs]</a> <span class="k">def</span> <span class="nf">new_tracker</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">OffsetRangeTracker</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">)</span></div>
<div class="viewcode-block" id="OffsetRange.size"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRange.size">[docs]</a> <span class="k">def</span> <span class="nf">size</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">stop</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">start</span></div></div>
<div class="viewcode-block" id="OffsetRestrictionTracker"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker">[docs]</a><span class="k">class</span> <span class="nc">OffsetRestrictionTracker</span><span class="p">(</span><span class="n">RestrictionTracker</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;An `iobase.RestrictionTracker` implementations for an offset range.</span>
<span class="sd"> Offset range is represented as OffsetRange.</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">offset_range</span><span class="p">):</span>
<span class="c1"># type: (OffsetRange) -&gt; None</span>
<span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">offset_range</span><span class="p">,</span> <span class="n">OffsetRange</span><span class="p">),</span> <span class="n">offset_range</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_range</span> <span class="o">=</span> <span class="n">offset_range</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current_position</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_checkpointed</span> <span class="o">=</span> <span class="kc">False</span>
<div class="viewcode-block" id="OffsetRestrictionTracker.check_done"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.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">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">start</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">stop</span> <span class="ow">and</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">stop</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;OffsetRestrictionTracker is not done since work in range [</span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">) &#39;</span>
<span class="s1">&#39;has not been claimed.&#39;</span> <span class="o">%</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">start</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">stop</span><span class="p">))</span></div>
<div class="viewcode-block" id="OffsetRestrictionTracker.current_restriction"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.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">_range</span></div>
<div class="viewcode-block" id="OffsetRestrictionTracker.current_progress"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.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">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current_position</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">fraction</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">stop</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">start</span><span class="p">:</span>
<span class="c1"># If self._current_position is not None, we must be done.</span>
<span class="n">fraction</span> <span class="o">=</span> <span class="mf">1.0</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">fraction</span> <span class="o">=</span> <span class="p">(</span>
<span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_current_position</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">start</span><span class="p">)</span> <span class="o">/</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">stop</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">start</span><span class="p">))</span>
<span class="k">return</span> <span class="n">RestrictionProgress</span><span class="p">(</span><span class="n">fraction</span><span class="o">=</span><span class="n">fraction</span><span class="p">)</span></div>
<div class="viewcode-block" id="OffsetRestrictionTracker.start_position"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.start_position">[docs]</a> <span class="k">def</span> <span class="nf">start_position</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">_range</span><span class="o">.</span><span class="n">start</span></div>
<div class="viewcode-block" id="OffsetRestrictionTracker.stop_position"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.stop_position">[docs]</a> <span class="k">def</span> <span class="nf">stop_position</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">_range</span><span class="o">.</span><span class="n">stop</span></div>
<div class="viewcode-block" id="OffsetRestrictionTracker.try_claim"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.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">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span>
<span class="n">position</span> <span class="o">&lt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;Positions claimed should strictly increase. Trying to claim &#39;</span>
<span class="s1">&#39;position </span><span class="si">%d</span><span class="s1"> while last claim attempt was </span><span class="si">%d</span><span class="s1">.&#39;</span> <span class="o">%</span>
<span class="p">(</span><span class="n">position</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span> <span class="o">=</span> <span class="n">position</span>
<span class="k">if</span> <span class="n">position</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">start</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;Position to be claimed cannot be smaller than the start position &#39;</span>
<span class="s1">&#39;of the range. Tried to claim position </span><span class="si">%r</span><span class="s1"> for the range [</span><span class="si">%r</span><span class="s1">, </span><span class="si">%r</span><span class="s1">)&#39;</span> <span class="o">%</span>
<span class="p">(</span><span class="n">position</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">stop</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">start</span> <span class="o">&lt;=</span> <span class="n">position</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">stop</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current_position</span> <span class="o">=</span> <span class="n">position</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="OffsetRestrictionTracker.try_split"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.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">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_checkpointed</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">cur</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">start</span> <span class="o">-</span> <span class="mi">1</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">cur</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim_attempt</span>
<span class="n">split_point</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">cur</span> <span class="o">+</span> <span class="nb">int</span><span class="p">(</span><span class="nb">max</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">stop</span> <span class="o">-</span> <span class="n">cur</span><span class="p">)</span> <span class="o">*</span> <span class="n">fraction_of_remainder</span><span class="p">)))</span>
<span class="k">if</span> <span class="n">split_point</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">stop</span><span class="p">:</span>
<span class="k">if</span> <span class="n">fraction_of_remainder</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_checkpointed</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="p">,</span> <span class="n">residual_range</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="o">.</span><span class="n">split_at</span><span class="p">(</span><span class="n">split_point</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="p">,</span> <span class="n">residual_range</span></div>
<div class="viewcode-block" id="OffsetRestrictionTracker.is_bounded"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.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="kc">True</span></div></div>
<div class="viewcode-block" id="UnsplittableRestrictionTracker"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.UnsplittableRestrictionTracker">[docs]</a><span class="k">class</span> <span class="nc">UnsplittableRestrictionTracker</span><span class="p">(</span><span class="n">RestrictionTracker</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;An `iobase.RestrictionTracker` that wraps another but does not split.&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">underling_tracker</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_underling_tracker</span> <span class="o">=</span> <span class="n">underling_tracker</span>
<div class="viewcode-block" id="UnsplittableRestrictionTracker.try_split"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.UnsplittableRestrictionTracker.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">return</span> <span class="kc">False</span></div>
<span class="c1"># __getattribute__ is used rather than __getattr__ to override the</span>
<span class="c1"># stubs in the baseclass.</span>
<span class="k">def</span> <span class="fm">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">if</span> <span class="n">name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;try_split&#39;</span><span class="p">,</span> <span class="p">):</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__getattribute__</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">else</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">_underling_tracker</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></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>