feat(setuptools): adding cmake_args (#314)

Adds cmake_args, can be combined with `[build_cmake] cmake_args` and
other ways to set it.

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

pyproject.toml

@@ -88,6 +88,7 @@ Examples = "https://github.com/scikit-build/scikit-build-core/tree/main/tests/pa
 [project.entry-points]
 "distutils.commands".build_cmake = "scikit_build_core.setuptools.build_cmake:BuildCMake"
 "distutils.setup_keywords".cmake_source_dir = "scikit_build_core.setuptools.build_cmake:cmake_source_dir"
+"distutils.setup_keywords".cmake_args = "scikit_build_core.setuptools.build_cmake:cmake_args"
 "setuptools.finalize_distribution_options".scikit_build_entry = "scikit_build_core.setuptools.build_cmake:finalize_distribution_options"
 
 [tool.hatch]

src/scikit_build_core/builder/builder.py

@@ -4,7 +4,7 @@
 import re
 import sys
 import sysconfig
-from collections.abc import Mapping, Sequence
+from collections.abc import Iterable, Mapping, Sequence
 from pathlib import Path
 
 from packaging.version import Version
@@ -83,6 +83,7 @@ def configure(
         name: str | None = None,
         version: Version | None = None,
         limited_abi: bool | None = None,
+        configure_args: Iterable[str] = (),
     ) -> None:
         cmake_defines = dict(defines)
 
@@ -181,7 +182,7 @@ def configure(
 
         self.config.configure(
             defines=cmake_defines,
-            cmake_args=self.get_cmake_args(),
+            cmake_args=[*self.get_cmake_args(), *configure_args],
         )
 
     def build(self, build_args: list[str]) -> None:

src/scikit_build_core/setuptools/build_cmake.py

@@ -6,6 +6,7 @@
 from pathlib import Path
 
 import setuptools
+import setuptools.errors
 from packaging.version import Version
 from setuptools.dist import Distribution
 
@@ -38,6 +39,7 @@ def _validate_settings() -> None:
 
 class BuildCMake(setuptools.Command):
     source_dir: str | None = None
+    cmake_args: list[str] | str | None = None
 
     build_lib: str | None
     build_temp: str | None
@@ -52,6 +54,8 @@ class BuildCMake(setuptools.Command):
         ("plat-name=", "p", "platform name to cross-compile for, if supported "),
         ("debug", "g", "compile/link with debugging information"),
         ("parallel=", "j", "number of parallel build jobs"),
+        ("source-dir=", "j", "directory with CMakeLists.txt"),
+        ("cmake-args=", "a", "extra arguments for CMake"),
     ]
 
     def initialize_options(self) -> None:
@@ -61,6 +65,8 @@ def initialize_options(self) -> None:
         self.editable_mode = False
         self.parallel = None
         self.plat_name = None
+        self.source_dir = None
+        self.cmake_args = None
 
     def finalize_options(self) -> None:
         self.set_undefined_options(
@@ -72,8 +78,12 @@ def finalize_options(self) -> None:
             ("plat_name", "plat_name"),
         )
 
+        if isinstance(self.cmake_args, str):
+            self.cmake_args = [
+                b.strip() for a in self.cmake_args.split() for b in a.split(";")
+            ]
+
     def run(self) -> None:
-        assert self.source_dir is not None
         assert self.build_lib is not None
         assert self.build_temp is not None
         assert self.plat_name is not None
@@ -84,6 +94,14 @@ def run(self) -> None:
         build_temp = build_tmp_folder / "_skbuild"  # TODO: include python platform
 
         dist = self.distribution
+        dist_source_dir = getattr(self.distribution, "cmake_source_dir", None)
+        source_dir = self.source_dir if dist_source_dir is None else dist_source_dir
+        assert source_dir is not None, "This should not be reachable"
+
+        configure_args = self.cmake_args or []
+        assert isinstance(configure_args, list)
+        dist_cmake_args = getattr(self.distribution, "cmake_args", None)
+        configure_args.extend(dist_cmake_args or [])
 
         bdist_wheel = dist.get_command_obj("bdist_wheel")
         assert bdist_wheel is not None
@@ -101,7 +119,7 @@ def run(self) -> None:
 
         config = CMaker(
             cmake,
-            source_dir=Path(self.source_dir),
+            source_dir=Path(source_dir),
             build_dir=build_temp,
             build_type=settings.cmake.build_type,
         )
@@ -126,6 +144,7 @@ def run(self) -> None:
             version=Version(dist.get_version()),
             defines={},
             limited_abi=limited_api,
+            configure_args=configure_args,
         )
 
         # Set CMAKE_BUILD_PARALLEL_LEVEL to control the parallel build level
