diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/sqlglot/helper.html | 1115 |
1 files changed, 580 insertions, 535 deletions
diff --git a/docs/sqlglot/helper.html b/docs/sqlglot/helper.html index 42b0455..57c0dc1 100644 --- a/docs/sqlglot/helper.html +++ b/docs/sqlglot/helper.html @@ -3,7 +3,7 @@ <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="generator" content="pdoc 13.1.0"/> + <meta name="generator" content="pdoc 13.1.1"/> <title>sqlglot.helper API documentation</title> <style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style> @@ -252,298 +252,320 @@ </span><span id="L-131"><a href="#L-131"><span class="linenos">131</span></a> <span class="p">]</span> </span><span id="L-132"><a href="#L-132"><span class="linenos">132</span></a> </span><span id="L-133"><a href="#L-133"><span class="linenos">133</span></a> -</span><span id="L-134"><a href="#L-134"><span class="linenos">134</span></a><span class="k">def</span> <span class="nf">apply_index_offset</span><span class="p">(</span><span class="n">expressions</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">E</span><span class="p">]],</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">E</span><span class="p">]]:</span> -</span><span id="L-135"><a href="#L-135"><span class="linenos">135</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-136"><a href="#L-136"><span class="linenos">136</span></a><span class="sd"> Applies an offset to a given integer literal expression.</span> -</span><span id="L-137"><a href="#L-137"><span class="linenos">137</span></a> -</span><span id="L-138"><a href="#L-138"><span class="linenos">138</span></a><span class="sd"> Args:</span> -</span><span id="L-139"><a href="#L-139"><span class="linenos">139</span></a><span class="sd"> expressions: the expression the offset will be applied to, wrapped in a list.</span> -</span><span id="L-140"><a href="#L-140"><span class="linenos">140</span></a><span class="sd"> offset: the offset that will be applied.</span> +</span><span id="L-134"><a href="#L-134"><span class="linenos">134</span></a><span class="k">def</span> <span class="nf">apply_index_offset</span><span class="p">(</span> +</span><span id="L-135"><a href="#L-135"><span class="linenos">135</span></a> <span class="n">this</span><span class="p">:</span> <span class="n">exp</span><span class="o">.</span><span class="n">Expression</span><span class="p">,</span> +</span><span id="L-136"><a href="#L-136"><span class="linenos">136</span></a> <span class="n">expressions</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">E</span><span class="p">]],</span> +</span><span id="L-137"><a href="#L-137"><span class="linenos">137</span></a> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> +</span><span id="L-138"><a href="#L-138"><span class="linenos">138</span></a><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">E</span><span class="p">]]:</span> +</span><span id="L-139"><a href="#L-139"><span class="linenos">139</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-140"><a href="#L-140"><span class="linenos">140</span></a><span class="sd"> Applies an offset to a given integer literal expression.</span> </span><span id="L-141"><a href="#L-141"><span class="linenos">141</span></a> -</span><span id="L-142"><a href="#L-142"><span class="linenos">142</span></a><span class="sd"> Returns:</span> -</span><span id="L-143"><a href="#L-143"><span class="linenos">143</span></a><span class="sd"> The original expression with the offset applied to it, wrapped in a list. If the provided</span> -</span><span id="L-144"><a href="#L-144"><span class="linenos">144</span></a><span class="sd"> `expressions` argument contains more than one expressions, it's returned unaffected.</span> -</span><span id="L-145"><a href="#L-145"><span class="linenos">145</span></a><span class="sd"> """</span> -</span><span id="L-146"><a href="#L-146"><span class="linenos">146</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">offset</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">expressions</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span> -</span><span id="L-147"><a href="#L-147"><span class="linenos">147</span></a> <span class="k">return</span> <span class="n">expressions</span> -</span><span id="L-148"><a href="#L-148"><span class="linenos">148</span></a> -</span><span id="L-149"><a href="#L-149"><span class="linenos">149</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">expressions</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> -</span><span id="L-150"><a href="#L-150"><span class="linenos">150</span></a> -</span><span id="L-151"><a href="#L-151"><span class="linenos">151</span></a> <span class="k">if</span> <span class="n">expression</span> <span class="ow">and</span> <span class="n">expression</span><span class="o">.</span><span class="n">is_int</span><span class="p">:</span> -</span><span id="L-152"><a href="#L-152"><span class="linenos">152</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">expression</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> -</span><span id="L-153"><a href="#L-153"><span class="linenos">153</span></a> <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Applying array index offset (</span><span class="si">%s</span><span class="s2">)"</span><span class="p">,</span> <span class="n">offset</span><span class="p">)</span> -</span><span id="L-154"><a href="#L-154"><span class="linenos">154</span></a> <span class="n">expression</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="s2">"this"</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">expression</span><span class="o">.</span><span class="n">this</span><span class="p">)</span> <span class="o">+</span> <span class="n">offset</span><span class="p">)</span> <span class="c1"># type: ignore</span> -</span><span id="L-155"><a href="#L-155"><span class="linenos">155</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">expression</span><span class="p">]</span> -</span><span id="L-156"><a href="#L-156"><span class="linenos">156</span></a> -</span><span id="L-157"><a href="#L-157"><span class="linenos">157</span></a> <span class="k">return</span> <span class="n">expressions</span> -</span><span id="L-158"><a href="#L-158"><span class="linenos">158</span></a> +</span><span id="L-142"><a href="#L-142"><span class="linenos">142</span></a><span class="sd"> Args:</span> +</span><span id="L-143"><a href="#L-143"><span class="linenos">143</span></a><span class="sd"> this: the target of the index</span> +</span><span id="L-144"><a href="#L-144"><span class="linenos">144</span></a><span class="sd"> expressions: the expression the offset will be applied to, wrapped in a list.</span> +</span><span id="L-145"><a href="#L-145"><span class="linenos">145</span></a><span class="sd"> offset: the offset that will be applied.</span> +</span><span id="L-146"><a href="#L-146"><span class="linenos">146</span></a> +</span><span id="L-147"><a href="#L-147"><span class="linenos">147</span></a><span class="sd"> Returns:</span> +</span><span id="L-148"><a href="#L-148"><span class="linenos">148</span></a><span class="sd"> The original expression with the offset applied to it, wrapped in a list. If the provided</span> +</span><span id="L-149"><a href="#L-149"><span class="linenos">149</span></a><span class="sd"> `expressions` argument contains more than one expressions, it's returned unaffected.</span> +</span><span id="L-150"><a href="#L-150"><span class="linenos">150</span></a><span class="sd"> """</span> +</span><span id="L-151"><a href="#L-151"><span class="linenos">151</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">offset</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">expressions</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span> +</span><span id="L-152"><a href="#L-152"><span class="linenos">152</span></a> <span class="k">return</span> <span class="n">expressions</span> +</span><span id="L-153"><a href="#L-153"><span class="linenos">153</span></a> +</span><span id="L-154"><a href="#L-154"><span class="linenos">154</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">expressions</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> +</span><span id="L-155"><a href="#L-155"><span class="linenos">155</span></a> +</span><span id="L-156"><a href="#L-156"><span class="linenos">156</span></a> <span class="kn">from</span> <span class="nn">sqlglot</span> <span class="kn">import</span> <span class="n">exp</span> +</span><span id="L-157"><a href="#L-157"><span class="linenos">157</span></a> <span class="kn">from</span> <span class="nn">sqlglot.optimizer.annotate_types</span> <span class="kn">import</span> <span class="n">annotate_types</span> +</span><span id="L-158"><a href="#L-158"><span class="linenos">158</span></a> <span class="kn">from</span> <span class="nn">sqlglot.optimizer.simplify</span> <span class="kn">import</span> <span class="n">simplify</span> </span><span id="L-159"><a href="#L-159"><span class="linenos">159</span></a> -</span><span id="L-160"><a href="#L-160"><span class="linenos">160</span></a><span class="k">def</span> <span class="nf">camel_to_snake_case</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> -</span><span id="L-161"><a href="#L-161"><span class="linenos">161</span></a><span class="w"> </span><span class="sd">"""Converts `name` from camelCase to snake_case and returns the result."""</span> -</span><span id="L-162"><a href="#L-162"><span class="linenos">162</span></a> <span class="k">return</span> <span class="n">CAMEL_CASE_PATTERN</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">"_"</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> -</span><span id="L-163"><a href="#L-163"><span class="linenos">163</span></a> -</span><span id="L-164"><a href="#L-164"><span class="linenos">164</span></a> -</span><span id="L-165"><a href="#L-165"><span class="linenos">165</span></a><span class="k">def</span> <span class="nf">while_changing</span><span class="p">(</span><span class="n">expression</span><span class="p">:</span> <span class="n">Expression</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">[[</span><span class="n">Expression</span><span class="p">],</span> <span class="n">E</span><span class="p">])</span> <span class="o">-></span> <span class="n">E</span><span class="p">:</span> -</span><span id="L-166"><a href="#L-166"><span class="linenos">166</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-167"><a href="#L-167"><span class="linenos">167</span></a><span class="sd"> Applies a transformation to a given expression until a fix point is reached.</span> +</span><span id="L-160"><a href="#L-160"><span class="linenos">160</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">this</span><span class="o">.</span><span class="n">type</span><span class="p">:</span> +</span><span id="L-161"><a href="#L-161"><span class="linenos">161</span></a> <span class="n">annotate_types</span><span class="p">(</span><span class="n">this</span><span class="p">)</span> +</span><span id="L-162"><a href="#L-162"><span class="linenos">162</span></a> +</span><span id="L-163"><a href="#L-163"><span class="linenos">163</span></a> <span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="p">,</span> <span class="n">this</span><span class="o">.</span><span class="n">type</span><span class="p">)</span><span class="o">.</span><span class="n">this</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span> +</span><span id="L-164"><a href="#L-164"><span class="linenos">164</span></a> <span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="o">.</span><span class="n">Type</span><span class="o">.</span><span class="n">UNKNOWN</span><span class="p">,</span> +</span><span id="L-165"><a href="#L-165"><span class="linenos">165</span></a> <span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="o">.</span><span class="n">Type</span><span class="o">.</span><span class="n">ARRAY</span><span class="p">,</span> +</span><span id="L-166"><a href="#L-166"><span class="linenos">166</span></a> <span class="p">):</span> +</span><span id="L-167"><a href="#L-167"><span class="linenos">167</span></a> <span class="k">return</span> <span class="n">expressions</span> </span><span id="L-168"><a href="#L-168"><span class="linenos">168</span></a> -</span><span id="L-169"><a href="#L-169"><span class="linenos">169</span></a><span class="sd"> Args:</span> -</span><span id="L-170"><a href="#L-170"><span class="linenos">170</span></a><span class="sd"> expression: the expression to be transformed.</span> -</span><span id="L-171"><a href="#L-171"><span class="linenos">171</span></a><span class="sd"> func: the transformation to be applied.</span> -</span><span id="L-172"><a href="#L-172"><span class="linenos">172</span></a> -</span><span id="L-173"><a href="#L-173"><span class="linenos">173</span></a><span class="sd"> Returns:</span> -</span><span id="L-174"><a href="#L-174"><span class="linenos">174</span></a><span class="sd"> The transformed expression.</span> -</span><span id="L-175"><a href="#L-175"><span class="linenos">175</span></a><span class="sd"> """</span> -</span><span id="L-176"><a href="#L-176"><span class="linenos">176</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> -</span><span id="L-177"><a href="#L-177"><span class="linenos">177</span></a> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="n">_</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">expression</span><span class="o">.</span><span class="n">walk</span><span class="p">())):</span> -</span><span id="L-178"><a href="#L-178"><span class="linenos">178</span></a> <span class="n">n</span><span class="o">.</span><span class="n">_hash</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> -</span><span id="L-179"><a href="#L-179"><span class="linenos">179</span></a> <span class="n">start</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> -</span><span id="L-180"><a href="#L-180"><span class="linenos">180</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> +</span><span id="L-169"><a href="#L-169"><span class="linenos">169</span></a> <span class="k">if</span> <span class="n">expression</span><span class="p">:</span> +</span><span id="L-170"><a href="#L-170"><span class="linenos">170</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">expression</span><span class="o">.</span><span class="n">type</span><span class="p">:</span> +</span><span id="L-171"><a href="#L-171"><span class="linenos">171</span></a> <span class="n">annotate_types</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> +</span><span id="L-172"><a href="#L-172"><span class="linenos">172</span></a> <span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="p">,</span> <span class="n">expression</span><span class="o">.</span><span class="n">type</span><span class="p">)</span><span class="o">.</span><span class="n">this</span> <span class="ow">in</span> <span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="o">.</span><span class="n">INTEGER_TYPES</span><span class="p">:</span> +</span><span id="L-173"><a href="#L-173"><span class="linenos">173</span></a> <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Applying array index offset (</span><span class="si">%s</span><span class="s2">)"</span><span class="p">,</span> <span class="n">offset</span><span class="p">)</span> +</span><span id="L-174"><a href="#L-174"><span class="linenos">174</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">simplify</span><span class="p">(</span> +</span><span id="L-175"><a href="#L-175"><span class="linenos">175</span></a> <span class="n">exp</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="n">this</span><span class="o">=</span><span class="n">expression</span><span class="o">.</span><span class="n">copy</span><span class="p">(),</span> <span class="n">expression</span><span class="o">=</span><span class="n">exp</span><span class="o">.</span><span class="n">Literal</span><span class="o">.</span><span class="n">number</span><span class="p">(</span><span class="n">offset</span><span class="p">))</span> +</span><span id="L-176"><a href="#L-176"><span class="linenos">176</span></a> <span class="p">)</span> +</span><span id="L-177"><a href="#L-177"><span class="linenos">177</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">expression</span><span class="p">]</span> +</span><span id="L-178"><a href="#L-178"><span class="linenos">178</span></a> +</span><span id="L-179"><a href="#L-179"><span class="linenos">179</span></a> <span class="k">return</span> <span class="n">expressions</span> +</span><span id="L-180"><a href="#L-180"><span class="linenos">180</span></a> </span><span id="L-181"><a href="#L-181"><span class="linenos">181</span></a> -</span><span id="L-182"><a href="#L-182"><span class="linenos">182</span></a> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="n">_</span> <span class="ow">in</span> <span class="n">expression</span><span class="o">.</span><span class="n">walk</span><span class="p">():</span> -</span><span id="L-183"><a href="#L-183"><span class="linenos">183</span></a> <span class="n">n</span><span class="o">.</span><span class="n">_hash</span> <span class="o">=</span> <span class="kc">None</span> -</span><span id="L-184"><a href="#L-184"><span class="linenos">184</span></a> <span class="k">if</span> <span class="n">start</span> <span class="o">==</span> <span class="nb">hash</span><span class="p">(</span><span class="n">expression</span><span class="p">):</span> -</span><span id="L-185"><a href="#L-185"><span class="linenos">185</span></a> <span class="k">break</span> -</span><span id="L-186"><a href="#L-186"><span class="linenos">186</span></a> <span class="k">return</span> <span class="n">expression</span> -</span><span id="L-187"><a href="#L-187"><span class="linenos">187</span></a> -</span><span id="L-188"><a href="#L-188"><span class="linenos">188</span></a> -</span><span id="L-189"><a href="#L-189"><span class="linenos">189</span></a><span class="k">def</span> <span class="nf">tsort</span><span class="p">(</span><span class="n">dag</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">T</span><span class="p">]])</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> -</span><span id="L-190"><a href="#L-190"><span class="linenos">190</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-191"><a href="#L-191"><span class="linenos">191</span></a><span class="sd"> Sorts a given directed acyclic graph in topological order.</span> -</span><span id="L-192"><a href="#L-192"><span class="linenos">192</span></a> -</span><span id="L-193"><a href="#L-193"><span class="linenos">193</span></a><span class="sd"> Args:</span> -</span><span id="L-194"><a href="#L-194"><span class="linenos">194</span></a><span class="sd"> dag: the graph to be sorted.</span> -</span><span id="L-195"><a href="#L-195"><span class="linenos">195</span></a> -</span><span id="L-196"><a href="#L-196"><span class="linenos">196</span></a><span class="sd"> Returns:</span> -</span><span id="L-197"><a href="#L-197"><span class="linenos">197</span></a><span class="sd"> A list that contains all of the graph's nodes in topological order.</span> -</span><span id="L-198"><a href="#L-198"><span class="linenos">198</span></a><span class="sd"> """</span> -</span><span id="L-199"><a href="#L-199"><span class="linenos">199</span></a> <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span> -</span><span id="L-200"><a href="#L-200"><span class="linenos">200</span></a> -</span><span id="L-201"><a href="#L-201"><span class="linenos">201</span></a> <span class="k">def</span> <span class="nf">visit</span><span class="p">(</span><span class="n">node</span><span class="p">:</span> <span class="n">T</span><span class="p">,</span> <span class="n">visited</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Set</span><span class="p">[</span><span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> -</span><span id="L-202"><a href="#L-202"><span class="linenos">202</span></a> <span class="k">if</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span> -</span><span id="L-203"><a href="#L-203"><span class="linenos">203</span></a> <span class="k">return</span> -</span><span id="L-204"><a href="#L-204"><span class="linenos">204</span></a> <span class="k">if</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">visited</span><span class="p">:</span> -</span><span id="L-205"><a href="#L-205"><span class="linenos">205</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Cycle error"</span><span class="p">)</span> -</span><span id="L-206"><a href="#L-206"><span class="linenos">206</span></a> -</span><span id="L-207"><a href="#L-207"><span class="linenos">207</span></a> <span class="n">visited</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> -</span><span id="L-208"><a href="#L-208"><span class="linenos">208</span></a> -</span><span id="L-209"><a href="#L-209"><span class="linenos">209</span></a> <span class="k">for</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="p">[]):</span> -</span><span id="L-210"><a href="#L-210"><span class="linenos">210</span></a> <span class="n">visit</span><span class="p">(</span><span class="n">dep</span><span class="p">,</span> <span class="n">visited</span><span class="p">)</span> -</span><span id="L-211"><a href="#L-211"><span class="linenos">211</span></a> -</span><span id="L-212"><a href="#L-212"><span class="linenos">212</span></a> <span class="n">visited</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> -</span><span id="L-213"><a href="#L-213"><span class="linenos">213</span></a> <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> +</span><span id="L-182"><a href="#L-182"><span class="linenos">182</span></a><span class="k">def</span> <span class="nf">camel_to_snake_case</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> +</span><span id="L-183"><a href="#L-183"><span class="linenos">183</span></a><span class="w"> </span><span class="sd">"""Converts `name` from camelCase to snake_case and returns the result."""</span> +</span><span id="L-184"><a href="#L-184"><span class="linenos">184</span></a> <span class="k">return</span> <span class="n">CAMEL_CASE_PATTERN</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">"_"</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> +</span><span id="L-185"><a href="#L-185"><span class="linenos">185</span></a> +</span><span id="L-186"><a href="#L-186"><span class="linenos">186</span></a> +</span><span id="L-187"><a href="#L-187"><span class="linenos">187</span></a><span class="k">def</span> <span class="nf">while_changing</span><span class="p">(</span><span class="n">expression</span><span class="p">:</span> <span class="n">Expression</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">[[</span><span class="n">Expression</span><span class="p">],</span> <span class="n">E</span><span class="p">])</span> <span class="o">-></span> <span class="n">E</span><span class="p">:</span> +</span><span id="L-188"><a href="#L-188"><span class="linenos">188</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-189"><a href="#L-189"><span class="linenos">189</span></a><span class="sd"> Applies a transformation to a given expression until a fix point is reached.</span> +</span><span id="L-190"><a href="#L-190"><span class="linenos">190</span></a> +</span><span id="L-191"><a href="#L-191"><span class="linenos">191</span></a><span class="sd"> Args:</span> +</span><span id="L-192"><a href="#L-192"><span class="linenos">192</span></a><span class="sd"> expression: the expression to be transformed.</span> +</span><span id="L-193"><a href="#L-193"><span class="linenos">193</span></a><span class="sd"> func: the transformation to be applied.</span> +</span><span id="L-194"><a href="#L-194"><span class="linenos">194</span></a> +</span><span id="L-195"><a href="#L-195"><span class="linenos">195</span></a><span class="sd"> Returns:</span> +</span><span id="L-196"><a href="#L-196"><span class="linenos">196</span></a><span class="sd"> The transformed expression.</span> +</span><span id="L-197"><a href="#L-197"><span class="linenos">197</span></a><span class="sd"> """</span> +</span><span id="L-198"><a href="#L-198"><span class="linenos">198</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> +</span><span id="L-199"><a href="#L-199"><span class="linenos">199</span></a> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="n">_</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">expression</span><span class="o">.</span><span class="n">walk</span><span class="p">())):</span> +</span><span id="L-200"><a href="#L-200"><span class="linenos">200</span></a> <span class="n">n</span><span class="o">.</span><span class="n">_hash</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> +</span><span id="L-201"><a href="#L-201"><span class="linenos">201</span></a> <span class="n">start</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> +</span><span id="L-202"><a href="#L-202"><span class="linenos">202</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> +</span><span id="L-203"><a href="#L-203"><span class="linenos">203</span></a> +</span><span id="L-204"><a href="#L-204"><span class="linenos">204</span></a> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="n">_</span> <span class="ow">in</span> <span class="n">expression</span><span class="o">.</span><span class="n">walk</span><span class="p">():</span> +</span><span id="L-205"><a href="#L-205"><span class="linenos">205</span></a> <span class="n">n</span><span class="o">.</span><span class="n">_hash</span> <span class="o">=</span> <span class="kc">None</span> +</span><span id="L-206"><a href="#L-206"><span class="linenos">206</span></a> <span class="k">if</span> <span class="n">start</span> <span class="o">==</span> <span class="nb">hash</span><span class="p">(</span><span class="n">expression</span><span class="p">):</span> +</span><span id="L-207"><a href="#L-207"><span class="linenos">207</span></a> <span class="k">break</span> +</span><span id="L-208"><a href="#L-208"><span class="linenos">208</span></a> <span class="k">return</span> <span class="n">expression</span> +</span><span id="L-209"><a href="#L-209"><span class="linenos">209</span></a> +</span><span id="L-210"><a href="#L-210"><span class="linenos">210</span></a> +</span><span id="L-211"><a href="#L-211"><span class="linenos">211</span></a><span class="k">def</span> <span class="nf">tsort</span><span class="p">(</span><span class="n">dag</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">T</span><span class="p">]])</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> +</span><span id="L-212"><a href="#L-212"><span class="linenos">212</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-213"><a href="#L-213"><span class="linenos">213</span></a><span class="sd"> Sorts a given directed acyclic graph in topological order.</span> </span><span id="L-214"><a href="#L-214"><span class="linenos">214</span></a> -</span><span id="L-215"><a href="#L-215"><span class="linenos">215</span></a> <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">dag</span><span class="p">:</span> -</span><span id="L-216"><a href="#L-216"><span class="linenos">216</span></a> <span class="n">visit</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="nb">set</span><span class="p">())</span> +</span><span id="L-215"><a href="#L-215"><span class="linenos">215</span></a><span class="sd"> Args:</span> +</span><span id="L-216"><a href="#L-216"><span class="linenos">216</span></a><span class="sd"> dag: the graph to be sorted.</span> </span><span id="L-217"><a href="#L-217"><span class="linenos">217</span></a> -</span><span id="L-218"><a href="#L-218"><span class="linenos">218</span></a> <span class="k">return</span> <span class="n">result</span> -</span><span id="L-219"><a href="#L-219"><span class="linenos">219</span></a> -</span><span id="L-220"><a href="#L-220"><span class="linenos">220</span></a> -</span><span id="L-221"><a href="#L-221"><span class="linenos">221</span></a><span class="k">def</span> <span class="nf">open_file</span><span class="p">(</span><span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">TextIO</span><span class="p">:</span> -</span><span id="L-222"><a href="#L-222"><span class="linenos">222</span></a><span class="w"> </span><span class="sd">"""Open a file that may be compressed as gzip and return it in universal newline mode."""</span> -</span><span id="L-223"><a href="#L-223"><span class="linenos">223</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> -</span><span id="L-224"><a href="#L-224"><span class="linenos">224</span></a> <span class="n">gzipped</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="o">==</span> <span class="sa">b</span><span class="s2">"</span><span class="se">\x1f\x8b</span><span class="s2">"</span> -</span><span id="L-225"><a href="#L-225"><span class="linenos">225</span></a> -</span><span id="L-226"><a href="#L-226"><span class="linenos">226</span></a> <span class="k">if</span> <span class="n">gzipped</span><span class="p">:</span> -</span><span id="L-227"><a href="#L-227"><span class="linenos">227</span></a> <span class="kn">import</span> <span class="nn">gzip</span> +</span><span id="L-218"><a href="#L-218"><span class="linenos">218</span></a><span class="sd"> Returns:</span> +</span><span id="L-219"><a href="#L-219"><span class="linenos">219</span></a><span class="sd"> A list that contains all of the graph's nodes in topological order.</span> +</span><span id="L-220"><a href="#L-220"><span class="linenos">220</span></a><span class="sd"> """</span> +</span><span id="L-221"><a href="#L-221"><span class="linenos">221</span></a> <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span> +</span><span id="L-222"><a href="#L-222"><span class="linenos">222</span></a> +</span><span id="L-223"><a href="#L-223"><span class="linenos">223</span></a> <span class="k">def</span> <span class="nf">visit</span><span class="p">(</span><span class="n">node</span><span class="p">:</span> <span class="n">T</span><span class="p">,</span> <span class="n">visited</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Set</span><span class="p">[</span><span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> +</span><span id="L-224"><a href="#L-224"><span class="linenos">224</span></a> <span class="k">if</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span> +</span><span id="L-225"><a href="#L-225"><span class="linenos">225</span></a> <span class="k">return</span> +</span><span id="L-226"><a href="#L-226"><span class="linenos">226</span></a> <span class="k">if</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">visited</span><span class="p">:</span> +</span><span id="L-227"><a href="#L-227"><span class="linenos">227</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Cycle error"</span><span class="p">)</span> </span><span id="L-228"><a href="#L-228"><span class="linenos">228</span></a> -</span><span id="L-229"><a href="#L-229"><span class="linenos">229</span></a> <span class="k">return</span> <span class="n">gzip</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rt"</span><span class="p">,</span> <span class="n">newline</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span> +</span><span id="L-229"><a href="#L-229"><span class="linenos">229</span></a> <span class="n">visited</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> </span><span id="L-230"><a href="#L-230"><span class="linenos">230</span></a> -</span><span id="L-231"><a href="#L-231"><span class="linenos">231</span></a> <span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span> <span class="n">newline</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span> -</span><span id="L-232"><a href="#L-232"><span class="linenos">232</span></a> +</span><span id="L-231"><a href="#L-231"><span class="linenos">231</span></a> <span class="k">for</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="p">[]):</span> +</span><span id="L-232"><a href="#L-232"><span class="linenos">232</span></a> <span class="n">visit</span><span class="p">(</span><span class="n">dep</span><span class="p">,</span> <span class="n">visited</span><span class="p">)</span> </span><span id="L-233"><a href="#L-233"><span class="linenos">233</span></a> -</span><span id="L-234"><a href="#L-234"><span class="linenos">234</span></a><span class="nd">@contextmanager</span> -</span><span id="L-235"><a href="#L-235"><span class="linenos">235</span></a><span class="k">def</span> <span class="nf">csv_reader</span><span class="p">(</span><span class="n">read_csv</span><span class="p">:</span> <span class="n">exp</span><span class="o">.</span><span class="n">ReadCSV</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span> -</span><span id="L-236"><a href="#L-236"><span class="linenos">236</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-237"><a href="#L-237"><span class="linenos">237</span></a><span class="sd"> Returns a csv reader given the expression `READ_CSV(name, ['delimiter', '|', ...])`.</span> -</span><span id="L-238"><a href="#L-238"><span class="linenos">238</span></a> -</span><span id="L-239"><a href="#L-239"><span class="linenos">239</span></a><span class="sd"> Args:</span> -</span><span id="L-240"><a href="#L-240"><span class="linenos">240</span></a><span class="sd"> read_csv: a `ReadCSV` function call</span> +</span><span id="L-234"><a href="#L-234"><span class="linenos">234</span></a> <span class="n">visited</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> +</span><span id="L-235"><a href="#L-235"><span class="linenos">235</span></a> <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> +</span><span id="L-236"><a href="#L-236"><span class="linenos">236</span></a> +</span><span id="L-237"><a href="#L-237"><span class="linenos">237</span></a> <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">dag</span><span class="p">:</span> +</span><span id="L-238"><a href="#L-238"><span class="linenos">238</span></a> <span class="n">visit</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="nb">set</span><span class="p">())</span> +</span><span id="L-239"><a href="#L-239"><span class="linenos">239</span></a> +</span><span id="L-240"><a href="#L-240"><span class="linenos">240</span></a> <span class="k">return</span> <span class="n">result</span> </span><span id="L-241"><a href="#L-241"><span class="linenos">241</span></a> -</span><span id="L-242"><a href="#L-242"><span class="linenos">242</span></a><span class="sd"> Yields:</span> -</span><span id="L-243"><a href="#L-243"><span class="linenos">243</span></a><span class="sd"> A python csv reader.</span> -</span><span id="L-244"><a href="#L-244"><span class="linenos">244</span></a><span class="sd"> """</span> -</span><span id="L-245"><a href="#L-245"><span class="linenos">245</span></a> <span class="n">args</span> <span class="o">=</span> <span class="n">read_csv</span><span class="o">.</span><span class="n">expressions</span> -</span><span id="L-246"><a href="#L-246"><span class="linenos">246</span></a> <span class="n">file</span> <span class="o">=</span> <span class="n">open_file</span><span class="p">(</span><span class="n">read_csv</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> +</span><span id="L-242"><a href="#L-242"><span class="linenos">242</span></a> +</span><span id="L-243"><a href="#L-243"><span class="linenos">243</span></a><span class="k">def</span> <span class="nf">open_file</span><span class="p">(</span><span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">TextIO</span><span class="p">:</span> +</span><span id="L-244"><a href="#L-244"><span class="linenos">244</span></a><span class="w"> </span><span class="sd">"""Open a file that may be compressed as gzip and return it in universal newline mode."""</span> +</span><span id="L-245"><a href="#L-245"><span class="linenos">245</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> +</span><span id="L-246"><a href="#L-246"><span class="linenos">246</span></a> <span class="n">gzipped</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="o">==</span> <span class="sa">b</span><span class="s2">"</span><span class="se">\x1f\x8b</span><span class="s2">"</span> </span><span id="L-247"><a href="#L-247"><span class="linenos">247</span></a> -</span><span id="L-248"><a href="#L-248"><span class="linenos">248</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="s2">","</span> -</span><span id="L-249"><a href="#L-249"><span class="linenos">249</span></a> <span class="n">args</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">arg</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">)</span> -</span><span id="L-250"><a href="#L-250"><span class="linenos">250</span></a> <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="nb">zip</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span> -</span><span id="L-251"><a href="#L-251"><span class="linenos">251</span></a> <span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="s2">"delimiter"</span><span class="p">:</span> -</span><span id="L-252"><a href="#L-252"><span class="linenos">252</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="n">v</span> -</span><span id="L-253"><a href="#L-253"><span class="linenos">253</span></a> -</span><span id="L-254"><a href="#L-254"><span class="linenos">254</span></a> <span class="k">try</span><span class="p">:</span> -</span><span id="L-255"><a href="#L-255"><span class="linenos">255</span></a> <span class="kn">import</span> <span class="nn">csv</span> <span class="k">as</span> <span class="nn">csv_</span> -</span><span id="L-256"><a href="#L-256"><span class="linenos">256</span></a> -</span><span id="L-257"><a href="#L-257"><span class="linenos">257</span></a> <span class="k">yield</span> <span class="n">csv_</span><span class="o">.</span><span class="n">reader</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="n">delimiter</span><span class="o">=</span><span class="n">delimiter</span><span class="p">)</span> -</span><span id="L-258"><a href="#L-258"><span class="linenos">258</span></a> <span class="k">finally</span><span class="p">:</span> -</span><span id="L-259"><a href="#L-259"><span class="linenos">259</span></a> <span class="n">file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> +</span><span id="L-248"><a href="#L-248"><span class="linenos">248</span></a> <span class="k">if</span> <span class="n">gzipped</span><span class="p">:</span> +</span><span id="L-249"><a href="#L-249"><span class="linenos">249</span></a> <span class="kn">import</span> <span class="nn">gzip</span> +</span><span id="L-250"><a href="#L-250"><span class="linenos">250</span></a> +</span><span id="L-251"><a href="#L-251"><span class="linenos">251</span></a> <span class="k">return</span> <span class="n">gzip</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rt"</span><span class="p">,</span> <span class="n">newline</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span> +</span><span id="L-252"><a href="#L-252"><span class="linenos">252</span></a> +</span><span id="L-253"><a href="#L-253"><span class="linenos">253</span></a> <span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span> <span class="n">newline</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span> +</span><span id="L-254"><a href="#L-254"><span class="linenos">254</span></a> +</span><span id="L-255"><a href="#L-255"><span class="linenos">255</span></a> +</span><span id="L-256"><a href="#L-256"><span class="linenos">256</span></a><span class="nd">@contextmanager</span> +</span><span id="L-257"><a href="#L-257"><span class="linenos">257</span></a><span class="k">def</span> <span class="nf">csv_reader</span><span class="p">(</span><span class="n">read_csv</span><span class="p">:</span> <span class="n">exp</span><span class="o">.</span><span class="n">ReadCSV</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span> +</span><span id="L-258"><a href="#L-258"><span class="linenos">258</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-259"><a href="#L-259"><span class="linenos">259</span></a><span class="sd"> Returns a csv reader given the expression `READ_CSV(name, ['delimiter', '|', ...])`.</span> </span><span id="L-260"><a href="#L-260"><span class="linenos">260</span></a> -</span><span id="L-261"><a href="#L-261"><span class="linenos">261</span></a> -</span><span id="L-262"><a href="#L-262"><span class="linenos">262</span></a><span class="k">def</span> <span class="nf">find_new_name</span><span class="p">(</span><span class="n">taken</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Collection</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">base</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> -</span><span id="L-263"><a href="#L-263"><span class="linenos">263</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-264"><a href="#L-264"><span class="linenos">264</span></a><span class="sd"> Searches for a new name.</span> -</span><span id="L-265"><a href="#L-265"><span class="linenos">265</span></a> -</span><span id="L-266"><a href="#L-266"><span class="linenos">266</span></a><span class="sd"> Args:</span> -</span><span id="L-267"><a href="#L-267"><span class="linenos">267</span></a><span class="sd"> taken: a collection of taken names.</span> -</span><span id="L-268"><a href="#L-268"><span class="linenos">268</span></a><span class="sd"> base: base name to alter.</span> +</span><span id="L-261"><a href="#L-261"><span class="linenos">261</span></a><span class="sd"> Args:</span> +</span><span id="L-262"><a href="#L-262"><span class="linenos">262</span></a><span class="sd"> read_csv: a `ReadCSV` function call</span> +</span><span id="L-263"><a href="#L-263"><span class="linenos">263</span></a> +</span><span id="L-264"><a href="#L-264"><span class="linenos">264</span></a><span class="sd"> Yields:</span> +</span><span id="L-265"><a href="#L-265"><span class="linenos">265</span></a><span class="sd"> A python csv reader.</span> +</span><span id="L-266"><a href="#L-266"><span class="linenos">266</span></a><span class="sd"> """</span> +</span><span id="L-267"><a href="#L-267"><span class="linenos">267</span></a> <span class="n">args</span> <span class="o">=</span> <span class="n">read_csv</span><span class="o">.</span><span class="n">expressions</span> +</span><span id="L-268"><a href="#L-268"><span class="linenos">268</span></a> <span class="n">file</span> <span class="o">=</span> <span class="n">open_file</span><span class="p">(</span><span class="n">read_csv</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> </span><span id="L-269"><a href="#L-269"><span class="linenos">269</span></a> -</span><span id="L-270"><a href="#L-270"><span class="linenos">270</span></a><span class="sd"> Returns:</span> -</span><span id="L-271"><a href="#L-271"><span class="linenos">271</span></a><span class="sd"> The new, available name.</span> -</span><span id="L-272"><a href="#L-272"><span class="linenos">272</span></a><span class="sd"> """</span> -</span><span id="L-273"><a href="#L-273"><span class="linenos">273</span></a> <span class="k">if</span> <span class="n">base</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">taken</span><span class="p">:</span> -</span><span id="L-274"><a href="#L-274"><span class="linenos">274</span></a> <span class="k">return</span> <span class="n">base</span> +</span><span id="L-270"><a href="#L-270"><span class="linenos">270</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="s2">","</span> +</span><span id="L-271"><a href="#L-271"><span class="linenos">271</span></a> <span class="n">args</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">arg</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">)</span> +</span><span id="L-272"><a href="#L-272"><span class="linenos">272</span></a> <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="nb">zip</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span> +</span><span id="L-273"><a href="#L-273"><span class="linenos">273</span></a> <span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="s2">"delimiter"</span><span class="p">:</span> +</span><span id="L-274"><a href="#L-274"><span class="linenos">274</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="n">v</span> </span><span id="L-275"><a href="#L-275"><span class="linenos">275</span></a> -</span><span id="L-276"><a href="#L-276"><span class="linenos">276</span></a> <span class="n">i</span> <span class="o">=</span> <span class="mi">2</span> -</span><span id="L-277"><a href="#L-277"><span class="linenos">277</span></a> <span class="n">new</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">"</span> -</span><span id="L-278"><a href="#L-278"><span class="linenos">278</span></a> <span class="k">while</span> <span class="n">new</span> <span class="ow">in</span> <span class="n">taken</span><span class="p">:</span> -</span><span id="L-279"><a href="#L-279"><span class="linenos">279</span></a> <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> -</span><span id="L-280"><a href="#L-280"><span class="linenos">280</span></a> <span class="n">new</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">"</span> -</span><span id="L-281"><a href="#L-281"><span class="linenos">281</span></a> -</span><span id="L-282"><a href="#L-282"><span class="linenos">282</span></a> <span class="k">return</span> <span class="n">new</span> +</span><span id="L-276"><a href="#L-276"><span class="linenos">276</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="L-277"><a href="#L-277"><span class="linenos">277</span></a> <span class="kn">import</span> <span class="nn">csv</span> <span class="k">as</span> <span class="nn">csv_</span> +</span><span id="L-278"><a href="#L-278"><span class="linenos">278</span></a> +</span><span id="L-279"><a href="#L-279"><span class="linenos">279</span></a> <span class="k">yield</span> <span class="n">csv_</span><span class="o">.</span><span class="n">reader</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="n">delimiter</span><span class="o">=</span><span class="n">delimiter</span><span class="p">)</span> +</span><span id="L-280"><a href="#L-280"><span class="linenos">280</span></a> <span class="k">finally</span><span class="p">:</span> +</span><span id="L-281"><a href="#L-281"><span class="linenos">281</span></a> <span class="n">file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> +</span><span id="L-282"><a href="#L-282"><span class="linenos">282</span></a> </span><span id="L-283"><a href="#L-283"><span class="linenos">283</span></a> -</span><span id="L-284"><a href="#L-284"><span class="linenos">284</span></a> -</span><span id="L-285"><a href="#L-285"><span class="linenos">285</span></a><span class="k">def</span> <span class="nf">object_to_dict</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">:</span> -</span><span id="L-286"><a href="#L-286"><span class="linenos">286</span></a><span class="w"> </span><span class="sd">"""Returns a dictionary created from an object's attributes."""</span> -</span><span id="L-287"><a href="#L-287"><span class="linenos">287</span></a> <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">copy</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="nb">vars</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">()},</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">}</span> -</span><span id="L-288"><a href="#L-288"><span class="linenos">288</span></a> -</span><span id="L-289"><a href="#L-289"><span class="linenos">289</span></a> -</span><span id="L-290"><a href="#L-290"><span class="linenos">290</span></a><span class="k">def</span> <span class="nf">split_num_words</span><span class="p">(</span> -</span><span id="L-291"><a href="#L-291"><span class="linenos">291</span></a> <span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">sep</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">min_num_words</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">fill_from_start</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span> -</span><span id="L-292"><a href="#L-292"><span class="linenos">292</span></a><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]]:</span> -</span><span id="L-293"><a href="#L-293"><span class="linenos">293</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-294"><a href="#L-294"><span class="linenos">294</span></a><span class="sd"> Perform a split on a value and return N words as a result with `None` used for words that don't exist.</span> -</span><span id="L-295"><a href="#L-295"><span class="linenos">295</span></a> -</span><span id="L-296"><a href="#L-296"><span class="linenos">296</span></a><span class="sd"> Args:</span> -</span><span id="L-297"><a href="#L-297"><span class="linenos">297</span></a><span class="sd"> value: the value to be split.</span> -</span><span id="L-298"><a href="#L-298"><span class="linenos">298</span></a><span class="sd"> sep: the value to use to split on.</span> -</span><span id="L-299"><a href="#L-299"><span class="linenos">299</span></a><span class="sd"> min_num_words: the minimum number of words that are going to be in the result.</span> -</span><span id="L-300"><a href="#L-300"><span class="linenos">300</span></a><span class="sd"> fill_from_start: indicates that if `None` values should be inserted at the start or end of the list.</span> -</span><span id="L-301"><a href="#L-301"><span class="linenos">301</span></a> -</span><span id="L-302"><a href="#L-302"><span class="linenos">302</span></a><span class="sd"> Examples:</span> -</span><span id="L-303"><a href="#L-303"><span class="linenos">303</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3)</span> -</span><span id="L-304"><a href="#L-304"><span class="linenos">304</span></a><span class="sd"> [None, 'db', 'table']</span> -</span><span id="L-305"><a href="#L-305"><span class="linenos">305</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3, fill_from_start=False)</span> -</span><span id="L-306"><a href="#L-306"><span class="linenos">306</span></a><span class="sd"> ['db', 'table', None]</span> -</span><span id="L-307"><a href="#L-307"><span class="linenos">307</span></a><span class="sd"> >>> split_num_words("db.table", ".", 1)</span> -</span><span id="L-308"><a href="#L-308"><span class="linenos">308</span></a><span class="sd"> ['db', 'table']</span> -</span><span id="L-309"><a href="#L-309"><span class="linenos">309</span></a> -</span><span id="L-310"><a href="#L-310"><span class="linenos">310</span></a><span class="sd"> Returns:</span> -</span><span id="L-311"><a href="#L-311"><span class="linenos">311</span></a><span class="sd"> The list of words returned by `split`, possibly augmented by a number of `None` values.</span> -</span><span id="L-312"><a href="#L-312"><span class="linenos">312</span></a><span class="sd"> """</span> -</span><span id="L-313"><a href="#L-313"><span class="linenos">313</span></a> <span class="n">words</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">sep</span><span class="p">)</span> -</span><span id="L-314"><a href="#L-314"><span class="linenos">314</span></a> <span class="k">if</span> <span class="n">fill_from_start</span><span class="p">:</span> -</span><span id="L-315"><a href="#L-315"><span class="linenos">315</span></a> <span class="k">return</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="n">min_num_words</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">))</span> <span class="o">+</span> <span class="n">words</span> -</span><span id="L-316"><a href="#L-316"><span class="linenos">316</span></a> <span class="k">return</span> <span class="n">words</span> <span class="o">+</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="n">min_num_words</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">))</span> +</span><span id="L-284"><a href="#L-284"><span class="linenos">284</span></a><span class="k">def</span> <span class="nf">find_new_name</span><span class="p">(</span><span class="n">taken</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Collection</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">base</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> +</span><span id="L-285"><a href="#L-285"><span class="linenos">285</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-286"><a href="#L-286"><span class="linenos">286</span></a><span class="sd"> Searches for a new name.</span> +</span><span id="L-287"><a href="#L-287"><span class="linenos">287</span></a> +</span><span id="L-288"><a href="#L-288"><span class="linenos">288</span></a><span class="sd"> Args:</span> +</span><span id="L-289"><a href="#L-289"><span class="linenos">289</span></a><span class="sd"> taken: a collection of taken names.</span> +</span><span id="L-290"><a href="#L-290"><span class="linenos">290</span></a><span class="sd"> base: base name to alter.</span> +</span><span id="L-291"><a href="#L-291"><span class="linenos">291</span></a> +</span><span id="L-292"><a href="#L-292"><span class="linenos">292</span></a><span class="sd"> Returns:</span> +</span><span id="L-293"><a href="#L-293"><span class="linenos">293</span></a><span class="sd"> The new, available name.</span> +</span><span id="L-294"><a href="#L-294"><span class="linenos">294</span></a><span class="sd"> """</span> +</span><span id="L-295"><a href="#L-295"><span class="linenos">295</span></a> <span class="k">if</span> <span class="n">base</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">taken</span><span class="p">:</span> +</span><span id="L-296"><a href="#L-296"><span class="linenos">296</span></a> <span class="k">return</span> <span class="n">base</span> +</span><span id="L-297"><a href="#L-297"><span class="linenos">297</span></a> +</span><span id="L-298"><a href="#L-298"><span class="linenos">298</span></a> <span class="n">i</span> <span class="o">=</span> <span class="mi">2</span> +</span><span id="L-299"><a href="#L-299"><span class="linenos">299</span></a> <span class="n">new</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">"</span> +</span><span id="L-300"><a href="#L-300"><span class="linenos">300</span></a> <span class="k">while</span> <span class="n">new</span> <span class="ow">in</span> <span class="n">taken</span><span class="p">:</span> +</span><span id="L-301"><a href="#L-301"><span class="linenos">301</span></a> <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> +</span><span id="L-302"><a href="#L-302"><span class="linenos">302</span></a> <span class="n">new</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">"</span> +</span><span id="L-303"><a href="#L-303"><span class="linenos">303</span></a> +</span><span id="L-304"><a href="#L-304"><span class="linenos">304</span></a> <span class="k">return</span> <span class="n">new</span> +</span><span id="L-305"><a href="#L-305"><span class="linenos">305</span></a> +</span><span id="L-306"><a href="#L-306"><span class="linenos">306</span></a> +</span><span id="L-307"><a href="#L-307"><span class="linenos">307</span></a><span class="k">def</span> <span class="nf">object_to_dict</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">:</span> +</span><span id="L-308"><a href="#L-308"><span class="linenos">308</span></a><span class="w"> </span><span class="sd">"""Returns a dictionary created from an object's attributes."""</span> +</span><span id="L-309"><a href="#L-309"><span class="linenos">309</span></a> <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">copy</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="nb">vars</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">()},</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">}</span> +</span><span id="L-310"><a href="#L-310"><span class="linenos">310</span></a> +</span><span id="L-311"><a href="#L-311"><span class="linenos">311</span></a> +</span><span id="L-312"><a href="#L-312"><span class="linenos">312</span></a><span class="k">def</span> <span class="nf">split_num_words</span><span class="p">(</span> +</span><span id="L-313"><a href="#L-313"><span class="linenos">313</span></a> <span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">sep</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">min_num_words</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">fill_from_start</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span> +</span><span id="L-314"><a href="#L-314"><span class="linenos">314</span></a><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]]:</span> +</span><span id="L-315"><a href="#L-315"><span class="linenos">315</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-316"><a href="#L-316"><span class="linenos">316</span></a><span class="sd"> Perform a split on a value and return N words as a result with `None` used for words that don't exist.</span> </span><span id="L-317"><a href="#L-317"><span class="linenos">317</span></a> -</span><span id="L-318"><a href="#L-318"><span class="linenos">318</span></a> -</span><span id="L-319"><a href="#L-319"><span class="linenos">319</span></a><span class="k">def</span> <span class="nf">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> -</span><span id="L-320"><a href="#L-320"><span class="linenos">320</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-321"><a href="#L-321"><span class="linenos">321</span></a><span class="sd"> Checks if the value is an iterable, excluding the types `str` and `bytes`.</span> -</span><span id="L-322"><a href="#L-322"><span class="linenos">322</span></a> -</span><span id="L-323"><a href="#L-323"><span class="linenos">323</span></a><span class="sd"> Examples:</span> -</span><span id="L-324"><a href="#L-324"><span class="linenos">324</span></a><span class="sd"> >>> is_iterable([1,2])</span> -</span><span id="L-325"><a href="#L-325"><span class="linenos">325</span></a><span class="sd"> True</span> -</span><span id="L-326"><a href="#L-326"><span class="linenos">326</span></a><span class="sd"> >>> is_iterable("test")</span> -</span><span id="L-327"><a href="#L-327"><span class="linenos">327</span></a><span class="sd"> False</span> -</span><span id="L-328"><a href="#L-328"><span class="linenos">328</span></a> -</span><span id="L-329"><a href="#L-329"><span class="linenos">329</span></a><span class="sd"> Args:</span> -</span><span id="L-330"><a href="#L-330"><span class="linenos">330</span></a><span class="sd"> value: the value to check if it is an iterable.</span> +</span><span id="L-318"><a href="#L-318"><span class="linenos">318</span></a><span class="sd"> Args:</span> +</span><span id="L-319"><a href="#L-319"><span class="linenos">319</span></a><span class="sd"> value: the value to be split.</span> +</span><span id="L-320"><a href="#L-320"><span class="linenos">320</span></a><span class="sd"> sep: the value to use to split on.</span> +</span><span id="L-321"><a href="#L-321"><span class="linenos">321</span></a><span class="sd"> min_num_words: the minimum number of words that are going to be in the result.</span> +</span><span id="L-322"><a href="#L-322"><span class="linenos">322</span></a><span class="sd"> fill_from_start: indicates that if `None` values should be inserted at the start or end of the list.</span> +</span><span id="L-323"><a href="#L-323"><span class="linenos">323</span></a> +</span><span id="L-324"><a href="#L-324"><span class="linenos">324</span></a><span class="sd"> Examples:</span> +</span><span id="L-325"><a href="#L-325"><span class="linenos">325</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3)</span> +</span><span id="L-326"><a href="#L-326"><span class="linenos">326</span></a><span class="sd"> [None, 'db', 'table']</span> +</span><span id="L-327"><a href="#L-327"><span class="linenos">327</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3, fill_from_start=False)</span> +</span><span id="L-328"><a href="#L-328"><span class="linenos">328</span></a><span class="sd"> ['db', 'table', None]</span> +</span><span id="L-329"><a href="#L-329"><span class="linenos">329</span></a><span class="sd"> >>> split_num_words("db.table", ".", 1)</span> +</span><span id="L-330"><a href="#L-330"><span class="linenos">330</span></a><span class="sd"> ['db', 'table']</span> </span><span id="L-331"><a href="#L-331"><span class="linenos">331</span></a> </span><span id="L-332"><a href="#L-332"><span class="linenos">332</span></a><span class="sd"> Returns:</span> -</span><span id="L-333"><a href="#L-333"><span class="linenos">333</span></a><span class="sd"> A `bool` value indicating if it is an iterable.</span> +</span><span id="L-333"><a href="#L-333"><span class="linenos">333</span></a><span class="sd"> The list of words returned by `split`, possibly augmented by a number of `None` values.</span> </span><span id="L-334"><a href="#L-334"><span class="linenos">334</span></a><span class="sd"> """</span> -</span><span id="L-335"><a href="#L-335"><span class="linenos">335</span></a> <span class="k">return</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s2">"__iter__"</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">))</span> -</span><span id="L-336"><a href="#L-336"><span class="linenos">336</span></a> -</span><span id="L-337"><a href="#L-337"><span class="linenos">337</span></a> -</span><span id="L-338"><a href="#L-338"><span class="linenos">338</span></a><span class="k">def</span> <span class="nf">flatten</span><span class="p">(</span><span class="n">values</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Iterator</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]:</span> -</span><span id="L-339"><a href="#L-339"><span class="linenos">339</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-340"><a href="#L-340"><span class="linenos">340</span></a><span class="sd"> Flattens an iterable that can contain both iterable and non-iterable elements. Objects of</span> -</span><span id="L-341"><a href="#L-341"><span class="linenos">341</span></a><span class="sd"> type `str` and `bytes` are not regarded as iterables.</span> -</span><span id="L-342"><a href="#L-342"><span class="linenos">342</span></a> -</span><span id="L-343"><a href="#L-343"><span class="linenos">343</span></a><span class="sd"> Examples:</span> -</span><span id="L-344"><a href="#L-344"><span class="linenos">344</span></a><span class="sd"> >>> list(flatten([[1, 2], 3, {4}, (5, "bla")]))</span> -</span><span id="L-345"><a href="#L-345"><span class="linenos">345</span></a><span class="sd"> [1, 2, 3, 4, 5, 'bla']</span> -</span><span id="L-346"><a href="#L-346"><span class="linenos">346</span></a><span class="sd"> >>> list(flatten([1, 2, 3]))</span> -</span><span id="L-347"><a href="#L-347"><span class="linenos">347</span></a><span class="sd"> [1, 2, 3]</span> -</span><span id="L-348"><a href="#L-348"><span class="linenos">348</span></a> -</span><span id="L-349"><a href="#L-349"><span class="linenos">349</span></a><span class="sd"> Args:</span> -</span><span id="L-350"><a href="#L-350"><span class="linenos">350</span></a><span class="sd"> values: the value to be flattened.</span> -</span><span id="L-351"><a href="#L-351"><span class="linenos">351</span></a> -</span><span id="L-352"><a href="#L-352"><span class="linenos">352</span></a><span class="sd"> Yields:</span> -</span><span id="L-353"><a href="#L-353"><span class="linenos">353</span></a><span class="sd"> Non-iterable elements in `values`.</span> -</span><span id="L-354"><a href="#L-354"><span class="linenos">354</span></a><span class="sd"> """</span> -</span><span id="L-355"><a href="#L-355"><span class="linenos">355</span></a> <span class="k">for</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">values</span><span class="p">:</span> -</span><span id="L-356"><a href="#L-356"><span class="linenos">356</span></a> <span class="k">if</span> <span class="n">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> -</span><span id="L-357"><a href="#L-357"><span class="linenos">357</span></a> <span class="k">yield from</span> <span class="n">flatten</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> -</span><span id="L-358"><a href="#L-358"><span class="linenos">358</span></a> <span class="k">else</span><span class="p">:</span> -</span><span id="L-359"><a href="#L-359"><span class="linenos">359</span></a> <span class="k">yield</span> <span class="n">value</span> -</span><span id="L-360"><a href="#L-360"><span class="linenos">360</span></a> -</span><span id="L-361"><a href="#L-361"><span class="linenos">361</span></a> -</span><span id="L-362"><a href="#L-362"><span class="linenos">362</span></a><span class="k">def</span> <span class="nf">count_params</span><span class="p">(</span><span class="n">function</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> -</span><span id="L-363"><a href="#L-363"><span class="linenos">363</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-364"><a href="#L-364"><span class="linenos">364</span></a><span class="sd"> Returns the number of formal parameters expected by a function, without counting "self"</span> -</span><span id="L-365"><a href="#L-365"><span class="linenos">365</span></a><span class="sd"> and "cls", in case of instance and class methods, respectively.</span> -</span><span id="L-366"><a href="#L-366"><span class="linenos">366</span></a><span class="sd"> """</span> -</span><span id="L-367"><a href="#L-367"><span class="linenos">367</span></a> <span class="n">count</span> <span class="o">=</span> <span class="n">function</span><span class="o">.</span><span class="vm">__code__</span><span class="o">.</span><span class="n">co_argcount</span> -</span><span id="L-368"><a href="#L-368"><span class="linenos">368</span></a> <span class="k">return</span> <span class="n">count</span> <span class="o">-</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">inspect</span><span class="o">.</span><span class="n">ismethod</span><span class="p">(</span><span class="n">function</span><span class="p">)</span> <span class="k">else</span> <span class="n">count</span> -</span><span id="L-369"><a href="#L-369"><span class="linenos">369</span></a> +</span><span id="L-335"><a href="#L-335"><span class="linenos">335</span></a> <span class="n">words</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">sep</span><span class="p">)</span> +</span><span id="L-336"><a href="#L-336"><span class="linenos">336</span></a> <span class="k">if</span> <span class="n">fill_from_start</span><span class="p">:</span> +</span><span id="L-337"><a href="#L-337"><span class="linenos">337</span></a> <span class="k">return</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="n">min_num_words</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">))</span> <span class="o">+</span> <span class="n">words</span> +</span><span id="L-338"><a href="#L-338"><span class="linenos">338</span></a> <span class="k">return</span> <span class="n">words</span> <span class="o">+</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="n">min_num_words</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">))</span> +</span><span id="L-339"><a href="#L-339"><span class="linenos">339</span></a> +</span><span id="L-340"><a href="#L-340"><span class="linenos">340</span></a> +</span><span id="L-341"><a href="#L-341"><span class="linenos">341</span></a><span class="k">def</span> <span class="nf">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> +</span><span id="L-342"><a href="#L-342"><span class="linenos">342</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-343"><a href="#L-343"><span class="linenos">343</span></a><span class="sd"> Checks if the value is an iterable, excluding the types `str` and `bytes`.</span> +</span><span id="L-344"><a href="#L-344"><span class="linenos">344</span></a> +</span><span id="L-345"><a href="#L-345"><span class="linenos">345</span></a><span class="sd"> Examples:</span> +</span><span id="L-346"><a href="#L-346"><span class="linenos">346</span></a><span class="sd"> >>> is_iterable([1,2])</span> +</span><span id="L-347"><a href="#L-347"><span class="linenos">347</span></a><span class="sd"> True</span> +</span><span id="L-348"><a href="#L-348"><span class="linenos">348</span></a><span class="sd"> >>> is_iterable("test")</span> +</span><span id="L-349"><a href="#L-349"><span class="linenos">349</span></a><span class="sd"> False</span> +</span><span id="L-350"><a href="#L-350"><span class="linenos">350</span></a> +</span><span id="L-351"><a href="#L-351"><span class="linenos">351</span></a><span class="sd"> Args:</span> +</span><span id="L-352"><a href="#L-352"><span class="linenos">352</span></a><span class="sd"> value: the value to check if it is an iterable.</span> +</span><span id="L-353"><a href="#L-353"><span class="linenos">353</span></a> +</span><span id="L-354"><a href="#L-354"><span class="linenos">354</span></a><span class="sd"> Returns:</span> +</span><span id="L-355"><a href="#L-355"><span class="linenos">355</span></a><span class="sd"> A `bool` value indicating if it is an iterable.</span> +</span><span id="L-356"><a href="#L-356"><span class="linenos">356</span></a><span class="sd"> """</span> +</span><span id="L-357"><a href="#L-357"><span class="linenos">357</span></a> <span class="k">return</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s2">"__iter__"</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">))</span> +</span><span id="L-358"><a href="#L-358"><span class="linenos">358</span></a> +</span><span id="L-359"><a href="#L-359"><span class="linenos">359</span></a> +</span><span id="L-360"><a href="#L-360"><span class="linenos">360</span></a><span class="k">def</span> <span class="nf">flatten</span><span class="p">(</span><span class="n">values</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Iterator</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]:</span> +</span><span id="L-361"><a href="#L-361"><span class="linenos">361</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-362"><a href="#L-362"><span class="linenos">362</span></a><span class="sd"> Flattens an iterable that can contain both iterable and non-iterable elements. Objects of</span> +</span><span id="L-363"><a href="#L-363"><span class="linenos">363</span></a><span class="sd"> type `str` and `bytes` are not regarded as iterables.</span> +</span><span id="L-364"><a href="#L-364"><span class="linenos">364</span></a> +</span><span id="L-365"><a href="#L-365"><span class="linenos">365</span></a><span class="sd"> Examples:</span> +</span><span id="L-366"><a href="#L-366"><span class="linenos">366</span></a><span class="sd"> >>> list(flatten([[1, 2], 3, {4}, (5, "bla")]))</span> +</span><span id="L-367"><a href="#L-367"><span class="linenos">367</span></a><span class="sd"> [1, 2, 3, 4, 5, 'bla']</span> +</span><span id="L-368"><a href="#L-368"><span class="linenos">368</span></a><span class="sd"> >>> list(flatten([1, 2, 3]))</span> +</span><span id="L-369"><a href="#L-369"><span class="linenos">369</span></a><span class="sd"> [1, 2, 3]</span> </span><span id="L-370"><a href="#L-370"><span class="linenos">370</span></a> -</span><span id="L-371"><a href="#L-371"><span class="linenos">371</span></a><span class="k">def</span> <span class="nf">dict_depth</span><span class="p">(</span><span class="n">d</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> -</span><span id="L-372"><a href="#L-372"><span class="linenos">372</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-373"><a href="#L-373"><span class="linenos">373</span></a><span class="sd"> Get the nesting depth of a dictionary.</span> -</span><span id="L-374"><a href="#L-374"><span class="linenos">374</span></a> -</span><span id="L-375"><a href="#L-375"><span class="linenos">375</span></a><span class="sd"> For example:</span> -</span><span id="L-376"><a href="#L-376"><span class="linenos">376</span></a><span class="sd"> >>> dict_depth(None)</span> -</span><span id="L-377"><a href="#L-377"><span class="linenos">377</span></a><span class="sd"> 0</span> -</span><span id="L-378"><a href="#L-378"><span class="linenos">378</span></a><span class="sd"> >>> dict_depth({})</span> -</span><span id="L-379"><a href="#L-379"><span class="linenos">379</span></a><span class="sd"> 1</span> -</span><span id="L-380"><a href="#L-380"><span class="linenos">380</span></a><span class="sd"> >>> dict_depth({"a": "b"})</span> -</span><span id="L-381"><a href="#L-381"><span class="linenos">381</span></a><span class="sd"> 1</span> -</span><span id="L-382"><a href="#L-382"><span class="linenos">382</span></a><span class="sd"> >>> dict_depth({"a": {}})</span> -</span><span id="L-383"><a href="#L-383"><span class="linenos">383</span></a><span class="sd"> 2</span> -</span><span id="L-384"><a href="#L-384"><span class="linenos">384</span></a><span class="sd"> >>> dict_depth({"a": {"b": {}}})</span> -</span><span id="L-385"><a href="#L-385"><span class="linenos">385</span></a><span class="sd"> 3</span> -</span><span id="L-386"><a href="#L-386"><span class="linenos">386</span></a> -</span><span id="L-387"><a href="#L-387"><span class="linenos">387</span></a><span class="sd"> Args:</span> -</span><span id="L-388"><a href="#L-388"><span class="linenos">388</span></a><span class="sd"> d (dict): dictionary</span> -</span><span id="L-389"><a href="#L-389"><span class="linenos">389</span></a> -</span><span id="L-390"><a href="#L-390"><span class="linenos">390</span></a><span class="sd"> Returns:</span> -</span><span id="L-391"><a href="#L-391"><span class="linenos">391</span></a><span class="sd"> int: depth</span> -</span><span id="L-392"><a href="#L-392"><span class="linenos">392</span></a><span class="sd"> """</span> -</span><span id="L-393"><a href="#L-393"><span class="linenos">393</span></a> <span class="k">try</span><span class="p">:</span> -</span><span id="L-394"><a href="#L-394"><span class="linenos">394</span></a> <span class="k">return</span> <span class="mi">1</span> <span class="o">+</span> <span class="n">dict_depth</span><span class="p">(</span><span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">values</span><span class="p">())))</span> -</span><span id="L-395"><a href="#L-395"><span class="linenos">395</span></a> <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> -</span><span id="L-396"><a href="#L-396"><span class="linenos">396</span></a> <span class="c1"># d doesn't have attribute "values"</span> -</span><span id="L-397"><a href="#L-397"><span class="linenos">397</span></a> <span class="k">return</span> <span class="mi">0</span> -</span><span id="L-398"><a href="#L-398"><span class="linenos">398</span></a> <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span> -</span><span id="L-399"><a href="#L-399"><span class="linenos">399</span></a> <span class="c1"># d.values() returns an empty sequence</span> -</span><span id="L-400"><a href="#L-400"><span class="linenos">400</span></a> <span class="k">return</span> <span class="mi">1</span> -</span><span id="L-401"><a href="#L-401"><span class="linenos">401</span></a> -</span><span id="L-402"><a href="#L-402"><span class="linenos">402</span></a> -</span><span id="L-403"><a href="#L-403"><span class="linenos">403</span></a><span class="k">def</span> <span class="nf">first</span><span class="p">(</span><span class="n">it</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span> -</span><span id="L-404"><a href="#L-404"><span class="linenos">404</span></a><span class="w"> </span><span class="sd">"""Returns the first element from an iterable.</span> -</span><span id="L-405"><a href="#L-405"><span class="linenos">405</span></a> -</span><span id="L-406"><a href="#L-406"><span class="linenos">406</span></a><span class="sd"> Useful for sets.</span> -</span><span id="L-407"><a href="#L-407"><span class="linenos">407</span></a><span class="sd"> """</span> -</span><span id="L-408"><a href="#L-408"><span class="linenos">408</span></a> <span class="k">return</span> <span class="nb">next</span><span class="p">(</span><span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">it</span><span class="p">)</span> -</span><span id="L-409"><a href="#L-409"><span class="linenos">409</span></a> -</span><span id="L-410"><a href="#L-410"><span class="linenos">410</span></a> -</span><span id="L-411"><a href="#L-411"><span class="linenos">411</span></a><span class="k">def</span> <span class="nf">should_identify</span><span class="p">(</span><span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">identify</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> -</span><span id="L-412"><a href="#L-412"><span class="linenos">412</span></a><span class="w"> </span><span class="sd">"""Checks if text should be identified given an identify option.</span> -</span><span id="L-413"><a href="#L-413"><span class="linenos">413</span></a> -</span><span id="L-414"><a href="#L-414"><span class="linenos">414</span></a><span class="sd"> Args:</span> -</span><span id="L-415"><a href="#L-415"><span class="linenos">415</span></a><span class="sd"> text: the text to check.</span> -</span><span id="L-416"><a href="#L-416"><span class="linenos">416</span></a><span class="sd"> identify: "always" | True - always returns true, "safe" - true if no upper case</span> -</span><span id="L-417"><a href="#L-417"><span class="linenos">417</span></a> -</span><span id="L-418"><a href="#L-418"><span class="linenos">418</span></a><span class="sd"> Returns:</span> -</span><span id="L-419"><a href="#L-419"><span class="linenos">419</span></a><span class="sd"> Whether or not a string should be identified.</span> -</span><span id="L-420"><a href="#L-420"><span class="linenos">420</span></a><span class="sd"> """</span> -</span><span id="L-421"><a href="#L-421"><span class="linenos">421</span></a> <span class="k">if</span> <span class="n">identify</span> <span class="ow">is</span> <span class="kc">True</span> <span class="ow">or</span> <span class="n">identify</span> <span class="o">==</span> <span class="s2">"always"</span><span class="p">:</span> -</span><span id="L-422"><a href="#L-422"><span class="linenos">422</span></a> <span class="k">return</span> <span class="kc">True</span> -</span><span id="L-423"><a href="#L-423"><span class="linenos">423</span></a> <span class="k">if</span> <span class="n">identify</span> <span class="o">==</span> <span class="s2">"safe"</span><span class="p">:</span> -</span><span id="L-424"><a href="#L-424"><span class="linenos">424</span></a> <span class="k">return</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">char</span><span class="o">.</span><span class="n">isupper</span><span class="p">()</span> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">text</span><span class="p">)</span> -</span><span id="L-425"><a href="#L-425"><span class="linenos">425</span></a> <span class="k">return</span> <span class="kc">False</span> +</span><span id="L-371"><a href="#L-371"><span class="linenos">371</span></a><span class="sd"> Args:</span> +</span><span id="L-372"><a href="#L-372"><span class="linenos">372</span></a><span class="sd"> values: the value to be flattened.</span> +</span><span id="L-373"><a href="#L-373"><span class="linenos">373</span></a> +</span><span id="L-374"><a href="#L-374"><span class="linenos">374</span></a><span class="sd"> Yields:</span> +</span><span id="L-375"><a href="#L-375"><span class="linenos">375</span></a><span class="sd"> Non-iterable elements in `values`.</span> +</span><span id="L-376"><a href="#L-376"><span class="linenos">376</span></a><span class="sd"> """</span> +</span><span id="L-377"><a href="#L-377"><span class="linenos">377</span></a> <span class="k">for</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">values</span><span class="p">:</span> +</span><span id="L-378"><a href="#L-378"><span class="linenos">378</span></a> <span class="k">if</span> <span class="n">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> +</span><span id="L-379"><a href="#L-379"><span class="linenos">379</span></a> <span class="k">yield from</span> <span class="n">flatten</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> +</span><span id="L-380"><a href="#L-380"><span class="linenos">380</span></a> <span class="k">else</span><span class="p">:</span> +</span><span id="L-381"><a href="#L-381"><span class="linenos">381</span></a> <span class="k">yield</span> <span class="n">value</span> +</span><span id="L-382"><a href="#L-382"><span class="linenos">382</span></a> +</span><span id="L-383"><a href="#L-383"><span class="linenos">383</span></a> +</span><span id="L-384"><a href="#L-384"><span class="linenos">384</span></a><span class="k">def</span> <span class="nf">count_params</span><span class="p">(</span><span class="n">function</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> +</span><span id="L-385"><a href="#L-385"><span class="linenos">385</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-386"><a href="#L-386"><span class="linenos">386</span></a><span class="sd"> Returns the number of formal parameters expected by a function, without counting "self"</span> +</span><span id="L-387"><a href="#L-387"><span class="linenos">387</span></a><span class="sd"> and "cls", in case of instance and class methods, respectively.</span> +</span><span id="L-388"><a href="#L-388"><span class="linenos">388</span></a><span class="sd"> """</span> +</span><span id="L-389"><a href="#L-389"><span class="linenos">389</span></a> <span class="n">count</span> <span class="o">=</span> <span class="n">function</span><span class="o">.</span><span class="vm">__code__</span><span class="o">.</span><span class="n">co_argcount</span> +</span><span id="L-390"><a href="#L-390"><span class="linenos">390</span></a> <span class="k">return</span> <span class="n">count</span> <span class="o">-</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">inspect</span><span class="o">.</span><span class="n">ismethod</span><span class="p">(</span><span class="n">function</span><span class="p">)</span> <span class="k">else</span> <span class="n">count</span> +</span><span id="L-391"><a href="#L-391"><span class="linenos">391</span></a> +</span><span id="L-392"><a href="#L-392"><span class="linenos">392</span></a> +</span><span id="L-393"><a href="#L-393"><span class="linenos">393</span></a><span class="k">def</span> <span class="nf">dict_depth</span><span class="p">(</span><span class="n">d</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> +</span><span id="L-394"><a href="#L-394"><span class="linenos">394</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-395"><a href="#L-395"><span class="linenos">395</span></a><span class="sd"> Get the nesting depth of a dictionary.</span> +</span><span id="L-396"><a href="#L-396"><span class="linenos">396</span></a> +</span><span id="L-397"><a href="#L-397"><span class="linenos">397</span></a><span class="sd"> For example:</span> +</span><span id="L-398"><a href="#L-398"><span class="linenos">398</span></a><span class="sd"> >>> dict_depth(None)</span> +</span><span id="L-399"><a href="#L-399"><span class="linenos">399</span></a><span class="sd"> 0</span> +</span><span id="L-400"><a href="#L-400"><span class="linenos">400</span></a><span class="sd"> >>> dict_depth({})</span> +</span><span id="L-401"><a href="#L-401"><span class="linenos">401</span></a><span class="sd"> 1</span> +</span><span id="L-402"><a href="#L-402"><span class="linenos">402</span></a><span class="sd"> >>> dict_depth({"a": "b"})</span> +</span><span id="L-403"><a href="#L-403"><span class="linenos">403</span></a><span class="sd"> 1</span> +</span><span id="L-404"><a href="#L-404"><span class="linenos">404</span></a><span class="sd"> >>> dict_depth({"a": {}})</span> +</span><span id="L-405"><a href="#L-405"><span class="linenos">405</span></a><span class="sd"> 2</span> +</span><span id="L-406"><a href="#L-406"><span class="linenos">406</span></a><span class="sd"> >>> dict_depth({"a": {"b": {}}})</span> +</span><span id="L-407"><a href="#L-407"><span class="linenos">407</span></a><span class="sd"> 3</span> +</span><span id="L-408"><a href="#L-408"><span class="linenos">408</span></a> +</span><span id="L-409"><a href="#L-409"><span class="linenos">409</span></a><span class="sd"> Args:</span> +</span><span id="L-410"><a href="#L-410"><span class="linenos">410</span></a><span class="sd"> d (dict): dictionary</span> +</span><span id="L-411"><a href="#L-411"><span class="linenos">411</span></a> +</span><span id="L-412"><a href="#L-412"><span class="linenos">412</span></a><span class="sd"> Returns:</span> +</span><span id="L-413"><a href="#L-413"><span class="linenos">413</span></a><span class="sd"> int: depth</span> +</span><span id="L-414"><a href="#L-414"><span class="linenos">414</span></a><span class="sd"> """</span> +</span><span id="L-415"><a href="#L-415"><span class="linenos">415</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="L-416"><a href="#L-416"><span class="linenos">416</span></a> <span class="k">return</span> <span class="mi">1</span> <span class="o">+</span> <span class="n">dict_depth</span><span class="p">(</span><span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">values</span><span class="p">())))</span> +</span><span id="L-417"><a href="#L-417"><span class="linenos">417</span></a> <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> +</span><span id="L-418"><a href="#L-418"><span class="linenos">418</span></a> <span class="c1"># d doesn't have attribute "values"</span> +</span><span id="L-419"><a href="#L-419"><span class="linenos">419</span></a> <span class="k">return</span> <span class="mi">0</span> +</span><span id="L-420"><a href="#L-420"><span class="linenos">420</span></a> <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span> +</span><span id="L-421"><a href="#L-421"><span class="linenos">421</span></a> <span class="c1"># d.values() returns an empty sequence</span> +</span><span id="L-422"><a href="#L-422"><span class="linenos">422</span></a> <span class="k">return</span> <span class="mi">1</span> +</span><span id="L-423"><a href="#L-423"><span class="linenos">423</span></a> +</span><span id="L-424"><a href="#L-424"><span class="linenos">424</span></a> +</span><span id="L-425"><a href="#L-425"><span class="linenos">425</span></a><span class="k">def</span> <span class="nf">first</span><span class="p">(</span><span class="n">it</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span> +</span><span id="L-426"><a href="#L-426"><span class="linenos">426</span></a><span class="w"> </span><span class="sd">"""Returns the first element from an iterable.</span> +</span><span id="L-427"><a href="#L-427"><span class="linenos">427</span></a> +</span><span id="L-428"><a href="#L-428"><span class="linenos">428</span></a><span class="sd"> Useful for sets.</span> +</span><span id="L-429"><a href="#L-429"><span class="linenos">429</span></a><span class="sd"> """</span> +</span><span id="L-430"><a href="#L-430"><span class="linenos">430</span></a> <span class="k">return</span> <span class="nb">next</span><span class="p">(</span><span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">it</span><span class="p">)</span> +</span><span id="L-431"><a href="#L-431"><span class="linenos">431</span></a> +</span><span id="L-432"><a href="#L-432"><span class="linenos">432</span></a> +</span><span id="L-433"><a href="#L-433"><span class="linenos">433</span></a><span class="k">def</span> <span class="nf">should_identify</span><span class="p">(</span><span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">identify</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> +</span><span id="L-434"><a href="#L-434"><span class="linenos">434</span></a><span class="w"> </span><span class="sd">"""Checks if text should be identified given an identify option.</span> +</span><span id="L-435"><a href="#L-435"><span class="linenos">435</span></a> +</span><span id="L-436"><a href="#L-436"><span class="linenos">436</span></a><span class="sd"> Args:</span> +</span><span id="L-437"><a href="#L-437"><span class="linenos">437</span></a><span class="sd"> text: the text to check.</span> +</span><span id="L-438"><a href="#L-438"><span class="linenos">438</span></a><span class="sd"> identify: "always" | True - always returns true, "safe" - true if no upper case</span> +</span><span id="L-439"><a href="#L-439"><span class="linenos">439</span></a> +</span><span id="L-440"><a href="#L-440"><span class="linenos">440</span></a><span class="sd"> Returns:</span> +</span><span id="L-441"><a href="#L-441"><span class="linenos">441</span></a><span class="sd"> Whether or not a string should be identified.</span> +</span><span id="L-442"><a href="#L-442"><span class="linenos">442</span></a><span class="sd"> """</span> +</span><span id="L-443"><a href="#L-443"><span class="linenos">443</span></a> <span class="k">if</span> <span class="n">identify</span> <span class="ow">is</span> <span class="kc">True</span> <span class="ow">or</span> <span class="n">identify</span> <span class="o">==</span> <span class="s2">"always"</span><span class="p">:</span> +</span><span id="L-444"><a href="#L-444"><span class="linenos">444</span></a> <span class="k">return</span> <span class="kc">True</span> +</span><span id="L-445"><a href="#L-445"><span class="linenos">445</span></a> <span class="k">if</span> <span class="n">identify</span> <span class="o">==</span> <span class="s2">"safe"</span><span class="p">:</span> +</span><span id="L-446"><a href="#L-446"><span class="linenos">446</span></a> <span class="k">return</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">char</span><span class="o">.</span><span class="n">isupper</span><span class="p">()</span> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">text</span><span class="p">)</span> +</span><span id="L-447"><a href="#L-447"><span class="linenos">447</span></a> <span class="k">return</span> <span class="kc">False</span> </span></pre></div> @@ -805,36 +827,58 @@ <div class="attr function"> <span class="def">def</span> - <span class="name">apply_index_offset</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">expressions</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="o">~</span><span class="n">E</span><span class="p">]]</span>, </span><span class="param"><span class="n">offset</span><span class="p">:</span> <span class="nb">int</span></span><span class="return-annotation">) -> <span class="n">List</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="o">~</span><span class="n">E</span><span class="p">]]</span>:</span></span> + <span class="name">apply_index_offset</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">this</span><span class="p">:</span> <span class="n"><a href="expressions.html#Expression">sqlglot.expressions.Expression</a></span>,</span><span class="param"> <span class="n">expressions</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="o">~</span><span class="n">E</span><span class="p">]]</span>,</span><span class="param"> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span></span><span class="return-annotation">) -> <span class="n">List</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="o">~</span><span class="n">E</span><span class="p">]]</span>:</span></span> <label class="view-source-button" for="apply_index_offset-view-source"><span>View Source</span></label> </div> <a class="headerlink" href="#apply_index_offset"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="apply_index_offset-135"><a href="#apply_index_offset-135"><span class="linenos">135</span></a><span class="k">def</span> <span class="nf">apply_index_offset</span><span class="p">(</span><span class="n">expressions</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">E</span><span class="p">]],</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">E</span><span class="p">]]:</span> -</span><span id="apply_index_offset-136"><a href="#apply_index_offset-136"><span class="linenos">136</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="apply_index_offset-137"><a href="#apply_index_offset-137"><span class="linenos">137</span></a><span class="sd"> Applies an offset to a given integer literal expression.</span> -</span><span id="apply_index_offset-138"><a href="#apply_index_offset-138"><span class="linenos">138</span></a> -</span><span id="apply_index_offset-139"><a href="#apply_index_offset-139"><span class="linenos">139</span></a><span class="sd"> Args:</span> -</span><span id="apply_index_offset-140"><a href="#apply_index_offset-140"><span class="linenos">140</span></a><span class="sd"> expressions: the expression the offset will be applied to, wrapped in a list.</span> -</span><span id="apply_index_offset-141"><a href="#apply_index_offset-141"><span class="linenos">141</span></a><span class="sd"> offset: the offset that will be applied.</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="apply_index_offset-135"><a href="#apply_index_offset-135"><span class="linenos">135</span></a><span class="k">def</span> <span class="nf">apply_index_offset</span><span class="p">(</span> +</span><span id="apply_index_offset-136"><a href="#apply_index_offset-136"><span class="linenos">136</span></a> <span class="n">this</span><span class="p">:</span> <span class="n">exp</span><span class="o">.</span><span class="n">Expression</span><span class="p">,</span> +</span><span id="apply_index_offset-137"><a href="#apply_index_offset-137"><span class="linenos">137</span></a> <span class="n">expressions</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">E</span><span class="p">]],</span> +</span><span id="apply_index_offset-138"><a href="#apply_index_offset-138"><span class="linenos">138</span></a> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> +</span><span id="apply_index_offset-139"><a href="#apply_index_offset-139"><span class="linenos">139</span></a><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">E</span><span class="p">]]:</span> +</span><span id="apply_index_offset-140"><a href="#apply_index_offset-140"><span class="linenos">140</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="apply_index_offset-141"><a href="#apply_index_offset-141"><span class="linenos">141</span></a><span class="sd"> Applies an offset to a given integer literal expression.</span> </span><span id="apply_index_offset-142"><a href="#apply_index_offset-142"><span class="linenos">142</span></a> -</span><span id="apply_index_offset-143"><a href="#apply_index_offset-143"><span class="linenos">143</span></a><span class="sd"> Returns:</span> -</span><span id="apply_index_offset-144"><a href="#apply_index_offset-144"><span class="linenos">144</span></a><span class="sd"> The original expression with the offset applied to it, wrapped in a list. If the provided</span> -</span><span id="apply_index_offset-145"><a href="#apply_index_offset-145"><span class="linenos">145</span></a><span class="sd"> `expressions` argument contains more than one expressions, it's returned unaffected.</span> -</span><span id="apply_index_offset-146"><a href="#apply_index_offset-146"><span class="linenos">146</span></a><span class="sd"> """</span> -</span><span id="apply_index_offset-147"><a href="#apply_index_offset-147"><span class="linenos">147</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">offset</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">expressions</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span> -</span><span id="apply_index_offset-148"><a href="#apply_index_offset-148"><span class="linenos">148</span></a> <span class="k">return</span> <span class="n">expressions</span> -</span><span id="apply_index_offset-149"><a href="#apply_index_offset-149"><span class="linenos">149</span></a> -</span><span id="apply_index_offset-150"><a href="#apply_index_offset-150"><span class="linenos">150</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">expressions</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> -</span><span id="apply_index_offset-151"><a href="#apply_index_offset-151"><span class="linenos">151</span></a> -</span><span id="apply_index_offset-152"><a href="#apply_index_offset-152"><span class="linenos">152</span></a> <span class="k">if</span> <span class="n">expression</span> <span class="ow">and</span> <span class="n">expression</span><span class="o">.</span><span class="n">is_int</span><span class="p">:</span> -</span><span id="apply_index_offset-153"><a href="#apply_index_offset-153"><span class="linenos">153</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">expression</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> -</span><span id="apply_index_offset-154"><a href="#apply_index_offset-154"><span class="linenos">154</span></a> <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Applying array index offset (</span><span class="si">%s</span><span class="s2">)"</span><span class="p">,</span> <span class="n">offset</span><span class="p">)</span> -</span><span id="apply_index_offset-155"><a href="#apply_index_offset-155"><span class="linenos">155</span></a> <span class="n">expression</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="s2">"this"</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">expression</span><span class="o">.</span><span class="n">this</span><span class="p">)</span> <span class="o">+</span> <span class="n">offset</span><span class="p">)</span> <span class="c1"># type: ignore</span> -</span><span id="apply_index_offset-156"><a href="#apply_index_offset-156"><span class="linenos">156</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">expression</span><span class="p">]</span> -</span><span id="apply_index_offset-157"><a href="#apply_index_offset-157"><span class="linenos">157</span></a> -</span><span id="apply_index_offset-158"><a href="#apply_index_offset-158"><span class="linenos">158</span></a> <span class="k">return</span> <span class="n">expressions</span> +</span><span id="apply_index_offset-143"><a href="#apply_index_offset-143"><span class="linenos">143</span></a><span class="sd"> Args:</span> +</span><span id="apply_index_offset-144"><a href="#apply_index_offset-144"><span class="linenos">144</span></a><span class="sd"> this: the target of the index</span> +</span><span id="apply_index_offset-145"><a href="#apply_index_offset-145"><span class="linenos">145</span></a><span class="sd"> expressions: the expression the offset will be applied to, wrapped in a list.</span> +</span><span id="apply_index_offset-146"><a href="#apply_index_offset-146"><span class="linenos">146</span></a><span class="sd"> offset: the offset that will be applied.</span> +</span><span id="apply_index_offset-147"><a href="#apply_index_offset-147"><span class="linenos">147</span></a> +</span><span id="apply_index_offset-148"><a href="#apply_index_offset-148"><span class="linenos">148</span></a><span class="sd"> Returns:</span> +</span><span id="apply_index_offset-149"><a href="#apply_index_offset-149"><span class="linenos">149</span></a><span class="sd"> The original expression with the offset applied to it, wrapped in a list. If the provided</span> +</span><span id="apply_index_offset-150"><a href="#apply_index_offset-150"><span class="linenos">150</span></a><span class="sd"> `expressions` argument contains more than one expressions, it's returned unaffected.</span> +</span><span id="apply_index_offset-151"><a href="#apply_index_offset-151"><span class="linenos">151</span></a><span class="sd"> """</span> +</span><span id="apply_index_offset-152"><a href="#apply_index_offset-152"><span class="linenos">152</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">offset</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">expressions</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span> +</span><span id="apply_index_offset-153"><a href="#apply_index_offset-153"><span class="linenos">153</span></a> <span class="k">return</span> <span class="n">expressions</span> +</span><span id="apply_index_offset-154"><a href="#apply_index_offset-154"><span class="linenos">154</span></a> +</span><span id="apply_index_offset-155"><a href="#apply_index_offset-155"><span class="linenos">155</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">expressions</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> +</span><span id="apply_index_offset-156"><a href="#apply_index_offset-156"><span class="linenos">156</span></a> +</span><span id="apply_index_offset-157"><a href="#apply_index_offset-157"><span class="linenos">157</span></a> <span class="kn">from</span> <span class="nn">sqlglot</span> <span class="kn">import</span> <span class="n">exp</span> +</span><span id="apply_index_offset-158"><a href="#apply_index_offset-158"><span class="linenos">158</span></a> <span class="kn">from</span> <span class="nn">sqlglot.optimizer.annotate_types</span> <span class="kn">import</span> <span class="n">annotate_types</span> +</span><span id="apply_index_offset-159"><a href="#apply_index_offset-159"><span class="linenos">159</span></a> <span class="kn">from</span> <span class="nn">sqlglot.optimizer.simplify</span> <span class="kn">import</span> <span class="n">simplify</span> +</span><span id="apply_index_offset-160"><a href="#apply_index_offset-160"><span class="linenos">160</span></a> +</span><span id="apply_index_offset-161"><a href="#apply_index_offset-161"><span class="linenos">161</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">this</span><span class="o">.</span><span class="n">type</span><span class="p">:</span> +</span><span id="apply_index_offset-162"><a href="#apply_index_offset-162"><span class="linenos">162</span></a> <span class="n">annotate_types</span><span class="p">(</span><span class="n">this</span><span class="p">)</span> +</span><span id="apply_index_offset-163"><a href="#apply_index_offset-163"><span class="linenos">163</span></a> +</span><span id="apply_index_offset-164"><a href="#apply_index_offset-164"><span class="linenos">164</span></a> <span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="p">,</span> <span class="n">this</span><span class="o">.</span><span class="n">type</span><span class="p">)</span><span class="o">.</span><span class="n">this</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span> +</span><span id="apply_index_offset-165"><a href="#apply_index_offset-165"><span class="linenos">165</span></a> <span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="o">.</span><span class="n">Type</span><span class="o">.</span><span class="n">UNKNOWN</span><span class="p">,</span> +</span><span id="apply_index_offset-166"><a href="#apply_index_offset-166"><span class="linenos">166</span></a> <span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="o">.</span><span class="n">Type</span><span class="o">.</span><span class="n">ARRAY</span><span class="p">,</span> +</span><span id="apply_index_offset-167"><a href="#apply_index_offset-167"><span class="linenos">167</span></a> <span class="p">):</span> +</span><span id="apply_index_offset-168"><a href="#apply_index_offset-168"><span class="linenos">168</span></a> <span class="k">return</span> <span class="n">expressions</span> +</span><span id="apply_index_offset-169"><a href="#apply_index_offset-169"><span class="linenos">169</span></a> +</span><span id="apply_index_offset-170"><a href="#apply_index_offset-170"><span class="linenos">170</span></a> <span class="k">if</span> <span class="n">expression</span><span class="p">:</span> +</span><span id="apply_index_offset-171"><a href="#apply_index_offset-171"><span class="linenos">171</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">expression</span><span class="o">.</span><span class="n">type</span><span class="p">:</span> +</span><span id="apply_index_offset-172"><a href="#apply_index_offset-172"><span class="linenos">172</span></a> <span class="n">annotate_types</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> +</span><span id="apply_index_offset-173"><a href="#apply_index_offset-173"><span class="linenos">173</span></a> <span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="p">,</span> <span class="n">expression</span><span class="o">.</span><span class="n">type</span><span class="p">)</span><span class="o">.</span><span class="n">this</span> <span class="ow">in</span> <span class="n">exp</span><span class="o">.</span><span class="n">DataType</span><span class="o">.</span><span class="n">INTEGER_TYPES</span><span class="p">:</span> +</span><span id="apply_index_offset-174"><a href="#apply_index_offset-174"><span class="linenos">174</span></a> <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Applying array index offset (</span><span class="si">%s</span><span class="s2">)"</span><span class="p">,</span> <span class="n">offset</span><span class="p">)</span> +</span><span id="apply_index_offset-175"><a href="#apply_index_offset-175"><span class="linenos">175</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">simplify</span><span class="p">(</span> +</span><span id="apply_index_offset-176"><a href="#apply_index_offset-176"><span class="linenos">176</span></a> <span class="n">exp</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="n">this</span><span class="o">=</span><span class="n">expression</span><span class="o">.</span><span class="n">copy</span><span class="p">(),</span> <span class="n">expression</span><span class="o">=</span><span class="n">exp</span><span class="o">.</span><span class="n">Literal</span><span class="o">.</span><span class="n">number</span><span class="p">(</span><span class="n">offset</span><span class="p">))</span> +</span><span id="apply_index_offset-177"><a href="#apply_index_offset-177"><span class="linenos">177</span></a> <span class="p">)</span> +</span><span id="apply_index_offset-178"><a href="#apply_index_offset-178"><span class="linenos">178</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">expression</span><span class="p">]</span> +</span><span id="apply_index_offset-179"><a href="#apply_index_offset-179"><span class="linenos">179</span></a> +</span><span id="apply_index_offset-180"><a href="#apply_index_offset-180"><span class="linenos">180</span></a> <span class="k">return</span> <span class="n">expressions</span> </span></pre></div> @@ -843,6 +887,7 @@ <h6 id="arguments">Arguments:</h6> <ul> +<li><strong>this:</strong> the target of the index</li> <li><strong>expressions:</strong> the expression the offset will be applied to, wrapped in a list.</li> <li><strong>offset:</strong> the offset that will be applied.</li> </ul> @@ -868,9 +913,9 @@ </div> <a class="headerlink" href="#camel_to_snake_case"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="camel_to_snake_case-161"><a href="#camel_to_snake_case-161"><span class="linenos">161</span></a><span class="k">def</span> <span class="nf">camel_to_snake_case</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> -</span><span id="camel_to_snake_case-162"><a href="#camel_to_snake_case-162"><span class="linenos">162</span></a><span class="w"> </span><span class="sd">"""Converts `name` from camelCase to snake_case and returns the result."""</span> -</span><span id="camel_to_snake_case-163"><a href="#camel_to_snake_case-163"><span class="linenos">163</span></a> <span class="k">return</span> <span class="n">CAMEL_CASE_PATTERN</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">"_"</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="camel_to_snake_case-183"><a href="#camel_to_snake_case-183"><span class="linenos">183</span></a><span class="k">def</span> <span class="nf">camel_to_snake_case</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> +</span><span id="camel_to_snake_case-184"><a href="#camel_to_snake_case-184"><span class="linenos">184</span></a><span class="w"> </span><span class="sd">"""Converts `name` from camelCase to snake_case and returns the result."""</span> +</span><span id="camel_to_snake_case-185"><a href="#camel_to_snake_case-185"><span class="linenos">185</span></a> <span class="k">return</span> <span class="n">CAMEL_CASE_PATTERN</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">"_"</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> </span></pre></div> @@ -890,28 +935,28 @@ </div> <a class="headerlink" href="#while_changing"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="while_changing-166"><a href="#while_changing-166"><span class="linenos">166</span></a><span class="k">def</span> <span class="nf">while_changing</span><span class="p">(</span><span class="n">expression</span><span class="p">:</span> <span class="n">Expression</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">[[</span><span class="n">Expression</span><span class="p">],</span> <span class="n">E</span><span class="p">])</span> <span class="o">-></span> <span class="n">E</span><span class="p">:</span> -</span><span id="while_changing-167"><a href="#while_changing-167"><span class="linenos">167</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="while_changing-168"><a href="#while_changing-168"><span class="linenos">168</span></a><span class="sd"> Applies a transformation to a given expression until a fix point is reached.</span> -</span><span id="while_changing-169"><a href="#while_changing-169"><span class="linenos">169</span></a> -</span><span id="while_changing-170"><a href="#while_changing-170"><span class="linenos">170</span></a><span class="sd"> Args:</span> -</span><span id="while_changing-171"><a href="#while_changing-171"><span class="linenos">171</span></a><span class="sd"> expression: the expression to be transformed.</span> -</span><span id="while_changing-172"><a href="#while_changing-172"><span class="linenos">172</span></a><span class="sd"> func: the transformation to be applied.</span> -</span><span id="while_changing-173"><a href="#while_changing-173"><span class="linenos">173</span></a> -</span><span id="while_changing-174"><a href="#while_changing-174"><span class="linenos">174</span></a><span class="sd"> Returns:</span> -</span><span id="while_changing-175"><a href="#while_changing-175"><span class="linenos">175</span></a><span class="sd"> The transformed expression.</span> -</span><span id="while_changing-176"><a href="#while_changing-176"><span class="linenos">176</span></a><span class="sd"> """</span> -</span><span id="while_changing-177"><a href="#while_changing-177"><span class="linenos">177</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> -</span><span id="while_changing-178"><a href="#while_changing-178"><span class="linenos">178</span></a> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="n">_</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">expression</span><span class="o">.</span><span class="n">walk</span><span class="p">())):</span> -</span><span id="while_changing-179"><a href="#while_changing-179"><span class="linenos">179</span></a> <span class="n">n</span><span class="o">.</span><span class="n">_hash</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> -</span><span id="while_changing-180"><a href="#while_changing-180"><span class="linenos">180</span></a> <span class="n">start</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> -</span><span id="while_changing-181"><a href="#while_changing-181"><span class="linenos">181</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> -</span><span id="while_changing-182"><a href="#while_changing-182"><span class="linenos">182</span></a> -</span><span id="while_changing-183"><a href="#while_changing-183"><span class="linenos">183</span></a> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="n">_</span> <span class="ow">in</span> <span class="n">expression</span><span class="o">.</span><span class="n">walk</span><span class="p">():</span> -</span><span id="while_changing-184"><a href="#while_changing-184"><span class="linenos">184</span></a> <span class="n">n</span><span class="o">.</span><span class="n">_hash</span> <span class="o">=</span> <span class="kc">None</span> -</span><span id="while_changing-185"><a href="#while_changing-185"><span class="linenos">185</span></a> <span class="k">if</span> <span class="n">start</span> <span class="o">==</span> <span class="nb">hash</span><span class="p">(</span><span class="n">expression</span><span class="p">):</span> -</span><span id="while_changing-186"><a href="#while_changing-186"><span class="linenos">186</span></a> <span class="k">break</span> -</span><span id="while_changing-187"><a href="#while_changing-187"><span class="linenos">187</span></a> <span class="k">return</span> <span class="n">expression</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="while_changing-188"><a href="#while_changing-188"><span class="linenos">188</span></a><span class="k">def</span> <span class="nf">while_changing</span><span class="p">(</span><span class="n">expression</span><span class="p">:</span> <span class="n">Expression</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">[[</span><span class="n">Expression</span><span class="p">],</span> <span class="n">E</span><span class="p">])</span> <span class="o">-></span> <span class="n">E</span><span class="p">:</span> +</span><span id="while_changing-189"><a href="#while_changing-189"><span class="linenos">189</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="while_changing-190"><a href="#while_changing-190"><span class="linenos">190</span></a><span class="sd"> Applies a transformation to a given expression until a fix point is reached.</span> +</span><span id="while_changing-191"><a href="#while_changing-191"><span class="linenos">191</span></a> +</span><span id="while_changing-192"><a href="#while_changing-192"><span class="linenos">192</span></a><span class="sd"> Args:</span> +</span><span id="while_changing-193"><a href="#while_changing-193"><span class="linenos">193</span></a><span class="sd"> expression: the expression to be transformed.</span> +</span><span id="while_changing-194"><a href="#while_changing-194"><span class="linenos">194</span></a><span class="sd"> func: the transformation to be applied.</span> +</span><span id="while_changing-195"><a href="#while_changing-195"><span class="linenos">195</span></a> +</span><span id="while_changing-196"><a href="#while_changing-196"><span class="linenos">196</span></a><span class="sd"> Returns:</span> +</span><span id="while_changing-197"><a href="#while_changing-197"><span class="linenos">197</span></a><span class="sd"> The transformed expression.</span> +</span><span id="while_changing-198"><a href="#while_changing-198"><span class="linenos">198</span></a><span class="sd"> """</span> +</span><span id="while_changing-199"><a href="#while_changing-199"><span class="linenos">199</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> +</span><span id="while_changing-200"><a href="#while_changing-200"><span class="linenos">200</span></a> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="n">_</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">expression</span><span class="o">.</span><span class="n">walk</span><span class="p">())):</span> +</span><span id="while_changing-201"><a href="#while_changing-201"><span class="linenos">201</span></a> <span class="n">n</span><span class="o">.</span><span class="n">_hash</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> +</span><span id="while_changing-202"><a href="#while_changing-202"><span class="linenos">202</span></a> <span class="n">start</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> +</span><span id="while_changing-203"><a href="#while_changing-203"><span class="linenos">203</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span> +</span><span id="while_changing-204"><a href="#while_changing-204"><span class="linenos">204</span></a> +</span><span id="while_changing-205"><a href="#while_changing-205"><span class="linenos">205</span></a> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="n">_</span> <span class="ow">in</span> <span class="n">expression</span><span class="o">.</span><span class="n">walk</span><span class="p">():</span> +</span><span id="while_changing-206"><a href="#while_changing-206"><span class="linenos">206</span></a> <span class="n">n</span><span class="o">.</span><span class="n">_hash</span> <span class="o">=</span> <span class="kc">None</span> +</span><span id="while_changing-207"><a href="#while_changing-207"><span class="linenos">207</span></a> <span class="k">if</span> <span class="n">start</span> <span class="o">==</span> <span class="nb">hash</span><span class="p">(</span><span class="n">expression</span><span class="p">):</span> +</span><span id="while_changing-208"><a href="#while_changing-208"><span class="linenos">208</span></a> <span class="k">break</span> +</span><span id="while_changing-209"><a href="#while_changing-209"><span class="linenos">209</span></a> <span class="k">return</span> <span class="n">expression</span> </span></pre></div> @@ -944,36 +989,36 @@ </div> <a class="headerlink" href="#tsort"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="tsort-190"><a href="#tsort-190"><span class="linenos">190</span></a><span class="k">def</span> <span class="nf">tsort</span><span class="p">(</span><span class="n">dag</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">T</span><span class="p">]])</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> -</span><span id="tsort-191"><a href="#tsort-191"><span class="linenos">191</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="tsort-192"><a href="#tsort-192"><span class="linenos">192</span></a><span class="sd"> Sorts a given directed acyclic graph in topological order.</span> -</span><span id="tsort-193"><a href="#tsort-193"><span class="linenos">193</span></a> -</span><span id="tsort-194"><a href="#tsort-194"><span class="linenos">194</span></a><span class="sd"> Args:</span> -</span><span id="tsort-195"><a href="#tsort-195"><span class="linenos">195</span></a><span class="sd"> dag: the graph to be sorted.</span> -</span><span id="tsort-196"><a href="#tsort-196"><span class="linenos">196</span></a> -</span><span id="tsort-197"><a href="#tsort-197"><span class="linenos">197</span></a><span class="sd"> Returns:</span> -</span><span id="tsort-198"><a href="#tsort-198"><span class="linenos">198</span></a><span class="sd"> A list that contains all of the graph's nodes in topological order.</span> -</span><span id="tsort-199"><a href="#tsort-199"><span class="linenos">199</span></a><span class="sd"> """</span> -</span><span id="tsort-200"><a href="#tsort-200"><span class="linenos">200</span></a> <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span> -</span><span id="tsort-201"><a href="#tsort-201"><span class="linenos">201</span></a> -</span><span id="tsort-202"><a href="#tsort-202"><span class="linenos">202</span></a> <span class="k">def</span> <span class="nf">visit</span><span class="p">(</span><span class="n">node</span><span class="p">:</span> <span class="n">T</span><span class="p">,</span> <span class="n">visited</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Set</span><span class="p">[</span><span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> -</span><span id="tsort-203"><a href="#tsort-203"><span class="linenos">203</span></a> <span class="k">if</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span> -</span><span id="tsort-204"><a href="#tsort-204"><span class="linenos">204</span></a> <span class="k">return</span> -</span><span id="tsort-205"><a href="#tsort-205"><span class="linenos">205</span></a> <span class="k">if</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">visited</span><span class="p">:</span> -</span><span id="tsort-206"><a href="#tsort-206"><span class="linenos">206</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Cycle error"</span><span class="p">)</span> -</span><span id="tsort-207"><a href="#tsort-207"><span class="linenos">207</span></a> -</span><span id="tsort-208"><a href="#tsort-208"><span class="linenos">208</span></a> <span class="n">visited</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> -</span><span id="tsort-209"><a href="#tsort-209"><span class="linenos">209</span></a> -</span><span id="tsort-210"><a href="#tsort-210"><span class="linenos">210</span></a> <span class="k">for</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="p">[]):</span> -</span><span id="tsort-211"><a href="#tsort-211"><span class="linenos">211</span></a> <span class="n">visit</span><span class="p">(</span><span class="n">dep</span><span class="p">,</span> <span class="n">visited</span><span class="p">)</span> -</span><span id="tsort-212"><a href="#tsort-212"><span class="linenos">212</span></a> -</span><span id="tsort-213"><a href="#tsort-213"><span class="linenos">213</span></a> <span class="n">visited</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> -</span><span id="tsort-214"><a href="#tsort-214"><span class="linenos">214</span></a> <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="tsort-212"><a href="#tsort-212"><span class="linenos">212</span></a><span class="k">def</span> <span class="nf">tsort</span><span class="p">(</span><span class="n">dag</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">T</span><span class="p">]])</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> +</span><span id="tsort-213"><a href="#tsort-213"><span class="linenos">213</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="tsort-214"><a href="#tsort-214"><span class="linenos">214</span></a><span class="sd"> Sorts a given directed acyclic graph in topological order.</span> </span><span id="tsort-215"><a href="#tsort-215"><span class="linenos">215</span></a> -</span><span id="tsort-216"><a href="#tsort-216"><span class="linenos">216</span></a> <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">dag</span><span class="p">:</span> -</span><span id="tsort-217"><a href="#tsort-217"><span class="linenos">217</span></a> <span class="n">visit</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="nb">set</span><span class="p">())</span> +</span><span id="tsort-216"><a href="#tsort-216"><span class="linenos">216</span></a><span class="sd"> Args:</span> +</span><span id="tsort-217"><a href="#tsort-217"><span class="linenos">217</span></a><span class="sd"> dag: the graph to be sorted.</span> </span><span id="tsort-218"><a href="#tsort-218"><span class="linenos">218</span></a> -</span><span id="tsort-219"><a href="#tsort-219"><span class="linenos">219</span></a> <span class="k">return</span> <span class="n">result</span> +</span><span id="tsort-219"><a href="#tsort-219"><span class="linenos">219</span></a><span class="sd"> Returns:</span> +</span><span id="tsort-220"><a href="#tsort-220"><span class="linenos">220</span></a><span class="sd"> A list that contains all of the graph's nodes in topological order.</span> +</span><span id="tsort-221"><a href="#tsort-221"><span class="linenos">221</span></a><span class="sd"> """</span> +</span><span id="tsort-222"><a href="#tsort-222"><span class="linenos">222</span></a> <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span> +</span><span id="tsort-223"><a href="#tsort-223"><span class="linenos">223</span></a> +</span><span id="tsort-224"><a href="#tsort-224"><span class="linenos">224</span></a> <span class="k">def</span> <span class="nf">visit</span><span class="p">(</span><span class="n">node</span><span class="p">:</span> <span class="n">T</span><span class="p">,</span> <span class="n">visited</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Set</span><span class="p">[</span><span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> +</span><span id="tsort-225"><a href="#tsort-225"><span class="linenos">225</span></a> <span class="k">if</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span> +</span><span id="tsort-226"><a href="#tsort-226"><span class="linenos">226</span></a> <span class="k">return</span> +</span><span id="tsort-227"><a href="#tsort-227"><span class="linenos">227</span></a> <span class="k">if</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">visited</span><span class="p">:</span> +</span><span id="tsort-228"><a href="#tsort-228"><span class="linenos">228</span></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Cycle error"</span><span class="p">)</span> +</span><span id="tsort-229"><a href="#tsort-229"><span class="linenos">229</span></a> +</span><span id="tsort-230"><a href="#tsort-230"><span class="linenos">230</span></a> <span class="n">visited</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> +</span><span id="tsort-231"><a href="#tsort-231"><span class="linenos">231</span></a> +</span><span id="tsort-232"><a href="#tsort-232"><span class="linenos">232</span></a> <span class="k">for</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="p">[]):</span> +</span><span id="tsort-233"><a href="#tsort-233"><span class="linenos">233</span></a> <span class="n">visit</span><span class="p">(</span><span class="n">dep</span><span class="p">,</span> <span class="n">visited</span><span class="p">)</span> +</span><span id="tsort-234"><a href="#tsort-234"><span class="linenos">234</span></a> +</span><span id="tsort-235"><a href="#tsort-235"><span class="linenos">235</span></a> <span class="n">visited</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> +</span><span id="tsort-236"><a href="#tsort-236"><span class="linenos">236</span></a> <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> +</span><span id="tsort-237"><a href="#tsort-237"><span class="linenos">237</span></a> +</span><span id="tsort-238"><a href="#tsort-238"><span class="linenos">238</span></a> <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">dag</span><span class="p">:</span> +</span><span id="tsort-239"><a href="#tsort-239"><span class="linenos">239</span></a> <span class="n">visit</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="nb">set</span><span class="p">())</span> +</span><span id="tsort-240"><a href="#tsort-240"><span class="linenos">240</span></a> +</span><span id="tsort-241"><a href="#tsort-241"><span class="linenos">241</span></a> <span class="k">return</span> <span class="n">result</span> </span></pre></div> @@ -1005,17 +1050,17 @@ </div> <a class="headerlink" href="#open_file"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="open_file-222"><a href="#open_file-222"><span class="linenos">222</span></a><span class="k">def</span> <span class="nf">open_file</span><span class="p">(</span><span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">TextIO</span><span class="p">:</span> -</span><span id="open_file-223"><a href="#open_file-223"><span class="linenos">223</span></a><span class="w"> </span><span class="sd">"""Open a file that may be compressed as gzip and return it in universal newline mode."""</span> -</span><span id="open_file-224"><a href="#open_file-224"><span class="linenos">224</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> -</span><span id="open_file-225"><a href="#open_file-225"><span class="linenos">225</span></a> <span class="n">gzipped</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="o">==</span> <span class="sa">b</span><span class="s2">"</span><span class="se">\x1f\x8b</span><span class="s2">"</span> -</span><span id="open_file-226"><a href="#open_file-226"><span class="linenos">226</span></a> -</span><span id="open_file-227"><a href="#open_file-227"><span class="linenos">227</span></a> <span class="k">if</span> <span class="n">gzipped</span><span class="p">:</span> -</span><span id="open_file-228"><a href="#open_file-228"><span class="linenos">228</span></a> <span class="kn">import</span> <span class="nn">gzip</span> -</span><span id="open_file-229"><a href="#open_file-229"><span class="linenos">229</span></a> -</span><span id="open_file-230"><a href="#open_file-230"><span class="linenos">230</span></a> <span class="k">return</span> <span class="n">gzip</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rt"</span><span class="p">,</span> <span class="n">newline</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span> -</span><span id="open_file-231"><a href="#open_file-231"><span class="linenos">231</span></a> -</span><span id="open_file-232"><a href="#open_file-232"><span class="linenos">232</span></a> <span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span> <span class="n">newline</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="open_file-244"><a href="#open_file-244"><span class="linenos">244</span></a><span class="k">def</span> <span class="nf">open_file</span><span class="p">(</span><span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">TextIO</span><span class="p">:</span> +</span><span id="open_file-245"><a href="#open_file-245"><span class="linenos">245</span></a><span class="w"> </span><span class="sd">"""Open a file that may be compressed as gzip and return it in universal newline mode."""</span> +</span><span id="open_file-246"><a href="#open_file-246"><span class="linenos">246</span></a> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> +</span><span id="open_file-247"><a href="#open_file-247"><span class="linenos">247</span></a> <span class="n">gzipped</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="o">==</span> <span class="sa">b</span><span class="s2">"</span><span class="se">\x1f\x8b</span><span class="s2">"</span> +</span><span id="open_file-248"><a href="#open_file-248"><span class="linenos">248</span></a> +</span><span id="open_file-249"><a href="#open_file-249"><span class="linenos">249</span></a> <span class="k">if</span> <span class="n">gzipped</span><span class="p">:</span> +</span><span id="open_file-250"><a href="#open_file-250"><span class="linenos">250</span></a> <span class="kn">import</span> <span class="nn">gzip</span> +</span><span id="open_file-251"><a href="#open_file-251"><span class="linenos">251</span></a> +</span><span id="open_file-252"><a href="#open_file-252"><span class="linenos">252</span></a> <span class="k">return</span> <span class="n">gzip</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rt"</span><span class="p">,</span> <span class="n">newline</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span> +</span><span id="open_file-253"><a href="#open_file-253"><span class="linenos">253</span></a> +</span><span id="open_file-254"><a href="#open_file-254"><span class="linenos">254</span></a> <span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span> <span class="n">newline</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span> </span></pre></div> @@ -1036,32 +1081,32 @@ </div> <a class="headerlink" href="#csv_reader"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="csv_reader-235"><a href="#csv_reader-235"><span class="linenos">235</span></a><span class="nd">@contextmanager</span> -</span><span id="csv_reader-236"><a href="#csv_reader-236"><span class="linenos">236</span></a><span class="k">def</span> <span class="nf">csv_reader</span><span class="p">(</span><span class="n">read_csv</span><span class="p">:</span> <span class="n">exp</span><span class="o">.</span><span class="n">ReadCSV</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span> -</span><span id="csv_reader-237"><a href="#csv_reader-237"><span class="linenos">237</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="csv_reader-238"><a href="#csv_reader-238"><span class="linenos">238</span></a><span class="sd"> Returns a csv reader given the expression `READ_CSV(name, ['delimiter', '|', ...])`.</span> -</span><span id="csv_reader-239"><a href="#csv_reader-239"><span class="linenos">239</span></a> -</span><span id="csv_reader-240"><a href="#csv_reader-240"><span class="linenos">240</span></a><span class="sd"> Args:</span> -</span><span id="csv_reader-241"><a href="#csv_reader-241"><span class="linenos">241</span></a><span class="sd"> read_csv: a `ReadCSV` function call</span> -</span><span id="csv_reader-242"><a href="#csv_reader-242"><span class="linenos">242</span></a> -</span><span id="csv_reader-243"><a href="#csv_reader-243"><span class="linenos">243</span></a><span class="sd"> Yields:</span> -</span><span id="csv_reader-244"><a href="#csv_reader-244"><span class="linenos">244</span></a><span class="sd"> A python csv reader.</span> -</span><span id="csv_reader-245"><a href="#csv_reader-245"><span class="linenos">245</span></a><span class="sd"> """</span> -</span><span id="csv_reader-246"><a href="#csv_reader-246"><span class="linenos">246</span></a> <span class="n">args</span> <span class="o">=</span> <span class="n">read_csv</span><span class="o">.</span><span class="n">expressions</span> -</span><span id="csv_reader-247"><a href="#csv_reader-247"><span class="linenos">247</span></a> <span class="n">file</span> <span class="o">=</span> <span class="n">open_file</span><span class="p">(</span><span class="n">read_csv</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> -</span><span id="csv_reader-248"><a href="#csv_reader-248"><span class="linenos">248</span></a> -</span><span id="csv_reader-249"><a href="#csv_reader-249"><span class="linenos">249</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="s2">","</span> -</span><span id="csv_reader-250"><a href="#csv_reader-250"><span class="linenos">250</span></a> <span class="n">args</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">arg</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">)</span> -</span><span id="csv_reader-251"><a href="#csv_reader-251"><span class="linenos">251</span></a> <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="nb">zip</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span> -</span><span id="csv_reader-252"><a href="#csv_reader-252"><span class="linenos">252</span></a> <span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="s2">"delimiter"</span><span class="p">:</span> -</span><span id="csv_reader-253"><a href="#csv_reader-253"><span class="linenos">253</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="n">v</span> -</span><span id="csv_reader-254"><a href="#csv_reader-254"><span class="linenos">254</span></a> -</span><span id="csv_reader-255"><a href="#csv_reader-255"><span class="linenos">255</span></a> <span class="k">try</span><span class="p">:</span> -</span><span id="csv_reader-256"><a href="#csv_reader-256"><span class="linenos">256</span></a> <span class="kn">import</span> <span class="nn">csv</span> <span class="k">as</span> <span class="nn">csv_</span> -</span><span id="csv_reader-257"><a href="#csv_reader-257"><span class="linenos">257</span></a> -</span><span id="csv_reader-258"><a href="#csv_reader-258"><span class="linenos">258</span></a> <span class="k">yield</span> <span class="n">csv_</span><span class="o">.</span><span class="n">reader</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="n">delimiter</span><span class="o">=</span><span class="n">delimiter</span><span class="p">)</span> -</span><span id="csv_reader-259"><a href="#csv_reader-259"><span class="linenos">259</span></a> <span class="k">finally</span><span class="p">:</span> -</span><span id="csv_reader-260"><a href="#csv_reader-260"><span class="linenos">260</span></a> <span class="n">file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="csv_reader-257"><a href="#csv_reader-257"><span class="linenos">257</span></a><span class="nd">@contextmanager</span> +</span><span id="csv_reader-258"><a href="#csv_reader-258"><span class="linenos">258</span></a><span class="k">def</span> <span class="nf">csv_reader</span><span class="p">(</span><span class="n">read_csv</span><span class="p">:</span> <span class="n">exp</span><span class="o">.</span><span class="n">ReadCSV</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span> +</span><span id="csv_reader-259"><a href="#csv_reader-259"><span class="linenos">259</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="csv_reader-260"><a href="#csv_reader-260"><span class="linenos">260</span></a><span class="sd"> Returns a csv reader given the expression `READ_CSV(name, ['delimiter', '|', ...])`.</span> +</span><span id="csv_reader-261"><a href="#csv_reader-261"><span class="linenos">261</span></a> +</span><span id="csv_reader-262"><a href="#csv_reader-262"><span class="linenos">262</span></a><span class="sd"> Args:</span> +</span><span id="csv_reader-263"><a href="#csv_reader-263"><span class="linenos">263</span></a><span class="sd"> read_csv: a `ReadCSV` function call</span> +</span><span id="csv_reader-264"><a href="#csv_reader-264"><span class="linenos">264</span></a> +</span><span id="csv_reader-265"><a href="#csv_reader-265"><span class="linenos">265</span></a><span class="sd"> Yields:</span> +</span><span id="csv_reader-266"><a href="#csv_reader-266"><span class="linenos">266</span></a><span class="sd"> A python csv reader.</span> +</span><span id="csv_reader-267"><a href="#csv_reader-267"><span class="linenos">267</span></a><span class="sd"> """</span> +</span><span id="csv_reader-268"><a href="#csv_reader-268"><span class="linenos">268</span></a> <span class="n">args</span> <span class="o">=</span> <span class="n">read_csv</span><span class="o">.</span><span class="n">expressions</span> +</span><span id="csv_reader-269"><a href="#csv_reader-269"><span class="linenos">269</span></a> <span class="n">file</span> <span class="o">=</span> <span class="n">open_file</span><span class="p">(</span><span class="n">read_csv</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> +</span><span id="csv_reader-270"><a href="#csv_reader-270"><span class="linenos">270</span></a> +</span><span id="csv_reader-271"><a href="#csv_reader-271"><span class="linenos">271</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="s2">","</span> +</span><span id="csv_reader-272"><a href="#csv_reader-272"><span class="linenos">272</span></a> <span class="n">args</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">arg</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">)</span> +</span><span id="csv_reader-273"><a href="#csv_reader-273"><span class="linenos">273</span></a> <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="nb">zip</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span> +</span><span id="csv_reader-274"><a href="#csv_reader-274"><span class="linenos">274</span></a> <span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="s2">"delimiter"</span><span class="p">:</span> +</span><span id="csv_reader-275"><a href="#csv_reader-275"><span class="linenos">275</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="n">v</span> +</span><span id="csv_reader-276"><a href="#csv_reader-276"><span class="linenos">276</span></a> +</span><span id="csv_reader-277"><a href="#csv_reader-277"><span class="linenos">277</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="csv_reader-278"><a href="#csv_reader-278"><span class="linenos">278</span></a> <span class="kn">import</span> <span class="nn">csv</span> <span class="k">as</span> <span class="nn">csv_</span> +</span><span id="csv_reader-279"><a href="#csv_reader-279"><span class="linenos">279</span></a> +</span><span id="csv_reader-280"><a href="#csv_reader-280"><span class="linenos">280</span></a> <span class="k">yield</span> <span class="n">csv_</span><span class="o">.</span><span class="n">reader</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="n">delimiter</span><span class="o">=</span><span class="n">delimiter</span><span class="p">)</span> +</span><span id="csv_reader-281"><a href="#csv_reader-281"><span class="linenos">281</span></a> <span class="k">finally</span><span class="p">:</span> +</span><span id="csv_reader-282"><a href="#csv_reader-282"><span class="linenos">282</span></a> <span class="n">file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> </span></pre></div> @@ -1093,27 +1138,27 @@ </div> <a class="headerlink" href="#find_new_name"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="find_new_name-263"><a href="#find_new_name-263"><span class="linenos">263</span></a><span class="k">def</span> <span class="nf">find_new_name</span><span class="p">(</span><span class="n">taken</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Collection</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">base</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> -</span><span id="find_new_name-264"><a href="#find_new_name-264"><span class="linenos">264</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="find_new_name-265"><a href="#find_new_name-265"><span class="linenos">265</span></a><span class="sd"> Searches for a new name.</span> -</span><span id="find_new_name-266"><a href="#find_new_name-266"><span class="linenos">266</span></a> -</span><span id="find_new_name-267"><a href="#find_new_name-267"><span class="linenos">267</span></a><span class="sd"> Args:</span> -</span><span id="find_new_name-268"><a href="#find_new_name-268"><span class="linenos">268</span></a><span class="sd"> taken: a collection of taken names.</span> -</span><span id="find_new_name-269"><a href="#find_new_name-269"><span class="linenos">269</span></a><span class="sd"> base: base name to alter.</span> -</span><span id="find_new_name-270"><a href="#find_new_name-270"><span class="linenos">270</span></a> -</span><span id="find_new_name-271"><a href="#find_new_name-271"><span class="linenos">271</span></a><span class="sd"> Returns:</span> -</span><span id="find_new_name-272"><a href="#find_new_name-272"><span class="linenos">272</span></a><span class="sd"> The new, available name.</span> -</span><span id="find_new_name-273"><a href="#find_new_name-273"><span class="linenos">273</span></a><span class="sd"> """</span> -</span><span id="find_new_name-274"><a href="#find_new_name-274"><span class="linenos">274</span></a> <span class="k">if</span> <span class="n">base</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">taken</span><span class="p">:</span> -</span><span id="find_new_name-275"><a href="#find_new_name-275"><span class="linenos">275</span></a> <span class="k">return</span> <span class="n">base</span> -</span><span id="find_new_name-276"><a href="#find_new_name-276"><span class="linenos">276</span></a> -</span><span id="find_new_name-277"><a href="#find_new_name-277"><span class="linenos">277</span></a> <span class="n">i</span> <span class="o">=</span> <span class="mi">2</span> -</span><span id="find_new_name-278"><a href="#find_new_name-278"><span class="linenos">278</span></a> <span class="n">new</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">"</span> -</span><span id="find_new_name-279"><a href="#find_new_name-279"><span class="linenos">279</span></a> <span class="k">while</span> <span class="n">new</span> <span class="ow">in</span> <span class="n">taken</span><span class="p">:</span> -</span><span id="find_new_name-280"><a href="#find_new_name-280"><span class="linenos">280</span></a> <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> -</span><span id="find_new_name-281"><a href="#find_new_name-281"><span class="linenos">281</span></a> <span class="n">new</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">"</span> -</span><span id="find_new_name-282"><a href="#find_new_name-282"><span class="linenos">282</span></a> -</span><span id="find_new_name-283"><a href="#find_new_name-283"><span class="linenos">283</span></a> <span class="k">return</span> <span class="n">new</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="find_new_name-285"><a href="#find_new_name-285"><span class="linenos">285</span></a><span class="k">def</span> <span class="nf">find_new_name</span><span class="p">(</span><span class="n">taken</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Collection</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">base</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> +</span><span id="find_new_name-286"><a href="#find_new_name-286"><span class="linenos">286</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="find_new_name-287"><a href="#find_new_name-287"><span class="linenos">287</span></a><span class="sd"> Searches for a new name.</span> +</span><span id="find_new_name-288"><a href="#find_new_name-288"><span class="linenos">288</span></a> +</span><span id="find_new_name-289"><a href="#find_new_name-289"><span class="linenos">289</span></a><span class="sd"> Args:</span> +</span><span id="find_new_name-290"><a href="#find_new_name-290"><span class="linenos">290</span></a><span class="sd"> taken: a collection of taken names.</span> +</span><span id="find_new_name-291"><a href="#find_new_name-291"><span class="linenos">291</span></a><span class="sd"> base: base name to alter.</span> +</span><span id="find_new_name-292"><a href="#find_new_name-292"><span class="linenos">292</span></a> +</span><span id="find_new_name-293"><a href="#find_new_name-293"><span class="linenos">293</span></a><span class="sd"> Returns:</span> +</span><span id="find_new_name-294"><a href="#find_new_name-294"><span class="linenos">294</span></a><span class="sd"> The new, available name.</span> +</span><span id="find_new_name-295"><a href="#find_new_name-295"><span class="linenos">295</span></a><span class="sd"> """</span> +</span><span id="find_new_name-296"><a href="#find_new_name-296"><span class="linenos">296</span></a> <span class="k">if</span> <span class="n">base</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">taken</span><span class="p">:</span> +</span><span id="find_new_name-297"><a href="#find_new_name-297"><span class="linenos">297</span></a> <span class="k">return</span> <span class="n">base</span> +</span><span id="find_new_name-298"><a href="#find_new_name-298"><span class="linenos">298</span></a> +</span><span id="find_new_name-299"><a href="#find_new_name-299"><span class="linenos">299</span></a> <span class="n">i</span> <span class="o">=</span> <span class="mi">2</span> +</span><span id="find_new_name-300"><a href="#find_new_name-300"><span class="linenos">300</span></a> <span class="n">new</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">"</span> +</span><span id="find_new_name-301"><a href="#find_new_name-301"><span class="linenos">301</span></a> <span class="k">while</span> <span class="n">new</span> <span class="ow">in</span> <span class="n">taken</span><span class="p">:</span> +</span><span id="find_new_name-302"><a href="#find_new_name-302"><span class="linenos">302</span></a> <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> +</span><span id="find_new_name-303"><a href="#find_new_name-303"><span class="linenos">303</span></a> <span class="n">new</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">"</span> +</span><span id="find_new_name-304"><a href="#find_new_name-304"><span class="linenos">304</span></a> +</span><span id="find_new_name-305"><a href="#find_new_name-305"><span class="linenos">305</span></a> <span class="k">return</span> <span class="n">new</span> </span></pre></div> @@ -1146,9 +1191,9 @@ </div> <a class="headerlink" href="#object_to_dict"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="object_to_dict-286"><a href="#object_to_dict-286"><span class="linenos">286</span></a><span class="k">def</span> <span class="nf">object_to_dict</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">:</span> -</span><span id="object_to_dict-287"><a href="#object_to_dict-287"><span class="linenos">287</span></a><span class="w"> </span><span class="sd">"""Returns a dictionary created from an object's attributes."""</span> -</span><span id="object_to_dict-288"><a href="#object_to_dict-288"><span class="linenos">288</span></a> <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">copy</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="nb">vars</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">()},</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">}</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="object_to_dict-308"><a href="#object_to_dict-308"><span class="linenos">308</span></a><span class="k">def</span> <span class="nf">object_to_dict</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">:</span> +</span><span id="object_to_dict-309"><a href="#object_to_dict-309"><span class="linenos">309</span></a><span class="w"> </span><span class="sd">"""Returns a dictionary created from an object's attributes."""</span> +</span><span id="object_to_dict-310"><a href="#object_to_dict-310"><span class="linenos">310</span></a> <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">copy</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="nb">vars</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">()},</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">}</span> </span></pre></div> @@ -1168,33 +1213,33 @@ </div> <a class="headerlink" href="#split_num_words"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="split_num_words-291"><a href="#split_num_words-291"><span class="linenos">291</span></a><span class="k">def</span> <span class="nf">split_num_words</span><span class="p">(</span> -</span><span id="split_num_words-292"><a href="#split_num_words-292"><span class="linenos">292</span></a> <span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">sep</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">min_num_words</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">fill_from_start</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span> -</span><span id="split_num_words-293"><a href="#split_num_words-293"><span class="linenos">293</span></a><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]]:</span> -</span><span id="split_num_words-294"><a href="#split_num_words-294"><span class="linenos">294</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="split_num_words-295"><a href="#split_num_words-295"><span class="linenos">295</span></a><span class="sd"> Perform a split on a value and return N words as a result with `None` used for words that don't exist.</span> -</span><span id="split_num_words-296"><a href="#split_num_words-296"><span class="linenos">296</span></a> -</span><span id="split_num_words-297"><a href="#split_num_words-297"><span class="linenos">297</span></a><span class="sd"> Args:</span> -</span><span id="split_num_words-298"><a href="#split_num_words-298"><span class="linenos">298</span></a><span class="sd"> value: the value to be split.</span> -</span><span id="split_num_words-299"><a href="#split_num_words-299"><span class="linenos">299</span></a><span class="sd"> sep: the value to use to split on.</span> -</span><span id="split_num_words-300"><a href="#split_num_words-300"><span class="linenos">300</span></a><span class="sd"> min_num_words: the minimum number of words that are going to be in the result.</span> -</span><span id="split_num_words-301"><a href="#split_num_words-301"><span class="linenos">301</span></a><span class="sd"> fill_from_start: indicates that if `None` values should be inserted at the start or end of the list.</span> -</span><span id="split_num_words-302"><a href="#split_num_words-302"><span class="linenos">302</span></a> -</span><span id="split_num_words-303"><a href="#split_num_words-303"><span class="linenos">303</span></a><span class="sd"> Examples:</span> -</span><span id="split_num_words-304"><a href="#split_num_words-304"><span class="linenos">304</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3)</span> -</span><span id="split_num_words-305"><a href="#split_num_words-305"><span class="linenos">305</span></a><span class="sd"> [None, 'db', 'table']</span> -</span><span id="split_num_words-306"><a href="#split_num_words-306"><span class="linenos">306</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3, fill_from_start=False)</span> -</span><span id="split_num_words-307"><a href="#split_num_words-307"><span class="linenos">307</span></a><span class="sd"> ['db', 'table', None]</span> -</span><span id="split_num_words-308"><a href="#split_num_words-308"><span class="linenos">308</span></a><span class="sd"> >>> split_num_words("db.table", ".", 1)</span> -</span><span id="split_num_words-309"><a href="#split_num_words-309"><span class="linenos">309</span></a><span class="sd"> ['db', 'table']</span> -</span><span id="split_num_words-310"><a href="#split_num_words-310"><span class="linenos">310</span></a> -</span><span id="split_num_words-311"><a href="#split_num_words-311"><span class="linenos">311</span></a><span class="sd"> Returns:</span> -</span><span id="split_num_words-312"><a href="#split_num_words-312"><span class="linenos">312</span></a><span class="sd"> The list of words returned by `split`, possibly augmented by a number of `None` values.</span> -</span><span id="split_num_words-313"><a href="#split_num_words-313"><span class="linenos">313</span></a><span class="sd"> """</span> -</span><span id="split_num_words-314"><a href="#split_num_words-314"><span class="linenos">314</span></a> <span class="n">words</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">sep</span><span class="p">)</span> -</span><span id="split_num_words-315"><a href="#split_num_words-315"><span class="linenos">315</span></a> <span class="k">if</span> <span class="n">fill_from_start</span><span class="p">:</span> -</span><span id="split_num_words-316"><a href="#split_num_words-316"><span class="linenos">316</span></a> <span class="k">return</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="n">min_num_words</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">))</span> <span class="o">+</span> <span class="n">words</span> -</span><span id="split_num_words-317"><a href="#split_num_words-317"><span class="linenos">317</span></a> <span class="k">return</span> <span class="n">words</span> <span class="o">+</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="n">min_num_words</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">))</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="split_num_words-313"><a href="#split_num_words-313"><span class="linenos">313</span></a><span class="k">def</span> <span class="nf">split_num_words</span><span class="p">(</span> +</span><span id="split_num_words-314"><a href="#split_num_words-314"><span class="linenos">314</span></a> <span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">sep</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">min_num_words</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">fill_from_start</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span> +</span><span id="split_num_words-315"><a href="#split_num_words-315"><span class="linenos">315</span></a><span class="p">)</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]]:</span> +</span><span id="split_num_words-316"><a href="#split_num_words-316"><span class="linenos">316</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="split_num_words-317"><a href="#split_num_words-317"><span class="linenos">317</span></a><span class="sd"> Perform a split on a value and return N words as a result with `None` used for words that don't exist.</span> +</span><span id="split_num_words-318"><a href="#split_num_words-318"><span class="linenos">318</span></a> +</span><span id="split_num_words-319"><a href="#split_num_words-319"><span class="linenos">319</span></a><span class="sd"> Args:</span> +</span><span id="split_num_words-320"><a href="#split_num_words-320"><span class="linenos">320</span></a><span class="sd"> value: the value to be split.</span> +</span><span id="split_num_words-321"><a href="#split_num_words-321"><span class="linenos">321</span></a><span class="sd"> sep: the value to use to split on.</span> +</span><span id="split_num_words-322"><a href="#split_num_words-322"><span class="linenos">322</span></a><span class="sd"> min_num_words: the minimum number of words that are going to be in the result.</span> +</span><span id="split_num_words-323"><a href="#split_num_words-323"><span class="linenos">323</span></a><span class="sd"> fill_from_start: indicates that if `None` values should be inserted at the start or end of the list.</span> +</span><span id="split_num_words-324"><a href="#split_num_words-324"><span class="linenos">324</span></a> +</span><span id="split_num_words-325"><a href="#split_num_words-325"><span class="linenos">325</span></a><span class="sd"> Examples:</span> +</span><span id="split_num_words-326"><a href="#split_num_words-326"><span class="linenos">326</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3)</span> +</span><span id="split_num_words-327"><a href="#split_num_words-327"><span class="linenos">327</span></a><span class="sd"> [None, 'db', 'table']</span> +</span><span id="split_num_words-328"><a href="#split_num_words-328"><span class="linenos">328</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3, fill_from_start=False)</span> +</span><span id="split_num_words-329"><a href="#split_num_words-329"><span class="linenos">329</span></a><span class="sd"> ['db', 'table', None]</span> +</span><span id="split_num_words-330"><a href="#split_num_words-330"><span class="linenos">330</span></a><span class="sd"> >>> split_num_words("db.table", ".", 1)</span> +</span><span id="split_num_words-331"><a href="#split_num_words-331"><span class="linenos">331</span></a><span class="sd"> ['db', 'table']</span> +</span><span id="split_num_words-332"><a href="#split_num_words-332"><span class="linenos">332</span></a> +</span><span id="split_num_words-333"><a href="#split_num_words-333"><span class="linenos">333</span></a><span class="sd"> Returns:</span> +</span><span id="split_num_words-334"><a href="#split_num_words-334"><span class="linenos">334</span></a><span class="sd"> The list of words returned by `split`, possibly augmented by a number of `None` values.</span> +</span><span id="split_num_words-335"><a href="#split_num_words-335"><span class="linenos">335</span></a><span class="sd"> """</span> +</span><span id="split_num_words-336"><a href="#split_num_words-336"><span class="linenos">336</span></a> <span class="n">words</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">sep</span><span class="p">)</span> +</span><span id="split_num_words-337"><a href="#split_num_words-337"><span class="linenos">337</span></a> <span class="k">if</span> <span class="n">fill_from_start</span><span class="p">:</span> +</span><span id="split_num_words-338"><a href="#split_num_words-338"><span class="linenos">338</span></a> <span class="k">return</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="n">min_num_words</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">))</span> <span class="o">+</span> <span class="n">words</span> +</span><span id="split_num_words-339"><a href="#split_num_words-339"><span class="linenos">339</span></a> <span class="k">return</span> <span class="n">words</span> <span class="o">+</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="n">min_num_words</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">))</span> </span></pre></div> @@ -1243,23 +1288,23 @@ </div> <a class="headerlink" href="#is_iterable"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="is_iterable-320"><a href="#is_iterable-320"><span class="linenos">320</span></a><span class="k">def</span> <span class="nf">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> -</span><span id="is_iterable-321"><a href="#is_iterable-321"><span class="linenos">321</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="is_iterable-322"><a href="#is_iterable-322"><span class="linenos">322</span></a><span class="sd"> Checks if the value is an iterable, excluding the types `str` and `bytes`.</span> -</span><span id="is_iterable-323"><a href="#is_iterable-323"><span class="linenos">323</span></a> -</span><span id="is_iterable-324"><a href="#is_iterable-324"><span class="linenos">324</span></a><span class="sd"> Examples:</span> -</span><span id="is_iterable-325"><a href="#is_iterable-325"><span class="linenos">325</span></a><span class="sd"> >>> is_iterable([1,2])</span> -</span><span id="is_iterable-326"><a href="#is_iterable-326"><span class="linenos">326</span></a><span class="sd"> True</span> -</span><span id="is_iterable-327"><a href="#is_iterable-327"><span class="linenos">327</span></a><span class="sd"> >>> is_iterable("test")</span> -</span><span id="is_iterable-328"><a href="#is_iterable-328"><span class="linenos">328</span></a><span class="sd"> False</span> -</span><span id="is_iterable-329"><a href="#is_iterable-329"><span class="linenos">329</span></a> -</span><span id="is_iterable-330"><a href="#is_iterable-330"><span class="linenos">330</span></a><span class="sd"> Args:</span> -</span><span id="is_iterable-331"><a href="#is_iterable-331"><span class="linenos">331</span></a><span class="sd"> value: the value to check if it is an iterable.</span> -</span><span id="is_iterable-332"><a href="#is_iterable-332"><span class="linenos">332</span></a> -</span><span id="is_iterable-333"><a href="#is_iterable-333"><span class="linenos">333</span></a><span class="sd"> Returns:</span> -</span><span id="is_iterable-334"><a href="#is_iterable-334"><span class="linenos">334</span></a><span class="sd"> A `bool` value indicating if it is an iterable.</span> -</span><span id="is_iterable-335"><a href="#is_iterable-335"><span class="linenos">335</span></a><span class="sd"> """</span> -</span><span id="is_iterable-336"><a href="#is_iterable-336"><span class="linenos">336</span></a> <span class="k">return</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s2">"__iter__"</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">))</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="is_iterable-342"><a href="#is_iterable-342"><span class="linenos">342</span></a><span class="k">def</span> <span class="nf">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> +</span><span id="is_iterable-343"><a href="#is_iterable-343"><span class="linenos">343</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="is_iterable-344"><a href="#is_iterable-344"><span class="linenos">344</span></a><span class="sd"> Checks if the value is an iterable, excluding the types `str` and `bytes`.</span> +</span><span id="is_iterable-345"><a href="#is_iterable-345"><span class="linenos">345</span></a> +</span><span id="is_iterable-346"><a href="#is_iterable-346"><span class="linenos">346</span></a><span class="sd"> Examples:</span> +</span><span id="is_iterable-347"><a href="#is_iterable-347"><span class="linenos">347</span></a><span class="sd"> >>> is_iterable([1,2])</span> +</span><span id="is_iterable-348"><a href="#is_iterable-348"><span class="linenos">348</span></a><span class="sd"> True</span> +</span><span id="is_iterable-349"><a href="#is_iterable-349"><span class="linenos">349</span></a><span class="sd"> >>> is_iterable("test")</span> +</span><span id="is_iterable-350"><a href="#is_iterable-350"><span class="linenos">350</span></a><span class="sd"> False</span> +</span><span id="is_iterable-351"><a href="#is_iterable-351"><span class="linenos">351</span></a> +</span><span id="is_iterable-352"><a href="#is_iterable-352"><span class="linenos">352</span></a><span class="sd"> Args:</span> +</span><span id="is_iterable-353"><a href="#is_iterable-353"><span class="linenos">353</span></a><span class="sd"> value: the value to check if it is an iterable.</span> +</span><span id="is_iterable-354"><a href="#is_iterable-354"><span class="linenos">354</span></a> +</span><span id="is_iterable-355"><a href="#is_iterable-355"><span class="linenos">355</span></a><span class="sd"> Returns:</span> +</span><span id="is_iterable-356"><a href="#is_iterable-356"><span class="linenos">356</span></a><span class="sd"> A `bool` value indicating if it is an iterable.</span> +</span><span id="is_iterable-357"><a href="#is_iterable-357"><span class="linenos">357</span></a><span class="sd"> """</span> +</span><span id="is_iterable-358"><a href="#is_iterable-358"><span class="linenos">358</span></a> <span class="k">return</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s2">"__iter__"</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">))</span> </span></pre></div> @@ -1303,28 +1348,28 @@ </div> <a class="headerlink" href="#flatten"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="flatten-339"><a href="#flatten-339"><span class="linenos">339</span></a><span class="k">def</span> <span class="nf">flatten</span><span class="p">(</span><span class="n">values</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Iterator</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]:</span> -</span><span id="flatten-340"><a href="#flatten-340"><span class="linenos">340</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="flatten-341"><a href="#flatten-341"><span class="linenos">341</span></a><span class="sd"> Flattens an iterable that can contain both iterable and non-iterable elements. Objects of</span> -</span><span id="flatten-342"><a href="#flatten-342"><span class="linenos">342</span></a><span class="sd"> type `str` and `bytes` are not regarded as iterables.</span> -</span><span id="flatten-343"><a href="#flatten-343"><span class="linenos">343</span></a> -</span><span id="flatten-344"><a href="#flatten-344"><span class="linenos">344</span></a><span class="sd"> Examples:</span> -</span><span id="flatten-345"><a href="#flatten-345"><span class="linenos">345</span></a><span class="sd"> >>> list(flatten([[1, 2], 3, {4}, (5, "bla")]))</span> -</span><span id="flatten-346"><a href="#flatten-346"><span class="linenos">346</span></a><span class="sd"> [1, 2, 3, 4, 5, 'bla']</span> -</span><span id="flatten-347"><a href="#flatten-347"><span class="linenos">347</span></a><span class="sd"> >>> list(flatten([1, 2, 3]))</span> -</span><span id="flatten-348"><a href="#flatten-348"><span class="linenos">348</span></a><span class="sd"> [1, 2, 3]</span> -</span><span id="flatten-349"><a href="#flatten-349"><span class="linenos">349</span></a> -</span><span id="flatten-350"><a href="#flatten-350"><span class="linenos">350</span></a><span class="sd"> Args:</span> -</span><span id="flatten-351"><a href="#flatten-351"><span class="linenos">351</span></a><span class="sd"> values: the value to be flattened.</span> -</span><span id="flatten-352"><a href="#flatten-352"><span class="linenos">352</span></a> -</span><span id="flatten-353"><a href="#flatten-353"><span class="linenos">353</span></a><span class="sd"> Yields:</span> -</span><span id="flatten-354"><a href="#flatten-354"><span class="linenos">354</span></a><span class="sd"> Non-iterable elements in `values`.</span> -</span><span id="flatten-355"><a href="#flatten-355"><span class="linenos">355</span></a><span class="sd"> """</span> -</span><span id="flatten-356"><a href="#flatten-356"><span class="linenos">356</span></a> <span class="k">for</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">values</span><span class="p">:</span> -</span><span id="flatten-357"><a href="#flatten-357"><span class="linenos">357</span></a> <span class="k">if</span> <span class="n">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> -</span><span id="flatten-358"><a href="#flatten-358"><span class="linenos">358</span></a> <span class="k">yield from</span> <span class="n">flatten</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> -</span><span id="flatten-359"><a href="#flatten-359"><span class="linenos">359</span></a> <span class="k">else</span><span class="p">:</span> -</span><span id="flatten-360"><a href="#flatten-360"><span class="linenos">360</span></a> <span class="k">yield</span> <span class="n">value</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="flatten-361"><a href="#flatten-361"><span class="linenos">361</span></a><span class="k">def</span> <span class="nf">flatten</span><span class="p">(</span><span class="n">values</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="n">t</span><span class="o">.</span><span class="n">Iterator</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]:</span> +</span><span id="flatten-362"><a href="#flatten-362"><span class="linenos">362</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="flatten-363"><a href="#flatten-363"><span class="linenos">363</span></a><span class="sd"> Flattens an iterable that can contain both iterable and non-iterable elements. Objects of</span> +</span><span id="flatten-364"><a href="#flatten-364"><span class="linenos">364</span></a><span class="sd"> type `str` and `bytes` are not regarded as iterables.</span> +</span><span id="flatten-365"><a href="#flatten-365"><span class="linenos">365</span></a> +</span><span id="flatten-366"><a href="#flatten-366"><span class="linenos">366</span></a><span class="sd"> Examples:</span> +</span><span id="flatten-367"><a href="#flatten-367"><span class="linenos">367</span></a><span class="sd"> >>> list(flatten([[1, 2], 3, {4}, (5, "bla")]))</span> +</span><span id="flatten-368"><a href="#flatten-368"><span class="linenos">368</span></a><span class="sd"> [1, 2, 3, 4, 5, 'bla']</span> +</span><span id="flatten-369"><a href="#flatten-369"><span class="linenos">369</span></a><span class="sd"> >>> list(flatten([1, 2, 3]))</span> +</span><span id="flatten-370"><a href="#flatten-370"><span class="linenos">370</span></a><span class="sd"> [1, 2, 3]</span> +</span><span id="flatten-371"><a href="#flatten-371"><span class="linenos">371</span></a> +</span><span id="flatten-372"><a href="#flatten-372"><span class="linenos">372</span></a><span class="sd"> Args:</span> +</span><span id="flatten-373"><a href="#flatten-373"><span class="linenos">373</span></a><span class="sd"> values: the value to be flattened.</span> +</span><span id="flatten-374"><a href="#flatten-374"><span class="linenos">374</span></a> +</span><span id="flatten-375"><a href="#flatten-375"><span class="linenos">375</span></a><span class="sd"> Yields:</span> +</span><span id="flatten-376"><a href="#flatten-376"><span class="linenos">376</span></a><span class="sd"> Non-iterable elements in `values`.</span> +</span><span id="flatten-377"><a href="#flatten-377"><span class="linenos">377</span></a><span class="sd"> """</span> +</span><span id="flatten-378"><a href="#flatten-378"><span class="linenos">378</span></a> <span class="k">for</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">values</span><span class="p">:</span> +</span><span id="flatten-379"><a href="#flatten-379"><span class="linenos">379</span></a> <span class="k">if</span> <span class="n">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> +</span><span id="flatten-380"><a href="#flatten-380"><span class="linenos">380</span></a> <span class="k">yield from</span> <span class="n">flatten</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> +</span><span id="flatten-381"><a href="#flatten-381"><span class="linenos">381</span></a> <span class="k">else</span><span class="p">:</span> +</span><span id="flatten-382"><a href="#flatten-382"><span class="linenos">382</span></a> <span class="k">yield</span> <span class="n">value</span> </span></pre></div> @@ -1369,13 +1414,13 @@ type <code>str</code> and <code>bytes</code> are not regarded as iterables.</p> </div> <a class="headerlink" href="#count_params"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="count_params-363"><a href="#count_params-363"><span class="linenos">363</span></a><span class="k">def</span> <span class="nf">count_params</span><span class="p">(</span><span class="n">function</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> -</span><span id="count_params-364"><a href="#count_params-364"><span class="linenos">364</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="count_params-365"><a href="#count_params-365"><span class="linenos">365</span></a><span class="sd"> Returns the number of formal parameters expected by a function, without counting "self"</span> -</span><span id="count_params-366"><a href="#count_params-366"><span class="linenos">366</span></a><span class="sd"> and "cls", in case of instance and class methods, respectively.</span> -</span><span id="count_params-367"><a href="#count_params-367"><span class="linenos">367</span></a><span class="sd"> """</span> -</span><span id="count_params-368"><a href="#count_params-368"><span class="linenos">368</span></a> <span class="n">count</span> <span class="o">=</span> <span class="n">function</span><span class="o">.</span><span class="vm">__code__</span><span class="o">.</span><span class="n">co_argcount</span> -</span><span id="count_params-369"><a href="#count_params-369"><span class="linenos">369</span></a> <span class="k">return</span> <span class="n">count</span> <span class="o">-</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">inspect</span><span class="o">.</span><span class="n">ismethod</span><span class="p">(</span><span class="n">function</span><span class="p">)</span> <span class="k">else</span> <span class="n">count</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="count_params-385"><a href="#count_params-385"><span class="linenos">385</span></a><span class="k">def</span> <span class="nf">count_params</span><span class="p">(</span><span class="n">function</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> +</span><span id="count_params-386"><a href="#count_params-386"><span class="linenos">386</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="count_params-387"><a href="#count_params-387"><span class="linenos">387</span></a><span class="sd"> Returns the number of formal parameters expected by a function, without counting "self"</span> +</span><span id="count_params-388"><a href="#count_params-388"><span class="linenos">388</span></a><span class="sd"> and "cls", in case of instance and class methods, respectively.</span> +</span><span id="count_params-389"><a href="#count_params-389"><span class="linenos">389</span></a><span class="sd"> """</span> +</span><span id="count_params-390"><a href="#count_params-390"><span class="linenos">390</span></a> <span class="n">count</span> <span class="o">=</span> <span class="n">function</span><span class="o">.</span><span class="vm">__code__</span><span class="o">.</span><span class="n">co_argcount</span> +</span><span id="count_params-391"><a href="#count_params-391"><span class="linenos">391</span></a> <span class="k">return</span> <span class="n">count</span> <span class="o">-</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">inspect</span><span class="o">.</span><span class="n">ismethod</span><span class="p">(</span><span class="n">function</span><span class="p">)</span> <span class="k">else</span> <span class="n">count</span> </span></pre></div> @@ -1396,36 +1441,36 @@ and "cls", in case of instance and class methods, respectively.</p> </div> <a class="headerlink" href="#dict_depth"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="dict_depth-372"><a href="#dict_depth-372"><span class="linenos">372</span></a><span class="k">def</span> <span class="nf">dict_depth</span><span class="p">(</span><span class="n">d</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> -</span><span id="dict_depth-373"><a href="#dict_depth-373"><span class="linenos">373</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="dict_depth-374"><a href="#dict_depth-374"><span class="linenos">374</span></a><span class="sd"> Get the nesting depth of a dictionary.</span> -</span><span id="dict_depth-375"><a href="#dict_depth-375"><span class="linenos">375</span></a> -</span><span id="dict_depth-376"><a href="#dict_depth-376"><span class="linenos">376</span></a><span class="sd"> For example:</span> -</span><span id="dict_depth-377"><a href="#dict_depth-377"><span class="linenos">377</span></a><span class="sd"> >>> dict_depth(None)</span> -</span><span id="dict_depth-378"><a href="#dict_depth-378"><span class="linenos">378</span></a><span class="sd"> 0</span> -</span><span id="dict_depth-379"><a href="#dict_depth-379"><span class="linenos">379</span></a><span class="sd"> >>> dict_depth({})</span> -</span><span id="dict_depth-380"><a href="#dict_depth-380"><span class="linenos">380</span></a><span class="sd"> 1</span> -</span><span id="dict_depth-381"><a href="#dict_depth-381"><span class="linenos">381</span></a><span class="sd"> >>> dict_depth({"a": "b"})</span> -</span><span id="dict_depth-382"><a href="#dict_depth-382"><span class="linenos">382</span></a><span class="sd"> 1</span> -</span><span id="dict_depth-383"><a href="#dict_depth-383"><span class="linenos">383</span></a><span class="sd"> >>> dict_depth({"a": {}})</span> -</span><span id="dict_depth-384"><a href="#dict_depth-384"><span class="linenos">384</span></a><span class="sd"> 2</span> -</span><span id="dict_depth-385"><a href="#dict_depth-385"><span class="linenos">385</span></a><span class="sd"> >>> dict_depth({"a": {"b": {}}})</span> -</span><span id="dict_depth-386"><a href="#dict_depth-386"><span class="linenos">386</span></a><span class="sd"> 3</span> -</span><span id="dict_depth-387"><a href="#dict_depth-387"><span class="linenos">387</span></a> -</span><span id="dict_depth-388"><a href="#dict_depth-388"><span class="linenos">388</span></a><span class="sd"> Args:</span> -</span><span id="dict_depth-389"><a href="#dict_depth-389"><span class="linenos">389</span></a><span class="sd"> d (dict): dictionary</span> -</span><span id="dict_depth-390"><a href="#dict_depth-390"><span class="linenos">390</span></a> -</span><span id="dict_depth-391"><a href="#dict_depth-391"><span class="linenos">391</span></a><span class="sd"> Returns:</span> -</span><span id="dict_depth-392"><a href="#dict_depth-392"><span class="linenos">392</span></a><span class="sd"> int: depth</span> -</span><span id="dict_depth-393"><a href="#dict_depth-393"><span class="linenos">393</span></a><span class="sd"> """</span> -</span><span id="dict_depth-394"><a href="#dict_depth-394"><span class="linenos">394</span></a> <span class="k">try</span><span class="p">:</span> -</span><span id="dict_depth-395"><a href="#dict_depth-395"><span class="linenos">395</span></a> <span class="k">return</span> <span class="mi">1</span> <span class="o">+</span> <span class="n">dict_depth</span><span class="p">(</span><span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">values</span><span class="p">())))</span> -</span><span id="dict_depth-396"><a href="#dict_depth-396"><span class="linenos">396</span></a> <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> -</span><span id="dict_depth-397"><a href="#dict_depth-397"><span class="linenos">397</span></a> <span class="c1"># d doesn't have attribute "values"</span> -</span><span id="dict_depth-398"><a href="#dict_depth-398"><span class="linenos">398</span></a> <span class="k">return</span> <span class="mi">0</span> -</span><span id="dict_depth-399"><a href="#dict_depth-399"><span class="linenos">399</span></a> <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span> -</span><span id="dict_depth-400"><a href="#dict_depth-400"><span class="linenos">400</span></a> <span class="c1"># d.values() returns an empty sequence</span> -</span><span id="dict_depth-401"><a href="#dict_depth-401"><span class="linenos">401</span></a> <span class="k">return</span> <span class="mi">1</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="dict_depth-394"><a href="#dict_depth-394"><span class="linenos">394</span></a><span class="k">def</span> <span class="nf">dict_depth</span><span class="p">(</span><span class="n">d</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> +</span><span id="dict_depth-395"><a href="#dict_depth-395"><span class="linenos">395</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="dict_depth-396"><a href="#dict_depth-396"><span class="linenos">396</span></a><span class="sd"> Get the nesting depth of a dictionary.</span> +</span><span id="dict_depth-397"><a href="#dict_depth-397"><span class="linenos">397</span></a> +</span><span id="dict_depth-398"><a href="#dict_depth-398"><span class="linenos">398</span></a><span class="sd"> For example:</span> +</span><span id="dict_depth-399"><a href="#dict_depth-399"><span class="linenos">399</span></a><span class="sd"> >>> dict_depth(None)</span> +</span><span id="dict_depth-400"><a href="#dict_depth-400"><span class="linenos">400</span></a><span class="sd"> 0</span> +</span><span id="dict_depth-401"><a href="#dict_depth-401"><span class="linenos">401</span></a><span class="sd"> >>> dict_depth({})</span> +</span><span id="dict_depth-402"><a href="#dict_depth-402"><span class="linenos">402</span></a><span class="sd"> 1</span> +</span><span id="dict_depth-403"><a href="#dict_depth-403"><span class="linenos">403</span></a><span class="sd"> >>> dict_depth({"a": "b"})</span> +</span><span id="dict_depth-404"><a href="#dict_depth-404"><span class="linenos">404</span></a><span class="sd"> 1</span> +</span><span id="dict_depth-405"><a href="#dict_depth-405"><span class="linenos">405</span></a><span class="sd"> >>> dict_depth({"a": {}})</span> +</span><span id="dict_depth-406"><a href="#dict_depth-406"><span class="linenos">406</span></a><span class="sd"> 2</span> +</span><span id="dict_depth-407"><a href="#dict_depth-407"><span class="linenos">407</span></a><span class="sd"> >>> dict_depth({"a": {"b": {}}})</span> +</span><span id="dict_depth-408"><a href="#dict_depth-408"><span class="linenos">408</span></a><span class="sd"> 3</span> +</span><span id="dict_depth-409"><a href="#dict_depth-409"><span class="linenos">409</span></a> +</span><span id="dict_depth-410"><a href="#dict_depth-410"><span class="linenos">410</span></a><span class="sd"> Args:</span> +</span><span id="dict_depth-411"><a href="#dict_depth-411"><span class="linenos">411</span></a><span class="sd"> d (dict): dictionary</span> +</span><span id="dict_depth-412"><a href="#dict_depth-412"><span class="linenos">412</span></a> +</span><span id="dict_depth-413"><a href="#dict_depth-413"><span class="linenos">413</span></a><span class="sd"> Returns:</span> +</span><span id="dict_depth-414"><a href="#dict_depth-414"><span class="linenos">414</span></a><span class="sd"> int: depth</span> +</span><span id="dict_depth-415"><a href="#dict_depth-415"><span class="linenos">415</span></a><span class="sd"> """</span> +</span><span id="dict_depth-416"><a href="#dict_depth-416"><span class="linenos">416</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="dict_depth-417"><a href="#dict_depth-417"><span class="linenos">417</span></a> <span class="k">return</span> <span class="mi">1</span> <span class="o">+</span> <span class="n">dict_depth</span><span class="p">(</span><span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">values</span><span class="p">())))</span> +</span><span id="dict_depth-418"><a href="#dict_depth-418"><span class="linenos">418</span></a> <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> +</span><span id="dict_depth-419"><a href="#dict_depth-419"><span class="linenos">419</span></a> <span class="c1"># d doesn't have attribute "values"</span> +</span><span id="dict_depth-420"><a href="#dict_depth-420"><span class="linenos">420</span></a> <span class="k">return</span> <span class="mi">0</span> +</span><span id="dict_depth-421"><a href="#dict_depth-421"><span class="linenos">421</span></a> <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span> +</span><span id="dict_depth-422"><a href="#dict_depth-422"><span class="linenos">422</span></a> <span class="c1"># d.values() returns an empty sequence</span> +</span><span id="dict_depth-423"><a href="#dict_depth-423"><span class="linenos">423</span></a> <span class="k">return</span> <span class="mi">1</span> </span></pre></div> @@ -1475,12 +1520,12 @@ and "cls", in case of instance and class methods, respectively.</p> </div> <a class="headerlink" href="#first"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="first-404"><a href="#first-404"><span class="linenos">404</span></a><span class="k">def</span> <span class="nf">first</span><span class="p">(</span><span class="n">it</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span> -</span><span id="first-405"><a href="#first-405"><span class="linenos">405</span></a><span class="w"> </span><span class="sd">"""Returns the first element from an iterable.</span> -</span><span id="first-406"><a href="#first-406"><span class="linenos">406</span></a> -</span><span id="first-407"><a href="#first-407"><span class="linenos">407</span></a><span class="sd"> Useful for sets.</span> -</span><span id="first-408"><a href="#first-408"><span class="linenos">408</span></a><span class="sd"> """</span> -</span><span id="first-409"><a href="#first-409"><span class="linenos">409</span></a> <span class="k">return</span> <span class="nb">next</span><span class="p">(</span><span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">it</span><span class="p">)</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="first-426"><a href="#first-426"><span class="linenos">426</span></a><span class="k">def</span> <span class="nf">first</span><span class="p">(</span><span class="n">it</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span> +</span><span id="first-427"><a href="#first-427"><span class="linenos">427</span></a><span class="w"> </span><span class="sd">"""Returns the first element from an iterable.</span> +</span><span id="first-428"><a href="#first-428"><span class="linenos">428</span></a> +</span><span id="first-429"><a href="#first-429"><span class="linenos">429</span></a><span class="sd"> Useful for sets.</span> +</span><span id="first-430"><a href="#first-430"><span class="linenos">430</span></a><span class="sd"> """</span> +</span><span id="first-431"><a href="#first-431"><span class="linenos">431</span></a> <span class="k">return</span> <span class="nb">next</span><span class="p">(</span><span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">it</span><span class="p">)</span> </span></pre></div> @@ -1502,21 +1547,21 @@ and "cls", in case of instance and class methods, respectively.</p> </div> <a class="headerlink" href="#should_identify"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="should_identify-412"><a href="#should_identify-412"><span class="linenos">412</span></a><span class="k">def</span> <span class="nf">should_identify</span><span class="p">(</span><span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">identify</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> -</span><span id="should_identify-413"><a href="#should_identify-413"><span class="linenos">413</span></a><span class="w"> </span><span class="sd">"""Checks if text should be identified given an identify option.</span> -</span><span id="should_identify-414"><a href="#should_identify-414"><span class="linenos">414</span></a> -</span><span id="should_identify-415"><a href="#should_identify-415"><span class="linenos">415</span></a><span class="sd"> Args:</span> -</span><span id="should_identify-416"><a href="#should_identify-416"><span class="linenos">416</span></a><span class="sd"> text: the text to check.</span> -</span><span id="should_identify-417"><a href="#should_identify-417"><span class="linenos">417</span></a><span class="sd"> identify: "always" | True - always returns true, "safe" - true if no upper case</span> -</span><span id="should_identify-418"><a href="#should_identify-418"><span class="linenos">418</span></a> -</span><span id="should_identify-419"><a href="#should_identify-419"><span class="linenos">419</span></a><span class="sd"> Returns:</span> -</span><span id="should_identify-420"><a href="#should_identify-420"><span class="linenos">420</span></a><span class="sd"> Whether or not a string should be identified.</span> -</span><span id="should_identify-421"><a href="#should_identify-421"><span class="linenos">421</span></a><span class="sd"> """</span> -</span><span id="should_identify-422"><a href="#should_identify-422"><span class="linenos">422</span></a> <span class="k">if</span> <span class="n">identify</span> <span class="ow">is</span> <span class="kc">True</span> <span class="ow">or</span> <span class="n">identify</span> <span class="o">==</span> <span class="s2">"always"</span><span class="p">:</span> -</span><span id="should_identify-423"><a href="#should_identify-423"><span class="linenos">423</span></a> <span class="k">return</span> <span class="kc">True</span> -</span><span id="should_identify-424"><a href="#should_identify-424"><span class="linenos">424</span></a> <span class="k">if</span> <span class="n">identify</span> <span class="o">==</span> <span class="s2">"safe"</span><span class="p">:</span> -</span><span id="should_identify-425"><a href="#should_identify-425"><span class="linenos">425</span></a> <span class="k">return</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">char</span><span class="o">.</span><span class="n">isupper</span><span class="p">()</span> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">text</span><span class="p">)</span> -</span><span id="should_identify-426"><a href="#should_identify-426"><span class="linenos">426</span></a> <span class="k">return</span> <span class="kc">False</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="should_identify-434"><a href="#should_identify-434"><span class="linenos">434</span></a><span class="k">def</span> <span class="nf">should_identify</span><span class="p">(</span><span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">identify</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> +</span><span id="should_identify-435"><a href="#should_identify-435"><span class="linenos">435</span></a><span class="w"> </span><span class="sd">"""Checks if text should be identified given an identify option.</span> +</span><span id="should_identify-436"><a href="#should_identify-436"><span class="linenos">436</span></a> +</span><span id="should_identify-437"><a href="#should_identify-437"><span class="linenos">437</span></a><span class="sd"> Args:</span> +</span><span id="should_identify-438"><a href="#should_identify-438"><span class="linenos">438</span></a><span class="sd"> text: the text to check.</span> +</span><span id="should_identify-439"><a href="#should_identify-439"><span class="linenos">439</span></a><span class="sd"> identify: "always" | True - always returns true, "safe" - true if no upper case</span> +</span><span id="should_identify-440"><a href="#should_identify-440"><span class="linenos">440</span></a> +</span><span id="should_identify-441"><a href="#should_identify-441"><span class="linenos">441</span></a><span class="sd"> Returns:</span> +</span><span id="should_identify-442"><a href="#should_identify-442"><span class="linenos">442</span></a><span class="sd"> Whether or not a string should be identified.</span> +</span><span id="should_identify-443"><a href="#should_identify-443"><span class="linenos">443</span></a><span class="sd"> """</span> +</span><span id="should_identify-444"><a href="#should_identify-444"><span class="linenos">444</span></a> <span class="k">if</span> <span class="n">identify</span> <span class="ow">is</span> <span class="kc">True</span> <span class="ow">or</span> <span class="n">identify</span> <span class="o">==</span> <span class="s2">"always"</span><span class="p">:</span> +</span><span id="should_identify-445"><a href="#should_identify-445"><span class="linenos">445</span></a> <span class="k">return</span> <span class="kc">True</span> +</span><span id="should_identify-446"><a href="#should_identify-446"><span class="linenos">446</span></a> <span class="k">if</span> <span class="n">identify</span> <span class="o">==</span> <span class="s2">"safe"</span><span class="p">:</span> +</span><span id="should_identify-447"><a href="#should_identify-447"><span class="linenos">447</span></a> <span class="k">return</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">char</span><span class="o">.</span><span class="n">isupper</span><span class="p">()</span> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">text</span><span class="p">)</span> +</span><span id="should_identify-448"><a href="#should_identify-448"><span class="linenos">448</span></a> <span class="k">return</span> <span class="kc">False</span> </span></pre></div> |