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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-2.10.5.tar.gz
Algorithm Hash digest
SHA256 5c44ad7ab7f326b9b7a9c6189ad39b21f399aefac9dbaa5f76317ad2dc5b2d50
MD5 a323886bf9fc0214d89b789a7eb9ddd3
BLAKE2b-256 9ef778980fe7673a1bb28cbf18de4417a8e4d1e8c26ead6aebd282523adee09f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for marshmallow-2.10.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 76722a4312affd9ed60e08f7e7b56dd37ee7bfbf43da03b86131a30a655afe37
MD5 8452cb4dec2d974a4e8969835a3b3860
BLAKE2b-256 cc61ba694f527bc77606b2975e9621f7b28240e899e61e59bce27a3f1b600df2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page