Repository: scikit-build/scikit-build-core
Pull request #727 (2024-04-26 18:42:07)

Fix CMAKE_ARGS that may have spaces inside quotes
The current logic for parsing `CMAKE_ARGS` assumes that it is safe to split the string on spaces. However, this may not be the case for all variables; some variables must be passed with spaces in them, but inside quotes. The [`CMAKE_<LANG>_FLAGS`](https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_FLAGS.html) are a prime example of this. Quoting from the docs:
> This value is a command-line string fragment. Therefore, multiple options should be separated by spaces, and options with spaces should be quoted.

To support this, the split needs to be done with a regular expression instead of a simple string split.

I left a note in the test regarding the fact that this behavior is sensitive to quotes. I don't know if we can or should do anything about that, though.

codecov[bot]: ## [Codecov](https://app.codecov.io/gh/scikit-build/scikit-build-core/pull/727?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scikit-build) Report
All modified and coverable lines are covered by tests :white_check_mark:
> Project coverage is 82.01%. Comparing base [(`c491554`)](https://app.codecov.io/gh/scikit-build/scikit-build-core/commit/c491554ba68996fee188d310f5ece09a3bb4ace4?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scikit-build) to head [(`8e46dc1`)](https://app.codecov.io/gh/scikit-build/scikit-build-core/pull/727?dropdown=coverage&src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scikit-build).


<details><summary>Additional details and impacted files</summary>


```diff
@@            Coverage Diff             @@
##             main     #727      +/-   ##
==========================================
+ Coverage   81.93%   82.01%   +0.07%     
==========================================
  Files          68       68              
  Lines        3881     3881              
==========================================
+ Hits         3180     3183       +3     
+ Misses        701      698       -3     
```



</details>

[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/scikit-build/scikit-build-core/pull/727?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scikit-build).   
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scikit-build).

henryiii: What about using `shlex.split`?
henryiii: Also, a unit test might be a lot cheaper than an integration test just for this function.

Patch:
diff --git a/docs/build.md b/docs/build.md
index c2107d3..34da7fc 100644
--- a/docs/build.md
+++ b/docs/build.md
@@ -110,6 +110,10 @@ The three new items here (compared to SDists) are the [compatibility tags][]:
 - `platform tag`: This is the platform the wheel is valid on, such as `any`,
   `linux_x86_64`, or `manylinux_2_17_x86_64`.
 
+(repairing-wheels)=
+
+## Repairing
+
 The wheels produced by default are not designed to be redistributable. Making
 them redistributable depends on platform:
 
@@ -122,8 +126,9 @@ them redistributable depends on platform:
   tag, and can be uploaded to PyPI.
 - macOS: The wheels should be build with the official CPython releases, and
   target a reasonable `MACOSX_DEPLOYMENT_TARGET` value (10.9 or newer). You
-  should run the wheels through `develwheel` to bundle external dependencies.
-  You'll also want to (carefully) cross compile for Apple Silicon.
+  should run the wheels through `develocate` to bundle external dependencies.
+  You'll also want to (carefully) cross compile for Apple Silicon or build on
+  Apple Silicon runners (`macos-14`+ on GHA).
 - Windows: this is the easiest, usually, as the wheels don't have special rules
   on what Python or OS is being used. However, if you want to bundle
   dependencies, you'll need `delvewheel`, which is a bit younger than the other
@@ -131,7 +136,11 @@ them redistributable depends on platform:
   works like those packages.
 
 The easiest way to handle all the above for all Python versions, OSs,
-architectures, including testing, is to use [cibuildwheel][].
+architectures, including testing, is to use [cibuildwheel][]. There's also a
+fairly new tool, [repairwheel][], that combines all these tools. Tools usually
+allow extra flags that can be used for trickier repairs, like ignoring CUDA
+libraries when bundling (which technically is not a true manylinux wheel, but is
+the current workaround).
 
 <!-- prettier-ignore-start -->
 
@@ -143,6 +152,7 @@ architectures, including testing, is to use [cibuildwheel][].
       `setup.py bdist_wheel`! You can avoid this whole mess with
       scikit-build-core.
 
+[repairwheel]: https://github.com/jvolkman/repairwheel
 [cibuildwheel]: https://cibuildwheel.readthedocs.io
 [compatibility tags]: https://packaging.python.org/en/latest/specifications/binary-distribution-format
 
