[Python-checkins] r87892 - in python/branches/release27-maint: Doc/library/argparse.rst
georg.brandl
python-checkins at python.org
Sun Jan 9 10:33:09 CET 2011
Author: georg.brandl
Date: Sun Jan 9 10:33:09 2011
New Revision: 87892
Log:
Merged revisions 87890 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r87890 | georg.brandl | 2011-01-09 10:04:08 +0100 (So, 09 Jan 2011) | 1 line
Wrap some long examples and signatures.
........
Modified:
python/branches/release27-maint/ (props changed)
python/branches/release27-maint/Doc/library/argparse.rst
Modified: python/branches/release27-maint/Doc/library/argparse.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/argparse.rst (original)
+++ python/branches/release27-maint/Doc/library/argparse.rst Sun Jan 9 10:33:09 2011
@@ -120,7 +120,9 @@
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
detailed description below, but in short they are:
@@ -563,7 +565,9 @@
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
has its own more detailed description below, but in short they are:
@@ -777,9 +781,11 @@
>>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
... default=sys.stdout)
>>> 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([])
- 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
it generally doesn't make much sense to have more than one positional argument
@@ -1744,11 +1750,12 @@
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 =
- parser.parse_args()`` and add additional :meth:`ArgumentParser.add_argument` calls for the
- positional arguments.
+ parser.parse_args()`` and add additional :meth:`ArgumentParser.add_argument`
+ calls for the positional arguments.
* Replace callback actions and the ``callback_*`` keyword arguments with
``type`` or ``action`` arguments.
More information about the Python-checkins
mailing list