| |
| |
| <!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.testing.integration.notebook_executor module — 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.interactive.testing.integration.screen_diff module" href="apache_beam.runners.interactive.testing.integration.screen_diff.html" /> |
| <link rel="prev" title="apache_beam.runners.interactive.testing.integration package" href="apache_beam.runners.interactive.testing.integration.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 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.testing.html">apache_beam.runners.interactive.testing package</a> »</li> |
| |
| <li><a href="apache_beam.runners.interactive.testing.integration.html">apache_beam.runners.interactive.testing.integration package</a> »</li> |
| |
| <li>apache_beam.runners.interactive.testing.integration.notebook_executor module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.interactive.testing.integration.notebook_executor.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.testing.integration.notebook_executor"> |
| <span id="apache-beam-runners-interactive-testing-integration-notebook-executor-module"></span><h1>apache_beam.runners.interactive.testing.integration.notebook_executor module<a class="headerlink" href="#module-apache_beam.runners.interactive.testing.integration.notebook_executor" title="Permalink to this headline">¶</a></h1> |
| <p>Module to execute jupyter notebooks and gather the output into renderable |
| HTML files.</p> |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.testing.integration.notebook_executor.</code><code class="descname">NotebookExecutor</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/testing/integration/notebook_executor.html#NotebookExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor" 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>Executor that reads notebooks, executes it and gathers outputs into static |
| HTML pages that can be served.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.cleanup"> |
| <code class="descname">cleanup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/testing/integration/notebook_executor.html#NotebookExecutor.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.cleanup" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Cleans up the output folder.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.execute"> |
| <code class="descname">execute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/testing/integration/notebook_executor.html#NotebookExecutor.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.execute" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Executes all notebooks found in the scoped path and gathers their |
| outputs into HTML pages stored in the output folder.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.output_html_paths"> |
| <code class="descname">output_html_paths</code><a class="headerlink" href="#apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.output_html_paths" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Mapping from execution ids to output html page paths.</p> |
| <p>An execution/test id is an obfuscated value from the executed notebook path. |
| It identifies the input notebook, the output html, the screenshot of the |
| output html, and the golden screenshot for comparison.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.output_html_dir"> |
| <code class="descname">output_html_dir</code><a class="headerlink" href="#apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.output_html_dir" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The directory’s path to all the output html pages generated.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.notebook_path_to_execution_id"> |
| <code class="descname">notebook_path_to_execution_id</code><a class="headerlink" href="#apache_beam.runners.interactive.testing.integration.notebook_executor.NotebookExecutor.notebook_path_to_execution_id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Mapping from input notebook paths to their obfuscated execution ids.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.testing.integration.notebook_executor.IFrameParser"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.testing.integration.notebook_executor.</code><code class="descname">IFrameParser</code><a class="reference internal" href="_modules/apache_beam/runners/interactive/testing/integration/notebook_executor.html#IFrameParser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.testing.integration.notebook_executor.IFrameParser" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">html.parser.HTMLParser</span></code></a></p> |
| <p>A parser to extract iframe content from given HTML.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.testing.integration.notebook_executor.IFrameParser.handle_starttag"> |
| <code class="descname">handle_starttag</code><span class="sig-paren">(</span><em>tag</em>, <em>attrs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/testing/integration/notebook_executor.html#IFrameParser.handle_starttag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.testing.integration.notebook_executor.IFrameParser.handle_starttag" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.testing.integration.notebook_executor.IFrameParser.srcdocs"> |
| <code class="descname">srcdocs</code><a class="headerlink" href="#apache_beam.runners.interactive.testing.integration.notebook_executor.IFrameParser.srcdocs" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.runners.interactive.testing.integration.screen_diff.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.testing.integration.screen_diff module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.interactive.testing.integration.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.testing.integration 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> |
