voluptuous-serialize's Introduction

Voluptuous Serialize

Convert Voluptuous schemas to dictionaries so they can be serialized.

from collections import OrderedDict

# Use OrderedDict instead of dict.
# Only starting Python 3.6+ are dictionaries ordered.
schema = OrderedDict()
schema[vol.Required('name')] = vol.All(str, vol.Length(min=5))
schema[vol.Required('age')] = vol.All(vol.Coerce(int), vol.Range(min=18))
schema[vol.Optional('hobby', default='not specified')] = str
schema = vol.Schema(schema)

becomes

(dictionaries become lists to guarantee order of properties)

[
  {
    "name": "name",
    "type": "string",
    "lengthMin": 5,
    "required": true,
  },
  {
    "name": "age",
    "type": "integer",
    "valueMin": 18,
    "required": true,
  },
  {
    "name": "hobby",
    "type": "string",
    "default": "not specified",
    "optional": true,
  }
]

See the tests for more examples.

Custom serializer

You can pass a custom serializer to be able to process custom validators. If the serializer returns UNSUPPORTED, it will return to normal processing.

from voluptuous_serialize import UNSUPPORTED, convert

def custom_convert(value):
    if value is my_custom_validator:
        return {'type': 'custom_validator'}
        
    return UNSUPPORTED

convert(value, custom_serializer=custom_convert)

voluptuous-serialize's People

Contributors

Stargazers

Watchers

voluptuous-serialize's Issues

maybe wrong 2.3.0 tag?

Hi,

while you tagged 054be24 as 2.3.0, the actual version update happened one commit later (dc55dcc).

Was this intentional?

General better support for different types and advanced vol options

See discussions in #2

I have a very big and advanced schema containing things like:

{
        Required('triggers', default=defaults): {
            Required('run', default=defaults['run']): bool,
            Optional('time'): All(
                list, Unique(),
                Length(min=1), [
                    validators.Regex(r'^[0-2][0-9][0-5][0-9]$')
                ]
            ),
            Optional('every-x-seconds'): All(
                int, Range(min=5, max=60 * 60 * 24 * 7)
            )
        }
    }