Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.15.0 / . / pydoc / 2.15.0 / _modules / apache_beam / transforms / timeutil.html
blob: e5cf1bf1a8289a5879c0e4ae2e4ac1ebcadc1c05 [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.transforms.timeutil &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.transforms.timeutil</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.transforms.timeutil</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="sd">&quot;&quot;&quot;Timestamp utilities.&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
<span class="kn">from</span> <span class="nn">abc</span> <span class="k">import</span> <span class="n">ABCMeta</span>
<span class="kn">from</span> <span class="nn">abc</span> <span class="k">import</span> <span class="n">abstractmethod</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">future.utils</span> <span class="k">import</span> <span class="n">with_metaclass</span>
<span class="kn">from</span> <span class="nn">apache_beam.portability.api</span> <span class="k">import</span> <span class="n">beam_runner_api_pb2</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;TimeDomain&#39;</span><span class="p">,</span>
<span class="p">]</span>
<div class="viewcode-block" id="TimeDomain"><a class="viewcode-back" href="../../../apache_beam.transforms.timeutil.html#apache_beam.transforms.timeutil.TimeDomain">[docs]</a><span class="k">class</span> <span class="nc">TimeDomain</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Time domain for streaming timers.&quot;&quot;&quot;</span>
<span class="n">WATERMARK</span> <span class="o">=</span> <span class="s1">&#39;WATERMARK&#39;</span>
<span class="n">REAL_TIME</span> <span class="o">=</span> <span class="s1">&#39;REAL_TIME&#39;</span>
<span class="n">DEPENDENT_REAL_TIME</span> <span class="o">=</span> <span class="s1">&#39;DEPENDENT_REAL_TIME&#39;</span>
<span class="n">_RUNNER_API_MAPPING</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">WATERMARK</span><span class="p">:</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">TimeDomain</span><span class="o">.</span><span class="n">EVENT_TIME</span><span class="p">,</span>
<span class="n">REAL_TIME</span><span class="p">:</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">TimeDomain</span><span class="o">.</span><span class="n">PROCESSING_TIME</span><span class="p">,</span>
<span class="n">DEPENDENT_REAL_TIME</span><span class="p">:</span>
<span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">TimeDomain</span><span class="o">.</span><span class="n">SYNCHRONIZED_PROCESSING_TIME</span><span class="p">,</span>
<span class="p">}</span>
<div class="viewcode-block" id="TimeDomain.from_string"><a class="viewcode-back" href="../../../apache_beam.transforms.timeutil.html#apache_beam.transforms.timeutil.TimeDomain.from_string">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">from_string</span><span class="p">(</span><span class="n">domain</span><span class="p">):</span>
<span class="k">if</span> <span class="n">domain</span> <span class="ow">in</span> <span class="p">(</span><span class="n">TimeDomain</span><span class="o">.</span><span class="n">WATERMARK</span><span class="p">,</span>
<span class="n">TimeDomain</span><span class="o">.</span><span class="n">REAL_TIME</span><span class="p">,</span>
<span class="n">TimeDomain</span><span class="o">.</span><span class="n">DEPENDENT_REAL_TIME</span><span class="p">):</span>
<span class="k">return</span> <span class="n">domain</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Unknown time domain: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">domain</span><span class="p">)</span></div>
<div class="viewcode-block" id="TimeDomain.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.timeutil.html#apache_beam.transforms.timeutil.TimeDomain.to_runner_api">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="n">domain</span><span class="p">):</span>
<span class="k">return</span> <span class="n">TimeDomain</span><span class="o">.</span><span class="n">_RUNNER_API_MAPPING</span><span class="p">[</span><span class="n">domain</span><span class="p">]</span></div></div>
<span class="k">class</span> <span class="nc">TimestampCombinerImpl</span><span class="p">(</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">ABCMeta</span><span class="p">,</span> <span class="nb">object</span><span class="p">)):</span>
<span class="sd">&quot;&quot;&quot;Implementation of TimestampCombiner.&quot;&quot;&quot;</span>
<span class="nd">@abstractmethod</span>
<span class="k">def</span> <span class="nf">assign_output_time</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">window</span><span class="p">,</span> <span class="n">input_timestamp</span><span class="p">):</span>
<span class="k">pass</span>
<span class="nd">@abstractmethod</span>
<span class="k">def</span> <span class="nf">combine</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output_timestamp</span><span class="p">,</span> <span class="n">other_output_timestamp</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">def</span> <span class="nf">combine_all</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">merging_timestamps</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Apply combine to list of timestamps.&quot;&quot;&quot;</span>
<span class="n">combined_output_time</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">for</span> <span class="n">output_time</span> <span class="ow">in</span> <span class="n">merging_timestamps</span><span class="p">:</span>
<span class="k">if</span> <span class="n">combined_output_time</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">combined_output_time</span> <span class="o">=</span> <span class="n">output_time</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">combined_output_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">combine</span><span class="p">(</span>
<span class="n">combined_output_time</span><span class="p">,</span> <span class="n">output_time</span><span class="p">)</span>
<span class="k">return</span> <span class="n">combined_output_time</span>
<span class="k">def</span> <span class="nf">merge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">unused_result_window</span><span class="p">,</span> <span class="n">merging_timestamps</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Default to returning the result of combine_all.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">combine_all</span><span class="p">(</span><span class="n">merging_timestamps</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">DependsOnlyOnWindow</span><span class="p">(</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">ABCMeta</span><span class="p">,</span> <span class="n">TimestampCombinerImpl</span><span class="p">)):</span>
<span class="sd">&quot;&quot;&quot;TimestampCombinerImpl that only depends on the window.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">combine</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output_timestamp</span><span class="p">,</span> <span class="n">other_output_timestamp</span><span class="p">):</span>
<span class="k">return</span> <span class="n">output_timestamp</span>
<span class="k">def</span> <span class="nf">merge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result_window</span><span class="p">,</span> <span class="n">unused_merging_timestamps</span><span class="p">):</span>
<span class="c1"># Since we know that the result only depends on the window, we can ignore</span>
<span class="c1"># the given timestamps.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">assign_output_time</span><span class="p">(</span><span class="n">result_window</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">OutputAtEarliestInputTimestampImpl</span><span class="p">(</span><span class="n">TimestampCombinerImpl</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;TimestampCombinerImpl outputting at earliest input timestamp.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">assign_output_time</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">window</span><span class="p">,</span> <span class="n">input_timestamp</span><span class="p">):</span>
<span class="k">return</span> <span class="n">input_timestamp</span>
<span class="k">def</span> <span class="nf">combine</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output_timestamp</span><span class="p">,</span> <span class="n">other_output_timestamp</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Default to returning the earlier of two timestamps.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="nb">min</span><span class="p">(</span><span class="n">output_timestamp</span><span class="p">,</span> <span class="n">other_output_timestamp</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">OutputAtEarliestTransformedInputTimestampImpl</span><span class="p">(</span><span class="n">TimestampCombinerImpl</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;TimestampCombinerImpl outputting at earliest input timestamp.&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_fn</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">window_fn</span> <span class="o">=</span> <span class="n">window_fn</span>
<span class="k">def</span> <span class="nf">assign_output_time</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">window</span><span class="p">,</span> <span class="n">input_timestamp</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">window_fn</span><span class="o">.</span><span class="n">get_transformed_output_time</span><span class="p">(</span><span class="n">window</span><span class="p">,</span> <span class="n">input_timestamp</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">combine</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output_timestamp</span><span class="p">,</span> <span class="n">other_output_timestamp</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">min</span><span class="p">(</span><span class="n">output_timestamp</span><span class="p">,</span> <span class="n">other_output_timestamp</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">OutputAtLatestInputTimestampImpl</span><span class="p">(</span><span class="n">TimestampCombinerImpl</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;TimestampCombinerImpl outputting at latest input timestamp.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">assign_output_time</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">window</span><span class="p">,</span> <span class="n">input_timestamp</span><span class="p">):</span>
<span class="k">return</span> <span class="n">input_timestamp</span>
<span class="k">def</span> <span class="nf">combine</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output_timestamp</span><span class="p">,</span> <span class="n">other_output_timestamp</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">max</span><span class="p">(</span><span class="n">output_timestamp</span><span class="p">,</span> <span class="n">other_output_timestamp</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">OutputAtEndOfWindowImpl</span><span class="p">(</span><span class="n">DependsOnlyOnWindow</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;TimestampCombinerImpl outputting at end of window.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">assign_output_time</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">window</span><span class="p">,</span> <span class="n">unused_input_timestamp</span><span class="p">):</span>
<span class="k">return</span> <span class="n">window</span><span class="o">.</span><span class="n">end</span>
</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>