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

This version

2.9.0

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

Uploaded Source

Built Distribution

marshmallow-2.9.0-py2.py3-none-any.whl (44.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: marshmallow-2.9.0.tar.gz
  • Upload date:
  • Size: 133.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for marshmallow-2.9.0.tar.gz
Algorithm Hash digest
SHA256 4ef51025bfe84639f2dc42ea29c06fd6a487231b12d48a81ac9a24dbeb7b1b9f
MD5 15ebc05a75de782116ab1d5eee807e73
BLAKE2b-256 3c0812d7d988c540184616bbb7c6635bbae6f7c558db84979bc7a9fdaa0a5f7c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.9.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e981b5bfbe69c5dda229fca6dfcdd331785ad8089e2dad6cb2634b01608d41a7
MD5 12b96697cee54a4213df64bfb765830d
BLAKE2b-256 19ca38bfd623f60217e878c4206128e6a4550f509f300c2280cce2f522417d87

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