Initial support for cmake.preset

Signed-off-by: Cristian Le <[email protected]>

Author: LecrisUT

README.md

@@ -172,6 +172,9 @@ cmake.build-type = "Release"
 # The source directory to use when building the project.
 cmake.source-dir = "."
 
+# Configure preset to use. ``cmake.source-dir`` must still be appropriately defined
+cmake.preset = ""
+
 # The versions of Ninja to allow.
 ninja.version = ">=1.5"
 

docs/reference/configs.md

@@ -199,6 +199,17 @@ print(mk_skbuild_docs())
   DEPRECATED in 0.8; use version instead.
 ```
 
+```{eval-rst}
+.. confval:: cmake.preset
+  :type: ``str``
+
+  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.
+```
+
 ```{eval-rst}
 .. confval:: cmake.source-dir
   :type: ``Path``

src/scikit_build_core/builder/builder.py

@@ -292,6 +292,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

@@ -12,11 +12,18 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
+from packaging.version import Version
+
 from . import __version__
 from ._compat.builtins import ExceptionGroup
 from ._logging import logger
 from ._shutil import Run
-from .errors import CMakeConfigError, CMakeNotFoundError, FailedLiveProcessError
+from .errors import (
+    CMakeConfigError,
+    CMakeNotFoundError,
+    CMakeVersionError,
+    FailedLiveProcessError,
+)
 from .file_api.query import stateless_query
 from .file_api.reply import load_reply_dir
 from .program_search import Program, best_program, get_cmake_program, get_cmake_programs
@@ -25,7 +32,6 @@
     from collections.abc import Generator, Iterable, Mapping, Sequence
 
     from packaging.specifiers import SpecifierSet
-    from packaging.version import Version
 
     from ._compat.typing import Self
     from .file_api.model.index import Index
@@ -242,12 +248,19 @@ 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:
+            if self.cmake.version < Version("3.19"):
+                msg = f"CMake version ({self.cmake.version}) is too old to support presets."
+                raise CMakeVersionError(msg)
+            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"
         }
       }
     },

src/scikit_build_core/settings/skbuild_model.py

@@ -133,6 +133,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 SearchSettings:

src/scikit_build_core/settings/skbuild_read_settings.py

@@ -285,8 +285,12 @@ def __init__(
                 new_min_cmake = "3.15"
             self.settings.cmake.version = SpecifierSet(f">={new_min_cmake}")
 
+        default_cmake_minimum = "3.15"
+        if self.settings.cmake.preset:
+            default_cmake_minimum = "3.19"
+
         _handle_minimum_version(
-            self.settings.cmake, self.settings.minimum_version, "3.15"
+            self.settings.cmake, self.settings.minimum_version, default_cmake_minimum
         )
         _handle_minimum_version(self.settings.ninja, self.settings.minimum_version)
 

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,14 @@
+{
+  "version": 1,
+  "configurePresets": [
+    {
+      "name": "scikit",
+      "cacheVariables": {
+        "PRESET_ONLY_VAR": "defined",
+        "OVERWRITTEN_VAR": "original"
+      },
+      "binaryDir": "/dev/null",
+      "generator": "Ninja"
+    }
+  ]
+}