Deployed c2d3fb7 to 0.23 with MkDocs 1.5.3 and mike 2.0.0

0.23/references/between.rst

@@ -5,3 +5,5 @@ between
 .. autofunction:: between
 .. module:: validators.between
 .. autofunction:: between
+.. module:: validators.between
+.. autofunction:: between

0.23/references/between/index.html

@@ -925,8 +925,7 @@ <h2 id="validators.between.between" class="doc doc-heading">
           </td>
           <td>
             <div class="doc-md-description">
-              <p>If both <code>min_val</code> and <code>max_val</code> are <code>None</code>,
-or if <code>min_val</code> is greater than <code>max_val</code>.</p>
+              <p>If <code>min_val</code> is greater than <code>max_val</code>.</p>
             </div>
           </td>
         </tr>
@@ -936,7 +935,7 @@ <h2 id="validators.between.between" class="doc doc-heading">
           </td>
           <td>
             <div class="doc-md-description">
-              <p>If there's a type mismatch before comparison.</p>
+              <p>If there's a type mismatch during comparison.</p>
             </div>
           </td>
         </tr>
@@ -947,12 +946,9 @@ <h2 id="validators.between.between" class="doc doc-heading">
   <summary>Note</summary>
   <ul>
 <li><code>PossibleValueTypes</code> = <code>TypeVar("PossibleValueTypes", int, float, str, datetime)</code></li>
-<li>Either one of <code>min_val</code> or <code>max_val</code> must be provided.</li>
+<li>If neither <code>min_val</code> nor <code>max_val</code> is provided, result will always be <code>True</code>.</li>
 </ul>
-</details>      <blockquote>
-<p><em>New in version 0.2.0</em>.</p>
-</blockquote>
-
+</details>
           <details class="quote">
             <summary>Source code in <code>src/validators/between.py</code></summary>
             <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">14</span>
@@ -1022,24 +1018,7 @@ <h2 id="validators.between.between" class="doc doc-heading">
 <span class="normal">78</span>
 <span class="normal">79</span>
 <span class="normal">80</span>
-<span class="normal">81</span>
-<span class="normal">82</span>
-<span class="normal">83</span>
-<span class="normal">84</span>
-<span class="normal">85</span>
-<span class="normal">86</span>
-<span class="normal">87</span>
-<span class="normal">88</span>
-<span class="normal">89</span>
-<span class="normal">90</span>
-<span class="normal">91</span>
-<span class="normal">92</span>
-<span class="normal">93</span>
-<span class="normal">94</span>
-<span class="normal">95</span>
-<span class="normal">96</span>
-<span class="normal">97</span>
-<span class="normal">98</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@validator</span>
+<span class="normal">81</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@validator</span>
 <span class="k">def</span> <span class="nf">between</span><span class="p">(</span>
     <span class="n">value</span><span class="p">:</span> <span class="n">PossibleValueTypes</span><span class="p">,</span>
     <span class="o">/</span><span class="p">,</span>
@@ -1085,45 +1064,28 @@ <h2 id="validators.between.between" class="doc doc-heading">
 <span class="sd">            If `value` is not in between the given conditions.</span>
 
 <span class="sd">    Raises:</span>
-<span class="sd">        ValueError: If both `min_val` and `max_val` are `None`,</span>
-<span class="sd">            or if `min_val` is greater than `max_val`.</span>
-<span class="sd">        TypeError: If there&#39;s a type mismatch before comparison.</span>
+<span class="sd">        (ValueError): If `min_val` is greater than `max_val`.</span>
+<span class="sd">        (TypeError): If there&#39;s a type mismatch during comparison.</span>
 
 <span class="sd">    Note:</span>
 <span class="sd">        - `PossibleValueTypes` = `TypeVar(&quot;PossibleValueTypes&quot;, int, float, str, datetime)`</span>
-<span class="sd">        - Either one of `min_val` or `max_val` must be provided.</span>
-
-<span class="sd">    &gt; *New in version 0.2.0*.</span>
+<span class="sd">        - If neither `min_val` nor `max_val` is provided, result will always be `True`.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <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 class="k">return</span> <span class="kc">False</span>
 
-    <span class="k">if</span> <span class="n">min_val</span> <span class="ow">is</span> <span class="n">max_val</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
-        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;At least one of either `min_val` or `max_val` must be specified&quot;</span><span class="p">)</span>
-
     <span class="k">if</span> <span class="n">max_val</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
         <span class="n">max_val</span> <span class="o">=</span> <span class="n">AbsMax</span><span class="p">()</span>
     <span class="k">if</span> <span class="n">min_val</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
         <span class="n">min_val</span> <span class="o">=</span> <span class="n">AbsMin</span><span class="p">()</span>
 
-    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">min_val</span><span class="p">,</span> <span class="n">AbsMin</span><span class="p">):</span>
-        <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">type</span><span class="p">(</span><span class="n">max_val</span><span class="p">):</span>
-            <span class="k">return</span> <span class="n">min_val</span> <span class="o">&lt;=</span> <span class="n">value</span> <span class="o">&lt;=</span> <span class="n">max_val</span>
-        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;`value` and `max_val` must be of same type&quot;</span><span class="p">)</span>
-
-    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">max_val</span><span class="p">,</span> <span class="n">AbsMax</span><span class="p">):</span>
-        <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">type</span><span class="p">(</span><span class="n">min_val</span><span class="p">):</span>
-            <span class="k">return</span> <span class="n">min_val</span> <span class="o">&lt;=</span> <span class="n">value</span> <span class="o">&lt;=</span> <span class="n">max_val</span>
-        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;`value` and `min_val` must be of same type&quot;</span><span class="p">)</span>
-
-    <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">min_val</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">type</span><span class="p">(</span><span class="n">max_val</span><span class="p">):</span>
+    <span class="k">try</span><span class="p">:</span>
         <span class="k">if</span> <span class="n">min_val</span> <span class="o">&gt;</span> <span class="n">max_val</span><span class="p">:</span>
-            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;`min_val` cannot be more than `max_val`&quot;</span><span class="p">)</span>
-        <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">type</span><span class="p">(</span><span class="n">min_val</span><span class="p">):</span>  <span class="c1"># or is type(max_val)</span>
-            <span class="k">return</span> <span class="n">min_val</span> <span class="o">&lt;=</span> <span class="n">value</span> <span class="o">&lt;=</span> <span class="n">max_val</span>
-        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;`value` and (`min_val` or `max_val`) must be of same type&quot;</span><span class="p">)</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;`min_val` cannot be greater than `max_val`&quot;</span><span class="p">)</span>
+    <span class="k">except</span> <span class="ne">TypeError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Comparison type mismatch&quot;</span><span class="p">)</span> <span class="kn">from</span> <span class="nn">err</span>
 
-    <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;`value` and `min_val` and `max_val` must be of same type&quot;</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">min_val</span> <span class="o">&lt;=</span> <span class="n">value</span> <span class="o">&lt;=</span> <span class="n">max_val</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>

0.23/references/btc_address.rst

@@ -5,3 +5,5 @@ btc_address
 .. autofunction:: btc_address
 .. module:: validators.btc_address
 .. autofunction:: btc_address
+.. module:: validators.btc_address
+.. autofunction:: btc_address

0.23/references/card.rst

@@ -1,6 +1,8 @@
 card
 ----
 
+.. module:: validators.card
+.. autofunction:: visa
 .. module:: validators.card
 .. autofunction:: amex
 .. module:: validators.card

0.23/references/country_code.rst

@@ -5,3 +5,5 @@ country_code
 .. autofunction:: country_code
 .. module:: validators.country_code
 .. autofunction:: country_code
+.. module:: validators.country_code
+.. autofunction:: country_code

0.23/references/domain.rst

@@ -5,3 +5,5 @@ domain
 .. autofunction:: domain
 .. module:: validators.domain
 .. autofunction:: domain
+.. module:: validators.domain
+.. autofunction:: domain

0.23/references/email.rst

@@ -5,3 +5,5 @@ email
 .. autofunction:: email
 .. module:: validators.email
 .. autofunction:: email
+.. module:: validators.email
+.. autofunction:: email

0.23/references/hashes.rst

@@ -1,6 +1,8 @@
 hashes
 ------
 
+.. module:: validators.hashes
+.. autofunction:: sha512
 .. module:: validators.hashes
 .. autofunction:: md5
 .. module:: validators.hashes

0.23/references/hostname.rst

@@ -5,3 +5,5 @@ hostname
 .. autofunction:: hostname
 .. module:: validators.hostname
 .. autofunction:: hostname
+.. module:: validators.hostname
+.. autofunction:: hostname

0.23/references/i18n.rst

@@ -1,6 +1,8 @@
 i18n
 ----
 
+.. module:: validators.i18n
+.. autofunction:: fr_ssn
 .. module:: validators.i18n
 .. autofunction:: es_cif
 .. module:: validators.i18n

0.23/references/iban.rst

@@ -5,3 +5,5 @@ iban
 .. autofunction:: iban
 .. module:: validators.iban
 .. autofunction:: iban
+.. module:: validators.iban
+.. autofunction:: iban

0.23/references/ip_address.rst

@@ -1,6 +1,8 @@
 ip_address
 ----------
 
+.. module:: validators.ip_address
+.. autofunction:: ipv6
 .. module:: validators.ip_address
 .. autofunction:: ipv4
 .. module:: validators.ip_address

0.23/references/length.rst

@@ -5,3 +5,5 @@ length
 .. autofunction:: length
 .. module:: validators.length
 .. autofunction:: length
+.. module:: validators.length
+.. autofunction:: length

0.23/references/length/index.html

