| |
| |
| <!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.subprocess_server 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.utils.thread_pool_executor module" href="apache_beam.utils.thread_pool_executor.html" /> |
| <link rel="prev" title="apache_beam.utils.shared module" href="apache_beam.utils.shared.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"><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.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 current"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.utils.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.annotations.html">apache_beam.utils.annotations module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.histogram.html">apache_beam.utils.histogram module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.interactive_utils.html">apache_beam.utils.interactive_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.plugin.html">apache_beam.utils.plugin module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.processes.html">apache_beam.utils.processes module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.profiler.html">apache_beam.utils.profiler module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.proto_utils.html">apache_beam.utils.proto_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.retry.html">apache_beam.utils.retry module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.sentinel.html">apache_beam.utils.sentinel module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.sharded_key.html">apache_beam.utils.sharded_key module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.shared.html">apache_beam.utils.shared module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.utils.subprocess_server module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.thread_pool_executor.html">apache_beam.utils.thread_pool_executor module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.timestamp.html">apache_beam.utils.timestamp module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.urns.html">apache_beam.utils.urns module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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.utils.html">apache_beam.utils package</a> »</li> |
| |
| <li>apache_beam.utils.subprocess_server module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.utils.subprocess_server.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.utils.subprocess_server"> |
| <span id="apache-beam-utils-subprocess-server-module"></span><h1>apache_beam.utils.subprocess_server module<a class="headerlink" href="#module-apache_beam.utils.subprocess_server" title="Permalink to this headline">¶</a></h1> |
| <dl class="class"> |
| <dt id="apache_beam.utils.subprocess_server.SubprocessServer"> |
| <em class="property">class </em><code class="descclassname">apache_beam.utils.subprocess_server.</code><code class="descname">SubprocessServer</code><span class="sig-paren">(</span><em>stub_class</em>, <em>cmd</em>, <em>port=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#SubprocessServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.SubprocessServer" 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 abstract base class for running GRPC Servers as an external process.</p> |
| <p>This class acts as a context which will start up a server, provides a stub |
| to connect to it, and then shuts the server down. For example:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">SubprocessServer</span><span class="p">(</span><span class="n">GrpcStubClass</span><span class="p">,</span> <span class="p">[</span><span class="n">executable</span><span class="p">,</span> <span class="n">arg</span><span class="p">,</span> <span class="o">...</span><span class="p">])</span> <span class="k">as</span> <span class="n">stub</span><span class="p">:</span> |
| <span class="n">stub</span><span class="o">.</span><span class="n">CallService</span><span class="p">(</span><span class="o">...</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Creates the server object.</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 last simple"> |
| <li><strong>stub_class</strong> – the auto-generated GRPC client stub class used for |
| connecting to the GRPC service</li> |
| <li><strong>cmd</strong> – command (including arguments) for starting up the server, |
| suitable for passing to <cite>subprocess.POpen</cite>.</li> |
| <li><strong>port</strong> – (optional) the port at which the subprocess will serve its |
| service. If not given, one will be randomly chosen and the special |
| string “{{PORT}}” will be substituted in the command line arguments |
| with the chosen port.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.utils.subprocess_server.SubprocessServer.start"> |
| <code class="descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#SubprocessServer.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.SubprocessServer.start" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.utils.subprocess_server.SubprocessServer.start_process"> |
| <code class="descname">start_process</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#SubprocessServer.start_process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.SubprocessServer.start_process" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.utils.subprocess_server.SubprocessServer.stop"> |
| <code class="descname">stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#SubprocessServer.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.SubprocessServer.stop" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.utils.subprocess_server.SubprocessServer.stop_process"> |
| <code class="descname">stop_process</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#SubprocessServer.stop_process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.SubprocessServer.stop_process" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.utils.subprocess_server.SubprocessServer.local_temp_dir"> |
| <code class="descname">local_temp_dir</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#SubprocessServer.local_temp_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.SubprocessServer.local_temp_dir" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer"> |
| <em class="property">class </em><code class="descclassname">apache_beam.utils.subprocess_server.</code><code class="descname">JavaJarServer</code><span class="sig-paren">(</span><em>stub_class</em>, <em>path_to_jar</em>, <em>java_arguments</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#JavaJarServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.utils.subprocess_server.SubprocessServer" title="apache_beam.utils.subprocess_server.SubprocessServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.utils.subprocess_server.SubprocessServer</span></code></a></p> |
| <dl class="attribute"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.APACHE_REPOSITORY"> |
| <code class="descname">APACHE_REPOSITORY</code><em class="property"> = 'https://repo.maven.apache.org/maven2'</em><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.APACHE_REPOSITORY" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.BEAM_GROUP_ID"> |
| <code class="descname">BEAM_GROUP_ID</code><em class="property"> = 'org.apache.beam'</em><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.BEAM_GROUP_ID" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.JAR_CACHE"> |
| <code class="descname">JAR_CACHE</code><em class="property"> = '/Users/kcweaver/.apache_beam/cache/jars'</em><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.JAR_CACHE" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.start_process"> |
| <code class="descname">start_process</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#JavaJarServer.start_process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.start_process" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.stop_process"> |
| <code class="descname">stop_process</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#JavaJarServer.stop_process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.stop_process" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.jar_name"> |
| <em class="property">classmethod </em><code class="descname">jar_name</code><span class="sig-paren">(</span><em>artifact_id</em>, <em>version</em>, <em>classifier=None</em>, <em>appendix=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#JavaJarServer.jar_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.jar_name" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.path_to_maven_jar"> |
| <em class="property">classmethod </em><code class="descname">path_to_maven_jar</code><span class="sig-paren">(</span><em>artifact_id</em>, <em>group_id</em>, <em>version</em>, <em>repository='https://repo.maven.apache.org/maven2'</em>, <em>classifier=None</em>, <em>appendix=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#JavaJarServer.path_to_maven_jar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.path_to_maven_jar" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.path_to_beam_jar"> |
| <em class="property">classmethod </em><code class="descname">path_to_beam_jar</code><span class="sig-paren">(</span><em>gradle_target</em>, <em>appendix=None</em>, <em>version='2.34.0'</em>, <em>artifact_id=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#JavaJarServer.path_to_beam_jar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.path_to_beam_jar" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.local_jar"> |
| <em class="property">classmethod </em><code class="descname">local_jar</code><span class="sig-paren">(</span><em>url</em>, <em>cache_dir=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#JavaJarServer.local_jar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.local_jar" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.utils.subprocess_server.JavaJarServer.beam_services"> |
| <em class="property">classmethod </em><code class="descname">beam_services</code><span class="sig-paren">(</span><em>replacements</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#JavaJarServer.beam_services"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.JavaJarServer.beam_services" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.utils.subprocess_server.pick_port"> |
| <code class="descclassname">apache_beam.utils.subprocess_server.</code><code class="descname">pick_port</code><span class="sig-paren">(</span><em>*ports</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/subprocess_server.html#pick_port"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.utils.subprocess_server.pick_port" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of ports, same length as input ports list, but replaces |
| all None or 0 ports with a random free port.</p> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.utils.thread_pool_executor.html" class="btn btn-neutral float-right" title="apache_beam.utils.thread_pool_executor module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.utils.shared.html" class="btn btn-neutral float-left" title="apache_beam.utils.shared module" 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> |
