source: branches/GUIdev/Original Trial Files (9 December 2013)/ParameterEdit3.py @ 1441

#-------------------------------------------------------------------------------
# Name:        ParameterEdit3
# Purpose:
#
# Author:      Kelvin
#
# Created:     4/12/2013
#-------------------------------------------------------------------------------

# Note to self: Make this program more modular and readable by splitting it into distinct parts and use perhaps use functions to implement them.

# Define the file names involved.
defaultParamFileName = '/u/hsu004/IntroToDuchamp/duchampDefaultParameters'
oldParamFileName = '/u/hsu004/IntroToDuchamp/duchampHIPASS.in'
newParamFileName = '/u/hsu004/Kelvin/duchampHIPASSedited.in'
userSpecifiedParamFileName = newParamFileName


# Define a simple function to determine the user's intent.
# Note that this may be very inefficient.
YES = 1
NO = 0
INVALID = -1

def toEdit(response):
    if (response == 'y') | (response == 'Y') | (response == 'yes'):
        return(YES)
    elif (response == 'n') | (response == 'N') | (response == 'no'):
        return(NO)
    else:
        return(INVALID)

def readParamFile(paramFileName):

    # Initialise an empty Dictionary.
    parameters = {}

    # Open the given parameter file.
    paramFile = open(paramFileName)

    # Load files for lines of parameter data in the specified format and
    # store them into the dictionary.
    for line in paramFile:
        if line[0] != '#' and len(line) > 1:
            linebits = line.split()
            parameters[linebits[0]] = linebits[1]

    # Go back to the start of the file.
    paramFile.seek(0, 0)

    paramFile.close()

    return parameters

def writeParamFile(newParamFileName, parameters):

    # Create a new file.
    newParamFile = open(newParamFileName, 'w')

    # Write the editted set of parameters into the new file.
    for par in parameters:
        newParamFile.write('%s    %s\n'%(par, parameters[par]))

    newParamFile.close();

    
def listParameters(parameters):

    for par in parameters:
        print(par, parameters[par])
        
    print('\n')

def editParameter():
    
    # Firstly, determine the default list of parameters
    defaultParameters = readParamFile(defaultParamFileName)

    # Display the default set of parameters.
    print('Original set of Parameters: \n')
    listParameters(defaultParameters)

    parameters = readParamFile(oldParamFileName)

    # Display the original set of parameters.
    print('Original set of Parameters: \n')
    listParameters(parameters)

    # Prompt the user about whether they want to edit any parameters.
    keepEditting = raw_input('\nWould you like to edit any of the parameters? (Type "y" for yes): ')

    # This handles the case when no parameters are to be editted.
    if toEdit(keepEditting) == NO:
        print('\nNo parameters will be editted.')
        
    if toEdit(keepEditting) == INVALID:
        keepEditting = raw_input('\nInvalid Input. Did you mistype something? Did you want to edit any of the parameters? (Type "y" for yes): ')


    # This handles the case when the parameters are to be editted.
    while toEdit(keepEditting) == YES:

        # Prompt the user for the parameter name.
        parameter2edit = raw_input('\nWhich parameter would you like to edit? \n\tParameter: ')

        # If the parameter exists, edit the parameter value.
        # Note that the value is always stored as a string, even if the value is a 'number'.
        if parameter2edit in parameters:

            oldValue = parameters[parameter2edit]
            newValue = raw_input('\nPlease enter a new value or setting for "' + parameter2edit + '": ')
            parameters[parameter2edit] = newValue
            print('\n"' + parameter2edit + '" has been updated from ' + str(oldValue) + ' to ' + str(newValue) + '!')

        # Otherwise, if no such parameters exist, tell the user.    
        else:
            print('\nThere is no such parameter as "' +  parameter2edit + '" in your file "' + oldParamFileName + '"')

        # Prompt the user again if editting is to be continued.
        keepEditting = raw_input('\nWould you like to edit any other parameters? (Type "y" for yes): ')

        # Sometimes people mistype...
        if toEdit(keepEditting) == INVALID:
            keepEditting = raw_input('\nInvalid Input. Did you mistype something? Would you like to edit any other parameters? (Type "y" for yes): ')

    # Let the user know that the editting process has ended.
    if toEdit(keepEditting) == NO:
        print('\nFinished Editting.')
    elif toEdit(keepEditting) == INVALID:
        print('\nInvalid Input. No parameters will be editted.')
        

    # Display the editted set of parameters.
    print('\nEditted set of Parameters: \n');
    listParameters(parameters)
        
    writeParamFile(newParamFileName, parameters)

def checkParameter():

    # Firstly, determine the default list of parameters
    defaultParameters = readParamFile(defaultParamFileName)   

    # Then, determine the user specified list of parameters
    userSpecifiedParameters = readParamFile(userSpecifiedParamFileName)

    parameter2check = raw_input('\nWhich parameter would you like to check? \n\tParameter: ')

    if parameter2check in userSpecifiedParameters:
        print(parameter2check + ': ' + userSpecifiedParameters[parameter2check])
    elif parameter2check in defaultParameters:
        print(parameter2check + ': ' + defaultParameters[parameter2check])
    else:
        print('\n"' + parameter2check + '" does not exist.')
        
    
def main():
    editParameter()
    checkParameter()
    
if __name__ == '__main__':
    main()