Merge pull request #56 from LeanderCS/48

48 | Update ArrayElementValidator and IsDataclassValidator

Author: LeanderCS

.github/workflows/publish-to-pypi.yaml

@@ -137,7 +137,5 @@ jobs:
           path: dist
           merge-multiple: true
 
-      - run: ls -la dist
-
       - name: Publish package to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

docs/source/changelog.rst

@@ -3,6 +3,19 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+[0.5.4] - 2025-05-24
+--------------------
+
+Added
+^^^^^
+- Added ``ArrayElementFilter`` to filter elements in an array against specific filter.
+
+Changed
+^^^^^^^
+- Updated ``ArrayElementValidator`` to support validators directly.
+- Updated ``IsDataclassValidator`` to also check against their types, including nested dataclasses, lists, and dictionaries.
+
+
 [0.5.3] - 2025-04-28
 --------------------
 

docs/source/guides/frontend_validation.rst

@@ -14,11 +14,6 @@ Example implementation
 .. code-block:: python
 
     from flask import Response, Flask
-    from flask_inputfilter import InputFilter
-    from flask_inputfilter.conditions import ExactlyOneOfCondition
-    from flask_inputfilter.enums import RegexEnum
-    from flask_inputfilter.filters import StringTrimFilter, ToIntegerFilter, ToNullFilter
-    from flask_inputfilter.validators import IsIntegerValidator, IsStringValidator, RegexValidator
 
     app = Flask(__name__)
 

docs/source/index.rst

@@ -55,12 +55,6 @@ Definition
 
 .. code-block:: python
 
-    from flask_inputfilter import InputFilter
-    from flask_inputfilter.conditions import ExactlyOneOfCondition
-    from flask_inputfilter.enums import RegexEnum
-    from flask_inputfilter.filters import StringTrimFilter, ToIntegerFilter, ToNullFilter
-    from flask_inputfilter.validators import IsIntegerValidator, IsStringValidator, RegexValidator
-
     class UpdateZipcodeInputFilter(InputFilter):
         def __init__(self):
             super().__init__()

docs/source/options/condition.rst

@@ -13,11 +13,6 @@ Example
 
 .. code-block:: python
 
-    from flask_inputfilter import InputFilter
-    from flask_inputfilter.conditions import OneOfCondition
-    from flask_inputfilter.filters import StringTrimFilter
-    from flask_inputfilter.validators import IsStringValidator
-
     class TestInputFilter(InputFilter):
         def __init__(self):
             super().__init__()

docs/source/options/copy.rst

@@ -19,15 +19,15 @@ Basic Copy Integration
 
 .. code-block:: python
 
-    from flask_inputfilter import InputFilter
-    from flask_inputfilter.filters import StringSlugifyFilter
-
     class MyInputFilter(InputFilter):
         def __init__(self):
             super().__init__()
 
             self.add(
-                "username"
+                "username",
+                validator=[
+                    IsStringValidator()
+                ]
             )
 
             self.add(
@@ -52,9 +52,6 @@ The coping can also be used as a chain.
 
 .. code-block:: python
 
-    from flask_inputfilter import InputFilter
-    from flask_inputfilter.filters import StringSlugifyFilter, ToUpperFilter, ToLowerFilter
-
     class MyInputFilter(InputFilter):
         def __init__(self):
             super().__init__()
@@ -80,3 +77,15 @@ The coping can also be used as a chain.
                 copy="escapedUsername"
                 filters=[ToLowerFilter()]
             )
+
+    # Example usage
+    # Body: {"username": "Very Important User"}
+
+    @app.route("/test", methods=["GET"])
+    @MyInputFilter.validate()
+    def test_route():
+        validated_data = g.validated_data
+
+        # Contains the same value as username but escaped eg. "very-important-user"
+        # and in upper-case eg. "VERY-IMPORTANT-USER"
+        print(validated_data["upperEscapedUsername"])

docs/source/options/deserialization.rst

@@ -23,7 +23,6 @@ into an instance of the model class, if there is a model class set.
 
 .. code-block:: python
 
-    from flask_inputfilter import InputFilter
     from dataclasses import dataclass
 
 
@@ -50,7 +49,6 @@ You can also use deserialization in your Flask routes:
 .. code-block:: python
 
     from flask import Flask, jsonify, g
-    from flask_inputfilter import InputFilter
 
 
     class User:
@@ -82,7 +80,6 @@ You can also use deserialization outside of Flask routes:
 .. code-block:: python
 
     from flask import Flask, jsonify, g
-    from flask_inputfilter import InputFilter
 
 
     class User:

docs/source/options/external_api.rst

@@ -53,8 +53,6 @@ Basic External API Integration
 
 .. code-block:: python
 
-    from flask_inputfilter import InputFilter
-
     class MyInputFilter(InputFilter):
         def __init__(self):
             super().__init__()

docs/source/options/filter.rst

@@ -15,9 +15,6 @@ Example
 
 .. code-block:: python
 
-    from flask_inputfilter import InputFilter
-    from flask_inputfilter.filters import StringTrimFilter, ToLowerFilter
-
     class TestInputFilter(InputFilter):
         def __init__(self):
             super().__init__()
@@ -39,6 +36,7 @@ Example
 Available Filters
 -----------------
 
+- `ArrayElementFilter <#flask_inputfilter.filters.ArrayElementFilter>`_
 - `ArrayExplodeFilter <#flask_inputfilter.filters.ArrayExplodeFilter>`_
 - `Base64ImageDownscaleFilter <#flask_inputfilter.filters.Base64ImageDownscaleFilter>`_
 - `Base64ImageResizeFilter <#flask_inputfilter.filters.Base64ImageResizeFilter>`_

docs/source/options/special_validator.rst

@@ -12,9 +12,6 @@ Example
 
 .. code-block:: python
 
-    from flask_inputfilter import InputFilter
-    from flask_inputfilter.validators import NotValidator, IsIntegerValidator
-
     class NotIntegerInputFilter(InputFilter):
         def __init__(self):
             super().__init__()