Skip to main content

An implementation of JSON Schema validation for Python

Project description

PyPI version Supported Python versions Travis build status AppVeyor build status

jsonschema is an implementation of JSON Schema for Python (supporting 2.7+ 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'

It can also be used from console:

$ jsonschema -i sample.json sample.schema

Features

Installation

jsonschema is available on PyPI. You can install using pip:

$ pip install jsonschema

Release Notes

Version 2.6.0 drops support for Python 2.6.X (ha ha) and contains a number of small improvements in error messages, as well as a bug fix for ErrorTree.

Running the Test Suite

If you have tox installed (perhaps via pip install tox or your package manager), running tox in the directory of your source checkout will run jsonschema’s test suite on all of the versions of Python jsonschema supports. If you don’t have all of the versions that jsonschema is tested under, you’ll likely want to run using``tox``’s --skip-missing-interpreters option.

Of course you’re also free to just run the tests on a single version with your favorite test runner. The tests live in the jsonschema.tests package.

Benchmarks

jsonschema’s benchmarks make use of perf.

Running them can be done via tox -e perf, or by invoking the perf commands externally (after ensuring that both it and jsonschema itself are installed):

$ python -m perf jsonschema/benchmarks/test_suite.py --hist --output results.json

To compare to a previous run, use:

$ python -m perf compare_to --table reference.json results.json

See the perf documentation for more details.

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.

If you feel overwhelmingly grateful, you can woo me with beer money via Google Pay with the email in my GitHub profile.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jsonschema, version 3.0.0a4
Filename, size File type Python version Upload date Hashes
Filename, size jsonschema-3.0.0a4.tar.gz (118.5 kB) File type Source Python version None Upload date Hashes View
Filename, size jsonschema-3.0.0a4-py2.py3-none-any.whl (52.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page