diff --git a/docs/faqs.md b/docs/faqs.md
index b858701..81b44a5 100644
--- a/docs/faqs.md
+++ b/docs/faqs.md
@@ -69,6 +69,23 @@ printout of the current settings using:
 python -m scikit_build_core.builder
 ```
 
+## Repairing wheels
+
+Like most other backends[^1], scikit-build-core produced `linux` wheels, which
+are not redistrubutable cannot be uploaded to PyPI[^2]. You have to run your
+wheels through `auditwheel` to make `manylinux` wheels. `cibuildwheel`
+automatically does this for you. See [repairing](#repairing-wheels).
+
+[^1]:
+    Due to a [bug in packaging](https://github.com/pypa/packaging/issues/160),
+    some backends may mistakenly produce the wrong tags (including
+    scikit-build-core < 0.9), but the wheels are not actually
+    manylinux/musllinux, just mistagged.
+
+[^2]:
+    Platforms like ARMv6 that do not have a manylinux spec are exempt from this
+    rule.
+
 <!-- prettier-ignore-start -->
 
 [scientific python cookie]: https://github.com/scientific-python/cookie
diff --git a/src/scikit_build_core/builder/builder.py b/src/scikit_build_core/builder/builder.py
index e8a6c4c..2751f7a 100644
--- a/src/scikit_build_core/builder/builder.py
+++ b/src/scikit_build_core/builder/builder.py
@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import dataclasses
 import re
+import shlex
 import sys
 import sysconfig
 from pathlib import Path
@@ -94,9 +95,10 @@ class Builder:
         """
         # Adding CMake arguments set as environment variable
         # (needed e.g. to build for ARM OSX on conda-forge)
-        env_cmake_args = list(
-            filter(None, self.config.env.get("CMAKE_ARGS", "").split(" "))
+        env_cmake_args: list[str] = list(
+            filter(None, shlex.split(self.config.env.get("CMAKE_ARGS", "")))
         )
+
         if env_cmake_args:
             logger.debug("Env CMAKE_ARGS: {}", env_cmake_args)
 
diff --git a/src/scikit_build_core/builder/sysconfig.py b/src/scikit_build_core/builder/sysconfig.py
index 98e14c6..a299450 100644
--- a/src/scikit_build_core/builder/sysconfig.py
+++ b/src/scikit_build_core/builder/sysconfig.py
@@ -60,6 +60,8 @@ def get_python_library(env: Mapping[str, str], *, abi3: bool = False) -> Path |
     multiarch: str | None = sysconfig.get_config_var("MULTIARCH")
     masd: str | None = sysconfig.get_config_var("multiarchsubdir")
 
+    log_func = logger.warning if sys.platform.startswith("win") else logger.debug
+
     if libdir and ldlibrary:
         try:
             libdir_is_dir = libdir.is_dir()
@@ -75,9 +77,9 @@ def get_python_library(env: Mapping[str, str], *, abi3: bool = False) -> Path |
             libpath = libdir / ldlibrary
             if Path(os.path.expandvars(libpath)).is_file():
                 return libpath
-            logger.warning("libdir/ldlibrary: {} is not a real file!", libpath)
+            log_func("libdir/ldlibrary: {} is not a real file!", libpath)
         else:
-            logger.warning("libdir: {} is not a directory", libdir)
+            log_func("libdir: {} is not a directory", libdir)
 
     framework_prefix = sysconfig.get_config_var("PYTHONFRAMEWORKPREFIX")
     if framework_prefix and Path(framework_prefix).is_dir() and ldlibrary:


Test patch:
diff --git a/tests/conftest.py b/tests/conftest.py
index a4b73ce..81acbd6 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -217,6 +217,17 @@ def package_simple_pyproject_ext(
     return package
 
 
+@pytest.fixture()
+def package_simple_pyproject_script_with_flags(
+    tmp_path: Path, monkeypatch: pytest.MonkeyPatch
+) -> PackageInfo:
+    package = PackageInfo(
+        "simple_pyproject_script_with_flags",
+    )
+    process_package(package, tmp_path, monkeypatch)
+    return package
+
+
 @pytest.fixture()
 def package_simple_pyproject_source_dir(
     tmp_path: Path, monkeypatch: pytest.MonkeyPatch
diff --git a/tests/packages/simple_pyproject_script_with_flags/CMakeLists.txt b/tests/packages/simple_pyproject_script_with_flags/CMakeLists.txt
new file mode 100644
index 0000000..1377670
--- /dev/null
+++ b/tests/packages/simple_pyproject_script_with_flags/CMakeLists.txt
@@ -0,0 +1,9 @@
+cmake_minimum_required(VERSION 3.15...3.29)
+project(
+  "${SKBUILD_PROJECT_NAME}"
+  LANGUAGES C
+  VERSION "${SKBUILD_PROJECT_VERSION}")
+
+add_executable(cmake_example src/main.c)
+set_target_properties(cmake_example PROPERTIES POSITION_INDEPENDENT_CODE ON)
+install(TARGETS cmake_example DESTINATION "${SKBUILD_SCRIPTS_DIR}")
diff --git a/tests/packages/simple_pyproject_script_with_flags/LICENSE b/tests/packages/simple_pyproject_script_with_flags/LICENSE
new file mode 100644
index 0000000..5455513
--- /dev/null
+++ b/tests/packages/simple_pyproject_script_with_flags/LICENSE
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Henry Schreiner
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/tests/packages/simple_pyproject_script_with_flags/pyproject.toml b/tests/packages/simple_pyproject_script_with_flags/pyproject.toml
new file mode 100644
index 0000000..6f329e1
--- /dev/null
+++ b/tests/packages/simple_pyproject_script_with_flags/pyproject.toml
@@ -0,0 +1,13 @@
+[build-system]
+requires = [
+    "scikit_build_core",
+]
+build-backend = "scikit_build_core.build"
+
+[project]
+name = "CMake.Example"
+version = "0.0.1"
+requires-python = ">=3.7"
+
+[tool.scikit-build]
+wheel.py-api = "py3"
diff --git a/tests/packages/simple_pyproject_script_with_flags/src/main.c b/tests/packages/simple_pyproject_script_with_flags/src/main.c
new file mode 100644
index 0000000..9b1e4a4
--- /dev/null
+++ b/tests/packages/simple_pyproject_script_with_flags/src/main.c
@@ -0,0 +1,17 @@
+#include <assert.h>
+#include <stdbool.h>
+#include <stdio.h>
+
+#ifndef FOO
+static_assert(false, "FOO must be defined");
+#elif FOO != 1
+static_assert(false, "FOO must be 1");
+#endif
+#ifndef BAR
+static_assert(false, "BAR must be defined");
+#endif
+
+int main() {
+    printf("Hello world!");
+    return 0;
+}
diff --git a/tests/test_builder.py b/tests/test_builder.py
index c6092af..e5b1546 100644
--- a/tests/test_builder.py
+++ b/tests/test_builder.py
@@ -109,6 +109,25 @@ def test_builder_macos_arch_extra(monkeypatch):
     assert archs_to_tags(get_archs(tmpbuilder.config.env)) == ["universal2"]
 
 
+@pytest.mark.parametrize(
+    ("cmake_args", "answer"),
+    [
+        ("-DA=1 -DB=2", ["-DA=1", "-DB=2"]),
+        (r"-DA='1 1' -DB=\'2\'", ["-DA=1 1", "-DB='2'"]),
+        (r'-DA="1 1" -DB=\"2\"', ["-DA=1 1", '-DB="2"']),
+        ('"-DA=1 1" -DB=2', ["-DA=1 1", "-DB=2"]),
+    ],
+)
+def test_builder_get_cmake_args(monkeypatch, cmake_args, answer):
+    monkeypatch.setenv("CMAKE_ARGS", cmake_args)
+    tmpcfg = typing.cast(CMaker, SimpleNamespace(env=os.environ.copy()))
+    tmpbuilder = Builder(
+        settings=ScikitBuildSettings(wheel=WheelSettings()),
+        config=tmpcfg,
+    )
+    assert tmpbuilder.get_cmake_args() == answer
+
+
 @pytest.mark.parametrize(
     ("minver", "archs", "answer"),
     [
diff --git a/tests/test_pyproject_pep517.py b/tests/test_pyproject_pep517.py
index 215ee3d..7cb3729 100644
--- a/tests/test_pyproject_pep517.py
+++ b/tests/test_pyproject_pep517.py
@@ -160,6 +160,35 @@ def test_pep517_sdist_time_hash_set_epoch(
     assert hash == package_simple_pyproject_ext.sdist_dated_hash
 
 
+@pytest.mark.compile()
+@pytest.mark.configure()
+@pytest.mark.usefixtures("package_simple_pyproject_script_with_flags")
+@pytest.mark.parametrize(
+    ("env_var", "setting"),
+    [
+        ("CMAKE_ARGS", '-DCMAKE_C_FLAGS="-DFOO=1 -DBAR="'),
+        ("SKBUILD_CMAKE_ARGS", "-DCMAKE_C_FLAGS=-DFOO=1 -DBAR="),
+    ],
+)
+def test_passing_cxx_flags(monkeypatch, env_var, setting):
+    # Note: This is sensitive to the types of quotes for SKBUILD_CMAKE_ARGS
+    monkeypatch.setenv(env_var, setting)
+    build_wheel("dist", {"cmake.targets": ["cmake_example"]})  # Could leave empty
+    (wheel,) = Path("dist").glob("cmake_example-0.0.1-py3-none-*.whl")
+    with zipfile.ZipFile(wheel) as f:
+        file_names = set(f.namelist())
+
+    ext = ".exe" if sys.platform.startswith(("win", "cygwin")) else ""
+
+    assert file_names == {
+        "cmake_example-0.0.1.dist-info/RECORD",
+        "cmake_example-0.0.1.dist-info/WHEEL",
+        f"cmake_example-0.0.1.data/scripts/cmake_example{ext}",
+        "cmake_example-0.0.1.dist-info/METADATA",
+        "cmake_example-0.0.1.dist-info/licenses/LICENSE",
+    }
+
+
 @pytest.mark.compile()
 @pytest.mark.configure()
 @pytest.mark.usefixtures("package_simple_pyproject_ext")