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

Uploaded Source

Built Distribution

marshmallow-2.13.4-py2.py3-none-any.whl (45.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.13.4.tar.gz
Algorithm Hash digest
SHA256 670da20927ff375db05e14601f22a08d52bf35df2c6b0101d840f42dc6c80e8f
MD5 6e696588796fc07b5af820b287341d59
BLAKE2b-256 ea3a4d08a08198c07845560b38b43429bd03192c326fc0d22fd5976a26c645d4

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.13.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d88c8d25f636377c00ae85dda7030ff6f7553a9aec7dcd29094126c05b82b36b
MD5 1434e96de0e718a1f78989904c8a56a0
BLAKE2b-256 94a3cb6315e56ed827bac84029a3558f1c42249cc36b355d3435f68181059e7b

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