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.10.1.tar.gz (135.0 kB view details)

Uploaded Source

Built Distribution

marshmallow-2.10.1-py2.py3-none-any.whl (44.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.10.1.tar.gz
Algorithm Hash digest
SHA256 ee34223e65dd12d0fc964690f650da6ec9d07dfb015f3c11cd56e7b7cbba0d12
MD5 5e9828932e50d328ffd48c8098ce67ab
BLAKE2b-256 e0381f9a90d777c0597dafcf947dfd66486d6a707e5df87049921478117f242f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.10.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fe273cb0b927b1e80a76beeb969d787e3fe03cafc6a3fe70587ba64d43349eb2
MD5 077bb92557f4e0d3d7f11647056d8f19
BLAKE2b-256 617b34b7a1e70dacf6c88af968fa8f52c5a43a573b7d2753ee0bfada719fc17d

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