Google Git
Sign in
apache / beam-site / refs/heads/revert-643-revert-642-updates_release_2.47.0 / . / pydoc / 2.47.0 / _modules / apache_beam / runners / pipeline_context.html
blob: be3cabba3dadcd470e7d58fd8b77f68c344249e5 [file] [log] [blame]
<!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.pipeline_context &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.runners.pipeline_context</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.runners.pipeline_context</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;Utility class for serializing pipelines via the runner API.</span>
<span class="sd">For internal use only; no backwards-compatibility guarantees.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</span>
<span class="c1"># mypy: disallow-untyped-defs</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">FrozenSet</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Generic</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Iterable</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Mapping</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Type</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TypeVar</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>
<span class="kn">from</span> <span class="nn">typing_extensions</span> <span class="kn">import</span> <span class="n">Protocol</span>
<span class="kn">from</span> <span class="nn">apache_beam</span> <span class="kn">import</span> <span class="n">coders</span>
<span class="kn">from</span> <span class="nn">apache_beam</span> <span class="kn">import</span> <span class="n">pipeline</span>
<span class="kn">from</span> <span class="nn">apache_beam</span> <span class="kn">import</span> <span class="n">pvalue</span>
<span class="kn">from</span> <span class="nn">apache_beam.internal</span> <span class="kn">import</span> <span class="n">pickler</span>
<span class="kn">from</span> <span class="nn">apache_beam.pipeline</span> <span class="kn">import</span> <span class="n">ComponentIdMap</span>
<span class="kn">from</span> <span class="nn">apache_beam.portability.api</span> <span class="kn">import</span> <span class="n">beam_fn_api_pb2</span>
<span class="kn">from</span> <span class="nn">apache_beam.portability.api</span> <span class="kn">import</span> <span class="n">beam_runner_api_pb2</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">core</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">environments</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.resources</span> <span class="kn">import</span> <span class="n">merge_resource_hints</span>
<span class="kn">from</span> <span class="nn">apache_beam.typehints</span> <span class="kn">import</span> <span class="n">native_type_compatibility</span>
<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="kn">import</span> <span class="n">message</span> <span class="c1"># pylint: disable=ungrouped-imports</span>
<span class="kn">from</span> <span class="nn">apache_beam.coders.coder_impl</span> <span class="kn">import</span> <span class="n">IterableStateReader</span>
<span class="kn">from</span> <span class="nn">apache_beam.coders.coder_impl</span> <span class="kn">import</span> <span class="n">IterableStateWriter</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="kn">import</span> <span class="n">ptransform</span>
<span class="n">PortableObjectT</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">&#39;PortableObjectT&#39;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s1">&#39;PortableObject&#39;</span><span class="p">)</span>
<div class="viewcode-block" id="PortableObject"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PortableObject">[docs]</a><span class="k">class</span> <span class="nc">PortableObject</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
<div class="viewcode-block" id="PortableObject.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PortableObject.to_runner_api">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">__context</span><span class="p">):</span>
<span class="c1"># type: (PipelineContext) -&gt; Any</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="PortableObject.from_runner_api"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PortableObject.from_runner_api">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_runner_api</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">__proto</span><span class="p">,</span> <span class="n">__context</span><span class="p">):</span>
<span class="c1"># type: (Any, PipelineContext) -&gt; Any</span>
<span class="k">pass</span></div></div>
<span class="k">class</span> <span class="nc">_PipelineContextMap</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">PortableObjectT</span><span class="p">]):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;This is a bi-directional map between objects and ids.</span>
<span class="sd"> Under the hood it encodes and decodes these objects into runner API</span>
<span class="sd"> representations.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">context</span><span class="p">,</span> <span class="c1"># type: PipelineContext</span>
<span class="n">obj_type</span><span class="p">,</span> <span class="c1"># type: Type[PortableObjectT]</span>
<span class="n">namespace</span><span class="p">,</span> <span class="c1"># type: str</span>
<span class="n">proto_map</span><span class="o">=</span><span class="kc">None</span> <span class="c1"># type: Optional[Mapping[str, message.Message]]</span>
<span class="p">):</span>
<span class="c1"># type: (...) -&gt; None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_pipeline_context</span> <span class="o">=</span> <span class="n">context</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_obj_type</span> <span class="o">=</span> <span class="n">obj_type</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_namespace</span> <span class="o">=</span> <span class="n">namespace</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_obj_to_id</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># type: Dict[Any, str]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_id_to_obj</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># type: Dict[str, Any]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">proto_map</span><span class="p">)</span> <span class="k">if</span> <span class="n">proto_map</span> <span class="k">else</span> <span class="p">{}</span>
<span class="k">def</span> <span class="nf">populate_map</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto_map</span><span class="p">):</span>
<span class="c1"># type: (Mapping[str, message.Message]) -&gt; None</span>
<span class="k">for</span> <span class="nb">id</span><span class="p">,</span> <span class="n">proto</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">proto_map</span><span class="p">[</span><span class="nb">id</span><span class="p">]</span><span class="o">.</span><span class="n">CopyFrom</span><span class="p">(</span><span class="n">proto</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (PortableObjectT, Optional[str]) -&gt; str</span>
<span class="k">if</span> <span class="n">obj</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_obj_to_id</span><span class="p">:</span>
<span class="nb">id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pipeline_context</span><span class="o">.</span><span class="n">component_id_map</span><span class="o">.</span><span class="n">get_or_assign</span><span class="p">(</span>
<span class="n">obj</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_obj_type</span><span class="p">,</span> <span class="n">label</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_id_to_obj</span><span class="p">[</span><span class="nb">id</span><span class="p">]</span> <span class="o">=</span> <span class="n">obj</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_obj_to_id</span><span class="p">[</span><span class="n">obj</span><span class="p">]</span> <span class="o">=</span> <span class="nb">id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span><span class="p">[</span><span class="nb">id</span><span class="p">]</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_pipeline_context</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_obj_to_id</span><span class="p">[</span><span class="n">obj</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">get_proto</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (PortableObjectT, Optional[str]) -&gt; message.Message</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">label</span><span class="p">)]</span>
<span class="k">def</span> <span class="nf">get_by_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
<span class="c1"># type: (str) -&gt; PortableObjectT</span>
<span class="k">if</span> <span class="nb">id</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_to_obj</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_id_to_obj</span><span class="p">[</span><span class="nb">id</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_obj_type</span><span class="o">.</span><span class="n">from_runner_api</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span><span class="p">[</span><span class="nb">id</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pipeline_context</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_to_obj</span><span class="p">[</span><span class="nb">id</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">get_by_proto</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">maybe_new_proto</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">deduplicate</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="c1"># type: (message.Message, Optional[str], bool) -&gt; str</span>
<span class="c1"># TODO: this method may not be safe for arbitrary protos due to</span>
<span class="c1"># xlang concerns, hence limiting usage to the only current use-case it has.</span>
<span class="c1"># See: https://github.com/apache/beam/pull/14390#discussion_r616062377</span>
<span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">maybe_new_proto</span><span class="p">,</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">Environment</span><span class="p">)</span>
<span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_obj_type</span><span class="o">.</span><span class="n">from_runner_api</span><span class="p">(</span>
<span class="n">maybe_new_proto</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pipeline_context</span><span class="p">)</span>
<span class="k">if</span> <span class="n">deduplicate</span><span class="p">:</span>
<span class="k">if</span> <span class="n">obj</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_obj_to_id</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_obj_to_id</span><span class="p">[</span><span class="n">obj</span><span class="p">]</span>
<span class="k">for</span> <span class="nb">id</span><span class="p">,</span> <span class="n">proto</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">proto</span> <span class="o">==</span> <span class="n">maybe_new_proto</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">id</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">put_proto</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_pipeline_context</span><span class="o">.</span><span class="n">component_id_map</span><span class="o">.</span><span class="n">get_or_assign</span><span class="p">(</span>
<span class="n">obj</span><span class="o">=</span><span class="n">obj</span><span class="p">,</span> <span class="n">obj_type</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_obj_type</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="n">label</span><span class="p">),</span>
<span class="n">maybe_new_proto</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_id_to_proto_map</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; Dict[str, message.Message]</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span>
<span class="k">def</span> <span class="nf">get_proto_from_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
<span class="c1"># type: (str) -&gt; message.Message</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_id_to_proto_map</span><span class="p">()[</span><span class="nb">id</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">put_proto</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">proto</span><span class="p">,</span> <span class="n">ignore_duplicates</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="c1"># type: (str, message.Message, bool) -&gt; str</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">ignore_duplicates</span> <span class="ow">and</span> <span class="nb">id</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Id &#39;</span><span class="si">%s</span><span class="s2">&#39; is already taken.&quot;</span> <span class="o">%</span> <span class="nb">id</span><span class="p">)</span>
<span class="k">elif</span> <span class="p">(</span><span class="n">ignore_duplicates</span> <span class="ow">and</span> <span class="nb">id</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span> <span class="ow">and</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span><span class="p">[</span><span class="nb">id</span><span class="p">]</span> <span class="o">!=</span> <span class="n">proto</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;Cannot insert different protos </span><span class="si">%r</span><span class="s1"> and </span><span class="si">%r</span><span class="s1"> with the same ID </span><span class="si">%r</span><span class="s1">&#39;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span><span class="p">[</span><span class="nb">id</span><span class="p">],</span>
<span class="n">proto</span><span class="p">,</span>
<span class="nb">id</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span><span class="p">[</span><span class="nb">id</span><span class="p">]</span> <span class="o">=</span> <span class="n">proto</span>
<span class="k">return</span> <span class="nb">id</span>
<span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
<span class="c1"># type: (str) -&gt; Any</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_by_id</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
<span class="c1"># type: (str) -&gt; bool</span>
<span class="k">return</span> <span class="nb">id</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_to_proto</span>
<div class="viewcode-block" id="PipelineContext"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext">[docs]</a><span class="k">class</span> <span class="nc">PipelineContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;For internal use only; no backwards-compatibility guarantees.</span>
<span class="sd"> Used for accessing and constructing the referenced objects of a Pipeline.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">proto</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Union[beam_runner_api_pb2.Components, beam_fn_api_pb2.ProcessBundleDescriptor]]</span>
<span class="n">component_id_map</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[pipeline.ComponentIdMap]</span>
<span class="n">default_environment</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[environments.Environment]</span>
<span class="n">use_fake_coders</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="c1"># type: bool</span>
<span class="n">iterable_state_read</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[IterableStateReader]</span>
<span class="n">iterable_state_write</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[IterableStateWriter]</span>
<span class="n">namespace</span><span class="o">=</span><span class="s1">&#39;ref&#39;</span><span class="p">,</span> <span class="c1"># type: str</span>
<span class="n">requirements</span><span class="o">=</span><span class="p">(),</span> <span class="c1"># type: Iterable[str]</span>
<span class="p">):</span>
<span class="c1"># type: (...) -&gt; None</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">proto</span><span class="p">,</span> <span class="n">beam_fn_api_pb2</span><span class="o">.</span><span class="n">ProcessBundleDescriptor</span><span class="p">):</span>
<span class="n">proto</span> <span class="o">=</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">Components</span><span class="p">(</span>
<span class="n">coders</span><span class="o">=</span><span class="nb">dict</span><span class="p">(</span><span class="n">proto</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">items</span><span class="p">()),</span>
<span class="n">windowing_strategies</span><span class="o">=</span><span class="nb">dict</span><span class="p">(</span><span class="n">proto</span><span class="o">.</span><span class="n">windowing_strategies</span><span class="o">.</span><span class="n">items</span><span class="p">()),</span>
<span class="n">environments</span><span class="o">=</span><span class="nb">dict</span><span class="p">(</span><span class="n">proto</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">items</span><span class="p">()))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">component_id_map</span> <span class="o">=</span> <span class="n">component_id_map</span> <span class="ow">or</span> <span class="n">ComponentIdMap</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span>
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">component_id_map</span><span class="o">.</span><span class="n">namespace</span> <span class="o">==</span> <span class="n">namespace</span>
<span class="c1"># TODO(https://github.com/apache/beam/issues/20827) Initialize</span>
<span class="c1"># component_id_map with objects from proto.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">transforms</span> <span class="o">=</span> <span class="n">_PipelineContextMap</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">pipeline</span><span class="o">.</span><span class="n">AppliedPTransform</span><span class="p">,</span>
<span class="n">namespace</span><span class="p">,</span>
<span class="n">proto</span><span class="o">.</span><span class="n">transforms</span> <span class="k">if</span> <span class="n">proto</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pcollections</span> <span class="o">=</span> <span class="n">_PipelineContextMap</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">pvalue</span><span class="o">.</span><span class="n">PCollection</span><span class="p">,</span>
<span class="n">namespace</span><span class="p">,</span>
<span class="n">proto</span><span class="o">.</span><span class="n">pcollections</span> <span class="k">if</span> <span class="n">proto</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">coders</span> <span class="o">=</span> <span class="n">_PipelineContextMap</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">coders</span><span class="o">.</span><span class="n">Coder</span><span class="p">,</span>
<span class="n">namespace</span><span class="p">,</span>
<span class="n">proto</span><span class="o">.</span><span class="n">coders</span> <span class="k">if</span> <span class="n">proto</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">windowing_strategies</span> <span class="o">=</span> <span class="n">_PipelineContextMap</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">core</span><span class="o">.</span><span class="n">Windowing</span><span class="p">,</span>
<span class="n">namespace</span><span class="p">,</span>
<span class="n">proto</span><span class="o">.</span><span class="n">windowing_strategies</span> <span class="k">if</span> <span class="n">proto</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environments</span> <span class="o">=</span> <span class="n">_PipelineContextMap</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">environments</span><span class="o">.</span><span class="n">Environment</span><span class="p">,</span>
<span class="n">namespace</span><span class="p">,</span>
<span class="n">proto</span><span class="o">.</span><span class="n">environments</span> <span class="k">if</span> <span class="n">proto</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">default_environment</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">default_environment</span> <span class="o">=</span> <span class="n">environments</span><span class="o">.</span><span class="n">DefaultEnvironment</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_default_environment_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span>
<span class="n">default_environment</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s1">&#39;default_environment&#39;</span><span class="p">)</span> <span class="c1"># type: str</span>
<span class="bp">self</span><span class="o">.</span><span class="n">use_fake_coders</span> <span class="o">=</span> <span class="n">use_fake_coders</span>
<span class="bp">self</span><span class="o">.</span><span class="n">deterministic_coder_map</span> <span class="o">=</span> <span class="p">{</span>
<span class="p">}</span> <span class="c1"># type: Mapping[coders.Coder, coders.Coder]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">iterable_state_read</span> <span class="o">=</span> <span class="n">iterable_state_read</span>
<span class="bp">self</span><span class="o">.</span><span class="n">iterable_state_write</span> <span class="o">=</span> <span class="n">iterable_state_write</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_requirements</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">requirements</span><span class="p">)</span>
<div class="viewcode-block" id="PipelineContext.add_requirement"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext.add_requirement">[docs]</a> <span class="k">def</span> <span class="nf">add_requirement</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">requirement</span><span class="p">):</span>
<span class="c1"># type: (str) -&gt; None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_requirements</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">requirement</span><span class="p">)</span></div>
<div class="viewcode-block" id="PipelineContext.requirements"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext.requirements">[docs]</a> <span class="k">def</span> <span class="nf">requirements</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; FrozenSet[str]</span>
<span class="k">return</span> <span class="nb">frozenset</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_requirements</span><span class="p">)</span></div>
<span class="c1"># If fake coders are requested, return a pickled version of the element type</span>
<span class="c1"># rather than an actual coder. The element type is required for some runners,</span>
<span class="c1"># as well as performing a round-trip through protos.</span>
<span class="c1"># TODO(https://github.com/apache/beam/issues/18490): Remove once this is no</span>
<span class="c1"># longer needed.</span>
<div class="viewcode-block" id="PipelineContext.coder_id_from_element_type"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext.coder_id_from_element_type">[docs]</a> <span class="k">def</span> <span class="nf">coder_id_from_element_type</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">element_type</span><span class="p">,</span> <span class="n">requires_deterministic_key_coder</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (Any, Optional[str]) -&gt; str</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_fake_coders</span><span class="p">:</span>
<span class="k">return</span> <span class="n">pickler</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">element_type</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;ascii&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">coder</span> <span class="o">=</span> <span class="n">coders</span><span class="o">.</span><span class="n">registry</span><span class="o">.</span><span class="n">get_coder</span><span class="p">(</span><span class="n">element_type</span><span class="p">)</span>
<span class="k">if</span> <span class="n">requires_deterministic_key_coder</span><span class="p">:</span>
<span class="n">coder</span> <span class="o">=</span> <span class="n">coders</span><span class="o">.</span><span class="n">TupleCoder</span><span class="p">([</span>
<span class="bp">self</span><span class="o">.</span><span class="n">deterministic_coder</span><span class="p">(</span>
<span class="n">coder</span><span class="o">.</span><span class="n">key_coder</span><span class="p">(),</span> <span class="n">requires_deterministic_key_coder</span><span class="p">),</span>
<span class="n">coder</span><span class="o">.</span><span class="n">value_coder</span><span class="p">()</span>
<span class="p">])</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="n">coder</span><span class="p">)</span></div>
<div class="viewcode-block" id="PipelineContext.deterministic_coder"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext.deterministic_coder">[docs]</a> <span class="k">def</span> <span class="nf">deterministic_coder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coder</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
<span class="c1"># type: (coders.Coder, str) -&gt; coders.Coder</span>
<span class="k">if</span> <span class="n">coder</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">deterministic_coder_map</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">deterministic_coder_map</span><span class="p">[</span><span class="n">coder</span><span class="p">]</span> <span class="o">=</span> <span class="n">coder</span><span class="o">.</span><span class="n">as_deterministic_coder</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="c1"># type: ignore</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">deterministic_coder_map</span><span class="p">[</span><span class="n">coder</span><span class="p">]</span></div>
<div class="viewcode-block" id="PipelineContext.element_type_from_coder_id"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext.element_type_from_coder_id">[docs]</a> <span class="k">def</span> <span class="nf">element_type_from_coder_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coder_id</span><span class="p">):</span>
<span class="c1"># type: (str) -&gt; Any</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_fake_coders</span> <span class="ow">or</span> <span class="n">coder_id</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">coders</span><span class="p">:</span>
<span class="k">return</span> <span class="n">pickler</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">coder_id</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">native_type_compatibility</span><span class="o">.</span><span class="n">convert_to_beam_type</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">coders</span><span class="p">[</span><span class="n">coder_id</span><span class="p">]</span><span class="o">.</span><span class="n">to_type_hint</span><span class="p">())</span></div>
<div class="viewcode-block" id="PipelineContext.from_runner_api"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext.from_runner_api">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">from_runner_api</span><span class="p">(</span><span class="n">proto</span><span class="p">):</span>
<span class="c1"># type: (beam_runner_api_pb2.Components) -&gt; PipelineContext</span>
<span class="k">return</span> <span class="n">PipelineContext</span><span class="p">(</span><span class="n">proto</span><span class="p">)</span></div>
<div class="viewcode-block" id="PipelineContext.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext.to_runner_api">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; beam_runner_api_pb2.Components</span>
<span class="n">context_proto</span> <span class="o">=</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">Components</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">transforms</span><span class="o">.</span><span class="n">populate_map</span><span class="p">(</span><span class="n">context_proto</span><span class="o">.</span><span class="n">transforms</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pcollections</span><span class="o">.</span><span class="n">populate_map</span><span class="p">(</span><span class="n">context_proto</span><span class="o">.</span><span class="n">pcollections</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">populate_map</span><span class="p">(</span><span class="n">context_proto</span><span class="o">.</span><span class="n">coders</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">windowing_strategies</span><span class="o">.</span><span class="n">populate_map</span><span class="p">(</span><span class="n">context_proto</span><span class="o">.</span><span class="n">windowing_strategies</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">populate_map</span><span class="p">(</span><span class="n">context_proto</span><span class="o">.</span><span class="n">environments</span><span class="p">)</span>
<span class="k">return</span> <span class="n">context_proto</span></div>
<div class="viewcode-block" id="PipelineContext.default_environment_id"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext.default_environment_id">[docs]</a> <span class="k">def</span> <span class="nf">default_environment_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; str</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default_environment_id</span></div>
<div class="viewcode-block" id="PipelineContext.get_environment_id_for_resource_hints"><a class="viewcode-back" href="../../../apache_beam.runners.pipeline_context.html#apache_beam.io.iobase.PipelineContext.get_environment_id_for_resource_hints">[docs]</a> <span class="k">def</span> <span class="nf">get_environment_id_for_resource_hints</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">hints</span><span class="p">):</span> <span class="c1"># type: (Dict[str, bytes]) -&gt; str</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns an environment id that has necessary resource hints.&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">hints</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_environment_id</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">get_or_create_environment_with_resource_hints</span><span class="p">(</span>
<span class="n">template_env_id</span><span class="p">,</span>
<span class="n">resource_hints</span><span class="p">,</span>
<span class="p">):</span> <span class="c1"># type: (str, Dict[str, bytes]) -&gt; str</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Creates an environment that has necessary hints and returns its id.&quot;&quot;&quot;</span>
<span class="n">template_env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">get_proto_from_id</span><span class="p">(</span><span class="n">template_env_id</span><span class="p">)</span>
<span class="n">cloned_env</span> <span class="o">=</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">Environment</span><span class="p">()</span>
<span class="c1"># (TODO https://github.com/apache/beam/issues/25615)</span>
<span class="c1"># Remove the suppress warning for type once mypy is updated to 0.941 or</span>
<span class="c1"># higher.</span>
<span class="c1"># mypy 0.790 throws the warning below but 0.941 doesn&#39;t.</span>
<span class="c1"># error: Argument 1 to &quot;CopyFrom&quot; of &quot;Message&quot; has incompatible type</span>
<span class="c1"># &quot;Message&quot;; expected &quot;Environment&quot; [arg-type]</span>
<span class="c1"># Here, Environment is a subclass of Message but mypy still</span>
<span class="c1"># throws an error.</span>
<span class="n">cloned_env</span><span class="o">.</span><span class="n">CopyFrom</span><span class="p">(</span><span class="n">template_env</span><span class="p">)</span> <span class="c1"># type: ignore[arg-type]</span>
<span class="n">cloned_env</span><span class="o">.</span><span class="n">resource_hints</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
<span class="n">cloned_env</span><span class="o">.</span><span class="n">resource_hints</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">resource_hints</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">get_by_proto</span><span class="p">(</span>
<span class="n">cloned_env</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s1">&#39;environment_with_resource_hints&#39;</span><span class="p">,</span> <span class="n">deduplicate</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">default_env_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_environment_id</span><span class="p">()</span>
<span class="n">env_hints</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">get_by_id</span><span class="p">(</span><span class="n">default_env_id</span><span class="p">)</span><span class="o">.</span><span class="n">resource_hints</span><span class="p">()</span>
<span class="n">hints</span> <span class="o">=</span> <span class="n">merge_resource_hints</span><span class="p">(</span><span class="n">outer_hints</span><span class="o">=</span><span class="n">env_hints</span><span class="p">,</span> <span class="n">inner_hints</span><span class="o">=</span><span class="n">hints</span><span class="p">)</span>
<span class="n">maybe_new_env_id</span> <span class="o">=</span> <span class="n">get_or_create_environment_with_resource_hints</span><span class="p">(</span>
<span class="n">default_env_id</span><span class="p">,</span> <span class="n">hints</span><span class="p">)</span>
<span class="k">return</span> <span class="n">maybe_new_env_id</span></div></div>
</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>