Merge branch 'main' into 48

Author: LeanderCS

flask_inputfilter/conditions/array_length_equal_condition.py

@@ -16,7 +16,9 @@ class ArrayLengthEqualCondition(BaseCondition):
 
     **Expected Behavior:**
 
-    Validates that the length of the array from ``first_array_field`` is equal to the length of the array from ``second_array_field``. If not, the condition fails.
+    Validates that the length of the array from ``first_array_field`` is
+    equal to the length of the array from ``second_array_field``. If not,
+    the condition fails.
 
     **Example Usage:**
 
@@ -36,7 +38,12 @@ def __init__(self):
                     validators=[IsArrayValidator()]
                 )
 
-                self.add_condition(ArrayLengthEqualCondition('list1', 'list2'))
+                self.add_condition(
+                    ArrayLengthEqualCondition(
+                        first_array_field='list1',
+                        second_array_field='list2'
+                    )
+                )
     """
 
     __slots__ = ("first_array_field", "second_array_field")

flask_inputfilter/conditions/array_longer_than_condition.py

@@ -7,8 +7,7 @@
 
 class ArrayLongerThanCondition(BaseCondition):
     """
-    Checks if the array in one field is longer than the array in
-    another field.
+    Checks if the array in one field is longer than the array in another field.
 
     **Parameters:**
 
@@ -17,7 +16,8 @@ class ArrayLongerThanCondition(BaseCondition):
 
     **Expected Behavior:**
 
-    Validates that the array in ``longer_field`` has more elements than the array in ``shorter_field``.
+    Validates that the array in ``longer_field`` has more elements than
+    the array in ``shorter_field``.
 
     **Example Usage:**
 
@@ -37,7 +37,12 @@ def __init__(self):
                     validators=[IsArrayValidator()]
                 )
 
-                self.add_condition(ArrayLongerThanCondition('list1', 'list2'))
+                self.add_condition(
+                    ArrayLongerThanCondition(
+                        longer_field='list1',
+                        shorter_field='list2'
+                    )
+                )
     """
 
     __slots__ = ("longer_field", "shorter_field")

flask_inputfilter/conditions/custom_condition.py

@@ -8,16 +8,18 @@
 
 class CustomCondition(BaseCondition):
     """
-    Allows defining a custom condition using a user-provided
-    callable.
+    Allows defining a custom condition using a user-provided callable.
 
     **Parameters:**
 
-    - **condition** (*Callable[[Dict[str, Any]], bool]*): A function that takes the input data and returns a boolean indicating whether the condition is met.
+    - **condition** (*Callable[[Dict[str, Any]], bool]*): A function that
+        takes the input data and returns a boolean indicating whether the
+        condition is met.
 
     **Expected Behavior:**
 
-    Executes the provided callable with the input data. The condition passes if the callable returns ``True``, and fails otherwise.
+    Executes the provided callable with the input data. The condition passes
+    if the callable returns ``True``, and fails otherwise.
 
     **Example Usage:**
 
@@ -35,7 +37,11 @@ def __init__(self):
                     validators=[IsIntegerValidator()]
                 )
 
-                self.add_condition(CustomCondition(my_custom_condition))
+                self.add_condition(
+                    CustomCondition(
+                        condition=my_custom_condition
+                    )
+                )
     """
 
     __slots__ = ("condition",)

flask_inputfilter/conditions/equal_condition.py

@@ -16,7 +16,8 @@ class EqualCondition(BaseCondition):
 
     **Expected Behavior:**
 
-    Validates that the values of ``first_field`` and ``second_field`` are equal. Fails if they differ.
+    Validates that the values of ``first_field`` and ``second_field`` are
+    equal. Fails if they differ.
 
     **Example Usage:**
 
@@ -34,7 +35,12 @@ def __init__(self):
                     'confirm_password'
                 )
 
-                self.add_condition(EqualCondition('password', 'confirm_password'))
+                self.add_condition(
+                    EqualCondition(
+                        first_field='password',
+                        second_field='confirm_password'
+                    )
+                )
     """
 
     __slots__ = ("first_field", "second_field")

flask_inputfilter/conditions/exactly_n_of_condition.py

@@ -7,8 +7,8 @@
 
 class ExactlyNOfCondition(BaseCondition):
     """
-    Checks that exactly ``n`` of the specified fields are present in
-    the input data.
+    Checks that exactly ``n`` of the specified fields are present in the input
+    data.
 
     **Parameters:**
 
@@ -17,7 +17,8 @@ class ExactlyNOfCondition(BaseCondition):
 
     **Expected Behavior:**
 
-    Counts the number of specified fields present in the data and validates that the count equals ``n``.
+    Counts the number of specified fields present in the data and
+    validates that the count equals ``n``.
 
     **Example Usage:**
 
@@ -39,7 +40,12 @@ def __init__(self):
                     'field3'
                 )
 
-                self.add_condition(ExactlyNOfCondition(['field1', 'field2', 'field3'], 2))
+                self.add_condition(
+                    ExactlyNOfCondition(
+                        fields=['field1', 'field2', 'field3'],
+                        n=2
+                    )
+                )
     """
 
     __slots__ = ("fields", "n")

