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

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

This version

1.2.6

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

marshmallow-1.2.6.tar.gz (38.8 kB view details)

Uploaded Source

Built Distribution

marshmallow-1.2.6-py2.py3-none-any.whl (47.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-1.2.6.tar.gz
Algorithm Hash digest
SHA256 60d6182c49e001ad921f1a132a5b7f8df0570905e72f30783dfecbcbe9ad8189
MD5 0debe1d2153d727e9b3aee62ba2417ad
BLAKE2b-256 2028059de418200eb6edd1ec455b93295eac4e9b1c9ac992d1d44da0bef7363d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-1.2.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ba48c1908aa8171816956ba4d5a890c837dfebf72f99ba4f37603a6e668f3425
MD5 fe0a0a5a930c962aeddae1a71aabb01c
BLAKE2b-256 81f5c4aad4b34b54099dfe8295ec2a455c39087c0d84321db4ec9c3b79943440

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