From 01f7083eeef0330820e0e5d03fb83a3a8bfd2777 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Thu, 3 Feb 2022 15:44:32 -0800 Subject: [PATCH] Add a formatter that handles raw help text, optionally. --- config.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/config.py b/config.py index 42a7044..22660cc 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.', ) -- 2.47.1