Apply review suggestions

- finish with a `sys.exit(0)`
- elide default `r` in `open()`
- specify `python3`
- default to `cwd=None`
- change file name to `version.py`
- reorder functions in C-like declaration order

Author: abrown

Makefile

@@ -43,8 +43,8 @@ override LLVM_CMAKE_FLAGS += -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" \
 endif
 
 # Only the major version is needed for Clang, see https://reviews.llvm.org/D125860.
-CLANG_VERSION=$(shell $(BASH) ./version llvm-major --llvm-dir=$(LLVM_PROJ_DIR))
-VERSION:=$(shell $(BASH) ./version)
+CLANG_VERSION=$(shell $(BASH) ./version.py llvm-major --llvm-dir=$(LLVM_PROJ_DIR))
+VERSION:=$(shell $(BASH) ./version.py)
 DEBUG_PREFIX_MAP=-fdebug-prefix-map=$(ROOT_DIR)=wasisdk://v$(VERSION)
 
 default: build
@@ -241,7 +241,7 @@ build/config.BUILT:
 	touch build/config.BUILT
 
 build/version.BUILT:
-	./version dump > $(BUILD_PREFIX)/VERSION
+	./version.py dump > $(BUILD_PREFIX)/VERSION
 	touch build/version.BUILT
 
 build: build/llvm.BUILT build/wasi-libc.BUILT build/compiler-rt.BUILT build/libcxx.BUILT build/config.BUILT build/version.BUILT

RELEASING.md

@@ -3,7 +3,7 @@
 To publish a new version of `wasi-sdk` as a GitHub release:
 
 1. Tag a commit with an annotated tag. Note that this must be an annotated tag,
-   not a lightweight tag, so that `version` can use it for calculating the
+   not a lightweight tag, so that `version.py` can use it for calculating the
    package version (use `git show wasi-sdk-...` to show other tag messages).
    Note that you may need to clear the repository cache to avoid problems with
    cached artifacts [^cache].

deb_from_installation.sh

@@ -18,7 +18,7 @@ fi
 if [ -n "$2" ]; then
     VERSION="$2"
 else
-    VERSION=`./version`
+    VERSION=`./version.py`
 fi
 
 if [ -n "$3" ]; then

tar_from_installation.sh

@@ -10,7 +10,7 @@ fi
 if [ -n "$2" ]; then
     VERSION="$2"
 else
-    VERSION=`./version`
+    VERSION=`./version.py`
 fi
 
 if [ -n "$3" ]; then

version version.py

@@ -1,45 +1,25 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 # This script finds and prints the various versions in this project: wasi-sdk
 # itself, LLVM, and the Git revisions of dependencies.
 #
-# Usage: version [wasi-sdk|llvm|llvm-major|dump]?
+# Usage: version [wasi-sdk|llvm|llvm-major|dump] [--llvm-dir=<non-project dir>]
 
+import sys
 import argparse
 import subprocess
 
 # The number of characters to use for the abbreviated Git revision.
 GIT_REF_LEN = 12
 
 
-def main(action, llvm_dir):
-    if action == 'wasi-sdk':
-        print(git_version())
-    elif action == 'llvm':
-        major, minor, path = llvm_cmake_version(llvm_dir)
-        print(f'{major}.{minor}.{path}')
-    elif action == 'llvm-major':
-        major, _, _ = llvm_cmake_version(llvm_dir)
-        print(major)
-    elif action == 'dump':
-        print(git_version())
-        print(f'wasi-libc: {git_commit("src/wasi-libc")}')
-        print(f'llvm: {git_commit(llvm_dir)}')
-        major, minor, path = llvm_cmake_version(llvm_dir)
-        print(f'llvm-version: {major}.{minor}.{path}')
-        print(f'config: {git_commit("src/config")}')
+def exec(command, cwd=None):
+    result = subprocess.run(command, capture_output=True, text=True, cwd=cwd)
+    return result.stdout.strip()
 
 
-def git_version():
-    version = exec(['git', 'describe', '--long', '--candidates=999',
-                    '--match=wasi-sdk-*', '--dirty=+m', f'--abbrev={GIT_REF_LEN}'])
-    major, minor, git, dirty = parse_git_version(version)
-    version = f'{major}.{minor}'
-    if git:
-        version += f'g{git}'
-    if dirty:
-        version += '+m'
-    return version
+def git_commit(dir='.'):
+    return exec(['git', 'rev-parse', f'--short={GIT_REF_LEN}', 'HEAD'], dir)
 
 
 def parse_git_version(version):
@@ -77,12 +57,24 @@ def parse_git_version(version):
     'wasi-sdk-23-0-g317548590b40') == ('23', '0', '317548590b40', False)
 
 
-def git_commit(dir='.'):
-    return exec(['git', 'rev-parse', f'--short={GIT_REF_LEN}', 'HEAD'], dir)
+def git_version():
+    version = exec(['git', 'describe', '--long', '--candidates=999',
+                    '--match=wasi-sdk-*', '--dirty=+m', f'--abbrev={GIT_REF_LEN}'])
+    major, minor, git, dirty = parse_git_version(version)
+    version = f'{major}.{minor}'
+    if git:
+        version += f'g{git}'
+    if dirty:
+        version += '+m'
+    return version
+
+
+def parse_cmake_set(line):
+    return line.split(' ')[1].split(')')[0]
 
 
 def llvm_cmake_version(llvm_dir):
-    with open(f'{llvm_dir}/llvm/CMakeLists.txt', 'r') as file:
+    with open(f'{llvm_dir}/llvm/CMakeLists.txt') as file:
         for line in file:
             line = line.strip()
             if line.startswith('set(LLVM_VERSION_MAJOR'):
@@ -94,13 +86,22 @@ def llvm_cmake_version(llvm_dir):
     return llvm_version_major, llvm_version_minor, llvm_version_patch
 
 
-def parse_cmake_set(line):
-    return line.split(' ')[1].split(')')[0]
-
-
-def exec(command, cwd='.'):
-    result = subprocess.run(command, capture_output=True, text=True, cwd=cwd)
-    return result.stdout.strip()
+def main(action, llvm_dir):
+    if action == 'wasi-sdk':
+        print(git_version())
+    elif action == 'llvm':
+        major, minor, path = llvm_cmake_version(llvm_dir)
+        print(f'{major}.{minor}.{path}')
+    elif action == 'llvm-major':
+        major, _, _ = llvm_cmake_version(llvm_dir)
+        print(major)
+    elif action == 'dump':
+        print(git_version())
+        print(f'wasi-libc: {git_commit("src/wasi-libc")}')
+        print(f'llvm: {git_commit(llvm_dir)}')
+        major, minor, path = llvm_cmake_version(llvm_dir)
+        print(f'llvm-version: {major}.{minor}.{path}')
+        print(f'config: {git_commit("src/config")}')
 
 
 if __name__ == '__main__':
@@ -117,3 +118,4 @@ def exec(command, cwd='.'):
                         help='Override the location of the LLVM source directory (default: src/llvm-project).')
     args = parser.parse_args()
     main(args.action, args.llvm_dir)
+    sys.exit(0)