pydoc/2.47.0/_modules/apache_beam/utils/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.utils.interactive_utils &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.utils.interactive_utils</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.utils.interactive_utils</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;Common interactive utility module.</span>

 <span class="sd">For experimental usage only; no backwards-compatibility guarantees.</span>
 <span class="sd">&quot;&quot;&quot;</span>
 <span class="c1"># pytype: skip-file</span>

 <span class="kn">import</span> <span class="nn">logging</span>

 <span class="n">_LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


 <div class="viewcode-block" id="is_in_ipython"><a class="viewcode-back" href="../../../apache_beam.utils.interactive_utils.html#apache_beam.utils.interactive_utils.is_in_ipython">[docs]</a><span class="k">def</span> <span class="nf">is_in_ipython</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Determines if current code is executed within an ipython session.&quot;&quot;&quot;</span>
   <span class="k">try</span><span class="p">:</span>
     <span class="kn">from</span> <span class="nn">IPython</span> <span class="kn">import</span> <span class="n">get_ipython</span>  <span class="c1"># pylint: disable=import-error</span>
     <span class="k">if</span> <span class="n">get_ipython</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">except</span> <span class="ne">ImportError</span><span class="p">:</span>
     <span class="c1"># If dependencies are not available, then not interactive for sure.</span>
     <span class="k">return</span> <span class="kc">False</span>
   <span class="k">except</span> <span class="p">(</span><span class="ne">KeyboardInterrupt</span><span class="p">,</span> <span class="ne">SystemExit</span><span class="p">):</span>
     <span class="k">raise</span>
   <span class="k">except</span><span class="p">:</span>  <span class="c1"># pylint: disable=bare-except</span>
     <span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
         <span class="s1">&#39;Unexpected error occurred, treated as not in IPython.&#39;</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
     <span class="k">return</span> <span class="kc">False</span></div>


 <div class="viewcode-block" id="is_in_notebook"><a class="viewcode-back" href="../../../apache_beam.utils.interactive_utils.html#apache_beam.utils.interactive_utils.is_in_notebook">[docs]</a><span class="k">def</span> <span class="nf">is_in_notebook</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Determines if current code is executed from an ipython notebook.</span>

 <span class="sd">  If is_in_notebook() is True, then is_in_ipython() must also be True.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="n">is_in_notebook</span> <span class="o">=</span> <span class="kc">False</span>
   <span class="k">if</span> <span class="n">is_in_ipython</span><span class="p">():</span>
     <span class="c1"># The import and usage must be valid under the execution path.</span>
     <span class="kn">from</span> <span class="nn">IPython</span> <span class="kn">import</span> <span class="n">get_ipython</span>
     <span class="k">if</span> <span class="s1">&#39;IPKernelApp&#39;</span> <span class="ow">in</span> <span class="n">get_ipython</span><span class="p">()</span><span class="o">.</span><span class="n">config</span><span class="p">:</span>
       <span class="n">is_in_notebook</span> <span class="o">=</span> <span class="kc">True</span>
   <span class="k">return</span> <span class="n">is_in_notebook</span></div>


 <div class="viewcode-block" id="alter_label_if_ipython"><a class="viewcode-back" href="../../../apache_beam.utils.interactive_utils.html#apache_beam.utils.interactive_utils.alter_label_if_ipython">[docs]</a><span class="k">def</span> <span class="nf">alter_label_if_ipython</span><span class="p">(</span><span class="n">transform</span><span class="p">,</span> <span class="n">pvalueish</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Alters the label to an interactive label with ipython prompt metadata</span>
 <span class="sd">  prefixed for the given transform if the given pvalueish belongs to a</span>
 <span class="sd">  user-defined pipeline and current code execution is within an ipython kernel.</span>
 <span class="sd">  Otherwise, noop.</span>

 <span class="sd">  A label is either a user-defined or auto-generated str name of a PTransform</span>
 <span class="sd">  that is unique within a pipeline. If current environment is_in_ipython(), Beam</span>
 <span class="sd">  can implicitly create interactive labels to replace labels of top-level</span>
 <span class="sd">  PTransforms to be applied. The label is formatted as:</span>
 <span class="sd">  `Cell {prompt}: {original_label}`.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">if</span> <span class="n">is_in_ipython</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_environment</span> <span class="k">as</span> <span class="n">ie</span>
     <span class="c1"># Tracks user defined pipeline instances in watched scopes so that we only</span>
     <span class="c1"># alter labels for any transform to pvalueish belonging to those pipeline</span>
     <span class="c1"># instances, excluding any transform to be applied in other pipeline</span>
     <span class="c1"># instances the Beam SDK creates implicitly.</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">track_user_pipelines</span><span class="p">()</span>
     <span class="kn">from</span> <span class="nn">IPython</span> <span class="kn">import</span> <span class="n">get_ipython</span>
     <span class="n">prompt</span> <span class="o">=</span> <span class="n">get_ipython</span><span class="p">()</span><span class="o">.</span><span class="n">execution_count</span>
     <span class="n">pipeline</span> <span class="o">=</span> <span class="n">_extract_pipeline_of_pvalueish</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">)</span>
     <span class="k">if</span> <span class="p">(</span><span class="n">pipeline</span>
         <span class="c1"># We only alter for transforms to be applied to user-defined pipelines</span>
         <span class="c1"># at pipeline construction time.</span>
         <span class="ow">and</span> <span class="n">pipeline</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">tracked_user_pipelines</span><span class="p">):</span>
       <span class="n">transform</span><span class="o">.</span><span class="n">label</span> <span class="o">=</span> <span class="s1">&#39;[</span><span class="si">{}</span><span class="s1">]: </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="n">prompt</span><span class="p">,</span> <span class="n">transform</span><span class="o">.</span><span class="n">label</span><span class="p">)</span></div>


 <span class="k">def</span> <span class="nf">_extract_pipeline_of_pvalueish</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Extracts the pipeline that the given pvalueish belongs to.&quot;&quot;&quot;</span>
   <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
     <span class="n">pvalue</span> <span class="o">=</span> <span class="n">pvalueish</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
   <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
     <span class="n">pvalue</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">pvalueish</span><span class="o">.</span><span class="n">values</span><span class="p">()))</span>
   <span class="k">else</span><span class="p">:</span>
     <span class="n">pvalue</span> <span class="o">=</span> <span class="n">pvalueish</span>
   <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">pvalue</span><span class="p">,</span> <span class="s1">&#39;pipeline&#39;</span><span class="p">):</span>
     <span class="k">return</span> <span class="n">pvalue</span><span class="o">.</span><span class="n">pipeline</span>
   <span class="k">return</span> <span class="kc">None</span>
 </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>


	<!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.utils.interactive_utils — 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> »</li>

	<li><a href="../../index.html">Module code</a> »</li>

	<li>apache_beam.utils.interactive_utils</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.utils.interactive_utils</h1><div class="highlight"><pre>
	<span></span><span class="c1">#</span>
	<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
	<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
	<span class="c1"># this work for additional information regarding copyright ownership.</span>
	<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
	<span class="c1"># (the "License"); you may not use this file except in compliance with</span>
	<span class="c1"># the License. You may obtain a copy of the License at</span>
	<span class="c1">#</span>
	<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
	<span class="c1">#</span>
	<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
	<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span>
	<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
	<span class="c1"># See the License for the specific language governing permissions and</span>
	<span class="c1"># limitations under the License.</span>
	<span class="c1">#</span>

	<span class="sd">"""Common interactive utility module.</span>

	<span class="sd">For experimental usage only; no backwards-compatibility guarantees.</span>
	<span class="sd">"""</span>
	<span class="c1"># pytype: skip-file</span>

	<span class="kn">import</span> <span class="nn">logging</span>

	<span class="n">_LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


	<div class="viewcode-block" id="is_in_ipython"><a class="viewcode-back" href="../../../apache_beam.utils.interactive_utils.html#apache_beam.utils.interactive_utils.is_in_ipython">[docs]</a><span class="k">def</span> <span class="nf">is_in_ipython</span><span class="p">():</span>
	<span class="w"> </span><span class="sd">"""Determines if current code is executed within an ipython session."""</span>
	<span class="k">try</span><span class="p">:</span>
	<span class="kn">from</span> <span class="nn">IPython</span> <span class="kn">import</span> <span class="n">get_ipython</span> <span class="c1"># pylint: disable=import-error</span>
	<span class="k">if</span> <span class="n">get_ipython</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">except</span> <span class="ne">ImportError</span><span class="p">:</span>
	<span class="c1"># If dependencies are not available, then not interactive for sure.</span>
	<span class="k">return</span> <span class="kc">False</span>
	<span class="k">except</span> <span class="p">(</span><span class="ne">KeyboardInterrupt</span><span class="p">,</span> <span class="ne">SystemExit</span><span class="p">):</span>
	<span class="k">raise</span>
	<span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
	<span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
	<span class="s1">'Unexpected error occurred, treated as not in IPython.'</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
	<span class="k">return</span> <span class="kc">False</span></div>


	<div class="viewcode-block" id="is_in_notebook"><a class="viewcode-back" href="../../../apache_beam.utils.interactive_utils.html#apache_beam.utils.interactive_utils.is_in_notebook">[docs]</a><span class="k">def</span> <span class="nf">is_in_notebook</span><span class="p">():</span>
	<span class="w"> </span><span class="sd">"""Determines if current code is executed from an ipython notebook.</span>

	<span class="sd"> If is_in_notebook() is True, then is_in_ipython() must also be True.</span>
	<span class="sd"> """</span>
	<span class="n">is_in_notebook</span> <span class="o">=</span> <span class="kc">False</span>
	<span class="k">if</span> <span class="n">is_in_ipython</span><span class="p">():</span>
	<span class="c1"># The import and usage must be valid under the execution path.</span>
	<span class="kn">from</span> <span class="nn">IPython</span> <span class="kn">import</span> <span class="n">get_ipython</span>
	<span class="k">if</span> <span class="s1">'IPKernelApp'</span> <span class="ow">in</span> <span class="n">get_ipython</span><span class="p">()</span><span class="o">.</span><span class="n">config</span><span class="p">:</span>
	<span class="n">is_in_notebook</span> <span class="o">=</span> <span class="kc">True</span>
	<span class="k">return</span> <span class="n">is_in_notebook</span></div>


	<div class="viewcode-block" id="alter_label_if_ipython"><a class="viewcode-back" href="../../../apache_beam.utils.interactive_utils.html#apache_beam.utils.interactive_utils.alter_label_if_ipython">[docs]</a><span class="k">def</span> <span class="nf">alter_label_if_ipython</span><span class="p">(</span><span class="n">transform</span><span class="p">,</span> <span class="n">pvalueish</span><span class="p">):</span>
	<span class="w"> </span><span class="sd">"""Alters the label to an interactive label with ipython prompt metadata</span>
	<span class="sd"> prefixed for the given transform if the given pvalueish belongs to a</span>
	<span class="sd"> user-defined pipeline and current code execution is within an ipython kernel.</span>
	<span class="sd"> Otherwise, noop.</span>

	<span class="sd"> A label is either a user-defined or auto-generated str name of a PTransform</span>
	<span class="sd"> that is unique within a pipeline. If current environment is_in_ipython(), Beam</span>
	<span class="sd"> can implicitly create interactive labels to replace labels of top-level</span>
	<span class="sd"> PTransforms to be applied. The label is formatted as:</span>
	<span class="sd"> `Cell {prompt}: {original_label}`.</span>
	<span class="sd"> """</span>
	<span class="k">if</span> <span class="n">is_in_ipython</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_environment</span> <span class="k">as</span> <span class="n">ie</span>
	<span class="c1"># Tracks user defined pipeline instances in watched scopes so that we only</span>
	<span class="c1"># alter labels for any transform to pvalueish belonging to those pipeline</span>
	<span class="c1"># instances, excluding any transform to be applied in other pipeline</span>
	<span class="c1"># instances the Beam SDK creates implicitly.</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">track_user_pipelines</span><span class="p">()</span>
	<span class="kn">from</span> <span class="nn">IPython</span> <span class="kn">import</span> <span class="n">get_ipython</span>
	<span class="n">prompt</span> <span class="o">=</span> <span class="n">get_ipython</span><span class="p">()</span><span class="o">.</span><span class="n">execution_count</span>
	<span class="n">pipeline</span> <span class="o">=</span> <span class="n">_extract_pipeline_of_pvalueish</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">)</span>
	<span class="k">if</span> <span class="p">(</span><span class="n">pipeline</span>
	<span class="c1"># We only alter for transforms to be applied to user-defined pipelines</span>
	<span class="c1"># at pipeline construction time.</span>
	<span class="ow">and</span> <span class="n">pipeline</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">tracked_user_pipelines</span><span class="p">):</span>
	<span class="n">transform</span><span class="o">.</span><span class="n">label</span> <span class="o">=</span> <span class="s1">'[</span><span class="si">{}</span><span class="s1">]: </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">prompt</span><span class="p">,</span> <span class="n">transform</span><span class="o">.</span><span class="n">label</span><span class="p">)</span></div>


	<span class="k">def</span> <span class="nf">_extract_pipeline_of_pvalueish</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">):</span>
	<span class="w"> </span><span class="sd">"""Extracts the pipeline that the given pvalueish belongs to."""</span>
	<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
	<span class="n">pvalue</span> <span class="o">=</span> <span class="n">pvalueish</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
	<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">pvalueish</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
	<span class="n">pvalue</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">pvalueish</span><span class="o">.</span><span class="n">values</span><span class="p">()))</span>
	<span class="k">else</span><span class="p">:</span>
	<span class="n">pvalue</span> <span class="o">=</span> <span class="n">pvalueish</span>
	<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">pvalue</span><span class="p">,</span> <span class="s1">'pipeline'</span><span class="p">):</span>
	<span class="k">return</span> <span class="n">pvalue</span><span class="o">.</span><span class="n">pipeline</span>
	<span class="k">return</span> <span class="kc">None</span>
	</pre></div>

	</div>

	</div>
	<footer>


	<hr/>

	<div role="contentinfo">
	<p>
	© Copyright

	</p>
	</div>
	Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/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>