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

Uploaded Source

Built Distribution

marshmallow-3.0.0a1-py2.py3-none-any.whl (42.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0a1.tar.gz
Algorithm Hash digest
SHA256 8f041b4e983b3215ec1ed9820cff0a2f4fa5798f93e8c4c6f0dcd46d08216682
MD5 bc0aca0d84acb1f0b2bd8e5cb35d1416
BLAKE2b-256 c6adc88576e017d839610e75087f70d22e25946b78832aa8ba1481c08fb6af17

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-3.0.0a1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 89b994a30db9d3770fd1c24e7db732087d60c908376005ed465aa95331b8bb53
MD5 3349d0b8c50e97e5cc1865b6ca45ad32
BLAKE2b-256 a524fc1f2e438eeef67124e1ce3e39d6a791ebc1821a440aba6ef97ab0f4639b

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