json-schema-descriptions / get_descriptions.py
michaelmior's picture
Update excluded keywords
b3fb910 verified
import glob
import json
import os
import sys
KEYWORDS = [
"allOf",
"anyOf",
"oneOf",
]
REMOVE_KEYS = [
"$comment",
"$id",
"$ref",
"Description",
"description",
"markdownDescription",
"title",
]
dict_values = type({}.values())
def clean_object(obj):
if isinstance(obj, dict):
return {k: clean_object(v) for k, v in obj.items() if k not in REMOVE_KEYS}
elif isinstance(obj, list):
return [clean_object(v) for v in obj]
else:
return obj
def get_descriptions(obj, key=""):
if isinstance(obj, dict):
if "description" in obj and isinstance(obj["description"], str):
yield key, obj["description"], clean_object(obj)
for k, v in obj.items():
if k in KEYWORDS:
k = key
yield from get_descriptions(v, k)
elif isinstance(obj, (list, dict_values)):
for v in obj:
yield from get_descriptions(v, key)
for line in sys.stdin:
obj = json.loads(line)
schema = obj["name"]
obj = json.loads(obj["content"])
for key, desc, sub_obj in get_descriptions(obj):
json.dump(
{
"schema": os.path.basename(schema),
"key": key,
"description": desc,
"object": json.dumps(sub_obj),
},
sys.stdout,
)
sys.stdout.write("\n")