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 the command line by installing check-jsonschema.
Features
Full support for Draft 2020-12, Draft 2019-09, 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.18.0
This release majorly rehaul’s the way in which JSON Schema reference resolution is configured. It does so in a way that should be backwards compatible, preserving old behavior whilst emitting deprecation warnings.
jsonschema.RefResolver is now deprecated in favor of the new referencing library. referencing will begin in beta, but already is more compliant than the existing $ref support. This change is a culmination of a meaningful chunk of work to make $ref resolution more flexible and more correct. Backwards compatibility should be preserved for existing code which uses RefResolver, though doing so is again now deprecated, and all such use cases should be doable using the new APIs. Please file issues on the referencing tracker if there is functionality missing from it, or here on the jsonschema issue tracker if you have issues with existing code not functioning the same, or with figuring out how to change it to use referencing. In particular, this referencing change includes a change concerning automatic retrieval of remote references (retrieving http://foo/bar automatically within a schema). This behavior has always been a potential security risk and counter to the recommendations of the JSON Schema specifications; it has survived this long essentially only for backwards compatibility reasons, and now explicitly produces warnings. The referencing library itself will not automatically retrieve references if you interact directly with it, so the deprecated behavior is only triggered if you fully rely on the default $ref resolution behavior and also include remote references in your schema, which will still be retrieved during the deprecation period (after which they will become an error).
Support for Python 3.7 has been dropped, as it is nearing end-of-life. This should not be a “visible” change in the sense that requires-python has been updated, so users using 3.7 should still receive v4.17.3 when installing the library.
On draft 2019-09, unevaluatedItems now properly does not consider items to be evaluated by an additionalItems schema if items is missing from the schema, as the specification says in this case that additionalItems must be completely ignored.
Fix the date format checker on Python 3.11 (when format assertion behavior is enabled), where it was too liberal (#1076).
Speed up validation of unevaluatedProperties (#1075).
Deprecations
jsonschema.RefResolver – see above for details on the replacement
jsonschema.RefResolutionError – see above for details on the replacement
relying on automatic resolution of remote references – see above for details on the replacement
importing jsonschema.ErrorTree – instead import it via jsonschema.exceptions.ErrorTree
importing jsonschema.FormatError – instead import it via jsonschema.exceptions.FormatError
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.18.0a6.tar.gz.
File metadata
- Download URL: jsonschema-4.18.0a6.tar.gz
- Upload date:
- Size: 314.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b75063d9d6a5f5023c3d9bb89863a9cc1aaf34ccbd4dcf58ee5c5f23c1871b2a |
|
| MD5 | a28ade2c74e6a6714acbccf06f2a4232 |
|
| BLAKE2b-256 | 55f704d4415461e16c279f39ab5b080ae73bb2f3cb0b9fddb39646b28f4bbdfd |
File details
Details for the file jsonschema-4.18.0a6-py3-none-any.whl.
File metadata
- Download URL: jsonschema-4.18.0a6-py3-none-any.whl
- Upload date:
- Size: 81.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4b88fe4edfd5ddc3364fca04b1554d4dd5bc67d2eb73c8795ab2d9e46a032643 |
|
| MD5 | 4d5494fe704c54a7e5045aa6b33cde7d |
|
| BLAKE2b-256 | d8f2afd6141441d0979bc28cd5b7c7a4036df3e03610b89812df7813d8b85dca |
