Merge pull request #460 from CCPBioSim/357-general-improve-local-version

Show Local Version in Splash Screen and Add `--version` CLI Flag

Author: harryswift01

CodeEntropy/cli.py

@@ -4,16 +4,18 @@
 correlation entropy workflow.
 
 The entry point is intentionally small and only responsible for:
-  1) Creating a job folder.
-  2) Constructing a CodeEntropyRunner.
-  3) Executing the entropy workflow.
-  4) Handling fatal errors with a non-zero exit code.
+  1) Handling informational flags such as ``--version``.
+  2) Creating a job folder.
+  3) Constructing a CodeEntropyRunner.
+  4) Executing the entropy workflow.
+  5) Handling fatal errors with a non-zero exit code.
 """
 
 from __future__ import annotations
 
 import logging
 
+from CodeEntropy.config.argparse import ConfigResolver
 from CodeEntropy.config.runtime import CodeEntropyRunner
 
 logger = logging.getLogger(__name__)
@@ -22,9 +24,15 @@
 def main() -> None:
     """Run the entropy workflow.
 
+    Arguments are parsed before any side effects so that informational flags such
+    as ``--version`` and ``--help`` exit without creating a job folder or
+    rendering the splash screen.
+
     Raises:
         SystemExit: Exits with status code 1 on any unhandled exception.
     """
+    ConfigResolver().build_parser().parse_known_args()
+
     folder = CodeEntropyRunner.create_job_folder()
 
     try:

CodeEntropy/config/argparse.py

@@ -31,6 +31,7 @@
 
 import yaml
 
+from CodeEntropy import __version__
 from CodeEntropy.core.dask_clusters import HPCDaskManager
 
 logger = logging.getLogger(__name__)
@@ -318,6 +319,11 @@ def build_parser(self) -> argparse.ArgumentParser:
         parser = argparse.ArgumentParser(
             description="CodeEntropy: entropy calculation with the MCC method."
         )
+        parser.add_argument(
+            "--version",
+            action="version",
+            version=f"CodeEntropy {__version__}",
+        )
 
         for name, spec in self._arg_specs.items():
             arg_name = f"--{name}"

CodeEntropy/config/runtime.py

@@ -32,6 +32,7 @@
 from rich.table import Table
 from rich.text import Text
 
+from CodeEntropy import __version__
 from CodeEntropy.config.argparse import ConfigResolver
 from CodeEntropy.core.dask_clusters import HPCDaskManager
 from CodeEntropy.core.logging import LoggingConfig
@@ -135,20 +136,21 @@ def load_citation_data(self) -> dict[str, Any] | None:
             return None
 
     def show_splash(self) -> None:
-        """Render a Rich splash screen with optional citation metadata."""
+        """Render a Rich splash screen.
+
+        The version shown is that of the locally installed package. Remaining
+        metadata (authors, description, URL) comes from the online citation file
+        when it is reachable.
+        """
         citation = self.load_citation_data()
+        version_text = Align.center(Text(f"Version {__version__}", style="green"))
 
         if citation:
             ascii_title = text2art(citation.get("title", "CodeEntropy"))
             ascii_render = Align.center(Text(ascii_title, style="bold white"))
 
-            version = citation.get("version", "?")
-            release_date = citation.get("date-released", "?")
             url = citation.get("url", citation.get("repository-code", ""))
 
-            version_text = Align.center(
-                Text(f"Version {version} | Released {release_date}", style="green")
-            )
             url_text = Align.center(Text(url, style="blue underline"))
 
             abstract = citation.get("abstract", "No description available.")
@@ -193,7 +195,7 @@ def show_splash(self) -> None:
         else:
             ascii_title = text2art("CodeEntropy")
             ascii_render = Align.center(Text(ascii_title, style="bold white"))
-            splash_content = Group(ascii_render)
+            splash_content = Group(ascii_render, Rule(style="cyan"), version_text)
 
         splash_panel = Panel(
             splash_content,

tests/unit/CodeEntropy/cli/test_cli.py

@@ -36,3 +36,17 @@ def test_main_logs_and_exits_nonzero_on_exception(monkeypatch):
 
     assert exc.value.code == 1
     fake_runner.run_entropy_workflow.assert_called_once_with()
+
+
+def test_main_version_flag_exits_before_creating_job_folder(monkeypatch, capsys):
+    fake_runner_cls = MagicMock()
+    monkeypatch.setattr(entry, "CodeEntropyRunner", fake_runner_cls)
+    monkeypatch.setattr("sys.argv", ["CodeEntropy", "--version"])
+
+    with pytest.raises(SystemExit) as exc:
+        entry.main()
+
+    assert exc.value.code == 0
+    assert "CodeEntropy" in capsys.readouterr().out
+    fake_runner_cls.create_job_folder.assert_not_called()
+    fake_runner_cls.assert_not_called()

tests/unit/CodeEntropy/config/argparse/test_argparse_build_parser.py

@@ -1,3 +1,6 @@
+import pytest
+
+from CodeEntropy import __version__
 from CodeEntropy.config.argparse import ConfigResolver
 
 
@@ -37,3 +40,13 @@ def test_build_parser_nargs_plus_parses_top_traj_file_list():
     args = parser.parse_args(["--top_traj_file", "a.tpr", "b.trr"])
 
     assert args.top_traj_file == ["a.tpr", "b.trr"]
+
+
+def test_version_flag_prints_installed_version_and_exits(capsys):
+    parser = ConfigResolver().build_parser()
+
+    with pytest.raises(SystemExit) as exc:
+        parser.parse_args(["--version"])
+
+    assert exc.value.code == 0
+    assert f"CodeEntropy {__version__}" in capsys.readouterr().out

tests/unit/CodeEntropy/config/runtime/test_show_splash.py

@@ -3,6 +3,8 @@
 
 from rich.console import Console
 
+from CodeEntropy import __version__
+
 
 def test_show_splash_with_citation(runner):
     citation = {
@@ -26,8 +28,8 @@ def test_show_splash_with_citation(runner):
     out = buf.getvalue()
 
     assert "Welcome to CodeEntropy" in out
-    assert "Version 1.0" in out
-    assert "2025-01-01" in out
+    assert f"Version {__version__}" in out
+    assert "Version 1.0" not in out
     assert "https://example.com" in out
     assert "This is a test abstract." in out
     assert "Alice Smith" in out
@@ -43,4 +45,7 @@ def test_show_splash_without_citation(runner):
     ):
         runner.show_splash()
 
-    assert "Welcome to CodeEntropy" in buf.getvalue()
+    out = buf.getvalue()
+
+    assert "Welcome to CodeEntropy" in out
+    assert f"Version {__version__}" in out