Skip to main content

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

Project description

Latest version Build status pre-commit.ci status Documentation

marshmallow is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.

Example

from datetime import date
from pprint import pprint

from marshmallow import Schema, fields


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, 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 https://marshmallow.readthedocs.io/ .

Requirements

  • Python >= 3.9

Ecosystem

A list of marshmallow-related libraries can be found at the GitHub wiki here:

https://github.com/marshmallow-code/marshmallow/wiki/Ecosystem

Credits

Contributors

This project exists thanks to all the people who contribute.

You’re highly encouraged to participate in marshmallow’s development. Check out the Contributing Guidelines to see how you can help.

Thank you to all who have already contributed to marshmallow!

Contributors

Backers

If you find marshmallow useful, please consider supporting the team with a donation. Your donation helps move marshmallow forward.

Thank you to all our backers! [Become a backer]

Backers

Sponsors

marshmallow is sponsored by Route4Me.

Routing Planner

Support this project by becoming a sponsor (or ask your company to support this project by becoming a sponsor). Your logo will be displayed here with a link to your website. [Become a sponsor]

Professional Support

Professionally-supported marshmallow is now available through the Tidelift Subscription.

Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional-grade assurances from the experts who know it best, while seamlessly integrating with existing tools. [Get professional support]

Get supported marshmallow with Tidelift

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

Uploaded Source

Built Distribution

marshmallow-3.23.0-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marshmallow-3.23.0.tar.gz
  • Upload date:
  • Size: 177.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for marshmallow-3.23.0.tar.gz
Algorithm Hash digest
SHA256 98d8827a9f10c03d44ead298d2e99c6aea8197df18ccfad360dae7f89a50da2e
MD5 f7b800ad13a5948d208e04973e75aafa
BLAKE2b-256 b74105580fed5798ba8032341e7e330b866adc88dfca3bc3ec86c04e4ffdc427

See more details on using hashes here.

Provenance

File details

Details for the file marshmallow-3.23.0-py3-none-any.whl.

File metadata

  • Download URL: marshmallow-3.23.0-py3-none-any.whl
  • Upload date:
  • Size: 49.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for marshmallow-3.23.0-py3-none-any.whl
Algorithm Hash digest
SHA256 82f20a2397834fe6d9611b241f2f7e7b680ed89c49f84728a1ad937be6b4bdf4
MD5 44b752b90c2c416f2877bd28ab2e22a0
BLAKE2b-256 9a9ef8f0308b66ff5fcc3b351ffa5fcba19ae725dfeda75d3c673f4427f3fc99

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