schematec 0.3.4

Quickstart

import schematec as s

schema = s.dictionary(
   id=[s.integer, s.required],
   name=s.string,
   tags=s.array(s.string),
)

>>> data = {
...     'id': '1',
...     'name': 'Red Hot Chili Peppers',
...     'tags': ['funk', 'rock'],
...     'rank': '1',
... }
>>> schema(data)
{'id': 1, 'name': u'Red Hot Chili Peppers', 'tags': [u'funk', u'rock']}

Concepts

Schematec module is based on three basic concepts:

• Schema

• Validator

• Converter

Recursive schema

import schematec as s

schema = s.dictionary(
    id=[s.integer, s.required],
    entity=s.dictionary(
        name=[s.string, s.required],
        value=s.string,
    )
)

>>> data = {
...     'id': 1,
...     'entity': {
...         'name': 'song',
...         'value': 'californication',
...     }
... }
>>> schema(data)
{'id': 1, 'entity': {'name': u'song', 'value': u'californication'}}

Errors handling

import schematec as s

schema = s.dictionary(
    id=[s.integer, s.required],
    entity=s.dictionary(
        name=[s.string, s.required],
        value=s.string,
    )
)

>>> data = {
...     'id': 1,
...     'entity': {
...         'value': 'californication',
...     }
... }
>>> schema(data)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "schematec/schema.py", line 44, in __call__
    value = schema(value, strict=strict)
  File "schematec/schema.py", line 32, in __call__
    validator(name, data)
  File "schematec/validators.py", line 12, in __call__
    raise exc.ValidationError(name)
schematec.exc.ValidationError: name

Sugar descriptors

import schematec as s

schema = s.dictionary(
    id=s.integer & s.required,
    entity=s.dictionary(
        name=s.string & s.required,
        value=s.string,
    )
)