(original) (raw)

changeset: 74526:35665f6f3674 branch: 2.7 parent: 74521:d01208ba482f user: Sandro Tosi sandro.tosi@gmail.com date: Thu Jan 19 21:59:34 2012 +0100 files: Doc/library/argparse.rst description: Issue #13605: add documentation for nargs=argparse.REMAINDER diff -r d01208ba482f -r 35665f6f3674 Doc/library/argparse.rst --- a/Doc/library/argparse.rst Thu Jan 19 11:28:15 2012 +0100 +++ b/Doc/library/argparse.rst Thu Jan 19 21:59:34 2012 +0100 @@ -838,6 +838,17 @@ 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. /sandro.tosi@gmail.com