| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="../../../"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.utils.annotations — Apache Beam 2.76.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="../../../_static/jquery.js?v=5d32c60e"></script> |
| <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="../../../_static/documentation_options.js?v=f68839fd"></script> |
| <script src="../../../_static/doctools.js?v=9a2dae69"></script> |
| <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="../../../_static/js/theme.js"></script> |
| <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 role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu"> |
| <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="Mobile navigation menu" > |
| <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="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="../../index.html">Module code</a></li> |
| <li class="breadcrumb-item active">apache_beam.utils.annotations</li> |
| <li class="wy-breadcrumbs-aside"> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for apache_beam.utils.annotations</h1><div class="highlight"><pre> |
| <span></span><span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span> |
| <span class="c1"># contributor license agreements. See the NOTICE file distributed with</span> |
| <span class="c1"># this work for additional information regarding copyright ownership.</span> |
| <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span> |
| <span class="c1"># (the "License"); you may not use this file except in compliance with</span> |
| <span class="c1"># the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing, software</span> |
| <span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="c1"># See the License for the specific language governing permissions and</span> |
| <span class="c1"># limitations under the License.</span> |
| <span class="c1">#</span> |
| |
| <span class="sd">"""Deprecated annotations.</span> |
| |
| <span class="sd">Deprecated: Signifies that users are discouraged from using a public API</span> |
| <span class="sd">typically because a better alternative exists, and the current form might be</span> |
| <span class="sd">removed in a future version.</span> |
| |
| <span class="sd">Usage:</span> |
| <span class="sd">For internal use only; no backwards-compatibility guarantees.</span> |
| |
| <span class="sd">Annotations come in two flavors: deprecated and experimental</span> |
| |
| <span class="sd">The 'deprecated' annotation requires a 'since" parameter to specify</span> |
| <span class="sd">what version deprecated it.</span> |
| <span class="sd">Both 'deprecated' and 'experimental' annotations can specify the</span> |
| <span class="sd">current recommended version to use by means of a 'current' parameter.</span> |
| |
| <span class="sd">The following example illustrates how to annotate coexisting versions of the</span> |
| <span class="sd">same function 'multiply'.::</span> |
| |
| <span class="sd"> def multiply(arg1, arg2):</span> |
| <span class="sd"> print(arg1, '*', arg2, '=', end=' ')</span> |
| <span class="sd"> return arg1*arg2</span> |
| |
| <span class="sd"># This annotation marks 'old_multiply' as deprecated since 'v.1' and suggests</span> |
| <span class="sd"># using 'multiply' instead.::</span> |
| |
| <span class="sd"> @deprecated(since='v.1', current='multiply')</span> |
| <span class="sd"> def old_multiply(arg1, arg2):</span> |
| <span class="sd"> result = 0</span> |
| <span class="sd"> for i in xrange(arg1):</span> |
| <span class="sd"> result += arg2</span> |
| <span class="sd"> print(arg1, '*', arg2, '(the old way)=', end=' ')</span> |
| <span class="sd"> return result</span> |
| |
| <span class="sd"># Set a warning filter to control how often warnings are produced.::</span> |
| |
| <span class="sd"> warnings.simplefilter("always")</span> |
| <span class="sd"> print(multiply(5, 6))</span> |
| <span class="sd"> print(old_multiply(5,6))</span> |
| <span class="sd">"""</span> |
| |
| <span class="c1"># pytype: skip-file</span> |
| |
| <span class="kn">import</span><span class="w"> </span><span class="nn">inspect</span> |
| <span class="kn">import</span><span class="w"> </span><span class="nn">warnings</span> |
| <span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">partial</span> |
| <span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">wraps</span> |
| |
| |
| <span class="k">def</span><span class="w"> </span><span class="nf">_add_deprecation_notice_to_docstring</span><span class="p">(</span><span class="n">docstring</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Adds a deprecation notice to a docstring.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> docstring: The original docstring (can be None or empty).</span> |
| <span class="sd"> message: The deprecation message to add.</span> |
| |
| <span class="sd"> Returns:</span> |
| <span class="sd"> The modified docstring.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">docstring</span><span class="p">:</span> |
| <span class="k">return</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">docstring</span><span class="si">}</span><span class="se">\n\n</span><span class="s2">.. deprecated:: </span><span class="si">{</span><span class="n">message</span><span class="si">}</span><span class="s2">"</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="sa">f</span><span class="s2">".. deprecated:: </span><span class="si">{</span><span class="n">message</span><span class="si">}</span><span class="s2">"</span> |
| |
| |
| <div class="viewcode-block" id="BeamDeprecationWarning"> |
| <a class="viewcode-back" href="../../../apache_beam.utils.annotations.html#apache_beam.utils.annotations.BeamDeprecationWarning">[docs]</a> |
| <span class="k">class</span><span class="w"> </span><span class="nc">BeamDeprecationWarning</span><span class="p">(</span><span class="ne">DeprecationWarning</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Beam-specific deprecation warnings."""</span></div> |
| |
| |
| |
| <span class="c1"># Don't ignore BeamDeprecationWarnings.</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">simplefilter</span><span class="p">(</span><span class="s1">'once'</span><span class="p">,</span> <span class="n">BeamDeprecationWarning</span><span class="p">)</span> |
| |
| |
| <span class="k">class</span><span class="w"> </span><span class="nc">_WarningMessage</span><span class="p">:</span> |
| <span class="w"> </span><span class="sd">"""Utility class for assembling the warning message."""</span> |
| <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">label</span><span class="p">,</span> <span class="n">since</span><span class="p">,</span> <span class="n">current</span><span class="p">,</span> <span class="n">extra_message</span><span class="p">,</span> <span class="n">custom_message</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Initialize message, leave only name as placeholder."""</span> |
| <span class="k">if</span> <span class="n">custom_message</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">message</span> <span class="o">=</span> <span class="s1">'%name</span><span class="si">% i</span><span class="s1">s '</span> <span class="o">+</span> <span class="n">label</span> |
| <span class="k">if</span> <span class="n">label</span> <span class="o">==</span> <span class="s1">'deprecated'</span><span class="p">:</span> |
| <span class="n">message</span> <span class="o">+=</span> <span class="s1">' since </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">since</span> |
| <span class="n">message</span> <span class="o">+=</span> <span class="s1">'. Use </span><span class="si">%s</span><span class="s1"> instead.'</span> <span class="o">%</span> <span class="n">current</span> <span class="k">if</span> <span class="n">current</span> <span class="k">else</span> <span class="s1">'.'</span> |
| <span class="k">if</span> <span class="n">extra_message</span><span class="p">:</span> |
| <span class="n">message</span> <span class="o">+=</span> <span class="s1">' '</span> <span class="o">+</span> <span class="n">extra_message</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">label</span> <span class="o">==</span> <span class="s1">'deprecated'</span> <span class="ow">and</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">ince%'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">custom_message</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span> |
| <span class="s2">"Replacement string </span><span class="si">%s</span><span class="s2">ince% not found on </span><span class="se">\</span> |
| <span class="s2"> custom message"</span><span class="p">)</span> |
| <span class="n">emptyArg</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="s1">''</span> <span class="k">if</span> <span class="n">x</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">x</span> |
| <span class="n">message</span> <span class="o">=</span> <span class="n">custom_message</span>\ |
| <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1">ince%'</span><span class="p">,</span> <span class="n">emptyArg</span><span class="p">(</span><span class="n">since</span><span class="p">))</span>\ |
| <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="si">%c</span><span class="s1">urrent%'</span><span class="p">,</span> <span class="n">emptyArg</span><span class="p">(</span><span class="n">current</span><span class="p">))</span>\ |
| <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="si">%e</span><span class="s1">xtra%'</span><span class="p">,</span> <span class="n">emptyArg</span><span class="p">(</span><span class="n">extra_message</span><span class="p">))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">label</span> <span class="o">=</span> <span class="n">label</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span> |
| |
| <span class="k">def</span><span class="w"> </span><span class="nf">emit_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fnc_name</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">label</span> <span class="o">==</span> <span class="s1">'deprecated'</span><span class="p">:</span> |
| <span class="n">warning_type</span> <span class="o">=</span> <span class="n">BeamDeprecationWarning</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">warning_type</span> <span class="o">=</span> <span class="ne">FutureWarning</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">message</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'%name%'</span><span class="p">,</span> <span class="n">fnc_name</span><span class="p">),</span> <span class="n">warning_type</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="annotate"> |
| <a class="viewcode-back" href="../../../apache_beam.utils.annotations.html#apache_beam.utils.annotations.annotate">[docs]</a> |
| <span class="k">def</span><span class="w"> </span><span class="nf">annotate</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">since</span><span class="p">,</span> <span class="n">current</span><span class="p">,</span> <span class="n">extra_message</span><span class="p">,</span> <span class="n">custom_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""Decorates an API with a deprecated or experimental annotation.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> label: the kind of annotation ('deprecated' or 'experimental').</span> |
| <span class="sd"> since: the version that causes the annotation.</span> |
| <span class="sd"> current: the suggested replacement function.</span> |
| <span class="sd"> extra_message: an optional additional message.</span> |
| <span class="sd"> custom_message: if the default message does not suffice, the message</span> |
| <span class="sd"> can be changed using this argument. A string</span> |
| <span class="sd"> whit replacement tokens.</span> |
| <span class="sd"> A replecement string is were the previus args will</span> |
| <span class="sd"> be located on the custom message.</span> |
| <span class="sd"> The following replacement strings can be used:</span> |
| <span class="sd"> %name% -> API.__name__</span> |
| <span class="sd"> %since% -> since (Mandatory for the decapreted annotation)</span> |
| <span class="sd"> %current% -> current</span> |
| <span class="sd"> %extra% -> extra_message</span> |
| |
| <span class="sd"> Returns:</span> |
| <span class="sd"> The decorator for the API.</span> |
| <span class="sd"> """</span> |
| <span class="n">warning_message</span> <span class="o">=</span> <span class="n">_WarningMessage</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">since</span><span class="o">=</span><span class="n">since</span><span class="p">,</span> |
| <span class="n">current</span><span class="o">=</span><span class="n">current</span><span class="p">,</span> |
| <span class="n">extra_message</span><span class="o">=</span><span class="n">extra_message</span><span class="p">,</span> |
| <span class="n">custom_message</span><span class="o">=</span><span class="n">custom_message</span><span class="p">)</span> |
| |
| <span class="k">def</span><span class="w"> </span><span class="nf">_annotate</span><span class="p">(</span><span class="n">fnc</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">(</span><span class="n">fnc</span><span class="p">):</span> |
| <span class="c1"># Wrapping class into function causes documentation rendering issue.</span> |
| <span class="c1"># Patch class's __new__ method instead.</span> |
| <span class="n">old_new</span> <span class="o">=</span> <span class="n">fnc</span><span class="o">.</span><span class="fm">__new__</span> |
| |
| <span class="k">def</span><span class="w"> </span><span class="nf">wrapped_new</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| <span class="c1"># Emit a warning when class instance is created.</span> |
| <span class="n">warning_message</span><span class="o">.</span><span class="n">emit_warning</span><span class="p">(</span><span class="n">fnc</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">old_new</span> <span class="ow">is</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__new__</span><span class="p">:</span> |
| <span class="c1"># object.__new__ takes no extra argument for python>=3</span> |
| <span class="k">return</span> <span class="n">old_new</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">old_new</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| |
| <span class="n">fnc</span><span class="o">.</span><span class="fm">__new__</span> <span class="o">=</span> <span class="nb">staticmethod</span><span class="p">(</span><span class="n">wrapped_new</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">label</span> <span class="o">==</span> <span class="s1">'deprecated'</span><span class="p">:</span> |
| <span class="n">fnc</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="n">_add_deprecation_notice_to_docstring</span><span class="p">(</span> |
| <span class="n">fnc</span><span class="o">.</span><span class="vm">__doc__</span><span class="p">,</span> |
| <span class="n">warning_message</span><span class="o">.</span><span class="n">message</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'%name%'</span><span class="p">,</span> <span class="n">fnc</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">fnc</span> |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="nd">@wraps</span><span class="p">(</span><span class="n">fnc</span><span class="p">)</span> |
| <span class="k">def</span><span class="w"> </span><span class="nf">inner</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| <span class="c1"># Emit a warning when the function is called.</span> |
| <span class="n">warning_message</span><span class="o">.</span><span class="n">emit_warning</span><span class="p">(</span><span class="n">fnc</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">fnc</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">label</span> <span class="o">==</span> <span class="s1">'deprecated'</span><span class="p">:</span> |
| <span class="n">inner</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="n">_add_deprecation_notice_to_docstring</span><span class="p">(</span> |
| <span class="n">fnc</span><span class="o">.</span><span class="vm">__doc__</span><span class="p">,</span> |
| <span class="n">warning_message</span><span class="o">.</span><span class="n">message</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'%name%'</span><span class="p">,</span> <span class="n">fnc</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">inner</span> |
| |
| <span class="k">return</span> <span class="n">_annotate</span></div> |
| |
| |
| |
| <span class="c1"># Use partial application to customize each annotation.</span> |
| <span class="c1"># 'current' will be optional in both deprecated and experimental</span> |
| <span class="c1"># while 'since' will be mandatory for deprecated.</span> |
| <span class="n">deprecated</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span> |
| <span class="n">annotate</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s1">'deprecated'</span><span class="p">,</span> <span class="n">current</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">extra_message</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> |
| </pre></div> |
| |
| </div> |
| </div> |
| <footer> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
