jschon-sort 0.0.4

jschon-sort sorts a JSON or YAML document according to its JSON Schema: object properties are ordered to match the order in which JSON Schema properties (that match them) are declared.

The "jschon" name relates to it being based on the jschon library for JSON Schema handling.

Motivation

Per the JSON RFC, an object is an unordered collection. In practice, within serialized JSON or YAML files, a particular order of properties can benefit readability: for example, {"start": 10, "end": 20} read more naturally than naive lexicographic order of {"end": 20, "start": 10} (that would result from json.dumps(..., sort_keys=True)). While there are several attempts to introduce property ordering into JSON Schema, here we're taking a different approach. By leveraging the fact that the JSON Schema itself is written with human maintainers in mind, we can extrapolate the intuitive order from the JSON Schema definitions' ordering and apply it on the document itself.

Usage

Shell:

jschon-sort --schema ../schema.json file.yaml

API:

import jschon
import jschon_sort

jschon.create_catalog('2020-12')
...
sorted_doc_data = jschon_sort.sort_doc_by_schema(
    schema_data=schema_data,
    doc_data=doc_data,
)

Example

Given schema:

{
  "type": "object",
  "properties": {
    "range": {
      "type": "object",
      "properties": {
        "start": {"type": "number"},
        "end": {"type": "number"}
      }
    }
  }
}

the following document:

{"range": {"end": 20, "start": 10}}

would be reordered as:

{"range": {"start": 20, "end": 10}}