| |
| |
| <!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" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.utils.annotations module — Apache Beam 2.68.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=2388e03a"></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" /> |
| <link rel="next" title="apache_beam.utils.histogram module" href="apache_beam.utils.histogram.html" /> |
| <link rel="prev" title="apache_beam.utils package" href="apache_beam.utils.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 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.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 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 current"><a class="current reference internal" href="#">apache_beam.utils.annotations module</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.utils.annotations.BeamDeprecationWarning"><code class="docutils literal notranslate"><span class="pre">BeamDeprecationWarning</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.utils.annotations.annotate"><code class="docutils literal notranslate"><span class="pre">annotate()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.utils.annotations.deprecated"><code class="docutils literal notranslate"><span class="pre">deprecated()</span></code></a></li> |
| </ul> |
| </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.multi_process_shared.html">apache_beam.utils.multi_process_shared 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.python_callable.html">apache_beam.utils.python_callable 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"><a class="reference internal" href="apache_beam.utils.subprocess_server.html">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.transform_service_launcher.html">apache_beam.utils.transform_service_launcher 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> |
| <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="apache_beam.utils.html">apache_beam.utils package</a></li> |
| <li class="breadcrumb-item active">apache_beam.utils.annotations module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.utils.annotations.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"> |
| |
| <section id="module-apache_beam.utils.annotations"> |
| <span id="apache-beam-utils-annotations-module"></span><h1>apache_beam.utils.annotations module<a class="headerlink" href="#module-apache_beam.utils.annotations" title="Link to this heading"></a></h1> |
| <p>Deprecated annotations.</p> |
| <p>Deprecated: Signifies that users are discouraged from using a public API |
| typically because a better alternative exists, and the current form might be |
| removed in a future version.</p> |
| <p>Usage: |
| For internal use only; no backwards-compatibility guarantees.</p> |
| <p>Annotations come in two flavors: deprecated and experimental</p> |
| <p>The ‘deprecated’ annotation requires a ‘since” parameter to specify |
| what version deprecated it. |
| Both ‘deprecated’ and ‘experimental’ annotations can specify the |
| current recommended version to use by means of a ‘current’ parameter.</p> |
| <p>The following example illustrates how to annotate coexisting versions of the |
| same function ‘multiply’.:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">multiply</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">):</span> |
| <span class="nb">print</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="n">arg2</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">' '</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">arg1</span><span class="o">*</span><span class="n">arg2</span> |
| </pre></div> |
| </div> |
| <p># This annotation marks ‘old_multiply’ as deprecated since ‘v.1’ and suggests |
| # using ‘multiply’ instead.:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@deprecated</span><span class="p">(</span><span class="n">since</span><span class="o">=</span><span class="s1">'v.1'</span><span class="p">,</span> <span class="n">current</span><span class="o">=</span><span class="s1">'multiply'</span><span class="p">)</span> |
| <span class="k">def</span><span class="w"> </span><span class="nf">old_multiply</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">):</span> |
| <span class="n">result</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">xrange</span><span class="p">(</span><span class="n">arg1</span><span class="p">):</span> |
| <span class="n">result</span> <span class="o">+=</span> <span class="n">arg2</span> |
| <span class="nb">print</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="n">arg2</span><span class="p">,</span> <span class="s1">'(the old way)='</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">' '</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">result</span> |
| </pre></div> |
| </div> |
| <p># Set a warning filter to control how often warnings are produced.:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">warnings</span><span class="o">.</span><span class="n">simplefilter</span><span class="p">(</span><span class="s2">"always"</span><span class="p">)</span> |
| <span class="nb">print</span><span class="p">(</span><span class="n">multiply</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">))</span> |
| <span class="nb">print</span><span class="p">(</span><span class="n">old_multiply</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">))</span> |
| </pre></div> |
| </div> |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="apache_beam.utils.annotations.BeamDeprecationWarning"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.utils.annotations.</span></span><span class="sig-name descname"><span class="pre">BeamDeprecationWarning</span></span><a class="reference internal" href="_modules/apache_beam/utils/annotations.html#BeamDeprecationWarning"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.utils.annotations.BeamDeprecationWarning" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#DeprecationWarning" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeprecationWarning</span></code></a></p> |
| <p>Beam-specific deprecation warnings.</p> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.utils.annotations.annotate"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.utils.annotations.</span></span><span class="sig-name descname"><span class="pre">annotate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">label</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">current</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/utils/annotations.html#annotate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.utils.annotations.annotate" title="Link to this definition"></a></dt> |
| <dd><p>Decorates an API with a deprecated or experimental annotation.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>label</strong> – the kind of annotation (‘deprecated’ or ‘experimental’).</p></li> |
| <li><p><strong>since</strong> – the version that causes the annotation.</p></li> |
| <li><p><strong>current</strong> – the suggested replacement function.</p></li> |
| <li><p><strong>extra_message</strong> – an optional additional message.</p></li> |
| <li><p><strong>custom_message</strong> – if the default message does not suffice, the message |
| can be changed using this argument. A string |
| whit replacement tokens. |
| A replecement string is were the previus args will |
| be located on the custom message. |
| The following replacement strings can be used: |
| %name% -> API.__name__ |
| %since% -> since (Mandatory for the decapreted annotation) |
| %current% -> current |
| %extra% -> extra_message</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The decorator for the API.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.utils.annotations.deprecated"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.utils.annotations.</span></span><span class="sig-name descname"><span class="pre">deprecated</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'deprecated'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">current</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.utils.annotations.deprecated" title="Link to this definition"></a></dt> |
| <dd><p>Decorates an API with a deprecated or experimental annotation.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>label</strong> – the kind of annotation (‘deprecated’ or ‘experimental’).</p></li> |
| <li><p><strong>since</strong> – the version that causes the annotation.</p></li> |
| <li><p><strong>current</strong> – the suggested replacement function.</p></li> |
| <li><p><strong>extra_message</strong> – an optional additional message.</p></li> |
| <li><p><strong>custom_message</strong> – if the default message does not suffice, the message |
| can be changed using this argument. A string |
| whit replacement tokens. |
| A replecement string is were the previus args will |
| be located on the custom message. |
| The following replacement strings can be used: |
| %name% -> API.__name__ |
| %since% -> since (Mandatory for the decapreted annotation) |
| %current% -> current |
| %extra% -> extra_message</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The decorator for the API.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.utils.html" class="btn btn-neutral float-left" title="apache_beam.utils package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.utils.histogram.html" class="btn btn-neutral float-right" title="apache_beam.utils.histogram module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <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> |
