X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=config.py;h=1ac5cff30add3fcbd0eb0a03d7361f06515cbbfe;hb=b22b39493c5b6c747b16e9430f3833bb8869cef6;hp=588b7e072006d6d27cbf115e7220f9e40b6cc706;hpb=9eba12cba5641d6a0b988038694cbc2dd52800c5;p=python_utils.git diff --git a/config.py b/config.py index 588b7e0..1ac5cff 100644 --- a/config.py +++ b/config.py @@ -84,10 +84,24 @@ 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.', ) @@ -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: @@ -191,9 +209,7 @@ def augment_sys_argv_from_environment_variables(): 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): @@ -282,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.