dialogue.py

import json
import copy

EXIT_CONSTS = set(['q', 'quit', 'exit'])
YES_CONSTS = set(['y', 'yes'])
HELP_CONSTS = set(['?', 'help'])

# Json parameters might be subject to change.
TEMPLATE_DATA = 'TemplateData'
RUN_LIST = 'RunList'
RUNLIST_ARGS = 'args'
TAG_ARG = 'tag'
RUN_TEMPLATE_TYPE = 'template_type'

TEMPLATE_ARGS = 'args'
TEMPLATE_ANNO = 'annotations'
TEMPLATE_TYPES = 'types'
TEMPLATE_TRANS = 'translations'
TEMPLATE_DEFAULT = 'prop_options'

TYPE_CHECK_FUNC = {
    'string': lambda x: str(x),
    'int': lambda x: int(x),
    'integer': lambda x: int(x),
    'float': lambda x: float(x),
    'bool': lambda x: x not in set(['false', 'False']),
    'boolean': lambda x: x not in set(['false', 'False']),
}


def write_json(filename, python_dict):
    """ 
    Serialize python_dict (dictionary) to filename (text file).
    :param filename: string
    :param python_dict: dict
    """
    with open(filename, 'w') as f:
        json.dump(python_dict, f, indent=4)


def read_json(filename):
    """ 
    Deserializes json formatted string from filename (text file) as a dictionary.
    :param filename: string
    """
    with open(filename) as f:
        return json.load(f)


def print_dict(d):
    for key, value in sorted(d.items(), key=lambda x: x[0]):
        print("{}: {}".format(key, value))


# Level-one layer of dialogue.
# All functions take run_dict, template_dict as arguments so that they can be
# called homogenously from a dictionary in `dialogue`.


def tag_in_runlist(tag, run_list):
    """
    Returns True if a Run with tag `tag` is in the list.
    """
    return any(map(lambda run: run[TAG_ARG] == tag, run_list))


def find(f, seq):
    """
    Return first item in sequence where f(item) == True.
    """
    for item in seq:
        if f(item):
            return item


def find_run_tag(tag, run_list):
    return find(lambda run: run[TAG_ARG] == tag, run_list)


# Level-one layer of dialogue. All functions take run_dict, template_dict as
# arguments so that they can be called homogeneously from a dictionary in
# `dialogue`. All functions must, in turn, *return* a tuple (run_dict,
# template_dict) as arguments.


def print_all_runs(run_list, template_dict):
    """
    Prints all runs in the RunList. Note that it gets the argument order from
    `template_dict`.
    """
    for run in run_list:
        print('\nTag: {}'.format(run[TAG_ARG]))
        print('Template Type: {}'.format(run[RUN_TEMPLATE_TYPE]))
        for arg in template_dict[run[RUN_TEMPLATE_TYPE]][RUNLIST_ARGS]:
            print('{}: {}'.format(arg, run[RUNLIST_ARGS][arg]))
        print()
    return (run_list, template_dict)


def create_run(run_list, template_dict):
    new_run = {}
    # Inputting run type.
    print('Input the template type. Current options: {}'.format(' '.join(
        sorted(template_dict.keys()))))
    template_type = input('-> ')
    if template_type not in template_dict.keys():
        user_input = input('{} is not currently an option. Add it? '\
                     .format(template_type))
        if user_input.lower() in YES_CONSTS:
            return create_template(run_list, template_dict)
        return run_list, template_dict
    new_run[RUN_TEMPLATE_TYPE] = template_type
    new_run[RUNLIST_ARGS] = {}

    # Input the tag.
    while True:
        new_tag = input('Input a tag for the run. ')
        if new_tag in [run[TAG_ARG] for run in run_list]:
            print('Tag {} already exists in the run list!'.format(new_tag))
            continue
        new_run[TAG_ARG] = new_tag
        break

    # Input values.
    for arg in template_dict[template_type][RUNLIST_ARGS]:
        while True:
            try:
                user_input = input('{}: '.format(arg))
                if user_input in EXIT_CONSTS:
                    print('Aborting. New run not added.')
                    return (run_list, template_dict)
                elif user_input in HELP_CONSTS:
                    print('Annotation:\n{}\nType:\n{}\n'.format(
                        template_dict[template_type]['annotations'][arg],
                        template_dict[template_type]['types'][arg]))
                else:
                    try:
                        type_func = TYPE_CHECK_FUNC[template_dict[template_type]
                                                    [TEMPLATE_TYPES][arg]]
                        user_input = type_func(user_input)
                        new_run[RUNLIST_ARGS][arg] = user_input
                        break
                    except:
                        print('Invalid input.')
            except:
                print('Invalid input.')
    while True:
        if input('Add run {} to list? '.format(new_tag)) in YES_CONSTS:
            run_list.append(new_run)
            print('Run {} added to list.'.format(new_tag))
            return run_list, template_dict
        else:
            if input('Discard new run {}? '.format(new_tag)) in YES_CONSTS:
                return run_list, template_dict

    return run_list, template_dict


