Use less tpes of typing

Author: LeanderCS

docker-compose.yaml

@@ -1,10 +1,30 @@
 services:
 
-  flask-inputfilter:
+  env:
+    build:
+      context: .
+      dockerfile: env_configs/env.Dockerfile
+    container_name: flask-inputfilter-env
+    volumes:
+      - .:/app
+    stdin_open: true
+    tty: true
+
+  cython:
     build:
       context: .
       dockerfile: env_configs/cython.Dockerfile
-    container_name: flask-inputfilter
+    container_name: flask-inputfilter-cython
+    volumes:
+      - .:/app
+    stdin_open: true
+    tty: true
+
+  pure:
+    build:
+      context: .
+      dockerfile: env_configs/pure.Dockerfile
+    container_name: flask-inputfilter-pure
     volumes:
       - .:/app
     ports:

docs/source/changelog.rst

@@ -3,6 +3,15 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+[0.5.5] - 2025-06-30
+--------------------
+
+Changed
+^^^^^^^
+- Updated ``InputFilter`` to increase performance.
+- Updated ``IsDataclassValidator`` to be more readable and maintainable.
+
+
 [0.5.4] - 2025-05-24
 --------------------
 

docs/source/guides/create_own_components.rst

@@ -18,7 +18,7 @@ Condition
 First off with conditions.
 
 Their validation method is called ``check``.
-It expects a dict from the type ``Dict[str, Any]`` whereas the key (``str``) of the
+It expects a dict from the type ``dict[str, Any]`` whereas the key (``str``) of the
 dictionary represents the name of a field and the value (``Any``) the corresponding value.
 The dict represents the entirety of all fields present in the InputFilter it is called.
 

docs/source/options/external_api.rst

@@ -36,7 +36,7 @@ Fields of `ExternalApiConfig`
      - ``str``
      - The HTTP method to use (e.g., ``GET``, ``POST``).
    * - ``params``
-     - ``Optional[Dict[str, str]]``
+     - ``Optional[dict[str, str]]``
      - Query parameters for the API, with placeholders allowed.
    * - ``data_key``
      - ``Optional[str]``

env_configs/cython.Dockerfile

@@ -10,7 +10,7 @@ COPY pyproject.toml /app
 
 RUN python -m pip install .[dev]
 
-COPY .. /app
-
 COPY scripts /usr/local/bin
 RUN find /usr/local/bin -type f -name "*" -exec chmod +x {} \;
+
+COPY .. /app

env_configs/pure.Dockerfile

@@ -10,7 +10,7 @@ COPY pyproject.toml /app
 
 RUN python -m pip install .[dev]
 
-COPY .. /app
-
 COPY scripts /usr/local/bin
 RUN find /usr/local/bin -type f -name "*" -exec chmod +x {} \;
+
+COPY .. /app

flask_inputfilter/_input_filter.pyx

@@ -7,7 +7,7 @@
 import json
 import logging
 import warnings
-from typing import Any, Dict, List, Optional, Type, TypeVar, Union
+from typing import Any, Optional, Type, TypeVar, Union
 
 from flask import Response, g, request
 
@@ -46,16 +46,16 @@ cdef class InputFilter:
 
     def __cinit__(self) -> None:
         self.methods = make_default_methods()
-        self.fields: Dict[str, FieldModel] = {}
-        self.conditions: List[BaseCondition] = []
-        self.global_filters: List[BaseFilter] = []
-        self.global_validators: List[BaseValidator] = []
-        self.data: Dict[str, Any] = {}
-        self.validated_data: Dict[str, Any] = {}
-        self.errors: Dict[str, str] = {}
+        self.fields: dict[str, FieldModel] = {}
+        self.conditions: list[BaseCondition] = []
+        self.global_filters: list[BaseFilter] = []
+        self.global_validators: list[BaseValidator] = []
+        self.data: dict[str, Any] = {}
+        self.validated_data: dict[str, Any] = {}
+        self.errors: dict[str, str] = {}
         self.model_class: Optional[Type[T]] = None
 
-    def __init__(self, methods: Optional[List[str]] = None) -> None:
+    def __init__(self, methods: Optional[list[str]] = None) -> None:
         if methods is not None:
             self.methods.clear()
             [self.methods.push_back(method.encode()) for method in methods]
@@ -111,7 +111,7 @@ cdef class InputFilter:
                 f (Callable): The Flask route function to be decorated.
 
             Returns:
-                Callable[[Any, Any], Union[Response, tuple[Any, Dict[str, Any]]]]: The wrapped function with input validation.
+                Callable[[Any, Any], Union[Response, tuple[Any, dict[str, Any]]]]: The wrapped function with input validation.
             """
 
             def wrapper(
@@ -126,7 +126,7 @@ cdef class InputFilter:
                     **kwargs: Keyword arguments for the route function.
 
                 Returns:
-                    Union[Response, tuple[Any, Dict[str, Any]]]: The response from the route function or an error response.
+                    Union[Response, tuple[Any, dict[str, Any]]]: The response from the route function or an error response.
                 """
 
                 cdef InputFilter input_filter = cls()
