refactor: new summary table

Author: henryiii

action.yml

@@ -89,24 +89,3 @@ runs:
         ${{ inputs.only != ''        && format('--only "{0}"', inputs.only) || ''}}
       shell: pwsh
       if: runner.os == 'Windows'
-
-    - run: |
-        # Prepare summary
-        "${{ steps.python.outputs.python-path }}" -u << "EOF"
-        import os
-        from pathlib import Path
-
-        output_dir = Path("${{ inputs.output-dir }}" or "wheelhouse")
-
-        with Path(os.environ["GITHUB_STEP_SUMMARY"]).open("w", encoding="utf-8") as f:
-          print("## 🎡: files in output directory", file=f)
-          print(file=f)
-          for item in sorted(output_dir.iterdir()):
-            if item.is_file():
-              size_mb = item.stat().st_size / 1024**2
-              print(f"* `{item}` - {size_mb:.2f} MB", file=f)
-            else:
-              print(f"* `{item.name}/`", file=f)
-          print(file=f)
-        EOF
-      shell: bash

cibuildwheel/__main__.py

@@ -308,18 +308,10 @@ def print_new_wheels(msg: str, output_dir: Path) -> Generator[None, None, None]:
     if not new_contents:
         return
 
-    max_name_len = max(len(f.name) for f in new_contents)
-    max_size_len = max(len(f.size) for f in new_contents)
     n = len(new_contents)
     s = time.time() - start_time
     m = s / 60
-    print(
-        msg.format(n=n, s=s, m=m),
-        *sorted(
-            f"  {f.name:<{max_name_len}s}   {f.size:>{max_size_len}s} kB" for f in new_contents
-        ),
-        sep="\n",
-    )
+    print(msg.format(n=n, s=s, m=m))
 
 
 def build_in_directory(args: CommandLineArguments) -> None:
@@ -382,8 +374,9 @@ def build_in_directory(args: CommandLineArguments) -> None:
 
     tmp_path = Path(mkdtemp(prefix="cibw-run-")).resolve(strict=True)
     try:
-        with print_new_wheels("\n{n} wheels produced in {m:.0f} minutes:", output_dir):
+        with print_new_wheels("\n{n} wheels produced in {m:.0f} minutes", output_dir):
             platform_module.build(options, tmp_path)
+            log.print_summary()
     finally:
         # avoid https://github.com/python/cpython/issues/86962 by performing
         # cleanup manually

cibuildwheel/logger.py

@@ -3,7 +3,8 @@
 import re
 import sys
 import time
-from typing import IO, AnyStr, Final
+from pathlib import Path
+from typing import IO, AnyStr, Final, Literal
 
 from .ci import CIProvider, detect_ci_provider
 
@@ -70,13 +71,15 @@ def __init__(self, *, unicode: bool) -> None:
 
 
 class Logger:
-    fold_mode: str
+    fold_mode: Literal["azure", "github", "travis", "disabled"]
     colors_enabled: bool
     unicode_enabled: bool
     active_build_identifier: str | None = None
     build_start_time: float | None = None
     step_start_time: float | None = None
     active_fold_group_name: str | None = None
+    summary: list[tuple[str, Path | None, float]]
+    summary_mode: Literal["github", "generic"]
 
     def __init__(self) -> None:
         if sys.platform == "win32" and hasattr(sys.stdout, "reconfigure"):
@@ -88,25 +91,33 @@ def __init__(self) -> None:
 
         ci_provider = detect_ci_provider()
 
-        if ci_provider == CIProvider.azure_pipelines:
-            self.fold_mode = "azure"
-            self.colors_enabled = True
+        match ci_provider:
+            case CIProvider.azure_pipelines:
+                self.fold_mode = "azure"
+                self.colors_enabled = True
+                self.summary_mode = "generic"
 
-        elif ci_provider == CIProvider.github_actions:
-            self.fold_mode = "github"
-            self.colors_enabled = True
+            case CIProvider.github_actions:
+                self.fold_mode = "github"
+                self.colors_enabled = True
+                self.summary_mode = "github"
 
-        elif ci_provider == CIProvider.travis_ci:
-            self.fold_mode = "travis"
-            self.colors_enabled = True
+            case CIProvider.travis_ci:
+                self.fold_mode = "travis"
+                self.colors_enabled = True
+                self.summary_mode = "generic"
 
-        elif ci_provider == CIProvider.appveyor:
-            self.fold_mode = "disabled"
-            self.colors_enabled = True
+            case CIProvider.appveyor:
+                self.fold_mode = "disabled"
+                self.colors_enabled = True
+                self.summary_mode = "generic"
 
-        else:
-            self.fold_mode = "disabled"
-            self.colors_enabled = file_supports_color(sys.stdout)
+            case _:
+                self.fold_mode = "disabled"
+                self.colors_enabled = file_supports_color(sys.stdout)
+                self.summary_mode = "generic"
+
+        self.summary = []
 
     def build_start(self, identifier: str) -> None:
         self.step_end()
@@ -120,7 +131,7 @@ def build_start(self, identifier: str) -> None:
         self.build_start_time = time.time()
         self.active_build_identifier = identifier
 
