mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Wrap some long examples and signatures.

Browse source
This commit is contained in:
Georg Brandl 2011-01-09 09:04:08 +00:00
parent efb6902c3d
commit c9007081ef
1 changed files with 14 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Doc/library/argparse.rst
View file

@ -120,7 +120,9 @@ command-line args from :data:`sys.argv`.
ArgumentParser objects ArgumentParser objects
---------------------- ----------------------
.. class:: ArgumentParser([description], [epilog], [prog], [usage], [add_help], [argument_default], [parents], [prefix_chars], [conflict_handler], [formatter_class]) .. class:: ArgumentParser([description], [epilog], [prog], [usage], [add_help], \
[argument_default], [parents], [prefix_chars], \
[conflict_handler], [formatter_class])
Create a new :class:`ArgumentParser` object. Each parameter has its own more Create a new :class:`ArgumentParser` object. Each parameter has its own more
detailed description below, but in short they are: detailed description below, but in short they are:
@ -563,7 +565,9 @@ your usage messages.
The add_argument() method The add_argument() method
------------------------- -------------------------
.. method:: ArgumentParser.add_argument(name or flags..., [action], [nargs], [const], [default], [type], [choices], [required], [help], [metavar], [dest]) .. method:: ArgumentParser.add_argument(name or flags..., [action], [nargs], \
[const], [default], [type], [choices], [required], \
[help], [metavar], [dest])
Define how a single command line argument should be parsed. Each parameter Define how a single command line argument should be parsed. Each parameter
has its own more detailed description below, but in short they are: has its own more detailed description below, but in short they are:
@ -777,9 +781,11 @@ values are:
>>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'), >>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
... default=sys.stdout) ... default=sys.stdout)
>>> parser.parse_args(['input.txt', 'output.txt']) >>> parser.parse_args(['input.txt', 'output.txt'])
Namespace(infile=<open file 'input.txt', mode 'r' at 0x...>, outfile=<open file 'output.txt', mode 'w' at 0x...>) Namespace(infile=<open file 'input.txt', mode 'r' at 0x...>,
outfile=<open file 'output.txt', mode 'w' at 0x...>)
>>> parser.parse_args([]) >>> parser.parse_args([])
Namespace(infile=<open file '<stdin>', mode 'r' at 0x...>, outfile=<open file '<stdout>', mode 'w' at 0x...>) Namespace(infile=<open file '<stdin>', mode 'r' at 0x...>,
outfile=<open file '<stdout>', mode 'w' at 0x...>)
* ``'*'``. All command-line args present are gathered into a list. Note that * ``'*'``. All command-line args present are gathered into a list. Note that
it generally doesn't make much sense to have more than one positional argument it generally doesn't make much sense to have more than one positional argument
@ -1753,11 +1759,12 @@ backwards compatibility.
A partial upgrade path from optparse to argparse: A partial upgrade path from optparse to argparse:
* Replace all ``add_option()`` calls with :meth:`ArgumentParser.add_argument` calls. * Replace all ``add_option()`` calls with :meth:`ArgumentParser.add_argument`
calls.
* Replace ``options, args = parser.parse_args()`` with ``args = * Replace ``options, args = parser.parse_args()`` with ``args =
parser.parse_args()`` and add additional :meth:`ArgumentParser.add_argument` calls for the parser.parse_args()`` and add additional :meth:`ArgumentParser.add_argument`
positional arguments. calls for the positional arguments.
* Replace callback actions and the ``callback_*`` keyword arguments with * Replace callback actions and the ``callback_*`` keyword arguments with
``type`` or ``action`` arguments. ``type`` or ``action`` arguments.