mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-08 21:52:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

argparse docs: normalize constant references (#98765)

Browse source
This commit is contained in:
Skip Montanaro 2022-10-28 07:15:39 -05:00 • committed by GitHub
parent 5a8c4b9464
commit b27b57c6e4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/library/argparse.rst
View file

@ -63,7 +63,7 @@ Name Description
action_ Specify how an argument should be handled ``'store'``, ``'store_const'``, ``'store_true'``, ``'append'``, ``'append_const'``, ``'count'``, ``'help'``, ``'version'`` action_ Specify how an argument should be handled ``'store'``, ``'store_const'``, ``'store_true'``, ``'append'``, ``'append_const'``, ``'count'``, ``'help'``, ``'version'``
choices_ Limit values to a specific set of choices ``['foo', 'bar']``, ``range(1, 10)``, or :class:`~collections.abc.Container` instance choices_ Limit values to a specific set of choices ``['foo', 'bar']``, ``range(1, 10)``, or :class:`~collections.abc.Container` instance
const_ Store a constant value const_ Store a constant value
default_ Default value used when an argument is not provided Defaults to *None* default_ Default value used when an argument is not provided Defaults to ``None``
dest_ Specify the attribute name used in the result namespace dest_ Specify the attribute name used in the result namespace
help_ Help message for an argument help_ Help message for an argument
metavar_ Alternate display name for the argument as shown in help metavar_ Alternate display name for the argument as shown in help
@ -201,9 +201,10 @@ ArgumentParser objects
* usage_ - The string describing the program usage (default: generated from * usage_ - The string describing the program usage (default: generated from
arguments added to parser) arguments added to parser)
* description_ - Text to display before the argument help (default: none) * description_ - Text to display before the argument help
(by default, no text)
* epilog_ - Text to display after the argument help (default: none) * epilog_ - Text to display after the argument help (by default, no text)
* parents_ - A list of :class:`ArgumentParser` objects whose arguments should * parents_ - A list of :class:`ArgumentParser` objects whose arguments should
also be included also be included
@ -1926,8 +1927,8 @@ FileType objects
Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>) Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>)
FileType objects understand the pseudo-argument ``'-'`` and automatically FileType objects understand the pseudo-argument ``'-'`` and automatically
convert this into ``sys.stdin`` for readable :class:`FileType` objects and convert this into :data:`sys.stdin` for readable :class:`FileType` objects and
``sys.stdout`` for writable :class:`FileType` objects:: :data:`sys.stdout` for writable :class:`FileType` objects::
>>> parser = argparse.ArgumentParser() >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('infile', type=argparse.FileType('r')) >>> parser.add_argument('infile', type=argparse.FileType('r'))