Skip to content

Commit 7ba5018

Browse files
authored
Merge pull request #39 from uzumaxy/fix/flake8
Flake8 fixes
2 parents 925c498 + af94f31 commit 7ba5018

29 files changed

Lines changed: 392 additions & 209 deletions

README.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ information about excepted values/types/validators.
4343
The very basic example below shows how to use ``accepts`` and ``returns``
4444
decorators.
4545

46-
.. highlight:: python
4746
.. code-block:: python
4847
4948
from pyvalid import accepts, returns
@@ -107,7 +106,6 @@ Examples of usage:
107106
Let's define the ``multiply``, which accepts only ``int`` values, and see how
108107
does it work with other types.
109108

110-
.. highlight:: python
111109
.. code-block:: python
112110
113111
from pyvalid import accepts
@@ -148,7 +146,6 @@ Examples of usage:
148146
Let's define the ``multiply``, which returns only ``int`` values, and see how
149147
does it work with other types.
150148

151-
.. highlight:: python
152149
.. code-block:: python
153150
154151
from pyvalid import returns
@@ -181,7 +178,6 @@ Function ``calculate`` in the example below has the following limitations:
181178
* Second parameter must be ``int`` value or be equal to the ``2.0``;
182179
* Third parameter must be ``int`` or ``float`` value.
183180

184-
.. highlight:: python
185181
.. code-block:: python
186182
187183
from pyvalid import accepts, returns
@@ -221,7 +217,6 @@ decorators in the classes. Please pay attention to the method ``connect`` of
221217
the class ``SqlDriver``. In these classes we're using the ``accepts``
222218
decorator to validate keyword arguments.
223219

224-
.. highlight:: python
225220
.. code-block:: python
226221
227222
from pyvalid import accepts, returns
@@ -291,7 +286,6 @@ For example, here we're using the ``StringValidator`` validator based on the
291286
regular expression and the ``NumberValidator`` based on the min/max allowed
292287
values:
293288

294-
.. highlight:: python
295289
.. code-block:: python
296290
297291
from pyvalid import accepts, returns
@@ -318,7 +312,6 @@ The example below explains how to use the custom validator. It's pretty
318312
easy actually, we just need to apply the ``pyvalid.validators.is_validator``
319313
decorator to the validation function.
320314

321-
.. highlight:: python
322315
.. code-block:: python
323316
324317
from pyvalid import accepts

docs/.doctrees/environment.pickle

1.67 KB
Binary file not shown.

docs/.doctrees/index.doctree

-907 Bytes
Binary file not shown.

docs/.doctrees/modules.doctree

9.05 KB
Binary file not shown.

docs/_modules/pyvalid/validators/__base.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,15 @@ <h2 class="heading"><span>pyvalid.validators.__base</span></h2>
3232

3333
<h1>Source code for pyvalid.validators.__base</h1><div class="highlight"><pre>
3434
<span></span><span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABCMeta</span><span class="p">,</span> <span class="n">abstractmethod</span>
35-
<span class="kn">from</span> <span class="nn">six</span> <span class="kn">import</span> <span class="n">with_metaclass</span>
36-
<span class="kn">from</span> <span class="nn">pyvalid</span> <span class="kn">import</span> <span class="n">accepts</span>
3735
<span class="k">try</span><span class="p">:</span>
3836
<span class="kn">from</span> <span class="nn">collections.abc</span> <span class="kn">import</span> <span class="n">Callable</span>
3937
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
4038
<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">Callable</span>
4139

40+
<span class="kn">from</span> <span class="nn">six</span> <span class="kn">import</span> <span class="n">with_metaclass</span>
41+
42+
<span class="kn">from</span> <span class="nn">pyvalid</span> <span class="kn">import</span> <span class="n">accepts</span>
43+
4244

4345
<div class="viewcode-block" id="Validator"><a class="viewcode-back" href="../../../modules.html#pyvalid.validators.Validator">[docs]</a><span class="k">class</span> <span class="nc">Validator</span><span class="p">(</span><span class="n">Callable</span><span class="p">):</span>
4446

