Skip to main content

A lightweight library for converting complex datatypes to and from native Python datatypes.

Project description

Latest version Travis-CI Documentation

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.io/ .

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

marshmallow-2.15.2-py2.py3-none-any.whl (44.0 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for marshmallow-2.15.2.tar.gz
Algorithm Hash digest
SHA256 4c9978eddbc521674505ed38109cd8b92c8baa6f0a386a52356666c74e586d1e
MD5 11afa56d5256126ffccc2ede62789868
BLAKE2b-256 bd5864f9bbd173529c02e7e977dff26f4602706236dd54834fc0dc96685ad43c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for marshmallow-2.15.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0466c523c00bd6f1dcb6523cec016e20ffa9738d5abfaf618cd6b1142b9dc766
MD5 5ebd78629ab85d82daa13437e7cd7ba6
BLAKE2b-256 78b5cdea7457eaaec84dd51c853f44198b9f28ad5f7c6699d625bd767a380207

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page