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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.0.0rc2.tar.gz
Algorithm Hash digest
SHA256 4b7f3fc65d874fe492904d4188c3e57fe63a7477d281482c00d705aed7691047
MD5 7a9f9b05d4872913f434f621c2addf42
BLAKE2b-256 9e3af54516f04ba13c5b51a32e58105245cb0bf18187db98c231390a224b9820

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.0.0rc2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b2ec15da28eb056668e7691c91eb446b145cfa7b049fc2ba46b9826550ee5c60
MD5 af6458a6fd502015e4741b554fb41c5b
BLAKE2b-256 fd161731e0b3af65ce5fe451317091c5cb038f48c39aa288bcc0273f0c302965

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