pydoc/2.47.0/_modules/apache_beam/runners/interactive/messaging/interactive_environment_inspector.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.interactive.messaging.interactive_environment_inspector &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.runners.interactive.messaging.interactive_environment_inspector</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.interactive.messaging.interactive_environment_inspector</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;Messaging mechanism to inspect the interactive environment.</span>

 <span class="sd">A singleton instance is accessible from</span>
 <span class="sd">interactive_environment.current_env().inspector.</span>
 <span class="sd">&quot;&quot;&quot;</span>
 <span class="c1"># pytype: skip-file</span>

 <span class="kn">import</span> <span class="nn">apache_beam</span> <span class="k">as</span> <span class="nn">beam</span>
 <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive.utils</span> <span class="kn">import</span> <span class="n">as_json</span>
 <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive.utils</span> <span class="kn">import</span> <span class="n">obfuscate</span>


 <div class="viewcode-block" id="InteractiveEnvironmentInspector"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.messaging.interactive_environment_inspector.html#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector">[docs]</a><span class="k">class</span> <span class="nc">InteractiveEnvironmentInspector</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Inspector that converts information of the current interactive environment</span>
 <span class="sd">  including pipelines and pcollections into JSON data suitable for messaging</span>
 <span class="sd">  with applications within/outside the Python kernel.</span>

 <span class="sd">  The usage is always that the application side reads the inspectables or</span>
 <span class="sd">  list_inspectables first then communicates back to the kernel and get_val for</span>
 <span class="sd">  usage on the kernel side.</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">ignore_synthetic</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_inspectables</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_anonymous</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_inspectable_pipelines</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_ignore_synthetic</span> <span class="o">=</span> <span class="n">ignore_synthetic</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_clusters</span> <span class="o">=</span> <span class="p">{}</span>

   <span class="nd">@property</span>
   <span class="k">def</span> <span class="nf">inspectables</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Lists pipelines and pcollections assigned to variables as inspectables.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_inspectables</span> <span class="o">=</span> <span class="n">inspect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ignore_synthetic</span><span class="p">)</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_inspectables</span>

   <span class="nd">@property</span>
   <span class="k">def</span> <span class="nf">inspectable_pipelines</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns a dictionary of all inspectable pipelines. The keys are</span>
 <span class="sd">    stringified id of pipeline instances.</span>

 <span class="sd">    This includes user defined pipeline assigned to variables and anonymous</span>
 <span class="sd">    pipelines with inspectable PCollections.</span>
 <span class="sd">    If a user defined pipeline is not within the returned dict, it can be</span>
 <span class="sd">    considered out of scope, and all resources and memory states related to it</span>
 <span class="sd">    should be released.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">list_inspectables</span><span class="p">()</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_inspectable_pipelines</span>

   <span class="nd">@as_json</span>
   <span class="k">def</span> <span class="nf">list_inspectables</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Lists inspectables in JSON format.</span>

 <span class="sd">    When listing, pcollections are organized by the pipeline they belong to.</span>
 <span class="sd">    If a pipeline is no longer assigned to a variable but its pcollections</span>
 <span class="sd">    assigned to variables are still in scope, the pipeline will be given a name</span>
 <span class="sd">    as &#39;anonymous_pipeline[id:$inMemoryId]&#39;.</span>
 <span class="sd">    The listing doesn&#39;t contain object values of the pipelines or pcollections.</span>
 <span class="sd">    The obfuscated identifier can be used to trace back to those values in the</span>
 <span class="sd">    kernel.</span>
 <span class="sd">    The listing includes anonymous pipelines that are not assigned to variables</span>
 <span class="sd">    but still containing inspectable PCollections.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">listing</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="n">pipelines</span> <span class="o">=</span> <span class="n">inspect_pipelines</span><span class="p">()</span>
     <span class="k">for</span> <span class="n">pipeline</span><span class="p">,</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">pipelines</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
       <span class="n">metadata</span> <span class="o">=</span> <span class="n">meta</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">pipeline</span><span class="p">)</span>
       <span class="n">listing</span><span class="p">[</span><span class="n">obfuscate</span><span class="p">(</span><span class="n">metadata</span><span class="p">)]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;metadata&#39;</span><span class="p">:</span> <span class="n">metadata</span><span class="p">,</span> <span class="s1">&#39;pcolls&#39;</span><span class="p">:</span> <span class="p">{}}</span>
     <span class="k">for</span> <span class="n">identifier</span><span class="p">,</span> <span class="n">inspectable</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">inspectables</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
       <span class="k">if</span> <span class="n">inspectable</span><span class="p">[</span><span class="s1">&#39;metadata&#39;</span><span class="p">][</span><span class="s1">&#39;type&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;pcollection&#39;</span><span class="p">:</span>
         <span class="n">pipeline</span> <span class="o">=</span> <span class="n">inspectable</span><span class="p">[</span><span class="s1">&#39;value&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">pipeline</span>
         <span class="k">if</span> <span class="n">pipeline</span> <span class="ow">not</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="n">pipelines</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
           <span class="n">pipeline_name</span> <span class="o">=</span> <span class="n">synthesize_pipeline_name</span><span class="p">(</span><span class="n">pipeline</span><span class="p">)</span>
           <span class="n">pipelines</span><span class="p">[</span><span class="n">pipeline</span><span class="p">]</span> <span class="o">=</span> <span class="n">pipeline_name</span>
           <span class="n">pipeline_metadata</span> <span class="o">=</span> <span class="n">meta</span><span class="p">(</span><span class="n">pipeline_name</span><span class="p">,</span> <span class="n">pipeline</span><span class="p">)</span>
           <span class="n">pipeline_identifier</span> <span class="o">=</span> <span class="n">obfuscate</span><span class="p">(</span><span class="n">pipeline_metadata</span><span class="p">)</span>
           <span class="bp">self</span><span class="o">.</span><span class="n">_anonymous</span><span class="p">[</span><span class="n">pipeline_identifier</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
               <span class="s1">&#39;metadata&#39;</span><span class="p">:</span> <span class="n">pipeline_metadata</span><span class="p">,</span> <span class="s1">&#39;value&#39;</span><span class="p">:</span> <span class="n">pipeline</span>
           <span class="p">}</span>
           <span class="n">listing</span><span class="p">[</span><span class="n">pipeline_identifier</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
               <span class="s1">&#39;metadata&#39;</span><span class="p">:</span> <span class="n">pipeline_metadata</span><span class="p">,</span>
               <span class="s1">&#39;pcolls&#39;</span><span class="p">:</span> <span class="p">{</span>
                   <span class="n">identifier</span><span class="p">:</span> <span class="n">inspectable</span><span class="p">[</span><span class="s1">&#39;metadata&#39;</span><span class="p">]</span>
               <span class="p">}</span>
           <span class="p">}</span>
         <span class="k">else</span><span class="p">:</span>
           <span class="n">pipeline_identifier</span> <span class="o">=</span> <span class="n">obfuscate</span><span class="p">(</span><span class="n">meta</span><span class="p">(</span><span class="n">pipelines</span><span class="p">[</span><span class="n">pipeline</span><span class="p">],</span> <span class="n">pipeline</span><span class="p">))</span>
           <span class="n">listing</span><span class="p">[</span><span class="n">pipeline_identifier</span><span class="p">][</span><span class="s1">&#39;pcolls&#39;</span><span class="p">][</span><span class="n">identifier</span><span class="p">]</span> <span class="o">=</span> <span class="n">inspectable</span><span class="p">[</span>
               <span class="s1">&#39;metadata&#39;</span><span class="p">]</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_inspectable_pipelines</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
         <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="nb">id</span><span class="p">(</span><span class="n">pipeline</span><span class="p">)),</span> <span class="n">pipeline</span><span class="p">)</span> <span class="k">for</span> <span class="n">pipeline</span> <span class="ow">in</span> <span class="n">pipelines</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">listing</span>

 <div class="viewcode-block" id="InteractiveEnvironmentInspector.get_val"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.messaging.interactive_environment_inspector.html#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.get_val">[docs]</a>  <span class="k">def</span> <span class="nf">get_val</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">identifier</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Retrieves the in memory object itself by identifier.</span>

 <span class="sd">    The retrieved object could be a pipeline or a pcollection. If the</span>
 <span class="sd">    identifier is not recognized, return None.</span>
 <span class="sd">    The identifier can refer to an anonymous pipeline and the object will still</span>
 <span class="sd">    be retrieved.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">inspectable</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_inspectables</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">inspectable</span><span class="p">:</span>
       <span class="k">return</span> <span class="n">inspectable</span><span class="p">[</span><span class="s1">&#39;value&#39;</span><span class="p">]</span>
     <span class="n">inspectable</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_anonymous</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">inspectable</span><span class="p">:</span>
       <span class="k">return</span> <span class="n">inspectable</span><span class="p">[</span><span class="s1">&#39;value&#39;</span><span class="p">]</span>
     <span class="k">return</span> <span class="kc">None</span></div>

 <div class="viewcode-block" id="InteractiveEnvironmentInspector.get_pcoll_data"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.messaging.interactive_environment_inspector.html#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.get_pcoll_data">[docs]</a>  <span class="k">def</span> <span class="nf">get_pcoll_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">identifier</span><span class="p">,</span> <span class="n">include_window_info</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Retrieves the json formatted PCollection data.</span>

 <span class="sd">    If no PCollection value can be retieved from the given identifier, an empty</span>
 <span class="sd">    json string will be returned.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_val</span><span class="p">(</span><span class="n">identifier</span><span class="p">)</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">beam</span><span class="o">.</span><span class="n">pvalue</span><span class="o">.</span><span class="n">PCollection</span><span class="p">):</span>
       <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive</span> <span class="kn">import</span> <span class="n">interactive_beam</span> <span class="k">as</span> <span class="n">ib</span>
       <span class="n">dataframe</span> <span class="o">=</span> <span class="n">ib</span><span class="o">.</span><span class="n">collect</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">include_window_info</span><span class="o">=</span><span class="n">include_window_info</span><span class="p">)</span>
       <span class="k">return</span> <span class="n">dataframe</span><span class="o">.</span><span class="n">to_json</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s1">&#39;table&#39;</span><span class="p">)</span>
     <span class="k">return</span> <span class="p">{}</span></div>

   <span class="nd">@as_json</span>
   <span class="k">def</span> <span class="nf">list_clusters</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Retrieves information for all clusters as a json.</span>

 <span class="sd">    The json object maps a unique obfuscated identifier of a cluster to</span>
 <span class="sd">    the corresponding cluster_name, project, region, master_url, dashboard,</span>
 <span class="sd">    and pipelines. Furthermore, copies the mapping to self._clusters.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive</span> <span class="kn">import</span> <span class="n">interactive_environment</span> <span class="k">as</span> <span class="n">ie</span>

     <span class="n">clusters</span> <span class="o">=</span> <span class="n">ie</span><span class="o">.</span><span class="n">current_env</span><span class="p">()</span><span class="o">.</span><span class="n">clusters</span>
     <span class="n">all_cluster_data</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="k">for</span> <span class="n">meta</span><span class="p">,</span> <span class="n">dcm</span> <span class="ow">in</span> <span class="n">clusters</span><span class="o">.</span><span class="n">dataproc_cluster_managers</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
       <span class="n">all_cluster_data</span><span class="p">[</span><span class="n">obfuscate</span><span class="p">(</span><span class="n">meta</span><span class="p">)]</span> <span class="o">=</span> <span class="p">{</span>
           <span class="s1">&#39;cluster_name&#39;</span><span class="p">:</span> <span class="n">meta</span><span class="o">.</span><span class="n">cluster_name</span><span class="p">,</span>
           <span class="s1">&#39;project&#39;</span><span class="p">:</span> <span class="n">meta</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span>
           <span class="s1">&#39;region&#39;</span><span class="p">:</span> <span class="n">meta</span><span class="o">.</span><span class="n">region</span><span class="p">,</span>
           <span class="s1">&#39;master_url&#39;</span><span class="p">:</span> <span class="n">meta</span><span class="o">.</span><span class="n">master_url</span><span class="p">,</span>
           <span class="s1">&#39;dashboard&#39;</span><span class="p">:</span> <span class="n">meta</span><span class="o">.</span><span class="n">dashboard</span><span class="p">,</span>
           <span class="s1">&#39;pipelines&#39;</span><span class="p">:</span> <span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="nb">id</span><span class="p">(</span><span class="n">p</span><span class="p">))</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">dcm</span><span class="o">.</span><span class="n">pipelines</span><span class="p">]</span>
       <span class="p">}</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_clusters</span> <span class="o">=</span> <span class="n">all_cluster_data</span>
     <span class="k">return</span> <span class="n">all_cluster_data</span>

 <div class="viewcode-block" id="InteractiveEnvironmentInspector.get_cluster_master_url"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.messaging.interactive_environment_inspector.html#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.get_cluster_master_url">[docs]</a>  <span class="k">def</span> <span class="nf">get_cluster_master_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">identifier</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns the master_url corresponding to the obfuscated identifier.&quot;&quot;&quot;</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clusters</span><span class="p">[</span><span class="n">identifier</span><span class="p">][</span><span class="s1">&#39;master_url&#39;</span><span class="p">]</span>  <span class="c1"># Guaranteed to exist.</span></div></div>


 <div class="viewcode-block" id="inspect"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.messaging.interactive_environment_inspector.html#apache_beam.runners.interactive.messaging.interactive_environment_inspector.inspect">[docs]</a><span class="k">def</span> <span class="nf">inspect</span><span class="p">(</span><span class="n">ignore_synthetic</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Inspects current interactive environment to track metadata and values of</span>
 <span class="sd">  pipelines and pcollections.</span>

 <span class="sd">  Each pipeline and pcollections tracked is given a unique identifier.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive</span> <span class="kn">import</span> <span class="n">interactive_environment</span> <span class="k">as</span> <span class="n">ie</span>

   <span class="n">inspectables</span> <span class="o">=</span> <span class="p">{}</span>
   <span class="k">for</span> <span class="n">watching</span> <span class="ow">in</span> <span class="n">ie</span><span class="o">.</span><span class="n">current_env</span><span class="p">()</span><span class="o">.</span><span class="n">watching</span><span class="p">():</span>
     <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">watching</span><span class="p">:</span>
       <span class="c1"># Ignore synthetic vars created by Interactive Beam itself.</span>
       <span class="k">if</span> <span class="n">ignore_synthetic</span> <span class="ow">and</span> <span class="n">name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;synthetic_var_&#39;</span><span class="p">):</span>
         <span class="k">continue</span>
       <span class="n">metadata</span> <span class="o">=</span> <span class="n">meta</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
       <span class="n">identifier</span> <span class="o">=</span> <span class="n">obfuscate</span><span class="p">(</span><span class="n">metadata</span><span class="p">)</span>
       <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">pipeline</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">,</span> <span class="n">beam</span><span class="o">.</span><span class="n">pvalue</span><span class="o">.</span><span class="n">PCollection</span><span class="p">)):</span>
         <span class="n">inspectables</span><span class="p">[</span><span class="n">identifier</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;metadata&#39;</span><span class="p">:</span> <span class="n">metadata</span><span class="p">,</span> <span class="s1">&#39;value&#39;</span><span class="p">:</span> <span class="n">value</span><span class="p">}</span>
   <span class="k">return</span> <span class="n">inspectables</span></div>


 <div class="viewcode-block" id="inspect_pipelines"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.messaging.interactive_environment_inspector.html#apache_beam.runners.interactive.messaging.interactive_environment_inspector.inspect_pipelines">[docs]</a><span class="k">def</span> <span class="nf">inspect_pipelines</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Inspects current interactive environment to track all pipelines assigned</span>
 <span class="sd">  to variables. The keys are pipeline objects and values are pipeline names.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="kn">from</span> <span class="nn">apache_beam.runners.interactive</span> <span class="kn">import</span> <span class="n">interactive_environment</span> <span class="k">as</span> <span class="n">ie</span>

   <span class="n">pipelines</span> <span class="o">=</span> <span class="p">{}</span>
   <span class="k">for</span> <span class="n">watching</span> <span class="ow">in</span> <span class="n">ie</span><span class="o">.</span><span class="n">current_env</span><span class="p">()</span><span class="o">.</span><span class="n">watching</span><span class="p">():</span>
     <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">watching</span><span class="p">:</span>
       <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">beam</span><span class="o">.</span><span class="n">pipeline</span><span class="o">.</span><span class="n">Pipeline</span><span class="p">):</span>
         <span class="n">pipelines</span><span class="p">[</span><span class="n">value</span><span class="p">]</span> <span class="o">=</span> <span class="n">name</span>
   <span class="k">return</span> <span class="n">pipelines</span></div>


 <div class="viewcode-block" id="meta"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.messaging.interactive_environment_inspector.html#apache_beam.runners.interactive.messaging.interactive_environment_inspector.meta">[docs]</a><span class="k">def</span> <span class="nf">meta</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">val</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Generates meta data for the given name and value.&quot;&quot;&quot;</span>
   <span class="k">return</span> <span class="p">{</span>
       <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="n">name</span><span class="p">,</span> <span class="s1">&#39;inMemoryId&#39;</span><span class="p">:</span> <span class="nb">id</span><span class="p">(</span><span class="n">val</span><span class="p">),</span> <span class="s1">&#39;type&#39;</span><span class="p">:</span> <span class="nb">type</span><span class="p">(</span><span class="n">val</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
   <span class="p">}</span></div>


 <div class="viewcode-block" id="synthesize_pipeline_name"><a class="viewcode-back" href="../../../../../apache_beam.runners.interactive.messaging.interactive_environment_inspector.html#apache_beam.runners.interactive.messaging.interactive_environment_inspector.synthesize_pipeline_name">[docs]</a><span class="k">def</span> <span class="nf">synthesize_pipeline_name</span><span class="p">(</span><span class="n">val</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Synthesizes a pipeline name for the given pipeline object.&quot;&quot;&quot;</span>
   <span class="k">return</span> <span class="s1">&#39;anonymous_pipeline[id:</span><span class="si">{}</span><span class="s1">]&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">id</span><span class="p">(</span><span class="n">val</span><span class="p">))</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>