An implementation of JSON Schema validation for Python
Project description
jsonschema is an implementation of the JSON Schema specification 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 jsonschemaExtras
Two extras are available when installing the package, both currently related to format validation:
format
format-nongpl
They can be used when installing in order to include additional dependencies, e.g.:
$ pip install jsonschema'[format]'Be aware that the mere presence of these dependencies – or even the specification of format checks in a schema – do not activate format checks (as per the specification). Please read the format validation documentation for further details.
About
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 Information
v4.17.0
The check_schema method on jsonschema.protocols.Validator instances now enables format validation by default when run. This can catch some additional invalid schemas (e.g. containing invalid regular expressions) where the issue is indeed uncovered by validating against the metaschema with format validation enabled as an assertion.
The jsonschema CLI (along with jsonschema.cli the module) are now deprecated. Use check-jsonschema instead, which can be installed via pip install check-jsonschema and found here.
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.17.0.tar.gz.
File metadata
- Download URL: jsonschema-4.17.0.tar.gz
- Upload date:
- Size: 293.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5bfcf2bca16a087ade17e02b282d34af7ccd749ef76241e7f9bd7c0cb8a9424d |
|
| MD5 | e569b6114d575bdb05cb8ce4676fe458 |
|
| BLAKE2b-256 | 3a3d0653047b9b2ed03d3e96012bc90cfc96227221193fbedd4dc0cbf5a0e342 |
File details
Details for the file jsonschema-4.17.0-py3-none-any.whl.
File metadata
- Download URL: jsonschema-4.17.0-py3-none-any.whl
- Upload date:
- Size: 83.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f660066c3966db7d6daeaea8a75e0b68237a48e51cf49882087757bb59916248 |
|
| MD5 | 3eca4d07188e345de8d2465b981fde1d |
|
| BLAKE2b-256 | f2c58e4cdbcbf81c5003a88722c34009bbda692d495dbccc2bf23edf9402d83d |
