| |
| |
| <!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.typehints.native_type_compatibility module — Apache Beam 2.36.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" /> |
| <link rel="next" title="apache_beam.typehints.opcodes module" href="apache_beam.typehints.opcodes.html" /> |
| <link rel="prev" title="apache_beam.typehints.decorators module" href="apache_beam.typehints.decorators.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.36.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 class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.typehints.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.decorators.html">apache_beam.typehints.decorators module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.typehints.native_type_compatibility module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.opcodes.html">apache_beam.typehints.opcodes module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.row_type.html">apache_beam.typehints.row_type module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.schemas.html">apache_beam.typehints.schemas module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.sharded_key_type.html">apache_beam.typehints.sharded_key_type module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.trivial_inference.html">apache_beam.typehints.trivial_inference module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.typecheck.html">apache_beam.typehints.typecheck module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.typehints.html">apache_beam.typehints.typehints module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">Apache Beam</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li><a href="apache_beam.typehints.html">apache_beam.typehints package</a> »</li> |
| |
| <li>apache_beam.typehints.native_type_compatibility module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.typehints.native_type_compatibility.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="module-apache_beam.typehints.native_type_compatibility"> |
| <span id="apache-beam-typehints-native-type-compatibility-module"></span><h1>apache_beam.typehints.native_type_compatibility module<a class="headerlink" href="#module-apache_beam.typehints.native_type_compatibility" title="Permalink to this headline">¶</a></h1> |
| <p>Module to convert Python’s native typing types to Beam types.</p> |
| <dl class="function"> |
| <dt id="apache_beam.typehints.native_type_compatibility.match_is_named_tuple"> |
| <code class="descclassname">apache_beam.typehints.native_type_compatibility.</code><code class="descname">match_is_named_tuple</code><span class="sig-paren">(</span><em>user_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/native_type_compatibility.html#match_is_named_tuple"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.native_type_compatibility.match_is_named_tuple" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.native_type_compatibility.extract_optional_type"> |
| <code class="descclassname">apache_beam.typehints.native_type_compatibility.</code><code class="descname">extract_optional_type</code><span class="sig-paren">(</span><em>user_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/native_type_compatibility.html#extract_optional_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.native_type_compatibility.extract_optional_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Extracts the non-None type from Optional type user_type.</p> |
| <p>If user_type is not Optional, returns None</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.native_type_compatibility.is_any"> |
| <code class="descclassname">apache_beam.typehints.native_type_compatibility.</code><code class="descname">is_any</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/native_type_compatibility.html#is_any"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.native_type_compatibility.is_any" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.native_type_compatibility.is_new_type"> |
| <code class="descclassname">apache_beam.typehints.native_type_compatibility.</code><code class="descname">is_new_type</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/native_type_compatibility.html#is_new_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.native_type_compatibility.is_new_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.native_type_compatibility.is_forward_ref"> |
| <code class="descclassname">apache_beam.typehints.native_type_compatibility.</code><code class="descname">is_forward_ref</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/native_type_compatibility.html#is_forward_ref"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.native_type_compatibility.is_forward_ref" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.native_type_compatibility.convert_to_beam_type"> |
| <code class="descclassname">apache_beam.typehints.native_type_compatibility.</code><code class="descname">convert_to_beam_type</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/native_type_compatibility.html#convert_to_beam_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.native_type_compatibility.convert_to_beam_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Convert a given typing type to a Beam type.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>typ</strong> (<cite>typing.Union[type, str]</cite>) – typing type or string literal representing |
| a type.</td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The given type converted to a Beam type as far as we can do the |
| conversion.</td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.10)">type</a></td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.10)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> – The type was malformed.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.native_type_compatibility.convert_to_beam_types"> |
| <code class="descclassname">apache_beam.typehints.native_type_compatibility.</code><code class="descname">convert_to_beam_types</code><span class="sig-paren">(</span><em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/native_type_compatibility.html#convert_to_beam_types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.native_type_compatibility.convert_to_beam_types" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Convert the given list or dictionary of args to Beam types.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>args</strong> – Either an iterable of types, or a dictionary where the values are</li> |
| <li><strong>types.</strong> – </li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">If given an iterable, a list of converted types. If given a dictionary, |
| a dictionary with the same keys, and values which have been converted.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.native_type_compatibility.convert_to_typing_type"> |
| <code class="descclassname">apache_beam.typehints.native_type_compatibility.</code><code class="descname">convert_to_typing_type</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/native_type_compatibility.html#convert_to_typing_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.native_type_compatibility.convert_to_typing_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Converts a given Beam type to a typing type.</p> |
| <p>This is the reverse of convert_to_beam_type.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>typ</strong> – If a typehints.TypeConstraint, the type to convert. Otherwise, typ |
| will be unchanged.</td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Converted version of typ, or unchanged.</td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.10)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> – The type was malformed or could not be converted.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.native_type_compatibility.convert_to_typing_types"> |
| <code class="descclassname">apache_beam.typehints.native_type_compatibility.</code><code class="descname">convert_to_typing_types</code><span class="sig-paren">(</span><em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/native_type_compatibility.html#convert_to_typing_types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.native_type_compatibility.convert_to_typing_types" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Convert the given list or dictionary of args to typing types.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>args</strong> – Either an iterable of types, or a dictionary where the values are</li> |
| <li><strong>types.</strong> – </li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">If given an iterable, a list of converted types. If given a dictionary, |
| a dictionary with the same keys, and values which have been converted.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.typehints.opcodes.html" class="btn btn-neutral float-right" title="apache_beam.typehints.opcodes module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.typehints.decorators.html" class="btn btn-neutral float-left" title="apache_beam.typehints.decorators module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |