do not override CMAKE_ARGS in build scripts

Author: ndgrigorian

scripts/_build_helper.py

@@ -69,7 +69,7 @@ def run(cmd: list[str], env: dict[str, str] = None, cwd: str = None):
     )
 
 
-def get_output(cmd: list[str], cwd: str = None):
+def capture_cmd_output(cmd: list[str], cwd: str = None):
     print("+", " ".join(cmd))
     return (
         subprocess.check_output(cmd, cwd=cwd or os.getcwd())
@@ -78,14 +78,14 @@ def get_output(cmd: list[str], cwd: str = None):
     )
 
 
-def warn(msg: str, script: str):
-    print(f"[{script}][warning] {msg}", file=sys.stderr)
-
-
 def err(msg: str, script: str):
     print(f"[{script}][error] {msg}", file=sys.stderr)
 
 
+def log_cmake_args(cmake_args: list[str], script: str):
+    print(f"[{script}] Using CMake args:\n{' '.join(cmake_args)}")
+
+
 def make_cmake_args(
     c_compiler: str = None,
     cxx_compiler: str = None,
@@ -106,12 +106,13 @@ def make_cmake_args(
     if other_opts:
         args.extend(other_opts.split())
 
-    return " ".join(filter(None, args))
+    return args
 
 
 def build_extension(
     setup_dir: str,
     env: dict[str, str],
+    cmake_args: list[str],
     cmake_executable: str = None,
     generator: str = None,
     build_type: str = None,
@@ -123,6 +124,9 @@ def build_extension(
         cmd.append(f"--generator={generator}")
     if build_type:
         cmd.append(f"--build-type={build_type}")
+    if cmake_args:
+        cmd.append("--")
+        cmd += cmake_args
     run(
         cmd,
         env=env,

scripts/build_locally.py

@@ -26,9 +26,9 @@
     clean_build_dir,
     err,
     install_editable,
+    log_cmake_args,
     make_cmake_args,
     resolve_compilers,
-    warn,
 )
 
 
@@ -184,30 +184,25 @@ def main():
 
     # CUDA/HIP targets
     if args.target_cuda:
-        cmake_args += f" -DDPCTL_TARGET_CUDA={args.target_cuda}"
+        cmake_args += [f"-DDPCTL_TARGET_CUDA={args.target_cuda}"]
     if args.target_hip:
-        cmake_args += f" -DDPCTL_TARGET_HIP={args.target_hip}"
+        cmake_args += [f"-DDPCTL_TARGET_HIP={args.target_hip}"]
 
-    cmake_args += (
-        " -DDPCTL_ENABLE_L0_PROGRAM_CREATION="
+    cmake_args += [
+        "-DDPCTL_ENABLE_L0_PROGRAM_CREATION="
         f"{'ON' if level_zero_enabled else 'OFF'}"
-    )
-
-    env = os.environ.copy()
+    ]
 
-    # ignore pre-existing CMAKE_ARGS for determinism in build driver
-    if "CMAKE_ARGS" in env and env["CMAKE_ARGS"].strip():
-        warn("Ignoring pre-existing CMAKE_ARGS in environment", "build_locally")
-        del env["CMAKE_ARGS"]
-
-    env["CMAKE_ARGS"] = cmake_args
-    print(f"[build_locally] CMake args:\n {cmake_args}")
+    log_cmake_args(cmake_args, "build_locally")
 
     print("[build_locally] Building extensions in-place...")
 
+    env = os.environ.copy()
+
     build_extension(
         setup_dir,
         env,
+        cmake_args,
         cmake_executable=args.cmake_executable,
         generator=args.generator,
         build_type=args.build_type,

scripts/gen_coverage.py

@@ -26,22 +26,22 @@
 
 from _build_helper import (  # noqa: E402
     build_extension,
+    capture_cmd_output,
     clean_build_dir,
     err,
-    get_output,
     install_editable,
+    log_cmake_args,
     make_cmake_args,
     resolve_compilers,
     run,
-    warn,
 )
 
 
 def find_bin_llvm(compiler):
     if os.path.isabs(compiler):
         bin_dir = os.path.dirname(compiler)
     else:
-        compiler_path = get_output(["which", compiler])
+        compiler_path = capture_cmd_output(["which", compiler])
         if not compiler_path:
             raise RuntimeError(f"Compiler {compiler} not found in PATH")
         bin_dir = os.path.dirname(compiler_path)
@@ -180,26 +180,20 @@ def main():
         verbose=args.verbose,
     )
 
-    cmake_args += " -DDPCTL_GENERATE_COVERAGE=ON"
-    cmake_args += " -DDPCTL_BUILD_CAPI_TESTS=ON"
-    cmake_args += f" -DDPCTL_COVERAGE_REPORT_OUTPUT={setup_dir}"
+    cmake_args += ["-DDPCTL_GENERATE_COVERAGE=ON"]
+    cmake_args += ["-DDPCTL_BUILD_CAPI_TESTS=ON"]
+    cmake_args += [f"-DDPCTL_COVERAGE_REPORT_OUTPUT={setup_dir}"]
 
     if args.gtest_config:
-        cmake_args += " -DCMAKE_PREFIX_PATH={args.gtest_config}"
+        cmake_args += [f"-DCMAKE_PREFIX_PATH={args.gtest_config}"]
 
     env = os.environ.copy()
 
-    if "CMAKE_ARGS" in env and env["CMAKE_ARGS"].strip():
-        warn("Ignoring pre-existing CMAKE_ARGS in environment", "gen_coverage")
-        del env["CMAKE_ARGS"]
-
     if bin_llvm:
         env["PATH"] = ":".join((env.get("PATH", ""), bin_llvm))
         env["LLVM_TOOLS_HOME"] = bin_llvm
 
-    env["CMAKE_ARGS"] = cmake_args
-
-    print(f"[gen_coverage] Using CMake args:\n {env['CMAKE_ARGS']}")
+    log_cmake_args(cmake_args, "gen_coverage")
 
     build_extension(
         setup_dir,
@@ -218,7 +212,7 @@ def main():
         .strip("\n")
     )
 
-    cmake_build_dir = get_output(
+    cmake_build_dir = capture_cmd_output(
         ["find", "_skbuild", "-name", "cmake-build"],
         cwd=setup_dir,
     )

scripts/gen_docs.py

@@ -24,14 +24,14 @@
 
 from _build_helper import (  # noqa: E402
     build_extension,
+    capture_cmd_output,
     clean_build_dir,
     err,
-    get_output,
     install_editable,
+    log_cmake_args,
     make_cmake_args,
     resolve_compilers,
     run,
-    warn,
 )
 
 
@@ -151,21 +151,15 @@ def main():
         verbose=args.verbose,
     )
 
-    cmake_args += " -DDPCTL_GENERATE_DOCS=ON"
+    cmake_args += "-DDPCTL_GENERATE_DOCS=ON"
 
     if args.doxyrest_root:
-        cmake_args += " -DDPCTL_ENABLE_DOXYREST=ON"
-        cmake_args += f" -DDoxyrest_DIR={args.doxyrest_root}"
+        cmake_args += "-DDPCTL_ENABLE_DOXYREST=ON"
+        cmake_args += f"-DDoxyrest_DIR={args.doxyrest_root}"
 
-    env = os.environ.copy()
-
-    if "CMAKE_ARGS" in env and env["CMAKE_ARGS"].strip():
-        warn("Ignoring pre-existing CMAKE_ARGS in environment", "gen_docs")
-        del env["CMAKE_ARGS"]
+    log_cmake_args(cmake_args, "gen_docs")
 
-    env["CMAKE_ARGS"] = cmake_args
-
-    print(f"[gen_docs] Using CMake args:\n {env['CMAKE_ARGS']}")
+    env = os.environ.copy()
 
     build_extension(
         setup_dir,
@@ -175,7 +169,7 @@ def main():
         build_type="Release",
     )
     install_editable(setup_dir, env)
-    cmake_build_dir = get_output(
+    cmake_build_dir = capture_cmd_output(
         ["find", "_skbuild", "-name", "cmake-build"], cwd=setup_dir
     )