Added python 3.14 support and new FieldModel

Author: LeanderCS

README.rst

@@ -8,12 +8,12 @@ and type requirements before being processed.
 Thank you for using ``flask-inputfilter``!
 ==========================================
 
-If you have any questions or suggestions, please feel free to open an issue on GitHub `here <https://github.com/LeanderCS/flask-inputfilter>`__.
+If you have any questions or suggestions, please feel free to open an issue on `GitHub <https://github.com/LeanderCS/flask-inputfilter>`__.
 
 If you don't want to miss any updates, please star the repository.
 This will help me to understand how many people are interested in this project.
 
-For information about the usage you can view the documentation `here <https://leandercs.github.io/flask-inputfilter>`__.
+For information about the usage you can view the `documentation <https://leandercs.github.io/flask-inputfilter>`__.
 
 :Test Status:
 
@@ -34,7 +34,7 @@ For information about the usage you can view the documentation `here <https://le
 
 :Downloads:
 
-    .. image:: https://img.shields.io/pypi/dm/flask-inputfilter?style=flat-square&label=PyPI
+    .. image:: https://static.pepy.tech/badge/flask-inputfilter/month
         :target: https://pypi.org/project/flask-inputfilter/
     .. image:: https://static.pepy.tech/badge/flask-inputfilter
         :target: https://pypi.org/project/flask-inputfilter/

docs/changelog.rst

@@ -4,6 +4,18 @@ Changelog
 All notable changes to this project will be documented in this file.
 
 
+[0.0.10] - 2025-03-06
+--------------------
+
+Added
+^^^^^
+- Added python 3.14 support.
+
+Changed
+^^^^^^^
+- Use ``FieldModel`` vor field definition. (Only internal change, no impact on the user)
+
+
 [0.0.9.1] - 2025-02-09
 ----------------------
 

docs/conf.py

@@ -1,27 +1,12 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
 project = "flask-inputfilter"
 copyright = "2025, Leander Cain Slotosch"
 author = "Leander Cain Slotosch"
-release = "0.0.9.1"
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+release = "0.0.10"
 
 extensions = []
 
 templates_path = []
 exclude_patterns = []
 
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
 html_theme = "alabaster"
 html_static_path = []

docs/index.rst

@@ -16,10 +16,11 @@ Overview
 Available functions:
 --------------------
 
-- :doc:`Creating your own Conditions, Filters and Validators <guides/create_own>`
+- :doc:`InputFilter <options/inputfilter>`
 - :doc:`Conditions <options/condition>`
 - :doc:`Filter <options/filter>`
 - :doc:`Validator <options/validator>`
+- :doc:`Creating your own Conditions, Filters and Validators <guides/create_own>`
 - :doc:`ExternalApi <options/external_api>`
 
 

docs/options/index.rst

@@ -5,9 +5,9 @@ Options
     :maxdepth: 2
 
     condition
+    filter
     validator
     external_api
-    filter
 
 The `add` method supports several options:
 

env_configs/Dockerfile

@@ -38,8 +38,9 @@ RUN /root/.pyenv/bin/pyenv install 3.10.2
 RUN /root/.pyenv/bin/pyenv install 3.11.0
 RUN /root/.pyenv/bin/pyenv install 3.12.0
 RUN /root/.pyenv/bin/pyenv install 3.13.0
+RUN /root/.pyenv/bin/pyenv install 3.14-dev
 
-RUN /root/.pyenv/bin/pyenv global 3.7.12 3.8.12 3.9.7 3.10.2 3.11.0 3.12.0 3.13.0
+RUN /root/.pyenv/bin/pyenv global 3.7.12 3.8.12 3.9.7 3.10.2 3.11.0 3.12.0 3.13.0 3.14-dev
 
 RUN pip install --upgrade pip
 

env_configs/requirements-py314.txt

@@ -0,0 +1,5 @@
+flask
+pillow
+pytest
+requests
+typing_extensions

flask_inputfilter/InputFilter.py

@@ -1,28 +1,29 @@
 import re
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union
 
-import requests
 from flask import Response, g, request
 from typing_extensions import final
 
 from flask_inputfilter.Condition.BaseCondition import BaseCondition
 from flask_inputfilter.Exception import ValidationError
 from flask_inputfilter.Filter import BaseFilter
-from flask_inputfilter.Model import ExternalApiConfig
+from flask_inputfilter.Model import ExternalApiConfig, FieldModel
 from flask_inputfilter.Validator import BaseValidator
 
+API_PLACEHOLDER_PATTERN = re.compile(r"{{(.*?)}}")
+
 
 class InputFilter:
     """
     Base class for input filters.
     """
 
     def __init__(self, methods: Optional[List[str]] = None) -> None:
-        self.methods = methods or ["GET", "POST", "PATCH", "PUT", "DELETE"]
-        self.fields = {}
-        self.conditions = []
-        self.global_filters = []
-        self.global_validators = []
+        self._methods = methods or ["GET", "POST", "PATCH", "PUT", "DELETE"]
+        self._fields: Dict[str, FieldModel] = {}
+        self._conditions: List[BaseCondition] = []
+        self._global_filters: List[BaseFilter] = []
+        self._global_validators: List[BaseValidator] = []
 
     @final
     def add(
@@ -40,96 +41,90 @@ def add(
         """
         Add the field to the input filter.
 
-        :param name: The name of the field.
-        :param required: Whether the field is required.
-        :param default: The default value of the field.
-        :param fallback: The fallback value of the field, if validations fails
-        or field None, although it is required .
-        :param filters: The filters to apply to the field value.
-        :param validators: The validators to apply to the field value.
-        :param steps: Allows to apply multiple filters and validators
-        in a specific order.
-        :param external_api: Configuration for an external API call.
-        :param copy: The name of the field to copy the value from.
+        Args:
+            name: The name of the field.
+            required: Whether the field is required.
+            default: The default value of the field.
+            fallback: The fallback value of the field, if validations fails
+                or field None, although it is required .
+            filters: The filters to apply to the field value.
+            validators: The validators to apply to the field value.
+            steps: Allows to apply multiple filters and validators
+                in a specific order.
+            external_api: Configuration for an external API call.
+            copy: The name of the field to copy the value from.
         """
-
-        self.fields[name] = {
-            "required": required,
-            "default": default,
-            "fallback": fallback,
-            "filters": filters or [],
-            "validators": validators or [],
-            "steps": steps or [],
-            "external_api": external_api,
-            "copy": copy,
-        }
+        self._fields[name] = FieldModel(
+            required=required,
+            default=default,
+            fallback=fallback,
+            filters=filters or [],
+            validators=validators or [],
+            steps=steps or [],
+            external_api=external_api,
+            copy=copy,
+        )
 
     @final
     def addCondition(self, condition: BaseCondition) -> None:
         """
         Add a condition to the input filter.
         """
-        self.conditions.append(condition)
+        self._conditions.append(condition)
 
     @final
     def addGlobalFilter(self, filter_: BaseFilter) -> None:
         """
         Add a global filter to be applied to all fields.
         """
-        self.global_filters.append(filter_)
+        self._global_filters.append(filter_)
 
     @final
     def addGlobalValidator(self, validator: BaseValidator) -> None:
         """
         Add a global validator to be applied to all fields.
         """
-        self.global_validators.append(validator)
+        self._global_validators.append(validator)
 
-    @final
     def __applyFilters(self, filters: List[BaseFilter], value: Any) -> Any:
         """
         Apply filters to the field value.
         """
-
         if value is None:
             return value
 
-        for filter_ in self.global_filters + filters:
+        for filter_ in self._global_filters + filters:
             value = filter_.apply(value)
 
         return value
 
-    @final
     def __validateField(
         self, validators: List[BaseValidator], fallback: Any, value: Any
     ) -> None:
         """
         Validate the field value.
         """
-
         if value is None:
             return
 
         try:
-            for validator in self.global_validators + validators:
+            for validator in self._global_validators + validators:
                 validator.validate(value)
         except ValidationError:
             if fallback is None:
                 raise
 
             return fallback
 
-    @final
+    @staticmethod
     def __applySteps(
-        self,
         steps: List[Union[BaseFilter, BaseValidator]],
         fallback: Any,
         value: Any,
     ) -> Any:
         """
         Apply multiple filters and validators in a specific order.
         """
-
         if value is None:
             return
 
@@ -143,17 +138,16 @@ def __applySteps(
             if fallback is None:
                 raise
             return fallback
-
         return value
 
-    @final
     def __callExternalApi(
         self, config: ExternalApiConfig, fallback: Any, validated_data: dict
     ) -> Optional[Any]:
         """
         Führt den API-Aufruf durch und gibt den Wert zurück,
         der im Antwortkörper zu finden ist.
         """
+        import requests
 
         requestData = {
             "headers": {},
@@ -204,20 +198,16 @@ def __callExternalApi(
             return fallback
 
     @staticmethod
-    @final
     def __replacePlaceholders(value: str, validated_data: dict) -> str:
         """
         Replace all placeholders, marked with '{{ }}' in value
         with the corresponding values from validated_data.
         """
-
-        return re.sub(
-            r"{{(.*?)}}",
+        return API_PLACEHOLDER_PATTERN.sub(
             lambda match: str(validated_data.get(match.group(1))),
             value,
         )
 
-    @final
     def __replacePlaceholdersInParams(
         self, params: dict, validated_data: dict
     ) -> dict:
@@ -233,7 +223,6 @@ def __replacePlaceholdersInParams(
         }
 
     @staticmethod
-    @final
     def __checkForRequired(
         field_name: str,
         required: bool,
@@ -251,7 +240,6 @@ def __checkForRequired(
         value is returned.
         If no of the above conditions are met, a ValidationError is raised.
         """
-
         if value is not None:
             return value
 
@@ -264,7 +252,7 @@ def __checkForRequired(
         raise ValidationError(f"Field '{field_name}' is required.")
 
     def __checkConditions(self, validated_data: dict) -> None:
-        for condition in self.conditions:
+        for condition in self._conditions:
             if not condition.check(validated_data):
                 raise ValidationError(f"Condition '{condition}' not met.")
 
@@ -276,24 +264,23 @@ def validateData(
         Validate the input data, considering both request data and
         URL parameters (kwargs).
         """
-
         if kwargs is None:
             kwargs = {}
 
         validated_data = {}
         combined_data = {**data, **kwargs}
 
-        for field_name, field_info in self.fields.items():
+        for field_name, field_info in self._fields.items():
             value = combined_data.get(field_name)
 
-            required = field_info["required"]
-            default = field_info["default"]
-            fallback = field_info["fallback"]
-            filters = field_info["filters"]
-            validators = field_info["validators"]
-            steps = field_info["steps"]
-            external_api = field_info["external_api"]
-            copy = field_info["copy"]
+            required = field_info.required
+            default = field_info.default
+            fallback = field_info.fallback
+            filters = field_info.filters
+            validators = field_info.validators
+            steps = field_info.steps
+            external_api = field_info.external_api
+            copy = field_info.copy
 
             if copy:
                 value = validated_data.get(copy)
@@ -344,7 +331,7 @@ def wrapper(
                 *args, **kwargs
             ) -> Union[Response, Tuple[Any, Dict[str, Any]]]:
                 input_filter = cls()
-                if request.method not in input_filter.methods:
+                if request.method not in input_filter._methods:
                     return Response(status=405, response="Method Not Allowed")
 
                 data = request.json if request.is_json else request.args

flask_inputfilter/Model/ExternalApiConfig.py

@@ -11,6 +11,8 @@ class ExternalApiConfig:
     :param method: The HTTP method to use.
     :param params: The parameters to send to the API.
     :param data_key: The key in the response JSON to use
+    :param api_key: The API key to use.
+    :param headers: The headers to send to the API.
     """
 
     url: str