Merge pull request #569 from FNALssi/maintenance/merge-from-upstream-2025-08-06

Merge from upstream/develop 2025-08-06

Author: gartung

.github/workflows/bin/canonicalize.py

@@ -0,0 +1,148 @@
+#!/usr/bin/env python3
+# Copyright Spack Project Developers. See COPYRIGHT file for details.
+#
+# SPDX-License-Identifier: (Apache-2.0 OR MIT)
+import argparse
+import ast
+import os
+import subprocess
+import sys
+from itertools import product
+from typing import List
+
+
+def run_git_command(*args: str, dir: str) -> None:
+    """Run a git command in the output directory."""
+    subprocess.run(
+        [
+            "git",
+            "-c",
+            "[email protected]",
+            "-c",
+            "user.name=Example",
+            "-c",
+            "init.defaultBranch=main",
+            "-c",
+            "color.ui=always",
+            "-C",
+            dir,
+            *args,
+        ],
+        check=True,
+        stdout=sys.stdout,
+        stderr=sys.stderr,
+    )
+
+
+def run(root: str, output_dir: str) -> None:
+    """Recurse over a directory and canonicalize all Python files."""
+    from spack.util.package_hash import RemoveDocstrings, unparse
+
+    count = 0
+    stack = [root]
+
+    while stack:
+        current = stack.pop()
+        for entry in os.scandir(current):
+            if entry.is_dir(follow_symlinks=False):
+                stack.append(entry.path)
+            elif entry.is_file(follow_symlinks=False) and entry.name.endswith(".py"):
+                try:
+                    with open(entry.path, "r") as f:
+                        src = f.read()
+                except OSError:
+                    continue
+
+                canonical_dir = os.path.join(output_dir, os.path.relpath(current, root))
+                os.makedirs(canonical_dir, exist_ok=True)
+                with open(os.path.join(canonical_dir, entry.name), "w") as f:
+                    f.write(
+                        unparse(RemoveDocstrings().visit(ast.parse(src)), py_ver_consistent=True)
+                    )
+                count += 1
+
+    assert count > 0, "No Python files found in the specified directory."
+
+
+def compare(
+    input_dir: str, output_dir: str, python_versions: List[str], spack_versions: List[str]
+) -> None:
+    """Compare canonicalized files across different Python versions and error if they differ."""
+    # Create a git repo in output_dir to track changes
+    os.makedirs(output_dir, exist_ok=True)
+    run_git_command("init", dir=output_dir)
+
+    pairs = list(product(spack_versions, python_versions))
+
+    if len(pairs) < 2:
+        raise ValueError("At least two Python or two Spack versions must be given for comparison.")
+
+    changes_with_previous: List[int] = []
+
+    for i, (spack_dir, python_exe) in enumerate(pairs):
+        print(f"\033[1;97mCanonicalizing with {python_exe} and {spack_dir}...\033[0m", flush=True)
+
+        # Point PYTHONPATH to the given Spack library for the subprocess
+        if not os.path.isdir(spack_dir):
+            raise ValueError(f"Invalid Spack dir: {spack_dir}")
+        env = os.environ.copy()
+        spack_pythonpath = os.path.join(spack_dir, "lib", "spack")
+        if "PYTHONPATH" in env and env["PYTHONPATH"]:
+            env["PYTHONPATH"] = f"{spack_pythonpath}{os.pathsep}{env['PYTHONPATH']}"
+        else:
+            env["PYTHONPATH"] = spack_pythonpath
+
+        subprocess.run(
+            [python_exe, __file__, "--run", "--input-dir", input_dir, "--output-dir", output_dir],
+            check=True,
+            stdout=sys.stdout,
+            stderr=sys.stderr,
+            env=env,
+        )
+        if i > 0:
+            try:
+                run_git_command("diff", "--exit-code", "HEAD", dir=output_dir)
+            except subprocess.CalledProcessError:
+                changes_with_previous.append(i)
+
+        # The first run creates a commit for reference
+        run_git_command("add", ".", dir=output_dir)
+        run_git_command(
+            "commit",
+            "--quiet",
+            "--allow-empty",  # makes this idempotent when running locally
+            "-m",
+            f"Canonicalized with {python_exe} and {spack_dir}",
+            dir=output_dir,
+        )
+
+    for i in changes_with_previous:
+        previous_spack, previous_python = pairs[i - 1]
+        current_spack, current_python = pairs[i]
+        print(
+            f"\033[1;31mChanges detected between {previous_python} ({previous_spack}) and "
+            f"{current_python} ({current_spack})\033[0m"
+        )
+
+    if changes_with_previous:
+        exit(1)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Canonicalize Spack package files.")
+    parser.add_argument("--run", action="store_true", help="Generate canonicalized sources.")
+    parser.add_argument("--spack", nargs="+", help="Specify one or more Spack versions.")
+    parser.add_argument("--python", nargs="+", help="Specify one or more Python versions.")
+    parser.add_argument("--input-dir", type=str, required=True, help="A repo's packages dir.")
+    parser.add_argument(
+        "--output-dir",
+        type=str,
+        required=True,
+        help="The output directory for canonicalized package files.",
+    )
+    args = parser.parse_args()
+
+    if args.run:
+        run(args.input_dir, args.output_dir)
+    else:
+        compare(args.input_dir, args.output_dir, args.python, args.spack)

