Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

An implementation of JSON Schema validation for Python

Project description

PyPI version Supported Python versions Travis build status AppVeyor build status Codecov Code coverage ReadTheDocs 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(instance={"name" : "Eggs", "price" : 34.99}, schema=schema)

>>> validate(
...     instance={"name" : "Eggs", "price" : "Invalid"}, schema=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

Demo

Try jsonschema interactively in this online demo:

Open Live Demo

Online demo Notebook will look similar to this:

Open Live Demo

Release Notes

v3.1 brings support for ECMA 262 dialect regular expressions throughout schemas, as recommended by the specification. Big thanks to @Zac-HD for authoring support in a new js-regex library.

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 pyperf.

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

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

To compare to a previous run, use:

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

See the pyperf 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 also woo me with beer money via Google Pay with the email in my GitHub profile.

And for companies who appreciate jsonschema and its continued support and growth, jsonschema is also now supportable via TideLift.

Project details


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.1.1
Filename, size File type Python version Upload date Hashes
Filename, size jsonschema-3.1.1-py2.py3-none-any.whl (56.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size jsonschema-3.1.1.tar.gz (150.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page