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 / typehints / native_type_compatibility.html
blob: a8c8e438ec87596c4dd41049a9dda7a3efb363f1 [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.typehints.native_type_compatibility &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.typehints.native_type_compatibility</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.typehints.native_type_compatibility</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;Module to convert Python&#39;s native typing types to Beam types.&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</span>
<span class="kn">import</span> <span class="nn">collections</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">types</span>
<span class="kn">import</span> <span class="nn">typing</span>
<span class="kn">from</span> <span class="nn">apache_beam.typehints</span> <span class="kn">import</span> <span class="n">typehints</span>
<span class="n">_LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<span class="c1"># Describes an entry in the type map in convert_to_beam_type.</span>
<span class="c1"># match is a function that takes a user type and returns whether the conversion</span>
<span class="c1"># should trigger.</span>
<span class="c1"># arity is the expected arity of the user type. -1 means it&#39;s variadic.</span>
<span class="c1"># beam_type is the Beam type the user type should map to.</span>
<span class="n">_TypeMapEntry</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span>
<span class="s1">&#39;_TypeMapEntry&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;match&#39;</span><span class="p">,</span> <span class="s1">&#39;arity&#39;</span><span class="p">,</span> <span class="s1">&#39;beam_type&#39;</span><span class="p">])</span>
<span class="n">_BUILTINS_TO_TYPING</span> <span class="o">=</span> <span class="p">{</span>
<span class="nb">dict</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span>
<span class="nb">list</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">,</span>
<span class="nb">tuple</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">,</span>
<span class="nb">set</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Set</span><span class="p">,</span>
<span class="nb">frozenset</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">FrozenSet</span><span class="p">,</span>
<span class="p">}</span>
<span class="k">def</span> <span class="nf">_get_args</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns a list of arguments to the given type.</span>
<span class="sd"> Args:</span>
<span class="sd"> typ: A typing module typing type.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A tuple of args.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">typ</span><span class="o">.</span><span class="n">__args__</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="p">()</span>
<span class="k">return</span> <span class="n">typ</span><span class="o">.</span><span class="n">__args__</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">TypeVar</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="p">)</span>
<span class="k">return</span> <span class="p">()</span>
<span class="k">def</span> <span class="nf">_safe_issubclass</span><span class="p">(</span><span class="n">derived</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Like issubclass, but swallows TypeErrors.</span>
<span class="sd"> This is useful for when either parameter might not actually be a class,</span>
<span class="sd"> e.g. typing.Union isn&#39;t actually a class.</span>
<span class="sd"> Args:</span>
<span class="sd"> derived: As in issubclass.</span>
<span class="sd"> parent: As in issubclass.</span>
<span class="sd"> Returns:</span>
<span class="sd"> issubclass(derived, parent), or False if a TypeError was raised.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">derived</span><span class="p">,</span> <span class="n">parent</span><span class="p">)</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">TypeError</span><span class="p">,</span> <span class="ne">AttributeError</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">derived</span><span class="p">,</span> <span class="s1">&#39;__origin__&#39;</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">derived</span><span class="o">.</span><span class="n">__origin__</span><span class="p">,</span> <span class="n">parent</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">def</span> <span class="nf">_match_issubclass</span><span class="p">(</span><span class="n">match_against</span><span class="p">):</span>
<span class="k">return</span> <span class="k">lambda</span> <span class="n">user_type</span><span class="p">:</span> <span class="n">_safe_issubclass</span><span class="p">(</span><span class="n">user_type</span><span class="p">,</span> <span class="n">match_against</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_match_is_exactly_mapping</span><span class="p">(</span><span class="n">user_type</span><span class="p">):</span>
<span class="c1"># Avoid unintentionally catching all subtypes (e.g. strings and mappings).</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&lt;</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="p">):</span>
<span class="n">expected_origin</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Mapping</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">expected_origin</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">abc</span><span class="o">.</span><span class="n">Mapping</span>
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">user_type</span><span class="p">,</span> <span class="s1">&#39;__origin__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="n">expected_origin</span>
<span class="k">def</span> <span class="nf">_match_is_exactly_iterable</span><span class="p">(</span><span class="n">user_type</span><span class="p">):</span>
<span class="k">if</span> <span class="n">user_type</span> <span class="ow">is</span> <span class="n">typing</span><span class="o">.</span><span class="n">Iterable</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="c1"># Avoid unintentionally catching all subtypes (e.g. strings and mappings).</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&lt;</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="p">):</span>
<span class="n">expected_origin</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Iterable</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">expected_origin</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">abc</span><span class="o">.</span><span class="n">Iterable</span>
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">user_type</span><span class="p">,</span> <span class="s1">&#39;__origin__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="n">expected_origin</span>
<div class="viewcode-block" id="match_is_named_tuple"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.match_is_named_tuple">[docs]</a><span class="k">def</span> <span class="nf">match_is_named_tuple</span><span class="p">(</span><span class="n">user_type</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span>
<span class="n">_safe_issubclass</span><span class="p">(</span><span class="n">user_type</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">)</span> <span class="ow">and</span>
<span class="nb">hasattr</span><span class="p">(</span><span class="n">user_type</span><span class="p">,</span> <span class="s1">&#39;__annotations__&#39;</span><span class="p">))</span></div>
<span class="k">def</span> <span class="nf">_match_is_optional</span><span class="p">(</span><span class="n">user_type</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_match_is_union</span><span class="p">(</span><span class="n">user_type</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">sum</span><span class="p">(</span>
<span class="n">tp</span> <span class="ow">is</span> <span class="nb">type</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span> <span class="k">for</span> <span class="n">tp</span> <span class="ow">in</span> <span class="n">_get_args</span><span class="p">(</span><span class="n">user_type</span><span class="p">))</span> <span class="o">==</span> <span class="mi">1</span>
<div class="viewcode-block" id="extract_optional_type"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.extract_optional_type">[docs]</a><span class="k">def</span> <span class="nf">extract_optional_type</span><span class="p">(</span><span class="n">user_type</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Extracts the non-None type from Optional type user_type.</span>
<span class="sd"> If user_type is not Optional, returns None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_match_is_optional</span><span class="p">(</span><span class="n">user_type</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">next</span><span class="p">(</span><span class="n">tp</span> <span class="k">for</span> <span class="n">tp</span> <span class="ow">in</span> <span class="n">_get_args</span><span class="p">(</span><span class="n">user_type</span><span class="p">)</span> <span class="k">if</span> <span class="n">tp</span> <span class="ow">is</span> <span class="ow">not</span> <span class="nb">type</span><span class="p">(</span><span class="kc">None</span><span class="p">))</span></div>
<span class="k">def</span> <span class="nf">_match_is_union</span><span class="p">(</span><span class="n">user_type</span><span class="p">):</span>
<span class="c1"># For non-subscripted unions (Python 2.7.14+ with typing 3.64)</span>
<span class="k">if</span> <span class="n">user_type</span> <span class="ow">is</span> <span class="n">typing</span><span class="o">.</span><span class="n">Union</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">try</span><span class="p">:</span> <span class="c1"># Python 3.5.4+, or Python 2.7.14+ with typing 3.64</span>
<span class="k">return</span> <span class="n">user_type</span><span class="o">.</span><span class="n">__origin__</span> <span class="ow">is</span> <span class="n">typing</span><span class="o">.</span><span class="n">Union</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">return</span> <span class="kc">False</span>
<div class="viewcode-block" id="is_any"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.is_any">[docs]</a><span class="k">def</span> <span class="nf">is_any</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typ</span> <span class="ow">is</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span></div>
<div class="viewcode-block" id="is_new_type"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.is_new_type">[docs]</a><span class="k">def</span> <span class="nf">is_new_type</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="s1">&#39;__supertype__&#39;</span><span class="p">)</span></div>
<span class="k">try</span><span class="p">:</span>
<span class="n">_ForwardRef</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">ForwardRef</span> <span class="c1"># Python 3.7+</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="n">_ForwardRef</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">_ForwardRef</span>
<div class="viewcode-block" id="is_forward_ref"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.is_forward_ref">[docs]</a><span class="k">def</span> <span class="nf">is_forward_ref</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">_ForwardRef</span><span class="p">)</span></div>
<span class="c1"># Mapping from typing.TypeVar/typehints.TypeVariable ids to an object of the</span>
<span class="c1"># other type. Bidirectional mapping preserves typing.TypeVar instances.</span>
<span class="n">_type_var_cache</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># type: typing.Dict[int, typehints.TypeVariable]</span>
<div class="viewcode-block" id="convert_builtin_to_typing"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.convert_builtin_to_typing">[docs]</a><span class="k">def</span> <span class="nf">convert_builtin_to_typing</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert recursively a given builtin to a typing object.</span>
<span class="sd"> Args:</span>
<span class="sd"> typ (`builtins`): builtin object that exist in _BUILTINS_TO_TYPING.</span>
<span class="sd"> Returns:</span>
<span class="sd"> type: The given builtins converted to a type.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="s1">&#39;__origin__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">in</span> <span class="n">_BUILTINS_TO_TYPING</span><span class="p">:</span>
<span class="n">args</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="n">convert_builtin_to_typing</span><span class="p">,</span> <span class="n">typ</span><span class="o">.</span><span class="n">__args__</span><span class="p">)</span>
<span class="n">typ</span> <span class="o">=</span> <span class="n">_BUILTINS_TO_TYPING</span><span class="p">[</span><span class="n">typ</span><span class="o">.</span><span class="n">__origin__</span><span class="p">]</span><span class="o">.</span><span class="n">copy_with</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
<span class="k">return</span> <span class="n">typ</span></div>
<div class="viewcode-block" id="convert_collections_to_typing"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.convert_collections_to_typing">[docs]</a><span class="k">def</span> <span class="nf">convert_collections_to_typing</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Converts a given collections.abc type to a typing object.</span>
<span class="sd"> Args:</span>
<span class="sd"> typ: an object inheriting from a collections.abc object</span>
<span class="sd"> Returns:</span>
<span class="sd"> type: The corresponding typing object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="s1">&#39;__iter__&#39;</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="s1">&#39;__next__&#39;</span><span class="p">):</span>
<span class="n">typ</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Iterator</span><span class="p">[</span><span class="n">typ</span><span class="o">.</span><span class="n">__args__</span><span class="p">]</span>
<span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="s1">&#39;send&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="s1">&#39;throw&#39;</span><span class="p">):</span>
<span class="n">typ</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Generator</span><span class="p">[</span><span class="n">typ</span><span class="o">.</span><span class="n">__args__</span><span class="p">]</span>
<span class="k">elif</span> <span class="n">_match_is_exactly_iterable</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="n">typ</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">typ</span><span class="o">.</span><span class="n">__args__</span><span class="p">]</span>
<span class="k">return</span> <span class="n">typ</span></div>
<div class="viewcode-block" id="convert_to_beam_type"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.convert_to_beam_type">[docs]</a><span class="k">def</span> <span class="nf">convert_to_beam_type</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert a given typing type to a Beam type.</span>
<span class="sd"> Args:</span>
<span class="sd"> typ (`typing.Union[type, str]`): typing type or string literal representing</span>
<span class="sd"> a type.</span>
<span class="sd"> Returns:</span>
<span class="sd"> type: The given type converted to a Beam type as far as we can do the</span>
<span class="sd"> conversion.</span>
<span class="sd"> Raises:</span>
<span class="sd"> ValueError: The type was malformed.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Convert `int | float` to typing.Union[int, float]</span>
<span class="c1"># pipe operator as Union and types.UnionType are introduced</span>
<span class="c1"># in Python 3.10.</span>
<span class="c1"># GH issue: https://github.com/apache/beam/issues/21972</span>
<span class="k">if</span> <span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="mi">3</span> <span class="ow">and</span>
<span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">minor</span> <span class="o">&gt;=</span> <span class="mi">10</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">types</span><span class="o">.</span><span class="n">UnionType</span><span class="p">)):</span>
<span class="n">typ</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Union</span><span class="p">[</span><span class="n">typ</span><span class="p">]</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&gt;=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">9</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">types</span><span class="o">.</span><span class="n">GenericAlias</span><span class="p">):</span>
<span class="n">typ</span> <span class="o">=</span> <span class="n">convert_builtin_to_typing</span><span class="p">(</span><span class="n">typ</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&gt;=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">9</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="s1">&#39;__module__&#39;</span><span class="p">,</span>
<span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="s1">&#39;collections.abc&#39;</span><span class="p">:</span>
<span class="n">typ</span> <span class="o">=</span> <span class="n">convert_collections_to_typing</span><span class="p">(</span><span class="n">typ</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">TypeVar</span><span class="p">):</span>
<span class="c1"># This is a special case, as it&#39;s not parameterized by types.</span>
<span class="c1"># Also, identity must be preserved through conversion (i.e. the same</span>
<span class="c1"># TypeVar instance must get converted into the same TypeVariable instance).</span>
<span class="c1"># A global cache should be OK as the number of distinct type variables</span>
<span class="c1"># is generally small.</span>
<span class="k">if</span> <span class="nb">id</span><span class="p">(</span><span class="n">typ</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_type_var_cache</span><span class="p">:</span>
<span class="n">new_type_variable</span> <span class="o">=</span> <span class="n">typehints</span><span class="o">.</span><span class="n">TypeVariable</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span>
<span class="n">_type_var_cache</span><span class="p">[</span><span class="nb">id</span><span class="p">(</span><span class="n">typ</span><span class="p">)]</span> <span class="o">=</span> <span class="n">new_type_variable</span>
<span class="n">_type_var_cache</span><span class="p">[</span><span class="nb">id</span><span class="p">(</span><span class="n">new_type_variable</span><span class="p">)]</span> <span class="o">=</span> <span class="n">typ</span>
<span class="k">return</span> <span class="n">_type_var_cache</span><span class="p">[</span><span class="nb">id</span><span class="p">(</span><span class="n">typ</span><span class="p">)]</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="c1"># Special case for forward references.</span>
<span class="c1"># TODO(https://github.com/apache/beam/issues/19954): Currently unhandled.</span>
<span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Converting string literal type hint to Any: &quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span><span class="p">,</span> <span class="n">typ</span><span class="p">)</span>
<span class="k">return</span> <span class="n">typehints</span><span class="o">.</span><span class="n">Any</span>
<span class="k">elif</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&gt;=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">NewType</span><span class="p">):</span> <span class="c1"># pylint: disable=isinstance-second-argument-not-valid-type</span>
<span class="c1"># Special case for NewType, where, since Python 3.10, NewType is now a class</span>
<span class="c1"># rather than a function.</span>
<span class="c1"># TODO(https://github.com/apache/beam/issues/20076): Currently unhandled.</span>
<span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Converting NewType type hint to Any: &quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span><span class="p">,</span> <span class="n">typ</span><span class="p">)</span>
<span class="k">return</span> <span class="n">typehints</span><span class="o">.</span><span class="n">Any</span>
<span class="k">elif</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="s1">&#39;__module__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">!=</span> <span class="s1">&#39;typing&#39;</span><span class="p">:</span>
<span class="c1"># Only translate types from the typing module.</span>
<span class="k">return</span> <span class="n">typ</span>
<span class="n">type_map</span> <span class="o">=</span> <span class="p">[</span>
<span class="c1"># TODO(https://github.com/apache/beam/issues/20076): Currently</span>
<span class="c1"># unsupported.</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span><span class="n">match</span><span class="o">=</span><span class="n">is_new_type</span><span class="p">,</span> <span class="n">arity</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Any</span><span class="p">),</span>
<span class="c1"># TODO(https://github.com/apache/beam/issues/19954): Currently</span>
<span class="c1"># unsupported.</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span><span class="n">match</span><span class="o">=</span><span class="n">is_forward_ref</span><span class="p">,</span> <span class="n">arity</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Any</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span><span class="n">match</span><span class="o">=</span><span class="n">is_any</span><span class="p">,</span> <span class="n">arity</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Any</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span>
<span class="n">match</span><span class="o">=</span><span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">),</span>
<span class="n">arity</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Dict</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span>
<span class="n">match</span><span class="o">=</span><span class="n">_match_is_exactly_iterable</span><span class="p">,</span>
<span class="n">arity</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Iterable</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span>
<span class="n">match</span><span class="o">=</span><span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">),</span>
<span class="n">arity</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">List</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span>
<span class="n">match</span><span class="o">=</span><span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Set</span><span class="p">),</span> <span class="n">arity</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Set</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span>
<span class="n">match</span><span class="o">=</span><span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">FrozenSet</span><span class="p">),</span>
<span class="n">arity</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">FrozenSet</span><span class="p">),</span>
<span class="c1"># NamedTuple is a subclass of Tuple, but it needs special handling.</span>
<span class="c1"># We just convert it to Any for now.</span>
<span class="c1"># This MUST appear before the entry for the normal Tuple.</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span>
<span class="n">match</span><span class="o">=</span><span class="n">match_is_named_tuple</span><span class="p">,</span> <span class="n">arity</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Any</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span>
<span class="n">match</span><span class="o">=</span><span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">),</span>
<span class="n">arity</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span>
<span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Tuple</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span><span class="n">match</span><span class="o">=</span><span class="n">_match_is_union</span><span class="p">,</span> <span class="n">arity</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Union</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span>
<span class="n">match</span><span class="o">=</span><span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Generator</span><span class="p">),</span>
<span class="n">arity</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span>
<span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Generator</span><span class="p">),</span>
<span class="n">_TypeMapEntry</span><span class="p">(</span>
<span class="n">match</span><span class="o">=</span><span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Iterator</span><span class="p">),</span>
<span class="n">arity</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">beam_type</span><span class="o">=</span><span class="n">typehints</span><span class="o">.</span><span class="n">Iterator</span><span class="p">),</span>
<span class="p">]</span>
<span class="c1"># Find the first matching entry.</span>
<span class="n">matched_entry</span> <span class="o">=</span> <span class="nb">next</span><span class="p">((</span><span class="n">entry</span> <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">type_map</span> <span class="k">if</span> <span class="n">entry</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">typ</span><span class="p">)),</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">matched_entry</span><span class="p">:</span>
<span class="c1"># Please add missing type support if you see this message.</span>
<span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Using Any for unsupported type: </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">typ</span><span class="p">)</span>
<span class="k">return</span> <span class="n">typehints</span><span class="o">.</span><span class="n">Any</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">_get_args</span><span class="p">(</span><span class="n">typ</span><span class="p">)</span>
<span class="n">len_args</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
<span class="k">if</span> <span class="n">len_args</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">len_args</span> <span class="o">!=</span> <span class="n">matched_entry</span><span class="o">.</span><span class="n">arity</span><span class="p">:</span>
<span class="n">arity</span> <span class="o">=</span> <span class="n">matched_entry</span><span class="o">.</span><span class="n">arity</span>
<span class="c1"># Handle unsubscripted types.</span>
<span class="k">if</span> <span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">)(</span><span class="n">typ</span><span class="p">):</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">(</span><span class="n">typehints</span><span class="o">.</span><span class="n">TypeVariable</span><span class="p">(</span><span class="s1">&#39;T&#39;</span><span class="p">),</span> <span class="bp">Ellipsis</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">_match_is_union</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Unsupported Union with no arguments.&#39;</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Generator</span><span class="p">)(</span><span class="n">typ</span><span class="p">):</span>
<span class="c1"># Assume a simple generator.</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">(</span><span class="n">typehints</span><span class="o">.</span><span class="n">TypeVariable</span><span class="p">(</span><span class="s1">&#39;T_co&#39;</span><span class="p">),</span> <span class="nb">type</span><span class="p">(</span><span class="kc">None</span><span class="p">),</span> <span class="nb">type</span><span class="p">(</span><span class="kc">None</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">)(</span><span class="n">typ</span><span class="p">):</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">(</span><span class="n">typehints</span><span class="o">.</span><span class="n">TypeVariable</span><span class="p">(</span><span class="s1">&#39;KT&#39;</span><span class="p">),</span> <span class="n">typehints</span><span class="o">.</span><span class="n">TypeVariable</span><span class="p">(</span><span class="s1">&#39;VT&#39;</span><span class="p">))</span>
<span class="k">elif</span> <span class="p">(</span><span class="n">_match_issubclass</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Iterator</span><span class="p">)(</span><span class="n">typ</span><span class="p">)</span> <span class="ow">or</span>
<span class="n">_match_is_exactly_iterable</span><span class="p">(</span><span class="n">typ</span><span class="p">)):</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">(</span><span class="n">typehints</span><span class="o">.</span><span class="n">TypeVariable</span><span class="p">(</span><span class="s1">&#39;T_co&#39;</span><span class="p">),</span> <span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">(</span><span class="n">typehints</span><span class="o">.</span><span class="n">TypeVariable</span><span class="p">(</span><span class="s1">&#39;T&#39;</span><span class="p">),</span> <span class="p">)</span> <span class="o">*</span> <span class="n">arity</span>
<span class="k">elif</span> <span class="n">matched_entry</span><span class="o">.</span><span class="n">arity</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
<span class="n">arity</span> <span class="o">=</span> <span class="n">len_args</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">arity</span> <span class="o">=</span> <span class="n">matched_entry</span><span class="o">.</span><span class="n">arity</span>
<span class="k">if</span> <span class="n">len_args</span> <span class="o">!=</span> <span class="n">arity</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;expecting type </span><span class="si">%s</span><span class="s1"> to have arity </span><span class="si">%d</span><span class="s1">, had arity </span><span class="si">%d</span><span class="s1"> &#39;</span>
<span class="s1">&#39;instead&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">typ</span><span class="p">),</span> <span class="n">arity</span><span class="p">,</span> <span class="n">len_args</span><span class="p">))</span>
<span class="n">typs</span> <span class="o">=</span> <span class="n">convert_to_beam_types</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
<span class="k">if</span> <span class="n">arity</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="c1"># Nullary types (e.g. Any) don&#39;t accept empty tuples as arguments.</span>
<span class="k">return</span> <span class="n">matched_entry</span><span class="o">.</span><span class="n">beam_type</span>
<span class="k">elif</span> <span class="n">arity</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="c1"># Unary types (e.g. Set) don&#39;t accept 1-tuples as arguments</span>
<span class="k">return</span> <span class="n">matched_entry</span><span class="o">.</span><span class="n">beam_type</span><span class="p">[</span><span class="n">typs</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">matched_entry</span><span class="o">.</span><span class="n">beam_type</span><span class="p">[</span><span class="nb">tuple</span><span class="p">(</span><span class="n">typs</span><span class="p">)]</span></div>
<div class="viewcode-block" id="convert_to_beam_types"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.convert_to_beam_types">[docs]</a><span class="k">def</span> <span class="nf">convert_to_beam_types</span><span class="p">(</span><span class="n">args</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert the given list or dictionary of args to Beam types.</span>
<span class="sd"> Args:</span>
<span class="sd"> args: Either an iterable of types, or a dictionary where the values are</span>
<span class="sd"> types.</span>
<span class="sd"> Returns:</span>
<span class="sd"> If given an iterable, a list of converted types. If given a dictionary,</span>
<span class="sd"> a dictionary with the same keys, and values which have been converted.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="k">return</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">convert_to_beam_type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">args</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="n">convert_to_beam_type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">args</span><span class="p">]</span></div>
<div class="viewcode-block" id="convert_to_typing_type"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.convert_to_typing_type">[docs]</a><span class="k">def</span> <span class="nf">convert_to_typing_type</span><span class="p">(</span><span class="n">typ</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Converts a given Beam type to a typing type.</span>
<span class="sd"> This is the reverse of convert_to_beam_type.</span>
<span class="sd"> Args:</span>
<span class="sd"> typ: If a typehints.TypeConstraint, the type to convert. Otherwise, typ</span>
<span class="sd"> will be unchanged.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Converted version of typ, or unchanged.</span>
<span class="sd"> Raises:</span>
<span class="sd"> ValueError: The type was malformed or could not be converted.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">TypeVariable</span><span class="p">):</span>
<span class="c1"># This is a special case, as it&#39;s not parameterized by types.</span>
<span class="c1"># Also, identity must be preserved through conversion (i.e. the same</span>
<span class="c1"># TypeVariable instance must get converted into the same TypeVar instance).</span>
<span class="c1"># A global cache should be OK as the number of distinct type variables</span>
<span class="c1"># is generally small.</span>
<span class="k">if</span> <span class="nb">id</span><span class="p">(</span><span class="n">typ</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_type_var_cache</span><span class="p">:</span>
<span class="n">new_type_variable</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">TypeVar</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">_type_var_cache</span><span class="p">[</span><span class="nb">id</span><span class="p">(</span><span class="n">typ</span><span class="p">)]</span> <span class="o">=</span> <span class="n">new_type_variable</span>
<span class="n">_type_var_cache</span><span class="p">[</span><span class="nb">id</span><span class="p">(</span><span class="n">new_type_variable</span><span class="p">)]</span> <span class="o">=</span> <span class="n">typ</span>
<span class="k">return</span> <span class="n">_type_var_cache</span><span class="p">[</span><span class="nb">id</span><span class="p">(</span><span class="n">typ</span><span class="p">)]</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="s1">&#39;__module__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">&#39;typehints&#39;</span><span class="p">):</span>
<span class="c1"># Only translate types from the typehints module.</span>
<span class="k">return</span> <span class="n">typ</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">AnyTypeConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">DictConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">[</span><span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">key_type</span><span class="p">),</span>
<span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">value_type</span><span class="p">)]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">ListConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">inner_type</span><span class="p">)]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">IterableTypeConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">inner_type</span><span class="p">)]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">UnionConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">Union</span><span class="p">[</span><span class="nb">tuple</span><span class="p">(</span><span class="n">convert_to_typing_types</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">union_types</span><span class="p">))]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">SetTypeConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">Set</span><span class="p">[</span><span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">inner_type</span><span class="p">)]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">FrozenSetTypeConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">FrozenSet</span><span class="p">[</span><span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">inner_type</span><span class="p">)]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">TupleConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">tuple</span><span class="p">(</span><span class="n">convert_to_typing_types</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">tuple_types</span><span class="p">))]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">TupleSequenceConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">inner_type</span><span class="p">),</span> <span class="o">...</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">typ</span><span class="p">,</span> <span class="n">typehints</span><span class="o">.</span><span class="n">IteratorTypeConstraint</span><span class="p">):</span>
<span class="k">return</span> <span class="n">typing</span><span class="o">.</span><span class="n">Iterator</span><span class="p">[</span><span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">typ</span><span class="o">.</span><span class="n">yielded_type</span><span class="p">)]</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Failed to convert Beam type: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">typ</span><span class="p">)</span></div>
<div class="viewcode-block" id="convert_to_typing_types"><a class="viewcode-back" href="../../../apache_beam.typehints.native_type_compatibility.html#apache_beam.typehints.native_type_compatibility.convert_to_typing_types">[docs]</a><span class="k">def</span> <span class="nf">convert_to_typing_types</span><span class="p">(</span><span class="n">args</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert the given list or dictionary of args to typing types.</span>
<span class="sd"> Args:</span>
<span class="sd"> args: Either an iterable of types, or a dictionary where the values are</span>
<span class="sd"> types.</span>
<span class="sd"> Returns:</span>
<span class="sd"> If given an iterable, a list of converted types. If given a dictionary,</span>
<span class="sd"> a dictionary with the same keys, and values which have been converted.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="k">return</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">args</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="n">convert_to_typing_type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">args</span><span class="p">]</span></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>