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 --pre

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.

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

Uploaded Source

Built Distribution

marshmallow-2.1.2-py2.py3-none-any.whl (44.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-2.1.2.tar.gz
Algorithm Hash digest
SHA256 3c537701721164b7021d92d8cfff450ed5c1f7078c5ae3a8628bc78fece0f083
MD5 b6843a5aaffe057c6fdcb309fb9597fe
BLAKE2b-256 29347b80acc9e080ac7f7bf854925907be1df1be09f58b159d133ef55e0eb440

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 88cb73e966808ffb87e376a1995129b38e76799d849182e9b2e90150a87332e8
MD5 41de48c4b4b03f5d3a796217faccf745
BLAKE2b-256 21d61026e8cb7f3bcee374a1f32976efb87b358950f1cfe10e7e3132a69900ec

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