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

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

marshmallow-1.2.2-py2.py3-none-any.whl (42.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-1.2.2.tar.gz
Algorithm Hash digest
SHA256 65ff2b777d225d022213738616e61475943077c0eb7e31bcff1971e9c34b0401
MD5 6f5322e868c9c40de3715216577b9da4
BLAKE2b-256 ce5400d46cc62e1f192d26350a576b9cd81f1bd4f29af0577b2c8b3541e5ae68

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for marshmallow-1.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ea1258fe66f12e80e699f68f5f57f74b3c627e56653d95468d9ed0dbe8b83855
MD5 890d5328ed8a95bb132cc17e57693721
BLAKE2b-256 8869bb599baa3a97b5f68d62eba8b1bc2553776e4a408f53cd5eb93f4c19f218

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page