| |
| |
| <!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.range_trackers — Apache Beam 2.47.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.47.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.testing.html">apache_beam.testing package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.typehints.html">apache_beam.typehints package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.utils.html">apache_beam.utils package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.yaml.html">apache_beam.yaml package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="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> »</li> |
| |
| <li><a href="../../index.html">Module code</a> »</li> |
| |
| <li>apache_beam.io.range_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.range_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 "License"); 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 "AS IS" 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">"""iobase.RangeTracker implementations provided with Apache Beam.</span> |
| <span class="sd">"""</span> |
| <span class="c1"># pytype: skip-file</span> |
| |
| <span class="kn">import</span> <span class="nn">codecs</span> |
| <span class="kn">import</span> <span class="nn">logging</span> |
| <span class="kn">import</span> <span class="nn">math</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">Union</span> |
| |
| <span class="kn">from</span> <span class="nn">apache_beam.io</span> <span class="kn">import</span> <span class="n">iobase</span> |
| |
| <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="s1">'OffsetRangeTracker'</span><span class="p">,</span> |
| <span class="s1">'LexicographicKeyRangeTracker'</span><span class="p">,</span> |
| <span class="s1">'OrderedPositionRangeTracker'</span><span class="p">,</span> |
| <span class="s1">'UnsplittableRangeTracker'</span> |
| <span class="p">]</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> |
| |
| |
| <div class="viewcode-block" id="OffsetRangeTracker"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker">[docs]</a><span class="k">class</span> <span class="nc">OffsetRangeTracker</span><span class="p">(</span><span class="n">iobase</span><span class="o">.</span><span class="n">RangeTracker</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A 'RangeTracker' for non-negative positions of type 'long'."""</span> |
| |
| <span class="c1"># Offset corresponding to infinity. This can only be used as the upper-bound</span> |
| <span class="c1"># of a range, and indicates reading all of the records until the end without</span> |
| <span class="c1"># specifying exactly what the end is.</span> |
| <span class="c1"># Infinite ranges cannot be split because it is impossible to estimate</span> |
| <span class="c1"># progress within them.</span> |
| <span class="n">OFFSET_INFINITY</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="s1">'inf'</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">end</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="n">start</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Start offset must not be </span><span class="se">\'</span><span class="s1">None</span><span class="se">\'</span><span class="s1">'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">end</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'End offset must not be </span><span class="se">\'</span><span class="s1">None</span><span class="se">\'</span><span class="s1">'</span><span class="p">)</span> |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">end</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">OFFSET_INFINITY</span><span class="p">:</span> |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">end</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span> |
| |
| <span class="k">assert</span> <span class="n">start</span> <span class="o"><=</span> <span class="n">end</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_start_offset</span> <span class="o">=</span> <span class="n">start</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_stop_offset</span> <span class="o">=</span> <span class="n">end</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_last_record_start</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_last_attempted_record_start</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_offset_of_last_split_point</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</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="bp">self</span><span class="o">.</span><span class="n">_split_points_seen</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_split_points_unclaimed_callback</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.start_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.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">_start_offset</span></div> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.stop_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.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">_stop_offset</span></div> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">last_record_start</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">_last_record_start</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">last_attempted_record_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Return current value of last_attempted_record_start.</span> |
| |
| <span class="sd"> last_attempted_record_start records a valid position that tried to be</span> |
| <span class="sd"> claimed by calling try_claim(). This value is only updated by `try_claim()`</span> |
| <span class="sd"> no matter `try_claim()` returns `True` or `False`.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_attempted_record_start</span> |
| |
| <span class="k">def</span> <span class="nf">_validate_record_start</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record_start</span><span class="p">,</span> <span class="n">split_point</span><span class="p">):</span> |
| <span class="c1"># This function must only be called under the lock self.lock.</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="o">.</span><span class="n">locked</span><span class="p">():</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'This function must only be called under the lock self.lock.'</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">record_start</span> <span class="o"><</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_record_start</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'Trying to return a record [starting at </span><span class="si">%d</span><span class="s1">] which is before the '</span> |
| <span class="s1">'last-returned record [starting at </span><span class="si">%d</span><span class="s1">]'</span> <span class="o">%</span> |
| <span class="p">(</span><span class="n">record_start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_record_start</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="p">(</span><span class="n">split_point</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_offset_of_last_split_point</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">1</span> <span class="ow">and</span> |
| <span class="n">record_start</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_offset_of_last_split_point</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'Record at a split point has same offset as the previous split '</span> |
| <span class="s1">'point: </span><span class="si">%d</span><span class="s1">'</span> <span class="o">%</span> <span class="n">record_start</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">split_point</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_record_start</span> <span class="o">==</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">'The first record [starting at </span><span class="si">%d</span><span class="s1">] must be at a split point'</span> <span class="o">%</span> |
| <span class="n">record_start</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.try_claim"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.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">record_start</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"># Attempted claim should be monotonous.</span> |
| <span class="k">if</span> <span class="n">record_start</span> <span class="o"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_attempted_record_start</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'Trying to return a record [starting at </span><span class="si">%d</span><span class="s1">] which is not greater'</span> |
| <span class="s1">'than the last-attempted record [starting at </span><span class="si">%d</span><span class="s1">]'</span> <span class="o">%</span> |
| <span class="p">(</span><span class="n">record_start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_attempted_record_start</span><span class="p">))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_record_start</span><span class="p">(</span><span class="n">record_start</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_last_attempted_record_start</span> <span class="o">=</span> <span class="n">record_start</span> |
| <span class="k">if</span> <span class="n">record_start</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop_position</span><span class="p">():</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_offset_of_last_split_point</span> <span class="o">=</span> <span class="n">record_start</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_last_record_start</span> <span class="o">=</span> <span class="n">record_start</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_split_points_seen</span> <span class="o">+=</span> <span class="mi">1</span> |
| <span class="k">return</span> <span class="kc">True</span></div> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.set_current_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.set_current_position">[docs]</a> <span class="k">def</span> <span class="nf">set_current_position</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record_start</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">_validate_record_start</span><span class="p">(</span><span class="n">record_start</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_last_record_start</span> <span class="o">=</span> <span class="n">record_start</span></div> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.try_split"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.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">split_offset</span><span class="p">):</span> |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">split_offset</span><span class="p">,</span> <span class="nb">int</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">_stop_offset</span> <span class="o">==</span> <span class="n">OffsetRangeTracker</span><span class="o">.</span><span class="n">OFFSET_INFINITY</span><span class="p">:</span> |
| <span class="n">_LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span> |
| <span class="s1">'refusing to split </span><span class="si">%r</span><span class="s1"> at </span><span class="si">%d</span><span class="s1">: stop position unspecified'</span><span class="p">,</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">split_offset</span><span class="p">)</span> |
| <span class="k">return</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_record_start</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> |
| <span class="n">_LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span> |
| <span class="s1">'Refusing to split </span><span class="si">%r</span><span class="s1"> at </span><span class="si">%d</span><span class="s1">: unstarted'</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="n">split_offset</span><span class="p">)</span> |
| <span class="k">return</span> |
| |
| <span class="k">if</span> <span class="n">split_offset</span> <span class="o"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_record_start</span><span class="p">:</span> |
| <span class="n">_LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span> |
| <span class="s1">'Refusing to split </span><span class="si">%r</span><span class="s1"> at </span><span class="si">%d</span><span class="s1">: already past proposed stop offset'</span><span class="p">,</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">split_offset</span><span class="p">)</span> |
| <span class="k">return</span> |
| <span class="k">if</span> <span class="p">(</span><span class="n">split_offset</span> <span class="o"><</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_position</span><span class="p">()</span> <span class="ow">or</span> |
| <span class="n">split_offset</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop_position</span><span class="p">()):</span> |
| <span class="n">_LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span> |
| <span class="s1">'Refusing to split </span><span class="si">%r</span><span class="s1"> at </span><span class="si">%d</span><span class="s1">: proposed split position out of range'</span><span class="p">,</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">split_offset</span><span class="p">)</span> |
| <span class="k">return</span> |
| |
| <span class="n">_LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'Agreeing to split </span><span class="si">%r</span><span class="s1"> at </span><span class="si">%d</span><span class="s1">'</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="n">split_offset</span><span class="p">)</span> |
| |
| <span class="n">split_fraction</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="nb">float</span><span class="p">(</span><span class="n">split_offset</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_offset</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">_stop_offset</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_offset</span><span class="p">))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_stop_offset</span> <span class="o">=</span> <span class="n">split_offset</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stop_offset</span><span class="p">,</span> <span class="n">split_fraction</span></div> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.fraction_consumed"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.fraction_consumed">[docs]</a> <span class="k">def</span> <span class="nf">fraction_consumed</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"># self.last_record_start may become larger than self.end_offset when</span> |
| <span class="c1"># reading the records since any record that starts before the first 'split</span> |
| <span class="c1"># point' at or after the defined 'stop offset' is considered to be within</span> |
| <span class="c1"># the range of the OffsetRangeTracker. Hence fraction could be > 1.</span> |
| <span class="c1"># self.last_record_start is initialized to -1, hence fraction may be < 0.</span> |
| <span class="c1"># Bounding the to range [0, 1].</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">position_to_fraction</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_last_record_start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_position</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop_position</span><span class="p">())</span></div> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.position_to_fraction"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.position_to_fraction">[docs]</a> <span class="k">def</span> <span class="nf">position_to_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pos</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="n">fraction</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="o">*</span> <span class="p">(</span><span class="n">pos</span> <span class="o">-</span> <span class="n">start</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">stop</span> <span class="o">-</span> <span class="n">start</span><span class="p">)</span> <span class="k">if</span> <span class="n">start</span> <span class="o">!=</span> <span class="n">stop</span> <span class="k">else</span> <span class="mf">0.0</span> |
| <span class="k">return</span> <span class="nb">max</span><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="nb">min</span><span class="p">(</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">fraction</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.position_at_fraction"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.position_at_fraction">[docs]</a> <span class="k">def</span> <span class="nf">position_at_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fraction</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop_position</span><span class="p">()</span> <span class="o">==</span> <span class="n">OffsetRangeTracker</span><span class="o">.</span><span class="n">OFFSET_INFINITY</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span> |
| <span class="s1">'get_position_for_fraction_consumed is not applicable for an '</span> |
| <span class="s1">'unbounded range'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="nb">int</span><span class="p">(</span> |
| <span class="n">math</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">start_position</span><span class="p">()</span> <span class="o">+</span> <span class="n">fraction</span> <span class="o">*</span> |
| <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stop_position</span><span class="p">()</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_position</span><span class="p">())))</span></div> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.split_points"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.split_points">[docs]</a> <span class="k">def</span> <span class="nf">split_points</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="n">split_points_consumed</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="mi">0</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_split_points_seen</span> <span class="o">==</span> <span class="mi">0</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">_split_points_seen</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> |
| <span class="n">split_points_unclaimed</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_split_points_unclaimed_callback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stop_position</span><span class="p">())</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_split_points_unclaimed_callback</span> <span class="k">else</span> |
| <span class="n">iobase</span><span class="o">.</span><span class="n">RangeTracker</span><span class="o">.</span><span class="n">SPLIT_POINTS_UNKNOWN</span><span class="p">)</span> |
| <span class="n">split_points_remaining</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="n">iobase</span><span class="o">.</span><span class="n">RangeTracker</span><span class="o">.</span><span class="n">SPLIT_POINTS_UNKNOWN</span> |
| <span class="k">if</span> <span class="n">split_points_unclaimed</span> <span class="o">==</span> <span class="n">iobase</span><span class="o">.</span><span class="n">RangeTracker</span><span class="o">.</span><span class="n">SPLIT_POINTS_UNKNOWN</span> |
| <span class="k">else</span> <span class="p">(</span><span class="n">split_points_unclaimed</span> <span class="o">+</span> <span class="mi">1</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="p">(</span><span class="n">split_points_consumed</span><span class="p">,</span> <span class="n">split_points_remaining</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="OffsetRangeTracker.set_split_points_unclaimed_callback"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OffsetRangeTracker.set_split_points_unclaimed_callback">[docs]</a> <span class="k">def</span> <span class="nf">set_split_points_unclaimed_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_split_points_unclaimed_callback</span> <span class="o">=</span> <span class="n">callback</span></div></div> |
| |
| |
| <div class="viewcode-block" id="OrderedPositionRangeTracker"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OrderedPositionRangeTracker">[docs]</a><span class="k">class</span> <span class="nc">OrderedPositionRangeTracker</span><span class="p">(</span><span class="n">iobase</span><span class="o">.</span><span class="n">RangeTracker</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> An abstract base class for range trackers whose positions are comparable.</span> |
| |
| <span class="sd"> Subclasses only need to implement the mapping from position ranges</span> |
| <span class="sd"> to and from the closed interval [0, 1].</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">UNSTARTED</span> <span class="o">=</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_position</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">stop_position</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">_start_position</span> <span class="o">=</span> <span class="n">start_position</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_stop_position</span> <span class="o">=</span> <span class="n">stop_position</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="bp">self</span><span class="o">.</span><span class="n">_last_claim</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">UNSTARTED</span> |
| |
| <div class="viewcode-block" id="OrderedPositionRangeTracker.start_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OrderedPositionRangeTracker.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">_start_position</span></div> |
| |
| <div class="viewcode-block" id="OrderedPositionRangeTracker.stop_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OrderedPositionRangeTracker.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">_stop_position</span></div> |
| |
| <div class="viewcode-block" id="OrderedPositionRangeTracker.try_claim"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OrderedPositionRangeTracker.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</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">UNSTARTED</span> <span class="ow">and</span> <span class="n">position</span> <span class="o"><</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s2">"Positions must be claimed in order: "</span> |
| <span class="s2">"claim '</span><span class="si">%s</span><span class="s2">' attempted after claim '</span><span class="si">%s</span><span class="s2">'"</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</span><span class="p">))</span> |
| <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_position</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"><</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_position</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s2">"Claim '</span><span class="si">%s</span><span class="s2">' is before start '</span><span class="si">%s</span><span class="s2">'"</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">_start_position</span><span class="p">))</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stop_position</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">position</span> <span class="o"><</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stop_position</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim</span> <span class="o">=</span> <span class="n">position</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">False</span></div> |
| |
| <div class="viewcode-block" id="OrderedPositionRangeTracker.position_at_fraction"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OrderedPositionRangeTracker.position_at_fraction">[docs]</a> <span class="k">def</span> <span class="nf">position_at_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fraction</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">fraction_to_position</span><span class="p">(</span> |
| <span class="n">fraction</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_position</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stop_position</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="OrderedPositionRangeTracker.try_split"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OrderedPositionRangeTracker.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">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="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">_stop_position</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">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stop_position</span><span class="p">)</span> |
| <span class="ow">or</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_start_position</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"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_position</span><span class="p">)):</span> |
| <span class="n">_LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span> |
| <span class="s1">'Refusing to split </span><span class="si">%r</span><span class="s1"> at </span><span class="si">%d</span><span class="s1">: proposed split position out of range'</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="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim</span> <span class="ow">is</span> <span class="bp">self</span><span class="o">.</span><span class="n">UNSTARTED</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim</span> <span class="o"><</span> <span class="n">position</span><span class="p">:</span> |
| <span class="n">fraction</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">position_to_fraction</span><span class="p">(</span> |
| <span class="n">position</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_start_position</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_stop_position</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_stop_position</span> <span class="o">=</span> <span class="n">position</span> |
| <span class="k">return</span> <span class="n">position</span><span class="p">,</span> <span class="n">fraction</span></div> |
| |
| <div class="viewcode-block" id="OrderedPositionRangeTracker.fraction_consumed"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OrderedPositionRangeTracker.fraction_consumed">[docs]</a> <span class="k">def</span> <span class="nf">fraction_consumed</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">_last_claim</span> <span class="ow">is</span> <span class="bp">self</span><span class="o">.</span><span class="n">UNSTARTED</span><span class="p">:</span> |
| <span class="k">return</span> <span class="mi">0</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">position_to_fraction</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_last_claim</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_position</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stop_position</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="OrderedPositionRangeTracker.fraction_to_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OrderedPositionRangeTracker.fraction_to_position">[docs]</a> <span class="k">def</span> <span class="nf">fraction_to_position</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fraction</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Converts a fraction between 0 and 1 to a position between start and end.</span> |
| <span class="sd"> """</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span></div> |
| |
| <div class="viewcode-block" id="OrderedPositionRangeTracker.position_to_fraction"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.OrderedPositionRangeTracker.position_to_fraction">[docs]</a> <span class="k">def</span> <span class="nf">position_to_fraction</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="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Returns the fraction of keys in the range [start, end) that</span> |
| <span class="sd"> are less than the given key.</span> |
| <span class="sd"> """</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span></div></div> |
| |
| |
| <div class="viewcode-block" id="UnsplittableRangeTracker"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker">[docs]</a><span class="k">class</span> <span class="nc">UnsplittableRangeTracker</span><span class="p">(</span><span class="n">iobase</span><span class="o">.</span><span class="n">RangeTracker</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A RangeTracker that always ignores split requests.</span> |
| |
| <span class="sd"> This can be used to make a given</span> |
| <span class="sd"> :class:`~apache_beam.io.iobase.RangeTracker` object unsplittable by</span> |
| <span class="sd"> ignoring all calls to :meth:`.try_split()`. All other calls will be delegated</span> |
| <span class="sd"> to the given :class:`~apache_beam.io.iobase.RangeTracker`.</span> |
| <span class="sd"> """</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">range_tracker</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Initializes UnsplittableRangeTracker.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> range_tracker (~apache_beam.io.iobase.RangeTracker): a</span> |
| <span class="sd"> :class:`~apache_beam.io.iobase.RangeTracker` to which all method</span> |
| <span class="sd"> calls expect calls to :meth:`.try_split()` will be delegated.</span> |
| <span class="sd"> """</span> |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">range_tracker</span><span class="p">,</span> <span class="n">iobase</span><span class="o">.</span><span class="n">RangeTracker</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_range_tracker</span> <span class="o">=</span> <span class="n">range_tracker</span> |
| |
| <div class="viewcode-block" id="UnsplittableRangeTracker.start_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker.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_tracker</span><span class="o">.</span><span class="n">start_position</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="UnsplittableRangeTracker.stop_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker.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_tracker</span><span class="o">.</span><span class="n">stop_position</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="UnsplittableRangeTracker.position_at_fraction"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker.position_at_fraction">[docs]</a> <span class="k">def</span> <span class="nf">position_at_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fraction</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range_tracker</span><span class="o">.</span><span class="n">position_at_fraction</span><span class="p">(</span><span class="n">fraction</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="UnsplittableRangeTracker.try_claim"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker.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">_range_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="UnsplittableRangeTracker.try_split"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker.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">position</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">None</span></div> |
| |
| <div class="viewcode-block" id="UnsplittableRangeTracker.set_current_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker.set_current_position">[docs]</a> <span class="k">def</span> <span class="nf">set_current_position</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="bp">self</span><span class="o">.</span><span class="n">_range_tracker</span><span class="o">.</span><span class="n">set_current_position</span><span class="p">(</span><span class="n">position</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="UnsplittableRangeTracker.fraction_consumed"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker.fraction_consumed">[docs]</a> <span class="k">def</span> <span class="nf">fraction_consumed</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_tracker</span><span class="o">.</span><span class="n">fraction_consumed</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="UnsplittableRangeTracker.split_points"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker.split_points">[docs]</a> <span class="k">def</span> <span class="nf">split_points</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># An unsplittable range only contains a single split point.</span> |
| <span class="k">return</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="UnsplittableRangeTracker.set_split_points_unclaimed_callback"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.UnsplittableRangeTracker.set_split_points_unclaimed_callback">[docs]</a> <span class="k">def</span> <span class="nf">set_split_points_unclaimed_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_range_tracker</span><span class="o">.</span><span class="n">set_split_points_unclaimed_callback</span><span class="p">(</span><span class="n">callback</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="LexicographicKeyRangeTracker"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.LexicographicKeyRangeTracker">[docs]</a><span class="k">class</span> <span class="nc">LexicographicKeyRangeTracker</span><span class="p">(</span><span class="n">OrderedPositionRangeTracker</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""A range tracker that tracks progress through a lexicographically</span> |
| <span class="sd"> ordered keyspace of strings.</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="LexicographicKeyRangeTracker.fraction_to_position"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.LexicographicKeyRangeTracker.fraction_to_position">[docs]</a> <span class="nd">@classmethod</span> |
| <span class="k">def</span> <span class="nf">fraction_to_position</span><span class="p">(</span> |
| <span class="bp">cls</span><span class="p">,</span> |
| <span class="n">fraction</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> |
| <span class="n">start</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="n">end</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span> |
| <span class="w"> </span><span class="sd">"""Linearly interpolates a key that is lexicographically</span> |
| <span class="sd"> fraction of the way between start and end.</span> |
| <span class="sd"> """</span> |
| <span class="k">assert</span> <span class="mi">0</span> <span class="o"><=</span> <span class="n">fraction</span> <span class="o"><=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">fraction</span> |
| |
| <span class="k">if</span> <span class="n">start</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">start</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> |
| |
| <span class="k">if</span> <span class="n">fraction</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">start</span> |
| |
| <span class="k">if</span> <span class="n">fraction</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">end</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">end</span><span class="p">:</span> |
| <span class="n">common_prefix_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">start</span><span class="p">)</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">start</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\xFF</span><span class="s1">'</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">for</span> <span class="n">ix</span><span class="p">,</span> <span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">)):</span> |
| <span class="k">if</span> <span class="n">s</span> <span class="o">!=</span> <span class="n">e</span><span class="p">:</span> |
| <span class="n">common_prefix_len</span> <span class="o">=</span> <span class="n">ix</span> |
| <span class="k">break</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">common_prefix_len</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">start</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">end</span><span class="p">))</span> |
| |
| <span class="c1"># Convert the relative precision of fraction (~53 bits) to an absolute</span> |
| <span class="c1"># precision needed to represent values between start and end distinctly.</span> |
| <span class="n">prec</span> <span class="o">=</span> <span class="n">common_prefix_len</span> <span class="o">+</span> <span class="nb">int</span><span class="p">(</span><span class="o">-</span><span class="n">math</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">fraction</span><span class="p">,</span> <span class="mi">256</span><span class="p">))</span> <span class="o">+</span> <span class="mi">7</span> |
| <span class="n">istart</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_bytestring_to_int</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">prec</span><span class="p">)</span> |
| <span class="n">iend</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_bytestring_to_int</span><span class="p">(</span><span class="n">end</span><span class="p">,</span> <span class="n">prec</span><span class="p">)</span> <span class="k">if</span> <span class="n">end</span> <span class="k">else</span> <span class="mi">1</span> <span class="o"><<</span> <span class="p">(</span><span class="n">prec</span> <span class="o">*</span> <span class="mi">8</span><span class="p">)</span> |
| <span class="n">ikey</span> <span class="o">=</span> <span class="n">istart</span> <span class="o">+</span> <span class="nb">int</span><span class="p">((</span><span class="n">iend</span> <span class="o">-</span> <span class="n">istart</span><span class="p">)</span> <span class="o">*</span> <span class="n">fraction</span><span class="p">)</span> |
| |
| <span class="c1"># Could be equal due to rounding.</span> |
| <span class="c1"># Adjust to ensure we never return the actual start and end</span> |
| <span class="c1"># unless fraction is exatly 0 or 1.</span> |
| <span class="k">if</span> <span class="n">ikey</span> <span class="o">==</span> <span class="n">istart</span><span class="p">:</span> |
| <span class="n">ikey</span> <span class="o">+=</span> <span class="mi">1</span> |
| <span class="k">elif</span> <span class="n">ikey</span> <span class="o">==</span> <span class="n">iend</span><span class="p">:</span> |
| <span class="n">ikey</span> <span class="o">-=</span> <span class="mi">1</span> |
| |
| <span class="n">position</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_bytestring_from_int</span><span class="p">(</span><span class="n">ikey</span><span class="p">,</span> <span class="n">prec</span><span class="p">)</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">position</span> |
| |
| <span class="k">return</span> <span class="n">position</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">encoding</span><span class="o">=</span><span class="s1">'unicode_escape'</span><span class="p">,</span> <span class="n">errors</span><span class="o">=</span><span class="s1">'replace'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="LexicographicKeyRangeTracker.position_to_fraction"><a class="viewcode-back" href="../../../apache_beam.io.range_trackers.html#apache_beam.io.range_trackers.LexicographicKeyRangeTracker.position_to_fraction">[docs]</a> <span class="nd">@classmethod</span> |
| <span class="k">def</span> <span class="nf">position_to_fraction</span><span class="p">(</span> |
| <span class="bp">cls</span><span class="p">,</span> |
| <span class="n">key</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="n">start</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="n">end</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="nb">float</span><span class="p">:</span> |
| <span class="w"> </span><span class="sd">"""Returns the fraction of keys in the range [start, end) that</span> |
| <span class="sd"> are less than the given key.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">key</span><span class="p">:</span> |
| <span class="k">return</span> <span class="mi">0</span> |
| |
| <span class="k">if</span> <span class="n">start</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">start</span> <span class="o">=</span> <span class="s1">''</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="sa">b</span><span class="s1">''</span> |
| |
| <span class="n">prec</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">start</span><span class="p">)</span> <span class="o">+</span> <span class="mi">7</span> |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">start</span><span class="p">):</span> |
| <span class="c1"># Higher absolute precision needed for very small values of fixed</span> |
| <span class="c1"># relative position.</span> |
| <span class="n">trailing_symbol</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> |
| <span class="n">prec</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span> |
| <span class="n">prec</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">key</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">start</span><span class="p">):]</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="n">trailing_symbol</span><span class="p">))</span> <span class="o">+</span> <span class="mi">7</span><span class="p">)</span> |
| <span class="n">istart</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_bytestring_to_int</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">prec</span><span class="p">)</span> |
| <span class="n">ikey</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_bytestring_to_int</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">prec</span><span class="p">)</span> |
| <span class="n">iend</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_bytestring_to_int</span><span class="p">(</span><span class="n">end</span><span class="p">,</span> <span class="n">prec</span><span class="p">)</span> <span class="k">if</span> <span class="n">end</span> <span class="k">else</span> <span class="mi">1</span> <span class="o"><<</span> <span class="p">(</span><span class="n">prec</span> <span class="o">*</span> <span class="mi">8</span><span class="p">)</span> |
| <span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">ikey</span> <span class="o">-</span> <span class="n">istart</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">iend</span> <span class="o">-</span> <span class="n">istart</span><span class="p">)</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">_bytestring_to_int</span><span class="p">(</span><span class="n">s</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="n">prec</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> |
| <span class="w"> </span><span class="sd">"""Returns int(256**prec * f) where f is the fraction</span> |
| <span class="sd"> represented by interpreting '.' + s as a base-256</span> |
| <span class="sd"> floating point number.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">s</span><span class="p">:</span> |
| <span class="k">return</span> <span class="mi">0</span> |
| |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span> |
| <span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">encode</span><span class="p">()</span> <span class="c1"># str -> bytes</span> |
| |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o"><</span> <span class="n">prec</span><span class="p">:</span> |
| <span class="n">s</span> <span class="o">+=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> <span class="o">*</span> <span class="p">(</span><span class="n">prec</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="p">[:</span><span class="n">prec</span><span class="p">]</span> |
| |
| <span class="n">h</span> <span class="o">=</span> <span class="n">codecs</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">'hex'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">h</span><span class="p">,</span> <span class="n">base</span><span class="o">=</span><span class="mi">16</span><span class="p">)</span> |
| |
| <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">_bytestring_from_int</span><span class="p">(</span><span class="n">i</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">prec</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bytes</span><span class="p">:</span> |
| <span class="w"> </span><span class="sd">"""Inverse of _bytestring_to_int."""</span> |
| <span class="n">h</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%x</span><span class="s1">'</span> <span class="o">%</span> <span class="n">i</span> |
| <span class="k">return</span> <span class="n">codecs</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'0'</span> <span class="o">*</span> <span class="p">(</span><span class="mi">2</span> <span class="o">*</span> <span class="n">prec</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">h</span><span class="p">))</span> <span class="o">+</span> <span class="n">h</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">'hex'</span><span class="p">)</span></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |