Update paths inside the lib itself

LeanderCS · LeanderCS · commit ff1813fd8cb1 · 2025-01-07T23:12:27.000+01:00
diff --git a/Dockerfile b/Dockerfile
@@ -5,10 +5,5 @@ COPY . /app
 
 RUN apt-get update && apt-get install -y gcc python3-dev
 
-RUN python3 -m venv venv
-RUN . venv/bin/activate
-
 RUN pip install --upgrade pip
-RUN pip install -r requirements.txt
-
-ENV PYTHONPATH=/app/src
+RUN pip install --no-cache-dir -r requirements.txt
diff --git a/README.md b/README.md
@@ -19,8 +19,9 @@ There are lots of different filters and validators available to use, and you can
 ```python
 from flask_inputfilter import InputFilter
 from flask_inputfilter.Enum import RegexEnum
-from flask_inputfilter.Filters import ToIntFilter, ToNullFilter, StringTrimFilter
-from flask_inputfilter.Validators import RegexValidator
+from flask_inputfilter.Filter import ToIntegerFilter, ToNullFilter, StringTrimFilter
+from flask_inputfilter.Validator import RegexValidator
+
 
 class UpdateZipcodeInputFilter(InputFilter):
     def __init__(self):
@@ -30,7 +31,7 @@ class UpdateZipcodeInputFilter(InputFilter):
         self.add(
             'id',
             required=True,
-            filters=[ToIntFilter(), ToNullFilter()]
+            filters=[ToIntegerFilter(), ToNullFilter()]
         )
 
         self.add(
@@ -54,6 +55,7 @@ If the data is not valid, the `validate` method will return a 400 response with
 
 ```python
 from flask import Flask, g
+from your-path import UpdateZipcodeInputFilter
 
 app = Flask(__name__)
 
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -6,7 +6,5 @@ services:
     container_name: flask-inputfilter
     volumes:
       - .:/app
-    environment:
-      - PYTHONPATH=/app/src
     stdin_open: true
     tty: true
diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 
 setup(
     name="flask_inputfilter",
-    version="0.0.1",
+    version="0.0.3",
     author="Leander Cain Slotosch",
     author_email="slotosch.leander@outlook.de",
     description="A library to filter and validate input data in"
diff --git a/src/flask_inputfilter/Filter/StringTrimFilter.py b/src/flask_inputfilter/Filter/StringTrimFilter.py
@@ -1,4 +1,4 @@
-from ..Filter.BaseFilter import BaseFilter
+from ..Filter import BaseFilter
 
 
 class StringTrimFilter(BaseFilter):
diff --git a/src/flask_inputfilter/Filter/ToBoolFilter.py b/src/flask_inputfilter/Filter/ToBoolFilter.py
@@ -1,6 +1,6 @@
 from typing import Any, Optional
 
-from ..Filter.BaseFilter import BaseFilter
+from ..Filter import BaseFilter
 
 
 class ToBoolFilter(BaseFilter):
diff --git a/src/flask_inputfilter/Filter/ToFloatFilter.py b/src/flask_inputfilter/Filter/ToFloatFilter.py
@@ -1,4 +1,4 @@
-from ..Filter.BaseFilter import BaseFilter
+from ..Filter import BaseFilter
 
 
 class ToFloatFilter(BaseFilter):
diff --git a/src/flask_inputfilter/Filter/ToIntegerFilter.py b/src/flask_inputfilter/Filter/ToIntegerFilter.py
@@ -1,9 +1,9 @@
 from typing import Any, Optional
 
-from ..Filter.BaseFilter import BaseFilter
+from ..Filter import BaseFilter
 
 
-class ToIntFilter(BaseFilter):
+class ToIntegerFilter(BaseFilter):
     """
     Filter, that transforms the value to an Integer.
     """
diff --git a/src/flask_inputfilter/Filter/ToLowerFilter.py b/src/flask_inputfilter/Filter/ToLowerFilter.py
@@ -1,4 +1,4 @@
-from ..Filter.BaseFilter import BaseFilter
+from ..Filter import BaseFilter
 
 
 class ToLowerFilter(BaseFilter):
diff --git a/src/flask_inputfilter/Filter/ToNullFilter.py b/src/flask_inputfilter/Filter/ToNullFilter.py
@@ -1,6 +1,6 @@
 from typing import Any, Optional
 
-from ..Filter.BaseFilter import BaseFilter
+from ..Filter import BaseFilter
 
 
 class ToNullFilter(BaseFilter):
diff --git a/src/flask_inputfilter/Filter/ToStringFilter.py b/src/flask_inputfilter/Filter/ToStringFilter.py
@@ -1,6 +1,6 @@
 from typing import Any, Optional
 
-from ..Filter.BaseFilter import BaseFilter
+from ..Filter import BaseFilter
 
 
 class ToStringFilter(BaseFilter):
diff --git a/src/flask_inputfilter/Filter/ToUpperFilter.py b/src/flask_inputfilter/Filter/ToUpperFilter.py
@@ -1,4 +1,4 @@
-from ..Filter.BaseFilter import BaseFilter
+from ..Filter import BaseFilter
 
 
 class ToUpperFilter(BaseFilter):
diff --git a/src/flask_inputfilter/Filter/__init__.py b/src/flask_inputfilter/Filter/__init__.py
@@ -2,7 +2,7 @@
 from .StringTrimFilter import StringTrimFilter
 from .ToBoolFilter import ToBoolFilter
 from .ToFloatFilter import ToFloatFilter
-from .ToIntFilter import ToIntFilter
+from .ToIntegerFilter import ToIntegerFilter
 from .ToLowerFilter import ToLowerFilter
 from .ToNullFilter import ToNullFilter
 from .ToStringFilter import ToStringFilter
diff --git a/src/flask_inputfilter/InputFilter.py b/src/flask_inputfilter/InputFilter.py
@@ -2,9 +2,9 @@
 
 from flask import request, Response, g
 
-from src.flask_inputfilter.Exception import ValidationError
-from src.flask_inputfilter.Filter import BaseFilter
-from src.flask_inputfilter.Validator.BaseValidator import BaseValidator
+from .Exception import ValidationError
+from .Filter import BaseFilter
+from .Validator import BaseValidator
 
 
 class InputFilter:
diff --git a/src/flask_inputfilter/Validator/ArrayElementValidator.py b/src/flask_inputfilter/Validator/ArrayElementValidator.py
@@ -1,11 +1,11 @@
 from typing import Any, TYPE_CHECKING
 
-from src.flask_inputfilter.Exception import ValidationError
+from ..Exception import ValidationError
 from ..Validator.BaseValidator import BaseValidator
 
 
 if TYPE_CHECKING:
-    from src.flask_inputfilter.InputFilter import InputFilter
+    from ..InputFilter import InputFilter
 
 
 class ArrayElementValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/BaseValidator.py b/src/flask_inputfilter/Validator/BaseValidator.py
@@ -3,7 +3,7 @@
 
 class BaseValidator:
     """
-    BaseValidator-Klasse. Every validator should inherit from it.
+    BaseValidator-Class. Every validator should inherit from it.
     """
 
     def validate(self, value: Any) -> None:
diff --git a/src/flask_inputfilter/Validator/InArrayValidator.py b/src/flask_inputfilter/Validator/InArrayValidator.py
@@ -1,7 +1,7 @@
 from typing import Any, List
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class InArrayValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/InEnumValidator.py b/src/flask_inputfilter/Validator/InEnumValidator.py
@@ -1,8 +1,8 @@
 from enum import Enum
 from typing import Type, Any
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class InEnumValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/IsArrayValidator.py b/src/flask_inputfilter/Validator/IsArrayValidator.py
@@ -1,7 +1,7 @@
 from typing import Any
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class IsArrayValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/IsBase64ImageCorrectSizeValidator.py b/src/flask_inputfilter/Validator/IsBase64ImageCorrectSizeValidator.py
@@ -1,16 +1,18 @@
 import base64
 from typing import Any
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class IsBase64ImageCorrectSizeValidator(BaseValidator):
     """
     Validator that checks if a Base64 string has a valid image size.
+    By default, the image size must be between 1 and 4MB.
     """
 
-    def __init__(self, minSize: int, maxSize: int) -> None:
+    def __init__(self, minSize: int = 1,
+                 maxSize: int = 4 * 1024 * 1024) -> None:
 
         self.minSize = minSize
         self.maxSize = maxSize
diff --git a/src/flask_inputfilter/Validator/IsBase64ImageValidator.py b/src/flask_inputfilter/Validator/IsBase64ImageValidator.py
@@ -3,8 +3,8 @@
 from PIL import Image
 from typing import Any
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class IsBase64ImageValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/IsBoolValidator.py b/src/flask_inputfilter/Validator/IsBoolValidator.py
@@ -1,7 +1,7 @@
 from typing import Any
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class IsBoolValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/IsFloatValidator.py b/src/flask_inputfilter/Validator/IsFloatValidator.py
@@ -1,6 +1,6 @@
 from typing import Any
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class IsFloatValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/IsInstanceValidator.py b/src/flask_inputfilter/Validator/IsInstanceValidator.py
@@ -1,7 +1,7 @@
 from typing import Type, Any
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class IsInstanceValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/IsIntegerValidator.py b/src/flask_inputfilter/Validator/IsIntegerValidator.py
@@ -1,7 +1,7 @@
 from typing import Any
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class IsIntegerValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/IsStringValidator.py b/src/flask_inputfilter/Validator/IsStringValidator.py
@@ -1,7 +1,7 @@
 from typing import Any
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class IsStringValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/LengthValidator.py b/src/flask_inputfilter/Validator/LengthValidator.py
@@ -1,7 +1,7 @@
 from typing import Any
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class LengthValidator(BaseValidator):
diff --git a/src/flask_inputfilter/Validator/RegexValidator.py b/src/flask_inputfilter/Validator/RegexValidator.py
@@ -1,7 +1,7 @@
 import re
 
-from src.flask_inputfilter.Exception import ValidationError
-from ..Validator.BaseValidator import BaseValidator
+from ..Exception import ValidationError
+from ..Validator import BaseValidator
 
 
 class RegexValidator(BaseValidator):
diff --git a/test/test_input_filter.py b/test/test_input_filter.py
@@ -2,18 +2,13 @@
 from enum import Enum
 
 from src.flask_inputfilter.Exception import ValidationError
-from src.flask_inputfilter.Filter import (StringTrimFilter, ToFloatFilter,
-                                          ToIntFilter, ToLowerFilter,
-                                          ToNullFilter, ToUpperFilter)
+from src.flask_inputfilter.Filter import ToIntegerFilter, ToNullFilter, \
+    StringTrimFilter, ToFloatFilter, ToLowerFilter, ToUpperFilter
 from src.flask_inputfilter.InputFilter import InputFilter
-from src.flask_inputfilter.Validator import (ArrayElementValidator,
-                                             InArrayValidator,
-                                             InEnumValidator, IsArrayValidator,
-                                             IsBase64ImageCorrectSizeValidator,
-                                             IsBoolValidator, IsFloatValidator,
-                                             IsInstanceValidator,
-                                             IsIntegerValidator,
-                                             LengthValidator, RegexValidator)
+from src.flask_inputfilter.Validator import IsIntegerValidator, \
+    LengthValidator, InArrayValidator, RegexValidator, IsArrayValidator, \
+    IsFloatValidator, ArrayElementValidator, InEnumValidator, \
+    IsBase64ImageCorrectSizeValidator, IsBoolValidator, IsInstanceValidator
 
 
 class TestInputFilter(unittest.TestCase):
@@ -27,7 +22,7 @@ def setUp(self) -> None:
         self.inputFilter.add(
             'age',
             required=True,
-            filters=[ToIntFilter()],
+            filters=[ToIntegerFilter()],
             validators=[IsIntegerValidator()]
         )
 
@@ -250,7 +245,7 @@ def test_array_element_validator(self) -> None:
         elementFilter = InputFilter()
         elementFilter.add(
             'id', required=True, filters=[
-                ToIntFilter()], validators=[
+                ToIntegerFilter()], validators=[
                 IsIntegerValidator()])
 
         self.inputFilter.add(

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from ..Filter.BaseFilter import BaseFilter`
	`1`	`+from ..Filter import BaseFilter`
`2`	`2`
`3`	`3`
`4`	`4`	`class StringTrimFilter(BaseFilter):`