update-presets.py

"""Update or lint data/presets-default.json

Usage:
  update-presets.py [options]
  update-presets.py add <preset>
  update-presets.py list-non-default [--rust] <preset>
  update-presets.py diff <left> <right>
  update-presets.py (-h | --help)

Options:
  -h, --help         show this help message and exit
  --defaults         fill in missing settings with their default values
  --from=<rev>       update presets to match the given git commit
  --hook             run noninteractively for git pre-commit hook purposes
  --preset=<preset>  only update the named preset
  --rust             list non-default settings in Rust syntax appropriate for the midos.house codebase
"""

import sys

import json
import platform
import subprocess

import docopt # PyPI: docopt

import SettingsList

if hasattr(SettingsList, 'si_dict'):
    SETTINGS_DICT = SettingsList.si_dict
else:
    SETTINGS_DICT = SettingsList.SettingInfos.setting_infos

def complete_presets(new_presets, interactive, *, add=False, defaults=False, preset=None, source=None):
    with open('data/presets_default.json', encoding='utf-8') as f:
        current = json.load(f)
    names = set(current)
    if source is not None:
        names |= set(source)
    if preset is not None and preset not in names:
        if add:
            names.add(preset)
        else:
            raise ValueError(f'No such preset: {preset}')
    for preset_name in sorted(names, key=lambda name: (list(current).index(name) if name in current else len(current), name)):
        if source is not None and preset_name in source and (preset is None or preset_name == preset):
            old_preset = source[preset_name]
        elif preset_name in current:
            old_preset = current[preset_name]
        else:
            old_preset = {}
        if preset is not None and preset_name != preset:
            new_presets[preset_name] = old_preset
            continue
        if preset_name not in new_presets:
            new_presets[preset_name] = {}
        SettingsList.validate_settings(new_presets[preset_name], check_conflicts=False)
        for setting_name, setting in SETTINGS_DICT.items():
            if setting_name != 'starting_items' and (setting.shared or setting_name == 'aliases') and setting_name not in new_presets[preset_name]:
                if setting_name in old_preset:
                    try:
                        new_presets[preset_name][setting_name] = old_preset[setting_name]
                        SettingsList.validate_settings(new_presets[preset_name], check_conflicts=False)
                    except TypeError:
                        if defaults:
                            new_presets[preset_name][setting_name] = SETTINGS_DICT[setting_name].default
                        elif interactive:
                            while True:
                                try:
                                    new_presets[preset_name][setting_name] = json.loads(input(f'{preset_name}[{setting_name}] (previously {json.dumps(old_preset[setting_name])}): ').strip())
                                except json.JSONDecodeError:
                                    continue
                                else:
                                    break
                            SettingsList.validate_settings(new_presets[preset_name], check_conflicts=False)
                        else:
                            raise
                else:
                    if defaults:
                        new_presets[preset_name][setting_name] = SETTINGS_DICT[setting_name].default
                    elif interactive:
                        while True:
                            try:
                                new_presets[preset_name][setting_name] = json.loads(input(f'{preset_name}[{setting_name}]: ').strip())
                            except json.JSONDecodeError:
                                continue
                            else:
                                break
                    else:
                        raise ValueError(f'Missing setting {setting_name!r} in preset {preset_name!r}')

def get_preset(presets, name):
    if name in presets:
        return presets[name]
    elif any(name in preset.get('aliases', []) for preset in presets.values()):
        return next(preset for preset in presets.values() if name in preset.get('aliases', []))
    else:
        return None

if __name__ == '__main__':
    arguments = docopt.docopt(__doc__)
    new_presets = {}
    if arguments['list-non-default']:
        with open('data/presets_default.json', encoding='utf-8') as f:
            presets = json.load(f)
        preset = get_preset(presets, arguments['<preset>'])
        if preset is None:
            preset = json.loads(subprocess.run([sys.executable, 'OoTRandomizer.py', '--convert_settings', '--settings_string', arguments['<preset>']], stdout=subprocess.PIPE, encoding='utf-8', check=True).stdout)
        non_default = {name: value for name, value in preset.items() if value != SETTINGS_DICT[name].default}
        if arguments['--rust']:
            print('collect![')
            for name, value in non_default.items():
                if name == 'aliases':
                    continue
                print('\n    '.join(f'    format!("{name}") => json!({json.dumps(value, indent=4)}),'.splitlines())) #TODO trailing commas in arrays/objects
            print(']')
        else:
            print(json.dumps(non_default, indent=4))
    elif arguments['diff']:
        if arguments['<left>'] == 'default':
            left = {setting_name: setting.default for setting_name, setting in SETTINGS_DICT.items() if setting.shared or setting_name == 'aliases'}
        else:
            with open('data/presets_default.json', encoding='utf-8') as f:
                left = get_preset(json.load(f), arguments['<left>'])
        if arguments['<right>'] == 'default':
            right = {setting_name: setting.default for setting_name, setting in SETTINGS_DICT.items() if setting.shared or setting_name == 'aliases'}
        else:
            with open('data/presets_default.json', encoding='utf-8') as f:
                right = get_preset(json.load(f), arguments['<right>'])
        with open('left.json', 'w', encoding='utf-8') as left_f:
            json.dump(left, left_f, indent=4)
        with open('right.json', 'w', encoding='utf-8') as right_f:
            json.dump(right, right_f, indent=4)
        diff = ['wsl', 'diff'] if platform.system() == 'Windows' else ['diff']
        sys.exit(subprocess.run([*diff, left_f.name, right_f.name]).returncode)
    elif arguments['--hook']:
        complete_presets(new_presets, False)
        with open('data/presets_default.json', encoding='utf-8') as f:
            if f.read() != json.dumps(new_presets, indent=4) + '\n':
                raise ValueError('presets not formatted correctly, run .\\update-presets.py to fix')
    else:
        if arguments['--from']:
            source = json.loads(subprocess.run(['git', 'show', f'{arguments["--from"]}:data/presets_default.json'], encoding='utf-8', stdout=subprocess.PIPE, check=True).stdout)
        else:
            source = None
        preset = arguments['--preset']
        if arguments['add']:
            preset = arguments['<preset>']
        complete_presets(new_presets, True, add=arguments['add'], defaults=arguments['--defaults'], preset=preset, source=source)
        with open('data/presets_default.json', 'w', encoding='utf-8', newline='\n') as f:
            json.dump(new_presets, f, indent=4)
            print(file=f)