X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=config.py;h=1ac5cff30add3fcbd0eb0a03d7361f06515cbbfe;hb=413d28443c7308414e8d283b9c5b9037463274f3;hp=a608cf5101f86a046ab6759267772510e1fe020e;hpb=36fea7f15ed17150691b5b3ead75450e575229ef;p=python_utils.git diff --git a/config.py b/config.py index a608cf5..1ac5cff 100644 --- a/config.py +++ b/config.py @@ -80,14 +80,28 @@ from typing import Any, Dict, List, Optional saved_messages: List[str] = [] # Make a copy of the original program arguments. -program_name = os.path.basename(sys.argv[0]) -original_argv = [arg for arg in sys.argv] +program_name: str = os.path.basename(sys.argv[0]) +original_argv: List[str] = [arg for arg in sys.argv] + + +class OptionalRawFormatter(argparse.HelpFormatter): + """This formatter has the same bahavior as the normal argparse text + formatter except when the help text of an argument begins with + "RAW|". In that case, the line breaks are preserved and the text + is not wrapped. + + """ + + def _split_lines(self, text, width): + if text.startswith('RAW|'): + return text[4:].splitlines() + return argparse.HelpFormatter._split_lines(self, text, width) # A global parser that we will collect arguments into. args = argparse.ArgumentParser( description=None, - formatter_class=argparse.ArgumentDefaultsHelpFormatter, + formatter_class=OptionalRawFormatter, fromfile_prefix_chars="@", epilog=f'{program_name} uses config.py ({__file__}) for global, cross-module configuration setup and parsing.', ) @@ -101,7 +115,7 @@ config_parse_called = False # It is also this variable that modules use to access parsed arguments. # This is the data that is most interesting to our callers; it will hold # the configuration result. -config = {} +config: Dict[str, Any] = {} # It would be really nice if this shit worked from interactive python @@ -145,6 +159,10 @@ group.add_argument( ) +def overwrite_argparse_epilog(msg: str) -> None: + args.epilog = msg + + def is_flag_already_in_argv(var: str): """Is a particular flag passed on the commandline?""" for _ in sys.argv: @@ -153,36 +171,21 @@ def is_flag_already_in_argv(var: str): return False -def parse(entry_module: Optional[str]) -> Dict[str, Any]: - """Main program should call this early in main(). Note that the - bootstrap.initialize wrapper takes care of this automatically. +def reorder_arg_action_groups(entry_module: Optional[str]): + global program_name, args + reordered_action_groups = [] + for group in args._action_groups: + if entry_module is not None and entry_module in group.title: # type: ignore + reordered_action_groups.append(group) + elif program_name in group.title: # type: ignore + reordered_action_groups.append(group) + else: + reordered_action_groups.insert(0, group) + return reordered_action_groups - """ - global config_parse_called - if config_parse_called: - return config +def augment_sys_argv_from_environment_variables(): global saved_messages - - # If we're about to do the usage message dump, put the main module's - # argument group last in the list (if possible) so that when the user - # passes -h or --help, it will be visible on the screen w/o scrolling. - reordered_action_groups = [] - global prog - for arg in sys.argv: - if arg == '--help' or arg == '-h': - for group in args._action_groups: - if entry_module is not None and entry_module in group.title: - reordered_action_groups.append(group) - elif program_name in group.title: - reordered_action_groups.append(group) - else: - reordered_action_groups.insert(0, group) - args._action_groups = reordered_action_groups - - # Examine the environment for variables that match known flags. - # For a flag called --example_flag the corresponding environment - # variable would be called EXAMPLE_FLAG. usage_message = args.format_usage() optional = False var = '' @@ -206,9 +209,7 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: if env in os.environ: if not is_flag_already_in_argv(var): value = os.environ[env] - saved_messages.append( - f'Initialized from environment: {var} = {value}' - ) + saved_messages.append(f'Initialized from environment: {var} = {value}') from string_utils import to_bool if len(chunks) == 1 and to_bool(value): @@ -218,10 +219,10 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: sys.argv.append(value) var = '' env = '' - else: - next - # Look for loadfile and read/parse it if present. + +def augment_sys_argv_from_loadfile(): + global saved_messages loadfile = None saw_other_args = False grab_next_arg = False @@ -238,25 +239,51 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: saw_other_args = True if loadfile is not None: - if saw_other_args: - msg = ( - f'Augmenting commandline arguments with those from {loadfile}.' - ) - print(msg, file=sys.stderr) - saved_messages.append(msg) if not os.path.exists(loadfile): - print( - f'ERROR: --config_loadfile argument must be a file, {loadfile} not found.', - file=sys.stderr, + raise Exception( + f'ERROR: --config_loadfile argument must be a file, {loadfile} not found.' ) - sys.exit(-1) + if saw_other_args: + msg = f'Augmenting commandline arguments with those from {loadfile}.' + else: + msg = f'Reading commandline arguments from {loadfile}.' + print(msg, file=sys.stderr) + saved_messages.append(msg) + with open(loadfile, 'r') as rf: newargs = rf.readlines() - newargs = [ - arg.strip('\n') for arg in newargs if 'config_savefile' not in arg - ] + newargs = [arg.strip('\n') for arg in newargs if 'config_savefile' not in arg] sys.argv += newargs + +def parse(entry_module: Optional[str]) -> Dict[str, Any]: + """Main program should call this early in main(). Note that the + bootstrap.initialize wrapper takes care of this automatically. + + """ + global config_parse_called + if config_parse_called: + return config + global saved_messages + + # If we're about to do the usage message dump, put the main + # module's argument group last in the list (if possible) so that + # when the user passes -h or --help, it will be visible on the + # screen w/o scrolling. + for arg in sys.argv: + if arg == '--help' or arg == '-h': + args._action_groups = reorder_arg_action_groups(entry_module) + + # Examine the environment for variables that match known flags. + # For a flag called --example_flag the corresponding environment + # variable would be called EXAMPLE_FLAG. If found, hackily add + # these into sys.argv to be parsed. + augment_sys_argv_from_environment_variables() + + # Look for loadfile and read/parse it if present. This also + # works by jamming these values onto sys.argv. + augment_sys_argv_from_loadfile() + # Parse (possibly augmented, possibly completely overwritten) # commandline args with argparse normally and populate config. known, unknown = args.parse_known_args() @@ -271,9 +298,7 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: raise Exception( f'Encountered unrecognized config argument(s) {unknown} with --config_rejects_unrecognized_arguments enabled; halting.' ) - saved_messages.append( - f'Config encountered unrecognized commandline arguments: {unknown}' - ) + saved_messages.append(f'Config encountered unrecognized commandline arguments: {unknown}') sys.argv = sys.argv[:1] + unknown # Check for savefile and populate it if requested.