diff options
Diffstat (limited to 'docs/sqlglot/trie.html')
| -rw-r--r-- | docs/sqlglot/trie.html | 380 |
1 files changed, 250 insertions, 130 deletions
diff --git a/docs/sqlglot/trie.html b/docs/sqlglot/trie.html index 93c0938..eab6435 100644 --- a/docs/sqlglot/trie.html +++ b/docs/sqlglot/trie.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.trie 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,24 @@ <h2>API Documentation</h2> <ul class="memberlist"> <li> + <a class="variable" href="#key">key</a> + </li> + <li> + <a class="class" href="#TrieResult">TrieResult</a> + <ul class="memberlist"> + <li> + <a class="variable" href="#TrieResult.FAILED">FAILED</a> + </li> + <li> + <a class="variable" href="#TrieResult.PREFIX">PREFIX</a> + </li> + <li> + <a class="variable" href="#TrieResult.EXISTS">EXISTS</a> + </li> + </ul> + + </li> + <li> <a class="function" href="#new_trie">new_trie</a> </li> <li> @@ -60,79 +78,171 @@ <label class="view-source-button" for="mod-trie-view-source"><span>View Source</span></label> <div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos"> 1</span></a><span class="kn">import</span> <span class="nn">typing</span> <span class="k">as</span> <span class="nn">t</span> -</span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a> -</span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a><span class="n">key</span> <span class="o">=</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="o">.</span><span class="n">Hashable</span><span class="p">]</span> -</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a> +</span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span><span class="p">,</span> <span class="n">auto</span> +</span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a> +</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a><span class="n">key</span> <span class="o">=</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="o">.</span><span class="n">Hashable</span><span class="p">]</span> </span><span id="L-5"><a href="#L-5"><span class="linenos"> 5</span></a> -</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a><span class="k">def</span> <span class="nf">new_trie</span><span class="p">(</span><span class="n">keywords</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">key</span><span class="p">],</span> <span class="n">trie</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">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</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-7"><a href="#L-7"><span class="linenos"> 7</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a><span class="sd"> Creates a new trie out of a collection of keywords.</span> -</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a> -</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a><span class="sd"> The trie is represented as a sequence of nested dictionaries keyed by either single character</span> -</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a><span class="sd"> strings, or by 0, which is used to designate that a keyword is in the trie.</span> +</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a> +</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a><span class="k">class</span> <span class="nc">TrieResult</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span> +</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a> <span class="n">FAILED</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span> +</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a> <span class="n">PREFIX</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span> +</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a> <span class="n">EXISTS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span> +</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a> </span><span id="L-12"><a href="#L-12"><span class="linenos">12</span></a> -</span><span id="L-13"><a href="#L-13"><span class="linenos">13</span></a><span class="sd"> Example:</span> -</span><span id="L-14"><a href="#L-14"><span class="linenos">14</span></a><span class="sd"> >>> new_trie(["bla", "foo", "blab"])</span> -</span><span id="L-15"><a href="#L-15"><span class="linenos">15</span></a><span class="sd"> {'b': {'l': {'a': {0: True, 'b': {0: True}}}}, 'f': {'o': {'o': {0: True}}}}</span> +</span><span id="L-13"><a href="#L-13"><span class="linenos">13</span></a><span class="k">def</span> <span class="nf">new_trie</span><span class="p">(</span><span class="n">keywords</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">key</span><span class="p">],</span> <span class="n">trie</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">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</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-14"><a href="#L-14"><span class="linenos">14</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-15"><a href="#L-15"><span class="linenos">15</span></a><span class="sd"> Creates a new trie out of a collection of keywords.</span> </span><span id="L-16"><a href="#L-16"><span class="linenos">16</span></a> -</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a><span class="sd"> Args:</span> -</span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a><span class="sd"> keywords: the keywords to create the trie from.</span> -</span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a><span class="sd"> trie: a trie to mutate instead of creating a new one</span> -</span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a> -</span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a><span class="sd"> Returns:</span> -</span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a><span class="sd"> The trie corresponding to `keywords`.</span> -</span><span id="L-23"><a href="#L-23"><span class="linenos">23</span></a><span class="sd"> """</span> -</span><span id="L-24"><a href="#L-24"><span class="linenos">24</span></a> <span class="n">trie</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">trie</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">trie</span> -</span><span id="L-25"><a href="#L-25"><span class="linenos">25</span></a> -</span><span id="L-26"><a href="#L-26"><span class="linenos">26</span></a> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keywords</span><span class="p">:</span> -</span><span id="L-27"><a href="#L-27"><span class="linenos">27</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">trie</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="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">key</span><span class="p">:</span> -</span><span id="L-30"><a href="#L-30"><span class="linenos">30</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">current</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">char</span><span class="p">,</span> <span class="p">{})</span> -</span><span id="L-31"><a href="#L-31"><span class="linenos">31</span></a> <span class="n">current</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span> +</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a><span class="sd"> The trie is represented as a sequence of nested dictionaries keyed by either single</span> +</span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a><span class="sd"> character strings, or by 0, which is used to designate that a keyword is in the trie.</span> +</span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a> +</span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a><span class="sd"> Example:</span> +</span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a><span class="sd"> >>> new_trie(["bla", "foo", "blab"])</span> +</span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a><span class="sd"> {'b': {'l': {'a': {0: True, 'b': {0: True}}}}, 'f': {'o': {'o': {0: True}}}}</span> +</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="sd"> Args:</span> +</span><span id="L-25"><a href="#L-25"><span class="linenos">25</span></a><span class="sd"> keywords: the keywords to create the trie from.</span> +</span><span id="L-26"><a href="#L-26"><span class="linenos">26</span></a><span class="sd"> trie: a trie to mutate instead of creating a new one</span> +</span><span id="L-27"><a href="#L-27"><span class="linenos">27</span></a> +</span><span id="L-28"><a href="#L-28"><span class="linenos">28</span></a><span class="sd"> Returns:</span> +</span><span id="L-29"><a href="#L-29"><span class="linenos">29</span></a><span class="sd"> The trie corresponding to `keywords`.</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 class="n">trie</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">trie</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">trie</span> </span><span id="L-32"><a href="#L-32"><span class="linenos">32</span></a> -</span><span id="L-33"><a href="#L-33"><span class="linenos">33</span></a> <span class="k">return</span> <span class="n">trie</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">in_trie</span><span class="p">(</span><span class="n">trie</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">key</span><span class="p">:</span> <span class="n">key</span><span class="p">)</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="nb">int</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</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">"""</span> -</span><span id="L-38"><a href="#L-38"><span class="linenos">38</span></a><span class="sd"> Checks whether a key is in a trie.</span> +</span><span id="L-33"><a href="#L-33"><span class="linenos">33</span></a> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keywords</span><span class="p">:</span> +</span><span id="L-34"><a href="#L-34"><span class="linenos">34</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">trie</span> +</span><span id="L-35"><a href="#L-35"><span class="linenos">35</span></a> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">key</span><span class="p">:</span> +</span><span id="L-36"><a href="#L-36"><span class="linenos">36</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">current</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">char</span><span class="p">,</span> <span class="p">{})</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 class="n">current</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span> </span><span id="L-39"><a href="#L-39"><span class="linenos">39</span></a> -</span><span id="L-40"><a href="#L-40"><span class="linenos">40</span></a><span class="sd"> Examples:</span> -</span><span id="L-41"><a href="#L-41"><span class="linenos">41</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "bob")</span> -</span><span id="L-42"><a href="#L-42"><span class="linenos">42</span></a><span class="sd"> (0, {'c': {'a': {'t': {0: True}}}})</span> -</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="sd"> >>> in_trie(new_trie(["cat"]), "ca")</span> -</span><span id="L-45"><a href="#L-45"><span class="linenos">45</span></a><span class="sd"> (1, {'t': {0: True}})</span> +</span><span id="L-40"><a href="#L-40"><span class="linenos">40</span></a> <span class="k">return</span> <span class="n">trie</span> +</span><span id="L-41"><a href="#L-41"><span class="linenos">41</span></a> +</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 class="k">def</span> <span class="nf">in_trie</span><span class="p">(</span><span class="n">trie</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">key</span><span class="p">:</span> <span class="n">key</span><span class="p">)</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">TrieResult</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">]:</span> +</span><span id="L-44"><a href="#L-44"><span class="linenos">44</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-45"><a href="#L-45"><span class="linenos">45</span></a><span class="sd"> Checks whether a key is in a trie.</span> </span><span id="L-46"><a href="#L-46"><span class="linenos">46</span></a> -</span><span id="L-47"><a href="#L-47"><span class="linenos">47</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "cat")</span> -</span><span id="L-48"><a href="#L-48"><span class="linenos">48</span></a><span class="sd"> (2, {0: True})</span> -</span><span id="L-49"><a href="#L-49"><span class="linenos">49</span></a> -</span><span id="L-50"><a href="#L-50"><span class="linenos">50</span></a><span class="sd"> Args:</span> -</span><span id="L-51"><a href="#L-51"><span class="linenos">51</span></a><span class="sd"> trie: the trie to be searched.</span> -</span><span id="L-52"><a href="#L-52"><span class="linenos">52</span></a><span class="sd"> key: the target key.</span> +</span><span id="L-47"><a href="#L-47"><span class="linenos">47</span></a><span class="sd"> Examples:</span> +</span><span id="L-48"><a href="#L-48"><span class="linenos">48</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "bob")</span> +</span><span id="L-49"><a href="#L-49"><span class="linenos">49</span></a><span class="sd"> (<TrieResult.FAILED: 1>, {'c': {'a': {'t': {0: True}}}})</span> +</span><span id="L-50"><a href="#L-50"><span class="linenos">50</span></a> +</span><span id="L-51"><a href="#L-51"><span class="linenos">51</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "ca")</span> +</span><span id="L-52"><a href="#L-52"><span class="linenos">52</span></a><span class="sd"> (<TrieResult.PREFIX: 2>, {'t': {0: True}})</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="sd"> Returns:</span> -</span><span id="L-55"><a href="#L-55"><span class="linenos">55</span></a><span class="sd"> A pair `(value, subtrie)`, where `subtrie` is the sub-trie we get at the point where the search stops, and `value`</span> -</span><span id="L-56"><a href="#L-56"><span class="linenos">56</span></a><span class="sd"> is either 0 (search was unsuccessful), 1 (`value` is a prefix of a keyword in `trie`) or 2 (`key is in `trie`).</span> -</span><span id="L-57"><a href="#L-57"><span class="linenos">57</span></a><span class="sd"> """</span> -</span><span id="L-58"><a href="#L-58"><span class="linenos">58</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">key</span><span class="p">:</span> -</span><span id="L-59"><a href="#L-59"><span class="linenos">59</span></a> <span class="k">return</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">trie</span><span class="p">)</span> +</span><span id="L-54"><a href="#L-54"><span class="linenos">54</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "cat")</span> +</span><span id="L-55"><a href="#L-55"><span class="linenos">55</span></a><span class="sd"> (<TrieResult.EXISTS: 3>, {0: True})</span> +</span><span id="L-56"><a href="#L-56"><span class="linenos">56</span></a> +</span><span id="L-57"><a href="#L-57"><span class="linenos">57</span></a><span class="sd"> Args:</span> +</span><span id="L-58"><a href="#L-58"><span class="linenos">58</span></a><span class="sd"> trie: The trie to be searched.</span> +</span><span id="L-59"><a href="#L-59"><span class="linenos">59</span></a><span class="sd"> key: The target key.</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="n">current</span> <span class="o">=</span> <span class="n">trie</span> -</span><span id="L-62"><a href="#L-62"><span class="linenos">62</span></a> -</span><span id="L-63"><a href="#L-63"><span class="linenos">63</span></a> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">key</span><span class="p">:</span> -</span><span id="L-64"><a href="#L-64"><span class="linenos">64</span></a> <span class="k">if</span> <span class="n">char</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">current</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 class="mi">0</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> -</span><span id="L-66"><a href="#L-66"><span class="linenos">66</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">current</span><span class="p">[</span><span class="n">char</span><span class="p">]</span> -</span><span id="L-67"><a href="#L-67"><span class="linenos">67</span></a> -</span><span id="L-68"><a href="#L-68"><span class="linenos">68</span></a> <span class="k">if</span> <span class="mi">0</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> -</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="mi">2</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> -</span><span id="L-70"><a href="#L-70"><span class="linenos">70</span></a> <span class="k">return</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> +</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"> A pair `(value, subtrie)`, where `subtrie` is the sub-trie we get at the point</span> +</span><span id="L-63"><a href="#L-63"><span class="linenos">63</span></a><span class="sd"> where the search stops, and `value` is a TrieResult value that can be one of:</span> +</span><span id="L-64"><a href="#L-64"><span class="linenos">64</span></a> +</span><span id="L-65"><a href="#L-65"><span class="linenos">65</span></a><span class="sd"> - TrieResult.FAILED: the search was unsuccessful</span> +</span><span id="L-66"><a href="#L-66"><span class="linenos">66</span></a><span class="sd"> - TrieResult.PREFIX: `value` is a prefix of a keyword in `trie`</span> +</span><span id="L-67"><a href="#L-67"><span class="linenos">67</span></a><span class="sd"> - TrieResult.EXISTS: `key` exists in `trie`</span> +</span><span id="L-68"><a href="#L-68"><span class="linenos">68</span></a><span class="sd"> """</span> +</span><span id="L-69"><a href="#L-69"><span class="linenos">69</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">key</span><span class="p">:</span> +</span><span id="L-70"><a href="#L-70"><span class="linenos">70</span></a> <span class="k">return</span> <span class="p">(</span><span class="n">TrieResult</span><span class="o">.</span><span class="n">FAILED</span><span class="p">,</span> <span class="n">trie</span><span class="p">)</span> +</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="n">current</span> <span class="o">=</span> <span class="n">trie</span> +</span><span id="L-73"><a href="#L-73"><span class="linenos">73</span></a> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">key</span><span class="p">:</span> +</span><span id="L-74"><a href="#L-74"><span class="linenos">74</span></a> <span class="k">if</span> <span class="n">char</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> +</span><span id="L-75"><a href="#L-75"><span class="linenos">75</span></a> <span class="k">return</span> <span class="p">(</span><span class="n">TrieResult</span><span class="o">.</span><span class="n">FAILED</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> +</span><span id="L-76"><a href="#L-76"><span class="linenos">76</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">current</span><span class="p">[</span><span class="n">char</span><span class="p">]</span> +</span><span id="L-77"><a href="#L-77"><span class="linenos">77</span></a> +</span><span id="L-78"><a href="#L-78"><span class="linenos">78</span></a> <span class="k">if</span> <span class="mi">0</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> +</span><span id="L-79"><a href="#L-79"><span class="linenos">79</span></a> <span class="k">return</span> <span class="p">(</span><span class="n">TrieResult</span><span class="o">.</span><span class="n">EXISTS</span><span class="p">,</span> <span class="n">current</span><span class="p">)</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="k">return</span> <span class="p">(</span><span class="n">TrieResult</span><span class="o">.</span><span class="n">PREFIX</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> </span></pre></div> </section> + <section id="key"> + <div class="attr variable"> + <span class="name">key</span> = +<span class="default_value">typing.Sequence[typing.Hashable]</span> + + + </div> + <a class="headerlink" href="#key"></a> + + + + </section> + <section id="TrieResult"> + <input id="TrieResult-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1"> +<div class="attr class"> + + <span class="def">class</span> + <span class="name">TrieResult</span><wbr>(<span class="base">enum.Enum</span>): + + <label class="view-source-button" for="TrieResult-view-source"><span>View Source</span></label> + + </div> + <a class="headerlink" href="#TrieResult"></a> + <div class="pdoc-code codehilite"><pre><span></span><span id="TrieResult-8"><a href="#TrieResult-8"><span class="linenos"> 8</span></a><span class="k">class</span> <span class="nc">TrieResult</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span> +</span><span id="TrieResult-9"><a href="#TrieResult-9"><span class="linenos"> 9</span></a> <span class="n">FAILED</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span> +</span><span id="TrieResult-10"><a href="#TrieResult-10"><span class="linenos">10</span></a> <span class="n">PREFIX</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span> +</span><span id="TrieResult-11"><a href="#TrieResult-11"><span class="linenos">11</span></a> <span class="n">EXISTS</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span> +</span></pre></div> + + + <div class="docstring"><p>An enumeration.</p> +</div> + + + <div id="TrieResult.FAILED" class="classattr"> + <div class="attr variable"> + <span class="name">FAILED</span> = +<span class="default_value"><<a href="#TrieResult.FAILED">TrieResult.FAILED</a>: 1></span> + + + </div> + <a class="headerlink" href="#TrieResult.FAILED"></a> + + + + </div> + <div id="TrieResult.PREFIX" class="classattr"> + <div class="attr variable"> + <span class="name">PREFIX</span> = +<span class="default_value"><<a href="#TrieResult.PREFIX">TrieResult.PREFIX</a>: 2></span> + + + </div> + <a class="headerlink" href="#TrieResult.PREFIX"></a> + + + + </div> + <div id="TrieResult.EXISTS" class="classattr"> + <div class="attr variable"> + <span class="name">EXISTS</span> = +<span class="default_value"><<a href="#TrieResult.EXISTS">TrieResult.EXISTS</a>: 3></span> + + + </div> + <a class="headerlink" href="#TrieResult.EXISTS"></a> + + + + </div> + <div class="inherited"> + <h5>Inherited Members</h5> + <dl> + <div><dt>enum.Enum</dt> + <dd id="TrieResult.name" class="variable">name</dd> + <dd id="TrieResult.value" class="variable">value</dd> + + </div> + </dl> + </div> + </section> <section id="new_trie"> <input id="new_trie-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1"> <div class="attr function"> @@ -144,41 +254,41 @@ </div> <a class="headerlink" href="#new_trie"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="new_trie-7"><a href="#new_trie-7"><span class="linenos"> 7</span></a><span class="k">def</span> <span class="nf">new_trie</span><span class="p">(</span><span class="n">keywords</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">key</span><span class="p">],</span> <span class="n">trie</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">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</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="new_trie-8"><a href="#new_trie-8"><span class="linenos"> 8</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="new_trie-9"><a href="#new_trie-9"><span class="linenos"> 9</span></a><span class="sd"> Creates a new trie out of a collection of keywords.</span> -</span><span id="new_trie-10"><a href="#new_trie-10"><span class="linenos">10</span></a> -</span><span id="new_trie-11"><a href="#new_trie-11"><span class="linenos">11</span></a><span class="sd"> The trie is represented as a sequence of nested dictionaries keyed by either single character</span> -</span><span id="new_trie-12"><a href="#new_trie-12"><span class="linenos">12</span></a><span class="sd"> strings, or by 0, which is used to designate that a keyword is in the trie.</span> -</span><span id="new_trie-13"><a href="#new_trie-13"><span class="linenos">13</span></a> -</span><span id="new_trie-14"><a href="#new_trie-14"><span class="linenos">14</span></a><span class="sd"> Example:</span> -</span><span id="new_trie-15"><a href="#new_trie-15"><span class="linenos">15</span></a><span class="sd"> >>> new_trie(["bla", "foo", "blab"])</span> -</span><span id="new_trie-16"><a href="#new_trie-16"><span class="linenos">16</span></a><span class="sd"> {'b': {'l': {'a': {0: True, 'b': {0: True}}}}, 'f': {'o': {'o': {0: True}}}}</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="new_trie-14"><a href="#new_trie-14"><span class="linenos">14</span></a><span class="k">def</span> <span class="nf">new_trie</span><span class="p">(</span><span class="n">keywords</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">key</span><span class="p">],</span> <span class="n">trie</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">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</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="new_trie-15"><a href="#new_trie-15"><span class="linenos">15</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="new_trie-16"><a href="#new_trie-16"><span class="linenos">16</span></a><span class="sd"> Creates a new trie out of a collection of keywords.</span> </span><span id="new_trie-17"><a href="#new_trie-17"><span class="linenos">17</span></a> -</span><span id="new_trie-18"><a href="#new_trie-18"><span class="linenos">18</span></a><span class="sd"> Args:</span> -</span><span id="new_trie-19"><a href="#new_trie-19"><span class="linenos">19</span></a><span class="sd"> keywords: the keywords to create the trie from.</span> -</span><span id="new_trie-20"><a href="#new_trie-20"><span class="linenos">20</span></a><span class="sd"> trie: a trie to mutate instead of creating a new one</span> -</span><span id="new_trie-21"><a href="#new_trie-21"><span class="linenos">21</span></a> -</span><span id="new_trie-22"><a href="#new_trie-22"><span class="linenos">22</span></a><span class="sd"> Returns:</span> -</span><span id="new_trie-23"><a href="#new_trie-23"><span class="linenos">23</span></a><span class="sd"> The trie corresponding to `keywords`.</span> -</span><span id="new_trie-24"><a href="#new_trie-24"><span class="linenos">24</span></a><span class="sd"> """</span> -</span><span id="new_trie-25"><a href="#new_trie-25"><span class="linenos">25</span></a> <span class="n">trie</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">trie</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">trie</span> -</span><span id="new_trie-26"><a href="#new_trie-26"><span class="linenos">26</span></a> -</span><span id="new_trie-27"><a href="#new_trie-27"><span class="linenos">27</span></a> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keywords</span><span class="p">:</span> -</span><span id="new_trie-28"><a href="#new_trie-28"><span class="linenos">28</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">trie</span> -</span><span id="new_trie-29"><a href="#new_trie-29"><span class="linenos">29</span></a> -</span><span id="new_trie-30"><a href="#new_trie-30"><span class="linenos">30</span></a> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">key</span><span class="p">:</span> -</span><span id="new_trie-31"><a href="#new_trie-31"><span class="linenos">31</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">current</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">char</span><span class="p">,</span> <span class="p">{})</span> -</span><span id="new_trie-32"><a href="#new_trie-32"><span class="linenos">32</span></a> <span class="n">current</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span> +</span><span id="new_trie-18"><a href="#new_trie-18"><span class="linenos">18</span></a><span class="sd"> The trie is represented as a sequence of nested dictionaries keyed by either single</span> +</span><span id="new_trie-19"><a href="#new_trie-19"><span class="linenos">19</span></a><span class="sd"> character strings, or by 0, which is used to designate that a keyword is in the trie.</span> +</span><span id="new_trie-20"><a href="#new_trie-20"><span class="linenos">20</span></a> +</span><span id="new_trie-21"><a href="#new_trie-21"><span class="linenos">21</span></a><span class="sd"> Example:</span> +</span><span id="new_trie-22"><a href="#new_trie-22"><span class="linenos">22</span></a><span class="sd"> >>> new_trie(["bla", "foo", "blab"])</span> +</span><span id="new_trie-23"><a href="#new_trie-23"><span class="linenos">23</span></a><span class="sd"> {'b': {'l': {'a': {0: True, 'b': {0: True}}}}, 'f': {'o': {'o': {0: True}}}}</span> +</span><span id="new_trie-24"><a href="#new_trie-24"><span class="linenos">24</span></a> +</span><span id="new_trie-25"><a href="#new_trie-25"><span class="linenos">25</span></a><span class="sd"> Args:</span> +</span><span id="new_trie-26"><a href="#new_trie-26"><span class="linenos">26</span></a><span class="sd"> keywords: the keywords to create the trie from.</span> +</span><span id="new_trie-27"><a href="#new_trie-27"><span class="linenos">27</span></a><span class="sd"> trie: a trie to mutate instead of creating a new one</span> +</span><span id="new_trie-28"><a href="#new_trie-28"><span class="linenos">28</span></a> +</span><span id="new_trie-29"><a href="#new_trie-29"><span class="linenos">29</span></a><span class="sd"> Returns:</span> +</span><span id="new_trie-30"><a href="#new_trie-30"><span class="linenos">30</span></a><span class="sd"> The trie corresponding to `keywords`.</span> +</span><span id="new_trie-31"><a href="#new_trie-31"><span class="linenos">31</span></a><span class="sd"> """</span> +</span><span id="new_trie-32"><a href="#new_trie-32"><span class="linenos">32</span></a> <span class="n">trie</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">trie</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">trie</span> </span><span id="new_trie-33"><a href="#new_trie-33"><span class="linenos">33</span></a> -</span><span id="new_trie-34"><a href="#new_trie-34"><span class="linenos">34</span></a> <span class="k">return</span> <span class="n">trie</span> +</span><span id="new_trie-34"><a href="#new_trie-34"><span class="linenos">34</span></a> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keywords</span><span class="p">:</span> +</span><span id="new_trie-35"><a href="#new_trie-35"><span class="linenos">35</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">trie</span> +</span><span id="new_trie-36"><a href="#new_trie-36"><span class="linenos">36</span></a> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">key</span><span class="p">:</span> +</span><span id="new_trie-37"><a href="#new_trie-37"><span class="linenos">37</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">current</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">char</span><span class="p">,</span> <span class="p">{})</span> +</span><span id="new_trie-38"><a href="#new_trie-38"><span class="linenos">38</span></a> +</span><span id="new_trie-39"><a href="#new_trie-39"><span class="linenos">39</span></a> <span class="n">current</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span> +</span><span id="new_trie-40"><a href="#new_trie-40"><span class="linenos">40</span></a> +</span><span id="new_trie-41"><a href="#new_trie-41"><span class="linenos">41</span></a> <span class="k">return</span> <span class="n">trie</span> </span></pre></div> <div class="docstring"><p>Creates a new trie out of a collection of keywords.</p> -<p>The trie is represented as a sequence of nested dictionaries keyed by either single character -strings, or by 0, which is used to designate that a keyword is in the trie.</p> +<p>The trie is represented as a sequence of nested dictionaries keyed by either single +character strings, or by 0, which is used to designate that a keyword is in the trie.</p> <h6 id="example">Example:</h6> @@ -211,47 +321,51 @@ strings, or by 0, which is used to designate that a keyword is in the trie.</p> <div class="attr function"> <span class="def">def</span> - <span class="name">in_trie</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">trie</span><span class="p">:</span> <span class="n">Dict</span>, </span><span class="param"><span class="n">key</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Hashable</span><span class="p">]</span></span><span class="return-annotation">) -> <span class="n">Tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">Dict</span><span class="p">]</span>:</span></span> + <span class="name">in_trie</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">trie</span><span class="p">:</span> <span class="n">Dict</span>,</span><span class="param"> <span class="n">key</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Hashable</span><span class="p">]</span></span><span class="return-annotation">) -> <span class="n">Tuple</span><span class="p">[</span><span class="n"><a href="#TrieResult">sqlglot.trie.TrieResult</a></span><span class="p">,</span> <span class="n">Dict</span><span class="p">]</span>:</span></span> <label class="view-source-button" for="in_trie-view-source"><span>View Source</span></label> </div> <a class="headerlink" href="#in_trie"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="in_trie-37"><a href="#in_trie-37"><span class="linenos">37</span></a><span class="k">def</span> <span class="nf">in_trie</span><span class="p">(</span><span class="n">trie</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">key</span><span class="p">:</span> <span class="n">key</span><span class="p">)</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="nb">int</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">]:</span> -</span><span id="in_trie-38"><a href="#in_trie-38"><span class="linenos">38</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="in_trie-39"><a href="#in_trie-39"><span class="linenos">39</span></a><span class="sd"> Checks whether a key is in a trie.</span> -</span><span id="in_trie-40"><a href="#in_trie-40"><span class="linenos">40</span></a> -</span><span id="in_trie-41"><a href="#in_trie-41"><span class="linenos">41</span></a><span class="sd"> Examples:</span> -</span><span id="in_trie-42"><a href="#in_trie-42"><span class="linenos">42</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "bob")</span> -</span><span id="in_trie-43"><a href="#in_trie-43"><span class="linenos">43</span></a><span class="sd"> (0, {'c': {'a': {'t': {0: True}}}})</span> -</span><span id="in_trie-44"><a href="#in_trie-44"><span class="linenos">44</span></a> -</span><span id="in_trie-45"><a href="#in_trie-45"><span class="linenos">45</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "ca")</span> -</span><span id="in_trie-46"><a href="#in_trie-46"><span class="linenos">46</span></a><span class="sd"> (1, {'t': {0: True}})</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="in_trie-44"><a href="#in_trie-44"><span class="linenos">44</span></a><span class="k">def</span> <span class="nf">in_trie</span><span class="p">(</span><span class="n">trie</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">key</span><span class="p">:</span> <span class="n">key</span><span class="p">)</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">TrieResult</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">Dict</span><span class="p">]:</span> +</span><span id="in_trie-45"><a href="#in_trie-45"><span class="linenos">45</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="in_trie-46"><a href="#in_trie-46"><span class="linenos">46</span></a><span class="sd"> Checks whether a key is in a trie.</span> </span><span id="in_trie-47"><a href="#in_trie-47"><span class="linenos">47</span></a> -</span><span id="in_trie-48"><a href="#in_trie-48"><span class="linenos">48</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "cat")</span> -</span><span id="in_trie-49"><a href="#in_trie-49"><span class="linenos">49</span></a><span class="sd"> (2, {0: True})</span> -</span><span id="in_trie-50"><a href="#in_trie-50"><span class="linenos">50</span></a> -</span><span id="in_trie-51"><a href="#in_trie-51"><span class="linenos">51</span></a><span class="sd"> Args:</span> -</span><span id="in_trie-52"><a href="#in_trie-52"><span class="linenos">52</span></a><span class="sd"> trie: the trie to be searched.</span> -</span><span id="in_trie-53"><a href="#in_trie-53"><span class="linenos">53</span></a><span class="sd"> key: the target key.</span> +</span><span id="in_trie-48"><a href="#in_trie-48"><span class="linenos">48</span></a><span class="sd"> Examples:</span> +</span><span id="in_trie-49"><a href="#in_trie-49"><span class="linenos">49</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "bob")</span> +</span><span id="in_trie-50"><a href="#in_trie-50"><span class="linenos">50</span></a><span class="sd"> (<TrieResult.FAILED: 1>, {'c': {'a': {'t': {0: True}}}})</span> +</span><span id="in_trie-51"><a href="#in_trie-51"><span class="linenos">51</span></a> +</span><span id="in_trie-52"><a href="#in_trie-52"><span class="linenos">52</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "ca")</span> +</span><span id="in_trie-53"><a href="#in_trie-53"><span class="linenos">53</span></a><span class="sd"> (<TrieResult.PREFIX: 2>, {'t': {0: True}})</span> </span><span id="in_trie-54"><a href="#in_trie-54"><span class="linenos">54</span></a> -</span><span id="in_trie-55"><a href="#in_trie-55"><span class="linenos">55</span></a><span class="sd"> Returns:</span> -</span><span id="in_trie-56"><a href="#in_trie-56"><span class="linenos">56</span></a><span class="sd"> A pair `(value, subtrie)`, where `subtrie` is the sub-trie we get at the point where the search stops, and `value`</span> -</span><span id="in_trie-57"><a href="#in_trie-57"><span class="linenos">57</span></a><span class="sd"> is either 0 (search was unsuccessful), 1 (`value` is a prefix of a keyword in `trie`) or 2 (`key is in `trie`).</span> -</span><span id="in_trie-58"><a href="#in_trie-58"><span class="linenos">58</span></a><span class="sd"> """</span> -</span><span id="in_trie-59"><a href="#in_trie-59"><span class="linenos">59</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">key</span><span class="p">:</span> -</span><span id="in_trie-60"><a href="#in_trie-60"><span class="linenos">60</span></a> <span class="k">return</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">trie</span><span class="p">)</span> +</span><span id="in_trie-55"><a href="#in_trie-55"><span class="linenos">55</span></a><span class="sd"> >>> in_trie(new_trie(["cat"]), "cat")</span> +</span><span id="in_trie-56"><a href="#in_trie-56"><span class="linenos">56</span></a><span class="sd"> (<TrieResult.EXISTS: 3>, {0: True})</span> +</span><span id="in_trie-57"><a href="#in_trie-57"><span class="linenos">57</span></a> +</span><span id="in_trie-58"><a href="#in_trie-58"><span class="linenos">58</span></a><span class="sd"> Args:</span> +</span><span id="in_trie-59"><a href="#in_trie-59"><span class="linenos">59</span></a><span class="sd"> trie: The trie to be searched.</span> +</span><span id="in_trie-60"><a href="#in_trie-60"><span class="linenos">60</span></a><span class="sd"> key: The target key.</span> </span><span id="in_trie-61"><a href="#in_trie-61"><span class="linenos">61</span></a> -</span><span id="in_trie-62"><a href="#in_trie-62"><span class="linenos">62</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">trie</span> -</span><span id="in_trie-63"><a href="#in_trie-63"><span class="linenos">63</span></a> -</span><span id="in_trie-64"><a href="#in_trie-64"><span class="linenos">64</span></a> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">key</span><span class="p">:</span> -</span><span id="in_trie-65"><a href="#in_trie-65"><span class="linenos">65</span></a> <span class="k">if</span> <span class="n">char</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> -</span><span id="in_trie-66"><a href="#in_trie-66"><span class="linenos">66</span></a> <span class="k">return</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> -</span><span id="in_trie-67"><a href="#in_trie-67"><span class="linenos">67</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">current</span><span class="p">[</span><span class="n">char</span><span class="p">]</span> -</span><span id="in_trie-68"><a href="#in_trie-68"><span class="linenos">68</span></a> -</span><span id="in_trie-69"><a href="#in_trie-69"><span class="linenos">69</span></a> <span class="k">if</span> <span class="mi">0</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> -</span><span id="in_trie-70"><a href="#in_trie-70"><span class="linenos">70</span></a> <span class="k">return</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> -</span><span id="in_trie-71"><a href="#in_trie-71"><span class="linenos">71</span></a> <span class="k">return</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> +</span><span id="in_trie-62"><a href="#in_trie-62"><span class="linenos">62</span></a><span class="sd"> Returns:</span> +</span><span id="in_trie-63"><a href="#in_trie-63"><span class="linenos">63</span></a><span class="sd"> A pair `(value, subtrie)`, where `subtrie` is the sub-trie we get at the point</span> +</span><span id="in_trie-64"><a href="#in_trie-64"><span class="linenos">64</span></a><span class="sd"> where the search stops, and `value` is a TrieResult value that can be one of:</span> +</span><span id="in_trie-65"><a href="#in_trie-65"><span class="linenos">65</span></a> +</span><span id="in_trie-66"><a href="#in_trie-66"><span class="linenos">66</span></a><span class="sd"> - TrieResult.FAILED: the search was unsuccessful</span> +</span><span id="in_trie-67"><a href="#in_trie-67"><span class="linenos">67</span></a><span class="sd"> - TrieResult.PREFIX: `value` is a prefix of a keyword in `trie`</span> +</span><span id="in_trie-68"><a href="#in_trie-68"><span class="linenos">68</span></a><span class="sd"> - TrieResult.EXISTS: `key` exists in `trie`</span> +</span><span id="in_trie-69"><a href="#in_trie-69"><span class="linenos">69</span></a><span class="sd"> """</span> +</span><span id="in_trie-70"><a href="#in_trie-70"><span class="linenos">70</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">key</span><span class="p">:</span> +</span><span id="in_trie-71"><a href="#in_trie-71"><span class="linenos">71</span></a> <span class="k">return</span> <span class="p">(</span><span class="n">TrieResult</span><span class="o">.</span><span class="n">FAILED</span><span class="p">,</span> <span class="n">trie</span><span class="p">)</span> +</span><span id="in_trie-72"><a href="#in_trie-72"><span class="linenos">72</span></a> +</span><span id="in_trie-73"><a href="#in_trie-73"><span class="linenos">73</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">trie</span> +</span><span id="in_trie-74"><a href="#in_trie-74"><span class="linenos">74</span></a> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">key</span><span class="p">:</span> +</span><span id="in_trie-75"><a href="#in_trie-75"><span class="linenos">75</span></a> <span class="k">if</span> <span class="n">char</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> +</span><span id="in_trie-76"><a href="#in_trie-76"><span class="linenos">76</span></a> <span class="k">return</span> <span class="p">(</span><span class="n">TrieResult</span><span class="o">.</span><span class="n">FAILED</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> +</span><span id="in_trie-77"><a href="#in_trie-77"><span class="linenos">77</span></a> <span class="n">current</span> <span class="o">=</span> <span class="n">current</span><span class="p">[</span><span class="n">char</span><span class="p">]</span> +</span><span id="in_trie-78"><a href="#in_trie-78"><span class="linenos">78</span></a> +</span><span id="in_trie-79"><a href="#in_trie-79"><span class="linenos">79</span></a> <span class="k">if</span> <span class="mi">0</span> <span class="ow">in</span> <span class="n">current</span><span class="p">:</span> +</span><span id="in_trie-80"><a href="#in_trie-80"><span class="linenos">80</span></a> <span class="k">return</span> <span class="p">(</span><span class="n">TrieResult</span><span class="o">.</span><span class="n">EXISTS</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> +</span><span id="in_trie-81"><a href="#in_trie-81"><span class="linenos">81</span></a> +</span><span id="in_trie-82"><a href="#in_trie-82"><span class="linenos">82</span></a> <span class="k">return</span> <span class="p">(</span><span class="n">TrieResult</span><span class="o">.</span><span class="n">PREFIX</span><span class="p">,</span> <span class="n">current</span><span class="p">)</span> </span></pre></div> @@ -262,19 +376,19 @@ strings, or by 0, which is used to designate that a keyword is in the trie.</p> <blockquote> <div class="pdoc-code codehilite"> <pre><span></span><code><span class="gp">>>> </span><span class="n">in_trie</span><span class="p">(</span><span class="n">new_trie</span><span class="p">([</span><span class="s2">"cat"</span><span class="p">]),</span> <span class="s2">"bob"</span><span class="p">)</span> -<span class="go">(0, {'c': {'a': {'t': {0: True}}}})</span> +<span class="go">(<<a href="#TrieResult.FAILED">TrieResult.FAILED</a>: 1>, {'c': {'a': {'t': {0: True}}}})</span> </code></pre> </div> <div class="pdoc-code codehilite"> <pre><span></span><code><span class="gp">>>> </span><span class="n">in_trie</span><span class="p">(</span><span class="n">new_trie</span><span class="p">([</span><span class="s2">"cat"</span><span class="p">]),</span> <span class="s2">"ca"</span><span class="p">)</span> -<span class="go">(1, {'t': {0: True}})</span> +<span class="go">(<<a href="#TrieResult.PREFIX">TrieResult.PREFIX</a>: 2>, {'t': {0: True}})</span> </code></pre> </div> <div class="pdoc-code codehilite"> <pre><span></span><code><span class="gp">>>> </span><span class="n">in_trie</span><span class="p">(</span><span class="n">new_trie</span><span class="p">([</span><span class="s2">"cat"</span><span class="p">]),</span> <span class="s2">"cat"</span><span class="p">)</span> -<span class="go">(2, {0: True})</span> +<span class="go">(<<a href="#TrieResult.EXISTS">TrieResult.EXISTS</a>: 3>, {0: True})</span> </code></pre> </div> </blockquote> @@ -282,15 +396,21 @@ strings, or by 0, which is used to designate that a keyword is in the trie.</p> <h6 id="arguments">Arguments:</h6> <ul> -<li><strong>trie:</strong> the trie to be searched.</li> -<li><strong>key:</strong> the target key.</li> +<li><strong>trie:</strong> The trie to be searched.</li> +<li><strong>key:</strong> The target key.</li> </ul> <h6 id="returns">Returns:</h6> <blockquote> - <p>A pair <code>(value, subtrie)</code>, where <code>subtrie</code> is the sub-trie we get at the point where the search stops, and <code>value</code> - is either 0 (search was unsuccessful), 1 (<code>value</code> is a prefix of a keyword in <code>trie</code>) or 2 (<code>key is in</code>trie`).</p> + <p>A pair <code>(value, subtrie)</code>, where <code>subtrie</code> is the sub-trie we get at the point + where the search stops, and <code>value</code> is a TrieResult value that can be one of:</p> + + <ul> + <li><a href="#TrieResult.FAILED">TrieResult.FAILED</a>: the search was unsuccessful</li> + <li><a href="#TrieResult.PREFIX">TrieResult.PREFIX</a>: <code>value</code> is a prefix of a keyword in <code>trie</code></li> + <li><a href="#TrieResult.EXISTS">TrieResult.EXISTS</a>: <code><a href="#key">key</a></code> exists in <code>trie</code></li> + </ul> </blockquote> </div> |