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.schema
- 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.
jsonschema
is available on PyPI. You can install using pip:
$ pip install jsonschema
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 <https://tidelift.com/subscription/pkg/pypi-jsonschema?utm_source=pypi-j sonschema&utm_medium=referral&utm_campaign=readme>.
- Make the rendered README in PyPI simpler and fancier. Thanks Hynek (#983)!