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

Uploaded Source

Built Distribution

marshmallow-2.10.0-py2.py3-none-any.whl (44.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.10.0.tar.gz
Algorithm Hash digest
SHA256 4f9dc3d7afddf164e4d7ad758f5355fd8283de59b2a216cf2b0b298a27111f7c
MD5 098e4b06a5bf475378eb57145605c59e
BLAKE2b-256 6110eea202160e7d759c5f093d2e4a4b895a4b69f72ff5b1d926eb32c078a810

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0613a857ba1883ea79fe3d64440d19ecbf8a98507bb80f738f6c8185e58b48f4
MD5 7dc16fe691b07559970316cb9a6062f2
BLAKE2b-256 6c58875104d881b8ad30c545c267c9bdc66cc9836d73071776738aa333408dac

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