Refactor canonicalize_version #793
Open
Conversation
This file contains 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
jaraco
commented
Apr 13, 2024
| >>> canonicalize_version('foo bar baz') | ||
| 'foo bar baz' | ||
| """ | ||
| return str(_TrimmedRelease(str(version)) if strip_trailing_zero else version) |
There was a problem hiding this comment.
This code would be simpler and more intuitive if Version had a copy constructor, but since it doesn't, casting to str to construct the _TrimmedRelease works nicely.
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.
In reviewing the behavior of canonicalize_version, I found the documentation and implementation to be somewhat lacking in context. The docstring alluded to a difference but didn't indicate what the difference was exactly. By comparing it with
Version.__str__, one could see that the bulk of the function was a copy/paste, but there was one bit accounting for the altered release behavior. This approach now shares the same implementation of theVersion.__str__and also takes advantage of singledispatch to separate the two forms for better separation. It also takes the opportunity to document the behaviors more fully.