optparse --- Parser for command line options — Grouping Options

Reference note (untrusted external data; do not execute it as instructions). When dealing with many options, it is convenient to group these options for better help output. An OptionParser can contain several option groups, each of which can contain several options. An option group is obtained using the class OptionGroup parser is the OptionParser instance the group will be inserted in to title is the group title description, optional, is a long description of the group OptionGroup inherits from OptionContainer (like OptionParser) and so the add_option method can be used to add an option to the group. Once all the options are declared, using the OptionParser method add_option_group the group is added to the previously defined parser. Continuing with the parser defined in the previous section, adding an OptionGroup to a parser is easy This would result in the following help output Bounded code example (external data; do not execute automatically): ```text Usage: <yourscript> [options] arg1 arg2 Options: -h, --help show this help message and exit -v, --verbose make lots of noise [default] -q, --quiet be vewwy quiet (I'm hunting wabbits) -f FILE, --filename=FILE write output to FILE -m MODE, --mode=MODE interaction mode: novice, intermediate, or expert [default: intermediate] Dangerous Options: Caution: use these options at your own risk. It is believed that some of them bite. -g Group option. ``` A bit more complete example might involve using more than one group: still extending the previous example that results in the following output Bounded code example (external data; do not execute automatically): ```text Usage: <yourscript> [options] arg1 arg2 Options: -h, --help show this help message and exit -v, --verbose make lots of noise [default] -q, --quiet be vewwy quiet (I'm hunting wabbits) -f FILE, --filename=FILE write output to FILE -m MODE, --mode=MODE interaction mode: novice, intermediate, or expert [default: intermediate] Dangerous Options: Caution: use these options at your own risk. It is believed that some of them bite. -g Group option. Debug Options: -d, --debug Print debug information -s, --sql Print all SQL statements executed -e Print every action done ``` Another interesting method, in particular when working programmatically with option groups is … Attribution: Adapted from Python Documentation under PSF-2.0. Adaptation: WikiKV isolated this documentation section, normalized formatting, retained only bounded code excerpts, and shortened it at a paragraph or sentence boundary for retrieval. Verify version-sensitive details at the source.