| |
| |
| <!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.userstate — 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.transforms.userstate</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.userstate</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">"""User-facing interfaces for the Beam State and Timer APIs.</span> |
| |
| <span class="sd">Experimental; no backwards-compatibility guarantees.</span> |
| <span class="sd">"""</span> |
| |
| <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span> |
| |
| <span class="kn">import</span> <span class="nn">itertools</span> |
| <span class="kn">import</span> <span class="nn">types</span> |
| <span class="kn">from</span> <span class="nn">builtins</span> <span class="k">import</span> <span class="nb">object</span> |
| |
| <span class="kn">from</span> <span class="nn">apache_beam.coders</span> <span class="k">import</span> <span class="n">Coder</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.coders</span> <span class="k">import</span> <span class="n">coders</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.portability.api</span> <span class="k">import</span> <span class="n">beam_runner_api_pb2</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.transforms.timeutil</span> <span class="k">import</span> <span class="n">TimeDomain</span> |
| |
| |
| <div class="viewcode-block" id="StateSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.StateSpec">[docs]</a><span class="k">class</span> <span class="nc">StateSpec</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Specification for a user DoFn state cell."""</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span> |
| |
| <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</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="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="StateSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.StateSpec.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="k">raise</span> <span class="ne">NotImplementedError</span></div></div> |
| |
| |
| <div class="viewcode-block" id="BagStateSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.BagStateSpec">[docs]</a><span class="k">class</span> <span class="nc">BagStateSpec</span><span class="p">(</span><span class="n">StateSpec</span><span class="p">):</span> |
| <span class="sd">"""Specification for a user DoFn bag state cell."""</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">coder</span><span class="p">):</span> |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">coder</span><span class="p">,</span> <span class="n">Coder</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">coder</span> <span class="o">=</span> <span class="n">coder</span> |
| |
| <div class="viewcode-block" id="BagStateSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.BagStateSpec.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="k">return</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">StateSpec</span><span class="p">(</span> |
| <span class="n">bag_spec</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">BagStateSpec</span><span class="p">(</span> |
| <span class="n">element_coder_id</span><span class="o">=</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="bp">self</span><span class="o">.</span><span class="n">coder</span><span class="p">)))</span></div></div> |
| |
| |
| <div class="viewcode-block" id="CombiningValueStateSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.CombiningValueStateSpec">[docs]</a><span class="k">class</span> <span class="nc">CombiningValueStateSpec</span><span class="p">(</span><span class="n">StateSpec</span><span class="p">):</span> |
| <span class="sd">"""Specification for a user DoFn combining value state cell."""</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">coder</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">combine_fn</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""Initialize the specification for CombiningValue state.</span> |
| |
| <span class="sd"> CombiningValueStateSpec(name, combine_fn) -> Coder-inferred combining value</span> |
| <span class="sd"> state spec.</span> |
| <span class="sd"> CombiningValueStateSpec(name, coder, combine_fn) -> Combining value state</span> |
| <span class="sd"> spec with coder and combine_fn specified.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> name (str): The name by which the state is identified.</span> |
| <span class="sd"> coder (Coder): Coder specifying how to encode the values to be combined.</span> |
| <span class="sd"> May be inferred.</span> |
| <span class="sd"> combine_fn (``CombineFn`` or ``callable``): Function specifying how to</span> |
| <span class="sd"> combine the values passed to state.</span> |
| <span class="sd"> """</span> |
| <span class="c1"># Avoid circular import.</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="k">import</span> <span class="n">CombineFn</span> |
| <span class="c1"># We want the coder to be optional, but unfortunately it comes</span> |
| <span class="c1"># before the non-optional combine_fn parameter, which we can't</span> |
| <span class="c1"># change for backwards compatibility reasons.</span> |
| <span class="c1">#</span> |
| <span class="c1"># Instead, allow it to be omitted (by either passing two arguments</span> |
| <span class="c1"># or combine_fn by keyword.)</span> |
| <span class="k">if</span> <span class="n">combine_fn</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">coder</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'combine_fn must be provided'</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">coder</span><span class="p">,</span> <span class="n">combine_fn</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">coder</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">combine_fn</span> <span class="o">=</span> <span class="n">CombineFn</span><span class="o">.</span><span class="n">maybe_from_callable</span><span class="p">(</span><span class="n">combine_fn</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">coder</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">coder</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">combine_fn</span><span class="o">.</span><span class="n">get_accumulator_coder</span><span class="p">()</span> |
| |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> |
| <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">coder</span><span class="p">,</span> <span class="n">Coder</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="c1"># The coder here should be for the accumulator type of the given CombineFn.</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">coder</span> <span class="o">=</span> <span class="n">coder</span> |
| |
| <div class="viewcode-block" id="CombiningValueStateSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.CombiningValueStateSpec.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="k">return</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">StateSpec</span><span class="p">(</span> |
| <span class="n">combining_spec</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">CombiningStateSpec</span><span class="p">(</span> |
| <span class="n">combine_fn</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">combine_fn</span><span class="o">.</span><span class="n">to_runner_api</span><span class="p">(</span><span class="n">context</span><span class="p">),</span> |
| <span class="n">accumulator_coder_id</span><span class="o">=</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="bp">self</span><span class="o">.</span><span class="n">coder</span><span class="p">)))</span></div></div> |
| |
| |
| <div class="viewcode-block" id="TimerSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.TimerSpec">[docs]</a><span class="k">class</span> <span class="nc">TimerSpec</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Specification for a user stateful DoFn timer."""</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">time_domain</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="k">if</span> <span class="n">time_domain</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="n">TimeDomain</span><span class="o">.</span><span class="n">WATERMARK</span><span class="p">,</span> <span class="n">TimeDomain</span><span class="o">.</span><span class="n">REAL_TIME</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Unsupported TimeDomain: </span><span class="si">%r</span><span class="s1">.'</span> <span class="o">%</span> <span class="p">(</span><span class="n">time_domain</span><span class="p">,))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">time_domain</span> <span class="o">=</span> <span class="n">time_domain</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_attached_callback</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</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="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="TimerSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.TimerSpec.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="k">return</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">TimerSpec</span><span class="p">(</span> |
| <span class="n">time_domain</span><span class="o">=</span><span class="n">TimeDomain</span><span class="o">.</span><span class="n">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_domain</span><span class="p">),</span> |
| <span class="n">timer_coder_id</span><span class="o">=</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">coders</span><span class="o">.</span><span class="n">_TimerCoder</span><span class="p">(</span><span class="n">coders</span><span class="o">.</span><span class="n">SingletonCoder</span><span class="p">(</span><span class="kc">None</span><span class="p">))))</span></div></div> |
| |
| |
| <div class="viewcode-block" id="on_timer"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.on_timer">[docs]</a><span class="k">def</span> <span class="nf">on_timer</span><span class="p">(</span><span class="n">timer_spec</span><span class="p">):</span> |
| <span class="sd">"""Decorator for timer firing DoFn method.</span> |
| |
| <span class="sd"> This decorator allows a user to specify an on_timer processing method</span> |
| <span class="sd"> in a stateful DoFn. Sample usage::</span> |
| |
| <span class="sd"> class MyDoFn(DoFn):</span> |
| <span class="sd"> TIMER_SPEC = TimerSpec('timer', TimeDomain.WATERMARK)</span> |
| |
| <span class="sd"> @on_timer(TIMER_SPEC)</span> |
| <span class="sd"> def my_timer_expiry_callback(self):</span> |
| <span class="sd"> logging.info('Timer expired!')</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">timer_spec</span><span class="p">,</span> <span class="n">TimerSpec</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'@on_timer decorator expected TimerSpec.'</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">_inner</span><span class="p">(</span><span class="n">method</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">callable</span><span class="p">(</span><span class="n">method</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'@on_timer decorator expected callable.'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'Multiple on_timer callbacks registered for </span><span class="si">%r</span><span class="s1">.'</span> <span class="o">%</span> <span class="n">timer_spec</span><span class="p">)</span> |
| <span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span> <span class="o">=</span> <span class="n">method</span> |
| <span class="k">return</span> <span class="n">method</span> |
| |
| <span class="k">return</span> <span class="n">_inner</span></div> |
| |
| |
| <div class="viewcode-block" id="get_dofn_specs"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.get_dofn_specs">[docs]</a><span class="k">def</span> <span class="nf">get_dofn_specs</span><span class="p">(</span><span class="n">dofn</span><span class="p">):</span> |
| <span class="sd">"""Gets the state and timer specs for a DoFn, if any.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> dofn (apache_beam.transforms.core.DoFn): The DoFn instance to introspect for</span> |
| <span class="sd"> timer and state specs.</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># Avoid circular import.</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.runners.common</span> <span class="k">import</span> <span class="n">MethodWrapper</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="k">import</span> <span class="n">_DoFnParam</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="k">import</span> <span class="n">_StateDoFnParam</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="k">import</span> <span class="n">_TimerDoFnParam</span> |
| |
| <span class="n">all_state_specs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> |
| <span class="n">all_timer_specs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> |
| |
| <span class="c1"># Validate params to process(), start_bundle(), finish_bundle() and to</span> |
| <span class="c1"># any on_timer callbacks.</span> |
| <span class="k">for</span> <span class="n">method_name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">dofn</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">method_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span> <span class="n">types</span><span class="o">.</span><span class="n">MethodType</span><span class="p">):</span> |
| <span class="k">continue</span> |
| <span class="n">method</span> <span class="o">=</span> <span class="n">MethodWrapper</span><span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">method_name</span><span class="p">)</span> |
| <span class="n">param_ids</span> <span class="o">=</span> <span class="p">[</span><span class="n">d</span><span class="o">.</span><span class="n">param_id</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">method</span><span class="o">.</span><span class="n">defaults</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">_DoFnParam</span><span class="p">)]</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">param_ids</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">param_ids</span><span class="p">)):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'DoFn </span><span class="si">%r</span><span class="s1"> has duplicate </span><span class="si">%s</span><span class="s1"> method parameters: </span><span class="si">%s</span><span class="s1">.'</span> <span class="o">%</span> <span class="p">(</span> |
| <span class="n">dofn</span><span class="p">,</span> <span class="n">method_name</span><span class="p">,</span> <span class="n">param_ids</span><span class="p">))</span> |
| <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">method</span><span class="o">.</span><span class="n">defaults</span><span class="p">:</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">_StateDoFnParam</span><span class="p">):</span> |
| <span class="n">all_state_specs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">state_spec</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">_TimerDoFnParam</span><span class="p">):</span> |
| <span class="n">all_timer_specs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">timer_spec</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">all_state_specs</span><span class="p">,</span> <span class="n">all_timer_specs</span></div> |
| |
| |
| <div class="viewcode-block" id="is_stateful_dofn"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.is_stateful_dofn">[docs]</a><span class="k">def</span> <span class="nf">is_stateful_dofn</span><span class="p">(</span><span class="n">dofn</span><span class="p">):</span> |
| <span class="sd">"""Determines whether a given DoFn is a stateful DoFn."""</span> |
| |
| <span class="c1"># A Stateful DoFn is a DoFn that uses user state or timers.</span> |
| <span class="n">all_state_specs</span><span class="p">,</span> <span class="n">all_timer_specs</span> <span class="o">=</span> <span class="n">get_dofn_specs</span><span class="p">(</span><span class="n">dofn</span><span class="p">)</span> |
| <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">all_state_specs</span> <span class="ow">or</span> <span class="n">all_timer_specs</span><span class="p">)</span></div> |
| |
| |
| <div class="viewcode-block" id="validate_stateful_dofn"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.validate_stateful_dofn">[docs]</a><span class="k">def</span> <span class="nf">validate_stateful_dofn</span><span class="p">(</span><span class="n">dofn</span><span class="p">):</span> |
| <span class="sd">"""Validates the proper specification of a stateful DoFn."""</span> |
| |
| <span class="c1"># Get state and timer specs.</span> |
| <span class="n">all_state_specs</span><span class="p">,</span> <span class="n">all_timer_specs</span> <span class="o">=</span> <span class="n">get_dofn_specs</span><span class="p">(</span><span class="n">dofn</span><span class="p">)</span> |
| |
| <span class="c1"># Reject DoFns that have multiple state or timer specs with the same name.</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">all_state_specs</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">all_state_specs</span><span class="p">)):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'DoFn </span><span class="si">%r</span><span class="s1"> has multiple StateSpecs with the same name: </span><span class="si">%s</span><span class="s1">.'</span> <span class="o">%</span> <span class="p">(</span> |
| <span class="n">dofn</span><span class="p">,</span> <span class="n">all_state_specs</span><span class="p">))</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">all_timer_specs</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">all_timer_specs</span><span class="p">)):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'DoFn </span><span class="si">%r</span><span class="s1"> has multiple TimerSpecs with the same name: </span><span class="si">%s</span><span class="s1">.'</span> <span class="o">%</span> <span class="p">(</span> |
| <span class="n">dofn</span><span class="p">,</span> <span class="n">all_timer_specs</span><span class="p">))</span> |
| |
| <span class="c1"># Reject DoFns that use timer specs without corresponding timer callbacks.</span> |
| <span class="k">for</span> <span class="n">timer_spec</span> <span class="ow">in</span> <span class="n">all_timer_specs</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="p">(</span><span class="s1">'DoFn </span><span class="si">%r</span><span class="s1"> has a TimerSpec without an associated on_timer '</span> |
| <span class="s1">'callback: </span><span class="si">%s</span><span class="s1">.'</span><span class="p">)</span> <span class="o">%</span> <span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">timer_spec</span><span class="p">))</span> |
| <span class="n">method_name</span> <span class="o">=</span> <span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span><span class="o">.</span><span class="vm">__name__</span> |
| <span class="k">if</span> <span class="p">(</span><span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span> <span class="o">!=</span> |
| <span class="nb">getattr</span><span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">method_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span><span class="o">.</span><span class="vm">__func__</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="p">(</span><span class="s1">'The on_timer callback for </span><span class="si">%s</span><span class="s1"> is not the specified .</span><span class="si">%s</span><span class="s1"> method '</span> |
| <span class="s1">'for DoFn </span><span class="si">%r</span><span class="s1"> (perhaps it was overwritten?).'</span><span class="p">)</span> <span class="o">%</span> <span class="p">(</span> |
| <span class="n">timer_spec</span><span class="p">,</span> <span class="n">method_name</span><span class="p">,</span> <span class="n">dofn</span><span class="p">))</span></div> |
| |
| |
| <div class="viewcode-block" id="RuntimeTimer"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.RuntimeTimer">[docs]</a><span class="k">class</span> <span class="nc">RuntimeTimer</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Timer interface object passed to user code."""</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timer_spec</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cleared</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_new_timestamp</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <div class="viewcode-block" id="RuntimeTimer.clear"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.RuntimeTimer.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</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">_cleared</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_new_timestamp</span> <span class="o">=</span> <span class="kc">None</span></div> |
| |
| <div class="viewcode-block" id="RuntimeTimer.set"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.RuntimeTimer.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_new_timestamp</span> <span class="o">=</span> <span class="n">timestamp</span></div></div> |
| |
| |
| <div class="viewcode-block" id="RuntimeState"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.RuntimeState">[docs]</a><span class="k">class</span> <span class="nc">RuntimeState</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""State interface object passed to user code."""</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state_spec</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</span> <span class="n">current_value_accessor</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_state_spec</span> <span class="o">=</span> <span class="n">state_spec</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_state_tag</span> <span class="o">=</span> <span class="n">state_tag</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_current_value_accessor</span> <span class="o">=</span> <span class="n">current_value_accessor</span> |
| |
| <div class="viewcode-block" id="RuntimeState.for_spec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.RuntimeState.for_spec">[docs]</a> <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">for_spec</span><span class="p">(</span><span class="n">state_spec</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</span> <span class="n">current_value_accessor</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">state_spec</span><span class="p">,</span> <span class="n">BagStateSpec</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">BagRuntimeState</span><span class="p">(</span><span class="n">state_spec</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</span> <span class="n">current_value_accessor</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">state_spec</span><span class="p">,</span> <span class="n">CombiningValueStateSpec</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">CombiningValueRuntimeState</span><span class="p">(</span><span class="n">state_spec</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</span> |
| <span class="n">current_value_accessor</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">'Invalid state spec: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">state_spec</span><span class="p">)</span></div> |
| |
| <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="bp">self</span><span class="o">.</span><span class="n">_state_spec</span><span class="o">.</span><span class="n">coder</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">value</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_state_spec</span><span class="o">.</span><span class="n">coder</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="RuntimeState.prefetch"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.RuntimeState.prefetch">[docs]</a> <span class="k">def</span> <span class="nf">prefetch</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># The default implementation here does nothing.</span> |
| <span class="k">pass</span></div></div> |
| |
| |
| <span class="c1"># Sentinel designating an unread value.</span> |
| <span class="n">UNREAD_VALUE</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span> |
| |
| |
| <div class="viewcode-block" id="BagRuntimeState"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.BagRuntimeState">[docs]</a><span class="k">class</span> <span class="nc">BagRuntimeState</span><span class="p">(</span><span class="n">RuntimeState</span><span class="p">):</span> |
| <span class="sd">"""Bag state interface object passed to user code."""</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state_spec</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</span> <span class="n">current_value_accessor</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">BagRuntimeState</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">state_spec</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</span> <span class="n">current_value_accessor</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_value</span> <span class="o">=</span> <span class="n">UNREAD_VALUE</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cleared</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_new_values</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <div class="viewcode-block" id="BagRuntimeState.read"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.BagRuntimeState.read">[docs]</a> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_value</span> <span class="ow">is</span> <span class="n">UNREAD_VALUE</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current_value_accessor</span><span class="p">()</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cleared</span><span class="p">:</span> |
| <span class="n">encoded_values</span> <span class="o">=</span> <span class="n">itertools</span><span class="o">.</span><span class="n">chain</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cached_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_new_values</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">encoded_values</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_new_values</span> |
| <span class="k">return</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="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">encoded_values</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="BagRuntimeState.add"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.BagRuntimeState.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_new_values</span><span class="o">.</span><span class="n">append</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> |
| |
| <div class="viewcode-block" id="BagRuntimeState.clear"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.BagRuntimeState.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</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">_cleared</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_cached_value</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_new_values</span> <span class="o">=</span> <span class="p">[]</span></div></div> |
| |
| |
| <div class="viewcode-block" id="CombiningValueRuntimeState"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.CombiningValueRuntimeState">[docs]</a><span class="k">class</span> <span class="nc">CombiningValueRuntimeState</span><span class="p">(</span><span class="n">RuntimeState</span><span class="p">):</span> |
| <span class="sd">"""Combining value state interface object passed to user code."""</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state_spec</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</span> <span class="n">current_value_accessor</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CombiningValueRuntimeState</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">state_spec</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</span> <span class="n">current_value_accessor</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_current_accumulator</span> <span class="o">=</span> <span class="n">UNREAD_VALUE</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_modified</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_combine_fn</span> <span class="o">=</span> <span class="n">state_spec</span><span class="o">.</span><span class="n">combine_fn</span> |
| |
| <span class="k">def</span> <span class="nf">_read_initial_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current_accumulator</span> <span class="ow">is</span> <span class="n">UNREAD_VALUE</span><span class="p">:</span> |
| <span class="n">existing_accumulators</span> <span class="o">=</span> <span class="nb">list</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="n">a</span><span class="p">)</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current_value_accessor</span><span class="p">())</span> |
| <span class="k">if</span> <span class="n">existing_accumulators</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_current_accumulator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_combine_fn</span><span class="o">.</span><span class="n">merge_accumulators</span><span class="p">(</span> |
| <span class="n">existing_accumulators</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_current_accumulator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_combine_fn</span><span class="o">.</span><span class="n">create_accumulator</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="CombiningValueRuntimeState.read"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.CombiningValueRuntimeState.read">[docs]</a> <span class="k">def</span> <span class="nf">read</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">_read_initial_value</span><span class="p">()</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_combine_fn</span><span class="o">.</span><span class="n">extract_output</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_current_accumulator</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="CombiningValueRuntimeState.add"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.CombiningValueRuntimeState.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_read_initial_value</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_modified</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_current_accumulator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_combine_fn</span><span class="o">.</span><span class="n">add_input</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_current_accumulator</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="CombiningValueRuntimeState.clear"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.CombiningValueRuntimeState.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</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">_modified</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_current_accumulator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_combine_fn</span><span class="o">.</span><span class="n">create_accumulator</span><span class="p">()</span></div></div> |
| |
| |
| <div class="viewcode-block" id="UserStateContext"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.UserStateContext">[docs]</a><span class="k">class</span> <span class="nc">UserStateContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Wrapper allowing user state and timers to be accessed by a DoFnInvoker."""</span> |
| |
| <div class="viewcode-block" id="UserStateContext.get_timer"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.UserStateContext.get_timer">[docs]</a> <span class="k">def</span> <span class="nf">get_timer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timer_spec</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">window</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="UserStateContext.get_state"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.UserStateContext.get_state">[docs]</a> <span class="k">def</span> <span class="nf">get_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state_spec</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">window</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="UserStateContext.commit"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.transforms.userstate.UserStateContext.commit">[docs]</a> <span class="k">def</span> <span class="nf">commit</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></div></div> |
| </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> |