Issue #16933 (merge from 3.2): Improve choices examples in argparse docs.

This commit is contained in:
Chris Jerdonek 2013-01-11 19:28:05 -08:00
commit 71e39fb484

View File

@ -1022,32 +1022,33 @@ choices
^^^^^^^ ^^^^^^^
Some command-line arguments should be selected from a restricted set of values. Some command-line arguments should be selected from a restricted set of values.
These can be handled by passing a container object as the ``choices`` keyword These can be handled by passing a container object as the *choices* keyword
argument to :meth:`~ArgumentParser.add_argument`. When the command line is argument to :meth:`~ArgumentParser.add_argument`. When the command line is
parsed, argument values will be checked, and an error message will be displayed if parsed, argument values will be checked, and an error message will be displayed
the argument was not one of the acceptable values:: if the argument was not one of the acceptable values::
>>> parser = argparse.ArgumentParser(prog='PROG') >>> parser = argparse.ArgumentParser(prog='game.py')
>>> parser.add_argument('foo', choices='abc') >>> parser.add_argument('move', choices=['rock', 'paper', 'scissors'])
>>> parser.parse_args('c'.split()) >>> parser.parse_args(['rock'])
Namespace(foo='c') Namespace(move='rock')
>>> parser.parse_args('X'.split()) >>> parser.parse_args(['fire'])
usage: PROG [-h] {a,b,c} usage: game.py [-h] {rock,paper,scissors}
PROG: error: argument foo: invalid choice: 'X' (choose from 'a', 'b', 'c') game.py: error: argument move: invalid choice: 'fire' (choose from 'rock',
'paper', 'scissors')
Note that inclusion in the ``choices`` container is checked after any type_ Note that inclusion in the *choices* container is checked after any type_
conversions have been performed, so the type of the objects in the ``choices`` conversions have been performed, so the type of the objects in the *choices*
container should match the type_ specified:: container should match the type_ specified::
>>> parser = argparse.ArgumentParser(prog='PROG') >>> parser = argparse.ArgumentParser(prog='doors.py')
>>> parser.add_argument('foo', type=complex, choices=[1, 1j]) >>> parser.add_argument('door', type=int, choices=range(1, 4))
>>> parser.parse_args('1j'.split()) >>> print(parser.parse_args(['3']))
Namespace(foo=1j) Namespace(door=3)
>>> parser.parse_args('-- -4'.split()) >>> parser.parse_args(['4'])
usage: PROG [-h] {1,1j} usage: doors.py [-h] {1,2,3}
PROG: error: argument foo: invalid choice: (-4+0j) (choose from 1, 1j) doors.py: error: argument door: invalid choice: 4 (choose from 1, 2, 3)
Any object that supports the ``in`` operator can be passed as the ``choices`` Any object that supports the ``in`` operator can be passed as the *choices*
value, so :class:`dict` objects, :class:`set` objects, custom containers, value, so :class:`dict` objects, :class:`set` objects, custom containers,
etc. are all supported. etc. are all supported.