Skip to content

Commit

Permalink
bpo-41024: doc: Explicitly mention use of 'enum.Enum' as a valid cont…
Browse files Browse the repository at this point in the history
…ainer for '… (GH-20964) (GH-21527)
  • Loading branch information
miss-islington committed Jul 17, 2020
1 parent a16ac4e commit 760552c
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions Doc/library/argparse.rst
Expand Up @@ -1133,6 +1133,20 @@ container should match the type_ specified::

Any container can be passed as the *choices* value, so :class:`list` objects,
:class:`set` objects, and custom containers are all supported.
This includes :class:`enum.Enum`, which could be used to restrain
argument's choices; if we reuse previous rock/paper/scissors game example,
this could be as follows::

>>> from enum import Enum
>>> class GameMove(Enum):
... ROCK = 'rock'
... PAPER = 'paper'
... SCISSORS = 'scissors'
...
>>> parser = argparse.ArgumentParser(prog='game.py')
>>> parser.add_argument('move', type=GameMove, choices=GameMove)
>>> parser.parse_args(['rock'])
Namespace(move=<GameMove.ROCK: 'rock'>)


required
Expand Down

0 comments on commit 760552c

Please sign in to comment.