jsonschema

jsonschema is an implementation of JSON Schema (currently in Draft 3) for Python (supporting 2.6+ including Python 3).

>>> from jsonschema import validate

>>> # A sample schema, like what we'd get from json.load()
>>> schema = {
...     "type" : "object",
...     "properties" : {
...         "price" : {"type" : "number"},
...         "name" : {"type" : "string"},
...     },
... }

>>> # If no exception is raised by validate(), the instance is valid.
>>> validate({"name" : "Eggs", "price" : 34.99}, schema)

>>> validate(
...     {"name" : "Eggs", "price" : "Invalid"}, schema
... )                                   # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
    ...
ValidationError: 'Invalid' is not of type 'number'

Features

Support for Draft 3 of the Schema with the exception of
- $ref, and extends that use $refs
Lazy validation that can iteratively report all validation errors.

>>> from jsonschema import Validator
>>> schema = {
...     "type" : "array",
...     "items" : {"enum" : [1, 2, 3]},
...     "maxItems" : 2,
... }
>>> v = Validator()
>>> for error in sorted(v.iter_errors([2, 3, 4], schema), key=str):
...     print(error)
4 is not one of [1, 2, 3]
[2, 3, 4] is too long

Small and extensible
Programmatic querying of which properties or items failed validation.

>>> from jsonschema import ErrorTree, Validator
>>> schema = {
...     "type" : "array",
...     "items" : {"type" : "number", "enum" : [1, 2, 3]},
...     "minItems" : 3,
... }
>>> instance = ["spam", 2]
>>> v = Validator()
>>> tree = ErrorTree(v.iter_errors(instance, schema))

>>> sorted(tree.errors)
['minItems']

>>> 0 in tree
True

>>> 1 in tree
False

>>> sorted(tree[0].errors)
['enum', 'type']

>>> print(tree[0].errors["type"].message)
'spam' is not of type 'number'

Schema Versioning

JSON Schema is, at the time of this writing, seemingly at Draft 3, with preparations for Draft 4 underway. The Validator class and validate function take a version argument that you can use to specify what version of the Schema you are validating under.

As of right now, Draft 3 (jsonschema.DRAFT_3) is the only supported version, and the default when validating. Whether it will remain the default version in the future when it is superceeded is undecided, so if you want to be safe, explicitly declare which version to use when validating.

Release Notes

0.6 fixes the behavior for the dependencies property, which was mis-implemented.

Running the Test Suite

jsonschema uses the wonderful Tox for its test suite. (It really is wonderful, if for some reason you haven’t heard of it, you really should use it for your projects).

Assuming you have tox installed (perhaps via pip install tox or your package manager), just run tox in the directory of your source checkout to run jsonschema’s test suite on all of the versions of Python jsonschema supports. Note that you’ll need to have all of those versions installed in order to run the tests on each of them, otherwise tox will skip (and fail) the tests on that version.

Contributing

I’m Julian Berman.

jsonschema is on GitHub.

Get in touch, via GitHub or otherwise, if you’ve got something to contribute, it’d be most welcome!

You can also generally find me on Freenode (nick: tos9) in various channels, including #python.

Release files for jsonschema 0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distributions (sdists)

Source distribution for jsonschema 0.6
File	Size	Uploaded
jsonschema-0.6.zip	16.6 kB	Sep 21, 2012	Details
jsonschema-0.6.tar.gz	13.8 kB	Sep 21, 2012	Details

Release files / jsonschema-0.6.zip

Download URL	jsonschema-0.6.zip
Size	16.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`ccdb6071aea90a00ffe19dd75b3a0fe1941d3b9c7ef3b164e5d12b21da31198a`
BLAKE2b-256 checksum How to use checksums	`b2edfaaadef8a34b9640b99634c0dbabeb3f4803a530ebaf5d84e9cbb8e2beca`
Upload date	Sep 21, 2012
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / jsonschema-0.6.tar.gz

Download URL	jsonschema-0.6.tar.gz
Size	13.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`e55d50467b3f1a813e62ab8d2d9d46a095ccc1238e9183e650b078359f5a9356`
BLAKE2b-256 checksum How to use checksums	`d07120368c997b8de44d1242d6059aeb04cbe0cf4f3f500e66bfa7903a8349dc`
Upload date	Sep 21, 2012
Uploaded using Trusted Publishing? What is trusted publishing?	No