Skip to content

Repository files navigation

marshmallow: simplified object serialization

Latest versionTravis-CIDocumentation

marshmallow is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.

fromdatetimeimportdatefrommarshmallowimportSchema, fields, pprintclassArtistSchema(Schema):
name=fields.Str()
classAlbumSchema(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

Project Links

License

MIT licensed. See the bundled LICENSE file for more details.

About

A lightweight library for converting complex objects to and from simple Python datatypes.

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages