47 | Migrate components in new subfolder and add whl build for aarch64

Author: LeanderCS

.github/workflows/publish-to-pypi.yaml

@@ -30,7 +30,7 @@ jobs:
         env:
           CIBW_BUILD: "cp37-* cp38-* cp39-* cp310-* cp311-* cp312-* cp313-* cp314-*"
           CIBW_IGNORE: "*linux_x86_64*"
-          CIBW_BEFORE_BUILD: pip install cffi
+          CIBW_PRERELEASE_PYTHONS: "1"
         run: python -m cibuildwheel --output-dir dist
 
       - name: Upload wheels
@@ -39,6 +39,35 @@ jobs:
           name: pkg-${{ matrix.os }}-${{ strategy.job-index }}
           path: ./dist/*.whl
 
+  build-whl-linux-aarch64:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: docker/setup-qemu-action@v3
+        with:
+          platforms: all
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install build tools
+        run: python -m pip install cibuildwheel
+
+      - name: Build wheel (linux-aarch64)
+        env:
+          CIBW_BUILD: "cp37-manylinux_aarch64 cp38-manylinux_aarch64 cp39-manylinux_aarch64 cp310-manylinux_aarch64 cp311-manylinux_aarch64 cp312-manylinux_aarch64 cp313-manylinux_aarch64 cp314-manylinux_aarch64"
+          CIBW_ARCHS: "aarch64"
+          CIBW_PRERELEASE_PYTHONS: "1"
+        run: python -m cibuildwheel --output-dir dist
+
+      - name: Upload wheels (linux-aarch64)
+        uses: actions/upload-artifact@v4
+        with:
+          name: pkg-linux-aarch64
+          path: ./dist/*.whl
+
   build-sdist:
     runs-on: ubuntu-latest
 
@@ -62,7 +91,7 @@ jobs:
           path: ./dist/*.tar.gz
 
   publish:
-    needs: [build-whl, build-sdist]
+    needs: [build-whl, build-whl-linux-aarch64, build-sdist]
     runs-on: ubuntu-latest
 
     environment:

.github/workflows/test-lib-building.yaml

@@ -30,7 +30,6 @@ jobs:
 
       - name: Verify library usage - Part I - installation
         run: |
-          python -c "import flask_inputfilter.InputFilter"
           python -c "from flask_inputfilter import InputFilter"
 
       - name: Verify library usage - Part II - functional test
@@ -40,7 +39,7 @@ jobs:
         run: |
           output=$(python -c "from flask_inputfilter import InputFilter; print(InputFilter)")
 
-          if [ "$output" = "<class 'flask_inputfilter.InputFilter.InputFilter'>" ]; then
+          if [ "$output" = "<class 'flask_inputfilter.input_filter.InputFilter'>" ]; then
             echo "Test passed: Correct class returned"
           else
             echo "Test failed: Unexpected output - $output"
@@ -74,7 +73,6 @@ jobs:
 
       - name: Verify library usage - Part I - installation
         run: |
-          python -c "import flask_inputfilter.InputFilter"
           python -c "from flask_inputfilter import InputFilter"
 
       - name: Verify library usage - Part II - functional test
@@ -84,7 +82,7 @@ jobs:
         run: |
           output=$(python -c "from flask_inputfilter import InputFilter; print(InputFilter)")
 
-          if [ "$output" = "<class 'flask_inputfilter._InputFilter.InputFilter'>" ]; then
+          if [ "$output" = "<class 'flask_inputfilter._input_filter.InputFilter'>" ]; then
             echo "Test passed: Correct class returned"
           else
             echo "Test failed: Unexpected output - $output"

README.rst

@@ -60,10 +60,10 @@ Definition
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import ExactlyOneOfCondition
-    from flask_inputfilter.Enum import RegexEnum
-    from flask_inputfilter.Filter import StringTrimFilter, ToIntegerFilter, ToNullFilter
-    from flask_inputfilter.Validator import IsIntegerValidator, IsStringValidator, RegexValidator
+    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):

docs/source/changelog.rst

@@ -3,10 +3,37 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+[0.5.0] - 2025-04-26
+--------------------
+
+Changed
+^^^^^^^
+- Moved components to subfolders to improve readability and maintainability.
+  The following components have been moved:
+  - ``Condition`` => ``conditions``
+  - ``Enum`` => ``enums``
+  - ``Exception`` => ``exceptions``
+  - ``Filter`` => ``filters``
+  - ``Mixin`` => ``mixins``
+  - ``Model`` => ``models``
+  - ``Validator`` => ``validators``
+
+  But the old import paths are still available for backward compatibility, but
+  because the old path will be abandoned in the future, it is recommended
+  to use the new paths.
+
+- Renamed files into snake_case to follow the PEP8 standard.
+  This requires a migration if you are importing the files directly.
+  e.g. ``from flask_inputfilter.filters import Base64ImageResizeFilter`` to
+  ``from flask_inputfilter.filters.base64_image_resize_filter import Base64ImageResizeFilter``.
+
+
+
 [0.4.3a1] - 2025-04-26
 ----------------------
 
 Added
+^^^^^
 - whl generation for linux too.
 
 

docs/source/conf.py

@@ -1,7 +1,7 @@
 project = "flask-inputfilter"
 copyright = "2025, Leander Cain Slotosch"
 author = "Leander Cain Slotosch"
-release = "0.4.3a1"
+release = "0.5.0"
 
 extensions = ["sphinx_rtd_theme", "sphinx_design"]
 

docs/source/guides/create_own_components.rst

@@ -33,7 +33,7 @@ Example implementation
 
     from typing import Any
 
-    from flask_inputfilter.Condition import BaseCondition
+    from flask_inputfilter.conditions import BaseCondition
 
 
     class EqualCondition(BaseCondition):
@@ -71,7 +71,7 @@ Example implementation
     from datetime import date, datetime
     from typing import Any
 
-    from flask_inputfilter.Filter import BaseFilter
+    from flask_inputfilter.filters import BaseFilter
 
 
     class ToDateTimeFilter(BaseFilter):
@@ -117,8 +117,8 @@ Example implementation
 
     from typing import Any, Optional
 
-    from flask_inputfilter.Exception import ValidationError
-    from flask_inputfilter.Validator import BaseValidator
+    from flask_inputfilter.exceptions import ValidationError
+    from flask_inputfilter.validators import BaseValidator
 
 
     class InArrayValidator(BaseValidator):

docs/source/guides/frontend_validation.rst

@@ -15,10 +15,10 @@ Example implementation
 
     from flask import Response, Flask
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import ExactlyOneOfCondition
-    from flask_inputfilter.Enum import RegexEnum
-    from flask_inputfilter.Filter import StringTrimFilter, ToIntegerFilter, ToNullFilter
-    from flask_inputfilter.Validator import IsIntegerValidator, IsStringValidator, RegexValidator
+    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
 
     app = Flask(__name__)
 

docs/source/index.rst

@@ -56,10 +56,10 @@ Definition
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import ExactlyOneOfCondition
-    from flask_inputfilter.Enum import RegexEnum
-    from flask_inputfilter.Filter import StringTrimFilter, ToIntegerFilter, ToNullFilter
-    from flask_inputfilter.Validator import IsIntegerValidator, IsStringValidator, RegexValidator
+    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):

docs/source/options/condition.rst

@@ -14,9 +14,9 @@ Example
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import OneOfCondition
-    from flask_inputfilter.Filter import StringTrimFilter
-    from flask_inputfilter.Validator import IsStringValidator
+    from flask_inputfilter.conditions import OneOfCondition
+    from flask_inputfilter.filters import StringTrimFilter
+    from flask_inputfilter.validators import IsStringValidator
 
     class TestInputFilter(InputFilter):
         def __init__(self):
@@ -84,8 +84,8 @@ Validates that the length of the array from ``first_array_field`` is equal to th
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import ArrayLengthEqualCondition
-    from flask_inputfilter.Validator import IsArrayValidator
+    from flask_inputfilter.conditions import ArrayLengthEqualCondition
+    from flask_inputfilter.validators import IsArrayValidator
 
     class ArrayLengthFilter(InputFilter):
         def __init__(self):
@@ -124,8 +124,8 @@ Validates that the array in ``longer_field`` has more elements than the array in
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import ArrayLongerThanCondition
-    from flask_inputfilter.Validator import IsArrayValidator
+    from flask_inputfilter.conditions import ArrayLongerThanCondition
+    from flask_inputfilter.validators import IsArrayValidator
 
     class ArrayComparisonFilter(InputFilter):
         def __init__(self):
@@ -163,8 +163,8 @@ Executes the provided callable with the input data. The condition passes if the
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import CustomCondition
-    from flask_inputfilter.Validator import IsIntegerValidator
+    from flask_inputfilter.conditions import CustomCondition
+    from flask_inputfilter.validators import IsIntegerValidator
 
     def my_custom_condition(data):
         return data.get('age', 0) >= 18
@@ -201,7 +201,7 @@ Validates that the values of ``first_field`` and ``second_field`` are equal. Fai
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import EqualCondition
+    from flask_inputfilter.conditions import EqualCondition
 
     class EqualFieldsFilter(InputFilter):
         def __init__(self):
@@ -238,7 +238,7 @@ Counts the number of specified fields present in the data and validates that the
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import ExactlyNOfCondition
+    from flask_inputfilter.conditions import ExactlyNOfCondition
 
     class ExactFieldsFilter(InputFilter):
         def __init__(self):
@@ -280,7 +280,7 @@ Validates that exactly ``n`` fields among the specified ones have the given valu
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import ExactlyNOfMatchesCondition
+    from flask_inputfilter.conditions import ExactlyNOfMatchesCondition
 
     class MatchFieldsFilter(InputFilter):
         def __init__(self):
@@ -316,7 +316,7 @@ Validates that only one field among the specified fields exists in the input dat
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import ExactlyOneOfCondition
+    from flask_inputfilter.conditions import ExactlyOneOfCondition
 
     class OneFieldFilter(InputFilter):
         def __init__(self):
@@ -353,7 +353,7 @@ Validates that exactly one of the specified fields has the given value.
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import ExactlyOneOfMatchesCondition
+    from flask_inputfilter.conditions import ExactlyOneOfMatchesCondition
 
     class OneMatchFilter(InputFilter):
         def __init__(self):
@@ -390,8 +390,8 @@ Validates that the integer value from ``bigger_field`` is greater than the value
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import IntegerBiggerThanCondition
-    from flask_inputfilter.Validator import IsIntegerValidator
+    from flask_inputfilter.conditions import IntegerBiggerThanCondition
+    from flask_inputfilter.validators import IsIntegerValidator
 
     class NumberComparisonFilter(InputFilter):
         def __init__(self):
@@ -430,7 +430,7 @@ Validates that the count of the specified fields present is greater than or equa
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import NOfCondition
+    from flask_inputfilter.conditions import NOfCondition
 
     class MinimumFieldsFilter(InputFilter):
         def __init__(self):
@@ -472,7 +472,7 @@ Validates that the count of fields matching the given value is greater than or e
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import NOfMatchesCondition
+    from flask_inputfilter.conditions import NOfMatchesCondition
 
     class MinimumMatchFilter(InputFilter):
         def __init__(self):
@@ -509,7 +509,7 @@ Validates that the values of ``first_field`` and ``second_field`` are not equal.
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import NotEqualCondition
+    from flask_inputfilter.conditions import NotEqualCondition
 
     class DifferenceFilter(InputFilter):
         def __init__(self):
@@ -545,7 +545,7 @@ Validates that at least one field from the specified list is present. Fails if n
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import OneOfCondition
+    from flask_inputfilter.conditions import OneOfCondition
 
     class OneFieldRequiredFilter(InputFilter):
         def __init__(self):
@@ -582,7 +582,7 @@ Validates that at least one field from the specified list has the given value.
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import OneOfMatchesCondition
+    from flask_inputfilter.conditions import OneOfMatchesCondition
 
     class OneMatchRequiredFilter(InputFilter):
         def __init__(self):
@@ -620,7 +620,7 @@ If the value of ``condition_field`` matches the specified value (or is in the sp
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import RequiredIfCondition
+    from flask_inputfilter.conditions import RequiredIfCondition
 
     class ConditionalRequiredFilter(InputFilter):
         def __init__(self):
@@ -663,7 +663,7 @@ Validates that the string in ``longer_field`` has a greater length than the stri
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import StringLongerThanCondition
+    from flask_inputfilter.conditions import StringLongerThanCondition
 
     class StringLengthFilter(InputFilter):
         def __init__(self):
@@ -700,7 +700,7 @@ Validates that the date in ``smaller_date_field`` is earlier than the date in ``
 .. code-block:: python
 
     from flask_inputfilter import InputFilter
-    from flask_inputfilter.Condition import TemporalOrderCondition
+    from flask_inputfilter.conditions import TemporalOrderCondition
 
     class DateOrderFilter(InputFilter):
         def __init__(self):