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.readthedocs.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.readthedocs.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

This version

2.1.1

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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: marshmallow-2.1.1.tar.gz
  • Upload date:
  • Size: 127.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for marshmallow-2.1.1.tar.gz
Algorithm Hash digest
SHA256 158ce9a9577b7550a8ed76245c5b22d9bde39fa7d5999f3333140949b7025ce5
MD5 841b653d4d66f795ca3a3a4e3493bde0
BLAKE2b-256 884e977f668b4a5fa1d860e20956cf65b3a04df47998c1adb19d6a2da3786331

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cce535c29d004ca2938627bbfc2fa530618352f418541c4b237574eea871dda1
MD5 23feb347a798423b76b9faf79dfe6f18
BLAKE2b-256 4684581f4dd9ea45d788bdf093041bbd918a7bd2a5d7d41d4548135574e75722

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