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

Uploaded Source

Built Distribution

marshmallow-1.2.5-py2.py3-none-any.whl (42.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-1.2.5.tar.gz
Algorithm Hash digest
SHA256 fb69a7c9aacc91c61e8be5da83cc8f722b83822e703d096a8de950006a84d8d7
MD5 7b3575dcce03c8c27c3ad599a1afd720
BLAKE2b-256 53847541419848d73950e382e9bb58012479ca27f434c3e2cece25820258afd8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-1.2.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 49b56d4172a21ac2b669b635e2c39814892aed7383e109129d47de4776b85203
MD5 dec249f06c870bbda05f9e670d129759
BLAKE2b-256 2a697cb9fdbb11aaef62ec497710ae164eaa7844e61aa43d847509ec832222e9

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