diff --git a/src/scikit_build_core/setuptools/build_cmake.py b/src/scikit_build_core/setuptools/build_cmake.py index 0bf75d91f..86936a435 100644 --- a/src/scikit_build_core/setuptools/build_cmake.py +++ b/src/scikit_build_core/setuptools/build_cmake.py @@ -9,6 +9,7 @@ import setuptools.errors from packaging.version import Version +from .._compat import tomllib from .._logging import LEVEL_VALUE, raw_logger from ..builder.builder import Builder, get_archs from ..builder.macos import normalize_macos_version @@ -45,6 +46,17 @@ def _validate_settings(settings: ScikitBuildSettings) -> None: ) +def get_source_dir_from_pyproject_toml() -> str | None: + try: + with Path("pyproject.toml").open("rb") as f: + source_dir: str | None = tomllib.load(f)["tool"]["scikit-build"]["cmake"][ + "source-dir" + ] + return source_dir + except (FileNotFoundError, KeyError): + return None + + class BuildCMake(setuptools.Command): source_dir: str | None = None cmake_args: list[str] | str | None = None @@ -73,7 +85,7 @@ def initialize_options(self) -> None: self.editable_mode = False self.parallel = None self.plat_name = None - self.source_dir = None + self.source_dir = get_source_dir_from_pyproject_toml() self.cmake_args = None def finalize_options(self) -> None: @@ -195,6 +207,8 @@ def finalize_distribution_options(dist: Distribution) -> None: build.sub_commands.append( ("build_cmake", lambda cmd: _has_cmake(cmd.distribution)) ) + if get_source_dir_from_pyproject_toml() is not None: + _cmake_extension(dist) def _cmake_extension(dist: Distribution) -> None: @@ -239,6 +253,9 @@ def cmake_source_dir( dist: Distribution, attr: Literal["cmake_source_dir"], value: str ) -> None: assert attr == "cmake_source_dir" + if get_source_dir_from_pyproject_toml() is not None: + msg = "cmake_source_dir is already defined in pyproject.toml" + raise setuptools.errors.SetupError(msg) _cmake_extension(dist) if not Path(value).is_dir(): msg = "cmake_source_dir must be an existing directory" diff --git a/tests/conftest.py b/tests/conftest.py index d63ec7fac..c769b6cb7 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -251,6 +251,15 @@ def package_simple_setuptools_ext( return package +@pytest.fixture +def package_toml_setuptools_ext( + tmp_path: Path, monkeypatch: pytest.MonkeyPatch +) -> PackageInfo: + package = PackageInfo("toml_setuptools_ext") + process_package(package, tmp_path, monkeypatch) + return package + + @pytest.fixture def package_mixed_setuptools( tmp_path: Path, monkeypatch: pytest.MonkeyPatch diff --git a/tests/packages/toml_setuptools_ext/CMakeLists.txt b/tests/packages/toml_setuptools_ext/CMakeLists.txt new file mode 100644 index 000000000..9ecd3b15d --- /dev/null +++ b/tests/packages/toml_setuptools_ext/CMakeLists.txt @@ -0,0 +1,13 @@ +cmake_minimum_required(VERSION 3.15...3.26) +project( + "${SKBUILD_PROJECT_NAME}" + LANGUAGES CXX + VERSION "${SKBUILD_PROJECT_VERSION}") + +find_package(pybind11 CONFIG REQUIRED) +pybind11_add_module(cmake_example src/main.cpp) + +target_compile_definitions(cmake_example + PRIVATE VERSION_INFO=${PROJECT_VERSION}) + +install(TARGETS cmake_example LIBRARY DESTINATION .) diff --git a/tests/packages/toml_setuptools_ext/LICENSE b/tests/packages/toml_setuptools_ext/LICENSE new file mode 100644 index 000000000..545551303 --- /dev/null +++ b/tests/packages/toml_setuptools_ext/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/toml_setuptools_ext/pyproject.toml b/tests/packages/toml_setuptools_ext/pyproject.toml new file mode 100644 index 000000000..04c41e85e --- /dev/null +++ b/tests/packages/toml_setuptools_ext/pyproject.toml @@ -0,0 +1,15 @@ +[build-system] +requires = [ + "scikit_build_core", + "setuptools", + "pybind11", +] +build-backend = "scikit_build_core.setuptools.build_meta" + +[project] +name = "cmake-example" +version = "0.0.1" +requires-python = ">=3.7" + +[tool.scikit-build] +cmake.source-dir = "." diff --git a/tests/packages/toml_setuptools_ext/src/main.cpp b/tests/packages/toml_setuptools_ext/src/main.cpp new file mode 100644 index 000000000..d00f6882e --- /dev/null +++ b/tests/packages/toml_setuptools_ext/src/main.cpp @@ -0,0 +1,38 @@ +#include + +#define STRINGIFY(x) #x +#define MACRO_STRINGIFY(x) STRINGIFY(x) + +int add(int i, int j) { + return i + j; +} + +namespace py = pybind11; + +PYBIND11_MODULE(cmake_example, m) { + m.doc() = R"pbdoc( + Pybind11 example plugin + ----------------------- + .. currentmodule:: cmake_example + .. autosummary:: + :toctree: _generate + add + subtract + )pbdoc"; + + m.def("add", &add, R"pbdoc( + Add two numbers + Some other explanation about the add function. + )pbdoc"); + + m.def("subtract", [](int i, int j) { return i - j; }, R"pbdoc( + Subtract two numbers + Some other explanation about the subtract function. + )pbdoc"); + +#ifdef VERSION_INFO + m.attr("__version__") = MACRO_STRINGIFY(VERSION_INFO); +#else + m.attr("__version__") = "dev"; +#endif +} diff --git a/tests/test_setuptools_pep517.py b/tests/test_setuptools_pep517.py index 801b21d84..03d745fed 100644 --- a/tests/test_setuptools_pep517.py +++ b/tests/test_setuptools_pep517.py @@ -1,14 +1,16 @@ -import sys import tarfile import textwrap import zipfile from pathlib import Path import pytest +from packaging.version import Version +from scikit_build_core._compat.importlib import metadata from scikit_build_core.setuptools.build_meta import build_sdist, build_wheel pytestmark = pytest.mark.setuptools +setuptools_version = Version(metadata.version("setuptools")) @pytest.mark.usefixtures("package_simple_setuptools_ext") @@ -67,11 +69,6 @@ def test_pep517_sdist(): @pytest.mark.configure @pytest.mark.broken_on_urct @pytest.mark.usefixtures("package_simple_setuptools_ext") -@pytest.mark.xfail( - sys.platform.startswith("cygwin"), - reason="Cygwin fails here with ld errors", - strict=False, -) def test_pep517_wheel(virtualenv): dist = Path("dist") out = build_wheel("dist") @@ -100,6 +97,89 @@ def test_pep517_wheel(virtualenv): assert add.strip() == "3" +@pytest.mark.usefixtures("package_toml_setuptools_ext") +@pytest.mark.skipif( + setuptools_version < Version("61.0"), reason="Requires setuptools 61+" +) +def test_toml_pep517_sdist(): + correct_metadata = textwrap.dedent( + """\ + Name: cmake-example + Version: 0.0.1 + Requires-Python: >=3.7 + """ + # This was removed in https://github.com/pypa/setuptools/pull/4698 as part of 2.2 support: + # Metadata-Version: 2.1 + ) + metadata_set = set(correct_metadata.strip().splitlines()) + + dist = Path("dist") + out = build_sdist("dist") + + (sdist,) = dist.iterdir() + assert sdist.name in {"cmake-example-0.0.1.tar.gz", "cmake_example-0.0.1.tar.gz"} + assert sdist == dist / out + cmake_example = sdist.name[:13] + + with tarfile.open(sdist) as f: + file_names = set(f.getnames()) + assert file_names == { + f"{cmake_example}-0.0.1/{x}" + for x in ( + # TODO: "CMakeLists.txt", + "PKG-INFO", + "src", + "src/cmake_example.egg-info", + "src/cmake_example.egg-info/PKG-INFO", + "src/cmake_example.egg-info/SOURCES.txt", + "src/cmake_example.egg-info/dependency_links.txt", + "src/cmake_example.egg-info/top_level.txt", + "pyproject.toml", + "setup.cfg", + "LICENSE", + # TODO: "src/main.cpp", + ) + } | {f"{cmake_example}-0.0.1"} + pkg_info = f.extractfile(f"{cmake_example}-0.0.1/PKG-INFO") + assert pkg_info + pkg_info_contents = set(pkg_info.read().decode().strip().splitlines()) + assert metadata_set <= pkg_info_contents + + +@pytest.mark.compile +@pytest.mark.configure +@pytest.mark.usefixtures("package_toml_setuptools_ext") +@pytest.mark.skipif( + setuptools_version < Version("61.0"), reason="Requires setuptools 61+" +) +def test_toml_pep517_wheel(virtualenv): + dist = Path("dist") + out = build_wheel("dist") + (wheel,) = dist.glob("cmake_example-0.0.1-*.whl") + assert wheel == dist / out + + with zipfile.ZipFile(wheel) as zf: + file_names = {Path(n).parts[0] for n in zf.namelist()} + + assert len(file_names) == 2 + assert "cmake_example-0.0.1.dist-info" in file_names + file_names.remove("cmake_example-0.0.1.dist-info") + (so_file,) = file_names + + assert so_file.startswith("cmake_example") + print("SOFILE:", so_file) + + virtualenv.install(wheel) + + version = virtualenv.execute( + "import cmake_example; print(cmake_example.__version__)" + ) + assert version.strip() == "0.0.1" + + add = virtualenv.execute("import cmake_example; print(cmake_example.add(1, 2))") + assert add.strip() == "3" + + @pytest.mark.compile @pytest.mark.configure @pytest.mark.usefixtures("package_mixed_setuptools")