31 | Update implementation to include .so file

LeanderCS · LeanderCS · commit 9a6ffb2f637b · 2025-03-27T16:11:18.000+01:00
diff --git a/.github/workflows/publish-to-pypi.yaml b/.github/workflows/publish-to-pypi.yaml
@@ -5,8 +5,11 @@ on:
     types: [published]
 
 jobs:
-  publish:
-    runs-on: ubuntu-latest
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:
       - name: Checkout code
@@ -18,12 +21,39 @@ jobs:
           python-version: 3.9
 
       - name: Install build tools
-        run: pip install build twine wheel cython
+        run: pip install build twine wheel cibuildwheel
+
+      - name: Build wheel with cibuildwheel
+        env:
+          CIBW_BUILD: cp37-*,cp38-*,cp39-*,cp310-*,cp311-*,cp312-*,cp313-*,cp314-*
+        run: cibuildwheel --output-dir wheelhouse
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels-${{ matrix.os }}
+          path: wheelhouse/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download wheels
+        uses: actions/download-artifact@v3
+        with:
+          name: wheels-ubuntu-latest
+      - name: Download wheels
+        uses: actions/download-artifact@v3
+        with:
+          name: wheels-windows-latest
+      - name: Download wheels
+        uses: actions/download-artifact@v3
+        with:
+          name: wheels-macos-latest
 
-      - name: Compile and Build package
-        run: |
-          python setup.py build_ext --inplace
-          python setup.py sdist bdist_wheel
+      - name: Combine wheels
+        run: mkdir dist && mv wheelhouse/* dist/
 
       - name: Publish to PyPI
         env:
diff --git a/.github/workflows/test-lib-building.yaml b/.github/workflows/test-lib-building.yaml
@@ -1,4 +1,4 @@
-name: Build and Test Library
+name: Run Tests on all environments
 
 on:
   push:
@@ -8,7 +8,10 @@ on:
 
 jobs:
   build-and-test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:
       - name: Checkout code
@@ -20,22 +23,23 @@ jobs:
           python-version: 3.9
 
       - name: Install build tools and test dependencies
-        run: pip install build pytest cython
+        run: pip install build pytest cython cibuildwheel
 
-      - name: Compile Cython code
-        run: python setup.py build_ext --inplace
-
-      - name: Build the library
-        run: python -m build
-        id: build
+      - name: Build wheel with cibuildwheel
+        env:
+          CIBW_BUILD: cp39-*
+        run: cibuildwheel --output-dir wheelhouse
 
       - name: Install built library
-        run: pip install dist/*.whl
+        run: pip install flask_inputfilter --find-links=wheelhouse/ --force-reinstall
 
       - name: Verify library usage - Part I
         run: |
-          echo "import flask_inputfilter" > test_script.py
+          rm -rf flask_inputfilter
+          echo "import flask_inputfilter.InputFilter" > test_script.py
           python test_script.py
 
       - name: Verify library usage - Part II
-        run: PYTHONPATH="" pytest test/
+        run: |
+          rm -rf flask_inputfilter
+          pytest test/
diff --git a/.github/workflows/test_env.yaml b/.github/workflows/test_env.yaml
@@ -1,4 +1,4 @@
-name: Run Tests on all environments
+name: Run Tests on all python versions
 
 on: [push]
 
diff --git a/Dockerfile b/Dockerfile
@@ -14,3 +14,5 @@ COPY . /app
 
 COPY scripts /usr/local/bin
 RUN find /usr/local/bin -type f -name "*" -exec chmod +x {} \;
+
+ENV flask_inputfilter_dev=true
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -4,3 +4,6 @@ include docs/changelog.rst
 include flask_inputfilter/*.py
 include flask_inputfilter/*.pyx
 include flask_inputfilter/*.pxd
+include flask_inputfilter/*.so
+
+exclude test/*
diff --git a/Makefile b/Makefile
@@ -1,20 +1,12 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build
 
-# Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 .PHONY: help Makefile
 
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/env_configs/Dockerfile b/env_configs/Dockerfile
@@ -49,3 +49,5 @@ COPY ../requirements.txt /app
 RUN pip install --no-cache-dir -r requirements.txt && pip install tox
 
 COPY .. /app
+
+ENV flask_inputfilter_dev=true
diff --git a/flask_inputfilter/InputFilter.pyx b/flask_inputfilter/InputFilter.pyx
@@ -13,13 +13,21 @@ from flask_inputfilter.Validator import BaseValidator
 API_PLACEHOLDER_PATTERN = re.compile(r"{{(.*?)}}")
 
 
-class InputFilter:
+cdef class InputFilter:
     """
     Base class for input filters.
     """
+    cdef readonly list __methods
+    cdef readonly dict __fields
+    cdef readonly list __conditions
+    cdef readonly list __global_filters
+    cdef readonly list __global_validators
+    cdef public dict __data
+    cdef readonly dict __validated_data
+    cdef readonly str __error_message
 
     def __init__(self, methods: Optional[List[str]] = None) -> None:
-        self.__methods = methods or ["GET", "POST", "PATCH", "PUT", "DELETE"]
+        self.__methods: List[str] = methods or ["GET", "POST", "PATCH", "PUT", "DELETE"]
         self.__fields: Dict[str, FieldModel] = {}
         self.__conditions: List[BaseCondition] = []
         self.__global_filters: List[BaseFilter] = []
diff --git a/flask_inputfilter/Validator/IsIntegerValidator.py b/flask_inputfilter/Validator/IsIntegerValidator.py
@@ -15,5 +15,5 @@ def __init__(self, error_message: Optional[str] = None) -> None:
     def validate(self, value: Any) -> None:
         if not isinstance(value, int):
             raise ValidationError(
-                self.error_message, f"Value '{value}' is not an integer."
+                self.error_message or f"Value '{value}' is not an integer."
             )
diff --git a/flask_inputfilter/__init__.py b/flask_inputfilter/__init__.py
@@ -1,7 +1,8 @@
-try:
-    from .InputFilter import InputFilter
-except ImportError:
+import os
+
+if os.getenv("flask_inputfilter_dev"):
     import pyximport
 
     pyximport.install()
-    from .InputFilter import InputFilter
+
+from .InputFilter import InputFilter
diff --git a/make.bat b/make.bat
@@ -2,7 +2,7 @@
 
 pushd %~dp0
 
-REM Command file for Sphinx documentation
+REM
 
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
diff --git a/setup.py b/setup.py
@@ -1,13 +1,6 @@
 from Cython.Build import cythonize
 from setuptools import Extension, find_packages, setup
 
-ext_modules = cythonize(
-    [
-        Extension(name="", sources=["flask_inputfilter/InputFilter.pyx"]),
-    ],
-    compiler_directives={"language_level": "3"},
-)
-
 setup(
     name="flask_inputfilter",
     version="0.2.0",
@@ -23,11 +16,18 @@
     packages=find_packages(
         include=["flask_inputfilter", "flask_inputfilter.*"]
     ),
-    ext_modules=ext_modules,
+    ext_modules=cythonize(
+        [
+            Extension(
+                name="flask_inputfilter.InputFilter",
+                sources=["flask_inputfilter/InputFilter.pyx"],
+            ),
+        ]
+    ),
     package_data={"flask_inputfilter": ["*.pyx", "*.py"]},
     include_package_data=True,
     install_requires=[
-        "Flask>=2.1",
+        "flask>=2.1",
         "pillow>=8.0.0",
         "requests>=2.22.0",
         "typing_extensions>=3.6.2",
diff --git a/test/test_input_filter.py b/test/test_input_filter.py
@@ -27,7 +27,6 @@ def setUp(self) -> None:
         """
         Set up a basic InputFilter instance for testing.
         """
-
         self.inputFilter = InputFilter()
 
     def test_validate_decorator(self) -> None:
@@ -104,7 +103,7 @@ def test_route(username):
             self.assertEqual(response.status_code, 200)
             self.assertEqual(response.json, {"username": "test_user"})
 
-    def test_unsupported_method(self) -> None:
+    def test_custom_method(self) -> None:
         """
         Test that a method not supported by the InputFilter instance raises
         a TypeError.
@@ -116,19 +115,24 @@ def __init__(self):
 
         app = Flask(__name__)
 
-        @app.route("/test-unsupported", methods=["POST"])
+        @app.route("/test-custom")
         @MyInputFilter.validate()
-        def test_unsupported_route():
+        def test_custom_route():
             validated_data = g.validated_data
             return jsonify(validated_data)
 
         with app.test_client() as client:
-            response = client.post("/test-unsupported")
+            response = client.post("/test-custom")
             self.assertEqual(response.status_code, 405)
 
-    @patch.object(InputFilter, "validateData")
-    def test_validation_error_response(self, mock_validateData):
-        mock_validateData.side_effect = ValidationError("Invalid data")
+            response = client.get("/test-custom")
+            self.assertEqual(response.status_code, 200)
+
+    def test_validation_error_response(self):
+        """
+        Tests the behavior of the application when a validation error occurs
+        due to invalid input data.
+        """
 
         class MyInputFilter(InputFilter):
             def __init__(self):
@@ -137,7 +141,9 @@ def __init__(self):
                     name="age",
                     required=False,
                     default=18,
-                    validators=[IsIntegerValidator()],
+                    validators=[
+                        IsIntegerValidator(error_message="Invalid data")
+                    ],
                 )
 
         app = Flask(__name__)
@@ -153,49 +159,11 @@ def test_route():
         self.assertEqual(response.status_code, 400)
         self.assertEqual(response.data.decode(), "Invalid data")
 
-    @patch.object(InputFilter, "validateData")
-    def test_custom_supported_methods(self, mock_validateData):
-        mock_validateData.return_value = {"username": "test_user", "age": 25}
-
-        class MyInputFilter(InputFilter):
-            def __init__(self):
-                super().__init__(methods=["GET"])
-
-                self.add(
-                    name="username",
-                    required=True,
-                )
-                self.add(
-                    name="age",
-                    required=False,
-                    default=18,
-                    validators=[IsIntegerValidator()],
-                )
-
-        app = Flask(__name__)
-
-        @app.route("/test", methods=["GET", "POST"])
-        @MyInputFilter.validate()
-        def test_route():
-            validated_data = g.validated_data
-            return jsonify(validated_data)
-
-        with app.test_client() as client:
-            response = client.get(
-                "/test", query_string={"username": "test_user"}
-            )
-            self.assertEqual(response.status_code, 200)
-            self.assertEqual(
-                response.json, {"username": "test_user", "age": 25}
-            )
-
-            response = client.post("/test", json={"username": "test_user"})
-            self.assertEqual(response.status_code, 405)
-
     def test_optional(self) -> None:
         """
         Test that optional field validation works.
         """
+
         self.inputFilter.add("name", required=True)
 
         self.inputFilter.validateData({"name": "Alice"})
@@ -207,6 +175,7 @@ def test_default(self) -> None:
         """
         Test that default field works.
         """
+
         self.inputFilter.add("available", default=True)
 
         validated_data = self.inputFilter.validateData({})
@@ -219,6 +188,7 @@ def test_fallback(self) -> None:
         """
         Test that fallback field works.
         """
+
         self.inputFilter.add("available", required=True, fallback=True)
         self.inputFilter.add(
             "color",

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Run Tests on all environments`
	`1`	`+name: Run Tests on all python versions`
`2`	`2`
`3`	`3`	`on: [push]`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,5 @@ def __init__(self, error_message: Optional[str] = None) -> None:`
`15`	`15`	`def validate(self, value: Any) -> None:`
`16`	`16`	`if not isinstance(value, int):`
`17`	`17`	`raise ValidationError(`
`18`		`- self.error_message, f"Value '{value}' is not an integer."`
	`18`	`+ self.error_message or f"Value '{value}' is not an integer."`
`19`	`19`	`)`