X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=config.py;h=a608cf5101f86a046ab6759267772510e1fe020e;hb=36fea7f15ed17150691b5b3ead75450e575229ef;hp=1e690bcba70b258f04f84eefd1fca7ff07ea8ab5;hpb=4c315e387f18010ba0b5661744ad3c792f21d2d1;p=python_utils.git

diff --git a/config.py b/config.py
index 1e690bc..a608cf5 100644
--- a/config.py
+++ b/config.py
@@ -89,18 +89,20 @@ 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
 # 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 = ""):
@@ -122,14 +124,24 @@ 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.',
+)
+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.'
+    ),
 )
 
 
@@ -142,7 +154,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 +180,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
@@ -195,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:
@@ -223,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)
@@ -244,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']: