X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=config.py;h=b6262adf29b4f64816a793cfe7a692cd85d45d14;hb=889f57512986d1b799582c58d712b304b706391c;hp=1e690bcba70b258f04f84eefd1fca7ff07ea8ab5;hpb=4c315e387f18010ba0b5661744ad3c792f21d2d1;p=python_utils.git diff --git a/config.py b/config.py index 1e690bc..b6262ad 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'------------------------------------------------------------------------------\n{program_name} uses config.py ({__file__}) for global, cross-module configuration setup and parsing.\n------------------------------------------------------------------------------' + 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 @@ -122,14 +122,14 @@ group.add_argument( '--config_dump', default=False, action='store_true', - help='Display the global configuration on STDERR at program startup.', + help='Display the global configuration (possibly derived from multiple sources) on STDERR at program startup.', ) group.add_argument( '--config_savefile', type=str, metavar='FILENAME', default=None, - help='Populate config file compatible with --config_loadfile to save config for later use.', + help='Populate config file compatible with --config_loadfile to save global config for later use.', ) @@ -142,7 +142,10 @@ def is_flag_already_in_argv(var: str): def parse(entry_module: Optional[str]) -> Dict[str, Any]: - """Main program should call this early in main()""" + """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 @@ -165,8 +168,8 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: reordered_action_groups.insert(0, group) args._action_groups = reordered_action_groups - # Examine the environment variables that match known flags. For a - # flag called --example_flag the corresponding environment + # 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