Skip to content

Deepwalker/trafaret_schema

Repository files navigation

Trafaret Schema

Build status Gitter Downloads Downloads

Library takes JSON Schema and converts it to a Trafaret instance:

from trafaret_schema import json_schema
check_string = json_schema({'type': 'string', 'minLength': 6, 'maxLength': 10, 'pattern': '(bla)+'})
check_string('blablabla')

What is important to note, that this library is a big trafaret that produces other trafarets. So on parsing JSON Schema you can get a DataError, and you will get DataError in usage of parsed schema. And you can use schema parser or parsed schema as trafaret in any circumstances where you can use trafarets.

You can use Register object to provide custom format implementation and to support cross schemas $ref objects:

import trafaret as t
from trafaret_schema import json_schema, Register

my_reg = Register()

my_reg.reg_format('any_ip', t.IPv4 | t.IPv6)

check_address = json_schema(open('address.json').read(), context=register)
check_person = json_schema(open('person.json').read(), context=register)

Library is a bit of fun, because it is implemented in a trafaret and produces trafaret instances. Also its like a pro level of trafaret usage (I hope so).

Features:

[*] basic
    [*] type
    [*] enum
    [*] const
    [*] number
    [*] string
[*] array
    [*] minProperties
    [*] maxProperties
    [*] uniqueItems
    [*] items
    [*] additionalItems
    [*] contains
[*] objects
    [*] maxProperties
    [*] minProperties
    [*] required
    [*] properties
    [*] patternProperties
    [*] additionalProperties
    [*] dependencies
    [*] propertyNames
[*] combinators
    [*] anyOf
    [*] allOf
    [*] oneOf
    [*] not
[*] format
[*] references
    [*] definitions
    [*] $ref