pydoc/2.47.0/_modules/apache_beam/options/value_provider.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.options.value_provider &mdash; Apache Beam 2.47.0 documentation</title>


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


       <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
         <script type="text/javascript" src="../../../_static/jquery.js"></script>
         <script type="text/javascript" src="../../../_static/underscore.js"></script>
         <script type="text/javascript" src="../../../_static/doctools.js"></script>
         <script type="text/javascript" src="../../../_static/language_data.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

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


   <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
 </head>

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


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

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


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


           </a>


               <div class="version">
                 2.47.0
               </div>


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


         </div>

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


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


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

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


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

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

       </nav>


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

         <div class="rst-content">


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

   <ul class="wy-breadcrumbs">

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

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

       <li>apache_beam.options.value_provider</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.options.value_provider</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;A ValueProvider abstracts the notion of fetching a value that may or</span>
 <span class="sd">may not be currently available.</span>

 <span class="sd">This can be used to parameterize transforms that only read values in at</span>
 <span class="sd">runtime, for example.</span>
 <span class="sd">&quot;&quot;&quot;</span>

 <span class="c1"># pytype: skip-file</span>

 <span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">wraps</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Set</span>

 <span class="kn">from</span> <span class="nn">apache_beam</span> <span class="kn">import</span> <span class="n">error</span>

 <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
     <span class="s1">&#39;ValueProvider&#39;</span><span class="p">,</span>
     <span class="s1">&#39;StaticValueProvider&#39;</span><span class="p">,</span>
     <span class="s1">&#39;RuntimeValueProvider&#39;</span><span class="p">,</span>
     <span class="s1">&#39;NestedValueProvider&#39;</span><span class="p">,</span>
     <span class="s1">&#39;check_accessible&#39;</span><span class="p">,</span>
 <span class="p">]</span>


 <div class="viewcode-block" id="ValueProvider"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.ValueProvider">[docs]</a><span class="k">class</span> <span class="nc">ValueProvider</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Base class that all other ValueProviders must implement.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
 <div class="viewcode-block" id="ValueProvider.is_accessible"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.ValueProvider.is_accessible">[docs]</a>  <span class="k">def</span> <span class="nf">is_accessible</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Whether the contents of this ValueProvider is available to routines</span>
 <span class="sd">    that run at graph construction time.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
         <span class="s1">&#39;ValueProvider.is_accessible implemented in derived classes&#39;</span><span class="p">)</span></div>

 <div class="viewcode-block" id="ValueProvider.get"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.ValueProvider.get">[docs]</a>  <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the value wrapped by this ValueProvider.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
         <span class="s1">&#39;ValueProvider.get implemented in derived classes&#39;</span><span class="p">)</span></div></div>


 <div class="viewcode-block" id="StaticValueProvider"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.StaticValueProvider">[docs]</a><span class="k">class</span> <span class="nc">StaticValueProvider</span><span class="p">(</span><span class="n">ValueProvider</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;StaticValueProvider is an implementation of ValueProvider that allows</span>
 <span class="sd">  for a static value to be provided.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value_type</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Args:</span>
 <span class="sd">        value_type: Type of the static value</span>
 <span class="sd">        value: Static value</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">value_type</span> <span class="o">=</span> <span class="n">value_type</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">value_type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>

 <div class="viewcode-block" id="StaticValueProvider.is_accessible"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.StaticValueProvider.is_accessible">[docs]</a>  <span class="k">def</span> <span class="nf">is_accessible</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="kc">True</span></div>

 <div class="viewcode-block" id="StaticValueProvider.get"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.StaticValueProvider.get">[docs]</a>  <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span></div>

   <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>

   <span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">==</span> <span class="n">other</span><span class="p">:</span>
       <span class="k">return</span> <span class="kc">True</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">StaticValueProvider</span><span class="p">):</span>
       <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value_type</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">value_type</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">value</span><span class="p">):</span>
         <span class="k">return</span> <span class="kc">True</span>
     <span class="k">return</span> <span class="kc">False</span>

   <span class="k">def</span> <span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="nb">hash</span><span class="p">((</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">value_type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">))</span></div>


 <div class="viewcode-block" id="RuntimeValueProvider"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.RuntimeValueProvider">[docs]</a><span class="k">class</span> <span class="nc">RuntimeValueProvider</span><span class="p">(</span><span class="n">ValueProvider</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;RuntimeValueProvider is an implementation of ValueProvider that</span>
 <span class="sd">  allows for a value to be provided at execution time rather than</span>
 <span class="sd">  at graph construction time.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="n">runtime_options</span> <span class="o">=</span> <span class="kc">None</span>
   <span class="n">experiments</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>  <span class="c1"># type: Set[str]</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">option_name</span><span class="p">,</span> <span class="n">value_type</span><span class="p">,</span> <span class="n">default_value</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">option_name</span> <span class="o">=</span> <span class="n">option_name</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">default_value</span> <span class="o">=</span> <span class="n">default_value</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">value_type</span> <span class="o">=</span> <span class="n">value_type</span>

 <div class="viewcode-block" id="RuntimeValueProvider.is_accessible"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.RuntimeValueProvider.is_accessible">[docs]</a>  <span class="k">def</span> <span class="nf">is_accessible</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="n">RuntimeValueProvider</span><span class="o">.</span><span class="n">runtime_options</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span></div>

 <div class="viewcode-block" id="RuntimeValueProvider.get_value"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.RuntimeValueProvider.get_value">[docs]</a>  <span class="nd">@classmethod</span>
   <span class="k">def</span> <span class="nf">get_value</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">option_name</span><span class="p">,</span> <span class="n">value_type</span><span class="p">,</span> <span class="n">default_value</span><span class="p">):</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="n">RuntimeValueProvider</span><span class="o">.</span><span class="n">runtime_options</span><span class="p">:</span>
       <span class="k">return</span> <span class="n">default_value</span>

     <span class="n">candidate</span> <span class="o">=</span> <span class="n">RuntimeValueProvider</span><span class="o">.</span><span class="n">runtime_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">option_name</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">candidate</span><span class="p">:</span>
       <span class="k">return</span> <span class="n">value_type</span><span class="p">(</span><span class="n">candidate</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="k">return</span> <span class="n">default_value</span></div>

 <div class="viewcode-block" id="RuntimeValueProvider.get"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.RuntimeValueProvider.get">[docs]</a>  <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">if</span> <span class="n">RuntimeValueProvider</span><span class="o">.</span><span class="n">runtime_options</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
       <span class="k">raise</span> <span class="n">error</span><span class="o">.</span><span class="n">RuntimeValueProviderError</span><span class="p">(</span>
           <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">.get() not called from a runtime context&#39;</span> <span class="o">%</span> <span class="bp">self</span><span class="p">)</span>

     <span class="k">return</span> <span class="n">RuntimeValueProvider</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">option_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">value_type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_value</span><span class="p">)</span></div>

 <div class="viewcode-block" id="RuntimeValueProvider.set_runtime_options"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.RuntimeValueProvider.set_runtime_options">[docs]</a>  <span class="nd">@classmethod</span>
   <span class="k">def</span> <span class="nf">set_runtime_options</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">pipeline_options</span><span class="p">):</span>
     <span class="n">RuntimeValueProvider</span><span class="o">.</span><span class="n">runtime_options</span> <span class="o">=</span> <span class="n">pipeline_options</span>
     <span class="n">RuntimeValueProvider</span><span class="o">.</span><span class="n">experiments</span> <span class="o">=</span> <span class="n">RuntimeValueProvider</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span>
         <span class="s1">&#39;experiments&#39;</span><span class="p">,</span> <span class="nb">set</span><span class="p">,</span> <span class="nb">set</span><span class="p">())</span></div>

   <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">(option: </span><span class="si">%s</span><span class="s1">, type: </span><span class="si">%s</span><span class="s1">, default_value: </span><span class="si">%s</span><span class="s1">)&#39;</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">option_name</span><span class="p">,</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">value_type</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span>
         <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">default_value</span><span class="p">))</span></div>


 <div class="viewcode-block" id="NestedValueProvider"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.NestedValueProvider">[docs]</a><span class="k">class</span> <span class="nc">NestedValueProvider</span><span class="p">(</span><span class="n">ValueProvider</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;NestedValueProvider is an implementation of ValueProvider that allows</span>
 <span class="sd">  for wrapping another ValueProvider object.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">translator</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Creates a NestedValueProvider that wraps the provided ValueProvider.</span>

 <span class="sd">    Args:</span>
 <span class="sd">      value: ValueProvider object to wrap</span>
 <span class="sd">      translator: function that is applied to the ValueProvider</span>
 <span class="sd">    Raises:</span>
 <span class="sd">      ``RuntimeValueProviderError``: if any of the provided objects are not</span>
 <span class="sd">        accessible.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">value</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">translator</span> <span class="o">=</span> <span class="n">translator</span>

 <div class="viewcode-block" id="NestedValueProvider.is_accessible"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.NestedValueProvider.is_accessible">[docs]</a>  <span class="k">def</span> <span class="nf">is_accessible</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">is_accessible</span><span class="p">()</span></div>

 <div class="viewcode-block" id="NestedValueProvider.get"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.NestedValueProvider.get">[docs]</a>  <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">try</span><span class="p">:</span>
       <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cached_value</span>
     <span class="k">except</span> <span class="ne">AttributeError</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">translator</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">get</span><span class="p">())</span>
       <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cached_value</span></div>

   <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="s2">&quot;</span><span class="si">%s</span><span class="s2">(value: </span><span class="si">%s</span><span class="s2">, translator: </span><span class="si">%s</span><span class="s2">)&quot;</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">value</span><span class="p">,</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">translator</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span>
     <span class="p">)</span></div>


 <div class="viewcode-block" id="check_accessible"><a class="viewcode-back" href="../../../apache_beam.options.value_provider.html#apache_beam.options.value_provider.check_accessible">[docs]</a><span class="k">def</span> <span class="nf">check_accessible</span><span class="p">(</span><span class="n">value_provider_list</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A decorator that checks accessibility of a list of ValueProvider objects.</span>

 <span class="sd">  Args:</span>
 <span class="sd">    value_provider_list: list of ValueProvider objects</span>
 <span class="sd">  Raises:</span>
 <span class="sd">    ``RuntimeValueProviderError``: if any of the provided objects are not</span>
 <span class="sd">      accessible.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value_provider_list</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">_check_accessible</span><span class="p">(</span><span class="n">fnc</span><span class="p">):</span>
     <span class="nd">@wraps</span><span class="p">(</span><span class="n">fnc</span><span class="p">)</span>
     <span class="k">def</span> <span class="nf">_f</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
       <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="p">[</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vp</span><span class="p">)</span> <span class="k">for</span> <span class="n">vp</span> <span class="ow">in</span> <span class="n">value_provider_list</span><span class="p">]:</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="n">obj</span><span class="o">.</span><span class="n">is_accessible</span><span class="p">():</span>
           <span class="k">raise</span> <span class="n">error</span><span class="o">.</span><span class="n">RuntimeValueProviderError</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%s</span><span class="s1"> not accessible&#39;</span> <span class="o">%</span> <span class="n">obj</span><span class="p">)</span>
       <span class="k">return</span> <span class="n">fnc</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>

     <span class="k">return</span> <span class="n">_f</span>

   <span class="k">return</span> <span class="n">_check_accessible</span></div>
 </pre></div>

            </div>

           </div>
           <footer>


   <hr/>

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

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

 </footer>

         </div>
       </div>

     </section>

   </div>


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


 </body>
 </html>