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

Uploaded Source

Built Distribution

marshmallow-3.0.0b1-py2.py3-none-any.whl (42.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0b1.tar.gz
Algorithm Hash digest
SHA256 4169892eecd9d156e6261f9a5e0199ccf857786d0e5fb595c46d63c476b8f83f
MD5 7a994551a24cf2c8f298fa89a047256d
BLAKE2b-256 96ef1385a06e8eeba65b48cbdf9be110ce5b0b113aebedd01778279ddff3f5c8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0b1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 81b1e2b87e44dd1da0e1d9d61cce05b7c755efd04d29aa4bbc6d1a01dc03a24c
MD5 a3ed54f389da2588b7ddba29ca78b4f6
BLAKE2b-256 9b1bcf1b55b416a0c29e326e033aada8134b8d6ee8010bc4b068be9b7bc921ff

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