Skip to main content

A lightweight library for converting complex datatypes to and from native Python datatypes.

Project description

Latest version Travis-CI Documentation

marshmallow is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.

from datetime import date
from marshmallow import Schema, fields, pprint

class ArtistSchema(Schema):
    name = fields.Str()

class AlbumSchema(Schema):
    title = fields.Str()
    release_date = fields.Date()
    artist = fields.Nested(ArtistSchema())

bowie = dict(name='David Bowie')
album = dict(artist=bowie, title='Hunky Dory', release_date=date(1971, 12, 17))

schema = AlbumSchema()
result = schema.dump(album)
pprint(result.data, indent=2)
# { 'artist': {'name': 'David Bowie'},
#   'release_date': '1971-12-17',
#   'title': 'Hunky Dory'}

In short, marshmallow schemas can be used to:

  • Validate input data.

  • Deserialize input data to app-level objects.

  • Serialize app-level objects to primitive Python types. The serialized objects can then be rendered to standard formats such as JSON for use in an HTTP API.

Get It Now

$ pip install -U marshmallow

Documentation

Full documentation is available at http://marshmallow.readthedocs.io/ .

Requirements

  • Python >= 2.6 or >= 3.3

marshmallow has no external dependencies outside of the Python standard library, although python-dateutil is recommended for robust datetime deserialization.

Ecosystem

A list of marshmallow-related libraries can be found at the GitHub wiki here:

https://github.com/marshmallow-code/marshmallow/wiki/Ecosystem

License

MIT licensed. See the bundled LICENSE file for more details.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

marshmallow-2.12.0.tar.gz (137.3 kB view details)

Uploaded Source

Built Distribution

marshmallow-2.12.0-py2.py3-none-any.whl (45.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file marshmallow-2.12.0.tar.gz.

File metadata

File hashes

Hashes for marshmallow-2.12.0.tar.gz
Algorithm Hash digest
SHA256 3e717e7a807232b871114e61d9ca3c9c756a44cd7162135a780a250036690eec
MD5 e0eccd7bf75ca42f712581c651361f0b
BLAKE2b-256 0ef3702e09a72c4d7343bbd5f2793068db5fe7dd1dc06d55b69c3b98c7ecb231

See more details on using hashes here.

Provenance

File details

Details for the file marshmallow-2.12.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for marshmallow-2.12.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5aa73db7afe9ce0c3228fe5f34523c52267e3433b8a58a04df980df9ac5af07f
MD5 9b9302728ae49f49fa51e995f0393670
BLAKE2b-256 230c2d648126390e9b927a4fdf45161390cfe8590da52f0bbc80871d434c0d14

See more details on using hashes here.

Provenance

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