Skip to main content

A JSON toolkit for Python developers.

Project description

Supported Python versions PyPI package version Documentation status Test status Code coverage MIT license Total downloads

A JSON toolkit for Python developers.

Features

  • JSON Schema validator implementation (drafts 2019-09, 2020-12)

    • 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)

  • JSON Patch (RFC 6902)

  • Relative JSON Pointer (draft)

Installation

pip install jschon

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

pip install jschon[requests]

Basic usage

Create a JSON schema:

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:

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!"
        }
    ]
}

Project details


Download files

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

Source Distribution

jschon-0.11.1.tar.gz (69.4 kB view details)

Uploaded Source

Built Distribution

jschon-0.11.1-py3-none-any.whl (67.0 kB view details)

Uploaded Python 3

File details

Details for the file jschon-0.11.1.tar.gz.

File metadata

  • Download URL: jschon-0.11.1.tar.gz
  • Upload date:
  • Size: 69.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for jschon-0.11.1.tar.gz
Algorithm Hash digest
SHA256 c0ca0beab1f1694a03d726b91ed75ec604a7787af3ae91ead765f78215bf149f
MD5 d2dc7ab5b97355ccfb0b72cb61ed87ac
BLAKE2b-256 7b8b5cbfbb4751533027ba97a59dfe4c9e694fbceaf549fa9cd7cb9a6066bd60

See more details on using hashes here.

File details

Details for the file jschon-0.11.1-py3-none-any.whl.

File metadata

  • Download URL: jschon-0.11.1-py3-none-any.whl
  • Upload date:
  • Size: 67.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for jschon-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2350e8b6747b17358022960f91208bea70de448b914827af3184d30e20500f0f
MD5 efc85f7cb234c64ab90a7046f2a92919
BLAKE2b-256 ceb131f454a2ac0d23b0a47283d115f0af4abe2a1ea391f5ccb223e02d685b82

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