This release is a pre-release and may not be stable for production use.
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({"name" : "Eggs", "price" : 34.99}, schema)
>>> validate(
... {"name" : "Eggs", "price" : "Invalid"}, 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.schemaFeatures
Lazy validation that can iteratively report all validation errors.
Small and extensible
Programmatic querying of which properties or items failed validation.
Installation
jsonschema is available on PyPI. You can install using pip:
$ pip install jsonschemaRelease Notes
Version 2.6.0 drops support for Python 2.6.X (ha ha) and contains a number of small improvements in error messages, as well as a bug fix for ErrorTree.
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 perf.
Running them can be done via tox -e perf, or by invoking the perf commands externally (after ensuring that both it and jsonschema itself are installed):
$ python -m perf jsonschema/benchmarks/test_suite.py --hist --output results.json
To compare to a previous run, use:
$ python -m perf compare_to --table reference.json results.json
See the perf 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 woo me with beer money via Google Pay with the email in my GitHub profile.
Metadata
Release files for jsonschema 3.0.0a4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| jsonschema-3.0.0a4.tar.gz | 118.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jsonschema-3.0.0a4-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 170.6 kB
Release files / jsonschema-3.0.0a4.tar.gz
| Download URL | jsonschema-3.0.0a4.tar.gz |
|---|---|
| Size | 118.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8937b03883c17c999a45a1ec70c46690ef454181f09ebcbcb21694153b9e39c8
|
|
BLAKE2b-256 checksum How to use checksums |
617b8faddb56aeba967c567d32c0596e1b26131f18c276dfb5cc8e3ab8a091a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 PyPy/6.0.0
|
Release files / jsonschema-3.0.0a4-py2.py3-none-any.whl
| Download URL | jsonschema-3.0.0a4-py2.py3-none-any.whl |
|---|---|
| Size | 52.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
5695bc362157eab16513b27d5ec221048220ceacbceaf35ec235b5993deb9090
|
|
BLAKE2b-256 checksum How to use checksums |
d1bda72ea48d2cd9d28548b4293f24eec5eba9b2135c74171f319b571fe9398e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 PyPy/6.0.0
|
Security for jsonschema 3.0.0a4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
