Flatten JSON to typed path records

Before you begin

Python 3.12 or newer

What this script changesCreates a new result and refuses overwrite; input is unchanged. Nonstandard NaN/Infinity JSON is rejected; nested documents can exceed the interpreter recursion limit.

Set up your example

Save the complete code as json-flatten-paths.py in a working folder.
Save the provided sample files in that same folder; run commands from that folder.

Sample files in this download:

types.json
sample.json
people.json
other.json
sample.jsonl
flat.json
sample.xml

Download the ZIP, extract it, and open a terminal inside the extracted folder. The source file is json-flatten-paths.py.

Run the script

python "json-flatten-paths.py" --input "sample.json" --output "flattened.json"

If your system uses python3 instead of python, use that command for Python examples. Keep paths containing spaces in quotes. Required inputs and optional settings are described in the code and setup steps.

What to expect

Represent leaves and empty containers as path/value records. Ada appears at the typed path members, 0, name; null is preserved.

The complete script

#!/usr/bin/env python3
'Flatten JSON to typed path records'
import argparse
import json
from pathlib import Path

def write_json(path, value):
    data = json.dumps(value, indent=2, ensure_ascii=False, allow_nan=False) + "\n"
    with Path(path).open("x", encoding="utf-8", newline="") as handle:
        handle.write(data)

import random
from collections import Counter
import xml.etree.ElementTree as ET

def read_text(path):
    if Path(path).stat().st_size > 10*1024*1024:
        raise ValueError("Input exceeds 10 MiB.")
    return Path(path).read_text(encoding="utf-8-sig")
def reject(value):
    raise ValueError("Nonstandard JSON constant: "+value)
def load(path):
    return json.loads(read_text(path),parse_constant=reject)
def lines(path):
    return [json.loads(s,parse_constant=reject) for s in read_text(path).splitlines() if s.strip()]
def array(value):
    if not isinstance(value,list):
        raise ValueError("Expected an array root.")
    return value
def objects(value):
    value=array(value)
    if not all(isinstance(r,dict) for r in value):
        raise ValueError("Every array item must be an object.")
    return value
def walk(value,path=()):
    yield path,value
    if isinstance(value,dict):
        for k,v in value.items(): yield from walk(v,path+(k,))
    elif isinstance(value,list):
        for i,v in enumerate(value): yield from walk(v,path+(i,))
def pointer(value,path):
    if not path: return value
    if not path.startswith("/"): raise ValueError("Use a /-prefixed JSON Pointer.")
    for part in path[1:].split("/"):
        key=part.replace("~1","/").replace("~0","~")
        if isinstance(value,list):
            if not key.isdigit() or int(key)>=len(value): raise ValueError("Bad array index.")
            value=value[int(key)]
        elif isinstance(value,dict): value=value[key]
        else: raise ValueError("Pointer crosses a scalar.")
    return value
def xml(path):
    text=read_text(path)
    if "<!DOCTYPE" in text.upper() or "<!ENTITY" in text.upper():
        raise ValueError("DTD/entity declarations are refused.")
    try: return ET.fromstring(text)
    except ET.ParseError as exc: raise ValueError(str(exc)) from exc
def save(path,text):
    with Path(path).open("x",encoding="utf-8",newline="") as handle: handle.write(text)

def main():
    parser = argparse.ArgumentParser(description='Flatten JSON to typed path records')
    parser.add_argument("--input", required=True)
    parser.add_argument("--output", required=True)
    args = parser.parse_args()
    result=[{"path":list(path),"value":value} for path,value in walk(load(args.input)) if not isinstance(value,(dict,list)) or not value]
    write_json(args.output,result)

if __name__ == "__main__":
    try:
        main()
    except (OSError, ValueError, KeyError, TypeError, ArithmeticError, IndexError, LookupError) as exc:
        raise SystemExit(str(exc))

Open source as plain text · Download source and sample files

How it works

Local UTF-8 input is limited to 10 MiB and held in memory.
Path arrays distinguish string object keys from integer array positions, including keys containing dots or slashes.
Ada appears at the typed path members, 0, name; null is preserved.

Make it your own

--input

Choose any small nested JSON document.

Adapt the processing

Edit main's leaf condition to report container summaries separately.

Change one setting at a time, run it again on sample data, and compare the output. The customization guide walks through this process.

If something goes wrong

Empty containers appear as values.

They are necessary for a lossless structural reconstruction.

The destination already exists.

Choose a new --output path. The script deliberately refuses to replace an existing result.

Reference & next steps

These official references explain the underlying tools. The Scriptage example and guide are original instructional content. See verification notes for what has been checked and the limits of those checks.

Copies a template for your own notes. It does not send anything.