jsonschema
jsonschema is an implementation of JSON Schema 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
- Full support for Draft 3 and Draft 4 of the schema.
- Lazy validation that can iteratively report all validation errors.
- Small and extensible
- Programmatic querying of which properties or items failed validation.
Release Notes
v1.2.0 adds a number of new attributes to provide
information that is useful for programmatially inspecting draft4's
anyOf, oneOf and allOf
validators.
See https://python-jsonschema.readthedocs.org/en/latest/errors.html for examples.
ValidatorMixin also gained a descend method
which is useful for implementing validation methods that recurse into an
instance while maintaining the paths within the instance and schema. It
isn't documented yet though (patches welcome.)
There's also a fix for a minor issue where failing ref resolutions had poor error messages.
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.
Community
There's a mailing list for this implementation on Google Groups.
Please join, and feel free to send questions there.
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.