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

Uploaded Source

Built Distribution

marshmallow-2.13.2-py2.py3-none-any.whl (45.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.13.2.tar.gz
Algorithm Hash digest
SHA256 6ac09c20d54b4a3927a2047df721dd2e1d778d052848aa0ee978c40f7adc96f2
MD5 e314fd56772bcf4048e16fb52894b21d
BLAKE2b-256 28a982b045a35414b4fb70420b0cc46d2cc10befa5425893481c5860d109c701

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.13.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9e65209b56a95d10962564a3045ab47c2d5ba4484e8d56ceec8ddaf68f420365
MD5 86817c5a7e1bbe8dfe51af55e6b89cf0
BLAKE2b-256 47f35b90d4a74f36a800a8aa3e4ff058160166f5b9517cf24b08eb3d465fe3e3

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