sqlobjects 0.1.0__py3-none-any.whl

sqlobjects/validators.py

@@ -0,0 +1,294 @@
+"""SQLObjects Validators Module - Field validation system"""
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+from .exceptions import ValidationError
+
+
+__all__ = [
+    "FieldValidator",
+    "LengthValidator",
+    "RangeValidator",
+    "EmailValidator",
+    "validate_field_value",
+]
+
+
+class FieldValidator(ABC):
+    """Base class for field validators.
+
+    This abstract base class defines the interface for all field validators
+    in the SQLObjects system. Validators are used to ensure data integrity
+    and enforce business rules on model fields.
+
+    Examples:
+        >>> class CustomValidator(FieldValidator):
+        ...     def validate(self, value: Any, field_name: str) -> Any:
+        ...         if value and len(str(value)) < 3:
+        ...             raise ValidationError(self.get_error_message(field_name, value))
+        ...         return value
+        ...
+        ...     def get_error_message(self, field_name: str, value: Any) -> str:
+        ...         return f"Field '{field_name}' must be at least 3 characters long"
+    """
+
+    @abstractmethod
+    def validate(self, value: Any, field_name: str) -> Any:
+        """Validate and return the processed value.
+
+        Args:
+            value: The value to validate
+            field_name: Name of the field being validated
+
+        Returns:
+            The validated (and potentially transformed) value
+
+        Raises:
+            ValidationError: If validation fails
+        """
+        pass
+
+    @abstractmethod
+    def get_error_message(self, field_name: str, value: Any) -> str:
+        """Get the error message for validation failure.
+
+        Args:
+            field_name: Name of the field that failed validation
+            value: The value that failed validation
+
+        Returns:
+            Human-readable error message
+        """
+        pass
+
+
+class LengthValidator(FieldValidator):
+    """Validator for string/value length constraints.
+
+    This validator ensures that the string representation of a value
+    meets minimum and/or maximum length requirements.
+
+    Args:
+        min_length: Minimum required length (default: 0)
+        max_length: Maximum allowed length (optional)
+
+    Examples:
+        >>> # Username must be 3-20 characters
+        >>> username_validator = LengthValidator(min_length=3, max_length=20)
+        >>> username_validator.validate("john", "username")  # Valid
+        >>> username_validator.validate("jo", "username")  # Raises ValidationError
+
+        >>> # Description must be at least 10 characters
+        >>> desc_validator = LengthValidator(min_length=10)
+        >>> desc_validator.validate("Short desc", "description")  # Valid
+    """
+
+    def __init__(self, min_length: int = 0, max_length: int | None = None):
+        self.min_length = min_length
+        self.max_length = max_length
+
+    def validate(self, value: Any, field_name: str) -> Any:
+        """Validate the length of the value.
+
+        Args:
+            value: The value to validate
+            field_name: Name of the field being validated
+
+        Returns:
+            The original value if validation passes
+
+        Raises:
+            ValidationError: If the value length is outside the allowed range
+        """
+        if value is None:
+            return value
+
+        length = len(str(value))
+        if length < self.min_length:
+            raise ValidationError(self.get_error_message(field_name, value))
+        if self.max_length and length > self.max_length:
+            raise ValidationError(self.get_error_message(field_name, value))
+
+        return value
+
+    def get_error_message(self, field_name: str, value: Any) -> str:
+        """Get the error message for length validation failure.
+
+        Args:
+            field_name: Name of the field that failed validation
+            value: The value that failed validation
+
+        Returns:
+            Human-readable error message describing the length requirement
+        """
+        if self.max_length:
+            return f"Field '{field_name}' length must be between {self.min_length} and {self.max_length}"
+        return f"Field '{field_name}' length must be at least {self.min_length}"
+
+
+class RangeValidator(FieldValidator):
+    """Validator for numeric range constraints.
+
+    This validator ensures that numeric values fall within specified
+    minimum and/or maximum bounds. The value is converted to float
+    for comparison.
+
+    Args:
+        min_value: Minimum allowed value (optional)
+        max_value: Maximum allowed value (optional)
+
+    Examples:
+        >>> # Age must be between 0 and 150
+        >>> age_validator = RangeValidator(min_value=0, max_value=150)
+        >>> age_validator.validate(25, "age")  # Valid
+        >>> age_validator.validate(-5, "age")  # Raises ValidationError
+
+        >>> # Price must be at least 0
+        >>> price_validator = RangeValidator(min_value=0)
+        >>> price_validator.validate(19.99, "price")  # Valid
+    """
+
+    def __init__(self, min_value: float | None = None, max_value: float | None = None):
+        self.min_value = min_value
+        self.max_value = max_value
+
+    def validate(self, value: Any, field_name: str) -> Any:
+        """Validate the numeric range of the value.
+
+        Args:
+            value: The value to validate
+            field_name: Name of the field being validated
+
+        Returns:
+            The original value if validation passes
+
+        Raises:
+            ValidationError: If the value is not numeric or outside the allowed range
+        """
+        if value is None:
+            return value
+
+        try:
+            num_value = float(value)
+        except (ValueError, TypeError) as e:
+            raise ValidationError(f"Field '{field_name}' must be a number") from e
+
+        if self.min_value is not None and num_value < self.min_value:
+            raise ValidationError(self.get_error_message(field_name, value))
+        if self.max_value is not None and num_value > self.max_value:
+            raise ValidationError(self.get_error_message(field_name, value))
+
+        return value
+
+    def get_error_message(self, field_name: str, value: Any) -> str:
+        """Get the error message for range validation failure.
+
+        Args:
+            field_name: Name of the field that failed validation
+            value: The value that failed validation
+
+        Returns:
+            Human-readable error message describing the range requirement
+        """
+        if self.min_value is not None and self.max_value is not None:
+            return f"Field '{field_name}' must be between {self.min_value} and {self.max_value}"
+        elif self.min_value is not None:
+            return f"Field '{field_name}' must be at least {self.min_value}"
+        else:
+            return f"Field '{field_name}' must be at most {self.max_value}"
+
+
+class EmailValidator(FieldValidator):
+    """Validator for email address format.
+
+    This validator performs basic email format validation by checking
+    for the presence of '@' symbol and a dot in the domain part.
+    For production use, consider using more comprehensive email
+    validation libraries.
+
+    Examples:
+        >>> email_validator = EmailValidator()
+        >>> email_validator.validate("user@example.com", "email")  # Valid
+        >>> email_validator.validate("invalid-email", "email")  # Raises ValidationError
+        >>> email_validator.validate("user@domain", "email")  # Raises ValidationError
+    """
+
+    def validate(self, value: Any, field_name: str) -> Any:
+        """Validate the email address format.
+
+        Args:
+            value: The value to validate
+            field_name: Name of the field being validated
+
+        Returns:
+            The original value if validation passes
+
+        Raises:
+            ValidationError: If the value is not a valid email format
+        """
+        if value is None:
+            return value
+
+        email_str = str(value)
+        if "@" not in email_str or "." not in email_str.split("@")[-1]:
+            raise ValidationError(self.get_error_message(field_name, value))
+
+        return value
+
+    def get_error_message(self, field_name: str, value: Any) -> str:
+        """Get the error message for email validation failure.
+
+        Args:
+            field_name: Name of the field that failed validation
+            value: The value that failed validation
+
+        Returns:
+            Human-readable error message for invalid email format
+        """
+        return f"Field '{field_name}' must be a valid email address"
+
+
+def validate_field_value(validators: list[Any], value: Any, field_name: str) -> Any:
+    """Validate a field value using a list of validators.
+
+    This function applies multiple validators to a field value in sequence.
+    It supports both FieldValidator instances and simple callable functions.
+
+    Args:
+        validators: List of validators to apply
+        value: The value to validate
+        field_name: Name of the field being validated
+
+    Returns:
+        The validated (and potentially transformed) value
+
+    Raises:
+        ValidationError: If any validator fails
+
+    Examples:
+        >>> validators = [LengthValidator(min_length=3, max_length=50), EmailValidator()]
+        >>> validate_field_value(validators, "user@example.com", "email")
+        'user@example.com'
+
+        >>> # Using simple function validator
+        >>> def no_spaces(value):
+        ...     if " " in str(value):
+        ...         raise ValueError("No spaces allowed")
+        ...     return value
+        >>> validate_field_value([no_spaces], "username", "username")
+        'username'
+    """
+    for validator in validators:
+        if isinstance(validator, FieldValidator):
+            value = validator.validate(value, field_name)
+        elif callable(validator):
+            # Support for simple function validators
+            try:
+                result = validator(value)
+                if result is not None:
+                    value = result
+            except Exception as e:
+                raise ValidationError(f"Validation failed for {field_name}: {e}") from e
+
+    return value

