Allow repeating an option that takes multiple values #1445
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
|
Thanks for updating the behavior across all commands @victorlin! I believe there are also options that use double-quotes for nargs, i.e. |
victorlin
force-pushed
the
victorlin/argparse-extend
branch
from
114e21b
to
3a758f1
Compare
|
@joverlee521 good catch, updated in force-push and now some CI tests are failing. Taking a look now |
|
I think the fix is d0d0bf0 applied everywhere |
victorlin
force-pushed
the
victorlin/argparse-extend
branch
2 times, most recently
from
5fa320c
to
4a25d3b
Compare
tsibley
reviewed
Apr 18, 2024
victorlin
force-pushed
the
victorlin/argparse-extend
branch
from
4a25d3b
to
2020618
Compare
joverlee521
reviewed
Apr 19, 2024
From PEP 8 recommendations:
Comparisons to singletons like None should always be done with is or is
not, never the equality operators.
<https://peps.python.org/pep-0008/#programming-recommendations>
victorlin
force-pushed
the
victorlin/argparse-extend
branch
2 times, most recently
from
e1fbbfc
to
3a5a6bf
Compare
victorlin
force-pushed
the
victorlin/argparse-extend
branch
from
3a5a6bf
to
e76e9ef
Compare
tsibley
approved these changes
Apr 23, 2024
joverlee521
reviewed
Apr 24, 2024
There was a problem hiding this comment.
Changes look good by inspection!
One final note that there are options that use nargs="*" that should probably also use action=extend.
Many command line arguments take multiple values. Previously, to utilize this feature, all values must be specified after a single option flag (e.g. --exclude-where 'region=A' 'region=B'). If options were set using separate option flags (e.g. --exclude-where 'region=A' --exclude-where 'region=B'), only the last flag would be used, which is unintuitive. This commit enables all option flags to be used. Done across the codebase by adding action='extend' to all options that use nargs='+' or '*' and did not already specify an action. A side effect of action='extend' is that it extends instead of replacing a default value defined in add_argument. For arguments that use a custom default value, use a custom argparse action ExtendOverwriteDefault, based on the similarly named AppendOverwriteDefault from Nextstrain CLI¹. ¹ <https://github.com/nextstrain/cli/blob/9bf646b0c795d04658a6f6807d74428b7c173995/nextstrain/cli/argparse.py#L183-L197>
victorlin
force-pushed
the
victorlin/argparse-extend
branch
from
e76e9ef
to
4ddef23
Compare
|
@joverlee521 good catch, included |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Many command line arguments take multiple values. Previously, to utilize this feature, all values must be specified after a single option flag (e.g.
--exclude-where 'region=A' 'region=B'). If options were set using separate option flags (e.g.--exclude-where 'region=A' --exclude-where 'region=B'), only the last flag would be used, which is unintuitive. This commit enables all option flags to be used.Done across the codebase by adding
action='extend'to all options that usenargs='+'and did not already specify an action.A side effect of
action='extend'is that it extends instead of replacing a default value defined inadd_argument. Allow users to continue overriding the default value by first defaulting to an empty list constant, then setting the intended default value later during argument validation.Related issue(s)
Checklist
DEFER_LIST_DEFAULT