X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=config.py;h=a608cf5101f86a046ab6759267772510e1fe020e;hb=36fea7f15ed17150691b5b3ead75450e575229ef;hp=ea5f68a296b66ea8946a61e6f85fe1891a0b33a8;hpb=eb9e6df32ed696158bf34dba6464277b648f5c74;p=python_utils.git diff --git a/config.py b/config.py index ea5f68a..a608cf5 100644 --- a/config.py +++ b/config.py @@ -89,7 +89,7 @@ args = argparse.ArgumentParser( description=None, formatter_class=argparse.ArgumentDefaultsHelpFormatter, fromfile_prefix_chars="@", - epilog=f'{program_name} uses config.py ({__file__}) for global, cross-module configuration setup and parsing.' + epilog=f'{program_name} uses config.py ({__file__}) for global, cross-module configuration setup and parsing.', ) # Keep track of if we've been called and prevent being called more @@ -133,6 +133,16 @@ group.add_argument( default=None, help='Populate config file compatible with --config_loadfile to save global config for later use.', ) +group.add_argument( + '--config_rejects_unrecognized_arguments', + default=False, + action='store_true', + help=( + 'If present, config will raise an exception if it doesn\'t recognize an argument. The ' + + 'default behavior is to ignore this so as to allow interoperability with programs that ' + + 'want to use their own argparse calls to parse their own, separate commandline args.' + ), +) def is_flag_already_in_argv(var: str): @@ -200,6 +210,7 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: f'Initialized from environment: {var} = {value}' ) from string_utils import to_bool + if len(chunks) == 1 and to_bool(value): sys.argv.append(var) elif len(chunks) > 1: @@ -228,16 +239,22 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: if loadfile is not None: if saw_other_args: - msg = f'Augmenting commandline arguments with those from {loadfile}.' + 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) + print( + f'ERROR: --config_loadfile argument must be a file, {loadfile} not found.', + file=sys.stderr, + ) sys.exit(-1) 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 # Parse (possibly augmented, possibly completely overwritten) @@ -249,15 +266,21 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: # future argument parsers. For example, unittest_main in python # has some of its own flags. If we didn't recognize it, maybe # someone else will. + if len(unknown) > 0: + if config['config_rejects_unrecognized_arguments']: + 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}' + ) sys.argv = sys.argv[:1] + unknown # Check for savefile and populate it if requested. savefile = config['config_savefile'] if savefile and len(savefile) > 0: with open(savefile, 'w') as wf: - wf.write( - "\n".join(original_argv[1:]) - ) + wf.write("\n".join(original_argv[1:])) # Also dump the config on stderr if requested. if config['config_dump']: