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

Uploaded Source

Built Distribution

marshmallow-3.0.0b8-py2.py3-none-any.whl (43.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0b8.tar.gz
Algorithm Hash digest
SHA256 5ea1340c1a17c560e05db1be8ba32908d557a309c7e490ba863bb781728603a1
MD5 69264a8621d0e5b2b2d9f334d00e719e
BLAKE2b-256 f0e5729e28e144df022ca2b6b11ab21fcae684fdee220c75a130ca2f9454355b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0b8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4293185d8069ab4363f6359bc9fcfdc8be2fd2c593318d36ea391b93b632241b
MD5 c0fdb05be13964eb142b05fd093160eb
BLAKE2b-256 0b6639fca5bbce1d221c8711c5f8cdc78da41c1bb53298c71b2f697757e5a540

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