| |
| |
| <!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 module — Apache Beam 2.38.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" /> |
| <link rel="next" title="apache_beam.runners.interactive.options package" href="apache_beam.runners.interactive.options.html" /> |
| <link rel="prev" title="apache_beam.runners.interactive.messaging package" href="apache_beam.runners.interactive.messaging.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.38.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 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 current"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l4"><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> »</li> |
| |
| <li><a href="apache_beam.runners.html">apache_beam.runners package</a> »</li> |
| |
| <li><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a> »</li> |
| |
| <li><a href="apache_beam.runners.interactive.messaging.html">apache_beam.runners.interactive.messaging package</a> »</li> |
| |
| <li>apache_beam.runners.interactive.messaging.interactive_environment_inspector module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.interactive.messaging.interactive_environment_inspector.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.messaging.interactive_environment_inspector"> |
| <span id="apache-beam-runners-interactive-messaging-interactive-environment-inspector-module"></span><h1>apache_beam.runners.interactive.messaging.interactive_environment_inspector module<a class="headerlink" href="#module-apache_beam.runners.interactive.messaging.interactive_environment_inspector" title="Permalink to this headline">¶</a></h1> |
| <p>Messaging mechanism to inspect the interactive environment.</p> |
| <p>A singleton instance is accessible from |
| interactive_environment.current_env().inspector.</p> |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.messaging.interactive_environment_inspector.</code><code class="descname">InteractiveEnvironmentInspector</code><span class="sig-paren">(</span><em>ignore_synthetic=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/messaging/interactive_environment_inspector.html#InteractiveEnvironmentInspector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector" 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>Inspector that converts information of the current interactive environment |
| including pipelines and pcollections into JSON data suitable for messaging |
| with applications within/outside the Python kernel.</p> |
| <p>The usage is always that the application side reads the inspectables or |
| list_inspectables first then communicates back to the kernel and get_val for |
| usage on the kernel side.</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.inspectables"> |
| <code class="descname">inspectables</code><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.inspectables" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Lists pipelines and pcollections assigned to variables as inspectables.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.inspectable_pipelines"> |
| <code class="descname">inspectable_pipelines</code><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.inspectable_pipelines" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary of all inspectable pipelines. The keys are |
| stringified id of pipeline instances.</p> |
| <p>This includes user defined pipeline assigned to variables and anonymous |
| pipelines with inspectable PCollections. |
| If a user defined pipeline is not within the returned dict, it can be |
| considered out of scope, and all resources and memory states related to it |
| should be released.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.list_inspectables"> |
| <code class="descname">list_inspectables</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.list_inspectables" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.get_val"> |
| <code class="descname">get_val</code><span class="sig-paren">(</span><em>identifier</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/messaging/interactive_environment_inspector.html#InteractiveEnvironmentInspector.get_val"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.get_val" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Retrieves the in memory object itself by identifier.</p> |
| <p>The retrieved object could be a pipeline or a pcollection. If the |
| identifier is not recognized, return None. |
| The identifier can refer to an anonymous pipeline and the object will still |
| be retrieved.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.get_pcoll_data"> |
| <code class="descname">get_pcoll_data</code><span class="sig-paren">(</span><em>identifier</em>, <em>include_window_info=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/messaging/interactive_environment_inspector.html#InteractiveEnvironmentInspector.get_pcoll_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.InteractiveEnvironmentInspector.get_pcoll_data" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Retrieves the json formatted PCollection data.</p> |
| <p>If no PCollection value can be retieved from the given identifier, an empty |
| json string will be returned.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.inspect"> |
| <code class="descclassname">apache_beam.runners.interactive.messaging.interactive_environment_inspector.</code><code class="descname">inspect</code><span class="sig-paren">(</span><em>ignore_synthetic=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/messaging/interactive_environment_inspector.html#inspect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.inspect" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Inspects current interactive environment to track metadata and values of |
| pipelines and pcollections.</p> |
| <p>Each pipeline and pcollections tracked is given a unique identifier.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.inspect_pipelines"> |
| <code class="descclassname">apache_beam.runners.interactive.messaging.interactive_environment_inspector.</code><code class="descname">inspect_pipelines</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/messaging/interactive_environment_inspector.html#inspect_pipelines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.inspect_pipelines" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Inspects current interactive environment to track all pipelines assigned |
| to variables. The keys are pipeline objects and values are pipeline names.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.meta"> |
| <code class="descclassname">apache_beam.runners.interactive.messaging.interactive_environment_inspector.</code><code class="descname">meta</code><span class="sig-paren">(</span><em>name</em>, <em>val</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/messaging/interactive_environment_inspector.html#meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.meta" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Generates meta data for the given name and value.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.messaging.interactive_environment_inspector.synthesize_pipeline_name"> |
| <code class="descclassname">apache_beam.runners.interactive.messaging.interactive_environment_inspector.</code><code class="descname">synthesize_pipeline_name</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/messaging/interactive_environment_inspector.html#synthesize_pipeline_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.messaging.interactive_environment_inspector.synthesize_pipeline_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Synthesizes a pipeline name for the given pipeline object.</p> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.runners.interactive.options.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.options package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.interactive.messaging.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.messaging package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <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> |