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

Documentation

Full documentation is available at http://marshmallow.readthedocs.io/ .

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.

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

Uploaded Source

Built Distribution

marshmallow-2.13.1-py2.py3-none-any.whl (45.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.13.1.tar.gz
Algorithm Hash digest
SHA256 cf7e35ddfe8b18f8de3058fffc621921c79bb07455ad3084bfbf64caca766711
MD5 022f61bc48c20117165e032eedfe453a
BLAKE2b-256 a1d3a3b3ca2703b622f1670f883ed029be67f2215b660c6c8076261c04fe53a3

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.13.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5f7a9ab5d5f5583fe4e071fde98a472b04fd0df868ead83012f1a3e0e54d7cdf
MD5 fb55b7c93590791944718b7dfee49504
BLAKE2b-256 bd0a271d8c037b0957864d3b074fdf3d1374415d0d68803c3830edbca9689a6c

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