CASSPYTHON-10 Update cassandra.util.Version to better support Cassandra version strings by absurdfarce · Pull Request #1273 · apache/cassandra-python-driver

absurdfarce · 2026-02-25T22:38:49Z

Code here is largely derived from the equivalent Java driver code.

… Cassandra versions

…(with new versioning scheme)

Copilot

Pull request overview

Updates cassandra.util.Version parsing/comparison to better align with Cassandra version string formats (based on the Java driver), and adjusts schema parser selection logic accordingly.

Changes:

Replaced the Version parsing/comparison implementation with a regex-based approach supporting Cassandra-style prerelease/build formats.
Updated unit tests to reflect the new parsing/comparison rules and added coverage for 4.0-alpha schema threshold behavior.
Updated schema parser selection threshold from 4-a to 4.0-alpha in metadata.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.

File	Description
`cassandra/util.py`	Reworked `Version` parsing and ordering logic using a regex-based parser.
`tests/unit/test_util_types.py`	Updated `Version` parsing/comparison test cases to match the new semantics.
`cassandra/metadata.py`	Adjusted v4 schema parser cutoff version string to match the new parser expectations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-01T14:59:04Z

cassandra/util.py

 @total_ordering
 class Version(object):
-    """
-    Internal minimalist class to compare versions.
-    A valid version is: <int>.<int>.<int>.<int or str>.
-
-    TODO: when python2 support is removed, use packaging.version.
-    """
-
-    _version = None
-    major = None
-    minor = 0
-    patch = 0
-    build = 0
-    prerelease = 0

    def __init__(self, version):
        self._version = version


The new Version implementation removed the class docstring entirely. Since cassandra.util.Version is used outside this module (e.g. in cassandra.metadata and unit tests), it should keep an up-to-date docstring describing the supported version formats and comparison semantics.

Copilot · 2026-03-01T14:59:04Z

cassandra/util.py

+VERSION_REGEX = re.compile("(\\d+)\\.(\\d+)(\\.\\d+)?(\\.\\d+)?([~\\-]\\w[.\\w]*(?:-\\w[.\\w]*)*)?(\\+[.\\w]+)?")

 @total_ordering
 class Version(object):
-    """
-    Internal minimalist class to compare versions.
-    A valid version is: <int>.<int>.<int>.<int or str>.
-
-    TODO: when python2 support is removed, use packaging.version.
-    """
-
-    _version = None
-    major = None
-    minor = 0
-    patch = 0
-    build = 0
-    prerelease = 0

    def __init__(self, version):
        self._version = version
-        if '-' in version:
-            version_without_prerelease, self.prerelease = version.split('-', 1)
-        else:
-            version_without_prerelease = version
-        parts = list(reversed(version_without_prerelease.split('.')))
-        if len(parts) > 4:
-            prerelease_string = "-{}".format(self.prerelease) if self.prerelease else ""
-            log.warning("Unrecognized version: {}. Only 4 components plus prerelease are supported. "
-                        "Assuming version as {}{}".format(version, '.'.join(parts[:-5:-1]), prerelease_string))
+
+        match = VERSION_REGEX.match(version)
+        if not match:
+            raise ValueError("Version string did not match expected format")


VERSION_REGEX.match(version) is not anchored, so it can accept only a prefix of the string and silently ignore trailing characters (e.g. 3.55.1.build12 will match 3.55.1). If the intent is strict validation, use re.fullmatch (or ^...$) so malformed versions raise. If some legacy/lenient parsing is desired, it would be safer to make that behavior explicit (e.g., a separate fallback parse with a warning) rather than relying on partial regex matches.

Copilot · 2026-03-01T14:59:05Z

cassandra/util.py

+
+        match = VERSION_REGEX.match(version)
+        if not match:
+            raise ValueError("Version string did not match expected format")


The ValueError raised on parse failure is generic ("Version string did not match expected format") and omits the offending input. Including the actual version string in the message would make troubleshooting much easier.

Suggested change

raise ValueError("Version string did not match expected format")

raise ValueError("Version string did not match expected format: {!r}".format(version))

Copilot · 2026-03-01T14:59:05Z

cassandra/util.py

        try:
-            self.major = int(parts.pop())
-        except ValueError as e:
-            raise ValueError(
-                "Couldn't parse version {}. Version should start with a number".format(version))\
-                .with_traceback(e.__traceback__)
+            self.patch = self._cleanup_int(match[3])
+        except:
+            self.patch = 0
+
        try:
-            self.minor = int(parts.pop()) if parts else 0
-            self.patch = int(parts.pop()) if parts else 0
+            self.build = self._cleanup_int(match[4])
+        except:
+            self.build = 0

-            if parts:  # we have a build version
-                build = parts.pop()
-                try:
-                    self.build = int(build)
-                except ValueError:
-                    self.build = build
-        except ValueError:
-            assumed_version = "{}.{}.{}.{}-{}".format(self.major, self.minor, self.patch, self.build, self.prerelease)
-            log.warning("Unrecognized version {}. Assuming version as {}".format(version, assumed_version))
+        try:
+            self.prerelease = self._cleanup_str(match[5])
+        except:
+            self.prerelease = 0


