fix: show default values for single boolean flags with default=False#1490
Open
timonrieger wants to merge 1 commit intofastapi:masterfrom
Open
fix: show default values for single boolean flags with default=False#1490timonrieger wants to merge 1 commit intofastapi:masterfrom
timonrieger wants to merge 1 commit intofastapi:masterfrom
Conversation
Previously, single boolean flags (without secondary --no-* options) with default=False would not display their default value in help text, even when show_default=True was set. This made it inconsistent with dual-flag options and other parameter types. Removed the special case in _get_default_string() that hid defaults for single boolean flags with falsy default values. Now all boolean flags consistently show their default values in help text. Example: Before: --dry-run Simulate uploads without actually uploading After: --dry-run Simulate uploads without actually uploading [default: False] Fixes inconsistency where show_default=True had no effect for single boolean flags with default=False.
Author
|
alternatively we could do elif (
isinstance(obj, TyperOption)
and obj.is_bool_flag
and not obj.secondary_opts
and not default_value
+ and not (obj.show_default or ctx.show_default)
):
default_string = "" |
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.
Previously, single boolean flags (without secondary --no-* options) with
default=False would not display their default value in help text, even
when show_default=True was set. This made it inconsistent with dual-flag
options and other parameter types.
Removed the special case in _get_default_string() that hid defaults for
single boolean flags with falsy default values. Now all boolean flags
consistently show their default values in help text.
Before: --dry-run Simulate uploads without actually uploading
After: --dry-run Simulate uploads without actually uploading [default: False]
Fixes inconsistency where show_default=True had no effect for single
boolean flags with default=False.