Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.15.0 / . / pydoc / 2.15.0 / _modules / apache_beam / utils / timestamp.html
blob: 3c651ce998cebd146877ff3f51aeea3a1fe18b53 [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.utils.timestamp &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.utils.timestamp</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.utils.timestamp</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.</span>
<span class="sd">For internal use only; no backwards-compatibility guarantees.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">division</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="kn">import</span> <span class="nn">functools</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">builtins</span> <span class="k">import</span> <span class="nb">object</span>
<span class="kn">import</span> <span class="nn">pytz</span>
<span class="kn">from</span> <span class="nn">past.builtins</span> <span class="k">import</span> <span class="n">long</span>
<span class="kn">from</span> <span class="nn">apache_beam.portability</span> <span class="k">import</span> <span class="n">common_urns</span>
<div class="viewcode-block" id="Timestamp"><a class="viewcode-back" href="../../../apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp">[docs]</a><span class="nd">@functools</span><span class="o">.</span><span class="n">total_ordering</span>
<span class="k">class</span> <span class="nc">Timestamp</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Represents a Unix second timestamp with microsecond granularity.</span>
<span class="sd"> Can be treated in common timestamp arithmetic operations as a numeric type.</span>
<span class="sd"> Internally stores a time interval as an int of microseconds. This strategy</span>
<span class="sd"> is necessary since floating point values lose precision when storing values,</span>
<span class="sd"> especially after arithmetic operations (for example, 10000000 % 0.1 evaluates</span>
<span class="sd"> to 0.0999999994448885).</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">seconds</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">micros</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">seconds</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">long</span><span class="p">,</span> <span class="nb">float</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;Cannot interpret </span><span class="si">%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1"> as seconds.&#39;</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">seconds</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">seconds</span><span class="p">)))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">micros</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">long</span><span class="p">,</span> <span class="nb">float</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;Cannot interpret </span><span class="si">%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1"> as micros.&#39;</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">micros</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">micros</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">seconds</span> <span class="o">*</span> <span class="mi">1000000</span><span class="p">)</span> <span class="o">+</span> <span class="nb">int</span><span class="p">(</span><span class="n">micros</span><span class="p">)</span>
<div class="viewcode-block" id="Timestamp.of"><a class="viewcode-back" href="../../../apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp.of">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">of</span><span class="p">(</span><span class="n">seconds</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Return the Timestamp for the given number of seconds.</span>
<span class="sd"> If the input is already a Timestamp, the input itself will be returned.</span>
<span class="sd"> Args:</span>
<span class="sd"> seconds: Number of seconds as int, float, long, or Timestamp.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Corresponding Timestamp object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">seconds</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">long</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;Cannot interpret </span><span class="si">%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1"> as Timestamp.&#39;</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">seconds</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">seconds</span><span class="p">)))</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">seconds</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">):</span>
<span class="k">return</span> <span class="n">seconds</span>
<span class="k">return</span> <span class="n">Timestamp</span><span class="p">(</span><span class="n">seconds</span><span class="p">)</span></div>
<span class="n">RFC_3339_RE</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span>
<span class="sa">r</span><span class="s1">&#39;^(\d</span><span class="si">{4}</span><span class="s1">)-(\d</span><span class="si">{2}</span><span class="s1">)-(\d</span><span class="si">{2}</span><span class="s1">)T(\d</span><span class="si">{2}</span><span class="s1">):(\d</span><span class="si">{2}</span><span class="s1">):(\d</span><span class="si">{2}</span><span class="s1">)(?:\.(\d+))?Z$&#39;</span><span class="p">)</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">_epoch_datetime_utc</span><span class="p">():</span>
<span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">pytz</span><span class="o">.</span><span class="n">utc</span><span class="p">)</span>
<div class="viewcode-block" id="Timestamp.from_utc_datetime"><a class="viewcode-back" href="../../../apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp.from_utc_datetime">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_utc_datetime</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">dt</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Create a ``Timestamp`` instance from a ``datetime.datetime`` object.</span>
<span class="sd"> Args:</span>
<span class="sd"> dt: A ``datetime.datetime`` object in UTC (offset-aware).</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">dt</span><span class="o">.</span><span class="n">tzinfo</span> <span class="o">!=</span> <span class="n">pytz</span><span class="o">.</span><span class="n">utc</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;dt not in UTC: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">dt</span><span class="p">)</span>
<span class="n">duration</span> <span class="o">=</span> <span class="n">dt</span> <span class="o">-</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_epoch_datetime_utc</span><span class="p">()</span>
<span class="k">return</span> <span class="n">Timestamp</span><span class="p">(</span><span class="n">duration</span><span class="o">.</span><span class="n">total_seconds</span><span class="p">())</span></div>
<div class="viewcode-block" id="Timestamp.from_rfc3339"><a class="viewcode-back" href="../../../apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp.from_rfc3339">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_rfc3339</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">rfc3339</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Create a ``Timestamp`` instance from an RFC 3339 compliant string.</span>
<span class="sd"> Args:</span>
<span class="sd"> rfc3339: String in RFC 3339 form.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">dt_args</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">match</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">RFC_3339_RE</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">rfc3339</span><span class="p">)</span>
<span class="k">if</span> <span class="n">match</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">&#39;Could not parse RFC 3339 string: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">rfc3339</span><span class="p">)</span>
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">match</span><span class="o">.</span><span class="n">groups</span><span class="p">():</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">dt_args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</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">dt_args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">dt_args</span> <span class="o">+=</span> <span class="p">(</span><span class="n">pytz</span><span class="o">.</span><span class="n">utc</span><span class="p">,</span> <span class="p">)</span>
<span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">(</span><span class="o">*</span><span class="n">dt_args</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">from_utc_datetime</span><span class="p">(</span><span class="n">dt</span><span class="p">)</span></div>
<div class="viewcode-block" id="Timestamp.predecessor"><a class="viewcode-back" href="../../../apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp.predecessor">[docs]</a> <span class="k">def</span> <span class="nf">predecessor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Returns the largest timestamp smaller than self.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">Timestamp</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">micros</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">micros</span>
<span class="n">sign</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
<span class="k">if</span> <span class="n">micros</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">sign</span> <span class="o">=</span> <span class="s1">&#39;-&#39;</span>
<span class="n">micros</span> <span class="o">=</span> <span class="o">-</span><span class="n">micros</span>
<span class="n">int_part</span> <span class="o">=</span> <span class="n">micros</span> <span class="o">//</span> <span class="mi">1000000</span>
<span class="n">frac_part</span> <span class="o">=</span> <span class="n">micros</span> <span class="o">%</span> <span class="mi">1000000</span>
<span class="k">if</span> <span class="n">frac_part</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">&#39;Timestamp(</span><span class="si">%s%d</span><span class="s1">.</span><span class="si">%06d</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sign</span><span class="p">,</span> <span class="n">int_part</span><span class="p">,</span> <span class="n">frac_part</span><span class="p">)</span>
<span class="k">return</span> <span class="s1">&#39;Timestamp(</span><span class="si">%s%d</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sign</span><span class="p">,</span> <span class="n">int_part</span><span class="p">)</span>
<div class="viewcode-block" id="Timestamp.to_utc_datetime"><a class="viewcode-back" href="../../../apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp.to_utc_datetime">[docs]</a> <span class="k">def</span> <span class="nf">to_utc_datetime</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># We can&#39;t easily construct a datetime object from microseconds, so we</span>
<span class="c1"># create one at the epoch and add an appropriate timedelta interval.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_epoch_datetime_utc</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">+</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span>
<span class="n">microseconds</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span></div>
<div class="viewcode-block" id="Timestamp.to_rfc3339"><a class="viewcode-back" href="../../../apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp.to_rfc3339">[docs]</a> <span class="k">def</span> <span class="nf">to_rfc3339</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Append &#39;Z&#39; for UTC timezone.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">to_utc_datetime</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span> <span class="o">+</span> <span class="s1">&#39;Z&#39;</span></div>
<span class="k">def</span> <span class="nf">__float__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Note that the returned value may have lost precision.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">/</span> <span class="mi">1000000</span>
<span class="k">def</span> <span class="nf">__int__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Note that the returned value may have lost precision.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">//</span> <span class="mi">1000000</span>
<span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="c1"># Allow comparisons between Duration and Timestamp values.</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Duration</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Timestamp</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span>
<span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="c1"># TODO(BEAM-5949): Needed for Python 2 compatibility.</span>
<span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span> <span class="o">==</span> <span class="n">other</span>
<span class="k">def</span> <span class="nf">__lt__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="c1"># Allow comparisons between Duration and Timestamp values.</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Duration</span><span class="p">):</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Timestamp</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">&lt;</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span>
<span class="k">def</span> <span class="nf">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span>
<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">other</span><span class="p">):</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Timestamp</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">+</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__radd__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span> <span class="o">+</span> <span class="n">other</span>
<span class="k">def</span> <span class="nf">__sub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Timestamp</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">-</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__mod__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Duration</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">%</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span></div>
<span class="n">MIN_TIMESTAMP</span> <span class="o">=</span> <span class="n">Timestamp</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span>
<span class="n">common_urns</span><span class="o">.</span><span class="n">constants</span><span class="o">.</span><span class="n">MIN_TIMESTAMP_MILLIS</span><span class="o">.</span><span class="n">constant</span><span class="p">)</span><span class="o">*</span><span class="mi">1000</span><span class="p">)</span>
<span class="n">MAX_TIMESTAMP</span> <span class="o">=</span> <span class="n">Timestamp</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span>
<span class="n">common_urns</span><span class="o">.</span><span class="n">constants</span><span class="o">.</span><span class="n">MAX_TIMESTAMP_MILLIS</span><span class="o">.</span><span class="n">constant</span><span class="p">)</span><span class="o">*</span><span class="mi">1000</span><span class="p">)</span>
<div class="viewcode-block" id="Duration"><a class="viewcode-back" href="../../../apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Duration">[docs]</a><span class="nd">@functools</span><span class="o">.</span><span class="n">total_ordering</span>
<span class="k">class</span> <span class="nc">Duration</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Represents a second duration with microsecond granularity.</span>
<span class="sd"> Can be treated in common arithmetic operations as a numeric type.</span>
<span class="sd"> Internally stores a time interval as an int of microseconds. This strategy</span>
<span class="sd"> is necessary since floating point values lose precision when storing values,</span>
<span class="sd"> especially after arithmetic operations (for example, 10000000 % 0.1 evaluates</span>
<span class="sd"> to 0.0999999994448885).</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">seconds</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">micros</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">seconds</span> <span class="o">*</span> <span class="mi">1000000</span><span class="p">)</span> <span class="o">+</span> <span class="nb">int</span><span class="p">(</span><span class="n">micros</span><span class="p">)</span>
<div class="viewcode-block" id="Duration.of"><a class="viewcode-back" href="../../../apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Duration.of">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">of</span><span class="p">(</span><span class="n">seconds</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Return the Duration for the given number of seconds since Unix epoch.</span>
<span class="sd"> If the input is already a Duration, the input itself will be returned.</span>
<span class="sd"> Args:</span>
<span class="sd"> seconds: Number of seconds as int, float or Duration.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Corresponding Duration object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">seconds</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;Cannot interpret </span><span class="si">%s</span><span class="s1"> as Duration.&#39;</span> <span class="o">%</span> <span class="n">seconds</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">seconds</span><span class="p">,</span> <span class="n">Duration</span><span class="p">):</span>
<span class="k">return</span> <span class="n">seconds</span>
<span class="k">return</span> <span class="n">Duration</span><span class="p">(</span><span class="n">seconds</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">micros</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">micros</span>
<span class="n">sign</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
<span class="k">if</span> <span class="n">micros</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">sign</span> <span class="o">=</span> <span class="s1">&#39;-&#39;</span>
<span class="n">micros</span> <span class="o">=</span> <span class="o">-</span><span class="n">micros</span>
<span class="n">int_part</span> <span class="o">=</span> <span class="n">micros</span> <span class="o">//</span> <span class="mi">1000000</span>
<span class="n">frac_part</span> <span class="o">=</span> <span class="n">micros</span> <span class="o">%</span> <span class="mi">1000000</span>
<span class="k">if</span> <span class="n">frac_part</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">&#39;Duration(</span><span class="si">%s%d</span><span class="s1">.</span><span class="si">%06d</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sign</span><span class="p">,</span> <span class="n">int_part</span><span class="p">,</span> <span class="n">frac_part</span><span class="p">)</span>
<span class="k">return</span> <span class="s1">&#39;Duration(</span><span class="si">%s%d</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sign</span><span class="p">,</span> <span class="n">int_part</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__float__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Note that the returned value may have lost precision.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">/</span> <span class="mi">1000000</span>
<span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="c1"># Allow comparisons between Duration and Timestamp values.</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">):</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span>
<span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="c1"># TODO(BEAM-5949): Needed for Python 2 compatibility.</span>
<span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span> <span class="o">==</span> <span class="n">other</span>
<span class="k">def</span> <span class="nf">__lt__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="c1"># Allow comparisons between Duration and Timestamp values.</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">):</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">&lt;</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span>
<span class="k">def</span> <span class="nf">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__neg__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">Duration</span><span class="p">(</span><span class="n">micros</span><span class="o">=-</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span>
<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">other</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Timestamp</span><span class="p">):</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">+</span> <span class="bp">self</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Duration</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">+</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__radd__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span> <span class="o">+</span> <span class="n">other</span>
<span class="k">def</span> <span class="nf">__sub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Duration</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">-</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__rsub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="o">-</span><span class="p">(</span><span class="bp">self</span> <span class="o">-</span> <span class="n">other</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__mul__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Duration</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">*</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span> <span class="o">//</span> <span class="mi">1000000</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__rmul__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span> <span class="o">*</span> <span class="n">other</span>
<span class="k">def</span> <span class="nf">__mod__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="n">other</span> <span class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span class="n">of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Duration</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">micros</span> <span class="o">%</span> <span class="n">other</span><span class="o">.</span><span class="n">micros</span><span class="p">)</span></div>
<span class="c1"># The minimum granularity / interval expressible in a Timestamp / Duration</span>
<span class="c1"># object.</span>
<span class="n">TIME_GRANULARITY</span> <span class="o">=</span> <span class="n">Duration</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="mi">1</span><span class="p">)</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>