feat: add wheel.exclude (#560)

This is actually really easy to implement, and there already was a test
file named for this feature, so let's add it. :)

---------

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

Author: henryiii

README.md

@@ -241,6 +241,11 @@ wheel.cmake = true
 # platlib if wheel.cmake is true, and the purelib otherwise.
 wheel.platlib = ""
 
+# A set of patterns to exclude from the wheel. This is additive to the SDist
+# exclude patterns. This applies to the source files, not the final paths.
+# Editable installs may not respect this exclusion.
+wheel.exclude = []
+
 # If CMake is less than this value, backport a copy of FindPython. Set to 0
 # disable this, or the empty string.
 backport.find-python = "3.26.1"

docs/configuration.md

@@ -251,6 +251,14 @@ Globbing patterns are supported.
 wheel.license-files = ["LICENSE"]
 ```
 
+You can exclude files from the built wheel (on top of the `sdist.exclude` list)
+as well (not guaranteed to be respected by editable installs):
+
+```toml
+[tool.scikit-build]
+wheel.exclude = ["**.pyx"]
+```
+
 :::{note}
 
 There are two more settings that are primarily intended for `overrides` (see

src/scikit_build_core/build/wheel.py

@@ -329,7 +329,7 @@ def _build_wheel_impl(
             packages=packages,
             platlib_dir=wheel_dirs[targetlib],
             include=settings.sdist.include,
-            exclude=settings.sdist.exclude,
+            exclude=[*settings.sdist.exclude, *settings.wheel.exclude],
         )
 
         if not editable:

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

@@ -166,6 +166,13 @@
         "platlib": {
           "type": "boolean",
           "description": "Target the platlib or the purelib. If not set, the default is to target the platlib if wheel.cmake is true, and the purelib otherwise."
+        },
+        "exclude": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "A set of patterns to exclude from the wheel. This is additive to the SDist exclude patterns. This applies to the source files, not the final paths. Editable installs may not respect this exclusion."
         }
       }
     },

src/scikit_build_core/settings/skbuild_model.py

@@ -177,6 +177,13 @@ class WheelSettings:
     platlib if wheel.cmake is true, and the purelib otherwise.
     """
 
+    exclude: List[str] = dataclasses.field(default_factory=list)
+    """
+    A set of patterns to exclude from the wheel. This is additive to the SDist
+    exclude patterns. This applies to the source files, not the final paths.
+    Editable installs may not respect this exclusion.
+    """
+
 
 @dataclasses.dataclass
 class BackportSettings:

tests/test_simplest_c.py

@@ -110,6 +110,7 @@ def test_pep517_wheel_incexl(tmp_path, monkeypatch, virtualenv):
         {
             "sdist.include": "src/simplest/*included*.txt",
             "sdist.exclude": "src/simplest/*excluded*.txt",
+            "wheel.exclude": "src/simplest/sdist_only.txt",
             "wheel.packages": ["src/simplest", "src/not_a_package"],
         },
     )
@@ -135,7 +136,6 @@ def test_pep517_wheel_incexl(tmp_path, monkeypatch, virtualenv):
             "data.txt",
             "ignored_included.txt",
             "generated.txt",
-            "sdist_only.txt",
             "generated_ignored.txt",
         } == filtered_pkg
         assert {"simple.txt"} == not_a_pkg

tests/test_skbuild_settings.py

@@ -48,6 +48,7 @@ def test_skbuild_settings_default(tmp_path: Path):
         "NOTICE*",
         "AUTHORS*",
     ]
+    assert settings.wheel.exclude == []
     assert settings.backport.find_python == Version("3.26.1")
     assert settings.strict_config
     assert not settings.experimental
@@ -84,6 +85,7 @@ def test_skbuild_settings_envvar(tmp_path: Path, monkeypatch: pytest.MonkeyPatch
     monkeypatch.setenv("SKBUILD_WHEEL_PY_API", "cp39")
     monkeypatch.setenv("SKBUILD_WHEEL_EXPAND_MACOS_UNIVERSAL_TAGS", "True")
     monkeypatch.setenv("SKBUILD_WHEEL_LICENSE_FILES", "a;b;c")
+    monkeypatch.setenv("SKBUILD_WHEEL_EXCLUDE", "b;y;e")
     monkeypatch.setenv("SKBUILD_BACKPORT_FIND_PYTHON", "0")
     monkeypatch.setenv("SKBUILD_STRICT_CONFIG", "0")
     monkeypatch.setenv("SKBUILD_EXPERIMENTAL", "1")
@@ -122,6 +124,7 @@ def test_skbuild_settings_envvar(tmp_path: Path, monkeypatch: pytest.MonkeyPatch
     assert settings.wheel.py_api == "cp39"
     assert settings.wheel.expand_macos_universal_tags
     assert settings.wheel.license_files == ["a", "b", "c"]
+    assert settings.wheel.exclude == ["b", "y", "e"]
     assert settings.backport.find_python == Version("0")
     assert not settings.strict_config
     assert settings.experimental
@@ -166,6 +169,7 @@ def test_skbuild_settings_config_settings(
         "wheel.py-api": "cp39",
         "wheel.expand-macos-universal-tags": "True",
         "wheel.license-files": ["a", "b", "c"],
+        "wheel.exclude": ["b", "y", "e"],
         "backport.find-python": "0",
         "strict-config": "false",
         "experimental": "1",
@@ -203,6 +207,7 @@ def test_skbuild_settings_config_settings(
     assert settings.wheel.py_api == "cp39"
     assert settings.wheel.expand_macos_universal_tags
     assert settings.wheel.license_files == ["a", "b", "c"]
+    assert settings.wheel.exclude == ["b", "y", "e"]
     assert settings.backport.find_python == Version("0")
     assert not settings.strict_config
     assert settings.experimental
@@ -245,6 +250,7 @@ def test_skbuild_settings_pyproject_toml(
             wheel.py-api = "cp39"
             wheel.expand-macos-universal-tags = true
             wheel.license-files = ["a", "b", "c"]
+            wheel.exclude = ["b", "y", "e"]
             backport.find-python = "3.18"
             strict-config = false
             experimental = true
@@ -292,6 +298,7 @@ def test_skbuild_settings_pyproject_toml(
     assert settings.wheel.py_api == "cp39"
     assert settings.wheel.expand_macos_universal_tags
     assert settings.wheel.license_files == ["a", "b", "c"]
+    assert settings.wheel.exclude == ["b", "y", "e"]
     assert settings.backport.find_python == Version("3.18")
     assert not settings.strict_config
     assert settings.experimental