X-Git-Url: https://tinc-vpn.org/git/browse?a=blobdiff_plain;f=version.py;h=3213e3277a3a4dac17f71a4c368bc67b4031c574;hb=2ded4a80352dfbbd17b35ae0eafcbdc62243d574;hp=b4fb38afae8ec239424dd07139a56cb58ec15880;hpb=6049b67f1e1cf00da8e0e913b8adc81a7b16bb87;p=tinc

diff --git a/version.py b/version.py
index b4fb38af..3213e327 100755
--- a/version.py
+++ b/version.py
@@ -1,30 +1,39 @@
 #!/usr/bin/env python3
 
+"""Print current tinc version for using in build scripts.
+
+First try to determine the latest version using git tags. If this fails (because
+the .git directory is missing, git is not installed, or for some other reason),
+fall back to using the VERSION file. If it is not present or could not be read,
+use 'unknown'.
+"""
+
 from os import path, environ
 from sys import argv, stderr
 import subprocess as subp
+import typing as T
 
-prefix = "release-"
-source_root = path.dirname(path.realpath(__file__))
-source_root = environ.get("MESON_SOURCE_ROOT", source_root)
+PREFIX = "release-"
+SOURCE_ROOT = path.dirname(path.realpath(__file__))
+SOURCE_ROOT = environ.get("MESON_SOURCE_ROOT", SOURCE_ROOT)
 
 cmd = [
     "git",
     "--git-dir",
-    path.join(source_root, ".git"),
+    path.join(SOURCE_ROOT, ".git"),
     "describe",
     "--always",
     "--tags",
-    "--match=" + prefix + "*",
+    "--match=" + PREFIX + "*",
 ]
 
 if "short" in argv:
     cmd.append("--abbrev=0")
 
-version = None
+version: T.Optional[str] = None
 
 try:
-    result = subp.run(cmd, stdout=subp.PIPE, encoding="utf-8")
+    result = subp.run(cmd, stdout=subp.PIPE, encoding="utf-8", check=False)
     if not result.returncode:
         version = result.stdout
 except FileNotFoundError:
@@ -32,11 +41,11 @@ except FileNotFoundError:
 
 if not version:
     try:
-        with open(path.join(source_root, "VERSION"), "r") as f:
+        with open(path.join(SOURCE_ROOT, "VERSION"), "r", encoding="utf-8") as f:
             version = f.read().strip()
     except OSError as e:
         print("could not read version from file", e, file=stderr)
-elif version.startswith(prefix):
-    version = version[len(prefix):].strip()
+elif version.startswith(PREFIX):
+    version = version[len(PREFIX) :].strip()
 
 print(version if version else "unknown", end="")