Skip to main content

Convenient anonymous and nested schemas using dict literal syntax for Marshmallow.

Project description

Marshmallow Factory
===================


Inspired by [Voluptuous](https://github.com/alecthomas/voluptuous).

It's sometimes inconvenient to define named
[Marshmallow](https://github.com/marshmallow-code/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_)
```


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

marshmallow_factory-0.1.0.tar.gz (2.9 kB view hashes)

Uploaded source

Built Distribution

marshmallow_factory-0.1.0-py2.py3-none-any.whl (4.2 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page