48 | Updated IsDataclassValidator to also check against their types, including nested dataclasses, lists, and dictionaries

Author: LeanderCS

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/options/filter.rst

@@ -36,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>`_

examples/example 1/README.md

@@ -6,15 +6,14 @@ This example demonstrates various use cases of the Flask-InputFilter package, sh
 
 ```
 example 1/
-├── app.py                 # Main Flask application
-├── filters/              # InputFilter classes
-│   ├── __init__.py      # Package exports
-│   ├── user_filter.py   # User input validation
-│   ├── address_filter.py # Address input validation
-│   ├── profile_filter.py # Profile input validation
-│   └── product_filter.py # Product input validation
-├── test.http            # HTTP test requests
-└── README.md            # This file
+├── app.py                        # Main Flask application
+├── filters/                      # InputFilter classes
+│   ├── __init__.py               # Package exports
+│   ├── product_inputfilter.py    # Product input validation
+│   ├── profile_inputfilter.py    # Profile input validation
+│   └── user_inputfilter.py       # User input validation
+├── test.http                     # HTTP test requests
+└── README.md                     # This file
 ```
 
 ## Features Demonstrated
@@ -29,12 +28,12 @@ example 1/
 
 1. Make sure you have Flask and Flask-InputFilter installed:
 ```bash
-pip install flask flask-inputfilter
+  pip install flask flask-inputfilter
 ```
 
 2. Run the example application:
 ```bash
-python app.py
+  python app.py
 ```
 
 The server will start on `http://localhost:5000`.
@@ -55,18 +54,19 @@ You can use the provided `test.http` file to test the endpoints. This file conta
    - Demonstrates nested filtering with multiple InputFilter classes
    - Optional phone number field
 
-3. `POST /api/products`
+3. `POST /api/product`
    - Creates a new product
-   - Demonstrates basic type conversion with ToFloatFilter
-   - Optional tags field
+   - Demonstrates list validation for tags
+   - Required fields: name, price
+   - Optional tags field as a list of strings
 
 ## Example Requests
 
 ### Successful User Creation
 ```json
 {
     "name": "John Doe",
-    "age": "30",
+    "age": 30,
     "email": "[email protected]"
 }
 ```
@@ -76,13 +76,13 @@ You can use the provided `test.http` file to test the endpoints. This file conta
 {
     "user": {
         "name": "John Doe",
-        "age": "30",
+        "age": 30,
         "email": "[email protected]"
     },
     "address": {
         "street": "123 Main St",
         "city": "New York",
-        "zip_code": "10001"
+        "zip_code": 10001
     },
     "phone": "+1234567890"
 }
@@ -92,8 +92,11 @@ You can use the provided `test.http` file to test the endpoints. This file conta
 ```json
 {
     "name": "Laptop",
-    "price": "999.99",
-    "tags": "electronics,computers,gadgets"
+    "price": 999,
+    "tags": [
+        "electronics",
+        "sports"
+    ]
 }
 ```
 
@@ -138,9 +141,9 @@ You can use the provided `test.http` file to test the endpoints. This file conta
 The application demonstrates various validation errors:
 - Missing required fields
 - Invalid email format
-- Invalid zip code format
-- Invalid phone number format
-- Negative price values
-- Invalid data types
+- Invalid age format (must be integer)
+- Invalid price format
+- Invalid tags format (must be a list of strings)
+- Invalid nested data structures
 
 Each error will return a 400 status code with a descriptive error message. 

examples/example 1/app.py

@@ -1,22 +1,42 @@
-from flask import Flask, jsonify, g
-from .filters import UserInputFilter, ProfileInputFilter, ProductInputFilter
+from flask import Flask, Response, g
+
+from .filters import ProductInputFilter, ProfileInputFilter, UserInputFilter
 
 app = Flask(__name__)
 
-@app.route('/api/user', methods=['POST'], endpoint='create-user')
+
+@app.route("/api/user", methods=["POST"], endpoint="create-user")
 @UserInputFilter.validate()
 def create_user():
-    return jsonify({"message": "User created successfully", "data": g.validated_data}), 201
+    return Response(
+        {"message": "User created successfully", "data": g.validated_data},
+        201,
+    )
+
 
-@app.route('/api/profile', methods=['POST'], endpoint='create-profile')
+@app.route("/api/profile", methods=["POST"], endpoint="create-profile")
 @ProfileInputFilter.validate()
 def create_profile():
-    return jsonify({"message": "Profile created successfully", "data": g.validated_data}), 201
+    return Response(
+        {
+            "message": "Profile created successfully",
+            "data": g.validated_data,
+        },
+        201,
+    )
 
-@app.route('/api/product', methods=['POST'], endpoint='create-product')
+
+@app.route("/api/product", methods=["POST"], endpoint="create-product")
 @ProductInputFilter.validate()
 def create_products():
-    return jsonify({"message": "Products created successfully", "data": g.validated_data}), 201
+    return Response(
+        {
+            "message": "Products created successfully",
+            "data": g.validated_data,
+        },
+        201,
+    )
+
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     app.run(debug=True)

