@@ -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 "> """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 "> """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 "> """Check if the iterable is empty or not.</ span >
59+ < span class ="sd "> """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 'True', 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 'False', 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 "> """</ 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 "> """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 "> """</ 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 "> """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 "> """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 <min_val>.</ 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 "> <min_val>.</ 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 "> <min_val>.</ span >
117123< span class ="sd "> """</ 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 "> """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 "> """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 <max_val>.</ span >
140- < span class ="sd "> False: If at least one element of the iterable is greater than</ span >
141- < span class ="sd "> the <max_val>.</ 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 "> <max_val>.</ 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 "> <max_val>.</ span >
142151< span class ="sd "> """</ 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 "> 'empty_allowed'</ 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 "> 'elements_type'</ 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 "> 'min_val'</ 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 "> 'max_val'</ 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 "> ></ 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 "> 'Min value can</ span > < span class ="se "> \'</ span > < span class ="s1 "> t be greater than max value!'</ 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 "> 'empty_allowed'</ 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 "> 'elements_type'</ 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