Merge pull request #63 from LeanderCS/implement-decorator-field-definition

Implement decorator field definition

Author: LeanderCS

README.md

@@ -68,46 +68,42 @@ A more detailed guide can be found [in the docs](https://leandercs.github.io/fla
 
 ```python
 from flask_inputfilter import InputFilter
+from flask_inputfilter.declarative import field
 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__()
-
-        self.add(
-            'id',
-            required=True,
-            filters=[ToIntegerFilter(), ToNullFilter()],
-            validators=[
-                IsIntegerValidator()
-            ]
-        )
-
-        self.add(
-            'zipcode',
-            filters=[StringTrimFilter()],
-            validators=[
-                RegexValidator(
-                    RegexEnum.POSTAL_CODE.value,
-                    'The zipcode is not in the correct format.'
-                )
-            ]
-        )
-
-        self.add(
-            'city',
-            filters=[StringTrimFilter()],
-            validators=[
-                IsStringValidator()
-            ]
-        )
-
-        self.add_condition(
-            ExactlyOneOfCondition(['zipcode', 'city'])
-        )
+    
+    id: int = field(
+        required=True,
+        filters=[ToIntegerFilter(), ToNullFilter()],
+        validators=[
+            IsIntegerValidator()
+        ]
+    )
+
+    zipcode: str = field(
+        filters=[StringTrimFilter()],
+        validators=[
+            RegexValidator(
+                RegexEnum.POSTAL_CODE.value,
+                'The zipcode is not in the correct format.'
+            )
+        ]
+    )
+    
+    city: str = field(
+        filters=[StringTrimFilter()],
+        validators=[
+            IsStringValidator()
+        ]
+    )
+
+    _conditions = [
+        ExactlyOneOfCondition(['zipcode', 'city'])
+    ]
 ```
 
 

docs/source/changelog.rst

@@ -3,6 +3,73 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+
+[0.7.0] - 2025-09-25
+--------------------
+
+Added
+^^^^^
+- Added that fields, conditons, global filters and global validators can be
+  added as decorator and do not require a self.add, self.add_condition,
+  self.add_global_filter or self.add_global_validator call in the __init__.
+
+  ``self.add`` => ``field``
+
+  ``self.add_condition`` => ``_conditions``
+
+  ``self.add_global_filter`` => ``_global_filters``
+
+  ``self.add_global_validator`` => ``_global_validators``
+
+  ``self.add_model`` => ``_model``
+
+  **Before**:
+    .. code-block:: python
+
+        class UpdateZipcodeInputFilter(InputFilter):
+            def __init__(self):
+                super().__init__()
+                self.add(
+                    'id',
+                    required=True,
+                    filters=[ToIntegerFilter(), ToNullFilter()],
+                    validators=[
+                        IsIntegerValidator()
+                    ]
+                )
+
+                self.add_condition(ExactlyOneOfCondition(['zipcode', 'city']))
+
+                self.add_global_filter(StringTrimFilter())
+
+                self.add_global_validator(IsStringValidator())
+
+                self.set_model(UserModel)
+
+  **After**:
+    .. code-block:: python
+
+        class UpdateZipcodeInputFilter(InputFilter):
+            id: int = field(
+                required=True,
+                filters=[ToIntegerFilter(), ToNullFilter()],
+                validators=[IsIntegerValidator()]
+            )
+
+            _conditions = [ExactlyOneOfCondition(['zipcode', 'city'])]
+
+            _global_filters = [StringTrimFilter()]
+
+            _global_validators = [IsStringValidator()]
+
+            _model = UserModel
+
+  The Change is fully backward compatible, but the new way is more readable
+  and maintainable.
+
+  You can also mix both ways inside a single InputFilter.
+
+
 [0.6.3] - 2025-09-24
 --------------------
 

docs/source/guides/frontend_validation.rst

@@ -18,28 +18,21 @@ Example implementation
     app = Flask(__name__)
 
     class UpdateZipcodeInputFilter(InputFilter):
-        def __init__(self):
-            super().__init__()
-
-            self.add(
-                'id',
-                required=True,
-                filters=[ToIntegerFilter(), ToNullFilter()],
-                validators=[
-                    IsIntegerValidator()
-                ]
-            )
-
-            self.add(
-                'zipcode',
-                filters=[StringTrimFilter()],
-                validators=[
-                    RegexValidator(
-                        pattern=RegexEnum.POSTAL_CODE.value,
-                        error_message='The zipcode is not in the correct format.'
-                    )
-                ]
-            )
+        id: int = field(
+            required=True,
+            filters=[ToIntegerFilter(), ToNullFilter()],
+            validators=[IsIntegerValidator()]
+        )
+
+        zipcode: str = field(
+            filters=[StringTrimFilter()],
+            validators=[
+                RegexValidator(
+                    pattern=RegexEnum.POSTAL_CODE.value,
+                    error_message='The zipcode is not in the correct format.'
+                )
+            ]
+        )
 
     @app.route('/form-update-zipcode', methods=['POST'])
     @UpdateZipcodeInputFilter.validate()

docs/source/index.rst

@@ -56,40 +56,28 @@ Definition
 .. code-block:: python
 
     class UpdateZipcodeInputFilter(InputFilter):
-        def __init__(self):
-            super().__init__()
-
-            self.add(
-                'id',
-                required=True,
-                filters=[ToIntegerFilter(), ToNullFilter()],
-                validators=[
-                    IsIntegerValidator()
-                ]
-            )
-
-            self.add(
-                'zipcode',
-                filters=[StringTrimFilter()],
-                validators=[
-                    RegexValidator(
-                        RegexEnum.POSTAL_CODE.value,
-                        'The zipcode is not in the correct format.'
-                    )
-                ]
-            )
-
-            self.add(
-                'city',
-                filters=[StringTrimFilter()],
-                validators=[
-                    IsStringValidator()
-                ]
-            )
-
-            self.add_condition(
-                ExactlyOneOfCondition(['zipcode', 'city'])
-            )
+        id: int = field(
+            required=True,
+            filters=[ToIntegerFilter(), ToNullFilter()],
+            validators=[IsIntegerValidator()]
+        )
+
+        zipcode: str = field(
+            filters=[StringTrimFilter()],
+            validators=[
+                RegexValidator(
+                    RegexEnum.POSTAL_CODE.value,
+                    'The zipcode is not in the correct format.'
+                )
+            ]
+        )
+
+        city: str = field(
+            filters=[StringTrimFilter()],
+            validators=[IsStringValidator()]
+        )
+
+        _conditions = [ExactlyOneOfCondition(['zipcode', 'city'])]
 
 Usage
 ^^^^^

docs/source/options/condition.rst

@@ -6,32 +6,25 @@ Condition
 Overview
 --------
 
-Conditions are added using the ``add_condition`` method. They evaluate the combined input data, ensuring that inter-field dependencies and relationships (such as equality, ordering, or presence) meet predefined rules.
+Conditions are added using the ``_conditions`` class attribute. They evaluate the combined input data, ensuring that inter-field dependencies and relationships (such as equality, ordering, or presence) meet predefined rules.
 
 Example
 -------
 
 .. code-block:: python
 
     class TestInputFilter(InputFilter):
-        def __init__(self):
-            super().__init__()
+        username: str = field(
+            filters=[StringTrimFilter()],
+            validators=[IsStringValidator()]
+        )
 
-            self.add(
-                'username',
-                filters=[StringTrimFilter()],
-                validators=[IsStringValidator()]
-            )
+        name: str = field(
+            filters=[StringTrimFilter()],
+            validators=[IsStringValidator()]
+        )
 
-            self.add(
-                'name',
-                filters=[StringTrimFilter()],
-                validators=[IsStringValidator()]
-            )
-
-            self.add_condition(
-                OneOfCondition(['id', 'name'])
-            )
+        _conditions = [OneOfCondition(['id', 'name'])]
 
 Available Conditions
 --------------------

docs/source/options/copy.rst

@@ -4,7 +4,7 @@ Copy functionality
 Overview
 --------
 
-The copy functionality is configured via the ``copy`` parameter in the ``add`` method.
+The copy functionality is configured via the ``copy`` parameter in the ``field`` function.
 This parameter accepts a string with the name the value should be copied from.
 
 .. note::
@@ -20,21 +20,14 @@ Basic Copy Integration
 .. code-block:: python
 
     class MyInputFilter(InputFilter):
-        def __init__(self):
-            super().__init__()
-
-            self.add(
-                "username",
-                validator=[
-                    IsStringValidator()
-                ]
-            )
-
-            self.add(
-                "escapedUsername",
-                copy="username"
-                filters=[StringSlugifyFilter()]
-            )
+        username: str = field(
+            validators=[IsStringValidator()]
+        )
+
+        escapedUsername: str = field(
+            copy="username",
+            filters=[StringSlugifyFilter()]
+        )
 
     # Example usage
     # Body: {"username": "Very Important User"}
@@ -53,30 +46,22 @@ The coping can also be used as a chain.
 .. code-block:: python
 
     class MyInputFilter(InputFilter):
-        def __init__(self):
-            super().__init__()
-
-            self.add(
-                "username"
-            )
-
-            self.add(
-                "escapedUsername",
-                copy="username"
-                filters=[StringSlugifyFilter()]
-            )
-
-            self.add(
-                "upperEscapedUsername",
-                copy="escapedUsername"
-                filters=[ToUpperFilter()]
-            )
-
-            self.add(
-                "lowerEscapedUsername",
-                copy="escapedUsername"
-                filters=[ToLowerFilter()]
-            )
+        username: str = field()
+
+        escapedUsername: str = field(
+            copy="username",
+            filters=[StringSlugifyFilter()]
+        )
+
+        upperEscapedUsername: str = field(
+            copy="escapedUsername",
+            filters=[ToUpperFilter()]
+        )
+
+        lowerEscapedUsername: str = field(
+            copy="escapedUsername",
+            filters=[ToLowerFilter()]
+        )
 
     # Example usage
     # Body: {"username": "Very Important User"}