X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=config.py;h=7bf812e202be17b0093a04f786d6315414ceb5be;hb=02302bbd9363facb59c4df2c1f4013087702cfa6;hp=bea701837c520ca86d584f9b48cead98ab06e838;hpb=532df2c5b57c7517dfb3dddd8c1358fbadf8baf3;p=python_utils.git diff --git a/config.py b/config.py index bea7018..7bf812e 100644 --- a/config.py +++ b/config.py @@ -7,64 +7,77 @@ and saved configuration files. This works across several modules. Usage: - module.py: - ---------- - import config - - parser = config.add_commandline_args( - "Module", - "Args related to module doing the thing.", - ) - parser.add_argument( - "--module_do_the_thing", - type=bool, - default=True, - help="Should the module do the thing?" - ) - - main.py: - -------- - import config - - def main() -> None: + In your file.py:: + + import config + parser = config.add_commandline_args( - "Main", - "A program that does the thing.", + "Module", + "Args related to module doing the thing.", ) parser.add_argument( - "--dry_run", + "--module_do_the_thing", type=bool, - default=False, - help="Should we really do the thing?" + default=True, + help="Should the module do the thing?" ) - config.parse() # Very important, this must be invoked! + + In your main.py:: + + import config + + def main() -> None: + parser = config.add_commandline_args( + "Main", + "A program that does the thing.", + ) + parser.add_argument( + "--dry_run", + type=bool, + default=False, + help="Should we really do the thing?" + ) + config.parse() # Very important, this must be invoked! If you set this up and remember to invoke config.parse(), all commandline arguments will play nicely together. This is done automatically for you - if you're using the bootstrap module's initialize wrapper. + if you're using the :meth:`bootstrap.initialize` decorator on + your program's entry point. See :meth:`python_modules.bootstrap.initialize` + for more details.:: + + import bootstrap + + @bootstrap.initialize + def main(): + whatever - % main.py -h - usage: main.py [-h] - [--module_do_the_thing MODULE_DO_THE_THING] - [--dry_run DRY_RUN] + if __name__ == '__main__': + main() - Module: - Args related to module doing the thing. + Either way, you'll get this behavior from the commandline:: - --module_do_the_thing MODULE_DO_THE_THING - Should the module do the thing? + % main.py -h + usage: main.py [-h] + [--module_do_the_thing MODULE_DO_THE_THING] + [--dry_run DRY_RUN] - Main: - A program that does the thing + Module: + Args related to module doing the thing. - --dry_run - Should we really do the thing? + --module_do_the_thing MODULE_DO_THE_THING + Should the module do the thing? + + Main: + A program that does the thing + + --dry_run + Should we really do the thing? Arguments themselves should be accessed via - config.config['arg_name']. e.g. + :code:`config.config['arg_name']`. e.g.:: - if not config.config['dry_run']: - module.do_the_thing() + if not config.config['dry_run']: + module.do_the_thing() """ @@ -92,6 +105,33 @@ class OptionalRawFormatter(argparse.HelpFormatter): "RAW|". In that case, the line breaks are preserved and the text is not wrapped. + Use this, for example, when you need the helptext of an argument + to have its spacing preserved exactly, e.g.:: + + args.add_argument( + '--mode', + type=str, + default='PLAY', + choices=['CHEAT', 'AUTOPLAY', 'SELFTEST', 'PRECOMPUTE', 'PLAY'], + metavar='MODE', + help='''RAW|Our mode of operation. One of: + + PLAY = play wordle with me! Pick a random solution or + specify a solution with --template. + + CHEAT = given a --template and, optionally, --letters_in_word + and/or --letters_to_avoid, return the best guess word; + + AUTOPLAY = given a complete word in --template, guess it step + by step showing work; + + SELFTEST = autoplay every possible solution keeping track of + wins/losses and average number of guesses; + + PRECOMPUTE = populate hash table with optimal guesses. + ''', + ) + """ def _split_lines(self, text, width): @@ -106,6 +146,11 @@ ARGS = argparse.ArgumentParser( formatter_class=OptionalRawFormatter, fromfile_prefix_chars="@", epilog=f'{PROGRAM_NAME} uses config.py ({__file__}) for global, cross-module configuration setup and parsing.', + # I don't fully understand why but when loaded by sphinx sometimes + # the same module is loaded many times causing any arguments it + # registers via module-level code to be redefined. Work around + # this iff the program is 'sphinx-build' + conflict_handler='resolve' if PROGRAM_NAME == 'sphinx-build' else 'error', ) # Keep track of if we've been called and prevent being called more @@ -122,8 +167,16 @@ config: Dict[str, Any] = {} # It would be really nice if this shit worked from interactive python -def add_commandline_args(title: str, description: str = ""): - """Create a new context for arguments and return a handle.""" +def add_commandline_args(title: str, description: str = "") -> argparse._ArgumentGroup: + """Create a new context for arguments and return a handle. + + Args: + title: A title for your module's commandline arguments group. + description: A helpful description of your module. + + Returns: + An argparse._ArgumentGroup to be populated by the caller. + """ return ARGS.add_argument_group(title, description) @@ -163,18 +216,33 @@ group.add_argument( def overwrite_argparse_epilog(msg: str) -> None: + """Allows your code to override the default epilog created by + argparse. + + Args: + msg: The epilog message to substitute for the default. + """ ARGS.epilog = msg -def is_flag_already_in_argv(var: str): - """Is a particular flag passed on the commandline?""" +def is_flag_already_in_argv(var: str) -> bool: + """Returns true if a particular flag is passed on the commandline? + + Args: + var: The flag to search for. + """ for _ in sys.argv: if var in _: return True return False -def reorder_arg_action_groups_before_help(entry_module: Optional[str]): +def _reorder_arg_action_groups_before_help(entry_module: Optional[str]): + """Internal. Used to reorder the arguments before dumping out a + generated help string such that the main program's arguments come + last. + + """ reordered_action_groups = [] for grp in ARGS._action_groups: if entry_module is not None and entry_module in grp.title: # type: ignore @@ -186,7 +254,21 @@ def reorder_arg_action_groups_before_help(entry_module: Optional[str]): return reordered_action_groups -def augment_sys_argv_from_environment_variables(): +def _augment_sys_argv_from_environment_variables(): + """Internal. Look at the system environment for variables that match + arg names. This is done via some munging such that: + + :code:`--argument_to_match` + + ...is matched by: + + :code:`ARGUMENT_TO_MATCH` + + This allows programmers to set args via shell environment variables + in lieu of passing them on the cmdline. + + """ + usage_message = ARGS.format_usage() optional = False var = '' @@ -222,7 +304,9 @@ def augment_sys_argv_from_environment_variables(): env = '' -def augment_sys_argv_from_loadfile(): +def _augment_sys_argv_from_loadfile(): + """Internal. Augment with arguments persisted in a saved file.""" + loadfile = None saw_other_args = False grab_next_arg = False @@ -258,7 +342,8 @@ def augment_sys_argv_from_loadfile(): def parse(entry_module: Optional[str]) -> Dict[str, Any]: """Main program should call this early in main(). Note that the - bootstrap.initialize wrapper takes care of this automatically. + :code:`bootstrap.initialize` wrapper takes care of this automatically. + This should only be called once per program invocation. """ global CONFIG_PARSE_CALLED @@ -273,17 +358,17 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: if arg in ('--help', '-h'): if entry_module is not None: entry_module = os.path.basename(entry_module) - ARGS._action_groups = reorder_arg_action_groups_before_help(entry_module) + ARGS._action_groups = _reorder_arg_action_groups_before_help(entry_module) # Examine the environment for variables that match known flags. # For a flag called --example_flag the corresponding environment # variable would be called EXAMPLE_FLAG. If found, hackily add # these into sys.argv to be parsed. - augment_sys_argv_from_environment_variables() + _augment_sys_argv_from_environment_variables() # Look for loadfile and read/parse it if present. This also # works by jamming these values onto sys.argv. - augment_sys_argv_from_loadfile() + _augment_sys_argv_from_loadfile() # Parse (possibly augmented, possibly completely overwritten) # commandline args with argparse normally and populate config. @@ -317,7 +402,7 @@ def parse(entry_module: Optional[str]) -> Dict[str, Any]: def has_been_parsed() -> bool: - """Has the global config been parsed yet?""" + """Returns True iff the global config has already been parsed""" return CONFIG_PARSE_CALLED