Add finalize_version function

peblair · peblair · commit 95b4cf1cb50a · 2017-09-23T12:03:43.000-04:00
diff --git a/semver.py b/semver.py
@@ -358,3 +358,14 @@ def bump_build(version, token='build'):
     )
     return format_version(verinfo['major'], verinfo['minor'], verinfo['patch'],
                           verinfo['prerelease'], verinfo['build'])
+
+
+def finalize_version(version):
+    """Remove any prerelease and build metadata from the version
+
+    :param version: version string
+    :return: the finalized version string
+    :rtype: str
+    """
+    verinfo = parse(version)
+    return format_version(verinfo['major'], verinfo['minor'], verinfo['patch'])
diff --git a/tests.py b/tests.py
@@ -9,6 +9,7 @@
 from semver import bump_patch
 from semver import bump_prerelease
 from semver import bump_build
+from semver import finalize_version
 from semver import min_ver
 from semver import max_ver
 from semver import VersionInfo
@@ -17,7 +18,7 @@
 SEMVERFUNCS = [
     compare, match, parse, format_version,
     bump_major, bump_minor, bump_patch, bump_prerelease, bump_build,
-    max_ver, min_ver,
+    max_ver, min_ver, finalize_version
 ]
 
 
@@ -277,6 +278,15 @@ def test_should_bump_build():
     assert bump_build('3.4.5', '') == '3.4.5+build.1'
 
 
+def test_should_finalize_version():
+    assert finalize_version('1.2.3') == '1.2.3'
+    assert finalize_version('1.2.3-rc.5') == '1.2.3'
+    assert finalize_version('1.2.3+build.2') == '1.2.3'
+    assert finalize_version('1.2.3-rc.1+build.5') == '1.2.3'
+    assert finalize_version('1.2.3-alpha') == '1.2.3'
+    assert finalize_version('1.2.0') == '1.2.0'
+
+
 def test_should_compare_version_info_objects():
     v1 = VersionInfo(major=0, minor=10, patch=4, prerelease=None, build=None)
     v2 = VersionInfo(
