CASSPYTHON-10 Update cassandra.util.Version to better support Cassandra version strings #1273
+104
−111
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1692,57 +1692,56 @@ def __repr__(self): | |
| self.lower_bound, self.upper_bound, self.value | ||
| ) | ||
|
|
||
| VERSION_REGEX = re.compile("^(\\d+)\\.(\\d+)(\\.\\d+)?(\\.\\d+)?([~\\-]\\w[.\\w]*(?:-\\w[.\\w]*)*)?(\\+[.\\w]+)?$") | ||
|
|
||
| @total_ordering | ||
| class Version(object): | ||
| """ | ||
| Representation of a Cassandra version. Mostly follows the implementation of the same logic in the Java driver; | ||
| see https://github.com/apache/cassandra-java-driver/blob/4.19.2/core/src/main/java/com/datastax/oss/driver/api/core/Version.java. | ||
|
|
||
| Cassandra versions are assumed to correspond to major.minor.patch with an optional additional numeric build field as well as a | ||
| string prerelease field. | ||
| """ | ||
|
|
||
| def __init__(self, version): | ||
| self._version = version | ||
|
Comment on lines
1697
to
1708
There was a problem hiding this comment. The new
Contributor
Author
There was a problem hiding this comment. It's a fair point; I'll add an updated doc string back in. |
||
|
|
||
| match = VERSION_REGEX.match(version) | ||
| if not match: | ||
| raise ValueError("Version string {0} did not match expected format".format(version)) | ||
|
|
||
| self.major = int(match[1]) | ||
| self.minor = int(match[2]) | ||
|
|
||
| try: | ||
| self.patch = self._cleanup_int(match[3]) | ||
| except: | ||
| self.patch = 0 | ||
|
|
||
| try: | ||
| self.build = self._cleanup_int(match[4]) | ||
| except: | ||
| self.build = 0 | ||
|
|
||
| try: | ||
| self.prerelease = self._cleanup_str(match[5]) | ||
| except: | ||
| self.prerelease = "" | ||
|
|
||
| # This is used in a few places below so let's just build it now | ||
| self._tuple = (self.major, self.minor, self.patch, self.build, self.prerelease) | ||
|
|
||
| # Trim off the leading '.' characters and convert the discovered value to an integer | ||
| def _cleanup_int(self, instr): | ||
| return int(instr[1:]) if instr else 0 | ||
|
|
||
| # Trim off the leading '.' or '~' characters and just return the string directly | ||
| def _cleanup_str(self, instr): | ||
| return instr[1:] if instr else "" | ||
|
|
||
| def __hash__(self): | ||
| return hash(self._tuple) | ||
|
|
||
| def __repr__(self): | ||
| version_string = "Version({0}, {1}, {2}".format(self.major, self.minor, self.patch) | ||
|
|
@@ -1757,48 +1756,27 @@ def __repr__(self): | |
| def __str__(self): | ||
| return self._version | ||
|
|
||
| # Methods below leverage left-to-right positional comparison of tuples | ||
| def __eq__(self, other): | ||
| if not isinstance(other, Version): | ||
| return NotImplemented | ||
|
|
||
| return self._tuple == other._tuple | ||
|
|
||
| def __gt__(self, other): | ||
| if not isinstance(other, Version): | ||
| return NotImplemented | ||
|
|
||
| # We start by comparing the first four fields directly | ||
| self_tuple = self._tuple[:4] | ||
| other_tuple = (other.major, other.minor, other.patch, other.build) | ||
| if self_tuple != other_tuple: | ||
| return self_tuple > other_tuple | ||
| # If we're still around we have to check prereleases... prereleases always come before | ||
| # the corresponding version | ||
| elif self.prerelease and not other.prerelease: | ||
| return False | ||
bschoening marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| elif other.prerelease and not self.prerelease: | ||
| return True | ||
| else: | ||
| return self.prerelease > other.prerelease | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
Versiondocstring still doesn’t describe the supported Cassandra version formats or the comparison semantics (e.g., major/minor required, optional patch/build,-/~prerelease ordering, and whether+...build metadata is ignored). Since parsing/ordering behavior changed significantly, please document the accepted grammar and how prerelease/build metadata affect equality and ordering so callers don’t have to infer it from the regex/implementation.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know that I really want us to be in the business of describing what Cassandra versions look like. I suppose I can add a sentence explaining what we expect the format to look like but I don't want to do more than that... and even such a sentence should be pretty easily derivable from the regex.