@@ -172,7 +172,7 @@ cdef class InputFilter:
         return decorator
 
     cpdef object validateData(
-        self, data: Optional[Dict[str, Any]] = None
+        self, data: Optional[dict[str, Any]] = None
     ):
         warnings.warn(
             "validateData() is deprecated, use validate_data() instead",
@@ -182,7 +182,7 @@ cdef class InputFilter:
         return self.validate_data(data)
 
     cpdef object validate_data(
-        self, data: Optional[Dict[str, Any]] = None
+        self, data: Optional[dict[str, Any]] = None
     ):
         """
         Validates input data against defined field rules, including applying
@@ -191,12 +191,12 @@ cdef class InputFilter:
         appropriately and conditions are checked after processing.
 
         Args:
-            data (Dict[str, Any]): A dictionary containing the input data to
+            data (dict[str, Any]): A dictionary containing the input data to
                 be validated where keys represent field names and values
                 represent the corresponding data.
 
         Returns:
-            Union[Dict[str, Any], Type[T]]: A dictionary containing the validated data with
+            Union[dict[str, Any], Type[T]]: A dictionary containing the validated data with
                 any modifications, default values, or processed values as
                 per the defined validation rules.
 
@@ -325,27 +325,27 @@ cdef class InputFilter:
         is represented as an instance of the BaseCondition type.
 
         Returns:
-            List[BaseCondition]: A list containing all currently registered
+            list[BaseCondition]: A list containing all currently registered
                 instances of BaseCondition.
         """
         return self.conditions
 
-    cpdef void setData(self, data: Dict[str, Any]):
+    cpdef void setData(self, data: dict[str, Any]):
         warnings.warn(
             "setData() is deprecated, use set_data() instead",
             DeprecationWarning,
             stacklevel=2
         )
         self.set_data(data)
 
-    cpdef void set_data(self, data: Dict[str, Any]):
+    cpdef void set_data(self, data: dict[str, Any]):
         """
         Filters and sets the provided data into the object's internal
         storage, ensuring that only the specified fields are considered and
         their values are processed through defined filters.
 
         Parameters:
-            data (Dict[str, Any]):
+            data (dict[str, Any]):
                 The input dictionary containing key-value pairs where keys
                 represent field names and values represent the associated
                 data to be filtered and stored.
@@ -405,7 +405,7 @@ cdef class InputFilter:
         can be of various types depending on the object's design.
 
         Returns:
-            Dict[str, Any]: A dictionary containing string keys and their
+            dict[str, Any]: A dictionary containing string keys and their
                             corresponding values of any data type.
         """
         return self.validated_data
@@ -455,7 +455,7 @@ cdef class InputFilter:
         the identifiers, and the values are of any data type.
 
         Returns:
-            Dict[str, Any]: A dictionary containing the raw values retrieved.
+            dict[str, Any]: A dictionary containing the raw values retrieved.
                The keys are strings representing the identifiers, and the
                values can be of any type, depending on the source
                being accessed.
@@ -488,28 +488,28 @@ cdef class InputFilter:
         is required, as it does not perform any validations or checks.
 
         Returns:
-            Dict[str, Any]: The unfiltered, raw data retrieved from the
+            dict[str, Any]: The unfiltered, raw data retrieved from the
                  data source. The return type may vary based on the
                  specific implementation of the data source.
         """
         return self.data
 
-    cpdef void setUnfilteredData(self, data: Dict[str, Any]):
+    cpdef void setUnfilteredData(self, data: dict[str, Any]):
         warnings.warn(
             "setUnfilteredData() is deprecated, use set_unfiltered_data() instead",
             DeprecationWarning,
             stacklevel=2
         )
         self.set_unfiltered_data(data)
 
-    cpdef void set_unfiltered_data(self, data: Dict[str, Any]):
+    cpdef void set_unfiltered_data(self, data: dict[str, Any]):
         """
         Sets unfiltered data for the current instance. This method assigns a
         given dictionary of data to the instance for further processing. It
         updates the internal state using the provided data.
 
         Parameters:
-            data (Dict[str, Any]): A dictionary containing the unfiltered
+            data (dict[str, Any]): A dictionary containing the unfiltered
                 data to be associated with the instance.
         """
         self.data = data
@@ -585,7 +585,7 @@ cdef class InputFilter:
         respective error messages.
 
         Returns:
-            Dict[str, str]: A dictionary containing field names as keys and
+            dict[str, str]: A dictionary containing field names as keys and
                             their corresponding error messages as values.
         """
         return self.errors
@@ -596,9 +596,9 @@ cdef class InputFilter:
         required: bool = False,
         default: Any = None,
         fallback: Any = None,
-        filters: Optional[List[BaseFilter]] = None,
-        validators: Optional[List[BaseValidator]] = None,
-        steps: Optional[List[Union[BaseFilter, BaseValidator]]] = None,
+        filters: Optional[list[BaseFilter]] = None,
+        validators: Optional[list[BaseValidator]] = None,
+        steps: Optional[list[Union[BaseFilter, BaseValidator]]] = None,
         external_api: Optional[ExternalApiConfig] = None,
         copy: Optional[str] = None,
     ) except *:
@@ -615,13 +615,13 @@ cdef class InputFilter:
             fallback (Optional[Any]): The fallback value of the field, if 
                 validations fails or field None, although it is required.
 
-            filters (Optional[List[BaseFilter]]): The filters to apply to 
+            filters (Optional[list[BaseFilter]]): The filters to apply to 
                 the field value.
 
-            validators (Optional[List[BaseValidator]]): The validators to 
+            validators (Optional[list[BaseValidator]]): The validators to 
                 apply to the field value.
 
-            steps (Optional[List[Union[BaseFilter, BaseValidator]]]): Allows 
+            steps (Optional[list[Union[BaseFilter, BaseValidator]]]): Allows 
                 to apply multiple filters and validators in a specific order.
 
             external_api (Optional[ExternalApiConfig]): Configuration for an 
@@ -699,7 +699,7 @@ cdef class InputFilter:
         Retrieve the dictionary of input fields associated with the object.
 
         Returns:
-            Dict[str, FieldModel]: Dictionary containing field names as
+            dict[str, FieldModel]: Dictionary containing field names as
                 keys and their corresponding FieldModel instances as values
         """
         return self.fields
@@ -740,9 +740,9 @@ cdef class InputFilter:
         required: bool = False,
         default: Any = None,
         fallback: Any = None,
-        filters: Optional[List[BaseFilter]] = None,
-        validators: Optional[List[BaseValidator]] = None,
-        steps: Optional[List[Union[BaseFilter, BaseValidator]]] = None,
+        filters: Optional[list[BaseFilter]] = None,
+        validators: Optional[list[BaseValidator]] = None,
+        steps: Optional[list[Union[BaseFilter, BaseValidator]]] = None,
         external_api: Optional[ExternalApiConfig] = None,
         copy: Optional[str] = None,
     ):
@@ -759,13 +759,13 @@ cdef class InputFilter:
             fallback (Optional[Any]): The fallback value of the field, if 
                 validations fails or field None, although it is required.
 
-            filters (Optional[List[BaseFilter]]): The filters to apply to 
+            filters (Optional[list[BaseFilter]]): The filters to apply to 
                 the field value.
 
-            validators (Optional[List[BaseValidator]]): The validators to 
+            validators (Optional[list[BaseValidator]]): The validators to 
                 apply to the field value.
 
-            steps (Optional[List[Union[BaseFilter, BaseValidator]]]): Allows 
+            steps (Optional[list[Union[BaseFilter, BaseValidator]]]): Allows 
                 to apply multiple filters and validators in a specific order.
 
             external_api (Optional[ExternalApiConfig]): Configuration for an 
@@ -819,7 +819,7 @@ cdef class InputFilter:
         all fields during data processing.
 
         Returns:
-            List[BaseFilter]: A list of global filters.
+            list[BaseFilter]: A list of global filters.
         """
         return self.global_filters
 
@@ -907,7 +907,7 @@ cdef class InputFilter:
         raw validated data.
 
         Returns:
-            Union[Dict[str, Any], T]: The serialized data.
+            Union[dict[str, Any], T]: The serialized data.
         """
         if self.model_class is None:
             return self.validated_data
@@ -949,6 +949,6 @@ cdef class InputFilter:
         to all fields during validation.
 
         Returns:
-            List[BaseValidator]: A list of global validators.
+            list[BaseValidator]: A list of global validators.
         """
         return self.global_validators

flask_inputfilter/conditions/array_length_equal_condition.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, Dict
+from typing import Any
 
 from flask_inputfilter.conditions import BaseCondition
 
@@ -54,7 +54,7 @@ def __init__(
         self.first_array_field = first_array_field
         self.second_array_field = second_array_field
 
-    def check(self, data: Dict[str, Any]) -> bool:
+    def check(self, data: dict[str, Any]) -> bool:
         return len(data.get(self.first_array_field) or []) == len(
             data.get(self.second_array_field) or []
         )

flask_inputfilter/conditions/array_longer_than_condition.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, Dict
+from typing import Any
 
 from flask_inputfilter.conditions import BaseCondition
 
@@ -51,7 +51,7 @@ def __init__(self, longer_field: str, shorter_field: str) -> None:
         self.longer_field = longer_field
         self.shorter_field = shorter_field
 
-    def check(self, data: Dict[str, Any]) -> bool:
+    def check(self, data: dict[str, Any]) -> bool:
         return len(data.get(self.longer_field) or []) > len(
             data.get(self.shorter_field) or []
         )