| |
| |
| <!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.coders.coders — 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> »</li> |
| |
| <li><a href="../../index.html">Module code</a> »</li> |
| |
| <li>apache_beam.coders.coders</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.coders.coders</h1><div class="highlight"><pre> |
| <span></span><span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span> |
| <span class="c1"># contributor license agreements. See the NOTICE file distributed with</span> |
| <span class="c1"># this work for additional information regarding copyright ownership.</span> |
| <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span> |
| <span class="c1"># (the "License"); you may not use this file except in compliance with</span> |
| <span class="c1"># the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing, software</span> |
| <span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="c1"># See the License for the specific language governing permissions and</span> |
| <span class="c1"># limitations under the License.</span> |
| <span class="c1">#</span> |
| |
| <span class="sd">"""Collection of useful coders.</span> |
| |
| <span class="sd">Only those coders listed in __all__ are part of the public API of this module.</span> |
| <span class="sd">"""</span> |
| <span class="c1"># pytype: skip-file</span> |
| |
| <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">absolute_import</span> |
| |
| <span class="kn">import</span> <span class="nn">base64</span> |
| <span class="kn">import</span> <span class="nn">sys</span> |
| <span class="kn">from</span> <span class="nn">builtins</span> <span class="kn">import</span> <span class="nb">object</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TYPE_CHECKING</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Iterable</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Sequence</span> |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</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">overload</span> |
| |
| <span class="kn">import</span> <span class="nn">google.protobuf.wrappers_pb2</span> |
| <span class="kn">from</span> <span class="nn">future.moves</span> <span class="kn">import</span> <span class="n">pickle</span> |
| <span class="kn">from</span> <span class="nn">past.builtins</span> <span class="kn">import</span> <span class="n">unicode</span> |
| |
| <span class="kn">from</span> <span class="nn">apache_beam.coders</span> <span class="kn">import</span> <span class="n">coder_impl</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.coders.avro_record</span> <span class="kn">import</span> <span class="n">AvroRecord</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.portability</span> <span class="kn">import</span> <span class="n">common_urns</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.portability</span> <span class="kn">import</span> <span class="n">python_urns</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.portability.api</span> <span class="kn">import</span> <span class="n">beam_runner_api_pb2</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.typehints</span> <span class="kn">import</span> <span class="n">typehints</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.utils</span> <span class="kn">import</span> <span class="n">proto_utils</span> |
| |
| <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span> |
| <span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="kn">import</span> <span class="n">message</span> <span class="c1"># pylint: disable=ungrouped-imports</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.coders.typecoders</span> <span class="kn">import</span> <span class="n">CoderRegistry</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.runners.pipeline_context</span> <span class="kn">import</span> <span class="n">PipelineContext</span> |
| |
| <span class="c1"># pylint: disable=wrong-import-order, wrong-import-position, ungrouped-imports</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="kn">from</span> <span class="nn">.stream</span> <span class="kn">import</span> <span class="n">get_varint_size</span> |
| <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
| <span class="kn">from</span> <span class="nn">.slow_stream</span> <span class="kn">import</span> <span class="n">get_varint_size</span> |
| <span class="c1"># pylint: enable=wrong-import-order, wrong-import-position, ungrouped-imports</span> |
| |
| |
| <span class="c1"># pylint: disable=wrong-import-order, wrong-import-position</span> |
| <span class="c1"># Avoid dependencies on the full SDK.</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="c1"># Import dill from the pickler module to make sure our monkey-patching of dill</span> |
| <span class="c1"># occurs.</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.internal.pickler</span> <span class="kn">import</span> <span class="n">dill</span> |
| <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
| <span class="c1"># We fall back to using the stock dill library in tests that don't use the</span> |
| <span class="c1"># full Python SDK.</span> |
| <span class="kn">import</span> <span class="nn">dill</span> |
| |
| |
| <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="s1">'Coder'</span><span class="p">,</span> |
| <span class="s1">'AvroGenericCoder'</span><span class="p">,</span> <span class="s1">'BooleanCoder'</span><span class="p">,</span> <span class="s1">'BytesCoder'</span><span class="p">,</span> <span class="s1">'DillCoder'</span><span class="p">,</span> |
| <span class="s1">'FastPrimitivesCoder'</span><span class="p">,</span> <span class="s1">'FloatCoder'</span><span class="p">,</span> <span class="s1">'IterableCoder'</span><span class="p">,</span> <span class="s1">'PickleCoder'</span><span class="p">,</span> |
| <span class="s1">'ProtoCoder'</span><span class="p">,</span> <span class="s1">'SingletonCoder'</span><span class="p">,</span> <span class="s1">'StrUtf8Coder'</span><span class="p">,</span> <span class="s1">'TimestampCoder'</span><span class="p">,</span> |
| <span class="s1">'TupleCoder'</span><span class="p">,</span> <span class="s1">'TupleSequenceCoder'</span><span class="p">,</span> <span class="s1">'VarIntCoder'</span><span class="p">,</span> |
| <span class="s1">'WindowedValueCoder'</span><span class="p">,</span> <span class="s1">'ParamWindowedValueCoder'</span> |
| <span class="p">]</span> |
| |
| <span class="n">T</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">'T'</span><span class="p">)</span> |
| <span class="n">CoderT</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">'CoderT'</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s1">'Coder'</span><span class="p">)</span> |
| <span class="n">ProtoCoderT</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">'ProtoCoderT'</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s1">'ProtoCoder'</span><span class="p">)</span> |
| <span class="n">ConstructorFn</span> <span class="o">=</span> <span class="n">Callable</span><span class="p">[</span> |
| <span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Any</span><span class="p">],</span> |
| <span class="n">List</span><span class="p">[</span><span class="s1">'Coder'</span><span class="p">],</span> |
| <span class="s1">'PipelineContext'</span><span class="p">],</span> |
| <span class="n">Any</span><span class="p">]</span> |
| |
| |
| <span class="k">def</span> <span class="nf">serialize_coder</span><span class="p">(</span><span class="n">coder</span><span class="p">):</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.internal</span> <span class="kn">import</span> <span class="n">pickler</span> |
| <span class="k">return</span> <span class="sa">b</span><span class="s1">'</span><span class="si">%s</span><span class="s1">$</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">coder</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">),</span> |
| <span class="n">pickler</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">coder</span><span class="p">))</span> |
| |
| |
| <span class="k">def</span> <span class="nf">deserialize_coder</span><span class="p">(</span><span class="n">serialized</span><span class="p">):</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.internal</span> <span class="kn">import</span> <span class="n">pickler</span> |
| <span class="k">return</span> <span class="n">pickler</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">serialized</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="sa">b</span><span class="s1">'$'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">1</span><span class="p">])</span> |
| <span class="c1"># pylint: enable=wrong-import-order, wrong-import-position</span> |
| |
| |
| <div class="viewcode-block" id="Coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder">[docs]</a><span class="k">class</span> <span class="nc">Coder</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Base class for coders."""</span> |
| |
| <div class="viewcode-block" id="Coder.encode"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.encode">[docs]</a> <span class="k">def</span> <span class="nf">encode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="c1"># type: (Any) -> bytes</span> |
| <span class="sd">"""Encodes the given object into a byte string."""</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'Encode not implemented: </span><span class="si">%s</span><span class="s1">.'</span> <span class="o">%</span> <span class="bp">self</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Coder.decode"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.decode">[docs]</a> <span class="k">def</span> <span class="nf">decode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">encoded</span><span class="p">):</span> |
| <span class="sd">"""Decodes the given byte string into the corresponding object."""</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'Decode not implemented: </span><span class="si">%s</span><span class="s1">.'</span> <span class="o">%</span> <span class="bp">self</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Coder.encode_nested"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.encode_nested">[docs]</a> <span class="k">def</span> <span class="nf">encode_nested</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="sd">"""Uses the underlying implementation to encode in nested format."""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_impl</span><span class="p">()</span><span class="o">.</span><span class="n">encode_nested</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Coder.decode_nested"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.decode_nested">[docs]</a> <span class="k">def</span> <span class="nf">decode_nested</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">encoded</span><span class="p">):</span> |
| <span class="sd">"""Uses the underlying implementation to decode in nested format."""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_impl</span><span class="p">()</span><span class="o">.</span><span class="n">decode_nested</span><span class="p">(</span><span class="n">encoded</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Coder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> bool</span> |
| <span class="sd">"""Whether this coder is guaranteed to encode values deterministically.</span> |
| |
| <span class="sd"> A deterministic coder is required for key coders in GroupByKey operations</span> |
| <span class="sd"> to produce consistent results.</span> |
| |
| <span class="sd"> For example, note that the default coder, the PickleCoder, is not</span> |
| <span class="sd"> deterministic: the ordering of picked entries in maps may vary across</span> |
| <span class="sd"> executions since there is no defined order, and such a coder is not in</span> |
| <span class="sd"> general suitable for usage as a key coder in GroupByKey operations, since</span> |
| <span class="sd"> each instance of the same key may be encoded differently.</span> |
| |
| <span class="sd"> Returns:</span> |
| <span class="sd"> Whether coder is deterministic.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="kc">False</span></div> |
| |
| <div class="viewcode-block" id="Coder.as_deterministic_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.as_deterministic_coder">[docs]</a> <span class="k">def</span> <span class="nf">as_deterministic_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""Returns a deterministic version of self, if possible.</span> |
| |
| <span class="sd"> Otherwise raises a value error.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">():</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_message</span> <span class="ow">or</span> <span class="s2">"'</span><span class="si">%s</span><span class="s2">' cannot be made deterministic."</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Coder.estimate_size"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.estimate_size">[docs]</a> <span class="k">def</span> <span class="nf">estimate_size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="sd">"""Estimates the encoded size of the given value, in bytes.</span> |
| |
| <span class="sd"> Dataflow estimates the encoded size of a PCollection processed in a pipeline</span> |
| <span class="sd"> step by using the estimated size of a random sample of elements in that</span> |
| <span class="sd"> PCollection.</span> |
| |
| <span class="sd"> The default implementation encodes the given value and returns its byte</span> |
| <span class="sd"> size. If a coder can provide a fast estimate of the encoded size of a value</span> |
| <span class="sd"> (e.g., if the encoding has a fixed size), it can provide its estimate here</span> |
| <span class="sd"> to improve performance.</span> |
| |
| <span class="sd"> Arguments:</span> |
| <span class="sd"> value: the value whose encoded size is to be estimated.</span> |
| |
| <span class="sd"> Returns:</span> |
| <span class="sd"> The estimated encoded size of the given value.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">value</span><span class="p">))</span></div> |
| |
| <span class="c1"># ===========================================================================</span> |
| <span class="c1"># Methods below are internal SDK details that don't need to be modified for</span> |
| <span class="c1"># user-defined coders.</span> |
| <span class="c1"># ===========================================================================</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> coder_impl.CoderImpl</span> |
| <span class="sd">"""Creates a CoderImpl to do the actual encoding and decoding.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">CallbackCoderImpl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">encode</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">decode</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">estimate_size</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="Coder.get_impl"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.get_impl">[docs]</a> <span class="k">def</span> <span class="nf">get_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""For internal use only; no backwards-compatibility guarantees.</span> |
| |
| <span class="sd"> Returns the CoderImpl backing this Coder.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'_impl'</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_impl</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_create_impl</span><span class="p">()</span> |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_impl</span><span class="p">,</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">CoderImpl</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_impl</span></div> |
| |
| <span class="k">def</span> <span class="nf">__getstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dict_without_impl</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">_dict_without_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'_impl'</span><span class="p">):</span> |
| <span class="n">d</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">)</span> |
| <span class="k">del</span> <span class="n">d</span><span class="p">[</span><span class="s1">'_impl'</span><span class="p">]</span> |
| <span class="k">return</span> <span class="n">d</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span> |
| |
| <div class="viewcode-block" id="Coder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'BEAM-2717'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Coder.from_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.from_type_hint">[docs]</a> <span class="nd">@classmethod</span> |
| <span class="k">def</span> <span class="nf">from_type_hint</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">unused_typehint</span><span class="p">,</span> <span class="n">unused_registry</span><span class="p">):</span> |
| <span class="c1"># type: (Type[CoderT], Any, CoderRegistry) -> CoderT</span> |
| <span class="c1"># If not overridden, just construct the coder without arguments.</span> |
| <span class="k">return</span> <span class="bp">cls</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="Coder.is_kv_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.is_kv_coder">[docs]</a> <span class="k">def</span> <span class="nf">is_kv_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">False</span></div> |
| |
| <div class="viewcode-block" id="Coder.key_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.key_coder">[docs]</a> <span class="k">def</span> <span class="nf">key_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Coder</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_kv_coder</span><span class="p">():</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'key_coder: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="bp">self</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Not a KV coder: </span><span class="si">%s</span><span class="s1">.'</span> <span class="o">%</span> <span class="bp">self</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="Coder.value_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.value_coder">[docs]</a> <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Coder</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_kv_coder</span><span class="p">():</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'value_coder: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="bp">self</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Not a KV coder: </span><span class="si">%s</span><span class="s1">.'</span> <span class="o">%</span> <span class="bp">self</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="nf">_get_component_coders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Sequence[Coder]</span> |
| <span class="sd">"""For internal use only; no backwards-compatibility guarantees.</span> |
| |
| <span class="sd"> Returns the internal component coders of this coder."""</span> |
| <span class="c1"># This is an internal detail of the Coder API and does not need to be</span> |
| <span class="c1"># refined in user-defined Coders.</span> |
| <span class="k">return</span> <span class="p">[]</span> |
| |
| <div class="viewcode-block" id="Coder.as_cloud_object"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.as_cloud_object">[docs]</a> <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""For internal use only; no backwards-compatibility guarantees.</span> |
| |
| <span class="sd"> Returns Google Cloud Dataflow API description of this coder."""</span> |
| <span class="c1"># This is an internal detail of the Coder API and does not need to be</span> |
| <span class="c1"># refined in user-defined Coders.</span> |
| |
| <span class="n">value</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="c1"># We pass coders in the form "<coder_name>$<pickled_data>" to make the</span> |
| <span class="c1"># job description JSON more readable. Data before the $ is ignored by</span> |
| <span class="c1"># the worker.</span> |
| <span class="s1">'@type'</span><span class="p">:</span> |
| <span class="n">serialize_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> |
| <span class="s1">'component_encodings'</span><span class="p">:</span> <span class="p">[</span> |
| <span class="n">component</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">component</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_component_coders</span><span class="p">()</span> |
| <span class="p">],</span> |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">coders_context</span><span class="p">:</span> |
| <span class="n">value</span><span class="p">[</span><span class="s1">'pipeline_proto_coder_id'</span><span class="p">]</span> <span class="o">=</span> <span class="n">coders_context</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">value</span></div> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span> |
| |
| <span class="c1"># pylint: disable=protected-access</span> |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="vm">__class__</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dict_without_impl</span><span class="p">()</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_dict_without_impl</span><span class="p">())</span> |
| <span class="c1"># pylint: enable=protected-access</span> |
| |
| <span class="k">def</span> <span class="fm">__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="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span> |
| |
| <span class="n">_known_urns</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># type: Dict[str, Tuple[type, ConstructorFn]]</span> |
| |
| <span class="nd">@classmethod</span> |
| <span class="nd">@overload</span> |
| <span class="k">def</span> <span class="nf">register_urn</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> |
| <span class="n">urn</span><span class="p">,</span> <span class="c1"># type: str</span> |
| <span class="n">parameter_type</span><span class="p">,</span> <span class="c1"># type: Optional[Type[T]]</span> |
| <span class="p">):</span> |
| <span class="c1"># type: (...) -> Callable[[Callable[[T, List[Coder], PipelineContext], Any]], Callable[[T, List[Coder], PipelineContext], Any]]</span> |
| <span class="k">pass</span> |
| |
| <span class="nd">@classmethod</span> |
| <span class="nd">@overload</span> |
| <span class="k">def</span> <span class="nf">register_urn</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> |
| <span class="n">urn</span><span class="p">,</span> <span class="c1"># type: str</span> |
| <span class="n">parameter_type</span><span class="p">,</span> <span class="c1"># type: Optional[Type[T]]</span> |
| <span class="n">fn</span> <span class="c1"># type: Callable[[T, List[Coder], PipelineContext], Any]</span> |
| <span class="p">):</span> |
| <span class="c1"># type: (...) -> None</span> |
| <span class="k">pass</span> |
| |
| <div class="viewcode-block" id="Coder.register_urn"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.register_urn">[docs]</a> <span class="nd">@classmethod</span> |
| <span class="k">def</span> <span class="nf">register_urn</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">urn</span><span class="p">,</span> <span class="n">parameter_type</span><span class="p">,</span> <span class="n">fn</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""Registers a urn with a constructor.</span> |
| |
| <span class="sd"> For example, if 'beam:fn:foo' had parameter type FooPayload, one could</span> |
| <span class="sd"> write `RunnerApiFn.register_urn('bean:fn:foo', FooPayload, foo_from_proto)`</span> |
| <span class="sd"> where foo_from_proto took as arguments a FooPayload and a PipelineContext.</span> |
| <span class="sd"> This function can also be used as a decorator rather than passing the</span> |
| <span class="sd"> callable in as the final parameter.</span> |
| |
| <span class="sd"> A corresponding to_runner_api_parameter method would be expected that</span> |
| <span class="sd"> returns the tuple ('beam:fn:foo', FooPayload)</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span> |
| <span class="bp">cls</span><span class="o">.</span><span class="n">_known_urns</span><span class="p">[</span><span class="n">urn</span><span class="p">]</span> <span class="o">=</span> <span class="n">parameter_type</span><span class="p">,</span> <span class="n">fn</span> |
| <span class="k">return</span> <span class="nb">staticmethod</span><span class="p">(</span><span class="n">fn</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">fn</span><span class="p">:</span> |
| <span class="c1"># Used as a statement.</span> |
| <span class="n">register</span><span class="p">(</span><span class="n">fn</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># Used as a decorator.</span> |
| <span class="k">return</span> <span class="n">register</span></div> |
| |
| <div class="viewcode-block" id="Coder.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.to_runner_api">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="c1"># type: (PipelineContext) -> beam_runner_api_pb2.Coder</span> |
| <span class="n">urn</span><span class="p">,</span> <span class="n">typed_param</span><span class="p">,</span> <span class="n">components</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">to_runner_api_parameter</span><span class="p">(</span><span class="n">context</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">Coder</span><span class="p">(</span> |
| <span class="n">spec</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">FunctionSpec</span><span class="p">(</span> |
| <span class="n">urn</span><span class="o">=</span><span class="n">urn</span><span class="p">,</span> |
| <span class="n">payload</span><span class="o">=</span><span class="n">typed_param</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typed_param</span><span class="p">,</span> <span class="p">(</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="kc">None</span><span class="p">)))</span> |
| <span class="k">else</span> <span class="n">typed_param</span><span class="o">.</span><span class="n">SerializeToString</span><span class="p">()),</span> |
| <span class="n">component_coder_ids</span><span class="o">=</span><span class="p">[</span><span class="n">context</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">components</span><span class="p">])</span></div> |
| |
| <div class="viewcode-block" id="Coder.from_runner_api"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.from_runner_api">[docs]</a> <span class="nd">@classmethod</span> |
| <span class="k">def</span> <span class="nf">from_runner_api</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">coder_proto</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="c1"># type: (Type[CoderT], beam_runner_api_pb2.Coder, PipelineContext) -> CoderT</span> |
| <span class="sd">"""Converts from an FunctionSpec to a Fn object.</span> |
| |
| <span class="sd"> Prefer registering a urn with its parameter type and constructor.</span> |
| <span class="sd"> """</span> |
| <span class="n">parameter_type</span><span class="p">,</span> <span class="n">constructor</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_known_urns</span><span class="p">[</span><span class="n">coder_proto</span><span class="o">.</span><span class="n">spec</span><span class="o">.</span><span class="n">urn</span><span class="p">]</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">constructor</span><span class="p">(</span> |
| <span class="n">proto_utils</span><span class="o">.</span><span class="n">parse_Bytes</span><span class="p">(</span> |
| <span class="n">coder_proto</span><span class="o">.</span><span class="n">spec</span><span class="o">.</span><span class="n">payload</span><span class="p">,</span> <span class="n">parameter_type</span><span class="p">),</span> |
| <span class="p">[</span><span class="n">context</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">get_by_id</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">coder_proto</span><span class="o">.</span><span class="n">component_coder_ids</span><span class="p">],</span> |
| <span class="n">context</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">context</span><span class="o">.</span><span class="n">allow_proto_holders</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">RunnerAPICoderHolder</span><span class="p">(</span><span class="n">coder_proto</span><span class="p">)</span> <span class="c1"># type: ignore # too ambiguous</span> |
| <span class="k">raise</span></div> |
| |
| <div class="viewcode-block" id="Coder.to_runner_api_parameter"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.to_runner_api_parameter">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api_parameter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="c1"># type: (Optional[PipelineContext]) -> Tuple[str, Any, Sequence[Coder]]</span> |
| <span class="k">return</span> <span class="p">(</span> |
| <span class="n">python_urns</span><span class="o">.</span><span class="n">PICKLED_CODER</span><span class="p">,</span> |
| <span class="n">google</span><span class="o">.</span><span class="n">protobuf</span><span class="o">.</span><span class="n">wrappers_pb2</span><span class="o">.</span><span class="n">BytesValue</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="n">serialize_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">)),</span> |
| <span class="p">())</span></div> |
| |
| <div class="viewcode-block" id="Coder.register_structured_urn"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.Coder.register_structured_urn">[docs]</a> <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">register_structured_urn</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="bp">cls</span><span class="p">):</span> |
| <span class="c1"># type: (str, Type[Coder]) -> None</span> |
| <span class="sd">"""Register a coder that's completely defined by its urn and its</span> |
| <span class="sd"> component(s), if any, which are passed to construct the instance.</span> |
| <span class="sd"> """</span> |
| <span class="bp">cls</span><span class="o">.</span><span class="n">to_runner_api_parameter</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="k">lambda</span> <span class="bp">self</span><span class="p">,</span> <span class="n">unused_context</span><span class="p">:</span> <span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_component_coders</span><span class="p">()))</span> |
| |
| <span class="c1"># pylint: disable=unused-variable</span> |
| <span class="nd">@Coder</span><span class="o">.</span><span class="n">register_urn</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">from_runner_api_parameter</span><span class="p">(</span><span class="n">unused_payload</span><span class="p">,</span> <span class="n">components</span><span class="p">,</span> <span class="n">unused_context</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">components</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="o">*</span><span class="n">components</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">cls</span><span class="p">()</span></div></div> |
| |
| |
| <span class="nd">@Coder</span><span class="o">.</span><span class="n">register_urn</span><span class="p">(</span> |
| <span class="n">python_urns</span><span class="o">.</span><span class="n">PICKLED_CODER</span><span class="p">,</span> <span class="n">google</span><span class="o">.</span><span class="n">protobuf</span><span class="o">.</span><span class="n">wrappers_pb2</span><span class="o">.</span><span class="n">BytesValue</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">_pickle_from_runner_api_parameter</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">components</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">deserialize_coder</span><span class="p">(</span><span class="n">payload</span><span class="o">.</span><span class="n">value</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="StrUtf8Coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.StrUtf8Coder">[docs]</a><span class="k">class</span> <span class="nc">StrUtf8Coder</span><span class="p">(</span><span class="n">Coder</span><span class="p">):</span> |
| <span class="sd">"""A coder used for reading and writing strings as UTF-8."""</span> |
| |
| <div class="viewcode-block" id="StrUtf8Coder.encode"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.StrUtf8Coder.encode">[docs]</a> <span class="k">def</span> <span class="nf">encode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="StrUtf8Coder.decode"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.StrUtf8Coder.decode">[docs]</a> <span class="k">def</span> <span class="nf">decode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="StrUtf8Coder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.StrUtf8Coder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">True</span></div> |
| |
| <div class="viewcode-block" id="StrUtf8Coder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.StrUtf8Coder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">unicode</span></div></div> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span> |
| <span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">STRING_UTF8</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">StrUtf8Coder</span><span class="p">)</span> |
| |
| |
| <span class="k">class</span> <span class="nc">ToStringCoder</span><span class="p">(</span><span class="n">Coder</span><span class="p">):</span> |
| <span class="sd">"""A default string coder used if no sink coder is specified."""</span> |
| |
| <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span> |
| |
| <span class="k">def</span> <span class="nf">encode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="c1"># pylint: disable=unicode-builtin</span> |
| <span class="k">return</span> <span class="p">(</span><span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">unicode</span><span class="p">)</span> <span class="c1"># noqa: F821</span> |
| <span class="k">else</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">))</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="k">def</span> <span class="nf">encode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">)</span> <span class="k">else</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">decode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'ToStringCoder cannot be used for decoding.'</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| |
| <span class="k">class</span> <span class="nc">FastCoder</span><span class="p">(</span><span class="n">Coder</span><span class="p">):</span> |
| <span class="sd">"""Coder subclass used when a (faster) CoderImpl is supplied directly.</span> |
| |
| <span class="sd"> The Coder class defines _create_impl in terms of encode() and decode();</span> |
| <span class="sd"> this class inverts that by defining encode() and decode() in terms of</span> |
| <span class="sd"> _create_impl().</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="nf">encode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="sd">"""Encodes the given object into a byte string."""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_impl</span><span class="p">()</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">decode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">encoded</span><span class="p">):</span> |
| <span class="sd">"""Decodes the given byte string into the corresponding object."""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_impl</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">encoded</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">estimate_size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_impl</span><span class="p">()</span><span class="o">.</span><span class="n">estimate_size</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span> |
| |
| |
| <div class="viewcode-block" id="BytesCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.BytesCoder">[docs]</a><span class="k">class</span> <span class="nc">BytesCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Byte string coder."""</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">BytesCoderImpl</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="BytesCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.BytesCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span></div> |
| |
| <div class="viewcode-block" id="BytesCoder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.BytesCoder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">bytes</span></div> |
| |
| <div class="viewcode-block" id="BytesCoder.as_cloud_object"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.BytesCoder.as_cloud_object">[docs]</a> <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">{</span> |
| <span class="s1">'@type'</span><span class="p">:</span> <span class="s1">'kind:bytes'</span><span class="p">,</span> |
| <span class="p">}</span></div> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span><span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">BYTES</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">BytesCoder</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="BooleanCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.BooleanCoder">[docs]</a><span class="k">class</span> <span class="nc">BooleanCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">BooleanCoderImpl</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="BooleanCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.BooleanCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">True</span></div> |
| |
| <div class="viewcode-block" id="BooleanCoder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.BooleanCoder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">bool</span></div> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span><span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">BOOL</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">BooleanCoder</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="VarIntCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.VarIntCoder">[docs]</a><span class="k">class</span> <span class="nc">VarIntCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Variable-length integer coder."""</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">VarIntCoderImpl</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="VarIntCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.VarIntCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span></div> |
| |
| <div class="viewcode-block" id="VarIntCoder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.VarIntCoder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">int</span></div> |
| |
| <div class="viewcode-block" id="VarIntCoder.as_cloud_object"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.VarIntCoder.as_cloud_object">[docs]</a> <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">{</span> |
| <span class="s1">'@type'</span><span class="p">:</span> <span class="s1">'kind:varint'</span><span class="p">,</span> |
| <span class="p">}</span></div> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span><span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">VARINT</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">VarIntCoder</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="FloatCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FloatCoder">[docs]</a><span class="k">class</span> <span class="nc">FloatCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""A coder used for floating-point values."""</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">FloatCoderImpl</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="FloatCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FloatCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span></div> |
| |
| <div class="viewcode-block" id="FloatCoder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FloatCoder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">float</span></div> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span><span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">DOUBLE</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">FloatCoder</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="TimestampCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TimestampCoder">[docs]</a><span class="k">class</span> <span class="nc">TimestampCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""A coder used for timeutil.Timestamp values."""</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">TimestampCoderImpl</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="TimestampCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TimestampCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span></div> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div> |
| |
| |
| <span class="k">class</span> <span class="nc">_TimerCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""A coder used for timer values.</span> |
| |
| <span class="sd"> For internal use."""</span> |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">payload_coder</span><span class="p">):</span> |
| <span class="c1"># type: (Coder) -> None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_payload_coder</span> <span class="o">=</span> <span class="n">payload_coder</span> |
| |
| <span class="k">def</span> <span class="nf">_get_component_coders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> List[Coder]</span> |
| <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_payload_coder</span><span class="p">]</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">TimerCoderImpl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_payload_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">())</span> |
| |
| <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_payload_coder</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_payload_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_payload_coder</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span> <span class="o">+</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_payload_coder</span><span class="p">)</span> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span> |
| <span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">TIMER</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">_TimerCoder</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="SingletonCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.SingletonCoder">[docs]</a><span class="k">class</span> <span class="nc">SingletonCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""A coder that always encodes exactly one value."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">value</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">SingletonCoderImpl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="SingletonCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.SingletonCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span></div> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span> |
| |
| <span class="k">def</span> <span class="fm">__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">_value</span><span class="p">)</span></div> |
| |
| |
| <span class="k">def</span> <span class="nf">maybe_dill_dumps</span><span class="p">(</span><span class="n">o</span><span class="p">):</span> |
| <span class="sd">"""Pickle using cPickle or the Dill pickler as a fallback."""</span> |
| <span class="c1"># We need to use the dill pickler for objects of certain custom classes,</span> |
| <span class="c1"># including, for example, ones that contain lambdas.</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">pickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="n">pickle</span><span class="o">.</span><span class="n">HIGHEST_PROTOCOL</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span> |
| <span class="k">return</span> <span class="n">dill</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">o</span><span class="p">)</span> |
| |
| |
| <span class="k">def</span> <span class="nf">maybe_dill_loads</span><span class="p">(</span><span class="n">o</span><span class="p">):</span> |
| <span class="sd">"""Unpickle using cPickle or the Dill pickler as a fallback."""</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">o</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span> |
| <span class="k">return</span> <span class="n">dill</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">o</span><span class="p">)</span> |
| |
| |
| <span class="k">class</span> <span class="nc">_PickleCoderBase</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Base class for pickling coders."""</span> |
| |
| <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="c1"># Note that the default coder, the PickleCoder, is not deterministic (for</span> |
| <span class="c1"># example, the ordering of picked entries in maps may vary across</span> |
| <span class="c1"># executions), and so is not in general suitable for usage as a key coder in</span> |
| <span class="c1"># GroupByKey operations.</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| |
| <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">is_pair_like</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="n">value</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">_PickleCoderBase</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">)</span> |
| <span class="c1"># We currently use this coder in places where we cannot infer the coder to</span> |
| <span class="c1"># use for the value type in a more granular way. In places where the</span> |
| <span class="c1"># service expects a pair, it checks for the "is_pair_like" key, in which</span> |
| <span class="c1"># case we would fail without the hack below.</span> |
| <span class="k">if</span> <span class="n">is_pair_like</span><span class="p">:</span> |
| <span class="n">value</span><span class="p">[</span><span class="s1">'is_pair_like'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="n">value</span><span class="p">[</span><span class="s1">'component_encodings'</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">,</span> <span class="n">is_pair_like</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">,</span> <span class="n">is_pair_like</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> |
| <span class="p">]</span> |
| |
| <span class="k">return</span> <span class="n">value</span> |
| |
| <span class="c1"># We allow .key_coder() and .value_coder() to be called on PickleCoder since</span> |
| <span class="c1"># we can't always infer the return values of lambdas in ParDo operations, the</span> |
| <span class="c1"># result of which may be used in a GroupBykey.</span> |
| <span class="k">def</span> <span class="nf">is_kv_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">def</span> <span class="nf">key_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span> |
| |
| |
| <div class="viewcode-block" id="PickleCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.PickleCoder">[docs]</a><span class="k">class</span> <span class="nc">PickleCoder</span><span class="p">(</span><span class="n">_PickleCoderBase</span><span class="p">):</span> |
| <span class="sd">"""Coder using Python's pickle functionality."""</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">dumps</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">dumps</span> |
| <span class="n">HIGHEST_PROTOCOL</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">HIGHEST_PROTOCOL</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">CallbackCoderImpl</span><span class="p">(</span> |
| <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">dumps</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">HIGHEST_PROTOCOL</span><span class="p">),</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="PickleCoder.as_deterministic_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.PickleCoder.as_deterministic_coder">[docs]</a> <span class="k">def</span> <span class="nf">as_deterministic_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">DeterministicFastPrimitivesCoder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="PickleCoder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.PickleCoder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">Any</span></div></div> |
| |
| |
| <div class="viewcode-block" id="DillCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.DillCoder">[docs]</a><span class="k">class</span> <span class="nc">DillCoder</span><span class="p">(</span><span class="n">_PickleCoderBase</span><span class="p">):</span> |
| <span class="sd">"""Coder using dill's pickle functionality."""</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">CallbackCoderImpl</span><span class="p">(</span><span class="n">maybe_dill_dumps</span><span class="p">,</span> <span class="n">maybe_dill_loads</span><span class="p">)</span></div> |
| |
| |
| <span class="k">class</span> <span class="nc">DeterministicFastPrimitivesCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Throws runtime errors when encoding non-deterministic values."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coder</span><span class="p">,</span> <span class="n">step_label</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_underlying_coder</span> <span class="o">=</span> <span class="n">coder</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_step_label</span> <span class="o">=</span> <span class="n">step_label</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">DeterministicFastPrimitivesCoderImpl</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_underlying_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_step_label</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">def</span> <span class="nf">is_kv_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">def</span> <span class="nf">key_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">Any</span> |
| |
| |
| <div class="viewcode-block" id="FastPrimitivesCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FastPrimitivesCoder">[docs]</a><span class="k">class</span> <span class="nc">FastPrimitivesCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Encodes simple primitives (e.g. str, int) efficiently.</span> |
| |
| <span class="sd"> For unknown types, falls back to another coder (e.g. PickleCoder).</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fallback_coder</span><span class="o">=</span><span class="n">PickleCoder</span><span class="p">()):</span> |
| <span class="c1"># type: (Coder) -> None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_fallback_coder</span> <span class="o">=</span> <span class="n">fallback_coder</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">FastPrimitivesCoderImpl</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_fallback_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">())</span> |
| |
| <div class="viewcode-block" id="FastPrimitivesCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FastPrimitivesCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fallback_coder</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="FastPrimitivesCoder.as_deterministic_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FastPrimitivesCoder.as_deterministic_coder">[docs]</a> <span class="k">def</span> <span class="nf">as_deterministic_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">():</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">DeterministicFastPrimitivesCoder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="FastPrimitivesCoder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FastPrimitivesCoder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">Any</span></div> |
| |
| <div class="viewcode-block" id="FastPrimitivesCoder.as_cloud_object"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FastPrimitivesCoder.as_cloud_object">[docs]</a> <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">is_pair_like</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="n">value</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">)</span> |
| <span class="c1"># We currently use this coder in places where we cannot infer the coder to</span> |
| <span class="c1"># use for the value type in a more granular way. In places where the</span> |
| <span class="c1"># service expects a pair, it checks for the "is_pair_like" key, in which</span> |
| <span class="c1"># case we would fail without the hack below.</span> |
| <span class="k">if</span> <span class="n">is_pair_like</span><span class="p">:</span> |
| <span class="n">value</span><span class="p">[</span><span class="s1">'is_pair_like'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="n">value</span><span class="p">[</span><span class="s1">'component_encodings'</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">,</span> <span class="n">is_pair_like</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">,</span> <span class="n">is_pair_like</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> |
| <span class="p">]</span> |
| |
| <span class="k">return</span> <span class="n">value</span></div> |
| |
| <span class="c1"># We allow .key_coder() and .value_coder() to be called on FastPrimitivesCoder</span> |
| <span class="c1"># since we can't always infer the return values of lambdas in ParDo</span> |
| <span class="c1"># operations, the result of which may be used in a GroupBykey.</span> |
| <div class="viewcode-block" id="FastPrimitivesCoder.is_kv_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FastPrimitivesCoder.is_kv_coder">[docs]</a> <span class="k">def</span> <span class="nf">is_kv_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span></div> |
| |
| <div class="viewcode-block" id="FastPrimitivesCoder.key_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FastPrimitivesCoder.key_coder">[docs]</a> <span class="k">def</span> <span class="nf">key_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span></div> |
| |
| <div class="viewcode-block" id="FastPrimitivesCoder.value_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.FastPrimitivesCoder.value_coder">[docs]</a> <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span></div> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div> |
| |
| |
| <span class="k">class</span> <span class="nc">Base64PickleCoder</span><span class="p">(</span><span class="n">Coder</span><span class="p">):</span> |
| <span class="sd">"""Coder of objects by Python pickle, then base64 encoding."""</span> |
| <span class="c1"># TODO(robertwb): Do base64 encoding where it's needed (e.g. in json) rather</span> |
| <span class="c1"># than via a special Coder.</span> |
| |
| <span class="k">def</span> <span class="nf">encode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">pickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">pickle</span><span class="o">.</span><span class="n">HIGHEST_PROTOCOL</span><span class="p">))</span> |
| |
| <span class="k">def</span> <span class="nf">decode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">encoded</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">encoded</span><span class="p">))</span> |
| |
| <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="c1"># Note that the Base64PickleCoder is not deterministic. See the</span> |
| <span class="c1"># corresponding comments for PickleCoder above.</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| |
| <span class="c1"># We allow .key_coder() and .value_coder() to be called on Base64PickleCoder</span> |
| <span class="c1"># since we can't always infer the return values of lambdas in ParDo</span> |
| <span class="c1"># operations, the result of which may be used in a GroupBykey.</span> |
| <span class="c1">#</span> |
| <span class="c1"># TODO(ccy): this is currently only used for KV values from Create transforms.</span> |
| <span class="c1"># Investigate a way to unify this with PickleCoder.</span> |
| <span class="k">def</span> <span class="nf">is_kv_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">def</span> <span class="nf">key_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| |
| <div class="viewcode-block" id="ProtoCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.ProtoCoder">[docs]</a><span class="k">class</span> <span class="nc">ProtoCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""A Coder for Google Protocol Buffers.</span> |
| |
| <span class="sd"> It supports both Protocol Buffers syntax versions 2 and 3. However,</span> |
| <span class="sd"> the runtime version of the python protobuf library must exactly match the</span> |
| <span class="sd"> version of the protoc compiler what was used to generate the protobuf</span> |
| <span class="sd"> messages.</span> |
| |
| <span class="sd"> ProtoCoder is registered in the global CoderRegistry as the default coder for</span> |
| <span class="sd"> any protobuf Message object.</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto_message_type</span><span class="p">):</span> |
| <span class="c1"># type: (google.protobuf.message.Message) -> None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">proto_message_type</span> <span class="o">=</span> <span class="n">proto_message_type</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">ProtoCoderImpl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">proto_message_type</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="ProtoCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.ProtoCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="c1"># TODO(vikasrk): A proto message can be deterministic if it does not contain</span> |
| <span class="c1"># a Map.</span> |
| <span class="k">return</span> <span class="kc">False</span></div> |
| |
| <div class="viewcode-block" id="ProtoCoder.as_deterministic_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.ProtoCoder.as_deterministic_coder">[docs]</a> <span class="k">def</span> <span class="nf">as_deterministic_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">DeterministicProtoCoder</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">proto_message_type</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">proto_message_type</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">proto_message_type</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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">proto_message_type</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="ProtoCoder.from_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.ProtoCoder.from_type_hint">[docs]</a> <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">from_type_hint</span><span class="p">(</span><span class="n">typehint</span><span class="p">,</span> <span class="n">unused_registry</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">typehint</span><span class="p">,</span> <span class="n">google</span><span class="o">.</span><span class="n">protobuf</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="k">return</span> <span class="n">ProtoCoder</span><span class="p">(</span><span class="n">typehint</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">((</span><span class="s1">'Expected a subclass of google.protobuf.message.Message'</span> |
| <span class="s1">', but got a </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">typehint</span><span class="p">))</span></div></div> |
| |
| |
| <span class="k">class</span> <span class="nc">DeterministicProtoCoder</span><span class="p">(</span><span class="n">ProtoCoder</span><span class="p">):</span> |
| <span class="sd">"""A deterministic Coder for Google Protocol Buffers.</span> |
| |
| <span class="sd"> It supports both Protocol Buffers syntax versions 2 and 3. However,</span> |
| <span class="sd"> the runtime version of the python protobuf library must exactly match the</span> |
| <span class="sd"> version of the protoc compiler what was used to generate the protobuf</span> |
| <span class="sd"> messages.</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">DeterministicProtoCoderImpl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">proto_message_type</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">def</span> <span class="nf">as_deterministic_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| |
| |
| <span class="n">AVRO_GENERIC_CODER_URN</span> <span class="o">=</span> <span class="s2">"beam:coder:avro:generic:v1"</span> |
| |
| |
| <div class="viewcode-block" id="AvroGenericCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.AvroGenericCoder">[docs]</a><span class="k">class</span> <span class="nc">AvroGenericCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""A coder used for AvroRecord values."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">schema</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="n">schema</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">AvroCoderImpl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="AvroGenericCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.AvroGenericCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># TODO(BEAM-7903): need to confirm if it's deterministic</span> |
| <span class="k">return</span> <span class="kc">False</span></div> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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">schema</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="AvroGenericCoder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.AvroGenericCoder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">AvroRecord</span></div> |
| |
| <div class="viewcode-block" id="AvroGenericCoder.to_runner_api_parameter"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.AvroGenericCoder.to_runner_api_parameter">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api_parameter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">AVRO_GENERIC_CODER_URN</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema</span><span class="p">,</span> <span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="AvroGenericCoder.from_runner_api_parameter"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.AvroGenericCoder.from_runner_api_parameter">[docs]</a> <span class="nd">@Coder</span><span class="o">.</span><span class="n">register_urn</span><span class="p">(</span><span class="n">AVRO_GENERIC_CODER_URN</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">from_runner_api_parameter</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">unused_components</span><span class="p">,</span> <span class="n">unused_context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">AvroGenericCoder</span><span class="p">(</span><span class="n">payload</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="TupleCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder">[docs]</a><span class="k">class</span> <span class="nc">TupleCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Coder of tuple objects."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">components</span><span class="p">):</span> |
| <span class="c1"># type: (Iterable[Coder]) -> None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">components</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">TupleCoderImpl</span><span class="p">([</span><span class="n">c</span><span class="o">.</span><span class="n">get_impl</span><span class="p">()</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">])</span> |
| |
| <div class="viewcode-block" id="TupleCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="nb">all</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">()</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="TupleCoder.as_deterministic_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.as_deterministic_coder">[docs]</a> <span class="k">def</span> <span class="nf">as_deterministic_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">():</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">TupleCoder</span><span class="p">([</span><span class="n">c</span><span class="o">.</span><span class="n">as_deterministic_coder</span><span class="p">(</span><span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">])</span></div> |
| |
| <div class="viewcode-block" id="TupleCoder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">typehints</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">tuple</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">to_type_hint</span><span class="p">()</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">)]</span></div> |
| |
| <div class="viewcode-block" id="TupleCoder.from_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.from_type_hint">[docs]</a> <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">from_type_hint</span><span class="p">(</span><span class="n">typehint</span><span class="p">,</span> <span class="n">registry</span><span class="p">):</span> |
| <span class="c1"># type: (typehints.TupleConstraint, CoderRegistry) -> TupleCoder</span> |
| <span class="k">return</span> <span class="n">TupleCoder</span><span class="p">([</span><span class="n">registry</span><span class="o">.</span><span class="n">get_coder</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">typehint</span><span class="o">.</span><span class="n">tuple_types</span><span class="p">])</span></div> |
| |
| <div class="viewcode-block" id="TupleCoder.as_cloud_object"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.as_cloud_object">[docs]</a> <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_kv_coder</span><span class="p">():</span> |
| <span class="k">return</span> <span class="p">{</span> |
| <span class="s1">'@type'</span><span class="p">:</span> |
| <span class="s1">'kind:pair'</span><span class="p">,</span> |
| <span class="s1">'is_pair_like'</span><span class="p">:</span> |
| <span class="kc">True</span><span class="p">,</span> |
| <span class="s1">'component_encodings'</span><span class="p">:</span> <span class="p">[</span> |
| <span class="n">component</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">component</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_component_coders</span><span class="p">()</span> |
| <span class="p">],</span> |
| <span class="p">}</span> |
| |
| <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">TupleCoder</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="nf">_get_component_coders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Tuple[Coder, ...]</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">coders</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="TupleCoder.coders"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.coders">[docs]</a> <span class="k">def</span> <span class="nf">coders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Tuple[Coder, ...]</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span></div> |
| |
| <div class="viewcode-block" id="TupleCoder.is_kv_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.is_kv_coder">[docs]</a> <span class="k">def</span> <span class="nf">is_kv_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span></div> |
| |
| <div class="viewcode-block" id="TupleCoder.key_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.key_coder">[docs]</a> <span class="k">def</span> <span class="nf">key_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Coder</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'TupleCoder does not have exactly 2 components.'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div> |
| |
| <div class="viewcode-block" id="TupleCoder.value_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.value_coder">[docs]</a> <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Coder</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'TupleCoder does not have exactly 2 components.'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span></div> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'TupleCoder[</span><span class="si">%s</span><span class="s1">]'</span> <span class="o">%</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_coders</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">coders</span><span class="p">())</span> |
| |
| <span class="k">def</span> <span class="fm">__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">_coders</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="TupleCoder.to_runner_api_parameter"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.to_runner_api_parameter">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api_parameter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_kv_coder</span><span class="p">():</span> |
| <span class="k">return</span> <span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">KV</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">coders</span><span class="p">()</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">TupleCoder</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">to_runner_api_parameter</span><span class="p">(</span><span class="n">context</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="TupleCoder.from_runner_api_parameter"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleCoder.from_runner_api_parameter">[docs]</a> <span class="nd">@Coder</span><span class="o">.</span><span class="n">register_urn</span><span class="p">(</span><span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">KV</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">from_runner_api_parameter</span><span class="p">(</span><span class="n">unused_payload</span><span class="p">,</span> <span class="n">components</span><span class="p">,</span> <span class="n">unused_context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">TupleCoder</span><span class="p">(</span><span class="n">components</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="TupleSequenceCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleSequenceCoder">[docs]</a><span class="k">class</span> <span class="nc">TupleSequenceCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Coder of homogeneous tuple objects."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">elem_coder</span><span class="p">):</span> |
| <span class="c1"># type: (Coder) -> None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span> <span class="o">=</span> <span class="n">elem_coder</span> |
| |
| <div class="viewcode-block" id="TupleSequenceCoder.value_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleSequenceCoder.value_coder">[docs]</a> <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span></div> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">TupleSequenceCoderImpl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">())</span> |
| |
| <div class="viewcode-block" id="TupleSequenceCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleSequenceCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="TupleSequenceCoder.as_deterministic_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleSequenceCoder.as_deterministic_coder">[docs]</a> <span class="k">def</span> <span class="nf">as_deterministic_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">():</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">TupleSequenceCoder</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="o">.</span><span class="n">as_deterministic_coder</span><span class="p">(</span><span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="TupleSequenceCoder.from_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.TupleSequenceCoder.from_type_hint">[docs]</a> <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">from_type_hint</span><span class="p">(</span><span class="n">typehint</span><span class="p">,</span> <span class="n">registry</span><span class="p">):</span> |
| <span class="c1"># type: (Any, CoderRegistry) -> TupleSequenceCoder</span> |
| <span class="k">return</span> <span class="n">TupleSequenceCoder</span><span class="p">(</span><span class="n">registry</span><span class="o">.</span><span class="n">get_coder</span><span class="p">(</span><span class="n">typehint</span><span class="o">.</span><span class="n">inner_type</span><span class="p">))</span></div> |
| |
| <span class="k">def</span> <span class="nf">_get_component_coders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Tuple[Coder, ...]</span> |
| <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="p">,)</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'TupleSequenceCoder[</span><span class="si">%r</span><span class="s1">]'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">value_coder</span><span class="p">())</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="p">))</span></div> |
| |
| |
| <div class="viewcode-block" id="IterableCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.IterableCoder">[docs]</a><span class="k">class</span> <span class="nc">IterableCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Coder of iterables of homogeneous objects."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">elem_coder</span><span class="p">):</span> |
| <span class="c1"># type: (Coder) -> None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span> <span class="o">=</span> <span class="n">elem_coder</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">IterableCoderImpl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">())</span> |
| |
| <div class="viewcode-block" id="IterableCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.IterableCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="IterableCoder.as_deterministic_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.IterableCoder.as_deterministic_coder">[docs]</a> <span class="k">def</span> <span class="nf">as_deterministic_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">():</span> |
| <span class="k">return</span> <span class="bp">self</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">IterableCoder</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="o">.</span><span class="n">as_deterministic_coder</span><span class="p">(</span><span class="n">step_label</span><span class="p">,</span> <span class="n">error_message</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="IterableCoder.as_cloud_object"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.IterableCoder.as_cloud_object">[docs]</a> <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">{</span> |
| <span class="s1">'@type'</span><span class="p">:</span> |
| <span class="s1">'kind:stream'</span><span class="p">,</span> |
| <span class="s1">'is_stream_like'</span><span class="p">:</span> |
| <span class="kc">True</span><span class="p">,</span> |
| <span class="s1">'component_encodings'</span><span class="p">:</span> <span class="p">[</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">)</span> |
| <span class="p">],</span> |
| <span class="p">}</span></div> |
| |
| <div class="viewcode-block" id="IterableCoder.value_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.IterableCoder.value_coder">[docs]</a> <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span></div> |
| |
| <div class="viewcode-block" id="IterableCoder.to_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.IterableCoder.to_type_hint">[docs]</a> <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">typehints</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="o">.</span><span class="n">to_type_hint</span><span class="p">()]</span></div> |
| |
| <div class="viewcode-block" id="IterableCoder.from_type_hint"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.IterableCoder.from_type_hint">[docs]</a> <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">from_type_hint</span><span class="p">(</span><span class="n">typehint</span><span class="p">,</span> <span class="n">registry</span><span class="p">):</span> |
| <span class="c1"># type: (Any, CoderRegistry) -> IterableCoder</span> |
| <span class="k">return</span> <span class="n">IterableCoder</span><span class="p">(</span><span class="n">registry</span><span class="o">.</span><span class="n">get_coder</span><span class="p">(</span><span class="n">typehint</span><span class="o">.</span><span class="n">inner_type</span><span class="p">))</span></div> |
| |
| <span class="k">def</span> <span class="nf">_get_component_coders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Tuple[Coder, ...]</span> |
| <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="p">,)</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'IterableCoder[</span><span class="si">%r</span><span class="s1">]'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">value_coder</span><span class="p">())</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elem_coder</span><span class="p">))</span></div> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span><span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">ITERABLE</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">IterableCoder</span><span class="p">)</span> |
| |
| |
| <span class="k">class</span> <span class="nc">GlobalWindowCoder</span><span class="p">(</span><span class="n">SingletonCoder</span><span class="p">):</span> |
| <span class="sd">"""Coder for global windows."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">window</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">GlobalWindowCoder</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">window</span><span class="o">.</span><span class="n">GlobalWindow</span><span class="p">())</span> |
| |
| <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">{</span> |
| <span class="s1">'@type'</span><span class="p">:</span> <span class="s1">'kind:global_window'</span><span class="p">,</span> |
| <span class="p">}</span> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span> |
| <span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">GLOBAL_WINDOW</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">GlobalWindowCoder</span><span class="p">)</span> |
| |
| |
| <span class="k">class</span> <span class="nc">IntervalWindowCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Coder for an window defined by a start timestamp and a duration."""</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">IntervalWindowCoderImpl</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">{</span> |
| <span class="s1">'@type'</span><span class="p">:</span> <span class="s1">'kind:interval_window'</span><span class="p">,</span> |
| <span class="p">}</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span> |
| <span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">INTERVAL_WINDOW</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">IntervalWindowCoder</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="WindowedValueCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.WindowedValueCoder">[docs]</a><span class="k">class</span> <span class="nc">WindowedValueCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""Coder for windowed values."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wrapped_value_coder</span><span class="p">,</span> <span class="n">window_coder</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="c1"># type: (Coder, Optional[Coder]) -> None</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">window_coder</span><span class="p">:</span> |
| <span class="n">window_coder</span> <span class="o">=</span> <span class="n">PickleCoder</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span> <span class="o">=</span> <span class="n">wrapped_value_coder</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timestamp_coder</span> <span class="o">=</span> <span class="n">TimestampCoder</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span> <span class="o">=</span> <span class="n">window_coder</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">WindowedValueCoderImpl</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">(),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timestamp_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">(),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">())</span> |
| |
| <div class="viewcode-block" id="WindowedValueCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.WindowedValueCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="nb">all</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">()</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timestamp_coder</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span><span class="p">])</span></div> |
| |
| <div class="viewcode-block" id="WindowedValueCoder.as_cloud_object"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.WindowedValueCoder.as_cloud_object">[docs]</a> <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">{</span> |
| <span class="s1">'@type'</span><span class="p">:</span> |
| <span class="s1">'kind:windowed_value'</span><span class="p">,</span> |
| <span class="s1">'is_wrapper'</span><span class="p">:</span> |
| <span class="kc">True</span><span class="p">,</span> |
| <span class="s1">'component_encodings'</span><span class="p">:</span> <span class="p">[</span> |
| <span class="n">component</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">component</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_component_coders</span><span class="p">()</span> |
| <span class="p">],</span> |
| <span class="p">}</span></div> |
| |
| <span class="k">def</span> <span class="nf">_get_component_coders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> List[Coder]</span> |
| <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span><span class="p">]</span> |
| |
| <div class="viewcode-block" id="WindowedValueCoder.is_kv_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.WindowedValueCoder.is_kv_coder">[docs]</a> <span class="k">def</span> <span class="nf">is_kv_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="o">.</span><span class="n">is_kv_coder</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="WindowedValueCoder.key_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.WindowedValueCoder.key_coder">[docs]</a> <span class="k">def</span> <span class="nf">key_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Coder</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="o">.</span><span class="n">key_coder</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="WindowedValueCoder.value_coder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.WindowedValueCoder.value_coder">[docs]</a> <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Coder</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="o">.</span><span class="n">value_coder</span><span class="p">()</span></div> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'WindowedValueCoder[</span><span class="si">%s</span><span class="s1">]'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">wrapped_value_coder</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">timestamp_coder</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">window_coder</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp_coder</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span><span class="p">))</span></div> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span> |
| <span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">WINDOWED_VALUE</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">WindowedValueCoder</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="ParamWindowedValueCoder"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.ParamWindowedValueCoder">[docs]</a><span class="k">class</span> <span class="nc">ParamWindowedValueCoder</span><span class="p">(</span><span class="n">WindowedValueCoder</span><span class="p">):</span> |
| <span class="sd">"""A coder used for parameterized windowed values."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">payload</span><span class="p">,</span> <span class="n">components</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">ParamWindowedValueCoder</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">components</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">components</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">payload</span> <span class="o">=</span> <span class="n">payload</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">ParamWindowedValueCoderImpl</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">(),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">(),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="ParamWindowedValueCoder.is_deterministic"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.ParamWindowedValueCoder.is_deterministic">[docs]</a> <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="ParamWindowedValueCoder.as_cloud_object"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.ParamWindowedValueCoder.as_cloud_object">[docs]</a> <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span> |
| <span class="s2">"as_cloud_object not supported for ParamWindowedValueCoder"</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'ParamWindowedValueCoder[</span><span class="si">%s</span><span class="s1">]'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">wrapped_value_coder</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">window_coder</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">payload</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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">wrapped_value_coder</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">))</span> |
| |
| <div class="viewcode-block" id="ParamWindowedValueCoder.from_runner_api_parameter"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.ParamWindowedValueCoder.from_runner_api_parameter">[docs]</a> <span class="nd">@Coder</span><span class="o">.</span><span class="n">register_urn</span><span class="p">(</span><span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">PARAM_WINDOWED_VALUE</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">from_runner_api_parameter</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">components</span><span class="p">,</span> <span class="n">unused_context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">ParamWindowedValueCoder</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">components</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="ParamWindowedValueCoder.to_runner_api_parameter"><a class="viewcode-back" href="../../../apache_beam.coders.coders.html#apache_beam.coders.coders.ParamWindowedValueCoder.to_runner_api_parameter">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api_parameter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">(</span><span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">PARAM_WINDOWED_VALUE</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">,</span> |
| <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">wrapped_value_coder</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">window_coder</span><span class="p">))</span></div></div> |
| |
| |
| <span class="k">class</span> <span class="nc">LengthPrefixCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="sd">"""For internal use only; no backwards-compatibility guarantees.</span> |
| |
| <span class="sd"> Coder which prefixes the length of the encoded object in the stream."""</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value_coder</span><span class="p">):</span> |
| <span class="c1"># type: (Coder) -> None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span> <span class="o">=</span> <span class="n">value_coder</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">LengthPrefixCoderImpl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">())</span> |
| |
| <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span><span class="o">.</span><span class="n">is_deterministic</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">estimate_size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="n">value_size</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span><span class="o">.</span><span class="n">estimate_size</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">get_varint_size</span><span class="p">(</span><span class="n">value_size</span><span class="p">)</span> <span class="o">+</span> <span class="n">value_size</span> |
| |
| <span class="k">def</span> <span class="nf">value_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span> |
| |
| <span class="k">def</span> <span class="nf">as_cloud_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coders_context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">return</span> <span class="p">{</span> |
| <span class="s1">'@type'</span><span class="p">:</span> |
| <span class="s1">'kind:length_prefix'</span><span class="p">,</span> |
| <span class="s1">'component_encodings'</span><span class="p">:</span> <span class="p">[</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span><span class="o">.</span><span class="n">as_cloud_object</span><span class="p">(</span><span class="n">coders_context</span><span class="p">)</span> |
| <span class="p">],</span> |
| <span class="p">}</span> |
| |
| <span class="k">def</span> <span class="nf">_get_component_coders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Tuple[Coder, ...]</span> |
| <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span><span class="p">,)</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'LengthPrefixCoder[</span><span class="si">%r</span><span class="s1">]'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_value_coder</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value_coder</span><span class="p">))</span> |
| |
| |
| <span class="n">Coder</span><span class="o">.</span><span class="n">register_structured_urn</span><span class="p">(</span> |
| <span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">LENGTH_PREFIX</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="n">LengthPrefixCoder</span><span class="p">)</span> |
| |
| |
| <span class="k">class</span> <span class="nc">StateBackedIterableCoder</span><span class="p">(</span><span class="n">FastCoder</span><span class="p">):</span> |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">element_coder</span><span class="p">,</span> <span class="c1"># type: Coder</span> |
| <span class="n">read_state</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[coder_impl.IterableStateReader]</span> |
| <span class="n">write_state</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[coder_impl.IterableStateWriter]</span> |
| <span class="n">write_state_threshold</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_element_coder</span> <span class="o">=</span> <span class="n">element_coder</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_read_state</span> <span class="o">=</span> <span class="n">read_state</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_write_state</span> <span class="o">=</span> <span class="n">write_state</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_write_state_threshold</span> <span class="o">=</span> <span class="n">write_state_threshold</span> |
| |
| <span class="k">def</span> <span class="nf">_create_impl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">coder_impl</span><span class="o">.</span><span class="n">IterableCoderImpl</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_element_coder</span><span class="o">.</span><span class="n">get_impl</span><span class="p">(),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_read_state</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_write_state</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_write_state_threshold</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># () -> bool</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| |
| <span class="k">def</span> <span class="nf">_get_component_coders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># type: () -> Tuple[Coder, ...]</span> |
| <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_element_coder</span><span class="p">,)</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'StateBackedIterableCoder[</span><span class="si">%r</span><span class="s1">]'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">_element_coder</span> |
| |
| <span class="k">def</span> <span class="fm">__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="k">return</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_element_coder</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_element_coder</span> |
| <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_write_state_threshold</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_write_state_threshold</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__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="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_element_coder</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_write_state_threshold</span><span class="p">))</span> |
| |
| <span class="k">def</span> <span class="nf">to_runner_api_parameter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="c1"># type: (Optional[PipelineContext]) -> Tuple[str, Any, Sequence[Coder]]</span> |
| <span class="k">return</span> <span class="p">(</span> |
| <span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">STATE_BACKED_ITERABLE</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> |
| <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_write_state_threshold</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'ascii'</span><span class="p">),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_get_component_coders</span><span class="p">())</span> |
| |
| <span class="nd">@Coder</span><span class="o">.</span><span class="n">register_urn</span><span class="p">(</span><span class="n">common_urns</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">STATE_BACKED_ITERABLE</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">from_runner_api_parameter</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">components</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">StateBackedIterableCoder</span><span class="p">(</span> |
| <span class="n">components</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> |
| <span class="n">read_state</span><span class="o">=</span><span class="n">context</span><span class="o">.</span><span class="n">iterable_state_read</span><span class="p">,</span> |
| <span class="n">write_state</span><span class="o">=</span><span class="n">context</span><span class="o">.</span><span class="n">iterable_state_write</span><span class="p">,</span> |
| <span class="n">write_state_threshold</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">payload</span><span class="p">))</span> |
| |
| |
| <span class="k">class</span> <span class="nc">RunnerAPICoderHolder</span><span class="p">(</span><span class="n">Coder</span><span class="p">):</span> |
| <span class="sd">"""A `Coder` that holds a runner API `Coder` proto.</span> |
| |
| <span class="sd"> This is used for coders for which corresponding objects cannot be</span> |
| <span class="sd"> initialized in Python SDK. For example, coders for remote SDKs that may</span> |
| <span class="sd"> be available in Python SDK transform graph when expanding a cross-language</span> |
| <span class="sd"> transform.</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_proto</span> <span class="o">=</span> <span class="n">proto</span> |
| |
| <span class="k">def</span> <span class="nf">proto</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_proto</span> |
| |
| <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_proto</span> |
| |
| <span class="k">def</span> <span class="nf">to_type_hint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">Any</span> |
| </pre></div> |
| |
| </div> |
| <div class="articleComments"> |
| |
| </div> |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright . |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/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> |
