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.

Ecosystem

A list of marshmallow-related libraries can be found at the GitHub wiki here:

https://github.com/marshmallow-code/marshmallow/wiki/Ecosystem

License

MIT licensed. See the bundled LICENSE file for more details.

Project details


Release history Release notifications | RSS feed

This version

2.7.3

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

Uploaded Source

Built Distribution

marshmallow-2.7.3-py2.py3-none-any.whl (43.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-2.7.3.tar.gz
Algorithm Hash digest
SHA256 3e71d5544860a5fc07cefb0b4e1f65924fdef877767042a1e957cc63a4765f1e
MD5 1f38a03f66978625270993dc1522bd63
BLAKE2b-256 2bb900d0e21bcabc30aeef422049908bcf369eaa70faab1309a197e8c1451689

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.7.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 028ccc21e3985f6efbb9aacb0944f31f7a16ef8335be47b8ddb6e096c456931b
MD5 36887d70d673778f8ddc36176f5b1b85
BLAKE2b-256 398bcbb04e90e656a283b7a4c5ff6a2267b537b8f5aff47518eb5daf0e9d58d8

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