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.0b1.tar.gz (44.3 kB view details)

Uploaded Source

Built Distribution

marshmallow-2.0.0b1-py2.py3-none-any.whl (48.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.0.0b1.tar.gz
Algorithm Hash digest
SHA256 70cfe6db8ea6be3c2dd05c9e0660184aa36729daf5a9c60fecd4591c12f56c46
MD5 8b03b95c51fb1cd3d3c13bb825d02894
BLAKE2b-256 ab33408c8fc9f09cffe0a6169c58d3db7cfc66dba237618161e1fa0e95bd6ffe

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.0.0b1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 053544b6854970be32043d53bfc648d1bcd0d6b5cd6cd966af208b59a71ccf8c
MD5 4e244d7d98dd680c2c43aceefcb649c4
BLAKE2b-256 d1699adf6ab6f1795985b86de21c9e7c0779db4a767d24d985abae00fd4dacd8

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