Add support for argument choices, like argparse

Open
#930 1 comment 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cli

Research direction

Start at the task decorator and its existing help option handling. Trace where task option values are parsed, then compare the requested choices behavior with argparse; done means choices can be declared there and invalid values are handled consistently.

Written by the indexing model from the issue text.

Description

I have a ton of use cases where it would be beneficial to be able to define the valid choices for an option, much like argparse can:

https://docs.python.org/3/library/argparse.html#choices

My suggestion would be to add this as a map to the task decorator similiar to how help works now:

@task(choices={'foo': ['a', 'b', 'c']})
def mytask(c, foo):
    # stuff
Dominant language
Python
Stars
4.8k
Forks
412
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pyinvoke/invoke

All issues in pyinvoke/invoke

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.