Skip to main content

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

Project description

Latest version Travis-CI

Homepage: http://marshmallow.rtfd.org/

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 --pre

Documentation

Full documentation is available at http://marshmallow.rtfd.org/ .

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.

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.0.0a1.tar.gz (43.7 kB view details)

Uploaded Source

Built Distribution

marshmallow-2.0.0a1-py2.py3-none-any.whl (47.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file marshmallow-2.0.0a1.tar.gz.

File metadata

File hashes

Hashes for marshmallow-2.0.0a1.tar.gz
Algorithm Hash digest
SHA256 003e080899fc1318d04e09c7082c79fe3ef3e378456f7703c3d643a80194087b
MD5 5218296054a28d68de40a61a71b355a4
BLAKE2b-256 b1efa6bd9d2fe6b5247873941da983e9bd6f5c513d96bd945622911f96b2ba44

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.0.0a1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4b9be507127695189ea5be97fb002e256563439078fca7149f956baa98925731
MD5 504e6f5f4035924187b57309cbe30131
BLAKE2b-256 751299993e81ebf97ea65662000f21d5e21177be700def557ffbadad64ab99d5

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