mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-09 02:11:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

gh-94787: [doc] Add to argparse doc an example of a mutually-exclusive group nested in an argument group (GH-94807)

Browse source
This commit is contained in:
Scott Main 2022-09-18 01:05:43 -07:00 • committed by GitHub
parent 670007abb4
commit 810ae51787
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Doc/library/argparse.rst
View file

@ -2031,7 +2031,26 @@ Mutual exclusion
Note that currently mutually exclusive argument groups do not support the
*title* and *description* arguments of
:meth:`~ArgumentParser.add_argument_group`.
:meth:`~ArgumentParser.add_argument_group`. However, a mutually exclusive
group can be added to an argument group that has a title and description.
For example::
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_argument_group('Group title', 'Group description')
>>> exclusive_group = group.add_mutually_exclusive_group(required=True)
>>> exclusive_group.add_argument('--foo', help='foo help')
>>> exclusive_group.add_argument('--bar', help='bar help')
>>> parser.print_help()
usage: PROG [-h] (--foo FOO | --bar BAR)
options:
-h, --help show this help message and exit
Group title:
Group description
--foo FOO foo help
--bar BAR bar help
.. versionchanged:: 3.11
Calling :meth:`add_argument_group` or :meth:`add_mutually_exclusive_group`