flask_inputfilter/conditions/exactly_n_of_matches_condition.py

@@ -7,8 +7,7 @@
 
 class ExactlyNOfMatchesCondition(BaseCondition):
     """
-    Checks that exactly ``n`` of the specified fields match a given
-    value.
+    Checks that exactly ``n`` of the specified fields match a given value.
 
     **Parameters:**
 
@@ -18,7 +17,8 @@ class ExactlyNOfMatchesCondition(BaseCondition):
 
     **Expected Behavior:**
 
-    Validates that exactly ``n`` fields among the specified ones have the given value.
+    Validates that exactly ``n`` fields among the specified ones have the
+    given value.
 
     **Example Usage:**
 
@@ -36,7 +36,13 @@ def __init__(self):
                     'field2'
                 )
 
-                self.add_condition(ExactlyNOfMatchesCondition(['field1', 'field2'], 1, 'expected_value'))
+                self.add_condition(
+                    ExactlyNOfMatchesCondition(
+                        fields=['field1', 'field2'],
+                        n=1,
+                        value='expected_value'
+                    )
+                )
     """
 
     __slots__ = ("fields", "n", "value")

flask_inputfilter/conditions/exactly_one_of_condition.py

@@ -15,7 +15,8 @@ class ExactlyOneOfCondition(BaseCondition):
 
     **Expected Behavior:**
 
-    Validates that only one field among the specified fields exists in the input data.
+    Validates that only one field among the specified fields exists in the
+    input data.
 
     **Example Usage:**
 

flask_inputfilter/conditions/exactly_one_of_matches_condition.py

@@ -7,8 +7,7 @@
 
 class ExactlyOneOfMatchesCondition(BaseCondition):
     """
-    Ensures that exactly one of the specified fields matches a given
-    value.
+    Ensures that exactly one of the specified fields matches a given value.
 
     **Parameters:**
 
@@ -35,7 +34,12 @@ def __init__(self):
                     'option2'
                 )
 
-                self.add_condition(ExactlyOneOfMatchesCondition(['option1', 'option2'], 'yes'))
+                self.add_condition(
+                    ExactlyOneOfMatchesCondition(
+                        fields=['option1', 'option2'],
+                        value='yes'
+                    )
+                )
     """
 
     __slots__ = ("fields", "value")

flask_inputfilter/conditions/integer_bigger_than_condition.py

@@ -7,8 +7,8 @@
 
 class IntegerBiggerThanCondition(BaseCondition):
     """
-    Checks if the integer value in one field is greater than that in
-    another field.
+    Checks if the integer value in one field is greater than that in another
+    field.
 
     **Parameters:**
 
@@ -17,7 +17,8 @@ class IntegerBiggerThanCondition(BaseCondition):
 
     **Expected Behavior:**
 
-    Validates that the integer value from ``bigger_field`` is greater than the value from ``smaller_field``.
+    Validates that the integer value from ``bigger_field`` is greater than
+    the value from ``smaller_field``.
 
     **Example Usage:**
 
@@ -37,7 +38,12 @@ def __init__(self):
                     validators=[IsIntegerValidator()]
                 )
 
-                self.add_condition(IntegerBiggerThanCondition('field_should_be_bigger', 'field_should_be_smaller'))
+                self.add_condition(
+                    IntegerBiggerThanCondition(
+                        bigger_field='field_should_be_bigger',
+                        smaller_field='field_should_be_smaller'
+                    )
+                )
     """
 
     __slots__ = ("bigger_field", "smaller_field")

flask_inputfilter/conditions/n_of_condition.py

@@ -7,8 +7,8 @@
 
 class NOfCondition(BaseCondition):
     """
-    Checks that at least ``n`` of the specified fields are present in
-    the input data.
+    Checks that at least ``n`` of the specified fields are present in the input
+    data.
 
     **Parameters:**
 
@@ -17,7 +17,8 @@ class NOfCondition(BaseCondition):
 
     **Expected Behavior:**
 
-    Validates that the count of the specified fields present is greater than or equal to ``n``.
+    Validates that the count of the specified fields present is greater
+    than or equal to ``n``.
 
     **Example Usage:**
 
@@ -39,7 +40,12 @@ def __init__(self):
                     'field3'
                 )
 
-                self.add_condition(NOfCondition(['field1', 'field2', 'field3'], 2))
+                self.add_condition(
+                    NOfCondition(
+                        fields=['field1', 'field2', 'field3'],
+                        n=2
+                    )
+                )
     """
 
     __slots__ = ("fields", "n")