fix: guard default value comparison against types with strict __eq__#3327
Closed
Bahtya wants to merge 1 commit intopallets:mainfrom
Closed
fix: guard default value comparison against types with strict __eq__#3327Bahtya wants to merge 1 commit intopallets:mainfrom
Bahtya wants to merge 1 commit intopallets:mainfrom
Conversation
Fixes pallets#3298. When a non-string default value (e.g. semver.Version) is used with an option, Click help text builder compares it against an empty string using ==. Types that implement __eq__ to only accept specific types will raise a ValueError. Add an isinstance(default_value, str) guard before the equality check so non-string types fall through to str(default_value) instead.
Collaborator
|
AI slop duplicating: #3299 |
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.
Problem
Fixes #3298
When a non-string default value (e.g.
semver.Version) is used with an@click.option, Click tries to generate help text and compares the default value against an empty string using==. Types likesemver.Versionimplement__eq__to only accept strings that parse as valid semver, soVersion(1,0,0) == ""raisesValueError.Root Cause
In
core.pyline ~3113:This equality check is triggered for any type of default value, not just strings. For types with strict
__eq__implementations, this crashes.Fix
Add an
isinstance(default_value, str)guard before the== ""check, so non-string types fall through to thestr(default_value)branch which works correctly for all types.Testing
Existing test suite passes (331 passed; 1 pre-existing failure unrelated to this change).