Metadata-Version: 2.1
Name: marshmallow-polyfield
Version: 5.9
Summary: An unofficial extension to Marshmallow to allow for polymorphic fields
Home-page: https://github.com/Bachmann1234/marshmallow-polyfield
Author: Matt Bachmann
Author-email: bachmann.matt@gmail.com
License: Apache 2.0
Description: =====================
        Marshmallow-Polyfield
        =====================
        
        .. image:: https://readthedocs.org/projects/marshmallow-polyfield/badge/?version=latest
            :target: https://readthedocs.org/projects/marshmallow-polyfield/?badge=latest
            :alt: Documentation Status
        .. image:: https://travis-ci.org/Bachmann1234/marshmallow-polyfield.svg?branch=master
            :target: https://travis-ci.org/Bachmann1234/marshmallow-polyfield
            :alt: Build Status
        .. image:: https://coveralls.io/repos/Bachmann1234/marshmallow-polyfield/badge.svg?branch=master&service=github
            :target: https://coveralls.io/github/Bachmann1234/marshmallow-polyfield?branch=master
            :alt: Coverage Status
        
        This branch supports Marshmallow 3.0 and above. For 2.0 support see `The 2.0 branch <https://github.com/Bachmann1234/marshmallow-polyfield/tree/polyfield-2support>`_ 
        
        An unofficial extension to Marshmallow to allow for polymorphic fields.
        
        Marshmallow is a fantastic library for serialization and deserialization of data.
        For more on that project see its `GitHub <https://github.com/marshmallow-code/marshmallow>`_ page or its `Documentation <http://marshmallow.readthedocs.org/en/latest/>`_.
        
        This project adds a custom field designed for polymorphic types. This allows you to define a schema that says "This field accepts anything of type X"
        
        The secret to this field is that you need to define two functions. One to be used when serializing, and another for deserializing. These functions
        take in the raw value and return the schema to use.
        
        This field should support the same properties as other Marshmallow fields. I have worked with *required* *allow_none* and *many*.
        
        Last version support v2 is tagged FINAL_V2_VERSION
        
        Installing
        ----------
        ::
        
            $ pip install marshmallow-polyfield
        
        Importing
        ---------
        Here is how to import the necessary field class
        ::
        
            from marshmallow_polyfield import PolyField
        
        Example
        -------
        
        The code below demonstrates how to setup a schema with a PolyField. For the full context check out the tests.
        Once setup the schema should act like any other schema. If it does not then please file an Issue.
        
        .. code:: python
        
            def shape_schema_serialization_disambiguation(base_object, parent_obj):
                class_to_schema = {
                    Rectangle.__name__: RectangleSchema,
                    Triangle.__name__: TriangleSchema
                }
                try:
                    return class_to_schema[base_object.__class__.__name__]()
                except KeyError:
                    pass
        
                raise TypeError("Could not detect type. "
                                "Did not have a base or a length. "
                                "Are you sure this is a shape?")
        
        
            def shape_schema_deserialization_disambiguation(object_dict, parent_object_dict):
                if object_dict.get("base"):
                    return TriangleSchema()
                elif object_dict.get("length"):
                    return RectangleSchema()
        
                raise TypeError("Could not detect type. "
                                "Did not have a base or a length. "
                                "Are you sure this is a shape?")
        
        
            class ContrivedShapeClass(object):
                def __init__(self, main, others):
                    self.main = main
                    self.others = others
        
                def __eq__(self, other):
                    return self.__dict__ == other.__dict__
        
        
            class ContrivedShapeClassSchema(Schema):
                main = PolyField(
                    serialization_schema_selector=shape_schema_serialization_disambiguation,
                    deserialization_schema_selector=shape_schema_deserialization_disambiguation,
                    required=True
                )
                others = PolyField(
                    serialization_schema_selector=shape_schema_serialization_disambiguation,
                    deserialization_schema_selector=shape_schema_deserialization_disambiguation,
                    allow_none=True,
                    many=True
                )
        
                @post_load
                def make_object(self, data):
                    return TestPolyField.ContrivedShapeClass(
                        data.get('main'),
                        data.get('others')
                    )
        
Keywords: serialization,rest,json,api,marshal,marshalling,deserialization,validation,schema
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
