diff options
Diffstat (limited to 'sandbox/paultremblay/rst_to_docbook/rst_to_docbook/options_trem.py')
| -rw-r--r-- | sandbox/paultremblay/rst_to_docbook/rst_to_docbook/options_trem.py | 387 |
1 files changed, 0 insertions, 387 deletions
diff --git a/sandbox/paultremblay/rst_to_docbook/rst_to_docbook/options_trem.py b/sandbox/paultremblay/rst_to_docbook/rst_to_docbook/options_trem.py deleted file mode 100644 index 7176b165d..000000000 --- a/sandbox/paultremblay/rst_to_docbook/rst_to_docbook/options_trem.py +++ /dev/null @@ -1,387 +0,0 @@ -# WARNING TO PAUL: DON'T EDIT THIS FILE use update.py instead. -import sys -class ParseOptions: - - """ - - Requires: - - system_string --The string from the command line - - options_dict -- a dictionary with the key equal to the opition, and - a list describing that option. (See below) - - - Returns: - - A tupple. The first item in the tupple is a dictionary containing - the arguments for each options. The second is a list of the - arguments. - - If invalid options are passed to the module, 0,0 is returned. - - Examples: - - Your script has the option '--indents', and '--output=file'. - - You want to give short option names as well: - - --i and -o=file - - Use this: - - options_dict = {'output': [1, 'o'], - 'indents': [0, 'i'] - } - - options_obj = ParseOptions( - system_string = sys.argv, - options_dict = options_dict - ) - - options, arguments = options_obj.parse_options() - print options - print arguments - - The result will be: - - - {indents:None, output:'/home/paul/file'}, ['/home/paul/input'] - - - """ - def __init__(self, system_string, options_dict): - self.__system_string = system_string[1:] - long_list = self.__make_long_list_func(options_dict) - # # print long_list - short_list = self.__make_short_list_func(options_dict) - # # print short_list - self.__legal_options = long_list + short_list - # # print self.__legal_options - self.__short_long_dict = self.__make_short_long_dict_func(options_dict) - # # print self.__short_long_dict - self.__opt_with_args = self.__make_options_with_arg_list(options_dict) - # # print self.__opt_with_args - self.__options_okay = 1 - - - - def __make_long_list_func(self, options_dict): - """ - Required: - - options_dict -- the dictionary mapping options to a list - - Returns: - - a list of legal options - - - - - """ - legal_list = [] - keys = options_dict.keys() - for key in keys: - key = '--' + key - legal_list.append(key) - return legal_list - - def __make_short_list_func(self, options_dict): - """ - Required: - - options_dict --the dictionary mapping options to a list - - Returns: - - a list of legal short options - - """ - legal_list = [] - keys = options_dict.keys() - for key in keys: - values = options_dict[key] - try: - legal_list.append('-' + values[1]) - except IndexError: - pass - - return legal_list - - - - def __make_short_long_dict_func(self, options_dict): - """ - Required: - - options_dict --the dictionary mapping options to a list - - Returns: - - a dictionary with keys of short options and values of long options - - """ - short_long_dict = {} - keys = options_dict.keys() - for key in keys: - values = options_dict[key] - try: - short = '-' + values[1] - long = '--' + key - short_long_dict[short] = long - except IndexError: - pass - - return short_long_dict - - def __make_options_with_arg_list(self, options_dict): - """ - Required: - - options_dict --the dictionary mapping options to a list - - Returns: - - a list of options that take arguments. - - """ - opt_with_arg = [] - keys = options_dict.keys() - for key in keys: - values = options_dict[key] - try: - if values[0]: - opt_with_arg.append('--' + key) - except IndexError: - pass - - return opt_with_arg - - - def __sub_short_with_long(self): - """ - Required: - - nothing - - Returns: - - a new system string - - Logic: - - iterate through the system string and replace short options with long options - - - """ - new_string = [] - sub_list = self.__short_long_dict.keys() - for item in self.__system_string: - if item in sub_list: - item = self.__short_long_dict[item] - new_string.append(item) - return new_string - - - - def __pair_arg_with_option(self): - - """ - - Required: - - nothing - - Returns - - nothing (changes value of self.__system_string) - - Logic: - - iterate through the system string, and match arguments with options: - - old_list = ['--foo', 'bar'] - - new_list = ['--foo=bar' - - """ - opt_len = len(self.__system_string) - new_system_string = [] - counter = 0 - slurp_value = 0 - for arg in self.__system_string: - - # previous value was an option with an argument, so this arg is - # actually an argument that has already been added - counter += 1 - if slurp_value: - slurp_value = 0 - continue - - # not an option--an argument - if arg[0] != '-': - new_system_string.append(arg) - - # option and argument already paired - elif '=' in arg: - new_system_string .append(arg) - else: - # this option takes an argument - if arg in self.__opt_with_args: - # option is the last in the list - if counter + 1 > opt_len: - sys.stderr.write('option "%s" must take an argument\n' % arg) - new_system_string.append(arg) - self.__options_okay = 0 - else: - # the next item in list is also an option - if self.__system_string[counter][0] == '-': - sys.stderr.write('option "%s" must take an argument\n' % arg) - new_system_string.append(arg) - self.__options_okay = 0 - # the next item in the list is the argument - else: - new_system_string.append(arg + '=' + self.__system_string[counter]) - slurp_value = 1 - # this option does not take an argument - else: - new_system_string.append(arg) - return new_system_string - - - def __get_just_options(self): - - """ - - Requires: - - nothing - - Returns: - - list of options - - Logic: - - Iterate through the self.__system string, looking for the last - option. The options are everything in the sysem string before the - last option. - - Check to see that the options contain no arguments. - - - """ - highest = 0 - counter = 0 - found_options = 0 - for item in self.__system_string: - if item[0] == '-': - highest = counter - found_options = 1 - counter += 1 - - if found_options: - just_options = self.__system_string[:highest + 1] - arguments = self.__system_string[highest + 1:] - else: - just_options = [] - arguments = self.__system_string - - if found_options: - for item in just_options: - if item[0] != '-': - sys.stderr.write('%s is an argument in an option list\n' % item) - self.__options_okay = 0 - return just_options, arguments - - - def __is_legal_option_func(self): - - """ - Requires: - - nothing - - Returns: - - nothing - - Logic: - - Check each value in the newly creatd options list to see if it - matches what the user describes as a legal option. - - - """ - illegal_options = [] - for arg in self.__system_string: - if '=' in arg: - temp_list = arg.split('=') - arg = temp_list[0] - if arg not in self.__legal_options and arg[0] == '-': - illegal_options.append(arg) - - if illegal_options: - self.__options_okay = 0 - sys.stderr.write('The following options are not permitted:\n') - for not_legal in illegal_options: - sys.stderr.write('%s\n' % not_legal) - - - def __make_options_dict(self, options): - options_dict = {} - for item in options: - if '=' in item: - option, arg = item.split('=') - else: - option = item - arg = None - - if option[0] == '-': - option = option[1:] - if option[0] == '-': - option = option[1:] - - options_dict[option] = arg - - return options_dict - - def parse_options(self): - self.__system_string = self.__sub_short_with_long() - # # print 'subbed list is %s' % self.__system_string - self.__system_string = self.__pair_arg_with_option() - # # print 'list with pairing is %s' % self.__system_string - options, arguments = self.__get_just_options() - # # print 'options are %s ' % options - # # print 'arguments are %s ' % arguments - self.__is_legal_option_func() - if self.__options_okay: - options_dict = self.__make_options_dict(options) - # # print options_dict - return options_dict, arguments - - else: - return 0,0 - - - - -if __name__ == '__main__': - this_dict = { - 'indents': [0, 'i'], - 'output': [1, 'o'], - 'test3': [1, 't'], - } - test_obj = ParseOptions(system_string = sys.argv, - options_dict = this_dict - ) - - options, the_args = test_obj.parse_options() - print options, the_args - - """ - this_options = ['--foo', '-o'] - this_opt_with_args = ['--foo'] - - """ |