Merge pull request #61 from LeanderCS/ruff

Add IsImageValidator, ToBase64ImageFilter and ToImageFilter

Author: LeanderCS

docs/source/changelog.rst

@@ -3,6 +3,22 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+[0.6.2] - 2025-07-03
+--------------------
+
+Added
+^^^^^
+- Added IsImageValidator, ToBase64ImageFilter and ToImageFilter.
+
+
+[0.6.1] - 2025-07-02
+--------------------
+
+Changed
+^^^^^^^
+- Fixed issue with ``__init__.py`` for compiled versions.
+
+
 [0.6.0] - 2025-06-30
 --------------------
 

flask_inputfilter/_input_filter.pyx

@@ -184,7 +184,11 @@ cdef class InputFilter:
             dict[str, Any] validated_data
 
         validated_data, errors = DataMixin.validate_with_conditions(
-            self.fields, data, self.global_filters, self.global_validators, self.conditions
+            self.fields,
+            data,
+            self.global_filters,
+            self.global_validators,
+            self.conditions,
         )
 
         if errors:

flask_inputfilter/conditions/base_condition.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import warnings
 
 warnings.warn(
@@ -7,5 +9,3 @@
     DeprecationWarning,
     stacklevel=2,
 )
-
-from flask_inputfilter.models import BaseCondition

flask_inputfilter/filters/__init__.py

@@ -9,6 +9,7 @@
 from .string_slugify_filter import StringSlugifyFilter
 from .string_trim_filter import StringTrimFilter
 from .to_alpha_numeric_filter import ToAlphaNumericFilter
+from .to_base64_image_filter import ToBase64ImageFilter
 from .to_boolean_filter import ToBooleanFilter
 from .to_camel_case_filter import ToCamelCaseFilter
 from .to_dataclass_filter import ToDataclassFilter
@@ -17,6 +18,7 @@
 from .to_digits_filter import ToDigitsFilter
 from .to_enum_filter import ToEnumFilter
 from .to_float_filter import ToFloatFilter
+from .to_image_filter import ToImageFilter
 from .to_integer_filter import ToIntegerFilter
 from .to_iso_filter import ToIsoFilter
 from .to_lower_filter import ToLowerFilter
@@ -42,6 +44,7 @@
     "StringSlugifyFilter",
     "StringTrimFilter",
     "ToAlphaNumericFilter",
+    "ToBase64ImageFilter",
     "ToBooleanFilter",
     "ToCamelCaseFilter",
     "ToDataclassFilter",
@@ -50,6 +53,7 @@
     "ToDigitsFilter",
     "ToEnumFilter",
     "ToFloatFilter",
+    "ToImageFilter",
     "ToIntegerFilter",
     "ToIsoFilter",
     "ToLowerFilter",

flask_inputfilter/filters/base_filter.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import warnings
 
 warnings.warn(
@@ -7,5 +9,3 @@
     DeprecationWarning,
     stacklevel=2,
 )
-
-from flask_inputfilter.models import BaseFilter

flask_inputfilter/filters/string_slugify_filter.py

@@ -38,12 +38,16 @@ def apply(self, value: Any) -> Union[Optional[str], Any]:
 
         value_without_accents = "".join(
             char
-            for char in unicodedata.normalize(UnicodeFormEnum.NFD.value, value)
+            for char in unicodedata.normalize(
+                UnicodeFormEnum.NFD.value,
+                value,
+            )
             if unicodedata.category(char) != "Mn"
         )
 
         value = unicodedata.normalize(
-            UnicodeFormEnum.NFKD.value, value_without_accents
+            UnicodeFormEnum.NFKD.value,
+            value_without_accents,
         )
         value = value.encode("ascii", "ignore").decode("ascii")
 

flask_inputfilter/filters/to_base64_image_filter.py