docs/_modules/pyvalid/validators/__iterable.html

Lines changed: 48 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,12 @@ <h1>Source code for pyvalid.validators.__iterable</h1><div class="highlight"><pr
3636

3737

3838
<div class="viewcode-block" id="IterableValidator"><a class="viewcode-back" href="../../../modules.html#pyvalid.validators.IterableValidator">[docs]</a><span class="k">class</span> <span class="nc">IterableValidator</span><span class="p">(</span><span class="n">AbstractValidator</span><span class="p">):</span>
39-
<span class="sd">&quot;&quot;&quot;This class performs validation on the content of the iterable to check</span>
40-
<span class="sd"> if the given iterable is valid or not. The iterable can be either a list,</span>
41-
<span class="sd"> tuple or even keys or values of a dictionary.</span>
39+
<span class="sd">&quot;&quot;&quot;This class performs validation on the content of the iterable to check if the</span>
40+
<span class="sd"> given iterable is valid or not. The iterable can be either a list, tuple or even</span>
41+
<span class="sd"> keys or values of a dictionary.</span>
4242

4343
<span class="sd"> Example:</span>
4444

45-
<span class="sd"> .. highlight:: python</span>
4645
<span class="sd"> .. code-block:: python</span>
4746

4847
<span class="sd"> validator = IterableValidator(</span>
@@ -57,19 +56,22 @@ <h1>Source code for pyvalid.validators.__iterable</h1><div class="highlight"><pr
5756

5857
<div class="viewcode-block" id="IterableValidator.empty_iterable_checker"><a class="viewcode-back" href="../../../modules.html#pyvalid.validators.IterableValidator.empty_iterable_checker">[docs]</a> <span class="nd">@classmethod</span>
5958
<span class="k">def</span> <span class="nf">empty_iterable_checker</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">val</span><span class="p">,</span> <span class="n">empty_allowed</span><span class="p">):</span>
60-
<span class="sd">&quot;&quot;&quot;Check if the iterable is empty or not.</span>
59+
<span class="sd">&quot;&quot;&quot;Checks if the iterable is empty or not.</span>
6160

6261
<span class="sd"> Args:</span>
63-
<span class="sd"> val (list/tuple/dict/set): Iterable to be validated.</span>
64-
<span class="sd"> empty_allowed (bool): If this flag is set to &#39;True&#39;, this method</span>
65-
<span class="sd"> raises exception and terminates the execution if the iterable</span>
66-
<span class="sd"> is empty.</span>
67-
<span class="sd"> If set to &#39;False&#39;, it raises a warning and continues with the</span>
68-
<span class="sd"> execution.</span>
62+
<span class="sd"> val (collections.abc.Iterable):</span>
63+
<span class="sd"> Iterable whose contents needs to be validated.</span>
64+
<span class="sd"> empty_allowed (bool):</span>
65+
<span class="sd"> If this flag is set to ``True``, this method raises exception and</span>
66+
<span class="sd"> terminates the execution if the iterable is empty.</span>
67+
<span class="sd"> If set to ``False``, it raises a warning and continues with</span>
68+
<span class="sd"> the execution.</span>
6969

7070
<span class="sd"> Returns (bool):</span>
71-
<span class="sd"> True: If the iterable is not empty.</span>
72-
<span class="sd"> False: If the iterable is empty.</span>
71+
<span class="sd"> True:</span>
72+
<span class="sd"> If the iterable is not empty.</span>
73+
<span class="sd"> False:</span>
74+
<span class="sd"> If the iterable is empty.</span>
7375
<span class="sd"> &quot;&quot;&quot;</span>
7476
<span class="k">if</span> <span class="ow">not</span> <span class="n">empty_allowed</span><span class="p">:</span>
7577
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="n">val</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span>
@@ -81,15 +83,16 @@ <h1>Source code for pyvalid.validators.__iterable</h1><div class="highlight"><pr
8183
<span class="sd">&quot;&quot;&quot;Checks if all the elements of the iterable are of required type.</span>
8284

8385
<span class="sd"> Args:</span>
84-
<span class="sd"> val (list/tuple/dict/set): Iterable whose contents needs to be</span>
85-
<span class="sd"> validated.</span>
86-
<span class="sd"> elements_type (datatype): Expected type of all the elements in</span>
87-
<span class="sd"> the iterator.</span>
86+
<span class="sd"> val (collections.abc.Iterable):</span>
87+
<span class="sd"> Iterable whose contents needs to be validated.</span>
88+
<span class="sd"> elements_type (datatype):</span>
89+
<span class="sd"> Expected type of all the elements in the iterator.</span>
8890

8991
<span class="sd"> Returns (bool):</span>
90-
<span class="sd"> True: If all elements of the iterable are of required type.</span>
91-
<span class="sd"> False: If at least one element of the iterable is not of required</span>
92-
<span class="sd"> type.</span>
92+
<span class="sd"> True:</span>
93+
<span class="sd"> If all elements of the iterable are of required type.</span>
94+
<span class="sd"> False:</span>
95+
<span class="sd"> If at least one element of the iterable is not of required type.</span>
9396
<span class="sd"> &quot;&quot;&quot;</span>
9497
<span class="n">valid</span> <span class="o">=</span> <span class="kc">False</span>
9598
<span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">val</span><span class="p">:</span>
@@ -101,18 +104,21 @@ <h1>Source code for pyvalid.validators.__iterable</h1><div class="highlight"><pr
101104

102105
<div class="viewcode-block" id="IterableValidator.elements_min_val_checker"><a class="viewcode-back" href="../../../modules.html#pyvalid.validators.IterableValidator.elements_min_val_checker">[docs]</a> <span class="nd">@classmethod</span>
103106
<span class="k">def</span> <span class="nf">elements_min_val_checker</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">val</span><span class="p">,</span> <span class="n">min_val</span><span class="p">):</span>
104-
<span class="sd">&quot;&quot;&quot;Checks if all the elements of the iterable are greater than or</span>
105-
<span class="sd"> equal to the specified value.</span>
107+
<span class="sd">&quot;&quot;&quot;Checks if all the elements of the iterable are greater than or equal to the</span>
108+
<span class="sd"> specified value.</span>
106109

107110
<span class="sd"> Args:</span>
108-
<span class="sd"> val (list/tuple/dict/set): Iterable whose contents needs to be</span>
109-
<span class="sd"> validated.</span>
110-
<span class="sd"> min_val (int): Expected minimum value the iterable must contain.</span>
111+
<span class="sd"> val (collections.abc.Iterable):</span>
112+
<span class="sd"> Iterable whose contents needs to be validated.</span>
113+
<span class="sd"> min_val (int):</span>
114+
<span class="sd"> Expected minimum value the iterable must contain.</span>
111115

112116
<span class="sd"> Returns (bool):</span>
113-
<span class="sd"> True: If all the elements of the iterable are greater than or</span>
114-
<span class="sd"> equal to the &lt;min_val&gt;.</span>
115-
<span class="sd"> False: If at least one element of the iterable is less than the</span>
117+
<span class="sd"> True:</span>
118+
<span class="sd"> If all the elements of the iterable are greater than or equal to the</span>
119+
<span class="sd"> &lt;min_val&gt;.</span>
120+
<span class="sd"> False:</span>
121+
<span class="sd"> If at least one element of the iterable is less than the</span>
116122
<span class="sd"> &lt;min_val&gt;.</span>
117123
<span class="sd"> &quot;&quot;&quot;</span>
118124
<span class="n">valid</span> <span class="o">=</span> <span class="kc">True</span>
@@ -126,19 +132,22 @@ <h1>Source code for pyvalid.validators.__iterable</h1><div class="highlight"><pr
126132

127133
<div class="viewcode-block" id="IterableValidator.elements_max_val_checker"><a class="viewcode-back" href="../../../modules.html#pyvalid.validators.IterableValidator.elements_max_val_checker">[docs]</a> <span class="nd">@classmethod</span>
128134
<span class="k">def</span> <span class="nf">elements_max_val_checker</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">val</span><span class="p">,</span> <span class="n">max_val</span><span class="p">):</span>
129-
<span class="sd">&quot;&quot;&quot;Checks if all the elements of the iterable are less than or equal</span>
130-
<span class="sd"> to the specified value.</span>
135+
<span class="sd">&quot;&quot;&quot;Checks if all the elements of the iterable are less than or equal to the</span>
136+
<span class="sd"> specified value.</span>
131137

132138
<span class="sd"> Args:</span>
133-
<span class="sd"> val (list/tuple/dict/set): Iterable whose contents needs to be</span>
134-
<span class="sd"> validated.</span>
135-
<span class="sd"> max_val (int): Expected maximum value the iterable must contain.</span>
139+
<span class="sd"> val (collections.abc.Iterable):</span>
140+
<span class="sd"> Iterable whose contents needs to be validated.</span>
141+
<span class="sd"> max_val (int):</span>
142+
<span class="sd"> Expected maximum value the iterable must contain.</span>
136143

137144
<span class="sd"> Returns (bool):</span>
138-
<span class="sd"> True: If all the elements of the iterable are less than or equal</span>
139-
<span class="sd"> to the &lt;max_val&gt;.</span>
140-
<span class="sd"> False: If at least one element of the iterable is greater than</span>
141-
<span class="sd"> the &lt;max_val&gt;.</span>
145+
<span class="sd"> True:</span>
146+
<span class="sd"> If all the elements of the iterable are less than or equal to the</span>
147+
<span class="sd"> &lt;max_val&gt;.</span>
148+
<span class="sd"> False:</span>
149+
<span class="sd"> If at least one element of the iterable is greater than the</span>
150+
<span class="sd"> &lt;max_val&gt;.</span>
142151
<span class="sd"> &quot;&quot;&quot;</span>
143152
<span class="n">valid</span> <span class="o">=</span> <span class="kc">True</span>
144153

@@ -156,12 +165,12 @@ <h1>Source code for pyvalid.validators.__iterable</h1><div class="highlight"><pr
156165
<div class="viewcode-block" id="IterableValidator.__init__"><a class="viewcode-back" href="../../../modules.html#pyvalid.validators.IterableValidator.__init__">[docs]</a> <span class="nd">@accepts</span><span class="p">(</span><span class="nb">object</span><span class="p">,</span> <span class="n">empty_allowed</span><span class="o">=</span><span class="nb">bool</span><span class="p">,</span> <span class="n">element_type</span><span class="o">=</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">),</span>
157166
<span class="n">min_val</span><span class="o">=</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">),</span> <span class="n">max_val</span><span class="o">=</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">))</span>
158167
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
159-
<span class="n">empty_allowed</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;empty_allowed&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
160-
<span class="n">elements_type</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;elements_type&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
161168
<span class="n">min_val</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;min_val&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
162169
<span class="n">max_val</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;max_val&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
163170
<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">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">min_val</span> <span class="o">&gt;</span> <span class="n">max_val</span><span class="p">:</span>
164171
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Min value can</span><span class="se">\&#39;</span><span class="s1">t be greater than max value!&#39;</span><span class="p">)</span>
172+
<span class="n">empty_allowed</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;empty_allowed&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
173+
<span class="n">elements_type</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;elements_type&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
165174
<span class="bp">self</span><span class="o">.</span><span class="n">__checkers</span> <span class="o">=</span> <span class="p">{</span>
166175
<span class="n">IterableValidator</span><span class="o">.</span><span class="n">empty_iterable_checker</span><span class="p">:</span> <span class="p">[</span><span class="n">empty_allowed</span><span class="p">],</span>
167176
<span class="n">IterableValidator</span><span class="o">.</span><span class="n">element_type_checker</span><span class="p">:</span> <span class="p">[</span><span class="n">elements_type</span><span class="p">],</span>

0 commit comments

Comments
 (0)