Validictory

aconrad 918 views 10 slides May 02, 2011
Slide 1
Slide 1 of 10
Slide 1
1
Slide 2
2
Slide 3
3
Slide 4
4
Slide 5
5
Slide 6
6
Slide 7
7
Slide 8
8
Slide 9
9
Slide 10
10

About This Presentation

"Validictory" lightning talk given at the Pylons Mini Conf at Yelp in San Francisco, by Alexandre Conrad, on April 29 2011.


Slide Content

Validictory
JSON schema validator
Alex Conrad
Code Monkey, SurveyMonkey
@alexconrad
Pylons miniconf – April 29, 2011
Pylons miniconf

What is validictory?
A simple Python library to validate JSON data.

What do you use it for?
Validate web service APIs
that talk JSON.

How does it work?
One function. Two arguments.
>>> import validictory
>>> validictory.validate(data, schema)

How does it work?
What is ``data`` ?
A Python datatype loaded from JSON data.
>>> import json
>>> data = json.loads(request.body)

How does it work?
What is ``schema`` ?
A Python dictionary describing how the data
should be formed.
>>> schema = {”type”: ”string”,
...           ”minLength”: 2,
...           ”maxLength”: 2}

How does it work?
Invalid data.
>>> validictory.validate(”USA”, schema)
Traceback (most recent call last):
ValidationError: Length of value 'USA' for 
field '_data' must be less than or equal 
to 2

How does it work?
Re-usable schemas, just plain Python.
>>> country = {”type”: ”string”,
...            ”minLength”: 2,
...            ”maxLength”: 2}
>>> address = {”type”: ”object”,
...     ”properties”: {
...         ”street”: {”type”:”string”},
...         ”country”:  country}}

References
pypi.python.org/pypi/validictory
json-schema.org

Questions?
Thank you.
@alexconrad