def create_template(run_list, template_dict):
    new_template = {}
    new_template[TEMPLATE_ARGS] = []
    new_template[TEMPLATE_ANNO] = {}
    new_template[TEMPLATE_TYPES] = {}
    new_template[TEMPLATE_TRANS] = {}
    new_template[TEMPLATE_DEFAULT] = {}

    # Template name must be unique.
    while True:
        new_template_name = input('Input the name of the new Template. ')
        if new_template_name not in template_dict.keys():
            break
        if input('Template name already exists! Do you want to delete it? ')\
           in YES_CONSTS:
            break

    # Args.
    while True:
        new_arg = input('Input an arg. ')
        if not new_arg:
            continue
        if new_arg in EXIT_CONSTS:
            break
        if new_arg in new_template[TEMPLATE_ARGS]:
            if input('Argument already exists! Overwrite? ') not in YES_CONSTS:
                continue
        new_arg_type = input('Input a type for the arg. Default is string. ')
        if new_arg_type in EXIT_CONSTS:
            break
        # TODO: Needs validation!!
        new_arg_annotation = input('Input an annotation for the arg. ')
        if new_arg_annotation in EXIT_CONSTS:
            break
        new_arg_trans = input('Input the property that will be modified. '\
                              'Blank input skips this step. ')
        if new_arg_trans in EXIT_CONSTS:
            break

        print('Current argument:\n', 'Arg: {}\n'.format(new_arg),
              'Type: {}\n'.format(new_arg_type),
              'Annotation: {}\n'.format(new_arg_annotation),
              'Translation: {}'.format(new_arg_trans))
        if input('Add to the argument? ') in YES_CONSTS:
            if new_arg not in new_template[TEMPLATE_ARGS]:
                new_template[TEMPLATE_ARGS].append(new_arg)
            new_template[TEMPLATE_ANNO][new_arg] = new_arg_annotation
            new_template[TEMPLATE_TYPES][new_arg] = new_arg_type
            if new_arg_trans:
                new_template[TEMPLATE_TRANS][new_arg] = new_arg_trans

    # Default props.
    while True:
        default_property = input('Input a default property. Blank or \'exit\' '\
                                 'exits. ')
        if not default_property or default_property in EXIT_CONSTS:
            break
        if default_property in new_template[TEMPLATE_DEFAULT].keys():
            if input('Property is already in template! Overwrite? ')\
                in YES_CONSTS:
                continue
        value = input('Input a value for the property. ')
        new_template[TEMPLATE_DEFAULT][default_property] = value

    if input('Add template to the TateConfig? ') in YES_CONSTS:
        template_dict[new_template_name] = new_template
        print('Template {} added.'.format(new_template_name))
    else:
        if input('Are you sure? ') not in YES_CONSTS:
            template_dict[new_template_name] = new_template
            print('Template {} added.'.format(new_template_name))

    return run_list, template_dict


