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
# than once.
config_parse_called = False
+
# A global configuration dictionary that will contain parsed arguments.
# 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: Dict[str, Any] = {}
+config = {}
+# It would be really nice if this shit worked from interactive python
def add_commandline_args(title: str, description: str = ""):
'--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.',
)
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
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