mooss-serialize 0.0.3

A Python package to help with serialization and deserialization of dataclasses through the help of a common interface while also insuring the parsed data is properly typed and handled in many situations.

Mooss - Serialize

⚠️ This package is a woro-in-progress, it is not suitable nor reliable yet ⚠️

A Python package to help with serialization and deserialization of dataclasses through the help of a common interface

while also insuring the parsed data is properly typed and handled in many situations.

This package was created because I often found myself needing to deserialize nested dataclasses with complex value

types, and because all other solutions I found were either too bloated or didn't work properly with what I had.

It is by no mean a replacement for other packages, but [...].

Usage

[Mention how it uses annotations !]

Requirements

• Python 3.9 or newer.

Installation

Run one of the following commands to install the package:

python -m pip install --upgrade mooss-serialize

pip install --upgrade mooss-serialize

Creating classes

The following classes have more complex and fluid typing for their variables that will help illustrate the main

advantage of this package over oneliners and other simpler deserializers.

from dataclasses import dataclass

from typing import Optional, Union



from mooss.serialize.interface import ISerializable



@dataclass

class Address(ISerializable):

    country: str

    city: str

    zip_code: Optional[int]

    # TODO: non-serializable bool

    street: str = "Unknown"



@dataclass

class Person(ISerializable):

    name: str

    address: Union[Address, str, None]

Preparing the raw data

[Can be from json, toml or raw as a dict]

# All of the fields with nested 'ISerializable' classes

data_person_full: dict = {

    "name": "John Smith",

    "address": {

        "country": "Belgium",

        "city": "Brussels",

        "zip_code": 1000,

        "street": "Rue de la Tribune",

    },

}

Parsing the data

person_full = Person.from_dict(data_person_full)



print(person_full)

Supported type annotations

The following types are supported by the interface:

• Primitives: str, int, float, bool

Any other object type should be ignored and if possible, instantiated as a dict.

Contributing

If you want more information on how to contribute to this package, you should refer to develop.md.

License

Unlicense