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, 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.0b9.tar.gz (149.4 kB view details)

Uploaded Source

Built Distribution

marshmallow-3.0.0b9-py2.py3-none-any.whl (41.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0b9.tar.gz
Algorithm Hash digest
SHA256 cbedade4d2d7cdd88110de3645e67b63efbec13ad191fcbb3b8f958ad01ffa06
MD5 02001cd3db42a9f48f368a3f47cff29a
BLAKE2b-256 c49e8075208ad89ad06831e1570fa176457821b07a2414277926b5a0f398db4c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0b9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dcaa1cb13fc54db23c66e5fd56a666dadc4c9a4e99b8e465d4f69cccb1e91696
MD5 b6261675b524d451f8b0b95afb00e712
BLAKE2b-256 c68f1cbdb31d542ba5293c7449449db0a74ea995de37a7e1eb1318b50776b063

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