def delete_run(run_list, template_dict):
    print('Input the tag of the Run that you want to delete. Available tags')
    print('are {}'.format(' '.join(run[TAG_ARG] for run in run_list)))
    delete_tag = input('-> ')

    new_run_list = [run for run in run_list if run[TAG_ARG] != delete_tag]
    if len(run_list) == len(new_run_list):
        print('Tag {} does not exist.'.format(delete_tag))
    else:
        if input('Found tag {}. Do you want to delete? '.format(delete_tag)) \
           in YES_CONSTS:
            print('Tag {} deleted.'.format(delete_tag))
            run_list = new_run_list
        else:
            print('Deletion of tag {} cancelled.'.format(delete_tag))
    return run_list, template_dict


def copy_run(run_list, template_dict):
    print('Input the tag of the Run that you want to copy. Available tags')
    print('are {}'.format(' '.join(run[TAG_ARG] for run in run_list)))
    old_run_tag = input('-> ')

    if old_run_tag in EXIT_CONSTS:
        return run_list, template_dict

    old_run = find_run_tag(old_run_tag, run_list)
    if not old_run:
        print('Tag {} not found.'.format(old_run_tag))
        return run_list, template_dict
    print('Tag {} found.'.format(old_run_tag))

    new_run = copy.deepcopy(old_run)
    while True:
        new_run_tag = input('Input the tag of the new run. ')
        if new_run_tag in EXIT_CONSTS:
            return run_list, template_dict
        if not new_run_tag or new_run_tag in HELP_CONSTS:
            continue
        if tag_in_runlist(new_run_tag, run_list):
            print('Tag {} already exists!'.format(new_run_tag))
        else:
            new_run[TAG_ARG] = new_run_tag
            break

    if input('Add run {} to RunList? '.format(new_run_tag)) in YES_CONSTS:
        print('Added run {} to RunList.'.format(new_run_tag))
        run_list.append(new_run)
    else:
        print('Run {} not copied.'.format(old_run_tag))
    return run_list, template_dict


def edit_run(run_list, template_dict):
    edit_tag = input('Input the tag of the Run you want to edit. ')

    if not edit_tag or edit_tag in EXIT_CONSTS:
        return run_list, template_dict

    old_run = find_run_tag(edit_tag, run_list)
    if not old_run:
        print('Tag {} not found.'.format(edit_tag))
        return run_list, template_dict
    new_run = copy.deepcopy(old_run)

    # Edit the name.
    while True:
        new_tag = input('Input a new tag name. Blank input keeps it the same. ')
        if not new_tag:
            break
        if new_tag != old_run[TAG_ARG] and tag_in_runlist(new_tag, run_list):
            print('Tag already exists! Input a new tag.')
        else:
            new_run[TAG_ARG] = new_tag
            break

    for arg in template_dict[new_run[RUN_TEMPLATE_TYPE]][TEMPLATE_ARGS]:
        while True:
            try:
                user_input = input('Input new value for {}. Current value = {} '\
                               .format(arg, new_run[RUNLIST_ARGS][arg]))
                if user_input in HELP_CONSTS:
                    continue
                if user_input in EXIT_CONSTS:
                    return run_list, template_dict
                if not user_input:
                    # Blank input = no change.
                    break
                # TODO: Validation!
                new_run[RUNLIST_ARGS][arg] = user_input
                break
            except:
                print('Invalid input.')


    if input('Are you sure you want to change run {}? '\
             .format(old_run[TAG_ARG])) in YES_CONSTS:
        # Find the index of old_run and create a new list with new_run in its
        # place.
        for index, run in enumerate(run_list):
            if run == old_run:
                print('Run {} changed.'.format(old_run[TAG_ARG]))
                return (run_list[:index] + [new_run] + run_list[index + 1:],
                        template_dict)
        print('Something terribly wrong has happened. Cancelled.')
    else:
        print('Edit of Run {} cancelled.'.format(old_run[TAG_ARG]))
    return run_list, template_dict


def delete_template(run_list, template_dict):
    delete_tag = input('Enter the tag of the template you want to delete. ')
    if delete_tag not in template_dict.keys():
        print('Tag not found!')
        return run_list, template_dict
    if input('Are you sure you want to delete template {}? '\
             .format(delete_tag)) in YES_CONSTS:
        del template_dict[delete_tag]
        print('Template {} deleted.'.format(delete_tag))
    else:
        print('Deletion of Template {} cancelled.'.format(delete_tag))
    return run_list, template_dict