examples/example 1/filters/__init__.py

@@ -1,3 +1,3 @@
 from .product_inputfilter import ProductInputFilter
 from .profile_inputfilter import ProfileInputFilter
-from .user_inputfilter import UserInputFilter
+from .user_inputfilter import UserInputFilter

examples/example 1/filters/product_inputfilter.py

@@ -2,50 +2,50 @@
 
 from flask_inputfilter import InputFilter
 from flask_inputfilter.filters import ToFloatFilter
-from flask_inputfilter.validators import IsStringValidator, IsIntegerValidator, InEnumValidator, IsArrayValidator, \
-    ArrayElementValidator, IsFloatValidator
+from flask_inputfilter.validators import (
+    ArrayElementValidator,
+    InEnumValidator,
+    IsArrayValidator,
+    IsFloatValidator,
+    IsStringValidator,
+)
 
 
 class Tags(Enum):
-    ELECTRONICS = 'electronics'
-    FASHION = 'fashion'
-    HOME = 'home'
-    BEAUTY = 'beauty'
-    SPORTS = 'sports'
-    TOYS = 'toys'
+    ELECTRONICS = "electronics"
+    FASHION = "fashion"
+    HOME = "home"
+    BEAUTY = "beauty"
+    SPORTS = "sports"
+    TOYS = "toys"
+
 
 class ProductInputFilter(InputFilter):
     def __init__(self):
         super().__init__()
 
         self.add(
-            'name',
+            "name",
             required=True,
             validators=[
                 IsStringValidator(),
-            ]
+            ],
         )
 
         self.add(
-            'price',
+            "price",
             required=True,
-            filters=[
-                ToFloatFilter()
-            ],
+            filters=[ToFloatFilter()],
             validators=[
                 IsFloatValidator(),
-            ]
+            ],
         )
 
         self.add(
-            'tags',
+            "tags",
             required=False,
             validators=[
                 IsArrayValidator(),
-                ArrayElementValidator(
-                    InEnumValidator(
-                        Tags
-                    )
-                )
-            ]
+                ArrayElementValidator(InEnumValidator(Tags)),
+            ],
         )

examples/example 1/filters/profile_inputfilter.py

@@ -1,12 +1,15 @@
 from dataclasses import dataclass
 
 from flask_inputfilter import InputFilter
-from flask_inputfilter.validators import IsStringValidator, IsDataclassValidator
+from flask_inputfilter.validators import (
+    IsDataclassValidator,
+    IsStringValidator,
+)
 
 
 @dataclass
 class User:
-    name: int
+    name: str
     age: int
     email: str
 
@@ -23,29 +26,15 @@ def __init__(self):
         super().__init__()
 
         self.add(
-            'user',
-             required=True,
-             validators=[
-                 IsDataclassValidator(
-                    dataclass_type=User
-                 )
-             ]
-         )
+            "user",
+            required=True,
+            validators=[IsDataclassValidator(dataclass_type=User)],
+        )
 
         self.add(
-            'address',
-             required=True,
-             validators=[
-                 IsDataclassValidator(
-                    dataclass_type=Address
-                 )
-             ]
-         )
+            "address",
+            required=True,
+            validators=[IsDataclassValidator(dataclass_type=Address)],
+        )
 
-        self.add(
-            'phone',
-             required=False,
-             validators=[
-                 IsStringValidator()
-             ]
-         )
+        self.add("phone", required=False, validators=[IsStringValidator()])

examples/example 1/filters/user_inputfilter.py

@@ -6,26 +6,8 @@ class UserInputFilter(InputFilter):
     def __init__(self):
         super().__init__()
 
-        self.add(
-            'name',
-            required=True,
-            validators=[
-                IsStringValidator()
-            ]
-        )
+        self.add("name", required=True, validators=[IsStringValidator()])
 
-        self.add(
-            'age',
-            required=True,
-            validators=[
-                IsIntegerValidator()
-            ]
-        )
+        self.add("age", required=True, validators=[IsIntegerValidator()])
 
-        self.add(
-            'email',
-            required=True,
-            validators=[
-                IsStringValidator()
-            ]
-        )
+        self.add("email", required=True, validators=[IsStringValidator()])

flask_inputfilter/filters/__init__.py

@@ -1,5 +1,6 @@
 from flask_inputfilter.filters.base_filter import BaseFilter
 
+from .array_element_filter import ArrayElementFilter
 from .array_explode_filter import ArrayExplodeFilter
 from .base_64_image_downscale_filter import Base64ImageDownscaleFilter
 from .base_64_image_resize_filter import Base64ImageResizeFilter
@@ -31,7 +32,7 @@
 from .whitespace_collapse_filter import WhitespaceCollapseFilter
 
 __all__ = [
-    "ArrayExplodeFilter",
+    "ArrayElementFilter" "ArrayExplodeFilter",
     "Base64ImageDownscaleFilter",
     "Base64ImageResizeFilter",
     "BaseFilter",