You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
204 lines
7.2 KiB
204 lines
7.2 KiB
5 years ago
|
Metadata-Version: 2.1
|
||
|
|
Name: marshmallow
|
||
|
|
Version: 2.20.5
|
||
|
|
Summary: A lightweight library for converting complex datatypes to and from native Python datatypes.
|
||
|
|
Home-page: https://github.com/marshmallow-code/marshmallow
|
||
|
|
Author: Steven Loria
|
||
|
|
Author-email: sloria1@gmail.com
|
||
|
|
License: MIT
|
||
|
|
Project-URL: Issues, https://github.com/marshmallow-code/marshmallow/issues
|
||
|
|
Project-URL: Funding, https://opencollective.com/marshmallow
|
||
|
|
Project-URL: Tidelift, https://tidelift.com/subscription/pkg/pypi-marshmallow?utm_source=pypi-marshmallow&utm_medium=pypi
|
||
|
|
Keywords: serialization,rest,json,api,marshal,marshalling,deserialization,validation,schema
|
||
|
|
Platform: UNKNOWN
|
||
|
|
Classifier: Development Status :: 5 - Production/Stable
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: License :: OSI Approved :: MIT License
|
||
|
|
Classifier: Programming Language :: Python :: 2
|
||
|
|
Classifier: Programming Language :: Python :: 2.7
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3.4
|
||
|
|
Classifier: Programming Language :: Python :: 3.5
|
||
|
|
Classifier: Programming Language :: Python :: 3.6
|
||
|
|
Classifier: Programming Language :: Python :: 3.7
|
||
|
|
Provides-Extra: dev
|
||
|
|
Requires-Dist: python-dateutil ; extra == 'dev'
|
||
|
|
Requires-Dist: simplejson ; extra == 'dev'
|
||
|
|
Requires-Dist: pytest ; extra == 'dev'
|
||
|
|
Requires-Dist: pytz ; extra == 'dev'
|
||
|
|
Requires-Dist: flake8 (==3.7.4) ; extra == 'dev'
|
||
|
|
Requires-Dist: tox ; extra == 'dev'
|
||
|
|
Provides-Extra: docs
|
||
|
|
Requires-Dist: sphinx (==2.1.2) ; extra == 'docs'
|
||
|
|
Requires-Dist: sphinx-issues (==1.2.0) ; extra == 'docs'
|
||
|
|
Requires-Dist: alabaster (==0.7.12) ; extra == 'docs'
|
||
|
|
Requires-Dist: sphinx-version-warning (==1.1.2) ; extra == 'docs'
|
||
|
|
Provides-Extra: lint
|
||
|
|
Requires-Dist: flake8 (==3.7.4) ; extra == 'lint'
|
||
|
|
Provides-Extra: reco
|
||
|
|
Requires-Dist: python-dateutil ; extra == 'reco'
|
||
|
|
Requires-Dist: simplejson ; extra == 'reco'
|
||
|
|
Provides-Extra: tests
|
||
|
|
Requires-Dist: pytest ; extra == 'tests'
|
||
|
|
Requires-Dist: pytz ; extra == 'tests'
|
||
|
|
|
||
|
|
********************************************
|
||
|
|
marshmallow: simplified object serialization
|
||
|
|
********************************************
|
||
|
|
|
||
|
|
.. image:: https://badge.fury.io/py/marshmallow.svg
|
||
|
|
:target: http://badge.fury.io/py/marshmallow
|
||
|
|
:alt: Latest version
|
||
|
|
|
||
|
|
.. image:: https://dev.azure.com/sloria/sloria/_apis/build/status/marshmallow-code.marshmallow?branchName=2.x-line
|
||
|
|
:target: https://dev.azure.com/sloria/sloria/_build/latest?definitionId=5&branchName=2.x-line
|
||
|
|
:alt: Build status
|
||
|
|
|
||
|
|
.. image:: https://readthedocs.org/projects/marshmallow/badge/
|
||
|
|
:target: https://marshmallow.readthedocs.io/
|
||
|
|
:alt: Documentation
|
||
|
|
|
||
|
|
**marshmallow** is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.
|
||
|
|
|
||
|
|
.. code-block:: python
|
||
|
|
|
||
|
|
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.7 or >= 3.4
|
||
|
|
|
||
|
|
marshmallow has no external dependencies outside of the Python standard library, although `python-dateutil <https://pypi.python.org/pypi/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
|
||
|
|
|
||
|
|
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 <https://marshmallow.readthedocs.io/en/latest/contributing.html>`_ to see how you can help.
|
||
|
|
|
||
|
|
Thank you to all who have already contributed to marshmallow!
|
||
|
|
|
||
|
|
.. image:: https://opencollective.com/marshmallow/contributors.svg?width=890&button=false
|
||
|
|
:target: https://marshmallow.readthedocs.io/en/latest/authors.html
|
||
|
|
:alt: 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`_]
|
||
|
|
|
||
|
|
.. _`Become a backer`: https://opencollective.com/marshmallow#backer
|
||
|
|
|
||
|
|
.. image:: https://opencollective.com/marshmallow/backers.svg?width=890
|
||
|
|
:target: https://opencollective.com/marshmallow#backers
|
||
|
|
:alt: Backers
|
||
|
|
|
||
|
|
Sponsors
|
||
|
|
--------
|
||
|
|
|
||
|
|
Support this project by becoming a sponsor (or ask your company to support this project by becoming a sponsor).
|
||
|
|
Your logo will show up here with a link to your website. [`Become a sponsor`_]
|
||
|
|
|
||
|
|
.. _`Become a sponsor`: https://opencollective.com/marshmallow#sponsor
|
||
|
|
|
||
|
|
.. image:: https://opencollective.com/marshmallow/sponsor/0/avatar.svg
|
||
|
|
:target: https://opencollective.com/marshmallow/sponsor/0/website
|
||
|
|
:alt: Sponsors
|
||
|
|
|
||
|
|
|
||
|
|
Professional Support
|
||
|
|
====================
|
||
|
|
|
||
|
|
Professionally-supported marshmallow is now available through the
|
||
|
|
`Tidelift Subscription <https://tidelift.com/subscription/pkg/pypi-marshmallow?utm_source=pypi-marshmallow&utm_medium=readme>`_.
|
||
|
|
|
||
|
|
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 professional support`: https://tidelift.com/subscription/pkg/pypi-marshmallow?utm_source=marshmallow&utm_medium=referral&utm_campaign=github
|
||
|
|
|
||
|
|
.. image:: https://user-images.githubusercontent.com/2379650/45126032-50b69880-b13f-11e8-9c2c-abd16c433495.png
|
||
|
|
:target: https://tidelift.com/subscription/pkg/pypi-marshmallow?utm_source=pypi-marshmallow&utm_medium=readme
|
||
|
|
:alt: Get supported marshmallow with Tidelift
|
||
|
|
|
||
|
|
Security Contact Information
|
||
|
|
============================
|
||
|
|
|
||
|
|
To report a security vulnerability, please use the
|
||
|
|
`Tidelift security contact <https://tidelift.com/security>`_.
|
||
|
|
Tidelift will coordinate the fix and disclosure.
|
||
|
|
|
||
|
|
Project Links
|
||
|
|
=============
|
||
|
|
|
||
|
|
- Docs: http://marshmallow.readthedocs.io/
|
||
|
|
- Changelog: http://marshmallow.readthedocs.io/en/latest/changelog.html
|
||
|
|
- Contributing Guidelines: https://marshmallow.readthedocs.io/en/latest/contributing.html
|
||
|
|
- PyPI: https://pypi.python.org/pypi/marshmallow
|
||
|
|
- Issues: https://github.com/marshmallow-code/marshmallow/issues
|
||
|
|
- Donate: https://opencollective.com/marshmallow
|
||
|
|
|
||
|
|
License
|
||
|
|
=======
|
||
|
|
|
||
|
|
MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/marshmallow/blob/dev/LICENSE>`_ file for more details.
|
||
|
|
|
||
|
|
|