Merge pull request #404 from faster-cpython/groups

Show groupings in GHA

Author: mdboom

bench_runner/result.py

@@ -18,7 +18,6 @@
 import numpy as np
 from packaging import version
 import pyperf
-import rich.progress
 
 
 from . import bases as mbases
@@ -799,20 +798,20 @@ def find_match(result, candidates, base, func):
         bases = []
 
     if progress:
-        track = rich.progress.track  # type: ignore
+        track = util.track  # type: ignore
     else:
 
         def track(it, *_args, **_kwargs):
             return it
 
     groups = defaultdict(lambda: defaultdict(list))
-    for result in track(results, description="Loading results"):
+    for result in track(results, "Loading results"):
         if result.fork == "python":
             groups[(result.nickname, tuple(result.extra))][
                 result.benchmark_hash
             ].append(result)
 
-    for result in track(results, description="Matching results to bases"):
+    for result in track(results, "Matching results to bases"):
         candidates = groups[(result.nickname, tuple(result.extra))]
 
         if (

bench_runner/scripts/generate_results.py

@@ -12,7 +12,6 @@
 
 
 import rich
-import rich.progress
 import rich_argparse
 
 
@@ -70,9 +69,9 @@ def save_generated_results(results: Iterable[Result], force: bool = False) -> No
 
     rich.print(f"Generating {len(work)} derived results")
 
-    for func, filename in rich.progress.track(
+    for func, filename in util.track(
         work,
-        description="Generating results",
+        "Generating results",
     ):
         func(filename)
 
@@ -352,9 +351,7 @@ def generate_directory_indices(results: Iterable[Result]) -> None:
     entries = get_directory_indices_entries(results)
     structure = _tuple_to_nested_dicts(entries)
 
-    for dirpath, dirresults in rich.progress.track(
-        structure.items(), description="Generating indices"
-    ):
+    for dirpath, dirresults in util.track(structure.items(), "Generating indices"):
         with (dirpath / "README.md").open("w") as fd:
             fd.write("# Results\n\n")
             table.write_md_list(fd, dirresults[None][None])
@@ -392,7 +389,7 @@ def _main(repo_dir: PathLike, force: bool = False, bases: Sequence[str] | None =
 
     memory_benchmarking_results = filter_broken_memory_results(benchmarking_results)
 
-    for plot_func, args, kwargs in rich.progress.track(
+    for plot_func, args, kwargs in util.track(
         [
             (
                 plot.longitudinal_plot,
@@ -423,7 +420,7 @@ def _main(repo_dir: PathLike, force: bool = False, bases: Sequence[str] | None =
                 ),
             ),
         ],
-        description="Generating plots",
+        "Generating plots",
     ):
         plot_func(*args, **kwargs)  # type: ignore
 

bench_runner/scripts/remove_benchmark.py

@@ -8,12 +8,12 @@
 
 
 import rich
-import rich.progress
 import rich_argparse
 
 
 from bench_runner import result
 from bench_runner.scripts import generate_results
+from bench_runner import util
 from bench_runner.util import PathLike
 
 
@@ -52,9 +52,7 @@ def _main(benchmarks: Sequence[str], keep_hash: Sequence[str], dry_run: bool = F
         if Path("longitudinal.json").is_file():
             Path("longitudinal.json").unlink()
 
-    for filename in rich.progress.track(
-        list(Path("results").glob("**/*")), description="Deleting results"
-    ):
+    for filename in util.track(list(Path("results").glob("**/*")), "Deleting results"):
         if filename.is_dir():
             continue
         if filename.name != "README.md":

bench_runner/scripts/workflow.py

@@ -20,7 +20,7 @@
 from bench_runner import git
 from bench_runner.result import has_result
 from bench_runner import util
-from bench_runner.util import PathLike
+from bench_runner.util import log_group, PathLike
 
 
 from bench_runner.scripts import run_benchmarks as mrun_benchmarks
@@ -266,26 +266,33 @@ def _main(
     if pystats and platform != "linux":
         raise RuntimeError("Pystats is only supported on Linux")
 
-    checkout_cpython(fork, ref, cpython)
+    with log_group("Checking out CPython"):
+        checkout_cpython(fork, ref, cpython)
 
-    if not should_run(force, fork, ref, machine, False, flags, cpython=cpython):
-        print("No need to run benchmarks.  Skipping...")
-        return
+    with log_group("Determining if we need to run benchmarks"):
+        if not should_run(force, fork, ref, machine, False, flags, cpython=cpython):
+            print("No need to run benchmarks.  Skipping...")
+            return
 
-    checkout_benchmarks()
+    with log_group("Checking out benchmarks"):
+        checkout_benchmarks()
 
-    match platform:
-        case "linux" | "macos":
-            compile_unix(cpython, flags, pgo, pystats)
-        case "windows":
-            compile_windows(cpython, flags, pgo, force_32bit)
+    with log_group("Compiling CPython"):
+        match platform:
+            case "linux" | "macos":
+                compile_unix(cpython, flags, pgo, pystats)
+            case "windows":
+                compile_windows(cpython, flags, pgo, force_32bit)
 
-    # Print out the version of Python we built just so we can confirm it's the
-    # right thing in the logs
-    subprocess.check_call([get_exe_path(cpython, flags, force_32bit), "-VV"])
+        # Print out the version of Python we built just so we can confirm it's the
+        # right thing in the logs
+        subprocess.check_call([get_exe_path(cpython, flags, force_32bit), "-VV"])
 
-    install_pyperformance(venv)
-    tune_system(venv, perf)
+    with log_group("Installing pyperformance"):
+        install_pyperformance(venv)
+
+    with log_group("Tuning system"):
+        tune_system(venv, perf)
 
     try:
         if Path(".debug").exists():
@@ -303,17 +310,18 @@ def _main(
         else:
             mode = "benchmark"
 
-        mrun_benchmarks._main(
-            mode,
-            get_exe_path(cpython, flags, force_32bit),
-            fork,
-            ref,
-            benchmarks,
-            flags=flags,
-            run_id=run_id,
-            test_mode=False,
-            individual=pystats,
-        )
+        with log_group("Running benchmarks"):
+            mrun_benchmarks._main(
+                mode,
+                get_exe_path(cpython, flags, force_32bit),
+                fork,
+                ref,
+                benchmarks,
+                flags=flags,
+                run_id=run_id,
+                test_mode=False,
+                individual=pystats,
+            )
     finally:
         reset_system(venv)
 

bench_runner/templates/workflow_bootstrap.py

@@ -55,8 +55,12 @@ def install_requirements(venv: Path) -> None:
 
 def main():
     venv = Path("venv")
+    print("::group::Creating venv")
     create_venv(venv)
+    print("::endgroup::")
+    print("::group::Installing requirements")
     install_requirements(venv)
+    print("::endgroup::")
 
     # Now that we've installed the full bench_runner library,
     # continue on in a new process...

bench_runner/util.py

@@ -1,11 +1,12 @@
+import contextlib
 import functools
 import itertools
 import os
 from pathlib import Path
 import shutil
 import subprocess
 import sys
-from typing import Literal, TypeAlias, Union
+from typing import Iterable, Iterator, Literal, TypeAlias, Union
 
 
 from . import config
@@ -85,3 +86,44 @@ def get_simple_platform() -> Literal["linux", "macos", "windows"]:
     elif sys.platform.startswith("win"):
         return "windows"
     raise RuntimeError(f"Unsupported platform {sys.platform}.")
+
+
+if os.getenv("GITHUB_ACTIONS") == "true":
+
+    @contextlib.contextmanager
+    def log_group(text: str) -> Iterator:
+        print(f"::group::{text}")
+        try:
+            yield
+        finally:
+            print("::endgroup::")
+
+    def track(iterable: Iterable, name: str) -> Iterable:
+        with log_group(name):
+            yield from iterable
+
+else:
+    try:
+        import rich
+    except ImportError:
+
+        @contextlib.contextmanager
+        def log_group(text: str) -> Iterator:
+            print(text)
+            yield
+
+        def track(iterable: Iterable, name: str) -> Iterable:
+            print(name)
+            return iterable
+
+    else:
+
+        @contextlib.contextmanager
+        def log_group(text: str) -> Iterator:
+            rich.print(f"[b]{text}:[/b]")
+            yield
+
+        def track(iterable: Iterable, name: str) -> Iterable:
+            from rich.progress import track
+
+            return track(iterable, description=name)