jschon

library0.11.1pypypi✓ verified 91d ago

jschon is a comprehensive Python library for working with JSON data, JSON Schema validation (supporting Draft 2020-12), JSON Pointer, JSON Patch, and JSONPath. It provides robust tools for schema definition, data validation, and JSON document manipulation. The current version is 0.11.1, and the library maintains a relatively active release cadence with frequent minor and patch updates.

serialization data web-framework

pip install jschon

github ↗package ↗

INSTALL

IMPORT

SIG · JSCHON

jschon

serializationpythonv0.11.1

Install

1.7s avg

Import

272ms

Disk

17MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.11.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.930 runs

installs and imports cleanly · install 0.0s · import 0.278s · 18.6MB

glibc

py 3.10–3.930 runs

installs and imports cleanly · install 1.7s · import 0.267s · 19MB

17MB installed

● package 17MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

JSON

✓ from jschon import JSON

JSONSchema

✓ from jschon import JSONSchema

URI

✓ from jschon import URI

JSONPointer

✓ from jschon import JSONPointer

Catalog

✓ from jschon import Catalog

This quickstart demonstrates how to define a JSON Schema, create a JSON data instance, and validate the instance against the schema using `jschon`'s `JSONSchema` and `JSON` classes.

from jschon import JSON, JSONSchema # Define a JSON Schema schema_data = { "type": "object", "properties": { "name": {"type": "string"}, "age": {"type": "integer", "minimum": 0} }, "required": ["name", "age"] } schema = JSONSchema(schema_data) # Define a JSON instance instance_data = {"name": "Alice", "age": 30} instance = JSON(instance_data) # Validate the instance against the schema result = schema.evaluate(instance) if result.valid: print("JSON instance is valid!") else: print("JSON instance is invalid:") print(result.output('basic')) # Example of invalid data invalid_instance_data = {"name": "Bob", "age": -5} invalid_instance = JSON(invalid_instance_data) invalid_result = schema.evaluate(invalid_instance) if not invalid_result.valid: print("\nInvalid instance output:") print(invalid_result.output('basic'))

Debug

Known issues

breakingThe `Catalog.get_schema()` method signature changed. It now requires `recursive` and `session` arguments, which were previously implicit or handled differently.

fix

Update calls to `Catalog.get_schema()` to explicitly pass `recursive=False` (or `True`) and `session=None` (or a valid `SchemaSession` object).

affects: >=0.10.0

breakingThe `JSONPointer` constructor now strictly requires a `jschon.URI` object as its base argument, rather than a `jschon.JSON` instance or a string. If a `JSON` instance is provided, its `JSON.uri` attribute is extracted internally.

fix

Ensure `JSONPointer` is initialized with a `jschon.URI` object. Convert strings to `URI(your_string)` first if necessary.

affects: >=0.10.0

breakingThe `Catalog.get_schema()` method now returns a `JSONSchema` instance instead of a raw `JSON` instance. The `JSON.schema` attribute was deprecated and now returns `None`.

fix

Directly use the `JSONSchema` object returned by `Catalog.get_schema()`. Do not rely on `JSON.schema` for schema access.

affects: >=0.9.0

gotchajschon extensively uses `jschon.URI` objects instead of plain Python strings for all URI-related parameters (e.g., `$id`, `$ref`, base URIs). Passing strings where `URI` objects are expected will lead to `TypeError`.

fix

Always wrap URI strings with `jschon.URI()` before passing them to methods or constructors that expect a URI object.

affects: All versions

Errors

Common errors & fixes

TypeError: object of type 'str' has no len()

Attempting to pass a plain Python string where a `jschon.URI` object is expected, typically in methods dealing with schema URIs or JSONPointers.

fix

Wrap the string with `jschon.URI()` before passing it. E.g., `schema = JSONSchema(schema_data, uri=URI('https://example.com/schema'))`.

AttributeError: 'JSON' object has no attribute 'schema'

Attempting to access the `schema` attribute on a `jschon.JSON` instance, which was deprecated in `v0.9.0`.

fix

Retrieve schemas directly from the `Catalog` using `Catalog.get_schema()` which now returns a `JSONSchema` object directly.

TypeError: get_schema() missing 2 required positional arguments: 'recursive', and 'session'

Calling `Catalog.get_schema()` without the newly required `recursive` and `session` arguments introduced in `v0.10.0`.

fix

Update your call to `Catalog.get_schema()` to include these arguments, e.g., `catalog.get_schema(URI('https://example.com/schema'), recursive=False, session=None)`.

Upgrade

Version history

0.11.1latest on PyPI · released Oct 22, 2023

Audit

Dependencies

No dependency data recorded yet.

Agent activity

15 hits · last 30 days

node

Resources

githubhttps://github.com/marksparkza/jschon ↗

packagehttps://pypi.org/project/jschon/ ↗