def save_tate(run_list, template_dict):
    filename = input('Input a filename to save the TateConfig to. ')
    if not filename or filename in EXIT_CONSTS:
        print('Save cancelled.')
        return run_list, template_dict
    if input('Are you sure you want to save to {}? '.format(filename))\
        in YES_CONSTS:
        try:
            write_json(filename, {
                RUN_LIST: run_list,
                TEMPLATE_DATA: template_dict
            })
            print('Saved TateConfig to {}'.format(filename))
        except:
            print('Unable to save to {}.'.format(filename))
    return run_list, template_dict


def load_tate(run_list, template_dict):
    filename = input('Input a filename to load the TateConfig from. ')
    if not filename or filename in EXIT_CONSTS:
        print('Load cancelled.')
    elif input('Are you sure you want to load from {}? '.format(filename))\
        in YES_CONSTS:
        try:
            new_json = read_json(filename)
            run_list = new_json[RUN_LIST]
            template_dict = new_json[TEMPLATE_DATA]
            print('Filename {} loaded.'.format(filename))
        except:
            print('Unable to load filename {}'.format(filename))
    return run_list, template_dict


def reorder_run(run_list, template_dict):
    print('Select an index to reorder.')
    for index, run in enumerate(run_list):
        print('Index {}: Tag {}'.format(index, run[TAG_ARG]))

    new_list = run_list[:]
    try:
        user_input = input('Which index do you want to reorder? ')
        if user_input in EXIT_CONSTS:
            return run_list, template_dict
        old_index = int(user_input)
        user_input = input('What index do you want it to be? ')
        if user_input in EXIT_CONSTS:
            return run_list, template_dict
        new_index = int(user_input)

        run = new_list.pop(old_index)
        new_list.insert(new_index, run)
        if input('Remove Tag {} from index {} and place it in {}? '\
                 .format(run[TAG_ARG], old_index, new_index))\
           in YES_CONSTS:
            print('Run {} removed from index {} and placed in index {}.'\
                  .format(run[TAG_ARG], old_index, new_index))
            return new_list, template_dict
    except:
        print('Invalid index.')
        return run_list, template_dict

    print('Reorder canceled.')


def error(run_dict, template_dict):
    print('Invalid input.')
    return run_dict, template_dict


def dialogue():
    """
    A dialogue function for creating, editing, and saving TateConfig objects
    as JSON objects.
    """

    default_json = 'example_config.json'

    json_filename = input('Input TateConfig filename. Default = {} '\
                          .format(default_json))
    if not json_filename:
        json_filename = default_json

    function_dict = {
        'print all': print_all_runs,
        'create run': create_run,
        'create template': create_template,
        'delete run': delete_run,
        'delete template': delete_template,
        'copy run': copy_run,
        'edit run': edit_run,
        'save tate': save_tate,
        'load tate': load_tate,
        'reorder run': reorder_run,
    }

    option_description_dict = {
        'print all': 'Print all runs',
        'create run': 'Create a run',
        'create template': 'Create a template',
        'delete run': 'Delete a run',
        'delete template': 'Delete a template',
        'copy run': 'Copy a run',
        'edit run': 'Edit a run',
        'save tate': 'Save TateConfig',
        'load tate': 'Load TateConfig',
        'reorder run': 'Reorder a run',
    }

    try:
        tate_config = read_json(json_filename)
        run_list = tate_config[RUN_LIST]
        template_dict = tate_config[TEMPLATE_DATA]
    except:
        user_input = input("Unable to open file. Open a blank file? ")
        if user_input not in YES_CONSTS:
            return
        run_list = []
        template_dict = {}
    if run_list and template_dict:
        print('TateConfig successfully loaded.')
    else:
        print('Blank TateConfig created.')

    user_input = ""

    while user_input.lower() not in EXIT_CONSTS:
        print("\nWhat would you like to do?\n")
        print_dict(option_description_dict)
        user_input = input("-> ")
        if user_input.lower() in HELP_CONSTS:
            continue
        elif user_input.lower() not in EXIT_CONSTS:
            run_list, template_dict = function_dict.get(user_input, error)(
                run_list, template_dict)
    print('Exiting.')