porcupine-python 0.4.0

A library designed primarily for serializing objects using type checking and resolvers.

porcupine-python

Hi. I am a fucking porcupine 🦔. I am here to serialize your responses 💪.

Usage

porcupine-python is used for type and nested serialization of any objects with attributes into dictionaries.

Simple usage

First we need to create some simple class:

class User(object):
    def __init__(self, name=None, surname=None, age=None):
        self.name = name
        self.surname = surname
        self.age = age

Second we create serializer for this type of class:

from porcupine.base import Serializer

class UserSerializer(Serializer):
    name: str
    surname: str
    age: int = None

Final usage with different created instances looks like this:

# User instance with all attributes
user = User('foo', 'bar', 23)

dictionary = UserSerializer(user).dict()
# dictionary: {'name': 'foo', 'surname': 'bar', 'age': 23}

# User instance with only required attributes
user = User('foo', 'bar')

dictionary = UserSerializer(user).dict()
# dictionary: {'name': 'foo', 'surname': 'bar', 'age': None}

# User instance with all None attributes
user = User()

dictionary = UserSerializer(user).dict()
# raised ValidationError

Usage of resolvers

First we need to create some class which instances will be resolved:

class User(object):
    def __init__(self, name=None, surname=None, age=None):
        self.name = name
        self.surname = surname

Serializer for that class:

from porcupine.base import Serializer

class UserSerializer(Serializer):
    name: str = None
    surname: str = None
    full_name: str = None

    @staticmethod
    def resolve_full_name(data):
        fullname = None

        if data.name and data.surname:
            fullname = f'{data.name} {data.surname}'
        elif data.name:
            fullname = data.name
        elif data.surname:
            fullname = data.surname

        return fullname

Serialized user instance:

user = User('foo', 'bar')

dictionary = UserSerializer(user).dict()
# dictionary: {'name': 'foo', 'surname': 'bar', 'full_name': 'foo bar'}

---

Made with ❤ by Adam Žúrek & BACKBONE s.r.o.

0.1.0 : 2020-05-26

• Initial release

0.2.0 : 2020-06-27

• Fixed Expected type 'Dict[str, Any]' warning when calling BaseSerializer
• Implemented test for nested objects.

0.3.0 : 2020-11-27

• 🦦 Implemented possibility to add custom arguments to serializers.
• 🦦 Pydantic version requirement changed from 1.4.* to 1.7.*.

0.4.0 : 2021-02-02

• 🎸 Support for nested serializers.
• 🎸 Support for list of serializers.