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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0b10.tar.gz
Algorithm Hash digest
SHA256 adf7e8784573b86825df1c8167318a018ff9e357b07bb7ebc1d07de80b824bcb
MD5 f4178172c12d26bb65a808b070191f33
BLAKE2b-256 effea3015bd5b5747030476deb96c738950d2d5770376feefe98f30432f9cef1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0b10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 be2541dfd0fe7fdbb6ab83ab187e5190dfe2e169b68bb6ff982b06fad5bdb7e0
MD5 601ec5a60fd8e2d8bba012757ff93c20
BLAKE2b-256 4043ccfb94cb930a387f75c6ef8a1fa05145d46261ae58918a4018f5d4905a72

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