Function generate_builtins_docs

python/generate_builtins.py:7–46

()

from module_loader import get_type_data, get_value_data

def generate_builtins_docs():
    from generate_tray import processExample

    overrides = {}
    with open("./library/overrides.yaml", "r") as f:
        overrides_list = yaml.safe_load(f)['overrides']
        for override in overrides_list:
            overrides[override['key']] = override

    builtins_data = {
        'moduleName': 'builtins',
        'values': {},
        'types': {}
    }

    for name in dir(builtins):
        if name in ['None', 'True', 'False']:
            continue

        thing = getattr(builtins, name)
        data = get_value_data(name, thing)

        thingKey = f'builtins.{name}'
        if thingKey in overrides:
            overrideData = overrides[thingKey]
            if 'abstract' in overrideData:
                data['shortDoc'] = overrideData['abstract']
            data['examples'] = []
            if 'examples' in overrideData:
                data['examples'] = [processExample(ex) for ex in overrideData['examples']]
            if 'parameters' in overrideData:
                data['parameters'] = overrideData['parameters']

        builtins_data['values'][name] = data

        if (data['typeName'] == 'type'):
            type_data = get_type_data(thing, overrides)
            builtins_data['types'][name] = type_data

    return builtins_data