initial commit

Author: LeiWang1999

docs/reference/configs.md

@@ -271,6 +271,15 @@ print(mk_skbuild_docs())
   :default: true
 
   Turn on verbose output for the editable mode rebuilds.
+
+```{eval-rst}
+.. confval:: editable.build-dir
+  :type: ``str``
+  :default: ""
+
+  Build directory to use when ``editable.mode`` is ``"inplace"``. If empty, the project
+  source directory is used.
+```
 ```
 
 ## generate[]

src/scikit_build_core/build/wheel.py

@@ -279,24 +279,29 @@ def _build_wheel_impl_impl(
             root_is_purelib=targetlib == "purelib",
             build_tag=settings.wheel.build_tag,
         )
+        format_data = pyproject_format(
+            settings=settings,
+            tags=tags,
+            state=state,
+        )
 
         # A build dir can be specified, otherwise use a temporary directory
+        log_build_dir = True
         if cmake is not None and editable and settings.editable.mode == "inplace":
-            build_dir = settings.cmake.source_dir
+            if settings.editable.build_dir:
+                build_dir = Path(
+                    settings.editable.build_dir.format(**format_data)
+                )
+            else:
+                build_dir = settings.cmake.source_dir
+                log_build_dir = False
         else:
             build_dir = (
-                Path(
-                    settings.build_dir.format(
-                        **pyproject_format(
-                            settings=settings,
-                            tags=tags,
-                            state=state,
-                        )
-                    )
-                )
+                Path(settings.build_dir.format(**format_data))
                 if settings.build_dir
                 else build_tmp_folder / "build"
             )
+        if log_build_dir:
             logger.info("Build directory: {}", build_dir.resolve())
 
         wheel_dirs = {
@@ -426,6 +431,12 @@ def _build_wheel_impl_impl(
                 f"SKBUILD_{k.upper()}_DIR": v for k, v in wheel_dirs.items()
             }
             cache_entries["SKBUILD_STATE"] = state
+            if editable:
+                cache_entries["SKBUILD_EDITABLE_MODE"] = settings.editable.mode
+                if settings.editable.build_dir:
+                    cache_entries["SKBUILD_EDITABLE_BUILD_DIR"] = os.fspath(
+                        build_dir.resolve()
+                    )
             builder.configure(
                 defines=defines,
                 cache_entries=cache_entries,

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

@@ -274,6 +274,11 @@
           "type": "boolean",
           "default": false,
           "description": "Rebuild the project when the package is imported."
+        },
+        "build-dir": {
+          "type": "string",
+          "default": "",
+          "description": "Build directory to use when ``editable.mode`` is \"inplace\". If empty, the project source directory is used."
         }
       }
     },

src/scikit_build_core/settings/skbuild_model.py

@@ -344,6 +344,13 @@ class EditableSettings:
     :confval:`build-dir` must be set.
     """
 
+    build_dir: str = ""
+    """
+    Build directory to use when :confval:`editable.mode` is ``inplace``.
+
+    If empty, the project source directory is used (the historical behaviour).
+    """
+
 
 @dataclasses.dataclass
 class BuildSettings:

tests/packages/simplest_c/CMakeLists.txt

@@ -14,10 +14,15 @@ install(
   DESTINATION ${SKBUILD_PROJECT_NAME}
   COMPONENT PythonModule)
 
-if("${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}"
-   AND DEFINED SKBUILD)
-  # Editable in-place builds. THe empty generator expression ensures
-  # multi-config enerators keeps us from having to set
+if(DEFINED SKBUILD_EDITABLE_MODE AND SKBUILD_EDITABLE_MODE STREQUAL "inplace")
+  # Editable in-place builds using a dedicated build directory.
+  set_target_properties(
+    _module PROPERTIES LIBRARY_OUTPUT_DIRECTORY
+                       "${CMAKE_SOURCE_DIR}/src/${SKBUILD_PROJECT_NAME}$<0:>")
+elseif("${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}"
+       AND DEFINED SKBUILD)
+  # Editable in-place builds with an in-source build directory. The empty generator
+  # expression ensures multi-config generators keep us from having to set
   # LIBRARY_OUTPUT_DIRECTORY_<CONFIG> too.
   set_target_properties(
     _module PROPERTIES LIBRARY_OUTPUT_DIRECTORY

tests/test_editable.py

@@ -64,11 +64,13 @@ def test_navigate_editable(isolated, isolate, package):
 def test_cython_pxd(monkeypatch, tmp_path, editable, editable_mode, isolated):
     editable_flag = ["-e"] if editable else []
 
-    config_mode_flags = []
+    config_mode_flags = ["--config-settings=build-dir=build/{wheel_tag}"]
     if editable:
         config_mode_flags.append(f"--config-settings=editable.mode={editable_mode}")
-    if editable_mode != "inplace":
-        config_mode_flags.append("--config-settings=build-dir=build/{wheel_tag}")
+    if editable_mode == "inplace":
+        config_mode_flags.append(
+            "--config-settings=editable.build-dir=build/{wheel_tag}/editable"
+        )
 
     package1 = PackageInfo(
         "cython_pxd_editable/pkg1",
@@ -170,11 +172,13 @@ def _setup_package_for_editable_layout_tests(
 ) -> None:
     editable_flag = ["-e"] if editable else []
 
-    config_mode_flags = []
+    config_mode_flags = ["--config-settings=build-dir=build/{wheel_tag}"]
     if editable:
         config_mode_flags.append(f"--config-settings=editable.mode={editable_mode}")
-    if editable_mode != "inplace":
-        config_mode_flags.append("--config-settings=build-dir=build/{wheel_tag}")
+    if editable_mode == "inplace":
+        config_mode_flags.append(
+            "--config-settings=editable.build-dir=build/{wheel_tag}/editable"
+        )
 
     # Use a context so that we only change into the directory up until the point where
     # we run the editable install. We do not want to be in that directory when importing

tests/test_pyproject_pep660.py

@@ -25,7 +25,13 @@ def editable_mode(request: pytest.FixtureRequest) -> str:
 @pytest.mark.usefixtures("package_simplest_c")
 def test_pep660_wheel(editable_mode: str, tmp_path: Path):
     dist = tmp_path / "dist"
-    out = build_editable(str(dist), {"editable.mode": editable_mode})
+    config_settings = {
+        "build-dir": "build/{wheel_tag}",
+        "editable.mode": editable_mode,
+    }
+    if editable_mode == "inplace":
+        config_settings["editable.build-dir"] = "build/{wheel_tag}/editable"
+    out = build_editable(str(dist), config_settings)
     (wheel,) = dist.glob("simplest-0.0.1-*.whl")
     assert wheel == dist / out
 
@@ -61,12 +67,17 @@ def test_pep660_pip_isolated(isolated, isolate, editable_mode: str):
     if not isolate:
         isolated.install("scikit-build-core")
 
-    build_dir = "" if editable_mode == "inplace" else "build/{wheel_tag}"
-
+    config_flags = [
+        "--config-settings=build-dir=build/{wheel_tag}",
+        f"--config-settings=editable.mode={editable_mode}",
+    ]
+    if editable_mode == "inplace":
+        config_flags.append(
+            "--config-settings=editable.build-dir=build/{wheel_tag}/editable"
+        )
     isolated.install(
         "-v",
-        f"--config-settings=build-dir={build_dir}",
-        f"--config-settings=editable.mode={editable_mode}",
+        *config_flags,
         *isolate_args,
         "-e",
         ".",