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.

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

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

Uploaded Source

Built Distribution

marshmallow-4.0.0-py3-none-any.whl (48.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marshmallow-4.0.0.tar.gz
  • Upload date:
  • Size: 220.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for marshmallow-4.0.0.tar.gz
Algorithm Hash digest
SHA256 3b6e80aac299a7935cfb97ed01d1854fb90b5079430969af92118ea1b12a8d55
MD5 b3030c9ed81fba09cf620bf2aba28d4e
BLAKE2b-256 1eff26df5a9f5ac57ccf693a5854916ab47243039d2aa9e0fe5f5a0331e7b74b

See more details on using hashes here.

Provenance

The following attestation bundles were made for marshmallow-4.0.0.tar.gz:

Publisher: build-release.yml on marshmallow-code/marshmallow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: marshmallow-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 48.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for marshmallow-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7b0528337e9990fd64950f8a6b3a1baabed09ad17a0dfb844d701151f92d203
MD5 89961805f1f90639d0d44b9cbc331203
BLAKE2b-256 d6266cc45d156f44dbe1d5696d9e54042e4dcaf7b946c0b86df6a97d29706f32

See more details on using hashes here.

Provenance

The following attestation bundles were made for marshmallow-4.0.0-py3-none-any.whl:

Publisher: build-release.yml on marshmallow-code/marshmallow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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