Google Git
Sign in
apache / beam-site / 2124d9d3064f7803e25018ca63200f5af5857a1f / . / pydoc / 2.8.0 / _modules / apache_beam / io / gcp / datastore / v1 / util.html
blob: 0e020248c1e4f7cc99ddbf107040ef90ac5f065f [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.io.gcp.datastore.v1.util &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.gcp.datastore.v1.util</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.gcp.datastore.v1.util</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="c1"># Utility functions &amp; classes that are _not_ specific to the datastore client.</span>
<span class="c1">#</span>
<span class="c1"># For internal use only; no backwards-compatibility guarantees.</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">math</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">builtins</span> <span class="k">import</span> <span class="nb">range</span>
<div class="viewcode-block" id="MovingSum"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1.util.html#apache_beam.io.gcp.datastore.v1.util.MovingSum">[docs]</a><span class="k">class</span> <span class="nc">MovingSum</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Class that keeps track of a rolling window sum.</span>
<span class="sd"> For use in tracking recent performance of the connector.</span>
<span class="sd"> Intended to be similar to</span>
<span class="sd"> org.apache.beam.sdk.util.MovingFunction(..., Sum.ofLongs()), but for</span>
<span class="sd"> convenience we expose the count of entries as well so this doubles as a</span>
<span class="sd"> moving average tracker.</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">window_ms</span><span class="p">,</span> <span class="n">bucket_ms</span><span class="p">):</span>
<span class="k">if</span> <span class="n">window_ms</span> <span class="o">&lt;=</span> <span class="n">bucket_ms</span> <span class="ow">or</span> <span class="n">bucket_ms</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;window_ms &gt; bucket_ms &gt; 0 please&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_num_buckets</span> <span class="o">=</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="n">window_ms</span> <span class="o">/</span> <span class="n">bucket_ms</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_bucket_ms</span> <span class="o">=</span> <span class="n">bucket_ms</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_Reset</span><span class="p">(</span><span class="n">now</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># initialize the moving window members</span>
<span class="k">def</span> <span class="nf">_Reset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">now</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current_index</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1"># pointer into self._buckets</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current_ms_since_epoch</span> <span class="o">=</span> <span class="n">math</span><span class="o">.</span><span class="n">floor</span><span class="p">(</span>
<span class="n">now</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bucket_ms</span><span class="p">)</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bucket_ms</span>
<span class="c1"># _buckets is a list where each element is a list [sum, num_samples]</span>
<span class="c1"># This is a circular buffer where</span>
<span class="c1"># [_current_index] represents the time range</span>
<span class="c1"># [_current_ms_since_epoch, _current_ms_since_epoch+_bucket_ms)</span>
<span class="c1"># [_current_index-1] represents immediatly prior time range</span>
<span class="c1"># [_current_ms_since_epoch-_bucket_ms, _current_ms_since_epoch)</span>
<span class="c1"># etc, wrapping around from the start to the end of the array, so</span>
<span class="c1"># [_current_index+1] is the element representing the oldest bucket.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_buckets</span> <span class="o">=</span> <span class="p">[[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_num_buckets</span><span class="p">)]</span>
<span class="k">def</span> <span class="nf">_Flush</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">now</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Args:</span>
<span class="sd"> now: int, milliseconds since epoch</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">now</span> <span class="o">&gt;=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_current_ms_since_epoch</span>
<span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bucket_ms</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">_num_buckets</span><span class="p">):</span>
<span class="c1"># Time moved forward so far that all currently held data is outside of</span>
<span class="c1"># the window. It is faster to simply reset our data.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_Reset</span><span class="p">(</span><span class="n">now</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">while</span> <span class="n">now</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current_ms_since_epoch</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bucket_ms</span><span class="p">:</span>
<span class="c1"># Advance time by one _bucket_ms, setting the new bucket&#39;s counts to 0.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current_ms_since_epoch</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bucket_ms</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current_index</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_current_index</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">_num_buckets</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_buckets</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_current_index</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">]</span>
<span class="c1"># Intentional dead reckoning here; we don&#39;t care about staying precisely</span>
<span class="c1"># aligned with multiples of _bucket_ms since the epoch, we just need our</span>
<span class="c1"># buckets to represent the most recent _window_ms time window.</span>
<div class="viewcode-block" id="MovingSum.sum"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1.util.html#apache_beam.io.gcp.datastore.v1.util.MovingSum.sum">[docs]</a> <span class="k">def</span> <span class="nf">sum</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">now</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_Flush</span><span class="p">(</span><span class="n">now</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">sum</span><span class="p">(</span><span class="n">bucket</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">bucket</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buckets</span><span class="p">)</span></div>
<div class="viewcode-block" id="MovingSum.add"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1.util.html#apache_beam.io.gcp.datastore.v1.util.MovingSum.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">now</span><span class="p">,</span> <span class="n">inc</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_Flush</span><span class="p">(</span><span class="n">now</span><span class="p">)</span>
<span class="n">bucket</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buckets</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_current_index</span><span class="p">]</span>
<span class="n">bucket</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+=</span> <span class="n">inc</span>
<span class="n">bucket</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span></div>
<div class="viewcode-block" id="MovingSum.count"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1.util.html#apache_beam.io.gcp.datastore.v1.util.MovingSum.count">[docs]</a> <span class="k">def</span> <span class="nf">count</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">now</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_Flush</span><span class="p">(</span><span class="n">now</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">sum</span><span class="p">(</span><span class="n">bucket</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">bucket</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buckets</span><span class="p">)</span></div>
<div class="viewcode-block" id="MovingSum.has_data"><a class="viewcode-back" href="../../../../../../apache_beam.io.gcp.datastore.v1.util.html#apache_beam.io.gcp.datastore.v1.util.MovingSum.has_data">[docs]</a> <span class="k">def</span> <span class="nf">has_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">now</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="n">now</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</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>