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

Uploaded Source

Built Distribution

marshmallow-2.11.0-py2.py3-none-any.whl (45.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.11.0.tar.gz
Algorithm Hash digest
SHA256 dea77ac77163bf343e112949d93ecd774dba8aa0820abdd9dbe2ec34dab8b0be
MD5 e8cc067c46d30641e0a465669516a3f9
BLAKE2b-256 94928dbbd3b5879bfb87abcd3d0682ab0c345186a5b27b4c7181cdc1b2148f8f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.11.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a28f65477df036ce79f6b009a3a0627b28e4e9d64e7c6926bf0f5d7e5a0a2a18
MD5 9e70a504a4216ccf2237ca720380521e
BLAKE2b-256 f73059fa65b738db49b82192451a09827e89ae705dbc632473bba098c58e0396

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