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

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.0.0b2.tar.gz (45.0 kB view details)

Uploaded Source

Built Distribution

marshmallow-2.0.0b2-py2.py3-none-any.whl (48.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file marshmallow-2.0.0b2.tar.gz.

File metadata

File hashes

Hashes for marshmallow-2.0.0b2.tar.gz
Algorithm Hash digest
SHA256 c4bb1b8569bef322fea40658e523a47d559488e615f5db5789f520564851eb46
MD5 b958adde7fe431a43de1c38d63cf6993
BLAKE2b-256 c61d73293ec4e63c42d9e8157ee5160330df197f7d8871dee09ec21110ab266e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.0.0b2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 88f12ddf889ef0a081cd78bb1e924826677dced90f8992dae3653c2c27386d39
MD5 2c097ecf27a8a4e047017a3ee753eaa2
BLAKE2b-256 23578caf6d898f32e7e4f933695793043bfa2d8f0334bf40c1bffd952b5e5368

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