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

Uploaded Source

Built Distribution

marshmallow-2.13.3-py2.py3-none-any.whl (45.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-2.13.3.tar.gz
Algorithm Hash digest
SHA256 41b07838d99166cfef90c0382b5b7ffc52a00e16dd3ab7d03be9438def28f424
MD5 58f51d307bbba640c2f53d8b962b7c76
BLAKE2b-256 e6f73c77f36c1768c235ce1c8940e6b61f16ae770a58bf16c006fc430a82ec3b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow-2.13.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e48cf450dd548f778a836563e2779d08b115e329fe7316a275de4ba600c377c7
MD5 f05796867da69428dda8adc5cc1f935d
BLAKE2b-256 abf0ecea6637b066e7f3d54b99b1b973d9aec6f472ebf076f3da14d24d721c49

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