grunmin / gpyschema

轻量的python数据格式校验方法 Lightweight data validation function for Python

gpyschema

轻量的python数据格式校验方法

使用JSON schema规则进行校验, 支持多数draft-4规则

python2.6,2.7 Only

Supported property

Type-specific keywords

• boolean
• integer
• number
• string
• object
• array
• null

Generic keywords

• title
• enum
• not
• type

Object keywords

• properties
• maxProperties
• minProperties
• required
• additionalProperties

Array keywords

• items
• maxItems
• minItems
• uniqueItems

String keywords

• maxLength
• minLength
• pattern
• format

Number&Integer

• maximum
• minimum

Custom String

• ipv4
• alnum
• alpha
• numeric
• digit
• email
• price
• date
• datetime
• json
• regex

Combining schemas

• anyOf

Nested Schema Supported

TODO

• add dependencies support
• full Combining schemas support

Example

from gpyschema import ValidationError, SchemaError, dv
schema = {
    'type': 'object',
    'properties': {
        'name': {'type': 'string', 'maxLength': 20, 'minLength': 2, 'format': 'alpha' },
        'cname': {'type': 'string', 'maxLength': 20, 'minLength': 2 },
        'category': {'type': 'string', 'maxLength': 20, 'minLength': 2, 'title': '分类' },
        'icon': {'type': 'string', 'maxLength': 50, 'minLength': 2},
        'visible': {'type': 'boolean'},
        'desc': {'type': 'string', 'maxLength': 100, 'minLength': 0, 'title': '描述信息'},
        'default': {'type': 'integer'},
        'order': {'type': 'integer', 'not': {'type': 'integer', 'enum': [12]}},
        'id': {'enum': [1, 23, 3]},
        'permission2': {'type': 'string', 'format': 'json'},
        'permission': {'type': 'object',
            'properties': {
                'c': {'type': 'array', 'minItems': 1},
                'r': {'type': 'array', 'minItems': 1},
                'u': {'type': 'array', 'minItems': 1},
                'd': {'type': 'array', 'minItems': 1},
            },
            'required': ['c', 'r', 'u', 'd']
        },
        'schema': {'type': 'object', 
            'properties': {
                '_and': {'$ref': 'Schema'},
                'c': {'type': 'array', 'minItems': 1},
            },
            'minProperties': 1,
            'patternProperties': {
                '^[a-zA-z]+$': {'$ref': 'Schema'},
                '^[a-zA-Z]+\.[a-zA-Z]+$': {'type': 'array', 'minItems': 1}
            },
            'additionalProperties': False,
        },
        'any': {
            'anyOf': [
                {'type': 'string'},
                {'type': 'integer'}
            ]
        }
    },
    'required': ['name', 'cname', 'category', 'icon', 'visible', 'desc', 'order', 'id', 'any']
}
data = {
    'category': u'基础资源管理', 
    'name': u'ip', 
    'permission': {"c": ["admin"], "r": ["admin"], "u": ["admin"], "d": ["admin"]},
    'permission2': '{"c": ["admin"], "r": ["admin"], "u": ["admin"], "d": ["admin"]}',
    'default': 1, 
    'order': 1, 
    'visible': True, 
    'cname': u'ip地址段', 
    'icon': u'glyphicon glyphicon-sort', 
    'id': 23L, 
    'desc': u'',
    'any': '111',
    'schema': {
        'c': {
            'category': u'基础资源管理', 
            'name': u'ip', 
            'permission': {"c": ["admin"], "r": ["admin"], "u": ["admin"], "d": ["admin"]},
            'permission2': '{"c": ["admin"], "r": ["admin"], "u": ["admin"], "d": ["admin"]}',
            'default': 1, 
            'order': 1, 
            'visible': True, 
            'cname': u'ip地址段', 
            'icon': u'glyphicon glyphicon-sort', 
            'id': 23L, 
            'desc': u'',
            'any': 1.1
        }
    }
}

try:
    dv.validate(schema, data, ref={'Schema': schema})
    print 'validation pass'
except (SchemaError, ValidationError) as e:
    print e

Test

git clone https://github.com/grunmin/gpyschema.git
cd gpyschema
python -m unittest tests.test_gpyschema

If you want to know the coverage of tested code, install package coverage first, then run(in windows)

coverage.exe run --omit=./tests/test_* -m tests.test_gpyschema