@@ -786,7 +786,7 @@ <h1 id="length">length<a class="headerlink" href="#length" title="Permanent link
 
 
 <h2 id="validators.length.length" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">validators</span><span class="o">.</span><span class="n">length</span><span class="o">.</span><span class="n">length</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="o">/</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">min_val</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">max_val</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span></code>
+          <code class="highlight language-python"><span class="n">validators</span><span class="o">.</span><span class="n">length</span><span class="o">.</span><span class="n">length</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="o">/</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">min_val</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">max_val</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
 
 <a href="#validators.length.length" class="headerlink" title="Permanent link">&para;</a></h2>
 
@@ -836,7 +836,7 @@ <h2 id="validators.length.length" class="doc doc-heading">
         <tr>
           <td><code>min_val</code></td>
           <td>
-                <code>int</code>
+                <code><span title="typing.Union">Union</span>[int, None]</code>
           </td>
           <td>
             <div class="doc-md-description">
@@ -845,13 +845,13 @@ <h2 id="validators.length.length" class="doc doc-heading">
             </div>
           </td>
           <td>
-                <code>0</code>
+                <code>None</code>
           </td>
         </tr>
         <tr>
           <td><code>max_val</code></td>
           <td>
-                <code>int</code>
+                <code><span title="typing.Union">Union</span>[int, None]</code>
           </td>
           <td>
             <div class="doc-md-description">
@@ -860,7 +860,7 @@ <h2 id="validators.length.length" class="doc doc-heading">
             </div>
           </td>
           <td>
-                <code>0</code>
+                <code>None</code>
           </td>
         </tr>
     </tbody>
@@ -899,16 +899,34 @@ <h2 id="validators.length.length" class="doc doc-heading">
         </tr>
     </tbody>
   </table>
-      <blockquote>
-<p><em>New in version 0.2.0</em>.</p>
-</blockquote>
+
+
+
+  <p><strong>Raises:</strong></p>
+  <table>
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td>
+                <code>ValueError</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p>If either <code>min_val</code> or <code>max_val</code> is negative.</p>
+            </div>
+          </td>
+        </tr>
+    </tbody>
+  </table>
 
           <details class="quote">
             <summary>Source code in <code>src/validators/length.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 8</span>
-<span class="normal"> 9</span>
-<span class="normal">10</span>
-<span class="normal">11</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">11</span>
 <span class="normal">12</span>
 <span class="normal">13</span>
 <span class="normal">14</span>
@@ -935,8 +953,17 @@ <h2 id="validators.length.length" class="doc doc-heading">
 <span class="normal">35</span>
 <span class="normal">36</span>
 <span class="normal">37</span>
-<span class="normal">38</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@validator</span>
-<span class="k">def</span> <span class="nf">length</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">/</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">min_val</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">max_val</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
+<span class="normal">38</span>
+<span class="normal">39</span>
+<span class="normal">40</span>
+<span class="normal">41</span>
+<span class="normal">42</span>
+<span class="normal">43</span>
+<span class="normal">44</span>
+<span class="normal">45</span>
+<span class="normal">46</span>
+<span class="normal">47</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@validator</span>
+<span class="k">def</span> <span class="nf">length</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">/</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">min_val</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">max_val</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Return whether or not the length of given string is within a specified range.</span>
 
 <span class="sd">    Examples:</span>
@@ -963,9 +990,15 @@ <h2 id="validators.length.length" class="doc doc-heading">
 <span class="sd">        (ValidationError):</span>
 <span class="sd">            If `len(value)` is not in between the given conditions.</span>
 
-<span class="sd">    &gt; *New in version 0.2.0*.</span>
+<span class="sd">    Raises:</span>
+<span class="sd">        (ValueError): If either `min_val` or `max_val` is negative.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">between</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">min_val</span><span class="o">=</span><span class="n">min_val</span><span class="p">,</span> <span class="n">max_val</span><span class="o">=</span><span class="n">max_val</span><span class="p">)</span> <span class="k">if</span> <span class="n">value</span> <span class="k">else</span> <span class="kc">False</span>
+    <span class="k">if</span> <span class="n">min_val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">min_val</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Length cannot be negative. `min_val` is less than zero.&quot;</span><span class="p">)</span>
+    <span class="k">if</span> <span class="n">max_val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">max_val</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Length cannot be negative. `max_val` is less than zero.&quot;</span><span class="p">)</span>
+
+    <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">between</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">min_val</span><span class="o">=</span><span class="n">min_val</span><span class="p">,</span> <span class="n">max_val</span><span class="o">=</span><span class="n">max_val</span><span class="p">))</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>

0.23/references/mac_address.rst

@@ -5,3 +5,5 @@ mac_address
 .. autofunction:: mac_address
 .. module:: validators.mac_address
 .. autofunction:: mac_address
+.. module:: validators.mac_address
+.. autofunction:: mac_address