Raise clear error for multiple variadic arguments#1555
Open
worksbyfriday wants to merge 1 commit into
Open
Conversation
When a command has more than one argument annotated with List[...], Click raises an opaque "TypeError: Cannot have two nargs < 0". This adds validation in Typer's parameter collection to detect multiple variadic arguments early and raise a clear UsageError explaining the constraint. Closes fastapi#260
github-actions
Bot
added
the
conflicts
Contributor
|
This pull request has a merge conflict that needs to be resolved. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Closes #260.
When a command has more than one argument annotated with
List[...](or any type that maps tonargs=-1), Click raises an opaqueTypeError: Cannot have two nargs < 0. This PR adds early validation in Typer's parameter collection to detect multiple variadic arguments and raise a clearUsageErrorexplaining the constraint.Changes
get_params_convertors_ctx_param_name_from_function()to check for multiple arguments withnargs < 0click.UsageErrorwith a message naming all conflicting argumentstest_multiple_list_arguments_errorintests/test_type_conversion.pyExample
Before:
After: