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

Uploaded Source

Built Distribution

marshmallow-1.2.0-py2.py3-none-any.whl (42.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-1.2.0.tar.gz
Algorithm Hash digest
SHA256 6c2bfc60d16e8bafd6bfd981e61ef36937651810c835626dfb94e365dc48d3e2
MD5 0e00b0856e9dfeb70e36213c87aac903
BLAKE2b-256 0737a1814c0d1f2e330c0079b5870c216f9d2de042a900457a731e45b75d45c8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4ddc7f83964596521910493561b9290a3a2c9d697f759fdc8293a883ac391f66
MD5 f97e47a94d5c0176a067c21059b6112d
BLAKE2b-256 c6aafa48846d4bd59682f6323ce5214134863ebcfadb9a1763c0660265fbfc46

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