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

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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-2.7.2.tar.gz
Algorithm Hash digest
SHA256 291f04d77332843e65dda06253174951c87d4b685ac0cea77415168fc6c76f71
MD5 6b93167dba628314d66213cdf432af29
BLAKE2b-256 1c1d51ed9afd232691eaace459004cc5a6b7f7e177c0a7f2c1275d6f76e59f19

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.7.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3eda6b2d1bca4993a0244c415b90d5ac984353faa2d4dd8b2f647574fc5ca1e9
MD5 dcddf07b25c936f1fae5928026478b06
BLAKE2b-256 f48e72d84bbf8e26291e7bd2f464d531ebf089b46305997169a8269a95ec0216

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