-    def build_end(self) -> None:
+    def build_end(self, filename: Path | None) -> None:
         assert self.build_start_time is not None
         assert self.active_build_identifier is not None
         self.step_end()
@@ -133,6 +144,8 @@ def build_end(self) -> None:
         print(
             f"{c.green}{s.done} {c.end}{self.active_build_identifier} finished in {duration:.2f}s"
         )
+        self.summary.append((self.active_build_identifier, filename, duration))
+
         self.build_start_time = None
         self.active_build_identifier = None
 
@@ -183,6 +196,24 @@ def error(self, error: BaseException | str) -> None:
             c = self.colors
             print(f"cibuildwheel: {c.bright_red}error{c.end}: {error}\n", file=sys.stderr)
 
+    def print_summary(self) -> None:
+        summary = "## 🎡: Wheels\n\n| Identifier | Wheel | Size | Time |\n|===|===|===|===|\n"
+        for ident, filename, duration in self.summary:
+            if filename:
+                size_mb = filename.stat().st_size / 1024**2
+                summary += f"| {ident} | {filename.name} | {size_mb:.2f} MB | {duration} |"
+            else:
+                summary += f"| {ident} | test only | --- | {duration} |"
+
+        match self.summary_mode:
+            case "github":
+                Path(os.environ["GITHUB_STEP_SUMMARY"]).write_text(summary, encoding="utf-8")
+                print(summary)
+            case _:
+                print(summary)
+
+        self.summary = []
+
     @property
     def step_active(self) -> bool:
         return self.step_start_time is not None

cibuildwheel/platforms/ios.py

@@ -671,6 +671,7 @@ def build(options: Options, tmp_path: Path) -> None:
                     log.step_end()
 
             # We're all done here; move it to output (overwrite existing)
+            output_wheel: Path | None = None
             if compatible_wheel is None:
                 output_wheel = build_options.output_dir.joinpath(built_wheel.name)
                 moved_wheel = move_file(built_wheel, output_wheel)
@@ -683,7 +684,7 @@ def build(options: Options, tmp_path: Path) -> None:
             # Clean up
             shutil.rmtree(identifier_tmp_dir)
 
-            log.build_end()
+            log.build_end(output_wheel)
     except subprocess.CalledProcessError as error:
         msg = f"Command {error.cmd} failed with code {error.returncode}. {error.stdout or ''}"
         raise errors.FatalError(msg) from error

cibuildwheel/platforms/linux.py

@@ -418,14 +418,17 @@ def build_in_container(
             container.call(["rm", "-rf", testing_temp_dir])
 
         # move repaired wheels to output
+        # TODO: can this still output multiple wheels? I though it was just multiple tags
+        output_wheel: Path | None = None
         if compatible_wheel is None:
             container.call(["mkdir", "-p", container_output_dir])
             container.call(["mv", *repaired_wheels, container_output_dir])
             built_wheels.extend(
                 container_output_dir / repaired_wheel.name for repaired_wheel in repaired_wheels
             )
+            output_wheel = options.globals.output_dir / repaired_wheels[0].name
 
-        log.build_end()
+        log.build_end(output_wheel)
 
     log.step("Copying wheels back to host...")
     # copy the output back into the host

cibuildwheel/platforms/macos.py

@@ -726,6 +726,7 @@ def build(options: Options, tmp_path: Path) -> None:
                     shell_with_arch(test_command_prepared, cwd=test_cwd, env=virtualenv_env)
 
             # we're all done here; move it to output (overwrite existing)
+            output_wheel = None
             if compatible_wheel is None:
                 output_wheel = build_options.output_dir.joinpath(repaired_wheel.name)
                 moved_wheel = move_file(repaired_wheel, output_wheel)
@@ -738,7 +739,7 @@ def build(options: Options, tmp_path: Path) -> None:
             # clean up
             shutil.rmtree(identifier_tmp_dir)
 
-            log.build_end()
+            log.build_end(output_wheel)
     except subprocess.CalledProcessError as error:
         msg = f"Command {error.cmd} failed with code {error.returncode}. {error.stdout or ''}"
         raise errors.FatalError(msg) from error

cibuildwheel/platforms/windows.py

@@ -607,6 +607,7 @@ def build(options: Options, tmp_path: Path) -> None:
                 shell(test_command_prepared, cwd=test_cwd, env=virtualenv_env)
 
             # we're all done here; move it to output (remove if already exists)
+            output_wheel = None
             if compatible_wheel is None:
                 output_wheel = build_options.output_dir.joinpath(repaired_wheel.name)
                 moved_wheel = move_file(repaired_wheel, output_wheel)
@@ -621,7 +622,7 @@ def build(options: Options, tmp_path: Path) -> None:
             # don't want to abort a build because of that)
             shutil.rmtree(identifier_tmp_dir, ignore_errors=True)
 
-            log.build_end()
+            log.build_end(output_wheel)
     except subprocess.CalledProcessError as error:
         msg = f"Command {error.cmd} failed with code {error.returncode}. {error.stdout or ''}"
         raise errors.FatalError(msg) from error