.github/workflows/ci.yaml

@@ -50,6 +50,7 @@ jobs:
             - '.github/workflows/ci.yaml'
             core:
             - './!(var/**)/**'
+            - 'var/spack/test_repos/**'
             packages:
             - 'var/**'
       # Some links for easier reference:

.github/workflows/prechecks.yml

@@ -85,3 +85,31 @@ jobs:
           spack -d bootstrap now --dev
           spack -d style -t black
           spack unit-test -V
+
+  canonicalization:
+    name: package.py canonicalization
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/spack/all-pythons:2025-07-25
+
+    steps:
+      - name: Checkout Spack (current)
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        with:
+          path: spack-current
+      - name: Checkout Spack (previous)
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        with:
+          path: spack-previous
+          ref: ${{ github.event.pull_request.base.sha || github.event.before }}
+      - name: Checkout Spack Packages
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        with:
+          repository: spack/spack-packages
+          path: spack-packages
+      - name: Test package.py canonicalization
+        run: spack-current/.github/workflows/bin/canonicalize.py
+          --spack $PWD/spack-previous $PWD/spack-current
+          --python python3.6 python3.7 python3.8 python3.9 python3.10 python3.11 python3.12 python3.13
+          --input-dir spack-packages/repos/spack_repo/builtin/packages/
+          --output-dir canonicalized

.github/workflows/requirements/style/requirements.txt

@@ -2,7 +2,7 @@ black==25.1.0
 clingo==5.8.0
 flake8==7.3.0
 isort==6.0.1
-mypy==1.17.0
+mypy==1.17.1
 types-six==1.17.0.20250515
 vermin==1.6.0
 pylint==3.3.7

README.md

@@ -2,9 +2,9 @@
 
 <h2>
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://cdn.rawgit.com/spack/spack/develop/share/spack/logo/spack-logo-white-text.svg" width="250">
-  <source media="(prefers-color-scheme: light)" srcset="https://cdn.rawgit.com/spack/spack/develop/share/spack/logo/spack-logo-text.svg" width="250">
-  <img alt="Spack" src="https://cdn.rawgit.com/spack/spack/develop/share/spack/logo/spack-logo-text.svg" width="250">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/spack/spack/refs/heads/develop/share/spack/logo/spack-logo-white-text.svg" width="250">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/spack/spack/refs/heads/develop/share/spack/logo/spack-logo-text.svg" width="250">
+  <img alt="Spack" src="https://raw.githubusercontent.com/spack/spack/refs/heads/develop/share/spack/logo/spack-logo-text.svg" width="250">
 </picture>
 
 <br>

lib/spack/docs/_pygments/style.py

@@ -1,9 +1,57 @@
 div.versionadded {
-    border-left: 3px solid #0c731f;
-    color: #0c731f;
-    padding-left: 1rem;
+  border-left: 3px solid #0c731f;
+  color: #0c731f;
+  padding-left: 1rem;
 }
 
 .py.property {
   display: block !important;
+}
+
+div.version-switch {
+  text-align: center;
+  min-height: 2em;
+}
+
+div.version-switch>select {
+  display: inline-block;
+  text-align-last: center;
+  background: none;
+  border: none;
+  border-radius: 0.5em;
+  box-shadow: none;
+  color: var(--color-foreground-primary);
+  cursor: pointer;
+  appearance: none;
+  padding: 0.2em;
+  -webkit-appearance: none;
+  -moz-appearance: none;
+}
+
+div.version-switch select:active,
+div.version-switch select:focus,
+div.version-switch select:hover {
+  color: var(--color-foreground-secondary);
+  background: var(--color-background-hover);
+}
+
+.toc-tree li.scroll-current>.reference {
+  font-weight: normal;
+}
+
+.search-results span {
+  background-color: #fff3cd;
+  padding: 0.1rem 0.2rem;
+  border-radius: 2px;
+}
+
+@media (prefers-color-scheme: dark) {
+  body:not([data-theme="light"]) .search-results span {
+    background-color: #664d03;
+    color: #fff3cd;
+  }
+}
+
+.highlight .go {
+  color: #333;
 }