refactor: use PEP440 version in semver

Author: aignas

python/private/BUILD.bazel

@@ -613,6 +613,7 @@ bzl_library(
 bzl_library(
     name = "semver_bzl",
     srcs = ["semver.bzl"],
+    deps = [":version_bzl"],
 )
 
 bzl_library(

python/private/semver.bzl

@@ -14,25 +14,7 @@
 
 "A semver version parser"
 
-def _key(version):
-    return (
-        version.major,
-        version.minor or 0,
-        version.patch or 0,
-        # non pre-release versions are higher
-        version.pre_release == "",
-        # then we compare each element of the pre_release tag separately
-        tuple([
-            (
-                i if not i.isdigit() else "",
-                # digit values take precedence
-                int(i) if i.isdigit() else 0,
-            )
-            for i in version.pre_release.split(".")
-        ]) if version.pre_release else None,
-        # And build info is just alphabetic
-        version.build,
-    )
+load(":version.bzl", "version")
 
 def _to_dict(self):
     return {
@@ -43,7 +25,7 @@ def _to_dict(self):
         "pre_release": self.pre_release,
     }
 
-def _new(*, major, minor, patch, pre_release, build, version = None):
+def _new(*, major, minor, patch, pre_release, build, ver = None):
     # buildifier: disable=uninitialized
     self = struct(
         major = int(major),
@@ -53,33 +35,35 @@ def _new(*, major, minor, patch, pre_release, build, version = None):
         pre_release = pre_release,
         build = build,
         # buildifier: disable=uninitialized
-        key = lambda: _key(self),
-        str = lambda: version,
+        key = lambda: version.key(ver),
+        str = lambda: ver.string,
         to_dict = lambda: _to_dict(self),
     )
     return self
 
-def semver(version):
+def semver(version_str):
     """Parse the semver version and return the values as a struct.
 
     Args:
-        version: {type}`str` the version string.
+        version_str: {type}`str` the version string.
 
     Returns:
         A {type}`struct` with `major`, `minor`, `patch` and `build` attributes.
     """
 
-    # Implement the https://semver.org/ spec
-    major, _, tail = version.partition(".")
-    minor, _, tail = tail.partition(".")
-    patch, _, build = tail.partition("+")
-    patch, _, pre_release = patch.partition("-")
+    # Shim the version
+    ver = version.parse(version_str, strict = True)
+    major = ver.release[0]
+    minor = ver.release[1] if len(ver.release) > 1 else None
+    patch = ver.release[2] if len(ver.release) > 2 else None
+    build = ver.local
+    pre_release = ver.pre
 
     return _new(
-        major = int(major),
-        minor = int(minor) if minor.isdigit() else None,
-        patch = int(patch) if patch.isdigit() else None,
+        major = major,
+        minor = minor,
+        patch = patch,
         build = build,
         pre_release = pre_release,
-        version = version,
+        ver = ver,
     )

tests/semver/semver_test.bzl

@@ -24,7 +24,7 @@ def _test_semver_from_major(env):
     env.expect.that_int(actual.major).equals(3)
     env.expect.that_int(actual.minor).equals(None)
     env.expect.that_int(actual.patch).equals(None)
-    env.expect.that_str(actual.build).equals("")
+    env.expect.that_str(actual.build).equals(None)
 
 _tests.append(_test_semver_from_major)
 
@@ -33,7 +33,7 @@ def _test_semver_from_major_minor_version(env):
     env.expect.that_int(actual.major).equals(4)
     env.expect.that_int(actual.minor).equals(9)
     env.expect.that_int(actual.patch).equals(None)
-    env.expect.that_str(actual.build).equals("")
+    env.expect.that_str(actual.build).equals(None)
 
 _tests.append(_test_semver_from_major_minor_version)
 
@@ -42,28 +42,22 @@ def _test_semver_with_build_info(env):
     env.expect.that_int(actual.major).equals(1)
     env.expect.that_int(actual.minor).equals(2)
     env.expect.that_int(actual.patch).equals(3)
-    env.expect.that_str(actual.build).equals("mybuild")
+    env.expect.that_str(actual.build[0]).equals("mybuild")
 
 _tests.append(_test_semver_with_build_info)
 
 def _test_semver_with_build_info_multiple_pluses(env):
-    actual = semver("1.2.3-rc0+build+info")
+    actual = semver("1.2.3-rc0+buildinfo")
     env.expect.that_int(actual.major).equals(1)
     env.expect.that_int(actual.minor).equals(2)
     env.expect.that_int(actual.patch).equals(3)
-    env.expect.that_str(actual.pre_release).equals("rc0")
-    env.expect.that_str(actual.build).equals("build+info")
+    env.expect.that_str(actual.pre_release[0]).equals("rc")
+    env.expect.that_int(actual.pre_release[1]).equals(0)
 
-_tests.append(_test_semver_with_build_info_multiple_pluses)
-
-def _test_semver_alpha_beta(env):
-    actual = semver("1.2.3-alpha.beta")
-    env.expect.that_int(actual.major).equals(1)
-    env.expect.that_int(actual.minor).equals(2)
-    env.expect.that_int(actual.patch).equals(3)
-    env.expect.that_str(actual.pre_release).equals("alpha.beta")
+    # We normalize with PEP440
+    env.expect.that_str(actual.build[0]).equals("buildinfo")
 
-_tests.append(_test_semver_alpha_beta)
+_tests.append(_test_semver_with_build_info_multiple_pluses)
 
 def _test_semver_sort(env):
     want = [
@@ -77,7 +71,6 @@ def _test_semver_sort(env):
             "0.9.12",
             "1.0.0-alpha",
             "1.0.0-alpha.1",
-            "1.0.0-alpha.beta",
             "1.0.0-beta",
             "1.0.0-beta.2",
             "1.0.0-beta.11",