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

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.4.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.4.0.tar.gz (129.0 kB view details)

Uploaded Source

Built Distribution

marshmallow-2.4.0-py2.py3-none-any.whl (44.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-2.4.0.tar.gz
Algorithm Hash digest
SHA256 3df4ef2e9e2fe57469e18c3f2e1856345c78a0a8d5e92805c155cab61ccb52a0
MD5 432263d58e327dacee15e39d885c008f
BLAKE2b-256 68660f7614c6d01b2665540aa9739894b6c00a40e05c4e8ee83c05feb23208a7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a1fdb8ebff0efa9d5e21f9f697dc9a4791c9c3ef43a9d825e2912cdd259c1768
MD5 2ba780ea785811f41309304c22d64e59
BLAKE2b-256 416a4bfd68e1076bb0935d4e2e86ef434e5826f919493c72afc78c0b8f4ebed9

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