@@ -153,7 +172,10 @@ def run(self) -> None:
 def _has_cmake(dist: Distribution) -> bool:
     build_cmake = dist.get_command_obj("build_cmake")
     assert isinstance(build_cmake, BuildCMake)
-    return build_cmake.source_dir is not None
+    return (
+        build_cmake.source_dir is not None
+        or getattr(dist, "cmake_source_dir", None) is not None
+    )
 
 
 def _prepare_extension_detection(dist: Distribution) -> None:
@@ -181,16 +203,22 @@ def _prepare_build_cmake_command(dist: Distribution) -> None:
         )
 
 
-def cmake_source_dir(
-    dist: Distribution, attr: Literal["cmake_source_dir"], value: str
+def cmake_args(
+    _dist: Distribution, attr: Literal["cmake_args"], value: list[str]
 ) -> None:
-    assert attr == "cmake_source_dir"
-    assert Path(value).is_dir()
+    assert attr == "cmake_args"
+    if not isinstance(value, list):
+        msg = "cmake_args must be a list"
+        raise setuptools.errors.SetupError(msg)
 
-    build_cmake = dist.get_command_obj("build_cmake")
-    assert isinstance(build_cmake, BuildCMake)
 
-    build_cmake.source_dir = value
+def cmake_source_dir(
+    _dist: Distribution, attr: Literal["cmake_source_dir"], value: str
+) -> None:
+    assert attr == "cmake_source_dir"
+    if not Path(value).is_dir():
+        msg = "cmake_source_dir must be an existing directory"
+        raise setuptools.errors.SetupError(msg)
 
 
 def finalize_distribution_options(dist: Distribution) -> None:

tests/packages/mixed_setuptools/CMakeLists.txt

@@ -1,6 +1,26 @@
 cmake_minimum_required(VERSION 3.15...3.26)
 project("${SKBUILD_PROJECT_NAME}" LANGUAGES CXX)
 
+if(NOT EXAMPLE_DEFINE1 EQUAL 1)
+  message(FATAL_ERROR "Example define 1 is not set")
+endif()
+
+if(NOT EXAMPLE_DEFINE2 EQUAL 2)
+  message(FATAL_ERROR "Example define 2 is not set")
+endif()
+
+if(NOT EXAMPLE_DEFINE3 EQUAL 3)
+  message(FATAL_ERROR "Example define 3 is not set")
+endif()
+
+if(NOT EXAMPLE_DEFINE4 EQUAL 4)
+  message(FATAL_ERROR "Example define 4 is not set")
+endif()
+
+if(NOT EXAMPLE_DEFINE5 EQUAL 5)
+  message(FATAL_ERROR "Example define 5 is not set")
+endif()
+
 find_package(pybind11 CONFIG REQUIRED)
 pybind11_add_module(_core src/main.cpp)
 

tests/packages/mixed_setuptools/pyproject.toml

@@ -5,3 +5,9 @@ requires = [
     "pybind11",
 ]
 build-backend = "scikit_build_core.setuptools.build_meta"
+
+[tool.scikit-build]
+cmake.args = ["-DEXAMPLE_DEFINE3=3"]
+
+[tool.scikit-build.cmake.define]
+EXAMPLE_DEFINE4 = "4"

tests/packages/mixed_setuptools/setup.cfg

@@ -14,3 +14,6 @@ where = src
 
 [build_cmake]
 source_dir = .
+cmake_args =
+    -DEXAMPLE_DEFINE1=1
+    -DEXAMPLE_DEFINE2=2

tests/packages/mixed_setuptools/setup.py

@@ -1,3 +1,3 @@
 from setuptools import setup
 
-setup()
+setup(cmake_args=["-DEXAMPLE_DEFINE5=5"])