Add ability to retrieve choices from `argparse.ArgumentParser`
@cohml is already working on this.
Since Oct 13, 2024.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Feature or enhancement
Proposal:
argparse.ArgumentParser provides a get_default method (source) for retrieving an argument's default value:
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("foo", default="bar")
parser.get_default("foo") # 'bar'
However, there is currently no way to analogously retrieve the set of choices users can choose from:
parser.add_argument("foo", choices=["bar", "baz"])
So I propose adding a get_choices method, following the structure of get_default, which provides this ability:
# argparse.py
...
class _ActionsContainer(object):
...
def get_choices(self, dest):
for action in self._actions:
if action.dest == dest:
return action.choices
This should yield the following behavior:
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("foo", choices=["bar", "baz"])
parser.add_argument("ham")
parser.get_choices("foo") # ['bar', 'baz']
parser.get_choices("ham") # None
Note that get_default also returns None when called on an argument where no default has been set:
>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> _ = parser.add_argument("foo")
>>> print(parser.get_default("foo"))
None
Here's a demonstration of this proposal in action by extending argparse.ArgumentParser:
>>> import argparse
>>> class ExtendedArgumentParser(argparse.ArgumentParser):
... def get_choices(self, dest):
... for action in self._actions:
... if action.dest == dest:
... return action.choices
...
>>> parser = ExtendedArgumentParser()
>>> _ = parser.add_argument("foo", choices=["bar", "baz"])
>>> _ = parser.add_argument("ham")
>>> print(parser.get_choices("foo"))
['bar', 'baz']
>>> print(parser.get_choices("ham"))
None
Has this already been discussed elsewhere?
This is a minor feature, which does not need previous discussion elsewhere
Links to previous discussion of this feature:
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.