jsoncompat 0.3.0

JSON Schema compatibility checker for evolving schemas

jsoncompat

Python bindings for checking compatibility of evolving JSON schemas and generating example values.

Installation

Install from PyPI:

pip install jsoncompat

Usage

import jsoncompat as jsc

# Define old and new schemas as JSON strings
old_schema = '{"type": "string"}'
new_schema = '{"type": "number"}'

# Check compatibility (role: "serializer", "deserializer", or "both").
# Raises ValueError for invalid schemas or unsupported compatibility features.
is_compatible = jsc.check_compat(old_schema, new_schema, jsc.Role.BOTH)
print(is_compatible)

# Generate an example value for a schema
example = jsc.generate_value(old_schema, depth=5)
print(example)

Public Interface

• check_compat(old_schema_json: str, new_schema_json: str, role: str = "both") -> bool
  • role must be "serializer", "deserializer", or "both".
  • Raises ValueError for invalid schemas or unsupported compatibility features such as non-integral number.multipleOf.
• generate_value(schema_json: str, depth: int = 5) -> str
  • Returns a JSON string for one generated value accepted by the schema.
  • Raises ValueError when the schema is invalid, known to be unsatisfiable, or generation exhausts its retry budget.
• Role.SERIALIZER, Role.DESERIALIZER, and Role.BOTH are string constants accepted by check_compat.

Schemas are passed as JSON strings. The bindings are intentionally thin: they parse the strings, call the Rust core APIs, and map Rust errors into ValueError.

Examples

See the basic demo:

• https://github.com/ostrowr/jsoncompat/blob/main/examples/python/basic/demo.py
• https://jsoncompat.com

License

MIT License. See:

• https://github.com/ostrowr/jsoncompat/blob/main/LICENSE