README.md

Marshmallow Factory

Installation

pip install marshmallow-factory

Overview

Inspired by Voluptuous.

It's sometimes inconvenient to define named Marshmallow Schemas, especially when those schemas are deeply nested.

Example:

class InnerSchema(Schema):
    inner_bool = Boolean()


class MiddleSchema(Schema):
    middle_int = Integer()
    middle_nested = Nested(InnerSchema)


class OuterSchema(Schema):
    outer_str = String()
    outer_nested = Nested(MiddleSchema)


schema_instance = OuterSchema()
schema_instance.validate(input_)

So, this library provides a convenient syntax for defining deeply nested Schemas.

from marshmallow_factory import schema

OuterSchema = schema({
    'outer_str': String(),
    'outer_nested': Nested(schema({
        'middle_int': Integer(),
        'middle_nested': Nested(schema({
            'inner_bool': Boolean()
        }))
    }))
})

schema_instance = OuterSchema()
schema_instance.validate(input_)

Support For Meta Options

Meta options are supported using the following syntax:

class Meta:
    strict = True  # or your other options

my_schema = schema({
    'Meta': Meta,
    'str': String()
})

Alternative Syntax

Schema factory arguments can also be supplied as keyword arguments rather than a dictionary.

my_schema = schema(Meta=Meta, str=String())

For nested Schemas, plain dictionary literals can be provided instead of Nested(schema({...}).

from marshmallow_factory import schema

OuterSchema = schema({
    'outer_str': String(),
    'outer_nested': {
        'middle_int': Integer(),
        'middle_nested': {
            'inner_bool': Boolean()
        }
    }
})

schema_instance = OuterSchema()
schema_instance.validate(input_)