Google Git
Sign in
apache / beam-site / refs/heads/revert-643-revert-642-updates_release_2.47.0 / . / pydoc / 2.47.0 / _modules / apache_beam / utils / proto_utils.html
blob: 20c9faa25a259e163d4732233c8f0e496bb5377b [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.proto_utils &mdash; 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> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li>apache_beam.utils.proto_utils</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.proto_utils</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;For internal use only; no backwards-compatibility guarantees.&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Type</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TypeVar</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">typing</span> <span class="kn">import</span> <span class="n">overload</span>
<span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="kn">import</span> <span class="n">any_pb2</span>
<span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="kn">import</span> <span class="n">duration_pb2</span>
<span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="kn">import</span> <span class="n">message</span>
<span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="kn">import</span> <span class="n">struct_pb2</span>
<span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="kn">import</span> <span class="n">timestamp_pb2</span>
<span class="n">MessageT</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">&#39;MessageT&#39;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="n">message</span><span class="o">.</span><span class="n">Message</span><span class="p">)</span>
<span class="n">TimeMessageT</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span>
<span class="s1">&#39;TimeMessageT&#39;</span><span class="p">,</span> <span class="n">duration_pb2</span><span class="o">.</span><span class="n">Duration</span><span class="p">,</span> <span class="n">timestamp_pb2</span><span class="o">.</span><span class="n">Timestamp</span><span class="p">)</span>
<span class="n">message_types</span> <span class="o">=</span> <span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">Message</span><span class="p">,</span> <span class="p">)</span>
<span class="nd">@overload</span>
<span class="k">def</span> <span class="nf">pack_Any</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="c1"># type: (message.Message) -&gt; any_pb2.Any</span>
<span class="k">pass</span>
<span class="nd">@overload</span>
<span class="k">def</span> <span class="nf">pack_Any</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="c1"># type: (None) -&gt; None</span>
<span class="k">pass</span>
<div class="viewcode-block" id="pack_Any"><a class="viewcode-back" href="../../../apache_beam.utils.proto_utils.html#apache_beam.utils.proto_utils.pack_Any">[docs]</a><span class="k">def</span> <span class="nf">pack_Any</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Creates a protobuf Any with msg as its content.</span>
<span class="sd"> Returns None if msg is None.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">msg</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">any_pb2</span><span class="o">.</span><span class="n">Any</span><span class="p">()</span>
<span class="n">result</span><span class="o">.</span><span class="n">Pack</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span></div>
<span class="nd">@overload</span>
<span class="k">def</span> <span class="nf">unpack_Any</span><span class="p">(</span><span class="n">any_msg</span><span class="p">,</span> <span class="n">msg_class</span><span class="p">):</span>
<span class="c1"># type: (any_pb2.Any, Type[MessageT]) -&gt; MessageT</span>
<span class="k">pass</span>
<span class="nd">@overload</span>
<span class="k">def</span> <span class="nf">unpack_Any</span><span class="p">(</span><span class="n">any_msg</span><span class="p">,</span> <span class="n">msg_class</span><span class="p">):</span>
<span class="c1"># type: (any_pb2.Any, None) -&gt; None</span>
<span class="k">pass</span>
<div class="viewcode-block" id="unpack_Any"><a class="viewcode-back" href="../../../apache_beam.utils.proto_utils.html#apache_beam.utils.proto_utils.unpack_Any">[docs]</a><span class="k">def</span> <span class="nf">unpack_Any</span><span class="p">(</span><span class="n">any_msg</span><span class="p">,</span> <span class="n">msg_class</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Unpacks any_msg into msg_class.</span>
<span class="sd"> Returns None if msg_class is None.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">msg_class</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">msg_class</span><span class="p">()</span>
<span class="n">any_msg</span><span class="o">.</span><span class="n">Unpack</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">msg</span></div>
<span class="nd">@overload</span>
<span class="k">def</span> <span class="nf">parse_Bytes</span><span class="p">(</span><span class="n">serialized_bytes</span><span class="p">,</span> <span class="n">msg_class</span><span class="p">):</span>
<span class="c1"># type: (bytes, Type[MessageT]) -&gt; MessageT</span>
<span class="k">pass</span>
<span class="nd">@overload</span>
<span class="k">def</span> <span class="nf">parse_Bytes</span><span class="p">(</span><span class="n">serialized_bytes</span><span class="p">,</span> <span class="n">msg_class</span><span class="p">):</span>
<span class="c1"># type: (bytes, Union[Type[bytes], None]) -&gt; bytes</span>
<span class="k">pass</span>
<div class="viewcode-block" id="parse_Bytes"><a class="viewcode-back" href="../../../apache_beam.utils.proto_utils.html#apache_beam.utils.proto_utils.parse_Bytes">[docs]</a><span class="k">def</span> <span class="nf">parse_Bytes</span><span class="p">(</span><span class="n">serialized_bytes</span><span class="p">,</span> <span class="n">msg_class</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Parses the String of bytes into msg_class.</span>
<span class="sd"> Returns the input bytes if msg_class is None.&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">msg_class</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">msg_class</span> <span class="ow">is</span> <span class="nb">bytes</span><span class="p">:</span>
<span class="k">return</span> <span class="n">serialized_bytes</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">msg_class</span><span class="p">()</span>
<span class="n">msg</span><span class="o">.</span><span class="n">ParseFromString</span><span class="p">(</span><span class="n">serialized_bytes</span><span class="p">)</span>
<span class="k">return</span> <span class="n">msg</span></div>
<div class="viewcode-block" id="pack_Struct"><a class="viewcode-back" href="../../../apache_beam.utils.proto_utils.html#apache_beam.utils.proto_utils.pack_Struct">[docs]</a><span class="k">def</span> <span class="nf">pack_Struct</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="c1"># type: (...) -&gt; struct_pb2.Struct</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns a struct containing the values indicated by kwargs.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">struct_pb2</span><span class="o">.</span><span class="n">Struct</span><span class="p">()</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">msg</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span> <span class="c1"># pylint: disable=unsubscriptable-object, unsupported-assignment-operation</span>
<span class="k">return</span> <span class="n">msg</span></div>
<div class="viewcode-block" id="from_micros"><a class="viewcode-back" href="../../../apache_beam.utils.proto_utils.html#apache_beam.utils.proto_utils.from_micros">[docs]</a><span class="k">def</span> <span class="nf">from_micros</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">micros</span><span class="p">):</span>
<span class="c1"># type: (Type[TimeMessageT], int) -&gt; TimeMessageT</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
<span class="n">result</span><span class="o">.</span><span class="n">FromMicroseconds</span><span class="p">(</span><span class="n">micros</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span></div>
<div class="viewcode-block" id="to_Timestamp"><a class="viewcode-back" href="../../../apache_beam.utils.proto_utils.html#apache_beam.utils.proto_utils.to_Timestamp">[docs]</a><span class="k">def</span> <span class="nf">to_Timestamp</span><span class="p">(</span><span class="n">time</span><span class="p">):</span>
<span class="c1"># type: (Union[int, float]) -&gt; timestamp_pb2.Timestamp</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert a float returned by time.time() to a Timestamp.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">seconds</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="p">)</span>
<span class="n">nanos</span> <span class="o">=</span> <span class="nb">int</span><span class="p">((</span><span class="n">time</span> <span class="o">-</span> <span class="n">seconds</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span><span class="o">**</span><span class="mi">9</span><span class="p">)</span>
<span class="k">return</span> <span class="n">timestamp_pb2</span><span class="o">.</span><span class="n">Timestamp</span><span class="p">(</span><span class="n">seconds</span><span class="o">=</span><span class="n">seconds</span><span class="p">,</span> <span class="n">nanos</span><span class="o">=</span><span class="n">nanos</span><span class="p">)</span></div>
<div class="viewcode-block" id="from_Timestamp"><a class="viewcode-back" href="../../../apache_beam.utils.proto_utils.html#apache_beam.utils.proto_utils.from_Timestamp">[docs]</a><span class="k">def</span> <span class="nf">from_Timestamp</span><span class="p">(</span><span class="n">timestamp</span><span class="p">):</span>
<span class="c1"># type: (timestamp_pb2.Timestamp) -&gt; float</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert a Timestamp to a float expressed as seconds since the epoch.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">timestamp</span><span class="o">.</span><span class="n">seconds</span> <span class="o">+</span> <span class="nb">float</span><span class="p">(</span><span class="n">timestamp</span><span class="o">.</span><span class="n">nanos</span><span class="p">)</span> <span class="o">/</span> <span class="mi">10</span><span class="o">**</span><span class="mi">9</span></div>
</pre></div>
</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/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>