@@ -0,0 +1,101 @@
+from __future__ import annotations
+
+import base64
+import io
+from typing import Any, Optional
+
+from PIL import Image
+
+from flask_inputfilter.enums import ImageFormatEnum
+from flask_inputfilter.models import BaseFilter
+
+
+class ToBase64ImageFilter(BaseFilter):
+    """
+    Converts an image to a base64 encoded string. Supports various input
+    formats including file paths, bytes, or PIL Image objects.
+
+    **Parameters:**
+
+    - **format** (*ImageFormatEnum*, default: ``ImageFormatEnum.PNG``):
+      The output image format for the base64 encoding.
+    - **quality** (*int*, default: ``85``): The image quality (1-100) for
+      lossy formats like JPEG. Higher values mean better quality.
+
+    **Expected Behavior:**
+
+    Converts the input image to a base64 encoded string:
+    - If input is a PIL Image object, converts it directly
+    - If input is a string, tries to open it as a file path
+    - If input is bytes, tries to open as image data
+    - If input is already a base64 string, validates and returns it
+    - Returns the original value if conversion fails
+
+    **Example Usage:**
+
+    .. code-block:: python
+
+        class ImageFilter(InputFilter):
+            def __init__(self):
+                super().__init__()
+
+                self.add('image', filters=[
+                    ToBase64ImageFilter(format=ImageFormatEnum.JPEG)
+                ])
+    """
+
+    __slots__ = ("format", "quality")
+
+    def __init__(
+        self,
+        format: Optional[ImageFormatEnum] = None,
+        quality: int = 85,
+    ) -> None:
+        self.format = format if format else ImageFormatEnum.PNG
+        self.quality = quality
+
+    def apply(self, value: Any) -> Any:
+        if isinstance(value, Image.Image):
+            return self._image_to_base64(value)
+
+        # Try to open as file path
+        if isinstance(value, str):
+            try:
+                with Image.open(value) as img:
+                    return self._image_to_base64(img)
+            except OSError:
+                pass
+
+            # Try to decode as base64
+            try:
+                Image.open(io.BytesIO(base64.b64decode(value))).verify()
+                return value
+            except Exception:
+                pass
+
+        # Try to open as raw bytes
+        if isinstance(value, bytes):
+            try:
+                img = Image.open(io.BytesIO(value))
+                return self._image_to_base64(img)
+            except OSError:
+                pass
+
+        return value
+
+    def _image_to_base64(self, image: Image.Image) -> str:
+        """Convert a PIL Image to base64 encoded string."""
+        if image.mode in ("RGBA", "P"):
+            image = image.convert("RGB")
+
+        buffered = io.BytesIO()
+
+        save_options = {"format": self.format.value}
+
+        if self.format in (ImageFormatEnum.JPEG, ImageFormatEnum.WEBP):
+            save_options["quality"] = self.quality
+            save_options["optimize"] = True
+
+        image.save(buffered, **save_options)
+
+        return base64.b64encode(buffered.getvalue()).decode("ascii")

flask_inputfilter/filters/to_image_filter.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+import base64
+import io
+from typing import Any
+
+from PIL import Image
+
+from flask_inputfilter.models import BaseFilter
+
+
+class ToImageFilter(BaseFilter):
+    """
+    Converts various input formats to a PIL Image object. Supports file paths,
+    base64 encoded strings, and bytes.
+
+    **Expected Behavior:**
+
+    Converts the input to a PIL Image object:
+    - If input is already a PIL Image object, returns it as-is
+    - If input is a string, tries to open it as a file path or decode as base64
+    - If input is bytes, tries to open as image data
+    - Returns the original value if conversion fails
+
+    **Example Usage:**
+
+    .. code-block:: python
+
+        class ImageFilter(InputFilter):
+            def __init__(self):
+                super().__init__()
+
+                self.add('image', filters=[
+                    ToImageFilter()
+                ])
+    """
+
+    __slots__ = ()
+
+    def apply(self, value: Any) -> Any:
+        if isinstance(value, Image.Image):
+            return value
+
+        if isinstance(value, str):
+            # Try to open as file path
+            try:
+                return Image.open(value)
+            except OSError:
+                pass
+
+            # Try to decode as base64
+            try:
+                return Image.open(io.BytesIO(base64.b64decode(value)))
+            except Exception:
+                pass
+
+        # Try to open as raw bytes
+        if isinstance(value, bytes):
+            try:
+                return Image.open(io.BytesIO(value))
+            except OSError:
+                pass
+
+        return value

flask_inputfilter/filters/to_normalized_unicode_filter.py

@@ -59,8 +59,14 @@ def apply(self, value: Any) -> Union[str, Any]:
 
         value_without_accents = "".join(
             char
-            for char in unicodedata.normalize(UnicodeFormEnum.NFD.value, value)
+            for char in unicodedata.normalize(
+                UnicodeFormEnum.NFD.value,
+                value,
+            )
             if unicodedata.category(char) != "Mn"
         )
 
-        return unicodedata.normalize(self.form.value, value_without_accents)
+        return unicodedata.normalize(
+            self.form.value,
+            value_without_accents,
+        )

flask_inputfilter/input_filter.py

@@ -235,7 +235,9 @@ def set_data(self, data: dict[str, Any]) -> None:
                 data to be filtered and stored.
         """
         self.data = DataMixin.filter_data(
-            data, self.fields, self.global_filters
+            data,
+            self.fields,
+            self.global_filters,
         )
 
     def get_value(self, name: str) -> Any: