pydoc/2.15.0/_modules/apache_beam/io/restriction_trackers.html - beam-site - Git at Google



 <!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  documentation</title>


     <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />


         <link rel="index" title="Index"
               href="../../../genindex.html"/>
         <link rel="search" title="Search" href="../../../search.html"/>
     <link rel="top" title="Apache Beam  documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/>


   <script src="../../../_static/js/modernizr.min.js"></script>

 </head>

 <body class="wy-body-for-nav" role="document">


   <div class="wy-grid-for-nav">


     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search">


             <a href="../../../index.html" class="icon icon-home"> Apache Beam


           </a>


 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.internal.html">apache_beam.internal package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.tools.html">apache_beam.tools package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.utils.html">apache_beam.utils package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.version.html">apache_beam.version module</a></li>
 </ul>


         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">

           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../../../index.html">Apache Beam</a>

       </nav>


       <div class="wy-nav-content">
         <div class="rst-content">


 <div role="navigation" aria-label="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="../../../index.html">Docs</a> &raquo;</li>

           <li><a href="../../index.html">Module code</a> &raquo;</li>

       <li>apache_beam.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="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">division</span>

 <span class="kn">import</span> <span class="nn">threading</span>
 <span class="kn">from</span> <span class="nn">builtins</span> <span class="k">import</span> <span class="nb">object</span>

 <span class="kn">from</span> <span class="nn">apache_beam.io.iobase</span> <span class="k">import</span> <span class="n">RestrictionProgress</span>
 <span class="kn">from</span> <span class="nn">apache_beam.io.iobase</span> <span class="k">import</span> <span class="n">RestrictionTracker</span>
 <span class="kn">from</span> <span class="nn">apache_beam.io.range_trackers</span> <span class="k">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="nf">__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="nf">__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="nf">__ne__</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="c1"># TODO(BEAM-5949): Needed for Python 2 compatibility.</span>
     <span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span> <span class="o">==</span> <span class="n">other</span>

   <span class="k">def</span> <span class="nf">__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>

 <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.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>


 <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 a pair of integers</span>
 <span class="sd">  [start_position, stop_position}.</span>
 <span class="sd">  &quot;&quot;&quot;</span>

   <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start_position</span><span class="p">,</span> <span class="n">stop_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">OffsetRange</span><span class="p">(</span><span class="n">start_position</span><span class="p">,</span> <span class="n">stop_position</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="kc">None</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_current_watermark</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">_deferred_residual</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>
     <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>

 <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">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</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="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">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="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></div>

 <div class="viewcode-block" id="OffsetRestrictionTracker.current_watermark"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.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="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current_watermark</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="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</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">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">_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">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">_range</span><span class="o">.</span><span class="n">stop</span></div>

 <div class="viewcode-block" id="OffsetRestrictionTracker.default_size"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.default_size">[docs]</a>  <span class="k">def</span> <span class="nf">default_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">_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></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">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</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">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="n">position</span> <span class="o">&gt;=</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="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">_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">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</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">_current_position</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">_current_position</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="n">prev_stop</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">stop</span><span class="p">,</span> <span class="n">split_point</span>
           <span class="k">return</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="n">split_point</span><span class="p">),</span> <span class="p">(</span><span class="n">split_point</span><span class="p">,</span> <span class="n">prev_stop</span><span class="p">)</span></div>

   <span class="c1"># TODO(SDF): Replace all calls with try_claim(0).</span>
 <div class="viewcode-block" id="OffsetRestrictionTracker.checkpoint"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.checkpoint">[docs]</a>  <span class="k">def</span> <span class="nf">checkpoint</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="c1"># If self._current_position is &#39;None&#39; no records have been claimed so</span>
       <span class="c1"># residual should start from self._range.start.</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">end_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="k">else</span><span class="p">:</span>
         <span class="n">end_position</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current_position</span> <span class="o">+</span> <span class="mi">1</span>

       <span class="n">residual_range</span> <span class="o">=</span> <span class="p">(</span><span class="n">end_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">stop</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">OffsetRange</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="n">end_position</span><span class="p">)</span>
       <span class="k">return</span> <span class="n">residual_range</span></div>

 <div class="viewcode-block" id="OffsetRestrictionTracker.defer_remainder"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.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">watermark</span><span class="o">=</span><span class="kc">None</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">_deferred_watermark</span> <span class="o">=</span> <span class="n">watermark</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current_watermark</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_deferred_residual</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">checkpoint</span><span class="p">()</span></div>

 <div class="viewcode-block" id="OffsetRestrictionTracker.deferred_status"><a class="viewcode-back" href="../../../apache_beam.io.restriction_trackers.html#apache_beam.io.restriction_trackers.OffsetRestrictionTracker.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="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_deferred_residual</span><span class="p">:</span>
       <span class="k">return</span> <span class="p">(</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_watermark</span><span class="p">)</span></div></div>
 </pre></div>

            </div>
            <div class="articleComments">

            </div>
           </div>
           <footer>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright .

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
             VERSION:'',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true,
             SOURCELINK_SUFFIX: '.txt'
         };
     </script>
       <script type="text/javascript" src="../../../_static/jquery.js"></script>
       <script type="text/javascript" src="../../../_static/underscore.js"></script>
       <script type="text/javascript" src="../../../_static/doctools.js"></script>


     <script type="text/javascript" src="../../../_static/js/theme.js"></script>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>


 </body>
 </html>