model

Author: LeanderCS

examples/basic/filters/user_with_model_inputfilter.py

@@ -0,0 +1,20 @@
+from dataclasses import dataclass
+
+from flask_inputfilter import InputFilter
+from flask_inputfilter.declarative import field
+from flask_inputfilter.validators import IsIntegerValidator, IsStringValidator
+
+
+@dataclass
+class User:
+    name: str
+    age: int
+    email: str
+
+
+class UserWithModelInputFilter(InputFilter):
+    name: str = field(required=True, validators=[IsStringValidator()])
+    age: int = field(required=True, validators=[IsIntegerValidator()])
+    email: str = field(required=True, validators=[IsStringValidator()])
+
+    _model = User

flask_inputfilter/declarative/__init__.py

@@ -1,28 +1,7 @@
-"""
-Declarative API components for flask-inputfilter.
-
-This package provides descriptors and factory functions for declarative
-InputFilter field definition using decorators.
-"""
-
-from .condition_descriptor import ConditionDescriptor
-from .factory_functions import (
-    condition,
-    field,
-    global_filter,
-    global_validator,
-)
+from .factory_functions import field
 from .field_descriptor import FieldDescriptor
-from .global_filter_descriptor import GlobalFilterDescriptor
-from .global_validator_descriptor import GlobalValidatorDescriptor
 
 __all__ = [
-    "ConditionDescriptor",
     "FieldDescriptor",
-    "GlobalFilterDescriptor",
-    "GlobalValidatorDescriptor",
-    "condition",
     "field",
-    "global_filter",
-    "global_validator",
 ]

flask_inputfilter/declarative/condition_descriptor.py

@@ -1,17 +1,11 @@
-"""Factory functions for creating descriptors."""
-
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Optional, Union
 
-from .condition_descriptor import ConditionDescriptor
 from .field_descriptor import FieldDescriptor
-from .global_filter_descriptor import GlobalFilterDescriptor
-from .global_validator_descriptor import GlobalValidatorDescriptor
 
 if TYPE_CHECKING:
     from flask_inputfilter.models import (
-        BaseCondition,
         BaseFilter,
         BaseValidator,
         ExternalApiConfig,
@@ -77,98 +71,3 @@ class UserInputFilter(InputFilter):
         external_api=external_api,
         copy=copy,
     )
-
-
-def condition(cond: BaseCondition) -> ConditionDescriptor:
-    """
-    Create a condition descriptor for declarative condition definition.
-
-    This function creates a ConditionDescriptor that can be used to
-    register conditions declaratively using class attributes.
-
-    **Parameters:**
-
-    - **cond** (*BaseCondition*): The condition to register.
-
-    **Returns:**
-
-    A condition descriptor with the given condition.
-
-    **Example:**
-
-    .. code-block:: python
-
-        from flask_inputfilter import InputFilter
-        from flask_inputfilter.declarative import condition
-        from flask_inputfilter.conditions import ExactlyOneOfCondition
-
-        class ContactInputFilter(InputFilter):
-            _conditions = [
-                ExactlyOneOfCondition(['phone', 'email'])
-            ]
-    """
-    return ConditionDescriptor(cond)
-
-
-def global_validator(
-    validators: Union[BaseValidator, list[BaseValidator]]
-) -> GlobalValidatorDescriptor:
-    """
-    Create a global validator descriptor for declarative global validator definition.
-
-    This function creates a GlobalValidatorDescriptor that can be used to
-    register global validators declaratively using class attributes.
-
-    **Parameters:**
-
-    - **validators** (*Union[BaseValidator, list[BaseValidator]]*): The validator(s) to register globally.
-      Can be a single validator or a list of validators.
-
-    **Returns:**
-
-    A global validator descriptor.
-
-    **Example:**
-
-    .. code-block:: python
-
-        from flask_inputfilter import InputFilter
-        from flask_inputfilter.declarative import global_validator
-        from flask_inputfilter.validators import IsStringValidator
-
-        class FormInputFilter(InputFilter):
-            _global_validators = [IsStringValidator()]
-    """
-    return GlobalValidatorDescriptor(validators)
-
-
-def global_filter(
-    filters: Union[BaseFilter, list[BaseFilter]]
-) -> GlobalFilterDescriptor:
-    """
-    Create a global filter descriptor for declarative global filter definition.
-
-    This function creates a GlobalFilterDescriptor that can be used to
-    register global filters declaratively using class attributes.
-
-    **Parameters:**
-
-    - **filters** (*Union[BaseFilter, list[BaseFilter]]*): The filter(s) to register globally.
-      Can be a single filter or a list of filters.
-
-    **Returns:**
-
-    A global filter descriptor.
-
-    **Example:**
-
-    .. code-block:: python
-
-        from flask_inputfilter import InputFilter
-        from flask_inputfilter.declarative import global_filter
-        from flask_inputfilter.filters import StringTrimFilter
-
-        class FormInputFilter(InputFilter):
-            _global_filters = [StringTrimFilter()]
-    """
-    return GlobalFilterDescriptor(filters)

flask_inputfilter/declarative/factory_functions.py

@@ -1,5 +1,3 @@
-"""Field descriptor for declarative field definition."""
-
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Optional, Union

flask_inputfilter/declarative/field_descriptor.py

@@ -1,21 +1,9 @@
 from .declarative import (
-    ConditionDescriptor,
     FieldDescriptor,
-    GlobalFilterDescriptor,
-    GlobalValidatorDescriptor,
-    condition,
     field,
-    global_filter,
-    global_validator,
 )
 
 __all__ = [
-    "ConditionDescriptor",
     "FieldDescriptor",
-    "GlobalFilterDescriptor",
-    "GlobalValidatorDescriptor",
-    "condition",
     "field",
-    "global_filter",
-    "global_validator",
 ]

flask_inputfilter/declarative/global_filter_descriptor.py

@@ -247,6 +247,9 @@ def _register_decorator_components(self) -> None:
                 if filter not in self.global_filters:
                     self.global_filters.append(filter)
 
+        if hasattr(self.__class__, "_decorator_model") and self.__class__._decorator_model:
+            self.model_class = self.__class__._decorator_model
+
     def get_conditions(self) -> list[BaseCondition]:
         """
         Retrieve the list of all registered conditions.