An implementation of JSON Schema validation for Python
Project description
jsonschema is an implementation of JSON Schema for Python.
>>> 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 --instance sample.json sample.schemaFeatures
Partial support for Draft 2020-12 and Draft 2019-09, except for dynamicRef / recursiveRef and $vocabulary (in-progress). Full support for Draft 7, Draft 6, Draft 4 and Draft 3
Lazy validation that can iteratively report all validation errors.
Programmatic querying of which properties or items failed validation.
Installation
jsonschema is available on PyPI. You can install using pip:
$ pip install jsonschemaRunning 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
Community
The JSON Schema specification has a Slack, with an invite link on its home page. Many folks knowledgeable on authoring schemas can be found there.
Otherwise, asking questions on Stack Overflow is another means of getting help if you’re stuck.
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 Libera (nick: Julian) in various channels, including #python.
If you feel overwhelmingly grateful, you can also sponsor me.
And for companies who appreciate jsonschema and its continued support and growth, jsonschema is also now supportable via TideLift.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jsonschema-4.1.0a1.tar.gz.
File metadata
- Download URL: jsonschema-4.1.0a1.tar.gz
- Upload date:
- Size: 306.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0dac198595ef255d733db996586644b80edad0a1e6ee49dc0cced1e8971e7f57 |
|
| MD5 | 760654d90b36f5f73aef8199bc7de630 |
|
| BLAKE2b-256 | ef15a0d7e5b267e045408ac7952df66a13876a854c5ba9ccad80565dc1c2b789 |
File details
Details for the file jsonschema-4.1.0a1-py3-none-any.whl.
File metadata
- Download URL: jsonschema-4.1.0a1-py3-none-any.whl
- Upload date:
- Size: 69.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8fba09c0fc3f365e3d724de0dc2abc3d9461987fe127cb917f363f7039c2c81e |
|
| MD5 | 9cd8cd39524b85fcb54354c9da771039 |
|
| BLAKE2b-256 | ef8ddec198a43ddc477ed99d6f275652ea58ab5e4b1ab9d8d2baa1d993e7b318 |
