diff options
Diffstat (limited to 'docs/sqlglot/helper.html')
| -rw-r--r-- | docs/sqlglot/helper.html | 1558 |
1 files changed, 794 insertions, 764 deletions
diff --git a/docs/sqlglot/helper.html b/docs/sqlglot/helper.html index 27f83a0..fea7d78 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.1"/> + <meta name="generator" content="pdoc 14.0.0"/> <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> @@ -31,6 +31,15 @@ <h2>API Documentation</h2> <ul class="memberlist"> <li> + <a class="variable" href="#CAMEL_CASE_PATTERN">CAMEL_CASE_PATTERN</a> + </li> + <li> + <a class="variable" href="#PYTHON_VERSION">PYTHON_VERSION</a> + </li> + <li> + <a class="variable" href="#logger">logger</a> + </li> + <li> <a class="class" href="#AutoName">AutoName</a> <ul class="memberlist"> </ul> @@ -140,417 +149,451 @@ </span><span id="L-22"><a href="#L-22"><span class="linenos"> 22</span></a> </span><span id="L-23"><a href="#L-23"><span class="linenos"> 23</span></a> </span><span id="L-24"><a href="#L-24"><span class="linenos"> 24</span></a><span class="k">class</span> <span class="nc">AutoName</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span> -</span><span id="L-25"><a href="#L-25"><span class="linenos"> 25</span></a><span class="w"> </span><span class="sd">"""This is used for creating enum classes where `auto()` is the string form of the corresponding value's name."""</span> -</span><span id="L-26"><a href="#L-26"><span class="linenos"> 26</span></a> -</span><span id="L-27"><a href="#L-27"><span class="linenos"> 27</span></a> <span class="k">def</span> <span class="nf">_generate_next_value_</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">_start</span><span class="p">,</span> <span class="n">_count</span><span class="p">,</span> <span class="n">_last_values</span><span class="p">):</span> -</span><span id="L-28"><a href="#L-28"><span class="linenos"> 28</span></a> <span class="k">return</span> <span class="n">name</span> -</span><span id="L-29"><a href="#L-29"><span class="linenos"> 29</span></a> -</span><span id="L-30"><a href="#L-30"><span class="linenos"> 30</span></a> -</span><span id="L-31"><a href="#L-31"><span class="linenos"> 31</span></a><span class="k">def</span> <span class="nf">seq_get</span><span class="p">(</span><span class="n">seq</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="p">],</span> <span class="n">index</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">Optional</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> -</span><span id="L-32"><a href="#L-32"><span class="linenos"> 32</span></a><span class="w"> </span><span class="sd">"""Returns the value in `seq` at position `index`, or `None` if `index` is out of bounds."""</span> -</span><span id="L-33"><a href="#L-33"><span class="linenos"> 33</span></a> <span class="k">try</span><span class="p">:</span> -</span><span id="L-34"><a href="#L-34"><span class="linenos"> 34</span></a> <span class="k">return</span> <span class="n">seq</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> -</span><span id="L-35"><a href="#L-35"><span class="linenos"> 35</span></a> <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span> -</span><span id="L-36"><a href="#L-36"><span class="linenos"> 36</span></a> <span class="k">return</span> <span class="kc">None</span> -</span><span id="L-37"><a href="#L-37"><span class="linenos"> 37</span></a> -</span><span id="L-38"><a href="#L-38"><span class="linenos"> 38</span></a> -</span><span id="L-39"><a href="#L-39"><span class="linenos"> 39</span></a><span class="nd">@t</span><span class="o">.</span><span class="n">overload</span> -</span><span id="L-40"><a href="#L-40"><span class="linenos"> 40</span></a><span class="k">def</span> <span class="nf">ensure_list</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">Collection</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-41"><a href="#L-41"><span class="linenos"> 41</span></a> <span class="o">...</span> +</span><span id="L-25"><a href="#L-25"><span class="linenos"> 25</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-26"><a href="#L-26"><span class="linenos"> 26</span></a><span class="sd"> This is used for creating Enum classes where `auto()` is the string form</span> +</span><span id="L-27"><a href="#L-27"><span class="linenos"> 27</span></a><span class="sd"> of the corresponding enum's identifier (e.g. FOO.value results in "FOO").</span> +</span><span id="L-28"><a href="#L-28"><span class="linenos"> 28</span></a> +</span><span id="L-29"><a href="#L-29"><span class="linenos"> 29</span></a><span class="sd"> Reference: https://docs.python.org/3/howto/enum.html#using-automatic-values</span> +</span><span id="L-30"><a href="#L-30"><span class="linenos"> 30</span></a><span class="sd"> """</span> +</span><span id="L-31"><a href="#L-31"><span class="linenos"> 31</span></a> +</span><span id="L-32"><a href="#L-32"><span class="linenos"> 32</span></a> <span class="k">def</span> <span class="nf">_generate_next_value_</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">_start</span><span class="p">,</span> <span class="n">_count</span><span class="p">,</span> <span class="n">_last_values</span><span class="p">):</span> +</span><span id="L-33"><a href="#L-33"><span class="linenos"> 33</span></a> <span class="k">return</span> <span class="n">name</span> +</span><span id="L-34"><a href="#L-34"><span class="linenos"> 34</span></a> +</span><span id="L-35"><a href="#L-35"><span class="linenos"> 35</span></a> +</span><span id="L-36"><a href="#L-36"><span class="linenos"> 36</span></a><span class="k">def</span> <span class="nf">seq_get</span><span class="p">(</span><span class="n">seq</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="p">],</span> <span class="n">index</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">Optional</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> +</span><span id="L-37"><a href="#L-37"><span class="linenos"> 37</span></a><span class="w"> </span><span class="sd">"""Returns the value in `seq` at position `index`, or `None` if `index` is out of bounds."""</span> +</span><span id="L-38"><a href="#L-38"><span class="linenos"> 38</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="L-39"><a href="#L-39"><span class="linenos"> 39</span></a> <span class="k">return</span> <span class="n">seq</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> +</span><span id="L-40"><a href="#L-40"><span class="linenos"> 40</span></a> <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span> +</span><span id="L-41"><a href="#L-41"><span class="linenos"> 41</span></a> <span class="k">return</span> <span class="kc">None</span> </span><span id="L-42"><a href="#L-42"><span class="linenos"> 42</span></a> </span><span id="L-43"><a href="#L-43"><span class="linenos"> 43</span></a> </span><span id="L-44"><a href="#L-44"><span class="linenos"> 44</span></a><span class="nd">@t</span><span class="o">.</span><span class="n">overload</span> -</span><span id="L-45"><a href="#L-45"><span class="linenos"> 45</span></a><span class="k">def</span> <span class="nf">ensure_list</span><span class="p">(</span><span class="n">value</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-45"><a href="#L-45"><span class="linenos"> 45</span></a><span class="k">def</span> <span class="nf">ensure_list</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">Collection</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-46"><a href="#L-46"><span class="linenos"> 46</span></a> <span class="o">...</span> </span><span id="L-47"><a href="#L-47"><span class="linenos"> 47</span></a> </span><span id="L-48"><a href="#L-48"><span class="linenos"> 48</span></a> -</span><span id="L-49"><a href="#L-49"><span class="linenos"> 49</span></a><span class="k">def</span> <span class="nf">ensure_list</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> -</span><span id="L-50"><a href="#L-50"><span class="linenos"> 50</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-51"><a href="#L-51"><span class="linenos"> 51</span></a><span class="sd"> Ensures that a value is a list, otherwise casts or wraps it into one.</span> +</span><span id="L-49"><a href="#L-49"><span class="linenos"> 49</span></a><span class="nd">@t</span><span class="o">.</span><span class="n">overload</span> +</span><span id="L-50"><a href="#L-50"><span class="linenos"> 50</span></a><span class="k">def</span> <span class="nf">ensure_list</span><span class="p">(</span><span class="n">value</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-51"><a href="#L-51"><span class="linenos"> 51</span></a> <span class="o">...</span> </span><span id="L-52"><a href="#L-52"><span class="linenos"> 52</span></a> -</span><span id="L-53"><a href="#L-53"><span class="linenos"> 53</span></a><span class="sd"> Args:</span> -</span><span id="L-54"><a href="#L-54"><span class="linenos"> 54</span></a><span class="sd"> value: the value of interest.</span> -</span><span id="L-55"><a href="#L-55"><span class="linenos"> 55</span></a> -</span><span id="L-56"><a href="#L-56"><span class="linenos"> 56</span></a><span class="sd"> Returns:</span> -</span><span id="L-57"><a href="#L-57"><span class="linenos"> 57</span></a><span class="sd"> The value cast as a list if it's a list or a tuple, or else the value wrapped in a list.</span> -</span><span id="L-58"><a href="#L-58"><span class="linenos"> 58</span></a><span class="sd"> """</span> -</span><span id="L-59"><a href="#L-59"><span class="linenos"> 59</span></a> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> -</span><span id="L-60"><a href="#L-60"><span class="linenos"> 60</span></a> <span class="k">return</span> <span class="p">[]</span> -</span><span id="L-61"><a href="#L-61"><span class="linenos"> 61</span></a> <span class="k">if</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">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span> -</span><span id="L-62"><a href="#L-62"><span class="linenos"> 62</span></a> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> -</span><span id="L-63"><a href="#L-63"><span class="linenos"> 63</span></a> -</span><span id="L-64"><a href="#L-64"><span class="linenos"> 64</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">value</span><span class="p">]</span> -</span><span id="L-65"><a href="#L-65"><span class="linenos"> 65</span></a> -</span><span id="L-66"><a href="#L-66"><span class="linenos"> 66</span></a> -</span><span id="L-67"><a href="#L-67"><span class="linenos"> 67</span></a><span class="nd">@t</span><span class="o">.</span><span class="n">overload</span> -</span><span id="L-68"><a href="#L-68"><span class="linenos"> 68</span></a><span class="k">def</span> <span class="nf">ensure_collection</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">Collection</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">Collection</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> -</span><span id="L-69"><a href="#L-69"><span class="linenos"> 69</span></a> <span class="o">...</span> +</span><span id="L-53"><a href="#L-53"><span class="linenos"> 53</span></a> +</span><span id="L-54"><a href="#L-54"><span class="linenos"> 54</span></a><span class="k">def</span> <span class="nf">ensure_list</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> +</span><span id="L-55"><a href="#L-55"><span class="linenos"> 55</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-56"><a href="#L-56"><span class="linenos"> 56</span></a><span class="sd"> Ensures that a value is a list, otherwise casts or wraps it into one.</span> +</span><span id="L-57"><a href="#L-57"><span class="linenos"> 57</span></a> +</span><span id="L-58"><a href="#L-58"><span class="linenos"> 58</span></a><span class="sd"> Args:</span> +</span><span id="L-59"><a href="#L-59"><span class="linenos"> 59</span></a><span class="sd"> value: The value of interest.</span> +</span><span id="L-60"><a href="#L-60"><span class="linenos"> 60</span></a> +</span><span id="L-61"><a href="#L-61"><span class="linenos"> 61</span></a><span class="sd"> Returns:</span> +</span><span id="L-62"><a href="#L-62"><span class="linenos"> 62</span></a><span class="sd"> The value cast as a list if it's a list or a tuple, or else the value wrapped in a list.</span> +</span><span id="L-63"><a href="#L-63"><span class="linenos"> 63</span></a><span class="sd"> """</span> +</span><span id="L-64"><a href="#L-64"><span class="linenos"> 64</span></a> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> +</span><span id="L-65"><a href="#L-65"><span class="linenos"> 65</span></a> <span class="k">return</span> <span class="p">[]</span> +</span><span id="L-66"><a href="#L-66"><span class="linenos"> 66</span></a> <span class="k">if</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">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span> +</span><span id="L-67"><a href="#L-67"><span class="linenos"> 67</span></a> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> +</span><span id="L-68"><a href="#L-68"><span class="linenos"> 68</span></a> +</span><span id="L-69"><a href="#L-69"><span class="linenos"> 69</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">value</span><span class="p">]</span> </span><span id="L-70"><a href="#L-70"><span class="linenos"> 70</span></a> </span><span id="L-71"><a href="#L-71"><span class="linenos"> 71</span></a> </span><span id="L-72"><a href="#L-72"><span class="linenos"> 72</span></a><span class="nd">@t</span><span class="o">.</span><span class="n">overload</span> -</span><span id="L-73"><a href="#L-73"><span class="linenos"> 73</span></a><span class="k">def</span> <span class="nf">ensure_collection</span><span class="p">(</span><span class="n">value</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">Collection</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> +</span><span id="L-73"><a href="#L-73"><span class="linenos"> 73</span></a><span class="k">def</span> <span class="nf">ensure_collection</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">Collection</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">Collection</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> </span><span id="L-74"><a href="#L-74"><span class="linenos"> 74</span></a> <span class="o">...</span> </span><span id="L-75"><a href="#L-75"><span class="linenos"> 75</span></a> </span><span id="L-76"><a href="#L-76"><span class="linenos"> 76</span></a> -</span><span id="L-77"><a href="#L-77"><span class="linenos"> 77</span></a><span class="k">def</span> <span class="nf">ensure_collection</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> -</span><span id="L-78"><a href="#L-78"><span class="linenos"> 78</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-79"><a href="#L-79"><span class="linenos"> 79</span></a><span class="sd"> Ensures that a value is a collection (excluding `str` and `bytes`), otherwise wraps it into a list.</span> +</span><span id="L-77"><a href="#L-77"><span class="linenos"> 77</span></a><span class="nd">@t</span><span class="o">.</span><span class="n">overload</span> +</span><span id="L-78"><a href="#L-78"><span class="linenos"> 78</span></a><span class="k">def</span> <span class="nf">ensure_collection</span><span class="p">(</span><span class="n">value</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">Collection</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> +</span><span id="L-79"><a href="#L-79"><span class="linenos"> 79</span></a> <span class="o">...</span> </span><span id="L-80"><a href="#L-80"><span class="linenos"> 80</span></a> -</span><span id="L-81"><a href="#L-81"><span class="linenos"> 81</span></a><span class="sd"> Args:</span> -</span><span id="L-82"><a href="#L-82"><span class="linenos"> 82</span></a><span class="sd"> value: the value of interest.</span> -</span><span id="L-83"><a href="#L-83"><span class="linenos"> 83</span></a> -</span><span id="L-84"><a href="#L-84"><span class="linenos"> 84</span></a><span class="sd"> Returns:</span> -</span><span id="L-85"><a href="#L-85"><span class="linenos"> 85</span></a><span class="sd"> The value if it's a collection, or else the value wrapped in a list.</span> -</span><span id="L-86"><a href="#L-86"><span class="linenos"> 86</span></a><span class="sd"> """</span> -</span><span id="L-87"><a href="#L-87"><span class="linenos"> 87</span></a> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> -</span><span id="L-88"><a href="#L-88"><span class="linenos"> 88</span></a> <span class="k">return</span> <span class="p">[]</span> -</span><span id="L-89"><a href="#L-89"><span class="linenos"> 89</span></a> <span class="k">return</span> <span class="p">(</span> -</span><span id="L-90"><a href="#L-90"><span class="linenos"> 90</span></a> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Collection</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 class="k">else</span> <span class="p">[</span><span class="n">value</span><span class="p">]</span> -</span><span id="L-91"><a href="#L-91"><span class="linenos"> 91</span></a> <span class="p">)</span> -</span><span id="L-92"><a href="#L-92"><span class="linenos"> 92</span></a> -</span><span id="L-93"><a href="#L-93"><span class="linenos"> 93</span></a> -</span><span id="L-94"><a href="#L-94"><span class="linenos"> 94</span></a><span class="k">def</span> <span class="nf">csv</span><span class="p">(</span><span class="o">*</span><span class="n">args</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="o">=</span> <span class="s2">", "</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> -</span><span id="L-95"><a href="#L-95"><span class="linenos"> 95</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-96"><a href="#L-96"><span class="linenos"> 96</span></a><span class="sd"> Formats any number of string arguments as CSV.</span> +</span><span id="L-81"><a href="#L-81"><span class="linenos"> 81</span></a> +</span><span id="L-82"><a href="#L-82"><span class="linenos"> 82</span></a><span class="k">def</span> <span class="nf">ensure_collection</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> +</span><span id="L-83"><a href="#L-83"><span class="linenos"> 83</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-84"><a href="#L-84"><span class="linenos"> 84</span></a><span class="sd"> Ensures that a value is a collection (excluding `str` and `bytes`), otherwise wraps it into a list.</span> +</span><span id="L-85"><a href="#L-85"><span class="linenos"> 85</span></a> +</span><span id="L-86"><a href="#L-86"><span class="linenos"> 86</span></a><span class="sd"> Args:</span> +</span><span id="L-87"><a href="#L-87"><span class="linenos"> 87</span></a><span class="sd"> value: The value of interest.</span> +</span><span id="L-88"><a href="#L-88"><span class="linenos"> 88</span></a> +</span><span id="L-89"><a href="#L-89"><span class="linenos"> 89</span></a><span class="sd"> Returns:</span> +</span><span id="L-90"><a href="#L-90"><span class="linenos"> 90</span></a><span class="sd"> The value if it's a collection, or else the value wrapped in a list.</span> +</span><span id="L-91"><a href="#L-91"><span class="linenos"> 91</span></a><span class="sd"> """</span> +</span><span id="L-92"><a href="#L-92"><span class="linenos"> 92</span></a> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> +</span><span id="L-93"><a href="#L-93"><span class="linenos"> 93</span></a> <span class="k">return</span> <span class="p">[]</span> +</span><span id="L-94"><a href="#L-94"><span class="linenos"> 94</span></a> <span class="k">return</span> <span class="p">(</span> +</span><span id="L-95"><a href="#L-95"><span class="linenos"> 95</span></a> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Collection</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 class="k">else</span> <span class="p">[</span><span class="n">value</span><span class="p">]</span> +</span><span id="L-96"><a href="#L-96"><span class="linenos"> 96</span></a> <span class="p">)</span> </span><span id="L-97"><a href="#L-97"><span class="linenos"> 97</span></a> -</span><span id="L-98"><a href="#L-98"><span class="linenos"> 98</span></a><span class="sd"> Args:</span> -</span><span id="L-99"><a href="#L-99"><span class="linenos"> 99</span></a><span class="sd"> args: the string arguments to format.</span> -</span><span id="L-100"><a href="#L-100"><span class="linenos">100</span></a><span class="sd"> sep: the argument separator.</span> -</span><span id="L-101"><a href="#L-101"><span class="linenos">101</span></a> -</span><span id="L-102"><a href="#L-102"><span class="linenos">102</span></a><span class="sd"> Returns:</span> -</span><span id="L-103"><a href="#L-103"><span class="linenos">103</span></a><span class="sd"> The arguments formatted as a CSV string.</span> -</span><span id="L-104"><a href="#L-104"><span class="linenos">104</span></a><span class="sd"> """</span> -</span><span id="L-105"><a href="#L-105"><span class="linenos">105</span></a> <span class="k">return</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">arg</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span> <span class="k">if</span> <span class="n">arg</span><span class="p">)</span> +</span><span id="L-98"><a href="#L-98"><span class="linenos"> 98</span></a> +</span><span id="L-99"><a href="#L-99"><span class="linenos"> 99</span></a><span class="k">def</span> <span class="nf">csv</span><span class="p">(</span><span class="o">*</span><span class="n">args</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="o">=</span> <span class="s2">", "</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> +</span><span id="L-100"><a href="#L-100"><span class="linenos">100</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-101"><a href="#L-101"><span class="linenos">101</span></a><span class="sd"> Formats any number of string arguments as CSV.</span> +</span><span id="L-102"><a href="#L-102"><span class="linenos">102</span></a> +</span><span id="L-103"><a href="#L-103"><span class="linenos">103</span></a><span class="sd"> Args:</span> +</span><span id="L-104"><a href="#L-104"><span class="linenos">104</span></a><span class="sd"> args: The string arguments to format.</span> +</span><span id="L-105"><a href="#L-105"><span class="linenos">105</span></a><span class="sd"> sep: The argument separator.</span> </span><span id="L-106"><a href="#L-106"><span class="linenos">106</span></a> -</span><span id="L-107"><a href="#L-107"><span class="linenos">107</span></a> -</span><span id="L-108"><a href="#L-108"><span class="linenos">108</span></a><span class="k">def</span> <span class="nf">subclasses</span><span class="p">(</span> -</span><span id="L-109"><a href="#L-109"><span class="linenos">109</span></a> <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> -</span><span id="L-110"><a href="#L-110"><span class="linenos">110</span></a> <span class="n">classes</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Type</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Type</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span> -</span><span id="L-111"><a href="#L-111"><span class="linenos">111</span></a> <span class="n">exclude</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Type</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Type</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(),</span> -</span><span id="L-112"><a href="#L-112"><span class="linenos">112</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">Type</span><span class="p">]:</span> -</span><span id="L-113"><a href="#L-113"><span class="linenos">113</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-114"><a href="#L-114"><span class="linenos">114</span></a><span class="sd"> Returns all subclasses for a collection of classes, possibly excluding some of them.</span> -</span><span id="L-115"><a href="#L-115"><span class="linenos">115</span></a> -</span><span id="L-116"><a href="#L-116"><span class="linenos">116</span></a><span class="sd"> Args:</span> -</span><span id="L-117"><a href="#L-117"><span class="linenos">117</span></a><span class="sd"> module_name: the name of the module to search for subclasses in.</span> -</span><span id="L-118"><a href="#L-118"><span class="linenos">118</span></a><span class="sd"> classes: class(es) we want to find the subclasses of.</span> -</span><span id="L-119"><a href="#L-119"><span class="linenos">119</span></a><span class="sd"> exclude: class(es) we want to exclude from the returned list.</span> +</span><span id="L-107"><a href="#L-107"><span class="linenos">107</span></a><span class="sd"> Returns:</span> +</span><span id="L-108"><a href="#L-108"><span class="linenos">108</span></a><span class="sd"> The arguments formatted as a CSV string.</span> +</span><span id="L-109"><a href="#L-109"><span class="linenos">109</span></a><span class="sd"> """</span> +</span><span id="L-110"><a href="#L-110"><span class="linenos">110</span></a> <span class="k">return</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">arg</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span> <span class="k">if</span> <span class="n">arg</span><span class="p">)</span> +</span><span id="L-111"><a href="#L-111"><span class="linenos">111</span></a> +</span><span id="L-112"><a href="#L-112"><span class="linenos">112</span></a> +</span><span id="L-113"><a href="#L-113"><span class="linenos">113</span></a><span class="k">def</span> <span class="nf">subclasses</span><span class="p">(</span> +</span><span id="L-114"><a href="#L-114"><span class="linenos">114</span></a> <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> +</span><span id="L-115"><a href="#L-115"><span class="linenos">115</span></a> <span class="n">classes</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Type</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Type</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span> +</span><span id="L-116"><a href="#L-116"><span class="linenos">116</span></a> <span class="n">exclude</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Type</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Type</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(),</span> +</span><span id="L-117"><a href="#L-117"><span class="linenos">117</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">Type</span><span class="p">]:</span> +</span><span id="L-118"><a href="#L-118"><span class="linenos">118</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-119"><a href="#L-119"><span class="linenos">119</span></a><span class="sd"> Returns all subclasses for a collection of classes, possibly excluding some of them.</span> </span><span id="L-120"><a href="#L-120"><span class="linenos">120</span></a> -</span><span id="L-121"><a href="#L-121"><span class="linenos">121</span></a><span class="sd"> Returns:</span> -</span><span id="L-122"><a href="#L-122"><span class="linenos">122</span></a><span class="sd"> The target subclasses.</span> -</span><span id="L-123"><a href="#L-123"><span class="linenos">123</span></a><span class="sd"> """</span> -</span><span id="L-124"><a href="#L-124"><span class="linenos">124</span></a> <span class="k">return</span> <span class="p">[</span> -</span><span id="L-125"><a href="#L-125"><span class="linenos">125</span></a> <span class="n">obj</span> -</span><span id="L-126"><a href="#L-126"><span class="linenos">126</span></a> <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getmembers</span><span class="p">(</span> -</span><span id="L-127"><a href="#L-127"><span class="linenos">127</span></a> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">module_name</span><span class="p">],</span> -</span><span id="L-128"><a href="#L-128"><span class="linenos">128</span></a> <span class="k">lambda</span> <span class="n">obj</span><span class="p">:</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">classes</span><span class="p">)</span> <span class="ow">and</span> <span class="n">obj</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">exclude</span><span class="p">,</span> -</span><span id="L-129"><a href="#L-129"><span class="linenos">129</span></a> <span class="p">)</span> -</span><span id="L-130"><a href="#L-130"><span class="linenos">130</span></a> <span class="p">]</span> -</span><span id="L-131"><a href="#L-131"><span class="linenos">131</span></a> -</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 class="k">def</span> <span class="nf">apply_index_offset</span><span class="p">(</span> -</span><span id="L-134"><a href="#L-134"><span class="linenos">134</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-135"><a href="#L-135"><span class="linenos">135</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-136"><a href="#L-136"><span class="linenos">136</span></a> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> -</span><span id="L-137"><a href="#L-137"><span class="linenos">137</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-138"><a href="#L-138"><span class="linenos">138</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-139"><a href="#L-139"><span class="linenos">139</span></a><span class="sd"> Applies an offset to a given integer literal expression.</span> -</span><span id="L-140"><a href="#L-140"><span class="linenos">140</span></a> -</span><span id="L-141"><a href="#L-141"><span class="linenos">141</span></a><span class="sd"> Args:</span> -</span><span id="L-142"><a href="#L-142"><span class="linenos">142</span></a><span class="sd"> this: the target of the index</span> -</span><span id="L-143"><a href="#L-143"><span class="linenos">143</span></a><span class="sd"> expressions: the expression the offset will be applied to, wrapped in a list.</span> -</span><span id="L-144"><a href="#L-144"><span class="linenos">144</span></a><span class="sd"> offset: the offset that will be applied.</span> +</span><span id="L-121"><a href="#L-121"><span class="linenos">121</span></a><span class="sd"> Args:</span> +</span><span id="L-122"><a href="#L-122"><span class="linenos">122</span></a><span class="sd"> module_name: The name of the module to search for subclasses in.</span> +</span><span id="L-123"><a href="#L-123"><span class="linenos">123</span></a><span class="sd"> classes: Class(es) we want to find the subclasses of.</span> +</span><span id="L-124"><a href="#L-124"><span class="linenos">124</span></a><span class="sd"> exclude: Class(es) we want to exclude from the returned list.</span> +</span><span id="L-125"><a href="#L-125"><span class="linenos">125</span></a> +</span><span id="L-126"><a href="#L-126"><span class="linenos">126</span></a><span class="sd"> Returns:</span> +</span><span id="L-127"><a href="#L-127"><span class="linenos">127</span></a><span class="sd"> The target subclasses.</span> +</span><span id="L-128"><a href="#L-128"><span class="linenos">128</span></a><span class="sd"> """</span> +</span><span id="L-129"><a href="#L-129"><span class="linenos">129</span></a> <span class="k">return</span> <span class="p">[</span> +</span><span id="L-130"><a href="#L-130"><span class="linenos">130</span></a> <span class="n">obj</span> +</span><span id="L-131"><a href="#L-131"><span class="linenos">131</span></a> <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getmembers</span><span class="p">(</span> +</span><span id="L-132"><a href="#L-132"><span class="linenos">132</span></a> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">module_name</span><span class="p">],</span> +</span><span id="L-133"><a href="#L-133"><span class="linenos">133</span></a> <span class="k">lambda</span> <span class="n">obj</span><span class="p">:</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">classes</span><span class="p">)</span> <span class="ow">and</span> <span class="n">obj</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">exclude</span><span class="p">,</span> +</span><span id="L-134"><a href="#L-134"><span class="linenos">134</span></a> <span class="p">)</span> +</span><span id="L-135"><a href="#L-135"><span class="linenos">135</span></a> <span class="p">]</span> +</span><span id="L-136"><a href="#L-136"><span class="linenos">136</span></a> +</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="k">def</span> <span class="nf">apply_index_offset</span><span class="p">(</span> +</span><span id="L-139"><a href="#L-139"><span class="linenos">139</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-140"><a href="#L-140"><span class="linenos">140</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-141"><a href="#L-141"><span class="linenos">141</span></a> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> +</span><span id="L-142"><a href="#L-142"><span class="linenos">142</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-143"><a href="#L-143"><span class="linenos">143</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-144"><a href="#L-144"><span class="linenos">144</span></a><span class="sd"> Applies an offset to a given integer literal expression.</span> </span><span id="L-145"><a href="#L-145"><span class="linenos">145</span></a> -</span><span id="L-146"><a href="#L-146"><span class="linenos">146</span></a><span class="sd"> Returns:</span> -</span><span id="L-147"><a href="#L-147"><span class="linenos">147</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-148"><a href="#L-148"><span class="linenos">148</span></a><span class="sd"> `expressions` argument contains more than one expressions, it's returned unaffected.</span> -</span><span id="L-149"><a href="#L-149"><span class="linenos">149</span></a><span class="sd"> """</span> -</span><span id="L-150"><a href="#L-150"><span class="linenos">150</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-151"><a href="#L-151"><span class="linenos">151</span></a> <span class="k">return</span> <span class="n">expressions</span> -</span><span id="L-152"><a href="#L-152"><span class="linenos">152</span></a> -</span><span id="L-153"><a href="#L-153"><span class="linenos">153</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-154"><a href="#L-154"><span class="linenos">154</span></a> -</span><span id="L-155"><a href="#L-155"><span class="linenos">155</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-156"><a href="#L-156"><span class="linenos">156</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-157"><a href="#L-157"><span class="linenos">157</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-158"><a href="#L-158"><span class="linenos">158</span></a> -</span><span id="L-159"><a href="#L-159"><span class="linenos">159</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-160"><a href="#L-160"><span class="linenos">160</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-161"><a href="#L-161"><span class="linenos">161</span></a> -</span><span id="L-162"><a href="#L-162"><span class="linenos">162</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-163"><a href="#L-163"><span class="linenos">163</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-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">ARRAY</span><span class="p">,</span> -</span><span id="L-165"><a href="#L-165"><span class="linenos">165</span></a> <span class="p">):</span> -</span><span id="L-166"><a href="#L-166"><span class="linenos">166</span></a> <span class="k">return</span> <span class="n">expressions</span> -</span><span id="L-167"><a href="#L-167"><span class="linenos">167</span></a> -</span><span id="L-168"><a href="#L-168"><span class="linenos">168</span></a> <span class="k">if</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="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-170"><a href="#L-170"><span class="linenos">170</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-171"><a href="#L-171"><span class="linenos">171</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-172"><a href="#L-172"><span class="linenos">172</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-173"><a href="#L-173"><span class="linenos">173</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">simplify</span><span class="p">(</span> -</span><span id="L-174"><a href="#L-174"><span class="linenos">174</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-175"><a href="#L-175"><span class="linenos">175</span></a> <span class="p">)</span> -</span><span id="L-176"><a href="#L-176"><span class="linenos">176</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">expression</span><span class="p">]</span> -</span><span id="L-177"><a href="#L-177"><span class="linenos">177</span></a> -</span><span id="L-178"><a href="#L-178"><span class="linenos">178</span></a> <span class="k">return</span> <span class="n">expressions</span> -</span><span id="L-179"><a href="#L-179"><span class="linenos">179</span></a> -</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 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-182"><a href="#L-182"><span class="linenos">182</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-183"><a href="#L-183"><span class="linenos">183</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-146"><a href="#L-146"><span class="linenos">146</span></a><span class="sd"> Args:</span> +</span><span id="L-147"><a href="#L-147"><span class="linenos">147</span></a><span class="sd"> this: The target of the index.</span> +</span><span id="L-148"><a href="#L-148"><span class="linenos">148</span></a><span class="sd"> expressions: The expression the offset will be applied to, wrapped in a list.</span> +</span><span id="L-149"><a href="#L-149"><span class="linenos">149</span></a><span class="sd"> offset: The offset that will be applied.</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="sd"> Returns:</span> +</span><span id="L-152"><a href="#L-152"><span class="linenos">152</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-153"><a href="#L-153"><span class="linenos">153</span></a><span class="sd"> `expressions` argument contains more than one expression, it's returned unaffected.</span> +</span><span id="L-154"><a href="#L-154"><span class="linenos">154</span></a><span class="sd"> """</span> +</span><span id="L-155"><a href="#L-155"><span class="linenos">155</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-156"><a href="#L-156"><span class="linenos">156</span></a> <span class="k">return</span> <span class="n">expressions</span> +</span><span id="L-157"><a href="#L-157"><span class="linenos">157</span></a> +</span><span id="L-158"><a href="#L-158"><span class="linenos">158</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-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="kn">from</span> <span class="nn">sqlglot</span> <span class="kn">import</span> <span class="n">exp</span> +</span><span id="L-161"><a href="#L-161"><span class="linenos">161</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-162"><a href="#L-162"><span class="linenos">162</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-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 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-165"><a href="#L-165"><span class="linenos">165</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-166"><a href="#L-166"><span class="linenos">166</span></a> +</span><span id="L-167"><a href="#L-167"><span class="linenos">167</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-168"><a href="#L-168"><span class="linenos">168</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-169"><a href="#L-169"><span class="linenos">169</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-170"><a href="#L-170"><span class="linenos">170</span></a> <span class="p">):</span> +</span><span id="L-171"><a href="#L-171"><span class="linenos">171</span></a> <span class="k">return</span> <span class="n">expressions</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="k">if</span> <span class="n">expression</span><span class="p">:</span> +</span><span id="L-174"><a href="#L-174"><span class="linenos">174</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-175"><a href="#L-175"><span class="linenos">175</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-176"><a href="#L-176"><span class="linenos">176</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-177"><a href="#L-177"><span class="linenos">177</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-178"><a href="#L-178"><span class="linenos">178</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">simplify</span><span class="p">(</span> +</span><span id="L-179"><a href="#L-179"><span class="linenos">179</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-180"><a href="#L-180"><span class="linenos">180</span></a> <span class="p">)</span> +</span><span id="L-181"><a href="#L-181"><span class="linenos">181</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">expression</span><span class="p">]</span> +</span><span id="L-182"><a href="#L-182"><span class="linenos">182</span></a> +</span><span id="L-183"><a href="#L-183"><span class="linenos">183</span></a> <span class="k">return</span> <span class="n">expressions</span> </span><span id="L-184"><a href="#L-184"><span class="linenos">184</span></a> </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 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-187"><a href="#L-187"><span class="linenos">187</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-188"><a href="#L-188"><span class="linenos">188</span></a><span class="sd"> Applies a transformation to a given expression until a fix point is reached.</span> +</span><span id="L-186"><a href="#L-186"><span class="linenos">186</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-187"><a href="#L-187"><span class="linenos">187</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-188"><a href="#L-188"><span class="linenos">188</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-189"><a href="#L-189"><span class="linenos">189</span></a> -</span><span id="L-190"><a href="#L-190"><span class="linenos">190</span></a><span class="sd"> Args:</span> -</span><span id="L-191"><a href="#L-191"><span class="linenos">191</span></a><span class="sd"> expression: the expression to be transformed.</span> -</span><span id="L-192"><a href="#L-192"><span class="linenos">192</span></a><span class="sd"> func: the transformation to be applied.</span> -</span><span id="L-193"><a href="#L-193"><span class="linenos">193</span></a> -</span><span id="L-194"><a href="#L-194"><span class="linenos">194</span></a><span class="sd"> Returns:</span> -</span><span id="L-195"><a href="#L-195"><span class="linenos">195</span></a><span class="sd"> The transformed expression.</span> -</span><span id="L-196"><a href="#L-196"><span class="linenos">196</span></a><span class="sd"> """</span> -</span><span id="L-197"><a href="#L-197"><span class="linenos">197</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> -</span><span id="L-198"><a href="#L-198"><span class="linenos">198</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-199"><a href="#L-199"><span class="linenos">199</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-200"><a href="#L-200"><span class="linenos">200</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-201"><a href="#L-201"><span class="linenos">201</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-202"><a href="#L-202"><span class="linenos">202</span></a> -</span><span id="L-203"><a href="#L-203"><span class="linenos">203</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-204"><a href="#L-204"><span class="linenos">204</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-205"><a href="#L-205"><span class="linenos">205</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-206"><a href="#L-206"><span class="linenos">206</span></a> <span class="k">break</span> -</span><span id="L-207"><a href="#L-207"><span class="linenos">207</span></a> <span class="k">return</span> <span class="n">expression</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="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-192"><a href="#L-192"><span class="linenos">192</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-193"><a href="#L-193"><span class="linenos">193</span></a><span class="sd"> Applies a transformation to a given expression until a fix point is reached.</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"> Args:</span> +</span><span id="L-196"><a href="#L-196"><span class="linenos">196</span></a><span class="sd"> expression: The expression to be transformed.</span> +</span><span id="L-197"><a href="#L-197"><span class="linenos">197</span></a><span class="sd"> func: The transformation to be applied.</span> +</span><span id="L-198"><a href="#L-198"><span class="linenos">198</span></a> +</span><span id="L-199"><a href="#L-199"><span class="linenos">199</span></a><span class="sd"> Returns:</span> +</span><span id="L-200"><a href="#L-200"><span class="linenos">200</span></a><span class="sd"> The transformed expression.</span> +</span><span id="L-201"><a href="#L-201"><span class="linenos">201</span></a><span class="sd"> """</span> +</span><span id="L-202"><a href="#L-202"><span class="linenos">202</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> +</span><span id="L-203"><a href="#L-203"><span class="linenos">203</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-204"><a href="#L-204"><span class="linenos">204</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-205"><a href="#L-205"><span class="linenos">205</span></a> +</span><span id="L-206"><a href="#L-206"><span class="linenos">206</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-207"><a href="#L-207"><span class="linenos">207</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-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><span id="L-210"><a href="#L-210"><span class="linenos">210</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">Set</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-211"><a href="#L-211"><span class="linenos">211</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-212"><a href="#L-212"><span class="linenos">212</span></a><span class="sd"> Sorts a given directed acyclic graph in topological order.</span> +</span><span id="L-209"><a href="#L-209"><span class="linenos">209</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-210"><a href="#L-210"><span class="linenos">210</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-211"><a href="#L-211"><span class="linenos">211</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-212"><a href="#L-212"><span class="linenos">212</span></a> <span class="k">break</span> </span><span id="L-213"><a href="#L-213"><span class="linenos">213</span></a> -</span><span id="L-214"><a href="#L-214"><span class="linenos">214</span></a><span class="sd"> Args:</span> -</span><span id="L-215"><a href="#L-215"><span class="linenos">215</span></a><span class="sd"> dag: the graph to be sorted.</span> +</span><span id="L-214"><a href="#L-214"><span class="linenos">214</span></a> <span class="k">return</span> <span class="n">expression</span> +</span><span id="L-215"><a href="#L-215"><span class="linenos">215</span></a> </span><span id="L-216"><a href="#L-216"><span class="linenos">216</span></a> -</span><span id="L-217"><a href="#L-217"><span class="linenos">217</span></a><span class="sd"> Returns:</span> -</span><span id="L-218"><a href="#L-218"><span class="linenos">218</span></a><span class="sd"> A list that contains all of the graph's nodes in topological order.</span> -</span><span id="L-219"><a href="#L-219"><span class="linenos">219</span></a><span class="sd"> """</span> -</span><span id="L-220"><a href="#L-220"><span class="linenos">220</span></a> <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span> -</span><span id="L-221"><a href="#L-221"><span class="linenos">221</span></a> -</span><span id="L-222"><a href="#L-222"><span class="linenos">222</span></a> <span class="k">for</span> <span class="n">node</span><span class="p">,</span> <span class="n">deps</span> <span class="ow">in</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">dag</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span> -</span><span id="L-223"><a href="#L-223"><span class="linenos">223</span></a> <span class="k">for</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">deps</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="ow">not</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">dag</span><span class="p">:</span> -</span><span id="L-225"><a href="#L-225"><span class="linenos">225</span></a> <span class="n">dag</span><span class="p">[</span><span class="n">dep</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> -</span><span id="L-226"><a href="#L-226"><span class="linenos">226</span></a> -</span><span id="L-227"><a href="#L-227"><span class="linenos">227</span></a> <span class="k">while</span> <span class="n">dag</span><span class="p">:</span> -</span><span id="L-228"><a href="#L-228"><span class="linenos">228</span></a> <span class="n">current</span> <span class="o">=</span> <span class="p">{</span><span class="n">node</span> <span class="k">for</span> <span class="n">node</span><span class="p">,</span> <span class="n">deps</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">deps</span><span class="p">}</span> -</span><span id="L-229"><a href="#L-229"><span class="linenos">229</span></a> -</span><span id="L-230"><a href="#L-230"><span class="linenos">230</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">current</span><span class="p">:</span> -</span><span id="L-231"><a href="#L-231"><span class="linenos">231</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-232"><a href="#L-232"><span class="linenos">232</span></a> -</span><span id="L-233"><a href="#L-233"><span class="linenos">233</span></a> <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> -</span><span id="L-234"><a href="#L-234"><span class="linenos">234</span></a> <span class="n">dag</span><span class="o">.</span><span class="n">pop</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><span id="L-236"><a href="#L-236"><span class="linenos">236</span></a> <span class="k">for</span> <span class="n">deps</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> -</span><span id="L-237"><a href="#L-237"><span class="linenos">237</span></a> <span class="n">deps</span> <span class="o">-=</span> <span class="n">current</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="n">result</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="n">current</span><span class="p">))</span> <span class="c1"># type: ignore</span> -</span><span id="L-240"><a href="#L-240"><span class="linenos">240</span></a> -</span><span id="L-241"><a href="#L-241"><span class="linenos">241</span></a> <span class="k">return</span> <span class="n">result</span> +</span><span id="L-217"><a href="#L-217"><span class="linenos">217</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">Set</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-218"><a href="#L-218"><span class="linenos">218</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-219"><a href="#L-219"><span class="linenos">219</span></a><span class="sd"> Sorts a given directed acyclic graph in topological order.</span> +</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="sd"> Args:</span> +</span><span id="L-222"><a href="#L-222"><span class="linenos">222</span></a><span class="sd"> dag: The graph to be sorted.</span> +</span><span id="L-223"><a href="#L-223"><span class="linenos">223</span></a> +</span><span id="L-224"><a href="#L-224"><span class="linenos">224</span></a><span class="sd"> Returns:</span> +</span><span id="L-225"><a href="#L-225"><span class="linenos">225</span></a><span class="sd"> A list that contains all of the graph's nodes in topological order.</span> +</span><span id="L-226"><a href="#L-226"><span class="linenos">226</span></a><span class="sd"> """</span> +</span><span id="L-227"><a href="#L-227"><span class="linenos">227</span></a> <span class="n">result</span> <span class="o">=</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">for</span> <span class="n">node</span><span class="p">,</span> <span class="n">deps</span> <span class="ow">in</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">dag</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span> +</span><span id="L-230"><a href="#L-230"><span class="linenos">230</span></a> <span class="k">for</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">deps</span><span class="p">:</span> +</span><span id="L-231"><a href="#L-231"><span class="linenos">231</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">dag</span><span class="p">:</span> +</span><span id="L-232"><a href="#L-232"><span class="linenos">232</span></a> <span class="n">dag</span><span class="p">[</span><span class="n">dep</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</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="k">while</span> <span class="n">dag</span><span class="p">:</span> +</span><span id="L-235"><a href="#L-235"><span class="linenos">235</span></a> <span class="n">current</span> <span class="o">=</span> <span class="p">{</span><span class="n">node</span> <span class="k">for</span> <span class="n">node</span><span class="p">,</span> <span class="n">deps</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">deps</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">if</span> <span class="ow">not</span> <span class="n">current</span><span class="p">:</span> +</span><span id="L-238"><a href="#L-238"><span class="linenos">238</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-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">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> +</span><span id="L-241"><a href="#L-241"><span class="linenos">241</span></a> <span class="n">dag</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">node</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><span id="L-244"><a href="#L-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="L-245"><a href="#L-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="L-246"><a href="#L-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="L-247"><a href="#L-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="L-248"><a href="#L-248"><span class="linenos">248</span></a> -</span><span id="L-249"><a href="#L-249"><span class="linenos">249</span></a> <span class="k">if</span> <span class="n">gzipped</span><span class="p">:</span> -</span><span id="L-250"><a href="#L-250"><span class="linenos">250</span></a> <span class="kn">import</span> <span class="nn">gzip</span> -</span><span id="L-251"><a href="#L-251"><span class="linenos">251</span></a> -</span><span id="L-252"><a href="#L-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="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">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-243"><a href="#L-243"><span class="linenos">243</span></a> <span class="k">for</span> <span class="n">deps</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> +</span><span id="L-244"><a href="#L-244"><span class="linenos">244</span></a> <span class="n">deps</span> <span class="o">-=</span> <span class="n">current</span> +</span><span id="L-245"><a href="#L-245"><span class="linenos">245</span></a> +</span><span id="L-246"><a href="#L-246"><span class="linenos">246</span></a> <span class="n">result</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="n">current</span><span class="p">))</span> <span class="c1"># type: ignore</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="k">return</span> <span class="n">result</span> +</span><span id="L-249"><a href="#L-249"><span class="linenos">249</span></a> +</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">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-252"><a href="#L-252"><span class="linenos">252</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-253"><a href="#L-253"><span class="linenos">253</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-254"><a href="#L-254"><span class="linenos">254</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-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><span id="L-257"><a href="#L-257"><span class="linenos">257</span></a><span class="nd">@contextmanager</span> -</span><span id="L-258"><a href="#L-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="L-259"><a href="#L-259"><span class="linenos">259</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-260"><a href="#L-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="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="sd"> Args:</span> -</span><span id="L-263"><a href="#L-263"><span class="linenos">263</span></a><span class="sd"> read_csv: a `ReadCSV` function call</span> -</span><span id="L-264"><a href="#L-264"><span class="linenos">264</span></a> -</span><span id="L-265"><a href="#L-265"><span class="linenos">265</span></a><span class="sd"> Yields:</span> -</span><span id="L-266"><a href="#L-266"><span class="linenos">266</span></a><span class="sd"> A python csv reader.</span> -</span><span id="L-267"><a href="#L-267"><span class="linenos">267</span></a><span class="sd"> """</span> -</span><span id="L-268"><a href="#L-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="L-269"><a href="#L-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="L-270"><a href="#L-270"><span class="linenos">270</span></a> -</span><span id="L-271"><a href="#L-271"><span class="linenos">271</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="s2">","</span> -</span><span id="L-272"><a href="#L-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="L-273"><a href="#L-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="L-274"><a href="#L-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="L-275"><a href="#L-275"><span class="linenos">275</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="n">v</span> -</span><span id="L-276"><a href="#L-276"><span class="linenos">276</span></a> -</span><span id="L-277"><a href="#L-277"><span class="linenos">277</span></a> <span class="k">try</span><span class="p">:</span> -</span><span id="L-278"><a href="#L-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="L-279"><a href="#L-279"><span class="linenos">279</span></a> -</span><span id="L-280"><a href="#L-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="L-281"><a href="#L-281"><span class="linenos">281</span></a> <span class="k">finally</span><span class="p">:</span> -</span><span id="L-282"><a href="#L-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><span id="L-256"><a href="#L-256"><span class="linenos">256</span></a> <span class="k">if</span> <span class="n">gzipped</span><span class="p">:</span> +</span><span id="L-257"><a href="#L-257"><span class="linenos">257</span></a> <span class="kn">import</span> <span class="nn">gzip</span> +</span><span id="L-258"><a href="#L-258"><span class="linenos">258</span></a> +</span><span id="L-259"><a href="#L-259"><span class="linenos">259</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-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 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-262"><a href="#L-262"><span class="linenos">262</span></a> +</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="nd">@contextmanager</span> +</span><span id="L-265"><a href="#L-265"><span class="linenos">265</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-266"><a href="#L-266"><span class="linenos">266</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-267"><a href="#L-267"><span class="linenos">267</span></a><span class="sd"> Returns a csv reader given the expression `READ_CSV(name, ['delimiter', '|', ...])`.</span> +</span><span id="L-268"><a href="#L-268"><span class="linenos">268</span></a> +</span><span id="L-269"><a href="#L-269"><span class="linenos">269</span></a><span class="sd"> Args:</span> +</span><span id="L-270"><a href="#L-270"><span class="linenos">270</span></a><span class="sd"> read_csv: A `ReadCSV` function call.</span> +</span><span id="L-271"><a href="#L-271"><span class="linenos">271</span></a> +</span><span id="L-272"><a href="#L-272"><span class="linenos">272</span></a><span class="sd"> Yields:</span> +</span><span id="L-273"><a href="#L-273"><span class="linenos">273</span></a><span class="sd"> A python csv reader.</span> +</span><span id="L-274"><a href="#L-274"><span class="linenos">274</span></a><span class="sd"> """</span> +</span><span id="L-275"><a href="#L-275"><span class="linenos">275</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-276"><a href="#L-276"><span class="linenos">276</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-277"><a href="#L-277"><span class="linenos">277</span></a> +</span><span id="L-278"><a href="#L-278"><span class="linenos">278</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="s2">","</span> +</span><span id="L-279"><a href="#L-279"><span class="linenos">279</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-280"><a href="#L-280"><span class="linenos">280</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-281"><a href="#L-281"><span class="linenos">281</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-282"><a href="#L-282"><span class="linenos">282</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="n">v</span> </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">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-286"><a href="#L-286"><span class="linenos">286</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-287"><a href="#L-287"><span class="linenos">287</span></a><span class="sd"> Searches for a new name.</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 class="sd"> Args:</span> -</span><span id="L-290"><a href="#L-290"><span class="linenos">290</span></a><span class="sd"> taken: a collection of taken names.</span> -</span><span id="L-291"><a href="#L-291"><span class="linenos">291</span></a><span class="sd"> base: base name to alter.</span> -</span><span id="L-292"><a href="#L-292"><span class="linenos">292</span></a> -</span><span id="L-293"><a href="#L-293"><span class="linenos">293</span></a><span class="sd"> Returns:</span> -</span><span id="L-294"><a href="#L-294"><span class="linenos">294</span></a><span class="sd"> The new, available name.</span> -</span><span id="L-295"><a href="#L-295"><span class="linenos">295</span></a><span class="sd"> """</span> -</span><span id="L-296"><a href="#L-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="L-297"><a href="#L-297"><span class="linenos">297</span></a> <span class="k">return</span> <span class="n">base</span> -</span><span id="L-298"><a href="#L-298"><span class="linenos">298</span></a> -</span><span id="L-299"><a href="#L-299"><span class="linenos">299</span></a> <span class="n">i</span> <span class="o">=</span> <span class="mi">2</span> -</span><span id="L-300"><a href="#L-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="L-301"><a href="#L-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="L-302"><a href="#L-302"><span class="linenos">302</span></a> <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> -</span><span id="L-303"><a href="#L-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="L-304"><a href="#L-304"><span class="linenos">304</span></a> -</span><span id="L-305"><a href="#L-305"><span class="linenos">305</span></a> <span class="k">return</span> <span class="n">new</span> -</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><span id="L-308"><a href="#L-308"><span class="linenos">308</span></a><span class="k">def</span> <span class="nf">name_sequence</span><span class="p">(</span><span class="n">prefix</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">Callable</span><span class="p">[[],</span> <span class="nb">str</span><span class="p">]:</span> -</span><span id="L-309"><a href="#L-309"><span class="linenos">309</span></a><span class="w"> </span><span class="sd">"""Returns a name generator given a prefix (e.g. a0, a1, a2, ... if the prefix is "a")."""</span> -</span><span id="L-310"><a href="#L-310"><span class="linenos">310</span></a> <span class="n">sequence</span> <span class="o">=</span> <span class="n">count</span><span class="p">()</span> -</span><span id="L-311"><a href="#L-311"><span class="linenos">311</span></a> <span class="k">return</span> <span class="k">lambda</span><span class="p">:</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">prefix</span><span class="si">}{</span><span class="nb">next</span><span class="p">(</span><span class="n">sequence</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span> -</span><span id="L-312"><a href="#L-312"><span class="linenos">312</span></a> +</span><span id="L-284"><a href="#L-284"><span class="linenos">284</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="L-285"><a href="#L-285"><span class="linenos">285</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-286"><a href="#L-286"><span class="linenos">286</span></a> +</span><span id="L-287"><a href="#L-287"><span class="linenos">287</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-288"><a href="#L-288"><span class="linenos">288</span></a> <span class="k">finally</span><span class="p">:</span> +</span><span id="L-289"><a href="#L-289"><span class="linenos">289</span></a> <span class="n">file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> +</span><span id="L-290"><a href="#L-290"><span class="linenos">290</span></a> +</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="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-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"> Searches for a new name.</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"> taken: A collection of taken names.</span> +</span><span id="L-298"><a href="#L-298"><span class="linenos">298</span></a><span class="sd"> base: Base name to alter.</span> +</span><span id="L-299"><a href="#L-299"><span class="linenos">299</span></a> +</span><span id="L-300"><a href="#L-300"><span class="linenos">300</span></a><span class="sd"> Returns:</span> +</span><span id="L-301"><a href="#L-301"><span class="linenos">301</span></a><span class="sd"> The new, available name.</span> +</span><span id="L-302"><a href="#L-302"><span class="linenos">302</span></a><span class="sd"> """</span> +</span><span id="L-303"><a href="#L-303"><span class="linenos">303</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-304"><a href="#L-304"><span class="linenos">304</span></a> <span class="k">return</span> <span class="n">base</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 class="n">i</span> <span class="o">=</span> <span class="mi">2</span> +</span><span id="L-307"><a href="#L-307"><span class="linenos">307</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-308"><a href="#L-308"><span class="linenos">308</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-309"><a href="#L-309"><span class="linenos">309</span></a> <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> +</span><span id="L-310"><a href="#L-310"><span class="linenos">310</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-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">return</span> <span class="n">new</span> </span><span id="L-313"><a href="#L-313"><span class="linenos">313</span></a> -</span><span id="L-314"><a href="#L-314"><span class="linenos">314</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-315"><a href="#L-315"><span class="linenos">315</span></a><span class="w"> </span><span class="sd">"""Returns a dictionary created from an object's attributes."""</span> -</span><span id="L-316"><a href="#L-316"><span class="linenos">316</span></a> <span class="k">return</span> <span class="p">{</span> -</span><span id="L-317"><a href="#L-317"><span class="linenos">317</span></a> <span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="s2">"copy"</span><span class="p">)</span> <span class="k">else</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">items</span><span class="p">()},</span> -</span><span id="L-318"><a href="#L-318"><span class="linenos">318</span></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> -</span><span id="L-319"><a href="#L-319"><span class="linenos">319</span></a> <span class="p">}</span> +</span><span id="L-314"><a href="#L-314"><span class="linenos">314</span></a> +</span><span id="L-315"><a href="#L-315"><span class="linenos">315</span></a><span class="k">def</span> <span class="nf">name_sequence</span><span class="p">(</span><span class="n">prefix</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">Callable</span><span class="p">[[],</span> <span class="nb">str</span><span class="p">]:</span> +</span><span id="L-316"><a href="#L-316"><span class="linenos">316</span></a><span class="w"> </span><span class="sd">"""Returns a name generator given a prefix (e.g. a0, a1, a2, ... if the prefix is "a")."""</span> +</span><span id="L-317"><a href="#L-317"><span class="linenos">317</span></a> <span class="n">sequence</span> <span class="o">=</span> <span class="n">count</span><span class="p">()</span> +</span><span id="L-318"><a href="#L-318"><span class="linenos">318</span></a> <span class="k">return</span> <span class="k">lambda</span><span class="p">:</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">prefix</span><span class="si">}{</span><span class="nb">next</span><span class="p">(</span><span class="n">sequence</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span> +</span><span id="L-319"><a href="#L-319"><span class="linenos">319</span></a> </span><span id="L-320"><a href="#L-320"><span class="linenos">320</span></a> -</span><span id="L-321"><a href="#L-321"><span class="linenos">321</span></a> -</span><span id="L-322"><a href="#L-322"><span class="linenos">322</span></a><span class="k">def</span> <span class="nf">split_num_words</span><span class="p">(</span> -</span><span id="L-323"><a href="#L-323"><span class="linenos">323</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-324"><a href="#L-324"><span class="linenos">324</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-325"><a href="#L-325"><span class="linenos">325</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-326"><a href="#L-326"><span class="linenos">326</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-321"><a href="#L-321"><span class="linenos">321</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-322"><a href="#L-322"><span class="linenos">322</span></a><span class="w"> </span><span class="sd">"""Returns a dictionary created from an object's attributes."""</span> +</span><span id="L-323"><a href="#L-323"><span class="linenos">323</span></a> <span class="k">return</span> <span class="p">{</span> +</span><span id="L-324"><a href="#L-324"><span class="linenos">324</span></a> <span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="s2">"copy"</span><span class="p">)</span> <span class="k">else</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">items</span><span class="p">()},</span> +</span><span id="L-325"><a href="#L-325"><span class="linenos">325</span></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> +</span><span id="L-326"><a href="#L-326"><span class="linenos">326</span></a> <span class="p">}</span> </span><span id="L-327"><a href="#L-327"><span class="linenos">327</span></a> -</span><span id="L-328"><a href="#L-328"><span class="linenos">328</span></a><span class="sd"> Args:</span> -</span><span id="L-329"><a href="#L-329"><span class="linenos">329</span></a><span class="sd"> value: the value to be split.</span> -</span><span id="L-330"><a href="#L-330"><span class="linenos">330</span></a><span class="sd"> sep: the value to use to split on.</span> -</span><span id="L-331"><a href="#L-331"><span class="linenos">331</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-332"><a href="#L-332"><span class="linenos">332</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-333"><a href="#L-333"><span class="linenos">333</span></a> -</span><span id="L-334"><a href="#L-334"><span class="linenos">334</span></a><span class="sd"> Examples:</span> -</span><span id="L-335"><a href="#L-335"><span class="linenos">335</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3)</span> -</span><span id="L-336"><a href="#L-336"><span class="linenos">336</span></a><span class="sd"> [None, 'db', 'table']</span> -</span><span id="L-337"><a href="#L-337"><span class="linenos">337</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3, fill_from_start=False)</span> -</span><span id="L-338"><a href="#L-338"><span class="linenos">338</span></a><span class="sd"> ['db', 'table', None]</span> -</span><span id="L-339"><a href="#L-339"><span class="linenos">339</span></a><span class="sd"> >>> split_num_words("db.table", ".", 1)</span> -</span><span id="L-340"><a href="#L-340"><span class="linenos">340</span></a><span class="sd"> ['db', 'table']</span> -</span><span id="L-341"><a href="#L-341"><span class="linenos">341</span></a> -</span><span id="L-342"><a href="#L-342"><span class="linenos">342</span></a><span class="sd"> Returns:</span> -</span><span id="L-343"><a href="#L-343"><span class="linenos">343</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-344"><a href="#L-344"><span class="linenos">344</span></a><span class="sd"> """</span> -</span><span id="L-345"><a href="#L-345"><span class="linenos">345</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-346"><a href="#L-346"><span class="linenos">346</span></a> <span class="k">if</span> <span class="n">fill_from_start</span><span class="p">:</span> -</span><span id="L-347"><a href="#L-347"><span class="linenos">347</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-348"><a href="#L-348"><span class="linenos">348</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-349"><a href="#L-349"><span class="linenos">349</span></a> -</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="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-352"><a href="#L-352"><span class="linenos">352</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-353"><a href="#L-353"><span class="linenos">353</span></a><span class="sd"> Checks if the value is an iterable, excluding the types `str` and `bytes`.</span> -</span><span id="L-354"><a href="#L-354"><span class="linenos">354</span></a> -</span><span id="L-355"><a href="#L-355"><span class="linenos">355</span></a><span class="sd"> Examples:</span> -</span><span id="L-356"><a href="#L-356"><span class="linenos">356</span></a><span class="sd"> >>> is_iterable([1,2])</span> -</span><span id="L-357"><a href="#L-357"><span class="linenos">357</span></a><span class="sd"> True</span> -</span><span id="L-358"><a href="#L-358"><span class="linenos">358</span></a><span class="sd"> >>> is_iterable("test")</span> -</span><span id="L-359"><a href="#L-359"><span class="linenos">359</span></a><span class="sd"> False</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 class="sd"> Args:</span> -</span><span id="L-362"><a href="#L-362"><span class="linenos">362</span></a><span class="sd"> value: the value to check if it is an iterable.</span> -</span><span id="L-363"><a href="#L-363"><span class="linenos">363</span></a> -</span><span id="L-364"><a href="#L-364"><span class="linenos">364</span></a><span class="sd"> Returns:</span> -</span><span id="L-365"><a href="#L-365"><span class="linenos">365</span></a><span class="sd"> A `bool` value indicating if it is an iterable.</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="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-368"><a href="#L-368"><span class="linenos">368</span></a> -</span><span id="L-369"><a href="#L-369"><span class="linenos">369</span></a> -</span><span id="L-370"><a href="#L-370"><span class="linenos">370</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-371"><a href="#L-371"><span class="linenos">371</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-372"><a href="#L-372"><span class="linenos">372</span></a><span class="sd"> Flattens an iterable that can contain both iterable and non-iterable elements. Objects of</span> -</span><span id="L-373"><a href="#L-373"><span class="linenos">373</span></a><span class="sd"> type `str` and `bytes` are not regarded as iterables.</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"> Examples:</span> -</span><span id="L-376"><a href="#L-376"><span class="linenos">376</span></a><span class="sd"> >>> list(flatten([[1, 2], 3, {4}, (5, "bla")]))</span> -</span><span id="L-377"><a href="#L-377"><span class="linenos">377</span></a><span class="sd"> [1, 2, 3, 4, 5, 'bla']</span> -</span><span id="L-378"><a href="#L-378"><span class="linenos">378</span></a><span class="sd"> >>> list(flatten([1, 2, 3]))</span> -</span><span id="L-379"><a href="#L-379"><span class="linenos">379</span></a><span class="sd"> [1, 2, 3]</span> -</span><span id="L-380"><a href="#L-380"><span class="linenos">380</span></a> -</span><span id="L-381"><a href="#L-381"><span class="linenos">381</span></a><span class="sd"> Args:</span> -</span><span id="L-382"><a href="#L-382"><span class="linenos">382</span></a><span class="sd"> values: the value to be flattened.</span> -</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="sd"> Yields:</span> -</span><span id="L-385"><a href="#L-385"><span class="linenos">385</span></a><span class="sd"> Non-iterable elements in `values`.</span> -</span><span id="L-386"><a href="#L-386"><span class="linenos">386</span></a><span class="sd"> """</span> -</span><span id="L-387"><a href="#L-387"><span class="linenos">387</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-388"><a href="#L-388"><span class="linenos">388</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-389"><a href="#L-389"><span class="linenos">389</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-390"><a href="#L-390"><span class="linenos">390</span></a> <span class="k">else</span><span class="p">:</span> -</span><span id="L-391"><a href="#L-391"><span class="linenos">391</span></a> <span class="k">yield</span> <span class="n">value</span> -</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><span id="L-394"><a href="#L-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="L-395"><a href="#L-395"><span class="linenos">395</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-396"><a href="#L-396"><span class="linenos">396</span></a><span class="sd"> Get the nesting depth of a dictionary.</span> -</span><span id="L-397"><a href="#L-397"><span class="linenos">397</span></a> -</span><span id="L-398"><a href="#L-398"><span class="linenos">398</span></a><span class="sd"> For example:</span> -</span><span id="L-399"><a href="#L-399"><span class="linenos">399</span></a><span class="sd"> >>> dict_depth(None)</span> -</span><span id="L-400"><a href="#L-400"><span class="linenos">400</span></a><span class="sd"> 0</span> -</span><span id="L-401"><a href="#L-401"><span class="linenos">401</span></a><span class="sd"> >>> dict_depth({})</span> -</span><span id="L-402"><a href="#L-402"><span class="linenos">402</span></a><span class="sd"> 1</span> -</span><span id="L-403"><a href="#L-403"><span class="linenos">403</span></a><span class="sd"> >>> dict_depth({"a": "b"})</span> -</span><span id="L-404"><a href="#L-404"><span class="linenos">404</span></a><span class="sd"> 1</span> -</span><span id="L-405"><a href="#L-405"><span class="linenos">405</span></a><span class="sd"> >>> dict_depth({"a": {}})</span> -</span><span id="L-406"><a href="#L-406"><span class="linenos">406</span></a><span class="sd"> 2</span> -</span><span id="L-407"><a href="#L-407"><span class="linenos">407</span></a><span class="sd"> >>> dict_depth({"a": {"b": {}}})</span> -</span><span id="L-408"><a href="#L-408"><span class="linenos">408</span></a><span class="sd"> 3</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 class="sd"> Args:</span> -</span><span id="L-411"><a href="#L-411"><span class="linenos">411</span></a><span class="sd"> d (dict): dictionary</span> -</span><span id="L-412"><a href="#L-412"><span class="linenos">412</span></a> -</span><span id="L-413"><a href="#L-413"><span class="linenos">413</span></a><span class="sd"> Returns:</span> -</span><span id="L-414"><a href="#L-414"><span class="linenos">414</span></a><span class="sd"> int: depth</span> -</span><span id="L-415"><a href="#L-415"><span class="linenos">415</span></a><span class="sd"> """</span> -</span><span id="L-416"><a href="#L-416"><span class="linenos">416</span></a> <span class="k">try</span><span class="p">:</span> -</span><span id="L-417"><a href="#L-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="L-418"><a href="#L-418"><span class="linenos">418</span></a> <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> -</span><span id="L-419"><a href="#L-419"><span class="linenos">419</span></a> <span class="c1"># d doesn't have attribute "values"</span> -</span><span id="L-420"><a href="#L-420"><span class="linenos">420</span></a> <span class="k">return</span> <span class="mi">0</span> -</span><span id="L-421"><a href="#L-421"><span class="linenos">421</span></a> <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span> -</span><span id="L-422"><a href="#L-422"><span class="linenos">422</span></a> <span class="c1"># d.values() returns an empty sequence</span> -</span><span id="L-423"><a href="#L-423"><span class="linenos">423</span></a> <span class="k">return</span> <span class="mi">1</span> -</span><span id="L-424"><a href="#L-424"><span class="linenos">424</span></a> +</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="k">def</span> <span class="nf">split_num_words</span><span class="p">(</span> +</span><span id="L-330"><a href="#L-330"><span class="linenos">330</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-331"><a href="#L-331"><span class="linenos">331</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-332"><a href="#L-332"><span class="linenos">332</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-333"><a href="#L-333"><span class="linenos">333</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-334"><a href="#L-334"><span class="linenos">334</span></a> +</span><span id="L-335"><a href="#L-335"><span class="linenos">335</span></a><span class="sd"> Args:</span> +</span><span id="L-336"><a href="#L-336"><span class="linenos">336</span></a><span class="sd"> value: The value to be split.</span> +</span><span id="L-337"><a href="#L-337"><span class="linenos">337</span></a><span class="sd"> sep: The value to use to split on.</span> +</span><span id="L-338"><a href="#L-338"><span class="linenos">338</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-339"><a href="#L-339"><span class="linenos">339</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-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="sd"> Examples:</span> +</span><span id="L-342"><a href="#L-342"><span class="linenos">342</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3)</span> +</span><span id="L-343"><a href="#L-343"><span class="linenos">343</span></a><span class="sd"> [None, 'db', 'table']</span> +</span><span id="L-344"><a href="#L-344"><span class="linenos">344</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3, fill_from_start=False)</span> +</span><span id="L-345"><a href="#L-345"><span class="linenos">345</span></a><span class="sd"> ['db', 'table', None]</span> +</span><span id="L-346"><a href="#L-346"><span class="linenos">346</span></a><span class="sd"> >>> split_num_words("db.table", ".", 1)</span> +</span><span id="L-347"><a href="#L-347"><span class="linenos">347</span></a><span class="sd"> ['db', 'table']</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"> Returns:</span> +</span><span id="L-350"><a href="#L-350"><span class="linenos">350</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-351"><a href="#L-351"><span class="linenos">351</span></a><span class="sd"> """</span> +</span><span id="L-352"><a href="#L-352"><span class="linenos">352</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-353"><a href="#L-353"><span class="linenos">353</span></a> <span class="k">if</span> <span class="n">fill_from_start</span><span class="p">:</span> +</span><span id="L-354"><a href="#L-354"><span class="linenos">354</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-355"><a href="#L-355"><span class="linenos">355</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-356"><a href="#L-356"><span class="linenos">356</span></a> +</span><span id="L-357"><a href="#L-357"><span class="linenos">357</span></a> +</span><span id="L-358"><a href="#L-358"><span class="linenos">358</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-359"><a href="#L-359"><span class="linenos">359</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-360"><a href="#L-360"><span class="linenos">360</span></a><span class="sd"> Checks if the value is an iterable, excluding the types `str` and `bytes`.</span> +</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="sd"> Examples:</span> +</span><span id="L-363"><a href="#L-363"><span class="linenos">363</span></a><span class="sd"> >>> is_iterable([1,2])</span> +</span><span id="L-364"><a href="#L-364"><span class="linenos">364</span></a><span class="sd"> True</span> +</span><span id="L-365"><a href="#L-365"><span class="linenos">365</span></a><span class="sd"> >>> is_iterable("test")</span> +</span><span id="L-366"><a href="#L-366"><span class="linenos">366</span></a><span class="sd"> False</span> +</span><span id="L-367"><a href="#L-367"><span class="linenos">367</span></a> +</span><span id="L-368"><a href="#L-368"><span class="linenos">368</span></a><span class="sd"> Args:</span> +</span><span id="L-369"><a href="#L-369"><span class="linenos">369</span></a><span class="sd"> value: The value to check if it is an iterable.</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="sd"> Returns:</span> +</span><span id="L-372"><a href="#L-372"><span class="linenos">372</span></a><span class="sd"> A `bool` value indicating if it is an iterable.</span> +</span><span id="L-373"><a href="#L-373"><span class="linenos">373</span></a><span class="sd"> """</span> +</span><span id="L-374"><a href="#L-374"><span class="linenos">374</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-375"><a href="#L-375"><span class="linenos">375</span></a> +</span><span id="L-376"><a href="#L-376"><span class="linenos">376</span></a> +</span><span id="L-377"><a href="#L-377"><span class="linenos">377</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-378"><a href="#L-378"><span class="linenos">378</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-379"><a href="#L-379"><span class="linenos">379</span></a><span class="sd"> Flattens an iterable that can contain both iterable and non-iterable elements. Objects of</span> +</span><span id="L-380"><a href="#L-380"><span class="linenos">380</span></a><span class="sd"> type `str` and `bytes` are not regarded as iterables.</span> +</span><span id="L-381"><a href="#L-381"><span class="linenos">381</span></a> +</span><span id="L-382"><a href="#L-382"><span class="linenos">382</span></a><span class="sd"> Examples:</span> +</span><span id="L-383"><a href="#L-383"><span class="linenos">383</span></a><span class="sd"> >>> list(flatten([[1, 2], 3, {4}, (5, "bla")]))</span> +</span><span id="L-384"><a href="#L-384"><span class="linenos">384</span></a><span class="sd"> [1, 2, 3, 4, 5, 'bla']</span> +</span><span id="L-385"><a href="#L-385"><span class="linenos">385</span></a><span class="sd"> >>> list(flatten([1, 2, 3]))</span> +</span><span id="L-386"><a href="#L-386"><span class="linenos">386</span></a><span class="sd"> [1, 2, 3]</span> +</span><span id="L-387"><a href="#L-387"><span class="linenos">387</span></a> +</span><span id="L-388"><a href="#L-388"><span class="linenos">388</span></a><span class="sd"> Args:</span> +</span><span id="L-389"><a href="#L-389"><span class="linenos">389</span></a><span class="sd"> values: The value to be flattened.</span> +</span><span id="L-390"><a href="#L-390"><span class="linenos">390</span></a> +</span><span id="L-391"><a href="#L-391"><span class="linenos">391</span></a><span class="sd"> Yields:</span> +</span><span id="L-392"><a href="#L-392"><span class="linenos">392</span></a><span class="sd"> Non-iterable elements in `values`.</span> +</span><span id="L-393"><a href="#L-393"><span class="linenos">393</span></a><span class="sd"> """</span> +</span><span id="L-394"><a href="#L-394"><span class="linenos">394</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-395"><a href="#L-395"><span class="linenos">395</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-396"><a href="#L-396"><span class="linenos">396</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-397"><a href="#L-397"><span class="linenos">397</span></a> <span class="k">else</span><span class="p">:</span> +</span><span id="L-398"><a href="#L-398"><span class="linenos">398</span></a> <span class="k">yield</span> <span class="n">value</span> +</span><span id="L-399"><a href="#L-399"><span class="linenos">399</span></a> +</span><span id="L-400"><a href="#L-400"><span class="linenos">400</span></a> +</span><span id="L-401"><a href="#L-401"><span class="linenos">401</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-402"><a href="#L-402"><span class="linenos">402</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-403"><a href="#L-403"><span class="linenos">403</span></a><span class="sd"> Get the nesting depth of a dictionary.</span> +</span><span id="L-404"><a href="#L-404"><span class="linenos">404</span></a> +</span><span id="L-405"><a href="#L-405"><span class="linenos">405</span></a><span class="sd"> Example:</span> +</span><span id="L-406"><a href="#L-406"><span class="linenos">406</span></a><span class="sd"> >>> dict_depth(None)</span> +</span><span id="L-407"><a href="#L-407"><span class="linenos">407</span></a><span class="sd"> 0</span> +</span><span id="L-408"><a href="#L-408"><span class="linenos">408</span></a><span class="sd"> >>> dict_depth({})</span> +</span><span id="L-409"><a href="#L-409"><span class="linenos">409</span></a><span class="sd"> 1</span> +</span><span id="L-410"><a href="#L-410"><span class="linenos">410</span></a><span class="sd"> >>> dict_depth({"a": "b"})</span> +</span><span id="L-411"><a href="#L-411"><span class="linenos">411</span></a><span class="sd"> 1</span> +</span><span id="L-412"><a href="#L-412"><span class="linenos">412</span></a><span class="sd"> >>> dict_depth({"a": {}})</span> +</span><span id="L-413"><a href="#L-413"><span class="linenos">413</span></a><span class="sd"> 2</span> +</span><span id="L-414"><a href="#L-414"><span class="linenos">414</span></a><span class="sd"> >>> dict_depth({"a": {"b": {}}})</span> +</span><span id="L-415"><a href="#L-415"><span class="linenos">415</span></a><span class="sd"> 3</span> +</span><span id="L-416"><a href="#L-416"><span class="linenos">416</span></a><span class="sd"> """</span> +</span><span id="L-417"><a href="#L-417"><span class="linenos">417</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="L-418"><a href="#L-418"><span class="linenos">418</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-419"><a href="#L-419"><span class="linenos">419</span></a> <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> +</span><span id="L-420"><a href="#L-420"><span class="linenos">420</span></a> <span class="c1"># d doesn't have attribute "values"</span> +</span><span id="L-421"><a href="#L-421"><span class="linenos">421</span></a> <span class="k">return</span> <span class="mi">0</span> +</span><span id="L-422"><a href="#L-422"><span class="linenos">422</span></a> <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span> +</span><span id="L-423"><a href="#L-423"><span class="linenos">423</span></a> <span class="c1"># d.values() returns an empty sequence</span> +</span><span id="L-424"><a href="#L-424"><span class="linenos">424</span></a> <span class="k">return</span> <span class="mi">1</span> </span><span id="L-425"><a href="#L-425"><span class="linenos">425</span></a> -</span><span id="L-426"><a href="#L-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="L-427"><a href="#L-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="L-428"><a href="#L-428"><span class="linenos">428</span></a> -</span><span id="L-429"><a href="#L-429"><span class="linenos">429</span></a><span class="sd"> Useful for sets.</span> -</span><span id="L-430"><a href="#L-430"><span class="linenos">430</span></a><span class="sd"> """</span> -</span><span id="L-431"><a href="#L-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><span id="L-426"><a href="#L-426"><span class="linenos">426</span></a> +</span><span id="L-427"><a href="#L-427"><span class="linenos">427</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-428"><a href="#L-428"><span class="linenos">428</span></a><span class="w"> </span><span class="sd">"""Returns the first element from an iterable (useful for sets)."""</span> +</span><span id="L-429"><a href="#L-429"><span class="linenos">429</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> </section> + <section id="CAMEL_CASE_PATTERN"> + <div class="attr variable"> + <span class="name">CAMEL_CASE_PATTERN</span> = +<span class="default_value">re.compile('(?<!^)(?=[A-Z])')</span> + + + </div> + <a class="headerlink" href="#CAMEL_CASE_PATTERN"></a> + + + + </section> + <section id="PYTHON_VERSION"> + <div class="attr variable"> + <span class="name">PYTHON_VERSION</span> = +<span class="default_value">(3, 10)</span> + + + </div> + <a class="headerlink" href="#PYTHON_VERSION"></a> + + + + </section> + <section id="logger"> + <div class="attr variable"> + <span class="name">logger</span> = +<span class="default_value"><Logger sqlglot (WARNING)></span> + + + </div> + <a class="headerlink" href="#logger"></a> + + + + </section> <section id="AutoName"> <input id="AutoName-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1"> <div class="attr class"> @@ -563,14 +606,22 @@ </div> <a class="headerlink" href="#AutoName"></a> <div class="pdoc-code codehilite"><pre><span></span><span id="AutoName-25"><a href="#AutoName-25"><span class="linenos">25</span></a><span class="k">class</span> <span class="nc">AutoName</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span> -</span><span id="AutoName-26"><a href="#AutoName-26"><span class="linenos">26</span></a><span class="w"> </span><span class="sd">"""This is used for creating enum classes where `auto()` is the string form of the corresponding value's name."""</span> -</span><span id="AutoName-27"><a href="#AutoName-27"><span class="linenos">27</span></a> -</span><span id="AutoName-28"><a href="#AutoName-28"><span class="linenos">28</span></a> <span class="k">def</span> <span class="nf">_generate_next_value_</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">_start</span><span class="p">,</span> <span class="n">_count</span><span class="p">,</span> <span class="n">_last_values</span><span class="p">):</span> -</span><span id="AutoName-29"><a href="#AutoName-29"><span class="linenos">29</span></a> <span class="k">return</span> <span class="n">name</span> +</span><span id="AutoName-26"><a href="#AutoName-26"><span class="linenos">26</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="AutoName-27"><a href="#AutoName-27"><span class="linenos">27</span></a><span class="sd"> This is used for creating Enum classes where `auto()` is the string form</span> +</span><span id="AutoName-28"><a href="#AutoName-28"><span class="linenos">28</span></a><span class="sd"> of the corresponding enum's identifier (e.g. FOO.value results in "FOO").</span> +</span><span id="AutoName-29"><a href="#AutoName-29"><span class="linenos">29</span></a> +</span><span id="AutoName-30"><a href="#AutoName-30"><span class="linenos">30</span></a><span class="sd"> Reference: https://docs.python.org/3/howto/enum.html#using-automatic-values</span> +</span><span id="AutoName-31"><a href="#AutoName-31"><span class="linenos">31</span></a><span class="sd"> """</span> +</span><span id="AutoName-32"><a href="#AutoName-32"><span class="linenos">32</span></a> +</span><span id="AutoName-33"><a href="#AutoName-33"><span class="linenos">33</span></a> <span class="k">def</span> <span class="nf">_generate_next_value_</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">_start</span><span class="p">,</span> <span class="n">_count</span><span class="p">,</span> <span class="n">_last_values</span><span class="p">):</span> +</span><span id="AutoName-34"><a href="#AutoName-34"><span class="linenos">34</span></a> <span class="k">return</span> <span class="n">name</span> </span></pre></div> - <div class="docstring"><p>This is used for creating enum classes where <code>auto()</code> is the string form of the corresponding value's name.</p> + <div class="docstring"><p>This is used for creating Enum classes where <code>auto()</code> is the string form +of the corresponding enum's identifier (e.g. FOO.value results in "FOO").</p> + +<p>Reference: <a href="https://docs.python.org/3/howto/enum.html#using-automatic-values">https://docs.python.org/3/howto/enum.html#using-automatic-values</a></p> </div> @@ -596,12 +647,12 @@ </div> <a class="headerlink" href="#seq_get"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="seq_get-32"><a href="#seq_get-32"><span class="linenos">32</span></a><span class="k">def</span> <span class="nf">seq_get</span><span class="p">(</span><span class="n">seq</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="p">],</span> <span class="n">index</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">Optional</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> -</span><span id="seq_get-33"><a href="#seq_get-33"><span class="linenos">33</span></a><span class="w"> </span><span class="sd">"""Returns the value in `seq` at position `index`, or `None` if `index` is out of bounds."""</span> -</span><span id="seq_get-34"><a href="#seq_get-34"><span class="linenos">34</span></a> <span class="k">try</span><span class="p">:</span> -</span><span id="seq_get-35"><a href="#seq_get-35"><span class="linenos">35</span></a> <span class="k">return</span> <span class="n">seq</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> -</span><span id="seq_get-36"><a href="#seq_get-36"><span class="linenos">36</span></a> <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span> -</span><span id="seq_get-37"><a href="#seq_get-37"><span class="linenos">37</span></a> <span class="k">return</span> <span class="kc">None</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="seq_get-37"><a href="#seq_get-37"><span class="linenos">37</span></a><span class="k">def</span> <span class="nf">seq_get</span><span class="p">(</span><span class="n">seq</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="p">],</span> <span class="n">index</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">Optional</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span> +</span><span id="seq_get-38"><a href="#seq_get-38"><span class="linenos">38</span></a><span class="w"> </span><span class="sd">"""Returns the value in `seq` at position `index`, or `None` if `index` is out of bounds."""</span> +</span><span id="seq_get-39"><a href="#seq_get-39"><span class="linenos">39</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="seq_get-40"><a href="#seq_get-40"><span class="linenos">40</span></a> <span class="k">return</span> <span class="n">seq</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> +</span><span id="seq_get-41"><a href="#seq_get-41"><span class="linenos">41</span></a> <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span> +</span><span id="seq_get-42"><a href="#seq_get-42"><span class="linenos">42</span></a> <span class="k">return</span> <span class="kc">None</span> </span></pre></div> @@ -621,22 +672,22 @@ </div> <a class="headerlink" href="#ensure_list"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="ensure_list-50"><a href="#ensure_list-50"><span class="linenos">50</span></a><span class="k">def</span> <span class="nf">ensure_list</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> -</span><span id="ensure_list-51"><a href="#ensure_list-51"><span class="linenos">51</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="ensure_list-52"><a href="#ensure_list-52"><span class="linenos">52</span></a><span class="sd"> Ensures that a value is a list, otherwise casts or wraps it into one.</span> -</span><span id="ensure_list-53"><a href="#ensure_list-53"><span class="linenos">53</span></a> -</span><span id="ensure_list-54"><a href="#ensure_list-54"><span class="linenos">54</span></a><span class="sd"> Args:</span> -</span><span id="ensure_list-55"><a href="#ensure_list-55"><span class="linenos">55</span></a><span class="sd"> value: the value of interest.</span> -</span><span id="ensure_list-56"><a href="#ensure_list-56"><span class="linenos">56</span></a> -</span><span id="ensure_list-57"><a href="#ensure_list-57"><span class="linenos">57</span></a><span class="sd"> Returns:</span> -</span><span id="ensure_list-58"><a href="#ensure_list-58"><span class="linenos">58</span></a><span class="sd"> The value cast as a list if it's a list or a tuple, or else the value wrapped in a list.</span> -</span><span id="ensure_list-59"><a href="#ensure_list-59"><span class="linenos">59</span></a><span class="sd"> """</span> -</span><span id="ensure_list-60"><a href="#ensure_list-60"><span class="linenos">60</span></a> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> -</span><span id="ensure_list-61"><a href="#ensure_list-61"><span class="linenos">61</span></a> <span class="k">return</span> <span class="p">[]</span> -</span><span id="ensure_list-62"><a href="#ensure_list-62"><span class="linenos">62</span></a> <span class="k">if</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">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span> -</span><span id="ensure_list-63"><a href="#ensure_list-63"><span class="linenos">63</span></a> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> -</span><span id="ensure_list-64"><a href="#ensure_list-64"><span class="linenos">64</span></a> -</span><span id="ensure_list-65"><a href="#ensure_list-65"><span class="linenos">65</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">value</span><span class="p">]</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="ensure_list-55"><a href="#ensure_list-55"><span class="linenos">55</span></a><span class="k">def</span> <span class="nf">ensure_list</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> +</span><span id="ensure_list-56"><a href="#ensure_list-56"><span class="linenos">56</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="ensure_list-57"><a href="#ensure_list-57"><span class="linenos">57</span></a><span class="sd"> Ensures that a value is a list, otherwise casts or wraps it into one.</span> +</span><span id="ensure_list-58"><a href="#ensure_list-58"><span class="linenos">58</span></a> +</span><span id="ensure_list-59"><a href="#ensure_list-59"><span class="linenos">59</span></a><span class="sd"> Args:</span> +</span><span id="ensure_list-60"><a href="#ensure_list-60"><span class="linenos">60</span></a><span class="sd"> value: The value of interest.</span> +</span><span id="ensure_list-61"><a href="#ensure_list-61"><span class="linenos">61</span></a> +</span><span id="ensure_list-62"><a href="#ensure_list-62"><span class="linenos">62</span></a><span class="sd"> Returns:</span> +</span><span id="ensure_list-63"><a href="#ensure_list-63"><span class="linenos">63</span></a><span class="sd"> The value cast as a list if it's a list or a tuple, or else the value wrapped in a list.</span> +</span><span id="ensure_list-64"><a href="#ensure_list-64"><span class="linenos">64</span></a><span class="sd"> """</span> +</span><span id="ensure_list-65"><a href="#ensure_list-65"><span class="linenos">65</span></a> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> +</span><span id="ensure_list-66"><a href="#ensure_list-66"><span class="linenos">66</span></a> <span class="k">return</span> <span class="p">[]</span> +</span><span id="ensure_list-67"><a href="#ensure_list-67"><span class="linenos">67</span></a> <span class="k">if</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">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span> +</span><span id="ensure_list-68"><a href="#ensure_list-68"><span class="linenos">68</span></a> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> +</span><span id="ensure_list-69"><a href="#ensure_list-69"><span class="linenos">69</span></a> +</span><span id="ensure_list-70"><a href="#ensure_list-70"><span class="linenos">70</span></a> <span class="k">return</span> <span class="p">[</span><span class="n">value</span><span class="p">]</span> </span></pre></div> @@ -645,7 +696,7 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>value:</strong> the value of interest.</li> +<li><strong>value:</strong> The value of interest.</li> </ul> <h6 id="returns">Returns:</h6> @@ -668,21 +719,21 @@ </div> <a class="headerlink" href="#ensure_collection"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="ensure_collection-78"><a href="#ensure_collection-78"><span class="linenos">78</span></a><span class="k">def</span> <span class="nf">ensure_collection</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> -</span><span id="ensure_collection-79"><a href="#ensure_collection-79"><span class="linenos">79</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="ensure_collection-80"><a href="#ensure_collection-80"><span class="linenos">80</span></a><span class="sd"> Ensures that a value is a collection (excluding `str` and `bytes`), otherwise wraps it into a list.</span> -</span><span id="ensure_collection-81"><a href="#ensure_collection-81"><span class="linenos">81</span></a> -</span><span id="ensure_collection-82"><a href="#ensure_collection-82"><span class="linenos">82</span></a><span class="sd"> Args:</span> -</span><span id="ensure_collection-83"><a href="#ensure_collection-83"><span class="linenos">83</span></a><span class="sd"> value: the value of interest.</span> -</span><span id="ensure_collection-84"><a href="#ensure_collection-84"><span class="linenos">84</span></a> -</span><span id="ensure_collection-85"><a href="#ensure_collection-85"><span class="linenos">85</span></a><span class="sd"> Returns:</span> -</span><span id="ensure_collection-86"><a href="#ensure_collection-86"><span class="linenos">86</span></a><span class="sd"> The value if it's a collection, or else the value wrapped in a list.</span> -</span><span id="ensure_collection-87"><a href="#ensure_collection-87"><span class="linenos">87</span></a><span class="sd"> """</span> -</span><span id="ensure_collection-88"><a href="#ensure_collection-88"><span class="linenos">88</span></a> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> -</span><span id="ensure_collection-89"><a href="#ensure_collection-89"><span class="linenos">89</span></a> <span class="k">return</span> <span class="p">[]</span> -</span><span id="ensure_collection-90"><a href="#ensure_collection-90"><span class="linenos">90</span></a> <span class="k">return</span> <span class="p">(</span> -</span><span id="ensure_collection-91"><a href="#ensure_collection-91"><span class="linenos">91</span></a> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Collection</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 class="k">else</span> <span class="p">[</span><span class="n">value</span><span class="p">]</span> -</span><span id="ensure_collection-92"><a href="#ensure_collection-92"><span class="linenos">92</span></a> <span class="p">)</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="ensure_collection-83"><a href="#ensure_collection-83"><span class="linenos">83</span></a><span class="k">def</span> <span class="nf">ensure_collection</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> +</span><span id="ensure_collection-84"><a href="#ensure_collection-84"><span class="linenos">84</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="ensure_collection-85"><a href="#ensure_collection-85"><span class="linenos">85</span></a><span class="sd"> Ensures that a value is a collection (excluding `str` and `bytes`), otherwise wraps it into a list.</span> +</span><span id="ensure_collection-86"><a href="#ensure_collection-86"><span class="linenos">86</span></a> +</span><span id="ensure_collection-87"><a href="#ensure_collection-87"><span class="linenos">87</span></a><span class="sd"> Args:</span> +</span><span id="ensure_collection-88"><a href="#ensure_collection-88"><span class="linenos">88</span></a><span class="sd"> value: The value of interest.</span> +</span><span id="ensure_collection-89"><a href="#ensure_collection-89"><span class="linenos">89</span></a> +</span><span id="ensure_collection-90"><a href="#ensure_collection-90"><span class="linenos">90</span></a><span class="sd"> Returns:</span> +</span><span id="ensure_collection-91"><a href="#ensure_collection-91"><span class="linenos">91</span></a><span class="sd"> The value if it's a collection, or else the value wrapped in a list.</span> +</span><span id="ensure_collection-92"><a href="#ensure_collection-92"><span class="linenos">92</span></a><span class="sd"> """</span> +</span><span id="ensure_collection-93"><a href="#ensure_collection-93"><span class="linenos">93</span></a> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> +</span><span id="ensure_collection-94"><a href="#ensure_collection-94"><span class="linenos">94</span></a> <span class="k">return</span> <span class="p">[]</span> +</span><span id="ensure_collection-95"><a href="#ensure_collection-95"><span class="linenos">95</span></a> <span class="k">return</span> <span class="p">(</span> +</span><span id="ensure_collection-96"><a href="#ensure_collection-96"><span class="linenos">96</span></a> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Collection</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 class="k">else</span> <span class="p">[</span><span class="n">value</span><span class="p">]</span> +</span><span id="ensure_collection-97"><a href="#ensure_collection-97"><span class="linenos">97</span></a> <span class="p">)</span> </span></pre></div> @@ -691,7 +742,7 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>value:</strong> the value of interest.</li> +<li><strong>value:</strong> The value of interest.</li> </ul> <h6 id="returns">Returns:</h6> @@ -714,18 +765,18 @@ </div> <a class="headerlink" href="#csv"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="csv-95"><a href="#csv-95"><span class="linenos"> 95</span></a><span class="k">def</span> <span class="nf">csv</span><span class="p">(</span><span class="o">*</span><span class="n">args</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="o">=</span> <span class="s2">", "</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> -</span><span id="csv-96"><a href="#csv-96"><span class="linenos"> 96</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="csv-97"><a href="#csv-97"><span class="linenos"> 97</span></a><span class="sd"> Formats any number of string arguments as CSV.</span> -</span><span id="csv-98"><a href="#csv-98"><span class="linenos"> 98</span></a> -</span><span id="csv-99"><a href="#csv-99"><span class="linenos"> 99</span></a><span class="sd"> Args:</span> -</span><span id="csv-100"><a href="#csv-100"><span class="linenos">100</span></a><span class="sd"> args: the string arguments to format.</span> -</span><span id="csv-101"><a href="#csv-101"><span class="linenos">101</span></a><span class="sd"> sep: the argument separator.</span> -</span><span id="csv-102"><a href="#csv-102"><span class="linenos">102</span></a> -</span><span id="csv-103"><a href="#csv-103"><span class="linenos">103</span></a><span class="sd"> Returns:</span> -</span><span id="csv-104"><a href="#csv-104"><span class="linenos">104</span></a><span class="sd"> The arguments formatted as a CSV string.</span> -</span><span id="csv-105"><a href="#csv-105"><span class="linenos">105</span></a><span class="sd"> """</span> -</span><span id="csv-106"><a href="#csv-106"><span class="linenos">106</span></a> <span class="k">return</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">arg</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span> <span class="k">if</span> <span class="n">arg</span><span class="p">)</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="csv-100"><a href="#csv-100"><span class="linenos">100</span></a><span class="k">def</span> <span class="nf">csv</span><span class="p">(</span><span class="o">*</span><span class="n">args</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="o">=</span> <span class="s2">", "</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> +</span><span id="csv-101"><a href="#csv-101"><span class="linenos">101</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="csv-102"><a href="#csv-102"><span class="linenos">102</span></a><span class="sd"> Formats any number of string arguments as CSV.</span> +</span><span id="csv-103"><a href="#csv-103"><span class="linenos">103</span></a> +</span><span id="csv-104"><a href="#csv-104"><span class="linenos">104</span></a><span class="sd"> Args:</span> +</span><span id="csv-105"><a href="#csv-105"><span class="linenos">105</span></a><span class="sd"> args: The string arguments to format.</span> +</span><span id="csv-106"><a href="#csv-106"><span class="linenos">106</span></a><span class="sd"> sep: The argument separator.</span> +</span><span id="csv-107"><a href="#csv-107"><span class="linenos">107</span></a> +</span><span id="csv-108"><a href="#csv-108"><span class="linenos">108</span></a><span class="sd"> Returns:</span> +</span><span id="csv-109"><a href="#csv-109"><span class="linenos">109</span></a><span class="sd"> The arguments formatted as a CSV string.</span> +</span><span id="csv-110"><a href="#csv-110"><span class="linenos">110</span></a><span class="sd"> """</span> +</span><span id="csv-111"><a href="#csv-111"><span class="linenos">111</span></a> <span class="k">return</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">arg</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span> <span class="k">if</span> <span class="n">arg</span><span class="p">)</span> </span></pre></div> @@ -734,8 +785,8 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>args:</strong> the string arguments to format.</li> -<li><strong>sep:</strong> the argument separator.</li> +<li><strong>args:</strong> The string arguments to format.</li> +<li><strong>sep:</strong> The argument separator.</li> </ul> <h6 id="returns">Returns:</h6> @@ -758,29 +809,29 @@ </div> <a class="headerlink" href="#subclasses"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="subclasses-109"><a href="#subclasses-109"><span class="linenos">109</span></a><span class="k">def</span> <span class="nf">subclasses</span><span class="p">(</span> -</span><span id="subclasses-110"><a href="#subclasses-110"><span class="linenos">110</span></a> <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> -</span><span id="subclasses-111"><a href="#subclasses-111"><span class="linenos">111</span></a> <span class="n">classes</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Type</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Type</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span> -</span><span id="subclasses-112"><a href="#subclasses-112"><span class="linenos">112</span></a> <span class="n">exclude</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Type</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Type</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(),</span> -</span><span id="subclasses-113"><a href="#subclasses-113"><span class="linenos">113</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">Type</span><span class="p">]:</span> -</span><span id="subclasses-114"><a href="#subclasses-114"><span class="linenos">114</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="subclasses-115"><a href="#subclasses-115"><span class="linenos">115</span></a><span class="sd"> Returns all subclasses for a collection of classes, possibly excluding some of them.</span> -</span><span id="subclasses-116"><a href="#subclasses-116"><span class="linenos">116</span></a> -</span><span id="subclasses-117"><a href="#subclasses-117"><span class="linenos">117</span></a><span class="sd"> Args:</span> -</span><span id="subclasses-118"><a href="#subclasses-118"><span class="linenos">118</span></a><span class="sd"> module_name: the name of the module to search for subclasses in.</span> -</span><span id="subclasses-119"><a href="#subclasses-119"><span class="linenos">119</span></a><span class="sd"> classes: class(es) we want to find the subclasses of.</span> -</span><span id="subclasses-120"><a href="#subclasses-120"><span class="linenos">120</span></a><span class="sd"> exclude: class(es) we want to exclude from the returned list.</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="subclasses-114"><a href="#subclasses-114"><span class="linenos">114</span></a><span class="k">def</span> <span class="nf">subclasses</span><span class="p">(</span> +</span><span id="subclasses-115"><a href="#subclasses-115"><span class="linenos">115</span></a> <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> +</span><span id="subclasses-116"><a href="#subclasses-116"><span class="linenos">116</span></a> <span class="n">classes</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Type</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Type</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span> +</span><span id="subclasses-117"><a href="#subclasses-117"><span class="linenos">117</span></a> <span class="n">exclude</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Type</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Type</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(),</span> +</span><span id="subclasses-118"><a href="#subclasses-118"><span class="linenos">118</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">Type</span><span class="p">]:</span> +</span><span id="subclasses-119"><a href="#subclasses-119"><span class="linenos">119</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="subclasses-120"><a href="#subclasses-120"><span class="linenos">120</span></a><span class="sd"> Returns all subclasses for a collection of classes, possibly excluding some of them.</span> </span><span id="subclasses-121"><a href="#subclasses-121"><span class="linenos">121</span></a> -</span><span id="subclasses-122"><a href="#subclasses-122"><span class="linenos">122</span></a><span class="sd"> Returns:</span> -</span><span id="subclasses-123"><a href="#subclasses-123"><span class="linenos">123</span></a><span class="sd"> The target subclasses.</span> -</span><span id="subclasses-124"><a href="#subclasses-124"><span class="linenos">124</span></a><span class="sd"> """</span> -</span><span id="subclasses-125"><a href="#subclasses-125"><span class="linenos">125</span></a> <span class="k">return</span> <span class="p">[</span> -</span><span id="subclasses-126"><a href="#subclasses-126"><span class="linenos">126</span></a> <span class="n">obj</span> -</span><span id="subclasses-127"><a href="#subclasses-127"><span class="linenos">127</span></a> <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getmembers</span><span class="p">(</span> -</span><span id="subclasses-128"><a href="#subclasses-128"><span class="linenos">128</span></a> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">module_name</span><span class="p">],</span> -</span><span id="subclasses-129"><a href="#subclasses-129"><span class="linenos">129</span></a> <span class="k">lambda</span> <span class="n">obj</span><span class="p">:</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">classes</span><span class="p">)</span> <span class="ow">and</span> <span class="n">obj</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">exclude</span><span class="p">,</span> -</span><span id="subclasses-130"><a href="#subclasses-130"><span class="linenos">130</span></a> <span class="p">)</span> -</span><span id="subclasses-131"><a href="#subclasses-131"><span class="linenos">131</span></a> <span class="p">]</span> +</span><span id="subclasses-122"><a href="#subclasses-122"><span class="linenos">122</span></a><span class="sd"> Args:</span> +</span><span id="subclasses-123"><a href="#subclasses-123"><span class="linenos">123</span></a><span class="sd"> module_name: The name of the module to search for subclasses in.</span> +</span><span id="subclasses-124"><a href="#subclasses-124"><span class="linenos">124</span></a><span class="sd"> classes: Class(es) we want to find the subclasses of.</span> +</span><span id="subclasses-125"><a href="#subclasses-125"><span class="linenos">125</span></a><span class="sd"> exclude: Class(es) we want to exclude from the returned list.</span> +</span><span id="subclasses-126"><a href="#subclasses-126"><span class="linenos">126</span></a> +</span><span id="subclasses-127"><a href="#subclasses-127"><span class="linenos">127</span></a><span class="sd"> Returns:</span> +</span><span id="subclasses-128"><a href="#subclasses-128"><span class="linenos">128</span></a><span class="sd"> The target subclasses.</span> +</span><span id="subclasses-129"><a href="#subclasses-129"><span class="linenos">129</span></a><span class="sd"> """</span> +</span><span id="subclasses-130"><a href="#subclasses-130"><span class="linenos">130</span></a> <span class="k">return</span> <span class="p">[</span> +</span><span id="subclasses-131"><a href="#subclasses-131"><span class="linenos">131</span></a> <span class="n">obj</span> +</span><span id="subclasses-132"><a href="#subclasses-132"><span class="linenos">132</span></a> <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getmembers</span><span class="p">(</span> +</span><span id="subclasses-133"><a href="#subclasses-133"><span class="linenos">133</span></a> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">module_name</span><span class="p">],</span> +</span><span id="subclasses-134"><a href="#subclasses-134"><span class="linenos">134</span></a> <span class="k">lambda</span> <span class="n">obj</span><span class="p">:</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">classes</span><span class="p">)</span> <span class="ow">and</span> <span class="n">obj</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">exclude</span><span class="p">,</span> +</span><span id="subclasses-135"><a href="#subclasses-135"><span class="linenos">135</span></a> <span class="p">)</span> +</span><span id="subclasses-136"><a href="#subclasses-136"><span class="linenos">136</span></a> <span class="p">]</span> </span></pre></div> @@ -789,9 +840,9 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>module_name:</strong> the name of the module to search for subclasses in.</li> -<li><strong>classes:</strong> class(es) we want to find the subclasses of.</li> -<li><strong>exclude:</strong> class(es) we want to exclude from the returned list.</li> +<li><strong>module_name:</strong> The name of the module to search for subclasses in.</li> +<li><strong>classes:</strong> Class(es) we want to find the subclasses of.</li> +<li><strong>exclude:</strong> Class(es) we want to exclude from the returned list.</li> </ul> <h6 id="returns">Returns:</h6> @@ -814,52 +865,52 @@ </div> <a class="headerlink" href="#apply_index_offset"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="apply_index_offset-134"><a href="#apply_index_offset-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="apply_index_offset-135"><a href="#apply_index_offset-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="apply_index_offset-136"><a href="#apply_index_offset-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="apply_index_offset-137"><a href="#apply_index_offset-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="apply_index_offset-138"><a href="#apply_index_offset-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="apply_index_offset-139"><a href="#apply_index_offset-139"><span class="linenos">139</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="apply_index_offset-140"><a href="#apply_index_offset-140"><span class="linenos">140</span></a><span class="sd"> Applies an offset to a given integer literal expression.</span> -</span><span id="apply_index_offset-141"><a href="#apply_index_offset-141"><span class="linenos">141</span></a> -</span><span id="apply_index_offset-142"><a href="#apply_index_offset-142"><span class="linenos">142</span></a><span class="sd"> Args:</span> -</span><span id="apply_index_offset-143"><a href="#apply_index_offset-143"><span class="linenos">143</span></a><span class="sd"> this: the target of the index</span> -</span><span id="apply_index_offset-144"><a href="#apply_index_offset-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="apply_index_offset-145"><a href="#apply_index_offset-145"><span class="linenos">145</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-139"><a href="#apply_index_offset-139"><span class="linenos">139</span></a><span class="k">def</span> <span class="nf">apply_index_offset</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="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-141"><a href="#apply_index_offset-141"><span class="linenos">141</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-142"><a href="#apply_index_offset-142"><span class="linenos">142</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-143"><a href="#apply_index_offset-143"><span class="linenos">143</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-144"><a href="#apply_index_offset-144"><span class="linenos">144</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="apply_index_offset-145"><a href="#apply_index_offset-145"><span class="linenos">145</span></a><span class="sd"> Applies an offset to a given integer literal expression.</span> </span><span id="apply_index_offset-146"><a href="#apply_index_offset-146"><span class="linenos">146</span></a> -</span><span id="apply_index_offset-147"><a href="#apply_index_offset-147"><span class="linenos">147</span></a><span class="sd"> Returns:</span> -</span><span id="apply_index_offset-148"><a href="#apply_index_offset-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="apply_index_offset-149"><a href="#apply_index_offset-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="apply_index_offset-150"><a href="#apply_index_offset-150"><span class="linenos">150</span></a><span class="sd"> """</span> -</span><span id="apply_index_offset-151"><a href="#apply_index_offset-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="apply_index_offset-152"><a href="#apply_index_offset-152"><span class="linenos">152</span></a> <span class="k">return</span> <span class="n">expressions</span> -</span><span id="apply_index_offset-153"><a href="#apply_index_offset-153"><span class="linenos">153</span></a> -</span><span id="apply_index_offset-154"><a href="#apply_index_offset-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="apply_index_offset-155"><a href="#apply_index_offset-155"><span class="linenos">155</span></a> -</span><span id="apply_index_offset-156"><a href="#apply_index_offset-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="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.optimizer.annotate_types</span> <span class="kn">import</span> <span class="n">annotate_types</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.simplify</span> <span class="kn">import</span> <span class="n">simplify</span> -</span><span id="apply_index_offset-159"><a href="#apply_index_offset-159"><span class="linenos">159</span></a> -</span><span id="apply_index_offset-160"><a href="#apply_index_offset-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="apply_index_offset-161"><a href="#apply_index_offset-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="apply_index_offset-162"><a href="#apply_index_offset-162"><span class="linenos">162</span></a> -</span><span id="apply_index_offset-163"><a href="#apply_index_offset-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="apply_index_offset-164"><a href="#apply_index_offset-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="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">ARRAY</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="p">):</span> -</span><span id="apply_index_offset-167"><a href="#apply_index_offset-167"><span class="linenos">167</span></a> <span class="k">return</span> <span class="n">expressions</span> -</span><span id="apply_index_offset-168"><a href="#apply_index_offset-168"><span class="linenos">168</span></a> -</span><span id="apply_index_offset-169"><a href="#apply_index_offset-169"><span class="linenos">169</span></a> <span class="k">if</span> <span class="n">expression</span><span class="p">:</span> -</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="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-171"><a href="#apply_index_offset-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="apply_index_offset-172"><a href="#apply_index_offset-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="apply_index_offset-173"><a href="#apply_index_offset-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="apply_index_offset-174"><a href="#apply_index_offset-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="apply_index_offset-175"><a href="#apply_index_offset-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="apply_index_offset-176"><a href="#apply_index_offset-176"><span class="linenos">176</span></a> <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="k">return</span> <span class="p">[</span><span class="n">expression</span><span class="p">]</span> -</span><span id="apply_index_offset-178"><a href="#apply_index_offset-178"><span class="linenos">178</span></a> -</span><span id="apply_index_offset-179"><a href="#apply_index_offset-179"><span class="linenos">179</span></a> <span class="k">return</span> <span class="n">expressions</span> +</span><span id="apply_index_offset-147"><a href="#apply_index_offset-147"><span class="linenos">147</span></a><span class="sd"> Args:</span> +</span><span id="apply_index_offset-148"><a href="#apply_index_offset-148"><span class="linenos">148</span></a><span class="sd"> this: The target of the index.</span> +</span><span id="apply_index_offset-149"><a href="#apply_index_offset-149"><span class="linenos">149</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-150"><a href="#apply_index_offset-150"><span class="linenos">150</span></a><span class="sd"> offset: The offset that will be applied.</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="sd"> Returns:</span> +</span><span id="apply_index_offset-153"><a href="#apply_index_offset-153"><span class="linenos">153</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-154"><a href="#apply_index_offset-154"><span class="linenos">154</span></a><span class="sd"> `expressions` argument contains more than one expression, it's returned unaffected.</span> +</span><span id="apply_index_offset-155"><a href="#apply_index_offset-155"><span class="linenos">155</span></a><span class="sd"> """</span> +</span><span id="apply_index_offset-156"><a href="#apply_index_offset-156"><span class="linenos">156</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-157"><a href="#apply_index_offset-157"><span class="linenos">157</span></a> <span class="k">return</span> <span class="n">expressions</span> +</span><span id="apply_index_offset-158"><a href="#apply_index_offset-158"><span class="linenos">158</span></a> +</span><span id="apply_index_offset-159"><a href="#apply_index_offset-159"><span class="linenos">159</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-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="kn">from</span> <span class="nn">sqlglot</span> <span class="kn">import</span> <span class="n">exp</span> +</span><span id="apply_index_offset-162"><a href="#apply_index_offset-162"><span class="linenos">162</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-163"><a href="#apply_index_offset-163"><span class="linenos">163</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-164"><a href="#apply_index_offset-164"><span class="linenos">164</span></a> +</span><span id="apply_index_offset-165"><a href="#apply_index_offset-165"><span class="linenos">165</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-166"><a href="#apply_index_offset-166"><span class="linenos">166</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-167"><a href="#apply_index_offset-167"><span class="linenos">167</span></a> +</span><span id="apply_index_offset-168"><a href="#apply_index_offset-168"><span class="linenos">168</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-169"><a href="#apply_index_offset-169"><span class="linenos">169</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-170"><a href="#apply_index_offset-170"><span class="linenos">170</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-171"><a href="#apply_index_offset-171"><span class="linenos">171</span></a> <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="k">return</span> <span class="n">expressions</span> +</span><span id="apply_index_offset-173"><a href="#apply_index_offset-173"><span class="linenos">173</span></a> +</span><span id="apply_index_offset-174"><a href="#apply_index_offset-174"><span class="linenos">174</span></a> <span class="k">if</span> <span class="n">expression</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="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-176"><a href="#apply_index_offset-176"><span class="linenos">176</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-177"><a href="#apply_index_offset-177"><span class="linenos">177</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-178"><a href="#apply_index_offset-178"><span class="linenos">178</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-179"><a href="#apply_index_offset-179"><span class="linenos">179</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-180"><a href="#apply_index_offset-180"><span class="linenos">180</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-181"><a href="#apply_index_offset-181"><span class="linenos">181</span></a> <span class="p">)</span> +</span><span id="apply_index_offset-182"><a href="#apply_index_offset-182"><span class="linenos">182</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-183"><a href="#apply_index_offset-183"><span class="linenos">183</span></a> +</span><span id="apply_index_offset-184"><a href="#apply_index_offset-184"><span class="linenos">184</span></a> <span class="k">return</span> <span class="n">expressions</span> </span></pre></div> @@ -868,16 +919,16 @@ <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> +<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> <h6 id="returns">Returns:</h6> <blockquote> <p>The original expression with the offset applied to it, wrapped in a list. If the provided - <code>expressions</code> argument contains more than one expressions, it's returned unaffected.</p> + <code>expressions</code> argument contains more than one expression, it's returned unaffected.</p> </blockquote> </div> @@ -894,9 +945,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-182"><a href="#camel_to_snake_case-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="camel_to_snake_case-183"><a href="#camel_to_snake_case-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="camel_to_snake_case-184"><a href="#camel_to_snake_case-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> + <div class="pdoc-code codehilite"><pre><span></span><span id="camel_to_snake_case-187"><a href="#camel_to_snake_case-187"><span class="linenos">187</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-188"><a href="#camel_to_snake_case-188"><span class="linenos">188</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-189"><a href="#camel_to_snake_case-189"><span class="linenos">189</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> @@ -916,28 +967,30 @@ </div> <a class="headerlink" href="#while_changing"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="while_changing-187"><a href="#while_changing-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="while_changing-188"><a href="#while_changing-188"><span class="linenos">188</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="while_changing-189"><a href="#while_changing-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="while_changing-190"><a href="#while_changing-190"><span class="linenos">190</span></a> -</span><span id="while_changing-191"><a href="#while_changing-191"><span class="linenos">191</span></a><span class="sd"> Args:</span> -</span><span id="while_changing-192"><a href="#while_changing-192"><span class="linenos">192</span></a><span class="sd"> expression: the expression to be transformed.</span> -</span><span id="while_changing-193"><a href="#while_changing-193"><span class="linenos">193</span></a><span class="sd"> func: the transformation to be applied.</span> -</span><span id="while_changing-194"><a href="#while_changing-194"><span class="linenos">194</span></a> -</span><span id="while_changing-195"><a href="#while_changing-195"><span class="linenos">195</span></a><span class="sd"> Returns:</span> -</span><span id="while_changing-196"><a href="#while_changing-196"><span class="linenos">196</span></a><span class="sd"> The transformed expression.</span> -</span><span id="while_changing-197"><a href="#while_changing-197"><span class="linenos">197</span></a><span class="sd"> """</span> -</span><span id="while_changing-198"><a href="#while_changing-198"><span class="linenos">198</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> -</span><span id="while_changing-199"><a href="#while_changing-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="while_changing-200"><a href="#while_changing-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="while_changing-201"><a href="#while_changing-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="while_changing-202"><a href="#while_changing-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="while_changing-203"><a href="#while_changing-203"><span class="linenos">203</span></a> -</span><span id="while_changing-204"><a href="#while_changing-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="while_changing-205"><a href="#while_changing-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="while_changing-206"><a href="#while_changing-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="while_changing-207"><a href="#while_changing-207"><span class="linenos">207</span></a> <span class="k">break</span> -</span><span id="while_changing-208"><a href="#while_changing-208"><span class="linenos">208</span></a> <span class="k">return</span> <span class="n">expression</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="while_changing-192"><a href="#while_changing-192"><span class="linenos">192</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-193"><a href="#while_changing-193"><span class="linenos">193</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="while_changing-194"><a href="#while_changing-194"><span class="linenos">194</span></a><span class="sd"> Applies a transformation to a given expression until a fix point is reached.</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"> Args:</span> +</span><span id="while_changing-197"><a href="#while_changing-197"><span class="linenos">197</span></a><span class="sd"> expression: The expression to be transformed.</span> +</span><span id="while_changing-198"><a href="#while_changing-198"><span class="linenos">198</span></a><span class="sd"> func: The transformation to be applied.</span> +</span><span id="while_changing-199"><a href="#while_changing-199"><span class="linenos">199</span></a> +</span><span id="while_changing-200"><a href="#while_changing-200"><span class="linenos">200</span></a><span class="sd"> Returns:</span> +</span><span id="while_changing-201"><a href="#while_changing-201"><span class="linenos">201</span></a><span class="sd"> The transformed expression.</span> +</span><span id="while_changing-202"><a href="#while_changing-202"><span class="linenos">202</span></a><span class="sd"> """</span> +</span><span id="while_changing-203"><a href="#while_changing-203"><span class="linenos">203</span></a> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> +</span><span id="while_changing-204"><a href="#while_changing-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="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-205"><a href="#while_changing-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="nb">hash</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> +</span><span id="while_changing-206"><a href="#while_changing-206"><span class="linenos">206</span></a> +</span><span id="while_changing-207"><a href="#while_changing-207"><span class="linenos">207</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-208"><a href="#while_changing-208"><span class="linenos">208</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-209"><a href="#while_changing-209"><span class="linenos">209</span></a> +</span><span id="while_changing-210"><a href="#while_changing-210"><span class="linenos">210</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-211"><a href="#while_changing-211"><span class="linenos">211</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-212"><a href="#while_changing-212"><span class="linenos">212</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-213"><a href="#while_changing-213"><span class="linenos">213</span></a> <span class="k">break</span> +</span><span id="while_changing-214"><a href="#while_changing-214"><span class="linenos">214</span></a> +</span><span id="while_changing-215"><a href="#while_changing-215"><span class="linenos">215</span></a> <span class="k">return</span> <span class="n">expression</span> </span></pre></div> @@ -946,8 +999,8 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>expression:</strong> the expression to be transformed.</li> -<li><strong>func:</strong> the transformation to be applied.</li> +<li><strong>expression:</strong> The expression to be transformed.</li> +<li><strong>func:</strong> The transformation to be applied.</li> </ul> <h6 id="returns">Returns:</h6> @@ -970,38 +1023,38 @@ </div> <a class="headerlink" href="#tsort"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="tsort-211"><a href="#tsort-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">Set</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-212"><a href="#tsort-212"><span class="linenos">212</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="tsort-213"><a href="#tsort-213"><span class="linenos">213</span></a><span class="sd"> Sorts a given directed acyclic graph in topological order.</span> -</span><span id="tsort-214"><a href="#tsort-214"><span class="linenos">214</span></a> -</span><span id="tsort-215"><a href="#tsort-215"><span class="linenos">215</span></a><span class="sd"> Args:</span> -</span><span id="tsort-216"><a href="#tsort-216"><span class="linenos">216</span></a><span class="sd"> dag: the graph to be sorted.</span> -</span><span id="tsort-217"><a href="#tsort-217"><span class="linenos">217</span></a> -</span><span id="tsort-218"><a href="#tsort-218"><span class="linenos">218</span></a><span class="sd"> Returns:</span> -</span><span id="tsort-219"><a href="#tsort-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="tsort-220"><a href="#tsort-220"><span class="linenos">220</span></a><span class="sd"> """</span> -</span><span id="tsort-221"><a href="#tsort-221"><span class="linenos">221</span></a> <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span> -</span><span id="tsort-222"><a href="#tsort-222"><span class="linenos">222</span></a> -</span><span id="tsort-223"><a href="#tsort-223"><span class="linenos">223</span></a> <span class="k">for</span> <span class="n">node</span><span class="p">,</span> <span class="n">deps</span> <span class="ow">in</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">dag</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span> -</span><span id="tsort-224"><a href="#tsort-224"><span class="linenos">224</span></a> <span class="k">for</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">deps</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="ow">not</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">dag</span><span class="p">:</span> -</span><span id="tsort-226"><a href="#tsort-226"><span class="linenos">226</span></a> <span class="n">dag</span><span class="p">[</span><span class="n">dep</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> -</span><span id="tsort-227"><a href="#tsort-227"><span class="linenos">227</span></a> -</span><span id="tsort-228"><a href="#tsort-228"><span class="linenos">228</span></a> <span class="k">while</span> <span class="n">dag</span><span class="p">:</span> -</span><span id="tsort-229"><a href="#tsort-229"><span class="linenos">229</span></a> <span class="n">current</span> <span class="o">=</span> <span class="p">{</span><span class="n">node</span> <span class="k">for</span> <span class="n">node</span><span class="p">,</span> <span class="n">deps</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">deps</span><span class="p">}</span> -</span><span id="tsort-230"><a href="#tsort-230"><span class="linenos">230</span></a> -</span><span id="tsort-231"><a href="#tsort-231"><span class="linenos">231</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">current</span><span class="p">:</span> -</span><span id="tsort-232"><a href="#tsort-232"><span class="linenos">232</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-233"><a href="#tsort-233"><span class="linenos">233</span></a> -</span><span id="tsort-234"><a href="#tsort-234"><span class="linenos">234</span></a> <span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> -</span><span id="tsort-235"><a href="#tsort-235"><span class="linenos">235</span></a> <span class="n">dag</span><span class="o">.</span><span class="n">pop</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><span id="tsort-237"><a href="#tsort-237"><span class="linenos">237</span></a> <span class="k">for</span> <span class="n">deps</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> -</span><span id="tsort-238"><a href="#tsort-238"><span class="linenos">238</span></a> <span class="n">deps</span> <span class="o">-=</span> <span class="n">current</span> -</span><span id="tsort-239"><a href="#tsort-239"><span class="linenos">239</span></a> -</span><span id="tsort-240"><a href="#tsort-240"><span class="linenos">240</span></a> <span class="n">result</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="n">current</span><span class="p">))</span> <span class="c1"># type: ignore</span> -</span><span id="tsort-241"><a href="#tsort-241"><span class="linenos">241</span></a> -</span><span id="tsort-242"><a href="#tsort-242"><span class="linenos">242</span></a> <span class="k">return</span> <span class="n">result</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="tsort-218"><a href="#tsort-218"><span class="linenos">218</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">Set</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-219"><a href="#tsort-219"><span class="linenos">219</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="tsort-220"><a href="#tsort-220"><span class="linenos">220</span></a><span class="sd"> Sorts a given directed acyclic graph in topological order.</span> +</span><span id="tsort-221"><a href="#tsort-221"><span class="linenos">221</span></a> +</span><span id="tsort-222"><a href="#tsort-222"><span class="linenos">222</span></a><span class="sd"> Args:</span> +</span><span id="tsort-223"><a href="#tsort-223"><span class="linenos">223</span></a><span class="sd"> dag: The graph to be sorted.</span> +</span><span id="tsort-224"><a href="#tsort-224"><span class="linenos">224</span></a> +</span><span id="tsort-225"><a href="#tsort-225"><span class="linenos">225</span></a><span class="sd"> Returns:</span> +</span><span id="tsort-226"><a href="#tsort-226"><span class="linenos">226</span></a><span class="sd"> A list that contains all of the graph's nodes in topological order.</span> +</span><span id="tsort-227"><a href="#tsort-227"><span class="linenos">227</span></a><span class="sd"> """</span> +</span><span id="tsort-228"><a href="#tsort-228"><span class="linenos">228</span></a> <span class="n">result</span> <span class="o">=</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="k">for</span> <span class="n">node</span><span class="p">,</span> <span class="n">deps</span> <span class="ow">in</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">dag</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span> +</span><span id="tsort-231"><a href="#tsort-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">deps</span><span class="p">:</span> +</span><span id="tsort-232"><a href="#tsort-232"><span class="linenos">232</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">dag</span><span class="p">:</span> +</span><span id="tsort-233"><a href="#tsort-233"><span class="linenos">233</span></a> <span class="n">dag</span><span class="p">[</span><span class="n">dep</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</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="k">while</span> <span class="n">dag</span><span class="p">:</span> +</span><span id="tsort-236"><a href="#tsort-236"><span class="linenos">236</span></a> <span class="n">current</span> <span class="o">=</span> <span class="p">{</span><span class="n">node</span> <span class="k">for</span> <span class="n">node</span><span class="p">,</span> <span class="n">deps</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">deps</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">if</span> <span class="ow">not</span> <span class="n">current</span><span class="p">:</span> +</span><span id="tsort-239"><a href="#tsort-239"><span class="linenos">239</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-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">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> +</span><span id="tsort-242"><a href="#tsort-242"><span class="linenos">242</span></a> <span class="n">dag</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> +</span><span id="tsort-243"><a href="#tsort-243"><span class="linenos">243</span></a> +</span><span id="tsort-244"><a href="#tsort-244"><span class="linenos">244</span></a> <span class="k">for</span> <span class="n">deps</span> <span class="ow">in</span> <span class="n">dag</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> +</span><span id="tsort-245"><a href="#tsort-245"><span class="linenos">245</span></a> <span class="n">deps</span> <span class="o">-=</span> <span class="n">current</span> +</span><span id="tsort-246"><a href="#tsort-246"><span class="linenos">246</span></a> +</span><span id="tsort-247"><a href="#tsort-247"><span class="linenos">247</span></a> <span class="n">result</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="n">current</span><span class="p">))</span> <span class="c1"># type: ignore</span> +</span><span id="tsort-248"><a href="#tsort-248"><span class="linenos">248</span></a> +</span><span id="tsort-249"><a href="#tsort-249"><span class="linenos">249</span></a> <span class="k">return</span> <span class="n">result</span> </span></pre></div> @@ -1010,7 +1063,7 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>dag:</strong> the graph to be sorted.</li> +<li><strong>dag:</strong> The graph to be sorted.</li> </ul> <h6 id="returns">Returns:</h6> @@ -1033,17 +1086,17 @@ </div> <a class="headerlink" href="#open_file"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="open_file-245"><a href="#open_file-245"><span class="linenos">245</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-246"><a href="#open_file-246"><span class="linenos">246</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-247"><a href="#open_file-247"><span class="linenos">247</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-248"><a href="#open_file-248"><span class="linenos">248</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-249"><a href="#open_file-249"><span class="linenos">249</span></a> -</span><span id="open_file-250"><a href="#open_file-250"><span class="linenos">250</span></a> <span class="k">if</span> <span class="n">gzipped</span><span class="p">:</span> -</span><span id="open_file-251"><a href="#open_file-251"><span class="linenos">251</span></a> <span class="kn">import</span> <span class="nn">gzip</span> -</span><span id="open_file-252"><a href="#open_file-252"><span class="linenos">252</span></a> -</span><span id="open_file-253"><a href="#open_file-253"><span class="linenos">253</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-254"><a href="#open_file-254"><span class="linenos">254</span></a> -</span><span id="open_file-255"><a href="#open_file-255"><span class="linenos">255</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-252"><a href="#open_file-252"><span class="linenos">252</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-253"><a href="#open_file-253"><span class="linenos">253</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-254"><a href="#open_file-254"><span class="linenos">254</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-255"><a href="#open_file-255"><span class="linenos">255</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-256"><a href="#open_file-256"><span class="linenos">256</span></a> +</span><span id="open_file-257"><a href="#open_file-257"><span class="linenos">257</span></a> <span class="k">if</span> <span class="n">gzipped</span><span class="p">:</span> +</span><span id="open_file-258"><a href="#open_file-258"><span class="linenos">258</span></a> <span class="kn">import</span> <span class="nn">gzip</span> +</span><span id="open_file-259"><a href="#open_file-259"><span class="linenos">259</span></a> +</span><span id="open_file-260"><a href="#open_file-260"><span class="linenos">260</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-261"><a href="#open_file-261"><span class="linenos">261</span></a> +</span><span id="open_file-262"><a href="#open_file-262"><span class="linenos">262</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> @@ -1064,32 +1117,32 @@ </div> <a class="headerlink" href="#csv_reader"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="csv_reader-258"><a href="#csv_reader-258"><span class="linenos">258</span></a><span class="nd">@contextmanager</span> -</span><span id="csv_reader-259"><a href="#csv_reader-259"><span class="linenos">259</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-260"><a href="#csv_reader-260"><span class="linenos">260</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="csv_reader-261"><a href="#csv_reader-261"><span class="linenos">261</span></a><span class="sd"> Returns a csv reader given the expression `READ_CSV(name, ['delimiter', '|', ...])`.</span> -</span><span id="csv_reader-262"><a href="#csv_reader-262"><span class="linenos">262</span></a> -</span><span id="csv_reader-263"><a href="#csv_reader-263"><span class="linenos">263</span></a><span class="sd"> Args:</span> -</span><span id="csv_reader-264"><a href="#csv_reader-264"><span class="linenos">264</span></a><span class="sd"> read_csv: a `ReadCSV` function call</span> -</span><span id="csv_reader-265"><a href="#csv_reader-265"><span class="linenos">265</span></a> -</span><span id="csv_reader-266"><a href="#csv_reader-266"><span class="linenos">266</span></a><span class="sd"> Yields:</span> -</span><span id="csv_reader-267"><a href="#csv_reader-267"><span class="linenos">267</span></a><span class="sd"> A python csv reader.</span> -</span><span id="csv_reader-268"><a href="#csv_reader-268"><span class="linenos">268</span></a><span class="sd"> """</span> -</span><span id="csv_reader-269"><a href="#csv_reader-269"><span class="linenos">269</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-270"><a href="#csv_reader-270"><span class="linenos">270</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-271"><a href="#csv_reader-271"><span class="linenos">271</span></a> -</span><span id="csv_reader-272"><a href="#csv_reader-272"><span class="linenos">272</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="s2">","</span> -</span><span id="csv_reader-273"><a href="#csv_reader-273"><span class="linenos">273</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-274"><a href="#csv_reader-274"><span class="linenos">274</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-275"><a href="#csv_reader-275"><span class="linenos">275</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-276"><a href="#csv_reader-276"><span class="linenos">276</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="n">v</span> -</span><span id="csv_reader-277"><a href="#csv_reader-277"><span class="linenos">277</span></a> -</span><span id="csv_reader-278"><a href="#csv_reader-278"><span class="linenos">278</span></a> <span class="k">try</span><span class="p">:</span> -</span><span id="csv_reader-279"><a href="#csv_reader-279"><span class="linenos">279</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-280"><a href="#csv_reader-280"><span class="linenos">280</span></a> -</span><span id="csv_reader-281"><a href="#csv_reader-281"><span class="linenos">281</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-282"><a href="#csv_reader-282"><span class="linenos">282</span></a> <span class="k">finally</span><span class="p">:</span> -</span><span id="csv_reader-283"><a href="#csv_reader-283"><span class="linenos">283</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-265"><a href="#csv_reader-265"><span class="linenos">265</span></a><span class="nd">@contextmanager</span> +</span><span id="csv_reader-266"><a href="#csv_reader-266"><span class="linenos">266</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-267"><a href="#csv_reader-267"><span class="linenos">267</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="csv_reader-268"><a href="#csv_reader-268"><span class="linenos">268</span></a><span class="sd"> Returns a csv reader given the expression `READ_CSV(name, ['delimiter', '|', ...])`.</span> +</span><span id="csv_reader-269"><a href="#csv_reader-269"><span class="linenos">269</span></a> +</span><span id="csv_reader-270"><a href="#csv_reader-270"><span class="linenos">270</span></a><span class="sd"> Args:</span> +</span><span id="csv_reader-271"><a href="#csv_reader-271"><span class="linenos">271</span></a><span class="sd"> read_csv: A `ReadCSV` function call.</span> +</span><span id="csv_reader-272"><a href="#csv_reader-272"><span class="linenos">272</span></a> +</span><span id="csv_reader-273"><a href="#csv_reader-273"><span class="linenos">273</span></a><span class="sd"> Yields:</span> +</span><span id="csv_reader-274"><a href="#csv_reader-274"><span class="linenos">274</span></a><span class="sd"> A python csv reader.</span> +</span><span id="csv_reader-275"><a href="#csv_reader-275"><span class="linenos">275</span></a><span class="sd"> """</span> +</span><span id="csv_reader-276"><a href="#csv_reader-276"><span class="linenos">276</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-277"><a href="#csv_reader-277"><span class="linenos">277</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-278"><a href="#csv_reader-278"><span class="linenos">278</span></a> +</span><span id="csv_reader-279"><a href="#csv_reader-279"><span class="linenos">279</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="s2">","</span> +</span><span id="csv_reader-280"><a href="#csv_reader-280"><span class="linenos">280</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-281"><a href="#csv_reader-281"><span class="linenos">281</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-282"><a href="#csv_reader-282"><span class="linenos">282</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-283"><a href="#csv_reader-283"><span class="linenos">283</span></a> <span class="n">delimiter</span> <span class="o">=</span> <span class="n">v</span> +</span><span id="csv_reader-284"><a href="#csv_reader-284"><span class="linenos">284</span></a> +</span><span id="csv_reader-285"><a href="#csv_reader-285"><span class="linenos">285</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="csv_reader-286"><a href="#csv_reader-286"><span class="linenos">286</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-287"><a href="#csv_reader-287"><span class="linenos">287</span></a> +</span><span id="csv_reader-288"><a href="#csv_reader-288"><span class="linenos">288</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-289"><a href="#csv_reader-289"><span class="linenos">289</span></a> <span class="k">finally</span><span class="p">:</span> +</span><span id="csv_reader-290"><a href="#csv_reader-290"><span class="linenos">290</span></a> <span class="n">file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> </span></pre></div> @@ -1098,7 +1151,7 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>read_csv:</strong> a <code>ReadCSV</code> function call</li> +<li><strong>read_csv:</strong> A <code>ReadCSV</code> function call.</li> </ul> <h6 id="yields">Yields:</h6> @@ -1121,27 +1174,27 @@ </div> <a class="headerlink" href="#find_new_name"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="find_new_name-286"><a href="#find_new_name-286"><span class="linenos">286</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-287"><a href="#find_new_name-287"><span class="linenos">287</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="find_new_name-288"><a href="#find_new_name-288"><span class="linenos">288</span></a><span class="sd"> Searches for a new name.</span> -</span><span id="find_new_name-289"><a href="#find_new_name-289"><span class="linenos">289</span></a> -</span><span id="find_new_name-290"><a href="#find_new_name-290"><span class="linenos">290</span></a><span class="sd"> Args:</span> -</span><span id="find_new_name-291"><a href="#find_new_name-291"><span class="linenos">291</span></a><span class="sd"> taken: a collection of taken names.</span> -</span><span id="find_new_name-292"><a href="#find_new_name-292"><span class="linenos">292</span></a><span class="sd"> base: base name to alter.</span> -</span><span id="find_new_name-293"><a href="#find_new_name-293"><span class="linenos">293</span></a> -</span><span id="find_new_name-294"><a href="#find_new_name-294"><span class="linenos">294</span></a><span class="sd"> Returns:</span> -</span><span id="find_new_name-295"><a href="#find_new_name-295"><span class="linenos">295</span></a><span class="sd"> The new, available name.</span> -</span><span id="find_new_name-296"><a href="#find_new_name-296"><span class="linenos">296</span></a><span class="sd"> """</span> -</span><span id="find_new_name-297"><a href="#find_new_name-297"><span class="linenos">297</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-298"><a href="#find_new_name-298"><span class="linenos">298</span></a> <span class="k">return</span> <span class="n">base</span> -</span><span id="find_new_name-299"><a href="#find_new_name-299"><span class="linenos">299</span></a> -</span><span id="find_new_name-300"><a href="#find_new_name-300"><span class="linenos">300</span></a> <span class="n">i</span> <span class="o">=</span> <span class="mi">2</span> -</span><span id="find_new_name-301"><a href="#find_new_name-301"><span class="linenos">301</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-302"><a href="#find_new_name-302"><span class="linenos">302</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-303"><a href="#find_new_name-303"><span class="linenos">303</span></a> <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> -</span><span id="find_new_name-304"><a href="#find_new_name-304"><span class="linenos">304</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-305"><a href="#find_new_name-305"><span class="linenos">305</span></a> -</span><span id="find_new_name-306"><a href="#find_new_name-306"><span class="linenos">306</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-293"><a href="#find_new_name-293"><span class="linenos">293</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-294"><a href="#find_new_name-294"><span class="linenos">294</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="find_new_name-295"><a href="#find_new_name-295"><span class="linenos">295</span></a><span class="sd"> Searches for a new name.</span> +</span><span id="find_new_name-296"><a href="#find_new_name-296"><span class="linenos">296</span></a> +</span><span id="find_new_name-297"><a href="#find_new_name-297"><span class="linenos">297</span></a><span class="sd"> Args:</span> +</span><span id="find_new_name-298"><a href="#find_new_name-298"><span class="linenos">298</span></a><span class="sd"> taken: A collection of taken names.</span> +</span><span id="find_new_name-299"><a href="#find_new_name-299"><span class="linenos">299</span></a><span class="sd"> base: Base name to alter.</span> +</span><span id="find_new_name-300"><a href="#find_new_name-300"><span class="linenos">300</span></a> +</span><span id="find_new_name-301"><a href="#find_new_name-301"><span class="linenos">301</span></a><span class="sd"> Returns:</span> +</span><span id="find_new_name-302"><a href="#find_new_name-302"><span class="linenos">302</span></a><span class="sd"> The new, available name.</span> +</span><span id="find_new_name-303"><a href="#find_new_name-303"><span class="linenos">303</span></a><span class="sd"> """</span> +</span><span id="find_new_name-304"><a href="#find_new_name-304"><span class="linenos">304</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-305"><a href="#find_new_name-305"><span class="linenos">305</span></a> <span class="k">return</span> <span class="n">base</span> +</span><span id="find_new_name-306"><a href="#find_new_name-306"><span class="linenos">306</span></a> +</span><span id="find_new_name-307"><a href="#find_new_name-307"><span class="linenos">307</span></a> <span class="n">i</span> <span class="o">=</span> <span class="mi">2</span> +</span><span id="find_new_name-308"><a href="#find_new_name-308"><span class="linenos">308</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-309"><a href="#find_new_name-309"><span class="linenos">309</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-310"><a href="#find_new_name-310"><span class="linenos">310</span></a> <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> +</span><span id="find_new_name-311"><a href="#find_new_name-311"><span class="linenos">311</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-312"><a href="#find_new_name-312"><span class="linenos">312</span></a> +</span><span id="find_new_name-313"><a href="#find_new_name-313"><span class="linenos">313</span></a> <span class="k">return</span> <span class="n">new</span> </span></pre></div> @@ -1150,8 +1203,8 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>taken:</strong> a collection of taken names.</li> -<li><strong>base:</strong> base name to alter.</li> +<li><strong>taken:</strong> A collection of taken names.</li> +<li><strong>base:</strong> Base name to alter.</li> </ul> <h6 id="returns">Returns:</h6> @@ -1174,10 +1227,10 @@ </div> <a class="headerlink" href="#name_sequence"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="name_sequence-309"><a href="#name_sequence-309"><span class="linenos">309</span></a><span class="k">def</span> <span class="nf">name_sequence</span><span class="p">(</span><span class="n">prefix</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">Callable</span><span class="p">[[],</span> <span class="nb">str</span><span class="p">]:</span> -</span><span id="name_sequence-310"><a href="#name_sequence-310"><span class="linenos">310</span></a><span class="w"> </span><span class="sd">"""Returns a name generator given a prefix (e.g. a0, a1, a2, ... if the prefix is "a")."""</span> -</span><span id="name_sequence-311"><a href="#name_sequence-311"><span class="linenos">311</span></a> <span class="n">sequence</span> <span class="o">=</span> <span class="n">count</span><span class="p">()</span> -</span><span id="name_sequence-312"><a href="#name_sequence-312"><span class="linenos">312</span></a> <span class="k">return</span> <span class="k">lambda</span><span class="p">:</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">prefix</span><span class="si">}{</span><span class="nb">next</span><span class="p">(</span><span class="n">sequence</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="name_sequence-316"><a href="#name_sequence-316"><span class="linenos">316</span></a><span class="k">def</span> <span class="nf">name_sequence</span><span class="p">(</span><span class="n">prefix</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">Callable</span><span class="p">[[],</span> <span class="nb">str</span><span class="p">]:</span> +</span><span id="name_sequence-317"><a href="#name_sequence-317"><span class="linenos">317</span></a><span class="w"> </span><span class="sd">"""Returns a name generator given a prefix (e.g. a0, a1, a2, ... if the prefix is "a")."""</span> +</span><span id="name_sequence-318"><a href="#name_sequence-318"><span class="linenos">318</span></a> <span class="n">sequence</span> <span class="o">=</span> <span class="n">count</span><span class="p">()</span> +</span><span id="name_sequence-319"><a href="#name_sequence-319"><span class="linenos">319</span></a> <span class="k">return</span> <span class="k">lambda</span><span class="p">:</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">prefix</span><span class="si">}{</span><span class="nb">next</span><span class="p">(</span><span class="n">sequence</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span> </span></pre></div> @@ -1197,12 +1250,12 @@ </div> <a class="headerlink" href="#object_to_dict"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="object_to_dict-315"><a href="#object_to_dict-315"><span class="linenos">315</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-316"><a href="#object_to_dict-316"><span class="linenos">316</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-317"><a href="#object_to_dict-317"><span class="linenos">317</span></a> <span class="k">return</span> <span class="p">{</span> -</span><span id="object_to_dict-318"><a href="#object_to_dict-318"><span class="linenos">318</span></a> <span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="s2">"copy"</span><span class="p">)</span> <span class="k">else</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">items</span><span class="p">()},</span> -</span><span id="object_to_dict-319"><a href="#object_to_dict-319"><span class="linenos">319</span></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> -</span><span id="object_to_dict-320"><a href="#object_to_dict-320"><span class="linenos">320</span></a> <span class="p">}</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="object_to_dict-322"><a href="#object_to_dict-322"><span class="linenos">322</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-323"><a href="#object_to_dict-323"><span class="linenos">323</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-324"><a href="#object_to_dict-324"><span class="linenos">324</span></a> <span class="k">return</span> <span class="p">{</span> +</span><span id="object_to_dict-325"><a href="#object_to_dict-325"><span class="linenos">325</span></a> <span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="s2">"copy"</span><span class="p">)</span> <span class="k">else</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">items</span><span class="p">()},</span> +</span><span id="object_to_dict-326"><a href="#object_to_dict-326"><span class="linenos">326</span></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> +</span><span id="object_to_dict-327"><a href="#object_to_dict-327"><span class="linenos">327</span></a> <span class="p">}</span> </span></pre></div> @@ -1222,33 +1275,33 @@ </div> <a class="headerlink" href="#split_num_words"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="split_num_words-323"><a href="#split_num_words-323"><span class="linenos">323</span></a><span class="k">def</span> <span class="nf">split_num_words</span><span class="p">(</span> -</span><span id="split_num_words-324"><a href="#split_num_words-324"><span class="linenos">324</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-325"><a href="#split_num_words-325"><span class="linenos">325</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-326"><a href="#split_num_words-326"><span class="linenos">326</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="split_num_words-327"><a href="#split_num_words-327"><span class="linenos">327</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-328"><a href="#split_num_words-328"><span class="linenos">328</span></a> -</span><span id="split_num_words-329"><a href="#split_num_words-329"><span class="linenos">329</span></a><span class="sd"> Args:</span> -</span><span id="split_num_words-330"><a href="#split_num_words-330"><span class="linenos">330</span></a><span class="sd"> value: the value to be split.</span> -</span><span id="split_num_words-331"><a href="#split_num_words-331"><span class="linenos">331</span></a><span class="sd"> sep: the value to use to split on.</span> -</span><span id="split_num_words-332"><a href="#split_num_words-332"><span class="linenos">332</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-333"><a href="#split_num_words-333"><span class="linenos">333</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-334"><a href="#split_num_words-334"><span class="linenos">334</span></a> -</span><span id="split_num_words-335"><a href="#split_num_words-335"><span class="linenos">335</span></a><span class="sd"> Examples:</span> -</span><span id="split_num_words-336"><a href="#split_num_words-336"><span class="linenos">336</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3)</span> -</span><span id="split_num_words-337"><a href="#split_num_words-337"><span class="linenos">337</span></a><span class="sd"> [None, 'db', 'table']</span> -</span><span id="split_num_words-338"><a href="#split_num_words-338"><span class="linenos">338</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3, fill_from_start=False)</span> -</span><span id="split_num_words-339"><a href="#split_num_words-339"><span class="linenos">339</span></a><span class="sd"> ['db', 'table', None]</span> -</span><span id="split_num_words-340"><a href="#split_num_words-340"><span class="linenos">340</span></a><span class="sd"> >>> split_num_words("db.table", ".", 1)</span> -</span><span id="split_num_words-341"><a href="#split_num_words-341"><span class="linenos">341</span></a><span class="sd"> ['db', 'table']</span> -</span><span id="split_num_words-342"><a href="#split_num_words-342"><span class="linenos">342</span></a> -</span><span id="split_num_words-343"><a href="#split_num_words-343"><span class="linenos">343</span></a><span class="sd"> Returns:</span> -</span><span id="split_num_words-344"><a href="#split_num_words-344"><span class="linenos">344</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-345"><a href="#split_num_words-345"><span class="linenos">345</span></a><span class="sd"> """</span> -</span><span id="split_num_words-346"><a href="#split_num_words-346"><span class="linenos">346</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-347"><a href="#split_num_words-347"><span class="linenos">347</span></a> <span class="k">if</span> <span class="n">fill_from_start</span><span class="p">:</span> -</span><span id="split_num_words-348"><a href="#split_num_words-348"><span class="linenos">348</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-349"><a href="#split_num_words-349"><span class="linenos">349</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-330"><a href="#split_num_words-330"><span class="linenos">330</span></a><span class="k">def</span> <span class="nf">split_num_words</span><span class="p">(</span> +</span><span id="split_num_words-331"><a href="#split_num_words-331"><span class="linenos">331</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-332"><a href="#split_num_words-332"><span class="linenos">332</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-333"><a href="#split_num_words-333"><span class="linenos">333</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="split_num_words-334"><a href="#split_num_words-334"><span class="linenos">334</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-335"><a href="#split_num_words-335"><span class="linenos">335</span></a> +</span><span id="split_num_words-336"><a href="#split_num_words-336"><span class="linenos">336</span></a><span class="sd"> Args:</span> +</span><span id="split_num_words-337"><a href="#split_num_words-337"><span class="linenos">337</span></a><span class="sd"> value: The value to be split.</span> +</span><span id="split_num_words-338"><a href="#split_num_words-338"><span class="linenos">338</span></a><span class="sd"> sep: The value to use to split on.</span> +</span><span id="split_num_words-339"><a href="#split_num_words-339"><span class="linenos">339</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-340"><a href="#split_num_words-340"><span class="linenos">340</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-341"><a href="#split_num_words-341"><span class="linenos">341</span></a> +</span><span id="split_num_words-342"><a href="#split_num_words-342"><span class="linenos">342</span></a><span class="sd"> Examples:</span> +</span><span id="split_num_words-343"><a href="#split_num_words-343"><span class="linenos">343</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3)</span> +</span><span id="split_num_words-344"><a href="#split_num_words-344"><span class="linenos">344</span></a><span class="sd"> [None, 'db', 'table']</span> +</span><span id="split_num_words-345"><a href="#split_num_words-345"><span class="linenos">345</span></a><span class="sd"> >>> split_num_words("db.table", ".", 3, fill_from_start=False)</span> +</span><span id="split_num_words-346"><a href="#split_num_words-346"><span class="linenos">346</span></a><span class="sd"> ['db', 'table', None]</span> +</span><span id="split_num_words-347"><a href="#split_num_words-347"><span class="linenos">347</span></a><span class="sd"> >>> split_num_words("db.table", ".", 1)</span> +</span><span id="split_num_words-348"><a href="#split_num_words-348"><span class="linenos">348</span></a><span class="sd"> ['db', 'table']</span> +</span><span id="split_num_words-349"><a href="#split_num_words-349"><span class="linenos">349</span></a> +</span><span id="split_num_words-350"><a href="#split_num_words-350"><span class="linenos">350</span></a><span class="sd"> Returns:</span> +</span><span id="split_num_words-351"><a href="#split_num_words-351"><span class="linenos">351</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-352"><a href="#split_num_words-352"><span class="linenos">352</span></a><span class="sd"> """</span> +</span><span id="split_num_words-353"><a href="#split_num_words-353"><span class="linenos">353</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-354"><a href="#split_num_words-354"><span class="linenos">354</span></a> <span class="k">if</span> <span class="n">fill_from_start</span><span class="p">:</span> +</span><span id="split_num_words-355"><a href="#split_num_words-355"><span class="linenos">355</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-356"><a href="#split_num_words-356"><span class="linenos">356</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> @@ -1257,10 +1310,10 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>value:</strong> the value to be split.</li> -<li><strong>sep:</strong> the value to use to split on.</li> -<li><strong>min_num_words:</strong> the minimum number of words that are going to be in the result.</li> -<li><strong>fill_from_start:</strong> indicates that if <code>None</code> values should be inserted at the start or end of the list.</li> +<li><strong>value:</strong> The value to be split.</li> +<li><strong>sep:</strong> The value to use to split on.</li> +<li><strong>min_num_words:</strong> The minimum number of words that are going to be in the result.</li> +<li><strong>fill_from_start:</strong> Indicates that if <code>None</code> values should be inserted at the start or end of the list.</li> </ul> <h6 id="examples">Examples:</h6> @@ -1297,23 +1350,23 @@ </div> <a class="headerlink" href="#is_iterable"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="is_iterable-352"><a href="#is_iterable-352"><span class="linenos">352</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-353"><a href="#is_iterable-353"><span class="linenos">353</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="is_iterable-354"><a href="#is_iterable-354"><span class="linenos">354</span></a><span class="sd"> Checks if the value is an iterable, excluding the types `str` and `bytes`.</span> -</span><span id="is_iterable-355"><a href="#is_iterable-355"><span class="linenos">355</span></a> -</span><span id="is_iterable-356"><a href="#is_iterable-356"><span class="linenos">356</span></a><span class="sd"> Examples:</span> -</span><span id="is_iterable-357"><a href="#is_iterable-357"><span class="linenos">357</span></a><span class="sd"> >>> is_iterable([1,2])</span> -</span><span id="is_iterable-358"><a href="#is_iterable-358"><span class="linenos">358</span></a><span class="sd"> True</span> -</span><span id="is_iterable-359"><a href="#is_iterable-359"><span class="linenos">359</span></a><span class="sd"> >>> is_iterable("test")</span> -</span><span id="is_iterable-360"><a href="#is_iterable-360"><span class="linenos">360</span></a><span class="sd"> False</span> -</span><span id="is_iterable-361"><a href="#is_iterable-361"><span class="linenos">361</span></a> -</span><span id="is_iterable-362"><a href="#is_iterable-362"><span class="linenos">362</span></a><span class="sd"> Args:</span> -</span><span id="is_iterable-363"><a href="#is_iterable-363"><span class="linenos">363</span></a><span class="sd"> value: the value to check if it is an iterable.</span> -</span><span id="is_iterable-364"><a href="#is_iterable-364"><span class="linenos">364</span></a> -</span><span id="is_iterable-365"><a href="#is_iterable-365"><span class="linenos">365</span></a><span class="sd"> Returns:</span> -</span><span id="is_iterable-366"><a href="#is_iterable-366"><span class="linenos">366</span></a><span class="sd"> A `bool` value indicating if it is an iterable.</span> -</span><span id="is_iterable-367"><a href="#is_iterable-367"><span class="linenos">367</span></a><span class="sd"> """</span> -</span><span id="is_iterable-368"><a href="#is_iterable-368"><span class="linenos">368</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-359"><a href="#is_iterable-359"><span class="linenos">359</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-360"><a href="#is_iterable-360"><span class="linenos">360</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="is_iterable-361"><a href="#is_iterable-361"><span class="linenos">361</span></a><span class="sd"> Checks if the value is an iterable, excluding the types `str` and `bytes`.</span> +</span><span id="is_iterable-362"><a href="#is_iterable-362"><span class="linenos">362</span></a> +</span><span id="is_iterable-363"><a href="#is_iterable-363"><span class="linenos">363</span></a><span class="sd"> Examples:</span> +</span><span id="is_iterable-364"><a href="#is_iterable-364"><span class="linenos">364</span></a><span class="sd"> >>> is_iterable([1,2])</span> +</span><span id="is_iterable-365"><a href="#is_iterable-365"><span class="linenos">365</span></a><span class="sd"> True</span> +</span><span id="is_iterable-366"><a href="#is_iterable-366"><span class="linenos">366</span></a><span class="sd"> >>> is_iterable("test")</span> +</span><span id="is_iterable-367"><a href="#is_iterable-367"><span class="linenos">367</span></a><span class="sd"> False</span> +</span><span id="is_iterable-368"><a href="#is_iterable-368"><span class="linenos">368</span></a> +</span><span id="is_iterable-369"><a href="#is_iterable-369"><span class="linenos">369</span></a><span class="sd"> Args:</span> +</span><span id="is_iterable-370"><a href="#is_iterable-370"><span class="linenos">370</span></a><span class="sd"> value: The value to check if it is an iterable.</span> +</span><span id="is_iterable-371"><a href="#is_iterable-371"><span class="linenos">371</span></a> +</span><span id="is_iterable-372"><a href="#is_iterable-372"><span class="linenos">372</span></a><span class="sd"> Returns:</span> +</span><span id="is_iterable-373"><a href="#is_iterable-373"><span class="linenos">373</span></a><span class="sd"> A `bool` value indicating if it is an iterable.</span> +</span><span id="is_iterable-374"><a href="#is_iterable-374"><span class="linenos">374</span></a><span class="sd"> """</span> +</span><span id="is_iterable-375"><a href="#is_iterable-375"><span class="linenos">375</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> @@ -1334,7 +1387,7 @@ <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>value:</strong> the value to check if it is an iterable.</li> +<li><strong>value:</strong> The value to check if it is an iterable.</li> </ul> <h6 id="returns">Returns:</h6> @@ -1357,28 +1410,28 @@ </div> <a class="headerlink" href="#flatten"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="flatten-371"><a href="#flatten-371"><span class="linenos">371</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-372"><a href="#flatten-372"><span class="linenos">372</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="flatten-373"><a href="#flatten-373"><span class="linenos">373</span></a><span class="sd"> Flattens an iterable that can contain both iterable and non-iterable elements. Objects of</span> -</span><span id="flatten-374"><a href="#flatten-374"><span class="linenos">374</span></a><span class="sd"> type `str` and `bytes` are not regarded as iterables.</span> -</span><span id="flatten-375"><a href="#flatten-375"><span class="linenos">375</span></a> -</span><span id="flatten-376"><a href="#flatten-376"><span class="linenos">376</span></a><span class="sd"> Examples:</span> -</span><span id="flatten-377"><a href="#flatten-377"><span class="linenos">377</span></a><span class="sd"> >>> list(flatten([[1, 2], 3, {4}, (5, "bla")]))</span> -</span><span id="flatten-378"><a href="#flatten-378"><span class="linenos">378</span></a><span class="sd"> [1, 2, 3, 4, 5, 'bla']</span> -</span><span id="flatten-379"><a href="#flatten-379"><span class="linenos">379</span></a><span class="sd"> >>> list(flatten([1, 2, 3]))</span> -</span><span id="flatten-380"><a href="#flatten-380"><span class="linenos">380</span></a><span class="sd"> [1, 2, 3]</span> -</span><span id="flatten-381"><a href="#flatten-381"><span class="linenos">381</span></a> -</span><span id="flatten-382"><a href="#flatten-382"><span class="linenos">382</span></a><span class="sd"> Args:</span> -</span><span id="flatten-383"><a href="#flatten-383"><span class="linenos">383</span></a><span class="sd"> values: the value to be flattened.</span> -</span><span id="flatten-384"><a href="#flatten-384"><span class="linenos">384</span></a> -</span><span id="flatten-385"><a href="#flatten-385"><span class="linenos">385</span></a><span class="sd"> Yields:</span> -</span><span id="flatten-386"><a href="#flatten-386"><span class="linenos">386</span></a><span class="sd"> Non-iterable elements in `values`.</span> -</span><span id="flatten-387"><a href="#flatten-387"><span class="linenos">387</span></a><span class="sd"> """</span> -</span><span id="flatten-388"><a href="#flatten-388"><span class="linenos">388</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-389"><a href="#flatten-389"><span class="linenos">389</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-390"><a href="#flatten-390"><span class="linenos">390</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-391"><a href="#flatten-391"><span class="linenos">391</span></a> <span class="k">else</span><span class="p">:</span> -</span><span id="flatten-392"><a href="#flatten-392"><span class="linenos">392</span></a> <span class="k">yield</span> <span class="n">value</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="flatten-378"><a href="#flatten-378"><span class="linenos">378</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-379"><a href="#flatten-379"><span class="linenos">379</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="flatten-380"><a href="#flatten-380"><span class="linenos">380</span></a><span class="sd"> Flattens an iterable that can contain both iterable and non-iterable elements. Objects of</span> +</span><span id="flatten-381"><a href="#flatten-381"><span class="linenos">381</span></a><span class="sd"> type `str` and `bytes` are not regarded as iterables.</span> +</span><span id="flatten-382"><a href="#flatten-382"><span class="linenos">382</span></a> +</span><span id="flatten-383"><a href="#flatten-383"><span class="linenos">383</span></a><span class="sd"> Examples:</span> +</span><span id="flatten-384"><a href="#flatten-384"><span class="linenos">384</span></a><span class="sd"> >>> list(flatten([[1, 2], 3, {4}, (5, "bla")]))</span> +</span><span id="flatten-385"><a href="#flatten-385"><span class="linenos">385</span></a><span class="sd"> [1, 2, 3, 4, 5, 'bla']</span> +</span><span id="flatten-386"><a href="#flatten-386"><span class="linenos">386</span></a><span class="sd"> >>> list(flatten([1, 2, 3]))</span> +</span><span id="flatten-387"><a href="#flatten-387"><span class="linenos">387</span></a><span class="sd"> [1, 2, 3]</span> +</span><span id="flatten-388"><a href="#flatten-388"><span class="linenos">388</span></a> +</span><span id="flatten-389"><a href="#flatten-389"><span class="linenos">389</span></a><span class="sd"> Args:</span> +</span><span id="flatten-390"><a href="#flatten-390"><span class="linenos">390</span></a><span class="sd"> values: The value to be flattened.</span> +</span><span id="flatten-391"><a href="#flatten-391"><span class="linenos">391</span></a> +</span><span id="flatten-392"><a href="#flatten-392"><span class="linenos">392</span></a><span class="sd"> Yields:</span> +</span><span id="flatten-393"><a href="#flatten-393"><span class="linenos">393</span></a><span class="sd"> Non-iterable elements in `values`.</span> +</span><span id="flatten-394"><a href="#flatten-394"><span class="linenos">394</span></a><span class="sd"> """</span> +</span><span id="flatten-395"><a href="#flatten-395"><span class="linenos">395</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-396"><a href="#flatten-396"><span class="linenos">396</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-397"><a href="#flatten-397"><span class="linenos">397</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-398"><a href="#flatten-398"><span class="linenos">398</span></a> <span class="k">else</span><span class="p">:</span> +</span><span id="flatten-399"><a href="#flatten-399"><span class="linenos">399</span></a> <span class="k">yield</span> <span class="n">value</span> </span></pre></div> @@ -1400,7 +1453,7 @@ type <code>str</code> and <code>bytes</code> are not regarded as iterables.</p> <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>values:</strong> the value to be flattened.</li> +<li><strong>values:</strong> The value to be flattened.</li> </ul> <h6 id="yields">Yields:</h6> @@ -1423,42 +1476,36 @@ type <code>str</code> and <code>bytes</code> are not regarded as iterables.</p> </div> <a class="headerlink" href="#dict_depth"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="dict_depth-395"><a href="#dict_depth-395"><span class="linenos">395</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-396"><a href="#dict_depth-396"><span class="linenos">396</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="dict_depth-397"><a href="#dict_depth-397"><span class="linenos">397</span></a><span class="sd"> Get the nesting depth of a dictionary.</span> -</span><span id="dict_depth-398"><a href="#dict_depth-398"><span class="linenos">398</span></a> -</span><span id="dict_depth-399"><a href="#dict_depth-399"><span class="linenos">399</span></a><span class="sd"> For example:</span> -</span><span id="dict_depth-400"><a href="#dict_depth-400"><span class="linenos">400</span></a><span class="sd"> >>> dict_depth(None)</span> -</span><span id="dict_depth-401"><a href="#dict_depth-401"><span class="linenos">401</span></a><span class="sd"> 0</span> -</span><span id="dict_depth-402"><a href="#dict_depth-402"><span class="linenos">402</span></a><span class="sd"> >>> dict_depth({})</span> -</span><span id="dict_depth-403"><a href="#dict_depth-403"><span class="linenos">403</span></a><span class="sd"> 1</span> -</span><span id="dict_depth-404"><a href="#dict_depth-404"><span class="linenos">404</span></a><span class="sd"> >>> dict_depth({"a": "b"})</span> -</span><span id="dict_depth-405"><a href="#dict_depth-405"><span class="linenos">405</span></a><span class="sd"> 1</span> -</span><span id="dict_depth-406"><a href="#dict_depth-406"><span class="linenos">406</span></a><span class="sd"> >>> dict_depth({"a": {}})</span> -</span><span id="dict_depth-407"><a href="#dict_depth-407"><span class="linenos">407</span></a><span class="sd"> 2</span> -</span><span id="dict_depth-408"><a href="#dict_depth-408"><span class="linenos">408</span></a><span class="sd"> >>> dict_depth({"a": {"b": {}}})</span> -</span><span id="dict_depth-409"><a href="#dict_depth-409"><span class="linenos">409</span></a><span class="sd"> 3</span> -</span><span id="dict_depth-410"><a href="#dict_depth-410"><span class="linenos">410</span></a> -</span><span id="dict_depth-411"><a href="#dict_depth-411"><span class="linenos">411</span></a><span class="sd"> Args:</span> -</span><span id="dict_depth-412"><a href="#dict_depth-412"><span class="linenos">412</span></a><span class="sd"> d (dict): dictionary</span> -</span><span id="dict_depth-413"><a href="#dict_depth-413"><span class="linenos">413</span></a> -</span><span id="dict_depth-414"><a href="#dict_depth-414"><span class="linenos">414</span></a><span class="sd"> Returns:</span> -</span><span id="dict_depth-415"><a href="#dict_depth-415"><span class="linenos">415</span></a><span class="sd"> int: depth</span> -</span><span id="dict_depth-416"><a href="#dict_depth-416"><span class="linenos">416</span></a><span class="sd"> """</span> -</span><span id="dict_depth-417"><a href="#dict_depth-417"><span class="linenos">417</span></a> <span class="k">try</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">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-419"><a href="#dict_depth-419"><span class="linenos">419</span></a> <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> -</span><span id="dict_depth-420"><a href="#dict_depth-420"><span class="linenos">420</span></a> <span class="c1"># d doesn't have attribute "values"</span> -</span><span id="dict_depth-421"><a href="#dict_depth-421"><span class="linenos">421</span></a> <span class="k">return</span> <span class="mi">0</span> -</span><span id="dict_depth-422"><a href="#dict_depth-422"><span class="linenos">422</span></a> <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span> -</span><span id="dict_depth-423"><a href="#dict_depth-423"><span class="linenos">423</span></a> <span class="c1"># d.values() returns an empty sequence</span> -</span><span id="dict_depth-424"><a href="#dict_depth-424"><span class="linenos">424</span></a> <span class="k">return</span> <span class="mi">1</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="dict_depth-402"><a href="#dict_depth-402"><span class="linenos">402</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-403"><a href="#dict_depth-403"><span class="linenos">403</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="dict_depth-404"><a href="#dict_depth-404"><span class="linenos">404</span></a><span class="sd"> Get the nesting depth of a dictionary.</span> +</span><span id="dict_depth-405"><a href="#dict_depth-405"><span class="linenos">405</span></a> +</span><span id="dict_depth-406"><a href="#dict_depth-406"><span class="linenos">406</span></a><span class="sd"> Example:</span> +</span><span id="dict_depth-407"><a href="#dict_depth-407"><span class="linenos">407</span></a><span class="sd"> >>> dict_depth(None)</span> +</span><span id="dict_depth-408"><a href="#dict_depth-408"><span class="linenos">408</span></a><span class="sd"> 0</span> +</span><span id="dict_depth-409"><a href="#dict_depth-409"><span class="linenos">409</span></a><span class="sd"> >>> dict_depth({})</span> +</span><span id="dict_depth-410"><a href="#dict_depth-410"><span class="linenos">410</span></a><span class="sd"> 1</span> +</span><span id="dict_depth-411"><a href="#dict_depth-411"><span class="linenos">411</span></a><span class="sd"> >>> dict_depth({"a": "b"})</span> +</span><span id="dict_depth-412"><a href="#dict_depth-412"><span class="linenos">412</span></a><span class="sd"> 1</span> +</span><span id="dict_depth-413"><a href="#dict_depth-413"><span class="linenos">413</span></a><span class="sd"> >>> dict_depth({"a": {}})</span> +</span><span id="dict_depth-414"><a href="#dict_depth-414"><span class="linenos">414</span></a><span class="sd"> 2</span> +</span><span id="dict_depth-415"><a href="#dict_depth-415"><span class="linenos">415</span></a><span class="sd"> >>> dict_depth({"a": {"b": {}}})</span> +</span><span id="dict_depth-416"><a href="#dict_depth-416"><span class="linenos">416</span></a><span class="sd"> 3</span> +</span><span id="dict_depth-417"><a href="#dict_depth-417"><span class="linenos">417</span></a><span class="sd"> """</span> +</span><span id="dict_depth-418"><a href="#dict_depth-418"><span class="linenos">418</span></a> <span class="k">try</span><span class="p">:</span> +</span><span id="dict_depth-419"><a href="#dict_depth-419"><span class="linenos">419</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-420"><a href="#dict_depth-420"><span class="linenos">420</span></a> <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> +</span><span id="dict_depth-421"><a href="#dict_depth-421"><span class="linenos">421</span></a> <span class="c1"># d doesn't have attribute "values"</span> +</span><span id="dict_depth-422"><a href="#dict_depth-422"><span class="linenos">422</span></a> <span class="k">return</span> <span class="mi">0</span> +</span><span id="dict_depth-423"><a href="#dict_depth-423"><span class="linenos">423</span></a> <span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span> +</span><span id="dict_depth-424"><a href="#dict_depth-424"><span class="linenos">424</span></a> <span class="c1"># d.values() returns an empty sequence</span> +</span><span id="dict_depth-425"><a href="#dict_depth-425"><span class="linenos">425</span></a> <span class="k">return</span> <span class="mi">1</span> </span></pre></div> <div class="docstring"><p>Get the nesting depth of a dictionary.</p> -<h6 id="for-example">For example:</h6> +<h6 id="example">Example:</h6> <blockquote> <div class="pdoc-code codehilite"> @@ -1475,18 +1522,6 @@ type <code>str</code> and <code>bytes</code> are not regarded as iterables.</p> </code></pre> </div> </blockquote> - -<h6 id="arguments">Arguments:</h6> - -<ul> -<li><strong>d (dict):</strong> dictionary</li> -</ul> - -<h6 id="returns">Returns:</h6> - -<blockquote> - <p>int: depth</p> -</blockquote> </div> @@ -1502,18 +1537,13 @@ type <code>str</code> and <code>bytes</code> are not regarded as iterables.</p> </div> <a class="headerlink" href="#first"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="first-427"><a href="#first-427"><span class="linenos">427</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-428"><a href="#first-428"><span class="linenos">428</span></a><span class="w"> </span><span class="sd">"""Returns the first element from an iterable.</span> -</span><span id="first-429"><a href="#first-429"><span class="linenos">429</span></a> -</span><span id="first-430"><a href="#first-430"><span class="linenos">430</span></a><span class="sd"> Useful for sets.</span> -</span><span id="first-431"><a href="#first-431"><span class="linenos">431</span></a><span class="sd"> """</span> -</span><span id="first-432"><a href="#first-432"><span class="linenos">432</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-428"><a href="#first-428"><span class="linenos">428</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-429"><a href="#first-429"><span class="linenos">429</span></a><span class="w"> </span><span class="sd">"""Returns the first element from an iterable (useful for sets)."""</span> +</span><span id="first-430"><a href="#first-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></pre></div> - <div class="docstring"><p>Returns the first element from an iterable.</p> - -<p>Useful for sets.</p> + <div class="docstring"><p>Returns the first element from an iterable (useful for sets).</p> </div> |