Skip to main content

A framework for serializing and deserializing Python objects.

Project description

Serde is a general-purpose, extendable framework for serializing and deserializing Python objects. Objects are defined with a Model schema and can be converted to and from dictionaries and other data formats. Input values can be validated with arbitrary functions.

Installing

Install this package with

pip install serde

Example usage

First describe your data

class Version(Model):
    major = Integer()
    minor = Integer()
    patch = Integer(required=False, default=0)

class Package(Model):
    name = String(rename='packageName')
    version = ModelField(Version)

Easily instantiate and use a model

package = Package('requests', Version(2, 19, 1))

assert package.name == 'requests'
assert package.version.major == 2
assert package.version.minor == 19
assert package.version.patch == 1

Serialize the Model as a dictionary

assert package.to_dict() == {
    'packageName': 'requests',
    'version': {
        'major': 2,
        'minor': 19,
        'patch': 1
    }
}

Deserialize another Model from a dictionary

package = Package.from_dict({
    'packageName': 'click',
    'version': {
        'major': 7,
        'minor': 0
    }
})

assert package.name == 'click'
assert package.version.major == 7
assert package.version.minor == 0
assert package.version.patch == 0

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

serde-0.1.1.tar.gz (21.6 kB view hashes)

Uploaded Source

Built Distribution

serde-0.1.1-py3-none-any.whl (15.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page