jschon

An object-oriented JSON Schema implementation for Python.

Note from the author:

Hi! I'm Mark, and this is my personal Python-powered project. Work on jschon is currently on hold due to other commitments. Development will resume as and when time allows.

Features

JSON Schema validator implementation (drafts 2019-09, 2020-12 <https://json-schema.org/>_)
- Schema compilation and indexing
- $ref loading from local and remote sources
- Support for custom keywords, vocabularies and meta-schemas
- Support for format validation
JSON class implementing the JSON data model
JSON Pointer (RFC 6901 <https://tools.ietf.org/html/rfc6901.html>_)
JSON Patch (RFC 6902 <https://tools.ietf.org/html/rfc6902.html>_)
Relative JSON Pointer (draft <https://datatracker.ietf.org/doc/html/draft-bhutton-relative-json-pointer-00>_)

Installation

pip install jschon

For remote $ref support, the requests library is required. It may be installed with::

pip install jschon[requests]

Example

Create a JSON schema:

.. code-block:: python

from jschon import create_catalog, JSON, JSONSchema

create_catalog('2020-12')

demo_schema = JSONSchema({
    "$id": "https://example.com/demo",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "array",
    "items": {
        "anyOf": [
            {
                "type": "string",
                "description": "Cool! We got a string here!"
            },
            {
                "type": "integer",
                "description": "Hey! We got an integer here!"
            }
        ]
    }
})

Validate JSON data:

.. code-block:: python

result = demo_schema.evaluate(
    JSON([12, "Monkeys"])
)

Generate JSON Schema-conformant output:

result.output('basic') { "valid": True, "annotations": [ { "instanceLocation": "", "keywordLocation": "/items", "absoluteKeywordLocation": "https://example.com/demo#/items", "annotation": True }, { "instanceLocation": "/0", "keywordLocation": "/items/anyOf/1/description", "absoluteKeywordLocation": "https://example.com/demo#/items/anyOf/1/description", "annotation": "Hey! We got an integer here!" }, { "instanceLocation": "/1", "keywordLocation": "/items/anyOf/0/description", "absoluteKeywordLocation": "https://example.com/demo#/items/anyOf/0/description", "annotation": "Cool! We got a string here!" } ] }

marksparkza / jschon

readme

jschon

Features

Installation

Example

Links