Merge pull request #46 from LeanderCS/45

45 | Implement first parts in cython

Author: LeanderCS

MANIFEST.in

@@ -2,5 +2,6 @@ include docs/source/index.rst
 include LICENSE
 include docs/source/changelog.rst
 recursive-include flask_inputfilter *.py *.pyx *.c *.cpp
+recursive-include flask_inputfilter/include *.h
 prune tests
 recursive-prune __pycache__

docs/source/changelog.rst

@@ -3,6 +3,16 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+[0.4.1] - 2025-04-24
+--------------------
+
+Changed
+^^^^^^^
+- Introduced first c++ vector in ``InputFilter`` to improve performance.
+- Updated required ``cython`` version to 3.0 or higher for python 3.7 - 3.11.
+- Moved static methods outside of pure InputFilter class.
+
+
 [0.4.0] - 2025-04-20
 --------------------
 

docs/source/guides/create_own_components.rst

@@ -31,7 +31,7 @@ Example implementation
 
 .. code-block:: python
 
-    from typing import Any, Dict
+    from typing import Any
 
     from flask_inputfilter.Condition import BaseCondition
 
@@ -45,7 +45,7 @@ Example implementation
             self.first_field = first_field
             self.second_field = second_field
 
-        def check(self, data: Dict[str, Any]) -> bool:
+        def check(self, data: dict[str, Any]) -> bool:
             return data.get(self.first_field) == data.get(self.second_field)
 
 
@@ -69,7 +69,7 @@ Example implementation
 .. code-block:: python
 
     from datetime import date, datetime
-    from typing import Any, Union
+    from typing import Any
 
     from flask_inputfilter.Filter import BaseFilter
 
@@ -80,7 +80,7 @@ Example implementation
         Supports ISO 8601 formatted strings.
         """
 
-        def apply(self, value: Any) -> Union[datetime, Any]:
+        def apply(self, value: Any) -> datetime|Any:
             if isinstance(value, datetime):
                 return value
 
@@ -94,8 +94,7 @@ Example implementation
                 except ValueError:
                     return value
 
-            else:
-                return value
+            return value
 
 
 Validator
@@ -116,7 +115,7 @@ Example implementation
 
 .. code-block:: python
 
-    from typing import Any, List, Optional
+    from typing import Any, Optional
 
     from flask_inputfilter.Exception import ValidationError
     from flask_inputfilter.Validator import BaseValidator
@@ -129,7 +128,7 @@ Example implementation
 
         def __init__(
             self,
-            haystack: List[Any],
+            haystack: list[Any],
             strict: bool = False,
             error_message: Optional[str] = None,
         ) -> None:

docs/source/options/copy.rst

@@ -44,7 +44,7 @@ Basic Copy Integration
     def test_route():
         validated_data = g.validated_data
 
-        # Cotains the same value as username but escaped eg. "very-important-user"
+        # Contains the same value as username but escaped eg. "very-important-user"
         print(validated_data["escapedUsername"])
 
 

env_configs/cython.Dockerfile

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

env_configs/env.Dockerfile

@@ -2,35 +2,37 @@ FROM debian:buster-slim
 
 WORKDIR /app
 
-RUN apt-get update && apt-get install -y \
-    build-essential \
-    curl \
-    g++ \
-    git \
-    libbz2-dev \
-    libffi-dev \
-    libjpeg-dev \
-    liblzma-dev \
-    libncurses5-dev \
-    libncursesw5-dev \
-    libreadline-dev \
-    libsqlite3-dev \
-    libssl-dev \
-    llvm \
-    make \
-    python3-dev \
-    tk-dev \
-    wget \
-    xz-utils \
-    zlib1g-dev
+RUN apt-get update  \
+    && apt-get install -y \
+        build-essential \
+        curl \
+        g++ \
+        git \
+        libbz2-dev \
+        libffi-dev \
+        libjpeg-dev \
+        liblzma-dev \
+        libncurses5-dev \
+        libncursesw5-dev \
+        libreadline-dev \
+        libsqlite3-dev \
+        libssl-dev \
+        llvm \
+        make \
+        python3-dev \
+        tk-dev \
+        wget \
+        xz-utils \
+        zlib1g-dev \
+    && apt-get clean
 
 RUN curl https://pyenv.run | bash
 
 ENV PATH="/root/.pyenv/bin:/root/.pyenv/shims:/root/.pyenv/versions/3.7.12/bin:$PATH"
-RUN echo 'export PATH="/root/.pyenv/bin:$PATH"' >> ~/.bashrc
-RUN echo 'eval "$(pyenv init --path)"' >> ~/.bashrc
-RUN echo 'eval "$(pyenv init -)"' >> ~/.bashrc
-RUN echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bashrc
+RUN echo 'export PATH="/root/.pyenv/bin:$PATH"' >> ~/.bashrc \
+    && echo 'eval "$(pyenv init --path)"' >> ~/.bashrc \
+    && echo 'eval "$(pyenv init -)"' >> ~/.bashrc \
+    && echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bashrc
 
 RUN /root/.pyenv/bin/pyenv install 3.7.12
 RUN /root/.pyenv/bin/pyenv install 3.8.12

env_configs/pure.Dockerfile

@@ -2,7 +2,9 @@ FROM python:3.7-slim
 
 WORKDIR /app
 
-RUN apt-get update && apt-get install -y git
+RUN apt-get update  \
+    && apt-get install -y git \
+    && apt-get clean
 
 COPY pyproject.toml /app
 

env_configs/requirements-py310.txt

@@ -1,4 +1,4 @@
-cython==0.29.24
+cython==3.0
 flask==2.1
 pillow==8.0.0
 pytest

env_configs/requirements-py311.txt

@@ -1,4 +1,4 @@
-cython==0.29.32
+cython==3.0
 flask==2.1
 pillow==8.0.0
 pytest

env_configs/requirements-py37.txt

@@ -1,4 +1,4 @@
-cython==0.29
+cython==3.0
 flask==2.1
 pillow==8.0.0
 pytest