Skip to main content

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

Project description

Latest version Travis-CI

Homepage: http://marshmallow.readthedocs.org/

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 --pre

Documentation

Full documentation is available at http://marshmallow.readthedocs.org/ .

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.

License

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

Project details


Release history Release notifications | RSS feed

This version

2.1.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.1.0.tar.gz (126.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-2.1.0.tar.gz
Algorithm Hash digest
SHA256 d7e98b83b552a1d3f1701577e39a6e2f79adbabd49646f85033ffcbd88b5c296
MD5 03e3a03618156ff766fec2c1c4f5267b
BLAKE2b-256 962c6552f43e0973a5da69634daff360738cb31ff7666600997133cba6bd8cc1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5643da35c466773fe78cd02e974403d3f5b8218bf8a71656692b400698f45ac7
MD5 58018b403e0eb6813bfede0a341330d1
BLAKE2b-256 d2a4c6d5486f823edef4db9522eca74661e4fb63a9a7f0f9e1bae80ad7d7265b

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