Merge pull request #42 from LeanderCS/31

31 | Use cython to increase performance

Author: LeanderCS

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

@@ -26,4 +26,4 @@ jobs:
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
-        run: twine upload dist/*
+        run: twine upload dist/*.tar.gz

.gitignore

@@ -5,6 +5,8 @@ __pycache__/
 
 # C extensions
 *.so
+*.c
+*.cpp
 
 # Distribution / packaging
 .Python

Dockerfile

@@ -2,7 +2,7 @@ FROM python:3.7-slim
 
 WORKDIR /app
 
-RUN apt-get update && apt-get install -y gcc python3-dev git
+RUN apt-get update && apt-get install -y gcc g++ python3-dev git
 
 COPY pyproject.toml /app
 

MANIFEST.in

@@ -1,4 +1,5 @@
-include docs/index.rst
+include docs/source/index.rst
 include LICENSE
-include docs/changelog.rst
+include docs/source/changelog.rst
+recursive-include flask_inputfilter *.py *.pyx *.c *.cpp
 prune tests

README.rst

@@ -67,7 +67,6 @@ Definition
 
     class UpdateZipcodeInputFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'id',

docs/source/changelog.rst

@@ -3,6 +3,16 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+[0.4.0a1] - 2025-04-17
+----------------------
+
+Changed
+^^^^^^^
+- InputFilter now uses cython for performance improvements.
+- Made super().__init__() call optional. You will only need to call it,
+  if you are wanting to limit the allowed methods.
+
+
 [0.3.1] - 2025-04-14
 --------------------
 

docs/source/conf.py

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

docs/source/guides/frontend_validation.rst

@@ -24,7 +24,6 @@ Example implementation
 
     class UpdateZipcodeInputFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'id',

docs/source/index.rst

@@ -63,7 +63,6 @@ Definition
 
     class UpdateZipcodeInputFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'id',

docs/source/options/condition.rst

@@ -20,7 +20,6 @@ Example
 
     class TestInputFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'username',
@@ -89,7 +88,6 @@ Validates that the length of the array from ``first_array_field`` is equal to th
 
     class ArrayLengthFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'list1',
@@ -129,7 +127,6 @@ Validates that the array in ``longer_field`` has more elements than the array in
 
     class ArrayComparisonFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'list1',
@@ -171,7 +168,6 @@ Executes the provided callable with the input data. The condition passes if the
 
     class CustomFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'age',
@@ -205,7 +201,6 @@ Validates that the values of ``first_field`` and ``second_field`` are equal. Fai
 
     class EqualFieldsFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'password'
@@ -242,7 +237,6 @@ Counts the number of specified fields present in the data and validates that the
 
     class ExactFieldsFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'field1'
@@ -284,7 +278,6 @@ Validates that exactly ``n`` fields among the specified ones have the given valu
 
     class MatchFieldsFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'field1'
@@ -320,7 +313,6 @@ Validates that only one field among the specified fields exists in the input dat
 
     class OneFieldFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'email'
@@ -357,7 +349,6 @@ Validates that exactly one of the specified fields has the given value.
 
     class OneMatchFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'option1'
@@ -395,7 +386,6 @@ Validates that the integer value from ``bigger_field`` is greater than the value
 
     class NumberComparisonFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'field_should_be_bigger',
@@ -434,7 +424,6 @@ Validates that the count of the specified fields present is greater than or equa
 
     class MinimumFieldsFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'field1'
@@ -476,7 +465,6 @@ Validates that the count of fields matching the given value is greater than or e
 
     class MinimumMatchFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'field1'
@@ -513,7 +501,6 @@ Validates that the values of ``first_field`` and ``second_field`` are not equal.
 
     class DifferenceFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'field1'
@@ -549,7 +536,6 @@ Validates that at least one field from the specified list is present. Fails if n
 
     class OneFieldRequiredFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'email'
@@ -586,7 +572,6 @@ Validates that at least one field from the specified list has the given value.
 
     class OneMatchRequiredFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'option1'
@@ -624,7 +609,6 @@ If the value of ``condition_field`` matches the specified value (or is in the sp
 
     class ConditionalRequiredFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'status'
@@ -667,7 +651,6 @@ Validates that the string in ``longer_field`` has a greater length than the stri
 
     class StringLengthFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'description'
@@ -704,7 +687,6 @@ Validates that the date in ``smaller_date_field`` is earlier than the date in ``
 
     class DateOrderFilter(InputFilter):
         def __init__(self):
-            super().__init__()
 
             self.add(
                 'start_date'