| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>apache_beam.transforms.sideinputs — Apache Beam 2.38.0 documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../_static/language_data.js"></script> |
| <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| |
| <script type="text/javascript" src="../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../search.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../index.html" class="icon icon-home"> Apache Beam |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 2.38.0 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.coders.html">apache_beam.coders package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.io.html">apache_beam.io package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.metrics.html">apache_beam.metrics package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.ml.html">apache_beam.ml package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.options.html">apache_beam.options package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.portability.html">apache_beam.portability package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.runners.html">apache_beam.runners package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.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> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../index.html">Apache Beam</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../index.html">Module code</a> »</li> |
| |
| <li>apache_beam.transforms.sideinputs</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for apache_beam.transforms.sideinputs</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">"""Internal side input transforms and implementations.</span> |
| |
| <span class="sd">For internal use only; no backwards-compatibility guarantees.</span> |
| |
| <span class="sd">Important: this module is an implementation detail and should not be used</span> |
| <span class="sd">directly by pipeline writers. Instead, users should use the helper methods</span> |
| <span class="sd">AsSingleton, AsIter, AsList and AsDict in apache_beam.pvalue.</span> |
| <span class="sd">"""</span> |
| |
| <span class="c1"># pytype: skip-file</span> |
| |
| <span class="kn">import</span> <span class="nn">re</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">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">window</span> |
| |
| <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span> |
| <span class="kn">from</span> <span class="nn">apache_beam</span> <span class="kn">import</span> <span class="n">pvalue</span> |
| |
| <span class="n">WindowMappingFn</span> <span class="o">=</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">window</span><span class="o">.</span><span class="n">BoundedWindow</span><span class="p">],</span> <span class="n">window</span><span class="o">.</span><span class="n">BoundedWindow</span><span class="p">]</span> |
| |
| <span class="n">SIDE_INPUT_PREFIX</span> <span class="o">=</span> <span class="s1">'python_side_input'</span> |
| |
| <span class="n">SIDE_INPUT_REGEX</span> <span class="o">=</span> <span class="n">SIDE_INPUT_PREFIX</span> <span class="o">+</span> <span class="s1">'([0-9]+)(-.*)?$'</span> |
| |
| |
| <span class="c1"># Top-level function so we can identify it later.</span> |
| <span class="k">def</span> <span class="nf">_global_window_mapping_fn</span><span class="p">(</span><span class="n">w</span><span class="p">,</span> <span class="n">global_window</span><span class="o">=</span><span class="n">window</span><span class="o">.</span><span class="n">GlobalWindow</span><span class="p">()):</span> |
| <span class="c1"># type: (...) -> window.GlobalWindow</span> |
| <span class="k">return</span> <span class="n">global_window</span> |
| |
| |
| <div class="viewcode-block" id="default_window_mapping_fn"><a class="viewcode-back" href="../../../apache_beam.transforms.sideinputs.html#apache_beam.transforms.sideinputs.default_window_mapping_fn">[docs]</a><span class="k">def</span> <span class="nf">default_window_mapping_fn</span><span class="p">(</span><span class="n">target_window_fn</span><span class="p">):</span> |
| <span class="c1"># type: (window.WindowFn) -> WindowMappingFn</span> |
| <span class="k">if</span> <span class="n">target_window_fn</span> <span class="o">==</span> <span class="n">window</span><span class="o">.</span><span class="n">GlobalWindows</span><span class="p">():</span> |
| <span class="k">return</span> <span class="n">_global_window_mapping_fn</span> |
| |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">target_window_fn</span><span class="p">,</span> <span class="n">window</span><span class="o">.</span><span class="n">Sessions</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">"Sessions is not allowed in side inputs"</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">map_via_end</span><span class="p">(</span><span class="n">source_window</span><span class="p">):</span> |
| <span class="c1"># type: (window.BoundedWindow) -> window.BoundedWindow</span> |
| <span class="k">return</span> <span class="nb">list</span><span class="p">(</span> |
| <span class="n">target_window_fn</span><span class="o">.</span><span class="n">assign</span><span class="p">(</span> |
| <span class="n">window</span><span class="o">.</span><span class="n">WindowFn</span><span class="o">.</span><span class="n">AssignContext</span><span class="p">(</span><span class="n">source_window</span><span class="o">.</span><span class="n">max_timestamp</span><span class="p">())))[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| |
| <span class="k">return</span> <span class="n">map_via_end</span></div> |
| |
| |
| <div class="viewcode-block" id="get_sideinput_index"><a class="viewcode-back" href="../../../apache_beam.transforms.sideinputs.html#apache_beam.transforms.sideinputs.get_sideinput_index">[docs]</a><span class="k">def</span> <span class="nf">get_sideinput_index</span><span class="p">(</span><span class="n">tag</span><span class="p">):</span> |
| <span class="c1"># type: (str) -> int</span> |
| <span class="n">match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">SIDE_INPUT_REGEX</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">DOTALL</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">match</span><span class="p">:</span> |
| <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">"Invalid tag </span><span class="si">%r</span><span class="s2">"</span> <span class="o">%</span> <span class="n">tag</span><span class="p">)</span></div> |
| |
| |
| <div class="viewcode-block" id="SideInputMap"><a class="viewcode-back" href="../../../apache_beam.transforms.sideinputs.html#apache_beam.transforms.sideinputs.SideInputMap">[docs]</a><span class="k">class</span> <span class="nc">SideInputMap</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Represents a mapping of windows to side input 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">view_class</span><span class="p">,</span> <span class="c1"># type: pvalue.AsSideInput</span> |
| <span class="n">view_options</span><span class="p">,</span> |
| <span class="n">iterable</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_window_mapping_fn</span> <span class="o">=</span> <span class="n">view_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'window_mapping_fn'</span><span class="p">,</span> <span class="n">_global_window_mapping_fn</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_view_class</span> <span class="o">=</span> <span class="n">view_class</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_view_options</span> <span class="o">=</span> <span class="n">view_options</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_iterable</span> <span class="o">=</span> <span class="n">iterable</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cache</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># type: Dict[window.BoundedWindow, Any]</span> |
| |
| <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">window</span><span class="p">):</span> |
| <span class="c1"># type: (window.BoundedWindow) -> Any</span> |
| <span class="k">if</span> <span class="n">window</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cache</span><span class="p">:</span> |
| <span class="n">target_window</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_window_mapping_fn</span><span class="p">(</span><span class="n">window</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cache</span><span class="p">[</span><span class="n">window</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_view_class</span><span class="o">.</span><span class="n">_from_runtime_iterable</span><span class="p">(</span> |
| <span class="n">_FilteringIterable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_iterable</span><span class="p">,</span> <span class="n">target_window</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_view_options</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cache</span><span class="p">[</span><span class="n">window</span><span class="p">]</span> |
| |
| <div class="viewcode-block" id="SideInputMap.is_globally_windowed"><a class="viewcode-back" href="../../../apache_beam.transforms.sideinputs.html#apache_beam.transforms.sideinputs.SideInputMap.is_globally_windowed">[docs]</a> <span class="k">def</span> <span class="nf">is_globally_windowed</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="bp">self</span><span class="o">.</span><span class="n">_window_mapping_fn</span> <span class="o">==</span> <span class="n">_global_window_mapping_fn</span></div></div> |
| |
| |
| <span class="k">class</span> <span class="nc">_FilteringIterable</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""An iterable containing only those values in the given window.</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">iterable</span><span class="p">,</span> <span class="n">target_window</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_iterable</span> <span class="o">=</span> <span class="n">iterable</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_target_window</span> <span class="o">=</span> <span class="n">target_window</span> |
| |
| <span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">for</span> <span class="n">wv</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_iterable</span><span class="p">:</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target_window</span> <span class="ow">in</span> <span class="n">wv</span><span class="o">.</span><span class="n">windows</span><span class="p">:</span> |
| <span class="k">yield</span> <span class="n">wv</span><span class="o">.</span><span class="n">value</span> |
| |
| <span class="k">def</span> <span class="nf">__reduce__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># Pickle self as an already filtered list.</span> |
| <span class="k">return</span> <span class="nb">list</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="p">)</span> |
| </pre></div> |
| |
| </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/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |