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.0rc1.tar.gz (124.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 263836d1be4138c4f9bb4ca6897c260161610cfac57aac6f53b4e377793fe648
MD5 119114d1a73c5ac810a04544c0816119
BLAKE2b-256 9f53051ec4a8b960a2c41017b2c42f18229787f2a640efb8c5156df1f8dd6ea9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.0.0rc1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9fc2ae09e92a01253a64dc5eb121c059c8298e517371e751b2205b36f63c7b2f
MD5 7f799b679aeed3c200511b736ef9931a
BLAKE2b-256 ffb623d27914c2c42d9997b25eda52ae83a1746c77e59233e407e7e838075cc8

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