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

Uploaded Source

Built Distribution

marshmallow-2.11.1-py2.py3-none-any.whl (45.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.11.1.tar.gz
Algorithm Hash digest
SHA256 c580bd9ad017bba76414739eac1d98ef94daa41e37306b0c6aebcd421e997857
MD5 d28a9f8e94a6d876fda6e132b66c63ad
BLAKE2b-256 9c9a80d8fdc567cf92f24f8a4777a9aeb6cf318d086a3490bdcfff54bd0b0fd4

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.11.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8578eba89668adbfb4260fae7d2b568c0d718d9144269692c05541bee760608b
MD5 514bb8ac2bc1ea61c953ae99aeca1cb8
BLAKE2b-256 5152ebe69c46ca0f58644a4e862734bd7a675871a20863e5af92614a41a494c2

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