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 / testing / strategies.html
blob: 0d878ccdc971556a3528a4b77cfc28f181a9450b [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.testing.strategies &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.testing.strategies</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.testing.strategies</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;hypothesis strategies for generating schema types.</span>
<span class="sd">Intended for internal use only, no backward-compatibility guarantees.&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">keyword</span>
<span class="kn">import</span> <span class="nn">unicodedata</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Mapping</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Sequence</span>
<span class="kn">from</span> <span class="nn">hypothesis</span> <span class="kn">import</span> <span class="n">strategies</span> <span class="k">as</span> <span class="n">st</span>
<span class="kn">from</span> <span class="nn">apache_beam.typehints</span> <span class="kn">import</span> <span class="n">row_type</span>
<span class="kn">from</span> <span class="nn">apache_beam.typehints.schemas</span> <span class="kn">import</span> <span class="n">_PRIMITIVES</span>
<span class="n">PRIMITIVES</span> <span class="o">=</span> <span class="p">[</span><span class="n">p</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">_PRIMITIVES</span><span class="p">]</span>
<div class="viewcode-block" id="field_names"><a class="viewcode-back" href="../../../../apache_beam.typehints.testing.strategies.html#apache_beam.typehints.testing.strategies.field_names">[docs]</a><span class="k">def</span> <span class="nf">field_names</span><span class="p">():</span>
<span class="nd">@st</span><span class="o">.</span><span class="n">composite</span>
<span class="k">def</span> <span class="nf">field_name_candidates</span><span class="p">(</span><span class="n">draw</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Strategy to produce valid field names for Beam schema types.&quot;&quot;&quot;</span>
<span class="c1"># unicode categories that cannot be used in Python identifiers</span>
<span class="n">identifer_denylist</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Lo&#39;</span><span class="p">,</span> <span class="s1">&#39;Lm&#39;</span><span class="p">,</span> <span class="s1">&#39;C&#39;</span><span class="p">,</span> <span class="s1">&#39;P&#39;</span><span class="p">,</span> <span class="s1">&#39;Sm&#39;</span><span class="p">,</span> <span class="s1">&#39;Sc&#39;</span><span class="p">,</span> <span class="s1">&#39;So&#39;</span><span class="p">,</span> <span class="s1">&#39;Sk&#39;</span><span class="p">,</span> <span class="s1">&#39;M&#39;</span><span class="p">,</span> <span class="s1">&#39;No&#39;</span><span class="p">,</span> <span class="s1">&#39;Z&#39;</span><span class="p">)</span>
<span class="c1"># First character can&#39;t be numeric (Nd).</span>
<span class="c1"># It also can&#39;t start with &#39;_&#39; in a NamedTuple.</span>
<span class="n">field_first_character</span> <span class="o">=</span> <span class="n">draw</span><span class="p">(</span>
<span class="n">st</span><span class="o">.</span><span class="n">text</span><span class="p">(</span>
<span class="n">alphabet</span><span class="o">=</span><span class="n">st</span><span class="o">.</span><span class="n">characters</span><span class="p">(</span>
<span class="n">blacklist_categories</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;Nd&#39;</span><span class="p">,</span> <span class="p">)</span> <span class="o">+</span> <span class="n">identifer_denylist</span><span class="p">,</span>
<span class="n">blacklist_characters</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)),</span>
<span class="n">min_size</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">max_size</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span>
<span class="n">field_remainder</span> <span class="o">=</span> <span class="n">draw</span><span class="p">(</span>
<span class="n">st</span><span class="o">.</span><span class="n">text</span><span class="p">(</span>
<span class="n">alphabet</span><span class="o">=</span><span class="n">st</span><span class="o">.</span><span class="n">characters</span><span class="p">(</span><span class="n">blacklist_categories</span><span class="o">=</span><span class="n">identifer_denylist</span><span class="p">)))</span>
<span class="k">return</span> <span class="n">field_first_character</span> <span class="o">+</span> <span class="n">field_remainder</span>
<span class="k">return</span> <span class="n">field_name_candidates</span><span class="p">()</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span>
<span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">isidentifier</span><span class="p">()</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">keyword</span><span class="o">.</span><span class="n">iskeyword</span><span class="p">(</span><span class="n">s</span><span class="p">))</span></div>
<span class="k">def</span> <span class="nf">_named_fields_from_types</span><span class="p">(</span><span class="n">types</span><span class="p">):</span>
<span class="k">return</span> <span class="n">st</span><span class="o">.</span><span class="n">lists</span><span class="p">(</span>
<span class="n">st</span><span class="o">.</span><span class="n">tuples</span><span class="p">(</span><span class="n">field_names</span><span class="p">(),</span> <span class="n">types</span><span class="p">),</span>
<span class="n">min_size</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="c1"># Python identifiers are normalized with form NFKC (see</span>
<span class="c1"># https://peps.python.org/pep-0672/#normalizing-identifiers). We use the</span>
<span class="c1"># same normalization here to avoid name collisions.</span>
<span class="n">unique_by</span><span class="o">=</span><span class="k">lambda</span> <span class="n">name_and_type</span><span class="p">:</span> <span class="n">unicodedata</span><span class="o">.</span><span class="n">normalize</span><span class="p">(</span>
<span class="s1">&#39;NFKC&#39;</span><span class="p">,</span> <span class="n">name_and_type</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span>
<span class="p">)</span>
<div class="viewcode-block" id="types"><a class="viewcode-back" href="../../../../apache_beam.typehints.testing.strategies.html#apache_beam.typehints.testing.strategies.types">[docs]</a><span class="k">def</span> <span class="nf">types</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Strategy to produce types that are convertible to Beam schema FieldType</span>
<span class="sd"> instances.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">_extend_types</span><span class="p">(</span><span class="n">types</span><span class="p">):</span>
<span class="n">optionals</span> <span class="o">=</span> <span class="n">types</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">typ</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">typ</span><span class="p">])</span>
<span class="n">sequences</span> <span class="o">=</span> <span class="n">types</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">typ</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">typ</span><span class="p">])</span>
<span class="n">mappings</span> <span class="o">=</span> <span class="n">st</span><span class="o">.</span><span class="n">tuples</span><span class="p">(</span><span class="n">types</span><span class="p">,</span>
<span class="n">types</span><span class="p">)</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">typs</span><span class="p">:</span> <span class="n">Mapping</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="n">typs</span><span class="p">[</span><span class="mi">1</span><span class="p">]])</span>
<span class="n">rows</span> <span class="o">=</span> <span class="n">_named_fields_from_types</span><span class="p">(</span><span class="n">types</span><span class="p">)</span><span class="o">.</span><span class="n">map</span><span class="p">(</span>
<span class="n">row_type</span><span class="o">.</span><span class="n">RowTypeConstraint</span><span class="o">.</span><span class="n">from_fields</span><span class="p">)</span>
<span class="k">return</span> <span class="n">st</span><span class="o">.</span><span class="n">one_of</span><span class="p">(</span><span class="n">optionals</span><span class="p">,</span> <span class="n">sequences</span><span class="p">,</span> <span class="n">mappings</span><span class="p">,</span> <span class="n">rows</span><span class="p">)</span>
<span class="c1"># TODO: Currently this will only draw from the primitive types that can be</span>
<span class="c1"># roundtripped faithfully (e.g. np.int64, not int). We should add support for</span>
<span class="c1"># other types:</span>
<span class="c1"># - Logical Types (e.g. Timestamp)</span>
<span class="c1"># - Shunted primitive types (e.g. int)</span>
<span class="c1"># We&#39;ll need to provide support for limiting the types that are drawn. This</span>
<span class="c1"># could be similar to the allowlist[_categories]/denylist[_categories] pattern</span>
<span class="c1"># used in st.characters.</span>
<span class="k">return</span> <span class="n">st</span><span class="o">.</span><span class="n">recursive</span><span class="p">(</span><span class="n">st</span><span class="o">.</span><span class="n">sampled_from</span><span class="p">(</span><span class="n">PRIMITIVES</span><span class="p">),</span> <span class="n">_extend_types</span><span class="p">)</span></div>
<div class="viewcode-block" id="named_fields"><a class="viewcode-back" href="../../../../apache_beam.typehints.testing.strategies.html#apache_beam.typehints.testing.strategies.named_fields">[docs]</a><span class="k">def</span> <span class="nf">named_fields</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Strategy to produce a set of named fields (type ``List[Tuple[str,</span>
<span class="sd"> type]]``).&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">_named_fields_from_types</span><span class="p">(</span><span class="n">types</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>