Skip to main content

An implementation of JSON Schema validation for Python

Project description

https://img.shields.io/pypi/v/jsonschema.svg https://travis-ci.org/Julian/jsonschema.svg?branch=master https://img.shields.io/pypi/l/jsonschema.svg

jsonschema

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.schema

Features

Release Notes

Version 2.5.0 is mainly a performance release. The interface for RefResolver was extended to add methods that improve performance on CPython.

Support for custom RefResolver objects with the legacy interface should not be affected. If you notice something amiss please file an issue ticket.

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. Note that you’ll need to have all of those versions installed in order to run the tests on each of them, otherwise tox will skip (and fail) the tests on that version.

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.

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 on Gittip or via Google Wallet with the email in my GitHub profile.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

coopdigital_jsonschema-2.6.0-py2.py3-none-any.whl (43.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file coopdigital_jsonschema-2.6.0-py2.py3-none-any.whl.

File metadata

  • Download URL: coopdigital_jsonschema-2.6.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 43.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.6

File hashes

Hashes for coopdigital_jsonschema-2.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 19c93e04ce5961b2f5664a7e8c978c6cecd0e1f2f8431b1196e0c4ca21209352
MD5 2d2bed5bf4d2fb8006999c0b4daff0bc
BLAKE2b-256 7a85eae496f1b83dc5a5236bb074d47962ba0a5021099ba9486c2c4c5094d1ad

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page