devinaconley / py-object-factory Goto Github PK

View Code? Open in Web Editor NEW

objectfactory is a python package to easily implement the factory design pattern for object creation, serialization, and polymorphism

License: MIT License

Python 100.00%

py-object-factory's Introduction

py-object-factory

objectfactory is a python package to easily implement the factory design pattern for object creation, serialization, and polymorphism

designed to support polymorphism
integrates seamlessly with marshmallow and other serialization frameworks
schema inherent in class definition
load any object with a generic interface
serialize objects to JSON

Example

Simple shapes example:

import objectfactory

@objectfactory.register
class Square(objectfactory.Serializable):
    side = objectfactory.Field()

    def get_area(self):
        return self.side * self.side

@objectfactory.register
class Triangle(objectfactory.Serializable):
    base = objectfactory.Field()
    height = objectfactory.Field()

    def get_area(self):
        return 0.5 * self.base * self.height

serialized_data = [
    {"_type": "Square", "side": 2.0},
    {"_type": "Triangle", "base": 1.75, "height": 2.50},
    {"_type": "Square", "side": 1.5},
]

for data in serialized_data:
    shape = objectfactory.create(data)
    print('class type: {}, shape area: {}'.format(type(shape), shape.get_area()))

Output:

class type: <class '__main__.Square'>, shape area: 4.0
class type: <class '__main__.Triangle'>, shape area: 2.1875
class type: <class '__main__.Square'>, shape area: 2.25