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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-1.2.3.tar.gz
Algorithm Hash digest
SHA256 b353f692cc04527601d01dfc3c1271864771421b231d15ac64144d8593b2da37
MD5 d95f7857aaf1cead4355c01075f52674
BLAKE2b-256 ee41e8b1852e04b1b5240679a6329f5573a275bc1cc98a3c12f2831445ae6bd3

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-1.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 df3233c228f241847cb90a3e0b6df5e37fb4254d51eb857fefd441c770daa35a
MD5 bb6259e218c3c248c79f9466042109b5
BLAKE2b-256 4be36d40ae789b1dbf356455caf5f0842babea821e10c7a8c50a912f5d1d3a4a

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