sqlalchemy-serializer-meta 0.1.0__tar.gz → 0.2.0__tar.gz

{sqlalchemy_serializer_meta-0.1.0/sqlalchemy_serializer_meta.egg-info → sqlalchemy_serializer_meta-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlalchemy_serializer_meta
-Version: 0.1.0
+Version: 0.2.0
 Summary: A simple serializer for SQLAlchemy models and Flask Models
 Home-page: https://github.com/Wehda23/sqlalchemy_serializer_meta
 Author: Waheed Khaled Elhariri
@@ -24,10 +24,21 @@ Requires-Dist: pydantic_core==2.18.4
 
 This module provides a set of serializers for your Flask application, allowing you to easily validate and serialize data. The serializers are built with flexibility and extendability in mind, providing features such as nested serialization and integration with Pydantic models.
 
+## 📜 Table of Contents
+1. [Installation](#installation)
+2. [Basic Usage](#usage)
+3. [Creating Custom Serializers](#custom-serializers)
+4. [Validators & Other Utilities](#validators--other-utilities)
+5. [Support My Work](#support-my-work)
+
 ## Installation
 
 To use the serializers in your project, simply include the necessary files in your application directory.
 
+```bash
+pip install sqlalchemy-serializer-meta==0.1.0
+```
+
 ## Usage
 
 Can be used to Serialize SQLAlchemy Model or Flask-SQLAlchemy model.
@@ -390,3 +401,75 @@ if __name__ == '__main__':
 - **Focus on Business Logic:** By handling validation and serialization within the serializer, the main view functions can focus on business logic and API response handling, making the codebase cleaner and more maintainable.
 
 By adopting this design, you can create scalable, maintainable, and robust APIs that leverage the power of SQLAlchemy and Flask-SQLAlchemy, ensuring that your application remains flexible and adaptable to changing requirements.
+
+
+## Validators & Other Utilities
+
+You can add a `read_only` to class meta to specify fields that can only be retrieved but not be updated.
+
+Also you can add a `write_only` to a class to specify fields that can be put as inputs but never retrieved
+
+By default field `password` is passively added as a `write_only` field.
+
+
+In your application `validators.py`:
+
+```py
+from sqlalchemy_serializer_meta.validator import BaseValidator
+
+class CustomValidator(BaseValidator):
+    def validate(self, value):
+        if not value:
+            raise self.raise_exception(ValueError, 'Value cannot be empty')
+
+```
+
+In your application `serializers.py`:
+
+```py
+from sqlalchemy_serializer_meta import Serializer
+from your_application.models import CustomModel
+from your_application.validators import CustomValidator
+from pydantic import BaseModel, EmailStr, ValidationError
+from typing import Union
+
+class CustomPydantic(BaseModel):
+    id: str
+    name: str
+    description: EmailStr
+
+class CustomModelSerializer(Serializer):
+    pydantic_model: BaseModel = CustomPydantic
+
+    class Meta:
+        model = CustomModel
+        fields = ['id', 'name', 'description']
+        read_only = ['id']
+        write_only = ['name']
+
+    def validate_name(self, value):
+        CustomValidator(SerializerError).validate(value)
+        return value
+```
+
+## Support My Work
+
+If you find my free content and projects helpful, consider supporting me to enable more learning resources for the community. Your contributions will go towards creating new content and maintaining existing projects.
+
+### How to Contribute
+
+You can contribute by making a donation through PayPal:
+
+[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://paypal.me/Waheedkhaled?country.x=EG&locale.x=en_US)
+
+You can contribute by making donation through Buy me coffee:
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/waheedKh)
+
+Your generosity is greatly appreciated!
+
+### Why Contribute?
+
+By supporting this project, you help ensure the continued availability of free educational content and the development of new projects. Your contribution makes a meaningful impact on the community of learners.
+
+Thank you for your support!

{sqlalchemy_serializer_meta-0.1.0 → sqlalchemy_serializer_meta-0.2.0}/README.md

@@ -2,10 +2,21 @@
 
 This module provides a set of serializers for your Flask application, allowing you to easily validate and serialize data. The serializers are built with flexibility and extendability in mind, providing features such as nested serialization and integration with Pydantic models.
 
+## 📜 Table of Contents
+1. [Installation](#installation)
+2. [Basic Usage](#usage)
+3. [Creating Custom Serializers](#custom-serializers)
+4. [Validators & Other Utilities](#validators--other-utilities)
+5. [Support My Work](#support-my-work)
+
 ## Installation
 
 To use the serializers in your project, simply include the necessary files in your application directory.
 
+```bash
+pip install sqlalchemy-serializer-meta==0.1.0
+```
+
 ## Usage
 
 Can be used to Serialize SQLAlchemy Model or Flask-SQLAlchemy model.
@@ -368,3 +379,75 @@ if __name__ == '__main__':
 - **Focus on Business Logic:** By handling validation and serialization within the serializer, the main view functions can focus on business logic and API response handling, making the codebase cleaner and more maintainable.
 
 By adopting this design, you can create scalable, maintainable, and robust APIs that leverage the power of SQLAlchemy and Flask-SQLAlchemy, ensuring that your application remains flexible and adaptable to changing requirements.
+
+
+## Validators & Other Utilities
+
+You can add a `read_only` to class meta to specify fields that can only be retrieved but not be updated.
+
+Also you can add a `write_only` to a class to specify fields that can be put as inputs but never retrieved
+
+By default field `password` is passively added as a `write_only` field.
+
+
+In your application `validators.py`:
+
+```py
+from sqlalchemy_serializer_meta.validator import BaseValidator
+
+class CustomValidator(BaseValidator):
+    def validate(self, value):
+        if not value:
+            raise self.raise_exception(ValueError, 'Value cannot be empty')
+
+```
+
+In your application `serializers.py`:
+
+```py
+from sqlalchemy_serializer_meta import Serializer
+from your_application.models import CustomModel
+from your_application.validators import CustomValidator
+from pydantic import BaseModel, EmailStr, ValidationError
+from typing import Union
+
+class CustomPydantic(BaseModel):
+    id: str
+    name: str
+    description: EmailStr
+
+class CustomModelSerializer(Serializer):
+    pydantic_model: BaseModel = CustomPydantic
+
+    class Meta:
+        model = CustomModel
+        fields = ['id', 'name', 'description']
+        read_only = ['id']
+        write_only = ['name']
+
+    def validate_name(self, value):
+        CustomValidator(SerializerError).validate(value)
+        return value
+```
+
+## Support My Work
+
+If you find my free content and projects helpful, consider supporting me to enable more learning resources for the community. Your contributions will go towards creating new content and maintaining existing projects.
+
+### How to Contribute
+
+You can contribute by making a donation through PayPal:
+
+[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://paypal.me/Waheedkhaled?country.x=EG&locale.x=en_US)
+
+You can contribute by making donation through Buy me coffee:
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/waheedKh)
+
+Your generosity is greatly appreciated!
+
+### Why Contribute?
+
+By supporting this project, you help ensure the continued availability of free educational content and the development of new projects. Your contribution makes a meaningful impact on the community of learners.
+
+Thank you for your support!

{sqlalchemy_serializer_meta-0.1.0 → sqlalchemy_serializer_meta-0.2.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="sqlalchemy_serializer_meta",
-    version="0.1.0",
+    version="0.2.0",
     description="A simple serializer for SQLAlchemy models and Flask Models",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
@@ -11,11 +11,7 @@ setup(
     author_email="waheedkhaled95@gmail.com",
     license="MIT",
     packages=find_packages(),
-    install_requires=[
-        "sqlalchemy",
-        "pydantic==2.7.4",
-        "pydantic_core==2.18.4"
-    ],
+    install_requires=["sqlalchemy", "pydantic==2.7.4", "pydantic_core==2.18.4"],
     classifiers=[
         "Development Status :: 4 - Beta",
         "Intended Audience :: Developers",

{sqlalchemy_serializer_meta-0.1.0 → sqlalchemy_serializer_meta-0.2.0}/sqlalchemy_serializer_meta/__init__.py

@@ -156,7 +156,9 @@ class Serializer(SerializerInterface):
                             "input": (
                                 value
                                 if key != "password"
-                                else "" if key in self.write_only else ""
+                                else ""
+                                if key in self.write_only
+                                else ""
                             ),
                             "type": f"{e.args[0].__name__}",
                         }
@@ -169,7 +171,9 @@ class Serializer(SerializerInterface):
                             "input": (
                                 value
                                 if key != "password"
-                                else "" if key in self.write_only else ""
+                                else ""
+                                if key in self.write_only
+                                else ""
                             ),
                             "type": f"{type(e).__name__}",
                         }
@@ -363,9 +367,7 @@ class Serializer(SerializerInterface):
         return hasattr(instance, "__table__") and isinstance(instance.__table__, Table)
 
     def __serialize_relationship(
-        self,
-        nested_serializer: Optional["Serializer"],
-        relationship: object,
+        self, nested_serializer: Optional["Serializer"], relationship: object,
     ) -> Any:
         """Helper function to serialize a single nested relationship."""
         if nested_serializer and isinstance(nested_serializer, Serializer):

sqlalchemy_serializer_meta-0.2.0/sqlalchemy_serializer_meta/validator.py

@@ -0,0 +1,20 @@
+"""
+Module Contains base validator implementation.
+"""
+from abc import ABC, abstractmethod
+from typing import Self
+from . import SerializerError
+
+
+# Abstracted Validator Class
+class BaseValidator(ABC):
+    """
+    Base Validation class that utilizes `SerializerError` from package as it's default raise_exception
+    """
+
+    def __init__(self: Self, raise_exception: SerializerError = SerializerError):
+        self.raise_exception: SerializerError = raise_exception
+
+    @abstractmethod
+    def validate(self, data):
+        pass

{sqlalchemy_serializer_meta-0.1.0 → sqlalchemy_serializer_meta-0.2.0/sqlalchemy_serializer_meta.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlalchemy_serializer_meta
-Version: 0.1.0
+Version: 0.2.0
 Summary: A simple serializer for SQLAlchemy models and Flask Models
 Home-page: https://github.com/Wehda23/sqlalchemy_serializer_meta
 Author: Waheed Khaled Elhariri
@@ -24,10 +24,21 @@ Requires-Dist: pydantic_core==2.18.4
 
 This module provides a set of serializers for your Flask application, allowing you to easily validate and serialize data. The serializers are built with flexibility and extendability in mind, providing features such as nested serialization and integration with Pydantic models.
 
+## 📜 Table of Contents
+1. [Installation](#installation)
+2. [Basic Usage](#usage)
+3. [Creating Custom Serializers](#custom-serializers)
+4. [Validators & Other Utilities](#validators--other-utilities)
+5. [Support My Work](#support-my-work)
+
 ## Installation
 
 To use the serializers in your project, simply include the necessary files in your application directory.
 
+```bash
+pip install sqlalchemy-serializer-meta==0.1.0
+```
+
 ## Usage
 
 Can be used to Serialize SQLAlchemy Model or Flask-SQLAlchemy model.
@@ -390,3 +401,75 @@ if __name__ == '__main__':
 - **Focus on Business Logic:** By handling validation and serialization within the serializer, the main view functions can focus on business logic and API response handling, making the codebase cleaner and more maintainable.
 
 By adopting this design, you can create scalable, maintainable, and robust APIs that leverage the power of SQLAlchemy and Flask-SQLAlchemy, ensuring that your application remains flexible and adaptable to changing requirements.
+
+
+## Validators & Other Utilities
+
+You can add a `read_only` to class meta to specify fields that can only be retrieved but not be updated.
+
+Also you can add a `write_only` to a class to specify fields that can be put as inputs but never retrieved
+
+By default field `password` is passively added as a `write_only` field.
+
+
+In your application `validators.py`:
+
+```py
+from sqlalchemy_serializer_meta.validator import BaseValidator
+
+class CustomValidator(BaseValidator):
+    def validate(self, value):
+        if not value:
+            raise self.raise_exception(ValueError, 'Value cannot be empty')
+
+```
+
+In your application `serializers.py`:
+
+```py
+from sqlalchemy_serializer_meta import Serializer
+from your_application.models import CustomModel
+from your_application.validators import CustomValidator
+from pydantic import BaseModel, EmailStr, ValidationError
+from typing import Union
+
+class CustomPydantic(BaseModel):
+    id: str
+    name: str
+    description: EmailStr
+
+class CustomModelSerializer(Serializer):
+    pydantic_model: BaseModel = CustomPydantic
+
+    class Meta:
+        model = CustomModel
+        fields = ['id', 'name', 'description']
+        read_only = ['id']
+        write_only = ['name']
+
+    def validate_name(self, value):
+        CustomValidator(SerializerError).validate(value)
+        return value
+```
+
+## Support My Work
+
+If you find my free content and projects helpful, consider supporting me to enable more learning resources for the community. Your contributions will go towards creating new content and maintaining existing projects.
+
+### How to Contribute
+
+You can contribute by making a donation through PayPal:
+
+[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://paypal.me/Waheedkhaled?country.x=EG&locale.x=en_US)
+
+You can contribute by making donation through Buy me coffee:
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/waheedKh)
+
+Your generosity is greatly appreciated!
+
+### Why Contribute?
+
+By supporting this project, you help ensure the continued availability of free educational content and the development of new projects. Your contribution makes a meaningful impact on the community of learners.
+
+Thank you for your support!

{sqlalchemy_serializer_meta-0.1.0 → sqlalchemy_serializer_meta-0.2.0}/sqlalchemy_serializer_meta.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ setup.cfg
 setup.py
 sqlalchemy_serializer_meta/__init__.py
 sqlalchemy_serializer_meta/serializer.py
+sqlalchemy_serializer_meta/validator.py
 sqlalchemy_serializer_meta.egg-info/PKG-INFO
 sqlalchemy_serializer_meta.egg-info/SOURCES.txt
 sqlalchemy_serializer_meta.egg-info/dependency_links.txt