Avoid bare except: here. These blocks will also swallow unexpected exceptions and make debugging harder. Since _cleanup_int/_cleanup_str already handle None, the try/except may be unnecessary; otherwise, catch specific exceptions (e.g. ValueError, TypeError) and consider whether an invalid numeric component should raise vs. default to 0.

Copilot · 2026-03-01T14:59:05Z

cassandra/util.py

+    def _cleanup_str(self, str):
+        return str[1:] if str else 0


_cleanup_str uses a parameter named str, which shadows Python’s built-in str type. Rename the parameter to avoid shadowing.

Suggested change

def _cleanup_str(self, str):

return str[1:] if str else 0

def _cleanup_str(self, s):

return s[1:] if s else 0

Copilot · 2026-03-01T14:59:05Z

tests/unit/test_util_types.py

+        ]
+
+        for v in unsupported_versions:
+            print(v)


Remove the print(v) statement inside the unsupported-version loop; tests should not emit output in normal operation.

Suggested change

print(v)

Copilot · 2026-03-01T14:59:05Z

cassandra/util.py

+        return str[1:] if str else 0

    def __hash__(self):
        return self._version


Version.__hash__ returns self._version (a str). In Python 3, __hash__ must return an int, and it also needs to be consistent with __eq__. As written, calling hash(Version(...)) will raise TypeError, and even if fixed to return a string hash, it would still violate the hash/eq contract for versions that compare equal but have different original strings (e.g. 4.0-SNAPSHOT vs 4.0.0-SNAPSHOT).

Suggested change

return self._version

# Hash based on the same components used for equality, to satisfy the hash/eq contract.

return hash((self.major, self.minor, self.patch, self.build, self.prerelease))

Copilot · 2026-03-01T14:59:05Z

tests/unit/test_util_types.py

        for str_version, expected_result in versions:
+            print(str_version)
            v = Version(str_version)


Remove the print(...) statements from this unit test. They add noise to test output and can slow down/obscure CI logs; the asserts already provide sufficient failure context.

Copilot · 2026-03-01T14:59:06Z

tests/unit/test_util_types.py

        self.assertTrue(Version('4.0') > Version('4.0-SNAPSHOT'))
        self.assertTrue(Version('4.0-SNAPSHOT') == Version('4.0-SNAPSHOT'))
        self.assertTrue(Version('4.0.0-SNAPSHOT') == Version('4.0-SNAPSHOT'))
        self.assertTrue(Version('4.0.0-SNAPSHOT') == Version('4.0.0-SNAPSHOT'))
-        self.assertTrue(Version('4.0.0.build5-SNAPSHOT') == Version('4.0.0.build5-SNAPSHOT'))
+        self.assertTrue(Version('4.0.0.5-SNAPSHOT') == Version('4.0.0.5-SNAPSHOT'))


Given the new normalization behavior (e.g. Version('4.0.0-SNAPSHOT') == Version('4.0-SNAPSHOT')), add a unit test that hash() works and is consistent with equality for equivalent versions. This would catch regressions where __hash__ raises or returns inconsistent values.

bschoening · 2026-03-01T16:37:22Z

cassandra/util.py

+        elif self.build != other.build:
+            return self.build > other.build
+        elif self.prerelease and not other.prerelease:
+            return False


Python tuples can be compared directly, so something like this should work

def __gt__(self, other): # Compare as tuples return (self.major, self.minor, self.patch, self.build, not self.prerelease) < (other.major, other.minor, other.patch, other.build, not other.prerelease)

absurdfarce added 2 commits February 25, 2026 16:19

Initial cut at a new version impl that should be more compatible with…

972a262

… Cassandra versions

Re-implement current functionality to be a bit more concise

9195f76

absurdfarce requested a review from bschoening February 25, 2026 22:38

absurdfarce added 3 commits February 25, 2026 18:17

Removing some debugging

99a95ed

Update metadata version check to do the right thing re: 4.0 versions …

d63ec96

…(with new versioning scheme)

Test updates to validate change to cassandra.metadata

21c19ac

bschoening requested a review from Copilot March 1, 2026 14:55

Copilot started reviewing on behalf of bschoening March 1, 2026 14:55 View session

Copilot AI reviewed Mar 1, 2026

View reviewed changes

bschoening reviewed Mar 1, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CASSPYTHON-10 Update cassandra.util.Version to better support Cassandra version strings#1273

CASSPYTHON-10 Update cassandra.util.Version to better support Cassandra version strings#1273
absurdfarce wants to merge 5 commits intoapache:trunkfrom
absurdfarce:casspython10

absurdfarce commented Feb 25, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

bschoening Mar 1, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	raise ValueError("Version string did not match expected format")
	raise ValueError("Version string did not match expected format: {!r}".format(version))

	return self._version
	# Hash based on the same components used for equality, to satisfy the hash/eq contract.
	return hash((self.major, self.minor, self.patch, self.build, self.prerelease))

Conversation

absurdfarce commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

bschoening Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

absurdfarce commented Feb 25, 2026 •

edited

Loading

bschoening Mar 1, 2026 •

edited

Loading