pydoc/2.35.0/apache_beam.runners.interactive.utils.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.utils module &mdash; Apache Beam  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" />
     <link rel="next" title="apache_beam.runners.job package" href="apache_beam.runners.job.html" />
     <link rel="prev" title="apache_beam.runners.interactive.user_pipeline_tracker module" href="apache_beam.runners.interactive.user_pipeline_tracker.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 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 class="current">
 <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 current"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li>
 <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a><ul class="current">
 <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.interactive.html#submodules">Submodules</a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 </ul>


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

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


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

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

       </nav>


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

         <div class="rst-content">


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

   <ul class="wy-breadcrumbs">

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

           <li><a href="apache_beam.runners.html">apache_beam.runners package</a> &raquo;</li>

           <li><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a> &raquo;</li>

       <li>apache_beam.runners.interactive.utils module</li>


       <li class="wy-breadcrumbs-aside">


             <a href="_sources/apache_beam.runners.interactive.utils.rst.txt" rel="nofollow"> View page source</a>


       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <div class="section" id="module-apache_beam.runners.interactive.utils">
 <span id="apache-beam-runners-interactive-utils-module"></span><h1>apache_beam.runners.interactive.utils module<a class="headerlink" href="#module-apache_beam.runners.interactive.utils" title="Permalink to this headline">¶</a></h1>
 <p>Utilities to be used in  Interactive Beam.</p>
 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.to_element_list">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">to_element_list</code><span class="sig-paren">(</span><em>reader</em>, <em>coder</em>, <em>include_window_info</em>, <em>n=None</em>, <em>include_time_events=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#to_element_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.to_element_list" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns an iterator that properly decodes the elements from the reader.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.elements_to_df">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">elements_to_df</code><span class="sig-paren">(</span><em>elements</em>, <em>include_window_info=False</em>, <em>element_type=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#elements_to_df"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.elements_to_df" title="Permalink to this definition">¶</a></dt>
 <dd><p>Parses the given elements into a Dataframe.</p>
 <p>If the elements are a list of WindowedValues, then it will break out the
 elements into their own DataFrame and return it. If include_window_info is
 True, then it will concatenate the windowing information onto the elements
 DataFrame.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.register_ipython_log_handler">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">register_ipython_log_handler</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#register_ipython_log_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.register_ipython_log_handler" title="Permalink to this definition">¶</a></dt>
 <dd><p>Adds the IPython handler to a dummy parent logger (named
 ‘apache_beam.runners.interactive’) of all interactive modules’ loggers so that
 if is_in_notebook, logging displays the logs as HTML in frontends.</p>
 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.runners.interactive.utils.IPythonLogHandler">
 <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">IPythonLogHandler</code><span class="sig-paren">(</span><em>level=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#IPythonLogHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.IPythonLogHandler" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Handler" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">logging.Handler</span></code></a></p>
 <p>A logging handler to display logs as HTML in IPython backed frontends.</p>
 <p>Initializes the instance - basically setting the formatter to None
 and the filter list to empty.</p>
 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.utils.IPythonLogHandler.log_template">
 <code class="descname">log_template</code><em class="property"> = '\n            &lt;link rel=&quot;stylesheet&quot; href=&quot;https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css&quot; integrity=&quot;sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh&quot; crossorigin=&quot;anonymous&quot;&gt;\n            &lt;div class=&quot;alert alert-{level}&quot;&gt;{msg}&lt;/div&gt;'</em><a class="headerlink" href="#apache_beam.runners.interactive.utils.IPythonLogHandler.log_template" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.utils.IPythonLogHandler.logging_to_alert_level_map">
 <code class="descname">logging_to_alert_level_map</code><em class="property"> = {0: 'light', 10: 'dark', 20: 'info', 30: 'warning', 40: 'danger', 50: 'danger'}</em><a class="headerlink" href="#apache_beam.runners.interactive.utils.IPythonLogHandler.logging_to_alert_level_map" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.utils.IPythonLogHandler.emit">
 <code class="descname">emit</code><span class="sig-paren">(</span><em>record</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#IPythonLogHandler.emit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.IPythonLogHandler.emit" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.obfuscate">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">obfuscate</code><span class="sig-paren">(</span><em>*inputs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#obfuscate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.obfuscate" title="Permalink to this definition">¶</a></dt>
 <dd><p>Obfuscates any inputs into a hexadecimal string.</p>
 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.runners.interactive.utils.ProgressIndicator">
 <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">ProgressIndicator</code><span class="sig-paren">(</span><em>enter_text</em>, <em>exit_text</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#ProgressIndicator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.ProgressIndicator" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>An indicator visualizing code execution in progress.</p>
 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.utils.ProgressIndicator.spinner_template">
 <code class="descname">spinner_template</code><em class="property"> = '\n            &lt;link rel=&quot;stylesheet&quot; href=&quot;https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css&quot; integrity=&quot;sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh&quot; crossorigin=&quot;anonymous&quot;&gt;\n            &lt;div id=&quot;{id}&quot; class=&quot;spinner-border text-info&quot; role=&quot;status&quot;&gt;\n            &lt;/div&gt;'</em><a class="headerlink" href="#apache_beam.runners.interactive.utils.ProgressIndicator.spinner_template" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.utils.ProgressIndicator.spinner_removal_template">
 <code class="descname">spinner_removal_template</code><em class="property"> = '\n            $(&quot;#{id}&quot;).remove();'</em><a class="headerlink" href="#apache_beam.runners.interactive.utils.ProgressIndicator.spinner_removal_template" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.progress_indicated">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">progress_indicated</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#progress_indicated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.progress_indicated" title="Permalink to this definition">¶</a></dt>
 <dd><p>A decorator using a unique progress indicator as a context manager to
 execute the given function within.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.as_json">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">as_json</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#as_json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.as_json" title="Permalink to this definition">¶</a></dt>
 <dd><p>A decorator convert python objects returned by callables to json
 string.</p>
 <p>The decorated function should always return an object parsable by json.dumps.
 If the object is not parsable, the str() of original object is returned
 instead.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.deferred_df_to_pcollection">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">deferred_df_to_pcollection</code><span class="sig-paren">(</span><em>df</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#deferred_df_to_pcollection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.deferred_df_to_pcollection" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.pcoll_by_name">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">pcoll_by_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; Dict[str, apache_beam.pvalue.PCollection]<a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#pcoll_by_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.pcoll_by_name" title="Permalink to this definition">¶</a></dt>
 <dd><p>Finds all PCollections by their variable names defined in the notebook.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.find_pcoll_name">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">find_pcoll_name</code><span class="sig-paren">(</span><em>pcoll: apache_beam.pvalue.PCollection</em><span class="sig-paren">)</span> &#x2192; str<a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#find_pcoll_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.find_pcoll_name" title="Permalink to this definition">¶</a></dt>
 <dd><p>Finds the variable name of a PCollection defined by the user.</p>
 <p>Returns None if not assigned to any variable.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.cacheables">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">cacheables</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; Dict[apache_beam.runners.interactive.caching.cacheable.CacheKey, apache_beam.runners.interactive.caching.cacheable.Cacheable]<a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#cacheables"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.cacheables" title="Permalink to this definition">¶</a></dt>
 <dd><p>Finds all Cacheables with their CacheKeys.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.watch_sources">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">watch_sources</code><span class="sig-paren">(</span><em>pipeline</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#watch_sources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.watch_sources" title="Permalink to this definition">¶</a></dt>
 <dd><p>Watches the unbounded sources in the pipeline.</p>
 <p>Sources can output to a PCollection without a user variable reference. In
 this case the source is not cached. We still want to cache the data so we
 synthetically create a variable to the intermediate PCollection.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.has_unbounded_sources">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">has_unbounded_sources</code><span class="sig-paren">(</span><em>pipeline</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#has_unbounded_sources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.has_unbounded_sources" title="Permalink to this definition">¶</a></dt>
 <dd><p>Checks if a given pipeline has recordable sources.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.unbounded_sources">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">unbounded_sources</code><span class="sig-paren">(</span><em>pipeline</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#unbounded_sources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.unbounded_sources" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns a pipeline’s recordable sources.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.runners.interactive.utils.create_var_in_main">
 <code class="descclassname">apache_beam.runners.interactive.utils.</code><code class="descname">create_var_in_main</code><span class="sig-paren">(</span><em>name: str</em>, <em>value: Any</em>, <em>watch: bool = True</em><span class="sig-paren">)</span> &#x2192; Tuple[str, Any]<a class="reference internal" href="_modules/apache_beam/runners/interactive/utils.html#create_var_in_main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.utils.create_var_in_main" title="Permalink to this definition">¶</a></dt>
 <dd><p>Declares a variable in the main module.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>name</strong> – the variable name in the main module.</li>
 <li><strong>value</strong> – the value of the variable.</li>
 <li><strong>watch</strong> – whether to watch it in the interactive environment.</li>
 </ul>
 </td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A 2-entry tuple of the variable name and value.</p>
 </td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 </div>


            </div>

           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="apache_beam.runners.job.html" class="btn btn-neutral float-right" title="apache_beam.runners.job package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.runners.interactive.user_pipeline_tracker.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.user_pipeline_tracker module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <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>