pydoc/2.8.0/_modules/apache_beam/runners/direct/direct_userstate.html - beam-site - Git at Google



 <!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.runners.direct.direct_userstate &mdash; Apache Beam  documentation</title>


     <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />


         <link rel="index" title="Index"
               href="../../../../genindex.html"/>
         <link rel="search" title="Search" href="../../../../search.html"/>
     <link rel="top" title="Apache Beam  documentation" href="../../../../index.html"/>
         <link rel="up" title="Module code" href="../../../index.html"/>


   <script src="../../../../_static/js/modernizr.min.js"></script>

 </head>

 <body class="wy-body-for-nav" role="document">


   <div class="wy-grid-for-nav">


     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search">


             <a href="../../../../index.html" class="icon icon-home"> Apache Beam


           </a>


 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.internal.html">apache_beam.internal package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.tools.html">apache_beam.tools package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.utils.html">apache_beam.utils package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.version.html">apache_beam.version module</a></li>
 </ul>


         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">

           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../../../../index.html">Apache Beam</a>

       </nav>


       <div class="wy-nav-content">
         <div class="rst-content">


 <div role="navigation" aria-label="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="../../../../index.html">Docs</a> &raquo;</li>

           <li><a href="../../../index.html">Module code</a> &raquo;</li>

       <li>apache_beam.runners.direct.direct_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.runners.direct.direct_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 &quot;License&quot;); you may not use this file except in compliance with</span>
 <span class="c1"># the License.  You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
 <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 <span class="c1">#</span>

 <span class="sd">&quot;&quot;&quot;Support for user state in the BundleBasedDirectRunner.&quot;&quot;&quot;</span>
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>

 <span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="k">import</span> <span class="n">userstate</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms.trigger</span> <span class="k">import</span> <span class="n">_ListStateTag</span>


 <div class="viewcode-block" id="DirectUserStateContext"><a class="viewcode-back" href="../../../../apache_beam.runners.direct.direct_userstate.html#apache_beam.runners.direct.direct_userstate.DirectUserStateContext">[docs]</a><span class="k">class</span> <span class="nc">DirectUserStateContext</span><span class="p">(</span><span class="n">userstate</span><span class="o">.</span><span class="n">UserStateContext</span><span class="p">):</span>
   <span class="sd">&quot;&quot;&quot;userstate.UserStateContext for the BundleBasedDirectRunner.</span>

 <span class="sd">  The DirectUserStateContext buffers up updates that are to be committed</span>
 <span class="sd">  by the TransformEvaluator after running a DoFn.</span>
 <span class="sd">  &quot;&quot;&quot;</span>

   <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step_context</span><span class="p">,</span> <span class="n">dofn</span><span class="p">,</span> <span class="n">key_coder</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">step_context</span> <span class="o">=</span> <span class="n">step_context</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">dofn</span> <span class="o">=</span> <span class="n">dofn</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">key_coder</span> <span class="o">=</span> <span class="n">key_coder</span>

     <span class="bp">self</span><span class="o">.</span><span class="n">all_state_specs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_timer_specs</span> <span class="o">=</span> <span class="p">(</span>
         <span class="n">userstate</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="bp">self</span><span class="o">.</span><span class="n">state_tags</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="k">for</span> <span class="n">state_spec</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_state_specs</span><span class="p">:</span>
       <span class="n">state_key</span> <span class="o">=</span> <span class="s1">&#39;user/</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">state_spec</span><span class="o">.</span><span class="n">name</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">userstate</span><span class="o">.</span><span class="n">BagStateSpec</span><span class="p">):</span>
         <span class="n">state_tag</span> <span class="o">=</span> <span class="n">_ListStateTag</span><span class="p">(</span><span class="n">state_key</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">userstate</span><span class="o">.</span><span class="n">CombiningValueStateSpec</span><span class="p">):</span>
         <span class="n">state_tag</span> <span class="o">=</span> <span class="n">_ListStateTag</span><span class="p">(</span><span class="n">state_key</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">&#39;Invalid state spec: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">state_spec</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">state_tags</span><span class="p">[</span><span class="n">state_spec</span><span class="p">]</span> <span class="o">=</span> <span class="n">state_tag</span>

     <span class="bp">self</span><span class="o">.</span><span class="n">cached_states</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">cached_timers</span> <span class="o">=</span> <span class="p">{}</span>

 <div class="viewcode-block" id="DirectUserStateContext.get_timer"><a class="viewcode-back" href="../../../../apache_beam.runners.direct.direct_userstate.html#apache_beam.runners.direct.direct_userstate.DirectUserStateContext.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">assert</span> <span class="n">timer_spec</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_timer_specs</span>
     <span class="n">encoded_key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">key_coder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
     <span class="n">cache_key</span> <span class="o">=</span> <span class="p">(</span><span class="n">encoded_key</span><span class="p">,</span> <span class="n">window</span><span class="p">,</span> <span class="n">timer_spec</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">cache_key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cached_timers</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">cached_timers</span><span class="p">[</span><span class="n">cache_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">userstate</span><span class="o">.</span><span class="n">RuntimeTimer</span><span class="p">(</span><span class="n">timer_spec</span><span class="p">)</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cached_timers</span><span class="p">[</span><span class="n">cache_key</span><span class="p">]</span></div>

 <div class="viewcode-block" id="DirectUserStateContext.get_state"><a class="viewcode-back" href="../../../../apache_beam.runners.direct.direct_userstate.html#apache_beam.runners.direct.direct_userstate.DirectUserStateContext.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">assert</span> <span class="n">state_spec</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_state_specs</span>
     <span class="n">encoded_key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">key_coder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
     <span class="n">cache_key</span> <span class="o">=</span> <span class="p">(</span><span class="n">encoded_key</span><span class="p">,</span> <span class="n">window</span><span class="p">,</span> <span class="n">state_spec</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">cache_key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cached_states</span><span class="p">:</span>
       <span class="n">state_tag</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">state_tags</span><span class="p">[</span><span class="n">state_spec</span><span class="p">]</span>
       <span class="n">value_accessor</span> <span class="o">=</span> <span class="p">(</span>
           <span class="k">lambda</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_underlying_state</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="bp">self</span><span class="o">.</span><span class="n">cached_states</span><span class="p">[</span><span class="n">cache_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">userstate</span><span class="o">.</span><span class="n">RuntimeState</span><span class="o">.</span><span class="n">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">value_accessor</span><span class="p">)</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cached_states</span><span class="p">[</span><span class="n">cache_key</span><span class="p">]</span></div>

   <span class="k">def</span> <span class="nf">_get_underlying_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="n">state_tag</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">state_tags</span><span class="p">[</span><span class="n">state_spec</span><span class="p">]</span>
     <span class="n">encoded_key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">key_coder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">key</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="n">step_context</span><span class="o">.</span><span class="n">get_keyed_state</span><span class="p">(</span><span class="n">encoded_key</span><span class="p">)</span>
             <span class="o">.</span><span class="n">get_state</span><span class="p">(</span><span class="n">window</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">))</span>

 <div class="viewcode-block" id="DirectUserStateContext.commit"><a class="viewcode-back" href="../../../../apache_beam.runners.direct.direct_userstate.html#apache_beam.runners.direct.direct_userstate.DirectUserStateContext.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="c1"># Commit state modifications.</span>
     <span class="k">for</span> <span class="n">cache_key</span><span class="p">,</span> <span class="n">runtime_state</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cached_states</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
       <span class="n">encoded_key</span><span class="p">,</span> <span class="n">window</span><span class="p">,</span> <span class="n">state_spec</span> <span class="o">=</span> <span class="n">cache_key</span>
       <span class="n">state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">step_context</span><span class="o">.</span><span class="n">get_keyed_state</span><span class="p">(</span><span class="n">encoded_key</span><span class="p">)</span>
       <span class="n">state_tag</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">state_tags</span><span class="p">[</span><span class="n">state_spec</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">userstate</span><span class="o">.</span><span class="n">BagStateSpec</span><span class="p">):</span>
         <span class="k">if</span> <span class="n">runtime_state</span><span class="o">.</span><span class="n">_cleared</span><span class="p">:</span>
           <span class="n">state</span><span class="o">.</span><span class="n">clear_state</span><span class="p">(</span><span class="n">window</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">)</span>
         <span class="k">for</span> <span class="n">new_value</span> <span class="ow">in</span> <span class="n">runtime_state</span><span class="o">.</span><span class="n">_new_values</span><span class="p">:</span>
           <span class="n">state</span><span class="o">.</span><span class="n">add_state</span><span class="p">(</span><span class="n">window</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</span> <span class="n">new_value</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">userstate</span><span class="o">.</span><span class="n">CombiningValueStateSpec</span><span class="p">):</span>
         <span class="k">if</span> <span class="n">runtime_state</span><span class="o">.</span><span class="n">_modified</span><span class="p">:</span>
           <span class="n">state</span><span class="o">.</span><span class="n">clear_state</span><span class="p">(</span><span class="n">window</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">)</span>
           <span class="n">state</span><span class="o">.</span><span class="n">add_state</span><span class="p">(</span>
               <span class="n">window</span><span class="p">,</span> <span class="n">state_tag</span><span class="p">,</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">runtime_state</span><span class="o">.</span><span class="n">_current_accumulator</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">&#39;Invalid state spec: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">state_spec</span><span class="p">)</span>

     <span class="c1"># Commit new timers.</span>
     <span class="k">for</span> <span class="n">cache_key</span><span class="p">,</span> <span class="n">runtime_timer</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cached_timers</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
       <span class="n">encoded_key</span><span class="p">,</span> <span class="n">window</span><span class="p">,</span> <span class="n">timer_spec</span> <span class="o">=</span> <span class="n">cache_key</span>
       <span class="n">state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">step_context</span><span class="o">.</span><span class="n">get_keyed_state</span><span class="p">(</span><span class="n">encoded_key</span><span class="p">)</span>
       <span class="n">timer_name</span> <span class="o">=</span> <span class="s1">&#39;user/</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">timer_spec</span><span class="o">.</span><span class="n">name</span>
       <span class="k">if</span> <span class="n">runtime_timer</span><span class="o">.</span><span class="n">_cleared</span><span class="p">:</span>
         <span class="n">state</span><span class="o">.</span><span class="n">clear_timer</span><span class="p">(</span><span class="n">window</span><span class="p">,</span> <span class="n">timer_name</span><span class="p">,</span> <span class="n">timer_spec</span><span class="o">.</span><span class="n">time_domain</span><span class="p">)</span>
       <span class="k">if</span> <span class="n">runtime_timer</span><span class="o">.</span><span class="n">_new_timestamp</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
         <span class="c1"># TODO(ccy): add corresponding watermark holds after the DirectRunner</span>
         <span class="c1"># allows for keyed watermark holds.</span>
         <span class="n">state</span><span class="o">.</span><span class="n">set_timer</span><span class="p">(</span><span class="n">window</span><span class="p">,</span> <span class="n">timer_name</span><span class="p">,</span> <span class="n">timer_spec</span><span class="o">.</span><span class="n">time_domain</span><span class="p">,</span>
                         <span class="n">runtime_timer</span><span class="o">.</span><span class="n">_new_timestamp</span><span class="p">)</span></div></div>
 </pre></div>

            </div>
            <div class="articleComments">

            </div>
           </div>
           <footer>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright .

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../../',
             VERSION:'',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true,
             SOURCELINK_SUFFIX: '.txt'
         };
     </script>
       <script type="text/javascript" src="../../../../_static/jquery.js"></script>
       <script type="text/javascript" src="../../../../_static/underscore.js"></script>
       <script type="text/javascript" src="../../../../_static/doctools.js"></script>


     <script type="text/javascript" src="../../../../_static/js/theme.js"></script>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>


 </body>
 </html>