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.rtfd.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.rtfd.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

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

Uploaded Source

Built Distribution

marshmallow-2.0.0-py2.py3-none-any.whl (44.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-2.0.0.tar.gz
Algorithm Hash digest
SHA256 5d51bf0ae7f6ac8235a7445955707a37669ebb20166efd6d0729ccb44476ee78
MD5 4cb3ccc9d23f236a557058fa3c7d36af
BLAKE2b-256 2bcde24622e0ad98868042aeb70c281eb08f5dbc41f663aca631570667d145ea

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d3911d0ac7f74165d321d66dcf330aa0c1ade920516e895e00b0adb0058e15c1
MD5 85f566182bf8a78024074b585f50b014
BLAKE2b-256 6cde1ce124edcb9207f6ea1a23fb04b5088dd0215562dd357cc0e8d15da9bd28

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