Initial support for cmake.preset

Author: LecrisUT

README.md

@@ -181,6 +181,14 @@ cmake.source-dir = "."
 # DEPRECATED in 0.10; use build.targets instead.
 cmake.targets = ""
 
+# Configure preset to use. ``cmake.source-dir`` must still be appropriately
+# defined and it must contain a ``CMake(User)Presets.json``. The preset's
+# ``binaryDir`` is ignored and is always overwritten by the ``build-dir``
+# defined by scikit-build-core. ``cmake.define``, generator values are still
+# passed if defined and take precedence over preset's value according to CMake
+# logic.
+cmake.preset = ""
+
 # The versions of Ninja to allow. If Ninja is not present on the system or does
 # not pass this specifier, it will be downloaded via PyPI if possible. An empty
 # string will disable this check.

src/scikit_build_core/builder/builder.py

@@ -256,6 +256,7 @@ def configure(
         cmake_defines.update(self.settings.cmake.define)
 
         self.config.configure(
+            preset=self.settings.cmake.preset,
             defines=cmake_defines,
             cmake_args=[*self.get_cmake_args(), *configure_args],
         )

src/scikit_build_core/builder/generator.py

@@ -90,6 +90,7 @@ def set_environment_for_gen(
 
     If gen is not None, then that will be the target generator.
     """
+    # TODO: How does make_fallback interact when `preset` is set?
     allow_make_fallback = ninja_settings.make_fallback
 
     if generator:

src/scikit_build_core/cmake.py

@@ -222,12 +222,16 @@ def get_generator(self, *args: str) -> str | None:
     def configure(
         self,
         *,
+        preset: str | None = None,
         defines: Mapping[str, str | os.PathLike[str] | bool] | None = None,
         cmake_args: Sequence[str] = (),
     ) -> None:
         _cmake_args = self._compute_cmake_args(defines or {})
         all_args = [*_cmake_args, *cmake_args]
 
+        if preset:
+            all_args.append(f"--preset={preset}")
+
         gen = self.get_generator(*all_args)
         if gen:
             self.single_config = gen == "Ninja" or "Makefiles" in gen

src/scikit_build_core/resources/scikit-build.schema.json

@@ -102,6 +102,10 @@
           },
           "description": "DEPRECATED in 0.10; use build.targets instead.",
           "deprecated": true
+        },
+        "preset": {
+          "type": "string",
+          "description": "Configure preset to use. ``cmake.source-dir`` must still be appropriately defined and it must contain a ``CMake(User)Presets.json``. The preset's ``binaryDir`` is ignored and is always overwritten by the ``build-dir`` defined by scikit-build-core. ``cmake.define``, generator values are still passed if defined and take precedence over preset's value according to CMake logic."
         }
       }
     },

src/scikit_build_core/settings/skbuild_model.py

@@ -102,6 +102,15 @@ class CMakeSettings:
     DEPRECATED in 0.10; use build.targets instead.
     """
 
+    preset: Optional[str] = None
+    """
+    Configure preset to use. ``cmake.source-dir`` must still be appropriately defined
+    and it must contain a ``CMake(User)Presets.json``. The preset's ``binaryDir`` is
+    ignored and is always overwritten by the ``build-dir`` defined by scikit-build-core.
+    ``cmake.define``, generator values are still passed if defined and take precedence
+    over preset's value according to CMake logic.
+    """
+
 
 @dataclasses.dataclass
 class NinjaSettings:

tests/packages/cmake_defines/CMakeLists.txt

@@ -7,10 +7,19 @@ set(ONE_LEVEL_LIST
 set(NESTED_LIST
     ""
     CACHE STRING "")
+set(PRESET_ONLY_VAR
+    ""
+    CACHE STRING "")
+set(OVERWRITTEN_VAR
+    ""
+    CACHE STRING "")
 
 set(out_file "${CMAKE_CURRENT_BINARY_DIR}/log.txt")
 file(WRITE "${out_file}" "")
 
+file(APPEND "${out_file}" "PRESET_ONLY_VAR=${PRESET_ONLY_VAR}\n")
+file(APPEND "${out_file}" "OVERWRITTEN_VAR=${OVERWRITTEN_VAR}\n")
+
 foreach(list IN ITEMS ONE_LEVEL_LIST NESTED_LIST)
   list(LENGTH ${list} length)
   file(APPEND "${out_file}" "${list}.LENGTH = ${length}\n")

tests/packages/cmake_defines/CMakePresets.json

@@ -0,0 +1,13 @@
+{
+  "version": 4,
+  "configurePresets": [
+    {
+      "name": "scikit",
+      "cacheVariables": {
+        "PRESET_ONLY_VAR": "defined",
+        "OVERWRITTEN_VAR": "original"
+      },
+      "binaryDir": "/dev/null"
+    }
+  ]
+}

tests/packages/cmake_defines/pyproject.toml

@@ -9,3 +9,8 @@ ONE_LEVEL_LIST = [
     "Baz",
 ]
 NESTED_LIST = [ "Apple", "Lemon;Lime", "Banana" ]
+OVERWRITTEN_VAR = "overwritten"
+
+[[tool.scikit-build.overrides]]
+if.env.WITH_PRESET = true
+cmake.preset = "scikit"

tests/test_cmake_config.py

@@ -204,10 +204,14 @@ def test_cmake_paths(
     assert len(fp.calls) == 2
 
 
+@pytest.mark.parametrize("with_preset", [True, False])
 @pytest.mark.configure
 def test_cmake_defines(
+    monkeypatch,
     tmp_path: Path,
+    with_preset: bool,
 ):
+    monkeypatch.setenv("WITH_PRESET", f"{with_preset}")
     source_dir = DIR / "packages" / "cmake_defines"
     binary_dir = tmp_path / "build"
 
@@ -224,8 +228,14 @@ def test_cmake_defines(
     builder.configure(defines={})
 
     configure_log = Path.read_text(binary_dir / "log.txt")
+
+    # This var is always overwritten
+    overwritten_var = "overwritten"
+    preset_only_var = "defined" if with_preset else ""
     assert configure_log == dedent(
-        """\
+        f"""\
+        PRESET_ONLY_VAR={preset_only_var}
+        OVERWRITTEN_VAR={overwritten_var}
         ONE_LEVEL_LIST.LENGTH = 4
         Foo
         Bar