Quality: Fragile version parsing can crash with unclear error#4752
Closed
tuanaiseo wants to merge 1 commit intoboto:developfrom
Closed
Conversation
`get_version()` assumes the regex always matches and calls `.group(1)` directly. If `__version__` format changes or file contents differ, setup fails with an unhelpful `AttributeError`. Affected files: setup.py Signed-off-by: tuanaiseo <221258316+tuanaiseo@users.noreply.github.com>
Contributor
|
Hi @tuanaiseo, What scenarios are you running into this error? All versions should follow this regex. Can you provide more information on your use case or how you're encountering this? |
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
2 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.
Problem
get_version()assumes the regex always matches and calls.group(1)directly. If__version__format changes or file contents differ, setup fails with an unhelpfulAttributeError.Severity:
mediumFile:
setup.pySolution
Validate regex match before dereferencing and raise a clear exception (e.g.,
RuntimeError('Unable to find __version__ in boto3/__init__.py')).Changes
setup.py(modified)Testing