✨Treat keyword only parameters without defaults as option#1267
Open
wouterzwerink wants to merge 6 commits intofastapi:masterfrom
Open
✨Treat keyword only parameters without defaults as option#1267wouterzwerink wants to merge 6 commits intofastapi:masterfrom
wouterzwerink wants to merge 6 commits intofastapi:masterfrom
Conversation
Author
|
I'm not sure where to add documentation for this, i.e. what the correct page would be. If anyone from the team could make a suggestion I'd be happy to document this. |
Member
|
@wouterzwerink, thanks for your interest! I think the drawback of such approach is that it might break the existing code bases. @app.command()
def hello(
*,
formal: bool = False,
name: str, # <= This will become option..
color: str = "green",
):
passLet's wait for Sebastian to approve the idea |
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
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.
Reviving #270 to make Typer treat keyword only parameters as options even when they dont have a default.
E.g.
Will now result in the following CLI with a required flag instead of positional parameter:
python my_module --my-param valueThis is a breaking change, but I think it is the more logical behaviour. It allows people to get required options without default values in a really pythonic way that is much more intuitive than annotating type hints with
typer.Option(...).Supports #269