]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
GH-58058: Add quick reference for `ArgumentParser` to argparse docs (gh-124227)
authorSavannah Ostrowski <savannahostrowski@gmail.com>
Wed, 25 Sep 2024 22:22:17 +0000 (15:22 -0700)
committerGitHub <noreply@github.com>
Wed, 25 Sep 2024 22:22:17 +0000 (15:22 -0700)
Doc/library/argparse.rst

index 53ecc97d5659f4382f6c88806c1a3a36c71c884e..d5a21899ae4f9900295e9ed7154d9b1ad6cafdb4 100644 (file)
@@ -25,6 +25,25 @@ will figure out how to parse those out of :data:`sys.argv`.  The :mod:`argparse`
 module also automatically generates help and usage messages.  The module
 will also issue errors when users give the program invalid arguments.
 
+Quick Links for ArgumentParser
+---------------------------------------
+========================= =========================================================================================================== ==================================================================================
+Name                      Description                                                                                                 Values
+========================= =========================================================================================================== ==================================================================================
+prog_                     The name of the program                                                                                     Defaults to ``os.path.basename(sys.argv[0])``
+usage_                    The string describing the program usage
+description_              A brief description of what the program does
+epilog_                   Additional description of the program after the argument help
+parents_                  A list of :class:`ArgumentParser` objects whose arguments should also be included
+formatter_class_          A class for customizing the help output                                                                     ``argparse.HelpFormatter``
+prefix_chars_             The set of characters that prefix optional arguments                                                        Defaults to ``'-'``
+fromfile_prefix_chars_    The set of characters that prefix files to read additional arguments from                                   Defaults to ``None`` (meaning arguments will never be treated as file references)
+argument_default_         The global default value for arguments
+allow_abbrev_             Allows long options to be abbreviated if the abbreviation is unambiguous                                    ``True`` or ``False`` (default: ``True``)
+conflict_handler_         The strategy for resolving conflicting optionals
+add_help_                 Add a ``-h/--help`` option to the parser                                                                    ``True`` or ``False`` (default: ``True``)
+exit_on_error_            Determines whether or not to exit with error info when an error occurs                                      ``True`` or ``False`` (default: ``True``)
+========================= =========================================================================================================== ==================================================================================
 
 Core Functionality
 ------------------