Fix version to tuple (#10)

Author: almarklein

.github/workflows/ci.yml

@@ -36,3 +36,22 @@ jobs:
       run: |
           ruff format --check .
 
+  tests:
+    name: Unit tests
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v5
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.13'
+    - name: Install dependencies
+      run: |
+          python -m pip install --upgrade pip
+          pip install pytest
+    - name: Unit tests
+      run: |
+          pytest -v .

README.md

@@ -64,6 +64,3 @@ The `_version.py` is formatted with Ruff under a strict ruleset so it
 can be adopted in most projects without changes.
 
 On every change (i.e. PR) update `_version.py`'s version on the first line.
-
-We don't have tests yet, because we mainly use this for projects related to PyGfx.
-Maybe we can add some tests later ... though we don't expect this module to change much.

_version.py

@@ -1,5 +1,5 @@
 """
-_version.py v1.4
+_version.py v1.5
 
 Simple version string management, using a hard-coded version string
 for simplicity and compatibility, while adding git info at runtime.
@@ -47,21 +47,18 @@ def get_extended_version() -> str:
     """Get an extended version string with information from git."""
     release, post, labels = get_version_info_from_git()
 
-    # Sample first 3 parts of __version__
-    base_release = ".".join(__version__.split(".")[:3])
-
     # Start version string (__version__ string is leading)
-    version = base_release
+    version = base_version
     tag_prefix = "#"
 
-    if release and release != base_release:
+    if release and release != base_version:
         # Can happen between bumping and tagging. And also when merging a
         # version bump into a working branch, because we use --first-parent.
         release2, _post, _labels = get_version_info_from_git(first_parent=False)
-        if release2 != base_release:
+        if release2 != base_version:
             warning(
                 f"{project_name} version from git ({release})"
-                f" and __version__ ({base_release}) don't match."
+                f" and __version__ ({base_version}) don't match."
             )
         version += "+from_tag_" + release.replace(".", "_")
         tag_prefix = "."
@@ -121,12 +118,14 @@ def get_version_info_from_git(*, first_parent: bool = True) -> str:
 
 
 def version_to_tuple(v: str) -> tuple:
-    v = __version__.split("+")[0]  # remove hash
-    return tuple(int(i) if i.isnumeric() else i for i in v.split("."))
-
-
-def prnt(m: str) -> None:
-    sys.stdout.write(m + "\n")
+    parts = []
+    for part in v.split("."):
+        p, _, h = part.partition("#")
+        if p:
+            parts.append(p)
+        if h:
+            parts.append("#" + h)
+    return tuple(int(i) if i.isnumeric() else i for i in parts)
 
 
 def warning(m: str) -> None:
@@ -155,6 +154,10 @@ def warning(m: str) -> None:
     import sys
     import urllib.request
 
+    def prnt(m: str) -> None:
+        sys.stdout.write(m + "\n")
+        sys.stdout.flush()
+
     _, *args = sys.argv
     this_file = Path(__file__)
 
@@ -192,3 +195,4 @@ def warning(m: str) -> None:
     else:
         prnt(f"Unknown command for _version.py: {args[0]!r}")
         prnt("Use ``python _version.py help`` to see a list of options.")
+        sys.exit(1)

test_version.py

@@ -0,0 +1,92 @@
+"""A few basic tests for _version.py."""
+
+# ruff: noqa: S101, S603, ANN
+
+import subprocess
+import sys
+
+import _version
+
+example_versions = [
+    ("1", (1,)),
+    ("1.2", (1, 2)),
+    ("1.2.3", (1, 2, 3)),
+    ("1.2.3", (1, 2, 3)),
+    ("0.29.0.post4#g3175010", (0, 29, 0, "post4", "#g3175010")),
+    ("2.6.0#gcd877db.dirty", (2, 6, 0, "#gcd877db", "dirty")),
+    ("0.15.0.post16#g63b1a427.dirty", (0, 15, 0, "post16", "#g63b1a427", "dirty")),
+    ("1.#foo", (1, "#foo")),
+]
+
+
+def test_version_to_tuple() -> None:
+    """Test test_version_to_tuple function."""
+    for v, ref in example_versions:
+        t = _version.version_to_tuple(v)
+        assert t == ref, f"{v} -> {t} != {ref}"
+
+
+def test_run_as_script() -> None:
+    """Test the basics of the CLI util."""
+    # Plain call
+    p = subprocess.run(
+        [sys.executable, _version.__file__],
+        capture_output=True,
+        check=False,
+    )
+    assert p.returncode == 0
+    assert p.stderr.decode().strip() == ""
+    text = p.stdout.decode().strip()
+    assert text == "PROJECT_NAME v0.0.0"
+
+    # Use 'version'
+    p = subprocess.run(
+        [sys.executable, _version.__file__, "version"],
+        capture_output=True,
+        check=False,
+    )
+    assert p.returncode == 0
+    assert p.stderr.decode().strip() == ""
+    text = p.stdout.decode().strip()
+    assert text == "PROJECT_NAME v0.0.0"
+
+    # Use 'help'
+    p = subprocess.run(
+        [sys.executable, _version.__file__, "help"],
+        capture_output=True,
+        check=False,
+    )
+    assert p.returncode == 0
+    assert p.stderr.decode().strip() == ""
+    text = p.stdout.decode().strip()
+    assert text.startswith("_version.py")
+    assert "help" in text
+    assert "bump" in text
+    assert "update" in text
+
+    # Use false command
+    p = subprocess.run(
+        [sys.executable, _version.__file__, "foobar"],
+        capture_output=True,
+        check=False,
+    )
+    assert p.returncode == 1
+    assert p.stderr.decode().strip() == ""
+    text = p.stdout.decode().strip()
+    assert text.startswith("Unknown command")
+
+
+# %%%%%
+
+
+def run_tests(scope: dict) -> None:
+    """Small util to run all tests."""
+    for func in list(scope.values()):
+        if callable(func) and func.__name__.startswith("test_"):
+            sys.stdout.write(f"Running {func.__name__} ...\n")
+            func()
+    sys.stdout.write("Done\n")
+
+
+if __name__ == "__main__":
+    run_tests(globals())