sqlobjects-0.1.0.dist-info/METADATA

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: sqlobjects
+Version: 0.1.0
+Summary: Django-style async ORM library based on SQLAlchemy with chainable queries, Q objects, and relationship loading
+Author-email: XtraVisions <gitadmin@xtravisions.com>, Chen Hao <chenhao@xtravisions.com>
+Maintainer-email: XtraVisions <gitadmin@xtravisions.com>, Chen Hao <chenhao@xtravisions.com>
+License: MIT
+Project-URL: Homepage, https://github.com/XtraVisionsAI/sqlobjects
+Project-URL: Repository, https://github.com/XtraVisionsAI/sqlobjects.git
+Project-URL: Documentation, https://github.com/XtraVisionsAI/sqlobjects#readme
+Project-URL: Bug Tracker, https://github.com/XtraVisionsAI/sqlobjects/issues
+Project-URL: Changelog, https://github.com/XtraVisionsAI/sqlobjects/blob/main/CHANGELOG.md
+Keywords: python,orm,async,django-style,database,query
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Framework :: AsyncIO
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlalchemy[asyncio]>=2.0.43
+Dynamic: license-file

sqlobjects-0.1.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+sqlobjects/__init__.py,sha256=ptVLnrTySBdIHFl9Nj3oVDpY_2ssu8riX3pg-_h3T50,1165
+sqlobjects/config.py,sha256=WW8Dzf-8IY0j3i0kwzVt19rELXENSkBi1fpRl6Us5l0,19295
+sqlobjects/database.py,sha256=Vciywb0FWb1ChGYEfbqtBjopyiIR3KDHtH4p7bePc8g,19848
+sqlobjects/exceptions.py,sha256=J0mKk77JhJmJ28Gv80DckstB9rM_ky61Cq1ZwO4kbkE,18212
+sqlobjects/expressions.py,sha256=QyK3k_q4UaA5OLKu-fDkdiAc9dKHdplJd49OABCDzjk,38218
+sqlobjects/fields.py,sha256=5_vi31Bix7OSH0zp16WGjcbeT0f8x7iR7EA-gM8kj6k,56822
+sqlobjects/history.py,sha256=hcO-P3XcgdUF2zTL9IBv-2rfo0LKIZqdDAuIqSN6TA8,3742
+sqlobjects/metadata.py,sha256=PL1ow7xptGzVaXUQ6aqv2lS1MFCf1eP_bK3GnUqMQ_8,40459
+sqlobjects/model.py,sha256=-qnDZm9DMtE23tzcKNrVjHMJBO2dqIH11FtnD0tBO78,35014
+sqlobjects/objects.py,sha256=DkjdIzlkO2JFhY5C34U0wAXPoy9gk_k2GFIkfJ6GBbg,29546
+sqlobjects/queries.py,sha256=UysAA3Zmi0_sm0DTfHLotkKe7vXNJuTiQ64VyFnYMIQ,39992
+sqlobjects/relations.py,sha256=oY4Wt3jxCJokATvQ5ukF79-f8yKU46Y7JrzbwxxFF-Y,27684
+sqlobjects/session.py,sha256=-F6ia0DMWL2DPRw7aizBvzt7XNrz9aPZJYunvdkj2G4,13743
+sqlobjects/signals.py,sha256=ybUFi5KD7kve8jHtr8QJuqLxg-opCoLDsDl5QJtkqT8,17680
+sqlobjects/validators.py,sha256=cWZOVYw__No5YetGAFe4RBpXY14EKFxb7OkZoERyeAk,10114
+sqlobjects/utils/__init__.py,sha256=NsJ52Fl_PaB-2WlOIJVGNPmgOnqPmvYRmp7uaq5zfYs,192
+sqlobjects/utils/naming.py,sha256=PmfNuEz-Twly2qREjKfMNulJt8TmOUJaxzFTuts3COg,1411
+sqlobjects/utils/pattern.py,sha256=FGCgobTpnmKjdAtQidHIg4Xa2CQLeP35F0VuX_1T1dk,14740
+sqlobjects-0.1.0.dist-info/licenses/LICENSE,sha256=ScFR7nvWIhar0d32Y-LA4vqp9zNmy1HSJia7UX7jU6c,1068
+sqlobjects-0.1.0.dist-info/METADATA,sha256=DzDRI2_FR9FtvYD-9b7m_JydZC54TKwu1IchBXNGKks,1466
+sqlobjects-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sqlobjects-0.1.0.dist-info/top_level.txt,sha256=brO5vDtCpn4L9dpX0EHpehbu4kcHaK_2Bbnwze35YKc,11
+sqlobjects-0.1.0.dist-info/RECORD,,

sqlobjects-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sqlobjects-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 XtraVisions
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sqlobjects-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+sqlobjects