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

Documentation

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

Requirements

  • Python >= 2.7 or >= 3.4

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-3.0.0b7.tar.gz (148.7 kB view details)

Uploaded Source

Built Distribution

marshmallow-3.0.0b7-py2.py3-none-any.whl (44.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file marshmallow-3.0.0b7.tar.gz.

File metadata

File hashes

Hashes for marshmallow-3.0.0b7.tar.gz
Algorithm Hash digest
SHA256 dac05fc434aa21ba46e7a7d468c844c899e44f42380fba04dd896253fd7d7d52
MD5 b4be6a3bdb293a191ca48b148e70aaa0
BLAKE2b-256 790d672ed20d09159d161c93e52bf666aab86fb35b550136c7f745a58d8e0499

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0b7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0d049fdce4a3eecd91261188befeaeb937e1977fae6dbb86279b3eec8cb7feeb
MD5 1b362729fbe54e55d5dec98c058b0ef4
BLAKE2b-256 00b2b4db6b0328b4a02044afdb5afd32dbed5a10db525843b12f6326b5e8a245

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