pax_global_header00006660000000000000000000000064140150471750014516gustar00rootroot0000000000000052 comment=399fc9ccce5b21086a67476c308ccc62dd6e8b08 marshmallow-polyfield-5.10/000077500000000000000000000000001401504717500157565ustar00rootroot00000000000000marshmallow-polyfield-5.10/.gitignore000066400000000000000000000013121401504717500177430ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] # C extensions *.so venv .idea # Distribution / packaging .Python env/ build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ *.egg-info/ .installed.cfg *.egg # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *,cover # Translations *.mo *.pot # Django stuff: *.log # Sphinx documentation docs/_build/ # PyBuilder target/ marshmallow-polyfield-5.10/.travis.yml000066400000000000000000000004751401504717500200750ustar00rootroot00000000000000dist: xenial language: python sudo: false matrix: include: - python: '3.5' - python: '3.6' - python: '3.7' - python: '3.8' - python: pypy3 dist: trusty before_install: - pip install -U pip install: - pip install -U -r requirements.txt before_script: - flake8 . script: pytest after_success: coveralls marshmallow-polyfield-5.10/LICENSE000066400000000000000000000261361401504717500167730ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. marshmallow-polyfield-5.10/MANIFEST.in000066400000000000000000000000261401504717500175120ustar00rootroot00000000000000include *.rst LICENSE marshmallow-polyfield-5.10/README.rst000066400000000000000000000073441401504717500174550ustar00rootroot00000000000000===================== Marshmallow-Polyfield ===================== .. image:: https://travis-ci.com/Bachmann1234/marshmallow-polyfield.svg?branch=master :target: https://travis-ci.com/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 `_ 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 `_ page or its `Documentation `_. 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') ) marshmallow-polyfield-5.10/marshmallow_polyfield/000077500000000000000000000000001401504717500223535ustar00rootroot00000000000000marshmallow-polyfield-5.10/marshmallow_polyfield/__init__.py000066400000000000000000000001571401504717500244670ustar00rootroot00000000000000from marshmallow_polyfield.polyfield import PolyField, PolyFieldBase __all__ = ['PolyField', 'PolyFieldBase'] marshmallow-polyfield-5.10/marshmallow_polyfield/polyfield.py000066400000000000000000000111701401504717500247140ustar00rootroot00000000000000import abc from marshmallow import Schema, ValidationError from marshmallow.fields import Field class PolyFieldBase(Field, metaclass=abc.ABCMeta): def __init__(self, many=False, **metadata): super().__init__(**metadata) self.many = many def _deserialize(self, value, attr, parent, partial=None, **kwargs): if not self.many: value = [value] results = [] for v in value: deserializer = None try: deserializer = self.deserialization_schema_selector(v, parent) if isinstance(deserializer, type): deserializer = deserializer() if not isinstance(deserializer, (Field, Schema)): raise Exception('Invalid deserializer type') except TypeError as te: raise ValidationError(str(te)) from te except ValidationError: raise except Exception as err: class_type = None if deserializer: class_type = str(type(deserializer)) raise ValidationError( "Unable to use schema. Error: {err}\n" "Ensure there is a deserialization_schema_selector" " and then it returns a field or a schema when the function is passed in " "{value_passed}. This is the class I got. " "Make sure it is a field or a schema: {class_type}".format( err=err, value_passed=v, class_type=class_type ) ) from err # Will raise ValidationError if any problems if isinstance(deserializer, Field): data = deserializer.deserialize(v, attr, parent) else: deserializer.context.update(getattr(self, 'context', {})) data = deserializer.load(v, partial=partial) results.append(data) if self.many: return results else: # Will be at least one otherwise value would have been None return results[0] def _serialize(self, value, key, obj, **kwargs): if value is None: return None try: if self.many: res = [] for v in value: schema = self.serialization_schema_selector(v, obj) schema.context.update(getattr(self, 'context', {})) res.append(schema.dump(v)) return res else: schema = self.serialization_schema_selector(value, obj) schema.context.update(getattr(self, 'context', {})) return schema.dump(value) except Exception as err: raise TypeError( 'Failed to serialize object. Error: {0}\n' ' Ensure the serialization_schema_selector exists and ' ' returns a Schema and that schema' ' can serialize this value {1}'.format(err, value)) @abc.abstractmethod def serialization_schema_selector(self, value, obj): raise NotImplementedError @abc.abstractmethod def deserialization_schema_selector(self, value, obj): raise NotImplementedError class PolyField(PolyFieldBase): """ A field that (de)serializes to one of many types. Passed in functions are called to disambiguate what schema to use for the (de)serialization Intended to assist in working with fields that can contain any subclass of a base type """ def __init__( self, serialization_schema_selector=None, deserialization_schema_selector=None, many=False, **metadata ): """ :param serialization_schema_selector: Function that takes in either an object representing that object, it's parent object and returns the appropriate schema. :param deserialization_schema_selector: Function that takes in either an a dict representing that object, dict representing it's parent dict and returns the appropriate schema """ super().__init__(many=many, **metadata) self._serialization_schema_selector_arg = serialization_schema_selector self._deserialization_schema_selector_arg = deserialization_schema_selector def serialization_schema_selector(self, value, obj): return self._serialization_schema_selector_arg(value, obj) def deserialization_schema_selector(self, value, obj): return self._deserialization_schema_selector_arg(value, obj) marshmallow-polyfield-5.10/requirements.txt000066400000000000000000000001561401504717500212440ustar00rootroot00000000000000coverage>=3.7.1 coveralls>=0.5 flake8>=2.4.1 marshmallow>=3.0.0b10 pytest>=2.7.2 pytest-cov>=2.1.0 tox>=2.1.1 marshmallow-polyfield-5.10/setup.cfg000066400000000000000000000002141401504717500175740ustar00rootroot00000000000000[flake8] exclude = venv,.tox,build max-line-length = 100 [tool:pytest] addopts = --cov=marshmallow_polyfield [coverage:run] branch = True marshmallow-polyfield-5.10/setup.py000066400000000000000000000024261401504717500174740ustar00rootroot00000000000000#!/usr/bin/env python import os from setuptools import setup def read(fname): with open(os.path.join(os.path.abspath(os.path.dirname(__file__)), fname), 'r') as infile: content = infile.read() return content setup( name='marshmallow-polyfield', version='5.10', description='An unofficial extension to Marshmallow to allow for polymorphic fields', long_description=read('README.rst'), long_description_content_type='text/x-rst', author='Matt Bachmann', author_email='bachmann.matt@gmail.com', url='https://github.com/Bachmann1234/marshmallow-polyfield', packages=['marshmallow_polyfield'], license='Apache 2.0', keywords=['serialization', 'rest', 'json', 'api', 'marshal', 'marshalling', 'deserialization', 'validation', 'schema'], python_requires='>=3.5', install_requires=['marshmallow>=3.0.0b10'], classifiers=[ 'Intended Audience :: Developers', 'License :: OSI Approved :: Apache Software License', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', ], ) marshmallow-polyfield-5.10/tests/000077500000000000000000000000001401504717500171205ustar00rootroot00000000000000marshmallow-polyfield-5.10/tests/__init__.py000066400000000000000000000000001401504717500212170ustar00rootroot00000000000000marshmallow-polyfield-5.10/tests/polyclasses.py000066400000000000000000000021451401504717500220350ustar00rootroot00000000000000from marshmallow_polyfield import PolyFieldBase from tests.shapes import ( shape_schema_serialization_disambiguation, shape_property_schema_serialization_disambiguation, shape_schema_deserialization_disambiguation, shape_property_schema_deserialization_disambiguation ) def with_all(*args): def wrapper(func): def wrapped(*args_): return [ func(*(args_ + (a,))) for a in args ] return wrapped return wrapper class ShapePolyField(PolyFieldBase): def serialization_schema_selector(self, value, obj): return shape_schema_serialization_disambiguation(value, obj) def deserialization_schema_selector(self, value, obj): return shape_schema_deserialization_disambiguation(value, obj) class ShapePropertyPolyField(PolyFieldBase): def serialization_schema_selector(self, value, obj): return shape_property_schema_serialization_disambiguation(value, obj) def deserialization_schema_selector(self, value, obj): return shape_property_schema_deserialization_disambiguation(value, obj) marshmallow-polyfield-5.10/tests/shapes.py000066400000000000000000000065321401504717500207630ustar00rootroot00000000000000from marshmallow import Schema, fields, post_load, ValidationError class Shape(object): def __init__(self, color): self.color = color def __eq__(self, other): return self.__dict__ == other.__dict__ class ShapeSchema(Schema): color = fields.Str(allow_none=True) @post_load def make_object(self, data, **_): return Shape(**data) class Triangle(Shape): def __init__(self, color, base, height): super().__init__(color) self.base = base self.height = height class TriangleSchema(ShapeSchema): base = fields.Int(required=True) height = fields.Int(required=True) @post_load def make_object(self, data, **_): return Triangle( color=data['color'], base=data['base'], height=data['height'] ) class Rectangle(Shape): def __init__(self, color, length, width): super().__init__(color) self.length = length self.width = width class RectangleSchema(ShapeSchema): length = fields.Int(required=True) width = fields.Int(required=True) @post_load def make_object(self, data, **_): return Rectangle( color=data['color'], length=data['length'], width=data['width'] ) def shape_schema_serialization_disambiguation(base_object, _): 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_property_schema_serialization_disambiguation(base_object, obj): type_to_schema = { 'rectangle': RectangleSchema, 'triangle': TriangleSchema } try: return type_to_schema[obj.type]() 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, _): if object_dict.get("base"): if object_dict.get("base") < 0: raise ValidationError("Base cannot be negative.") return TriangleSchema() elif object_dict.get("length"): if object_dict.get("length") < 0: raise Exception("Bad Case") return RectangleSchema() raise TypeError("Could not detect type. " "Did not have a base or a length. " "Are you sure this is a shape?") def shape_property_schema_deserialization_disambiguation(object_dict, data): type_to_schema = { 'rectangle': RectangleSchema, 'triangle': TriangleSchema } try: return type_to_schema[data['type']]() 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 fuzzy_schema_deserialization_disambiguation(data, _): if isinstance(data, dict): return ShapeSchema if isinstance(data, str): return fields.Email raise TypeError('Could not detect type. ' 'Are you sure this is a shape or an email?') marshmallow-polyfield-5.10/tests/test_deserialization.py000066400000000000000000000235531401504717500237270ustar00rootroot00000000000000from marshmallow import Schema, ValidationError, post_load, fields from marshmallow_polyfield.polyfield import PolyField, PolyFieldBase import pytest from tests.shapes import ( Shape, Rectangle, Triangle, shape_schema_serialization_disambiguation, shape_property_schema_serialization_disambiguation, shape_schema_deserialization_disambiguation, shape_property_schema_deserialization_disambiguation, fuzzy_schema_deserialization_disambiguation, ) from tests.polyclasses import ( ShapePolyField, ShapePropertyPolyField, with_all ) def _bad_deserializer_disambiguation(self, _): return 1 class BadClassPolyField(PolyFieldBase): def serialization_schema_selector(self, value, obj): return _bad_deserializer_disambiguation(value, obj) def deserialization_schema_selector(self, value, obj): return _bad_deserializer_disambiguation(value, obj) class TestPolyField(object): class BadContrivedClassSchema(Schema): main = PolyField( serialization_schema_selector=_bad_deserializer_disambiguation, deserialization_schema_selector=_bad_deserializer_disambiguation, required=True ) others = PolyField( serialization_schema_selector=_bad_deserializer_disambiguation, deserialization_schema_selector=_bad_deserializer_disambiguation, allow_none=True, many=True ) class BadContrivedSubclassSchema(Schema): main = BadClassPolyField(required=True) others = BadClassPolyField(allow_none=True, many=True) 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') ) class FuzzySchema(Schema): data = PolyField( deserialization_schema_selector=fuzzy_schema_deserialization_disambiguation, many=True ) class ContrivedShapeSubclassSchema(Schema): main = ShapePolyField(required=True) others = ShapePolyField(allow_none=True, many=True) @post_load def make_object(self, data, **_): return TestPolyField.ContrivedShapeClass( data.get('main'), data.get('others') ) @with_all( ContrivedShapeClassSchema, ContrivedShapeSubclassSchema, ) def test_deserialize_polyfield(self, schema): original = self.ContrivedShapeClass( Rectangle('blue', 1, 100), [Rectangle('pink', 4, 93), Triangle('red', 8, 45)] ) data = schema().load( {'main': {'color': 'blue', 'length': 1, 'width': 100}, 'others': [ {'color': 'pink', 'length': 4, 'width': 93}, {'color': 'red', 'base': 8, 'height': 45}]} ) assert data == original @with_all( ContrivedShapeClassSchema, ContrivedShapeSubclassSchema, ) def test_deserialize_polyfield_none(self, schema): original = self.ContrivedShapeClass( Rectangle("blue", 1, 100), None ) data = schema().load( {'main': {'color': 'blue', 'length': 1, 'width': 100}, 'others': None} ) assert data == original @with_all( ContrivedShapeClassSchema, ContrivedShapeSubclassSchema, ) def test_deserailize_polyfield_none_required(self, schema): with pytest.raises(ValidationError): schema().load( {'main': None, 'others': None} ) @with_all( ContrivedShapeClassSchema, ContrivedShapeSubclassSchema, ) def test_deserialize_polyfield_invalid_type_error(self, schema): with pytest.raises(ValidationError) as excinfo: schema().load( {'main': {'color': 'blue', 'something': 4}, 'others': None} ) assert str(excinfo.value) == str("{'main': ['Could not detect type. " "Did not have a base or a length. " "Are you sure this is a shape?']}") @with_all( ContrivedShapeClassSchema, ContrivedShapeSubclassSchema, ) def test_deserialize_polyfield_invalid_validation_error(self, schema): with pytest.raises(ValidationError) as excinfo: schema().load( {'main': {'base': -1, 'something': 4}, 'others': None} ) assert str(excinfo.value) == "{'main': ['Base cannot be negative.']}" @with_all( ContrivedShapeClassSchema, ContrivedShapeSubclassSchema, ) def test_deserialize_polyfield_invalid_generic_error(self, schema): err_msg = 'Ensure there is a deserialization_schema_selector' with pytest.raises(ValidationError, match=err_msg): schema().load( {'main': {'width': 100, 'length': -1}, 'others': {'width': 100, 'length': 10}} ) @with_all( BadContrivedClassSchema, BadContrivedSubclassSchema, ) def test_deserialize_polyfield_invalid_schema_returned_is_invalid(self, schema): with pytest.raises(ValidationError): schema().load( {'main': {'color': 'blue', 'something': 4}, 'others': None} ) @with_all( ContrivedShapeClassSchema, ContrivedShapeSubclassSchema, ) def test_deserialize_polyfield_errors(self, schema): with pytest.raises(ValidationError): schema().load( {'main': {'color': 'blue', 'length': 'four', 'width': 4}, 'others': None} ) def test_fuzzy_schema(self): color = 'cyan' email = 'dummy@example.com' expected_data = {'data': [Shape(color), email]} data = self.FuzzySchema().load({'data': [{'color': color}, email]}) assert data == expected_data class TestPolyFieldDisambiguationByProperty(object): class ContrivedShapeClass(object): def __init__(self, main, others, type): self.main = main self.others = others self.type = type def __eq__(self, other): return self.__dict__ == other.__dict__ class ContrivedShapeClassSchema(Schema): main = PolyField( serialization_schema_selector=shape_property_schema_serialization_disambiguation, deserialization_schema_selector=shape_property_schema_deserialization_disambiguation, required=True ) others = PolyField( serialization_schema_selector=shape_property_schema_serialization_disambiguation, deserialization_schema_selector=shape_property_schema_deserialization_disambiguation, allow_none=True, many=True ) type = fields.String(required=True) @post_load def make_object(self, data, **_): return TestPolyFieldDisambiguationByProperty.ContrivedShapeClass( data.get('main'), data.get('others'), data.get('type') ) class ContrivedShapeSubclassSchema(Schema): main = ShapePropertyPolyField(required=True) others = ShapePropertyPolyField(allow_none=True, many=True) type = fields.String(required=True) @post_load def make_object(self, data, **_): return TestPolyFieldDisambiguationByProperty.ContrivedShapeClass( data.get('main'), data.get('others'), data.get('type') ) @with_all( ContrivedShapeClassSchema, ContrivedShapeSubclassSchema, ) def test_deserialize_polyfield(self, schema): original = self.ContrivedShapeClass( Rectangle('blue', 1, 100), [Rectangle('pink', 4, 93), Rectangle('red', 3, 90)], 'rectangle' ) data = schema().load( {'main': {'color': 'blue', 'length': 1, 'width': 100}, 'others': [ {'color': 'pink', 'length': 4, 'width': 93}, {'color': 'red', 'length': 3, 'width': 90}], 'type': 'rectangle'} ) assert data == original def test_deserialize_polyfield_partial_loading(): class CircleSchema(Schema): color = fields.Str(required=True) radius = fields.Int(required=True) class PartialLoadingShapeSchema(Schema): shape = PolyField( deserialization_schema_selector=lambda _, __: CircleSchema, required=True ) data = {'shape': {'radius': 1}} assert PartialLoadingShapeSchema().load(data, partial=True) == data assert PartialLoadingShapeSchema(partial=True).load(data) == data assert PartialLoadingShapeSchema().load(data, partial=("shape.color", )) == data marshmallow-polyfield-5.10/tests/test_polyfield_base.py000066400000000000000000000013041401504717500235100ustar00rootroot00000000000000from marshmallow_polyfield.polyfield import PolyFieldBase class TrivialExample(PolyFieldBase): def serialization_schema_selector(self, value, obj): super().serialization_schema_selector(value, obj) def deserialization_schema_selector(self, value, obj): super().deserialization_schema_selector(value, obj) def test_polyfield_base(): te = TrivialExample() try: te.serialization_schema_selector(None, None) except NotImplementedError: pass else: assert False, 'expected to raise' try: te.deserialization_schema_selector(None, None) except NotImplementedError: pass else: assert False, 'expected to raise' marshmallow-polyfield-5.10/tests/test_serialization.py000066400000000000000000000060261401504717500234120ustar00rootroot00000000000000from collections import namedtuple from marshmallow import fields, Schema from marshmallow_polyfield.polyfield import PolyField import pytest from tests.shapes import ( Rectangle, Triangle, shape_schema_serialization_disambiguation, shape_schema_deserialization_disambiguation, ) from tests.polyclasses import ShapePolyField, with_all def with_both_shapes(func): return with_all( PolyField( serialization_schema_selector=shape_schema_serialization_disambiguation, deserialization_schema_selector=shape_schema_deserialization_disambiguation ), ShapePolyField() )(func) def test_serializing_named_tuple(): Point = namedtuple('Point', ['x', 'y']) field = fields.Field() p = Point(x=4, y=2) assert field.serialize('x', p) == 4 def test_serializing_named_tuple_with_meta(): Point = namedtuple('Point', ['x', 'y']) p = Point(x=4, y=2) class PointSerializer(Schema): class Meta: fields = ('x', 'y') serialized = PointSerializer().dump(p) assert serialized['x'] == 4 assert serialized['y'] == 2 @with_both_shapes def test_serializing_polyfield_rectangle(field): rect = Rectangle("blue", 4, 10) Sticker = namedtuple('Sticker', ['shape', 'image']) marshmallow_sticker = Sticker(rect, "marshmallow.png") rect_dict = field.serialize('shape', marshmallow_sticker) assert rect_dict == {"length": 4, "width": 10, "color": "blue"} @with_both_shapes def test_serializing_polyfield_None(field): Sticker = namedtuple('Sticker', ['shape', 'image']) marshmallow_sticker = Sticker(None, "marshmallow.png") rect_dict = field.serialize('shape', marshmallow_sticker) assert rect_dict is None @with_all( PolyField( serialization_schema_selector=shape_schema_serialization_disambiguation, deserialization_schema_selector=shape_schema_deserialization_disambiguation, many=True ), ShapePolyField(many=True) ) def test_serializing_polyfield_many(field): rect = Rectangle("blue", 4, 10) tri = Triangle("red", 1, 100) StickerCollection = namedtuple('StickerCollection', ['shapes', 'image']) marshmallow_sticker_collection = StickerCollection([rect, tri], "marshmallow.png") shapes = field.serialize('shapes', marshmallow_sticker_collection) expected_shapes = [ {"length": 4, "width": 10, "color": "blue"}, {"base": 1, "height": 100, "color": "red"} ] assert shapes == expected_shapes @with_both_shapes def test_invalid_polyfield(field): Sticker = namedtuple('Sticker', ['shape', 'image']) with pytest.raises(TypeError): field.serialize('shape', Sticker(3, 3)) @with_both_shapes def test_serializing_polyfield_by_parent_type(field): rect = Rectangle("blue", 4, 10) Sticker = namedtuple('Sticker', ['shape', 'image', 'type']) marshmallow_sticker = Sticker(rect, "marshmallow.png", 'rectangle') rect_dict = field.serialize('shape', marshmallow_sticker) assert rect_dict == {"length": 4, "width": 10, "color": "blue"} marshmallow-polyfield-5.10/tox.ini000066400000000000000000000001661401504717500172740ustar00rootroot00000000000000[tox] envlist=py35,py36,py37,py38,pypy3 [testenv] deps= -rrequirements.txt commands= flake8 . py.test tests