Update version parsing to allow comments

Author: AntoinePrv

VERSION

@@ -1,6 +1,10 @@
+# See PEP 440 for valid version specification
+# The following should include only numbers
 VERSION_MAJOR 0
 VERSION_MINOR 7
 VERSION_PATCH 2
-VERSION_PRE
-VERSION_POST
-VERSION_DEV
+# The following should include their whole string and can be combined.
+# They must be numbered, starting from 0.
+VERSION_PRE        # Pre release without leading dot, e.g. `a0` (alpha), `b0` (beta), or `rc0` (release candidate)
+VERSION_POST       # Post release with leading dot, e.g. `.post0`
+VERSION_DEV        # Dev release with leading dot, e.g. `.dev0`

dev/run.sh

@@ -231,12 +231,22 @@ function test_doc {
 
 
 function file_version {
-	local -r file_major="$(awk '/VERSION_MAJOR/{print $2}' "${source_dir}/VERSION")"
-	local -r file_minor="$(awk '/VERSION_MINOR/{print $2}' "${source_dir}/VERSION")"
-	local -r file_patch="$(awk '/VERSION_PATCH/{print $2}' "${source_dir}/VERSION")"
-	local -r file_pre="$(awk '/VERSION_PRE/{print $2}' "${source_dir}/VERSION")"
-	local -r file_post="$(awk '/VERSION_POST/{print $2}' "${source_dir}/VERSION")"
-	local -r file_dev="$(awk '/VERSION_DEV/{print $2}' "${source_dir}/VERSION")"
+	local -r version_text="$(cat "${source_dir}/VERSION")"
+
+	function find_version {
+		local -r version="${1}"
+		local -r regex="${version}[[:space:]]+(\.?[[:alnum:]]+)"
+		if [[ "${version_text}" =~ $regex ]]; then
+			echo "${BASH_REMATCH[1]}"
+		fi
+	}
+
+	local -r file_major="$(find_version 'VERSION_MAJOR')"
+	local -r file_minor="$(find_version 'VERSION_MINOR')"
+	local -r file_patch="$(find_version 'VERSION_PATCH')"
+	local -r file_pre="$(find_version 'VERSION_PRE')"
+	local -r file_post="$(find_version 'VERSION_POST')"
+	local -r file_dev="$(find_version 'VERSION_DEV')"
 	local version="${file_major:?}.${file_minor:?}.${file_patch:?}"
 	version+="${file_pre}${file_post}${file_dev}"
 	echo "${version}"

setup.py

@@ -20,16 +20,13 @@ def get_file(file: pathlib.Path) -> str:
 def get_version(version_file: pathlib.Path) -> str:
     """Extract version from the Ecole VERSION file according to PEP440."""
     lines = get_file(version_file)
-    version_dict = re.search(
-        r"VERSION_MAJOR\s+(?P<major>\d+)[\s\n]*"
-        r"VERSION_MINOR\s+(?P<minor>\d+)[\s\n]*"
-        r"VERSION_PATCH\s+(?P<patch>\d+)[\s\n]*"
-        r"VERSION_PRE\s+(?P<pre>.*)[\s\n]*"
-        r"VERSION_POST\s+(?P<post>.*)[\s\n]*"
-        r"VERSION_DEV\s+(?P<dev>.*)",
-        lines,
-    ).groupdict()
-    return "{major}.{minor}.{patch}{pre}{post}{dev}".format(**version_dict)
+    major = re.search(r"VERSION_MAJOR\s+(\d+)", lines).group(1)
+    minor = re.search(r"VERSION_MINOR\s+(\d+)", lines).group(1)
+    patch = re.search(r"VERSION_PATCH\s+(\d+)", lines).group(1)
+    pre = re.search(r"VERSION_PRE\s+([\.\w]*)", lines).group(1)
+    post = re.search(r"VERSION_POST\s+([\.\w]*)", lines).group(1)
+    dev = re.search(r"VERSION_DEV\s+([\.\w]*)", lines).group(1)
+    return f"{major}.{minor}.{patch}{pre}{post}{dev}"
 
 
 def get_cmake_args() -> List[str]: