jsoncompat 0.3.0

JSON Schema Compatibility Checker
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# /// script
# requires-python = ">=3.12"
# dependencies = ["jsoncompat"]
# [tool.uv.sources]
# jsoncompat = { path = "../../../python", editable = true }
# ///
"""End-to-end demo for the Python bindings of jsoncompat.

Executed by `just python-demo` which automatically builds the extension
module via *maturin* and then runs this script.

Alternatively, run `uv run --prerelease=allow examples/python/basic/demo.py`
to grab jsoncompat from PyPI and run the script.
"""

import jsoncompat as jsc


def main() -> None:
    new_schema = """{
  "type": "object",
  "properties": {
    "name": { "type": "string", "minLength": 5 },
    "age": { "type": "integer", "minimum": 18 }
  },
  "required": ["name"]
}"""
    old_schema = """{
  "type": "object",
  "properties": {
    "name": { "type": "string", "minLength": 5 },
    "age": { "type": "integer", "minimum": 18 }
  }
}"""

    print("=== Compatibility checks ===")
    roles: list[jsc.RoleLiteral] = [
        "serializer",
        "deserializer",
        "both",
    ]
    for role in roles:
        ok = jsc.check_compat(old_schema, new_schema, role)
        print(f"{role:12}: {ok}")

    print("\n=== Example value generation ===")
    example = jsc.generate_value(old_schema, 3)
    print("example value:", example)


if __name__ == "__main__":
    main()