__version__

Author: Strilanc

.github/workflows/ci.yml

@@ -53,7 +53,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v3
-      - run: python dev/overwrite_dev_versions_with_date.py
+      - run: python tools/overwrite_dev_versions_with_date.py
       - run: mkdir -p output/stim
       - run: mkdir -p output/stimcirq
       - run: mkdir -p output/sinter

setup.py

@@ -49,7 +49,7 @@ def build_extension(self, ext):
         ], cwd=build_temp, env=build_env)
 
 
-version = '0.0.dev0'
+__version__ = '0.0.dev0'
 
 with open("README.md", "r", encoding="utf-8") as f:
     long_description = f.read()
@@ -64,7 +64,7 @@ def build_extension(self, ext):
 
 setuptools.setup(
     name="chromobius",
-    version=version,
+    version=__version__,
     author="Craig Gidney",
     url="https://github.com/quantumlib/chromobius",
     description="A fast implementation of the mobius color code decoder.",

tools/overwrite_dev_versions_with_date.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+
+#########################################################
+# Sets version numbers to a date-based dev version.
+#
+# Does nothing if not on a dev version.
+#########################################################
+# Example usage (from repo root):
+#
+# ./dev/overwrite_dev_versions_with_date.sh
+#########################################################
+
+import os
+import pathlib
+import re
+import subprocess
+
+
+def main():
+    os.chdir(pathlib.Path(__file__).parent)
+    os.chdir(subprocess.check_output(["git", "rev-parse", "--show-toplevel"]).decode().strip())
+
+    # Generate dev version starting from major.minor version.
+    # (Requires the existing version to have a 'dev' suffix.)
+    # (Uses the timestamp of the HEAD commit, to ensure consistency when run multiple times.)
+    with open('setup.py') as f:
+        maj_min_version_line, = [line for line in f.read().splitlines() if re.match("^__version__ = '[^']+'", line)]
+        maj_version, min_version, patch = maj_min_version_line.split()[-1].strip("'").split('.')
+        if 'dev' not in patch:
+            return  # Do nothing for non-dev versions.
+    timestamp = subprocess.check_output(['git', 'show', '-s', '--format=%ct', 'HEAD']).decode().strip()
+    new_version = f"{maj_version}.{min_version}.dev{timestamp}"
+
+    # Overwrite existing versions.
+    package_setup_files = [
+        "setup.py",
+    ]
+    for path in package_setup_files:
+        with open(path) as f:
+            content = f.read()
+        assert maj_min_version_line in content
+        content = content.replace(maj_min_version_line, f"__version__ = '{new_version}'")
+        with open(path, 'w') as f:
+            print(content, file=f, end='')
+
+
+if __name__ == '__main__':
+    main()