summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorSandro Tosi <sandro.tosi@gmail.com>2012-01-19 21:00:21 (GMT)
committerSandro Tosi <sandro.tosi@gmail.com>2012-01-19 21:00:21 (GMT)
commit83d32c9135b75b366ebe0542b4c677c32682b0e1 (patch)
treed5a5fdb27075b30993dc70b77f93e64a0cba1afd /Doc
parent188bee58737d366ea4bf296972d3389f64d1dae7 (diff)
parent16bd0b44636b1fe21def21b6e2537b58315d3fc6 (diff)
downloadcpython-83d32c9135b75b366ebe0542b4c677c32682b0e1.zip
cpython-83d32c9135b75b366ebe0542b4c677c32682b0e1.tar.gz
cpython-83d32c9135b75b366ebe0542b4c677c32682b0e1.tar.bz2
Issue #13605: merge with 3.2
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/argparse.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 1f0ea2d..8ddccfb 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -859,6 +859,17 @@ values are:
usage: PROG [-h] foo [foo ...]
PROG: error: too few arguments
+* ``argparse.REMAINDER``. All the remaining command-line arguments
+ are gathered into a lits. This is commonly useful for command line
+ utilities that dispatch to other command line utilities.
+
+ >>> parser = argparse.ArgumentParser(prog='PROG')
+ >>> parser.add_argument('--foo')
+ >>> parser.add_argument('command')
+ >>> parser.add_argument('args', nargs=argparse.REMAINDER)
+ >>> print parser.parse_args('--foo B XX YY ZZ'.split())
+ Namespace(args=['YY', 'ZZ'], command='XX', foo='B')
+
If the ``nargs`` keyword argument is not provided, the number of arguments consumed
is determined by the action_. Generally this means a single command-line argument
will be consumed and a single item (not a list) will be produced.