refactor: use from_pyproject (#224)

Pulling out a change from #197, will reduce the diff there. This could
go into 0.2.2, though it changes the signature of SettingsReader, that's
not really public.

Signed-off-by: Henry Schreiner <[email protected]>
Co-authored-by: Ben Rowland <[email protected]>

Author: henryiii

.github/CONTRIBUTING.md

@@ -189,7 +189,7 @@ usable as:
 ```python
 from scikit_build_core.settings.skbuild_settings import SettingsReader
 
-settings_reader = SettingsReader(Path("pyproject.toml"), config_settings or {})
+settings_reader = SettingsReader.from_file("pyproject.toml", config_settings)
 setting = settings_reader.settings
 assert settings.cmake.minimum_version == "3.15"
 assert settings.ninja.minimum_version == "1.5"

pyproject.toml

@@ -164,6 +164,7 @@ report.exclude_lines = [
     'if typing.TYPE_CHECKING:',
 ]
 
+
 [tool.check-wheel-contents]
 ignore = ["W002"]  # Triggers on __init__.py's
 

src/scikit_build_core/build/sdist.py

@@ -69,7 +69,7 @@ def build_sdist(
     sdist_directory: str,
     config_settings: dict[str, list[str] | str] | None = None,
 ) -> str:
-    settings_reader = SettingsReader(Path("pyproject.toml"), config_settings or {})
+    settings_reader = SettingsReader.from_file("pyproject.toml", config_settings)
     settings = settings_reader.settings
     setup_logging(settings.logging.level)
 

src/scikit_build_core/build/wheel.py

@@ -64,7 +64,7 @@ def _build_wheel_impl(
     Build a wheel or just prepare metadata (if wheel dir is None).
     """
 
-    settings_reader = SettingsReader(Path("pyproject.toml"), config_settings or {})
+    settings_reader = SettingsReader.from_file("pyproject.toml", config_settings)
     settings = settings_reader.settings
     setup_logging(settings.logging.level)
 

src/scikit_build_core/builder/get_requires.py

@@ -4,7 +4,6 @@
 import os
 import sys
 from collections.abc import Mapping
-from pathlib import Path
 
 from packaging.tags import sys_tags
 from packaging.version import Version
@@ -42,7 +41,7 @@ def is_known_platform(platforms: frozenset[str]) -> bool:
 def cmake_ninja_for_build_wheel(
     config_settings: Mapping[str, str | list[str]] | None = None
 ) -> list[str]:
-    settings = SettingsReader(Path("pyproject.toml"), config_settings or {}).settings
+    settings = SettingsReader.from_file("pyproject.toml", config_settings).settings
 
     packages = []
     cmake_min = Version(settings.cmake.minimum_version)

src/scikit_build_core/settings/skbuild_read_settings.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 
 import difflib
+import os
 import sys
 from collections.abc import Generator, Mapping
 from pathlib import Path
+from typing import Any
 
 from packaging.version import Version
 
@@ -24,13 +26,11 @@ def __dir__() -> list[str]:
 class SettingsReader:
     def __init__(
         self,
-        pyproject_toml: Path,
+        pyproject: dict[str, Any],
         config_settings: Mapping[str, str | list[str]],
+        *,
         verify_conf: bool = True,
     ) -> None:
-        with pyproject_toml.open("rb") as f:
-            pyproject = tomllib.load(f)
-
         self.sources = SourceChain(
             EnvSource("SKBUILD"),
             ConfSource(settings=config_settings, verify=verify_conf),
@@ -85,3 +85,16 @@ def validate_may_exit(self) -> None:
                 self.print_suggestions()
                 raise SystemExit(7)
             logger.warning("Unrecognized options: {}", ", ".join(unrecognized))
+
+    @classmethod
+    def from_file(
+        cls,
+        pyproject_path: os.PathLike[str] | str,
+        config_settings: Mapping[str, str | list[str]] | None,
+        *,
+        verify_conf: bool = True,
+    ) -> SettingsReader:
+        with Path(pyproject_path).open("rb") as f:
+            pyproject = tomllib.load(f)
+
+        return cls(pyproject, config_settings or {}, verify_conf=verify_conf)

src/scikit_build_core/setuptools/extension.py

@@ -57,7 +57,7 @@ def build_extension(self, ext: setuptools.Extension) -> None:
         if build_temp.exists():
             shutil.rmtree(build_temp)
 
-        settings = SettingsReader(Path("pyproject.toml"), {}).settings
+        settings = SettingsReader.from_file("pyproject.toml", {}).settings
 
         cmake = CMake.default_search(
             minimum_version=Version(settings.cmake.minimum_version)
@@ -118,7 +118,7 @@ def build_extension(self, ext: setuptools.Extension) -> None:
 def cmake_extensions(
     dist: Distribution, attr: Literal["cmake_extensions"], value: list[CMakeExtension]
 ) -> None:
-    settings = SettingsReader(Path("pyproject.toml"), {}).settings
+    settings = SettingsReader.from_file("pyproject.toml", {}).settings
 
     assert attr == "cmake_extensions"
     assert value

tests/test_skbuild_settings.py

@@ -18,7 +18,7 @@ def test_skbuild_settings_default(tmp_path):
 
     config_settings: dict[str, list[str] | str] = {}
 
-    settings_reader = SettingsReader(pyproject_toml, config_settings)
+    settings_reader = SettingsReader.from_file(pyproject_toml, config_settings)
     settings = settings_reader.settings
     assert list(settings_reader.unrecognized_options()) == []
 
@@ -73,7 +73,7 @@ def test_skbuild_settings_envvar(tmp_path, monkeypatch):
 
     config_settings: dict[str, list[str] | str] = {}
 
-    settings_reader = SettingsReader(pyproject_toml, config_settings)
+    settings_reader = SettingsReader.from_file(pyproject_toml, config_settings)
     settings = settings_reader.settings
     assert list(settings_reader.unrecognized_options()) == []
 
@@ -129,7 +129,7 @@ def test_skbuild_settings_config_settings(tmp_path, monkeypatch):
         "build-dir": "a/b/c",
     }
 
-    settings_reader = SettingsReader(pyproject_toml, config_settings)
+    settings_reader = SettingsReader.from_file(pyproject_toml, config_settings)
     settings = settings_reader.settings
     assert list(settings_reader.unrecognized_options()) == []
 
@@ -189,7 +189,7 @@ def test_skbuild_settings_pyproject_toml(tmp_path, monkeypatch):
 
     config_settings: dict[str, list[str] | str] = {}
 
-    settings_reader = SettingsReader(pyproject_toml, config_settings)
+    settings_reader = SettingsReader.from_file(pyproject_toml, config_settings)
     settings = settings_reader.settings
     assert list(settings_reader.unrecognized_options()) == []
 
@@ -231,7 +231,7 @@ def test_skbuild_settings_pyproject_toml_broken(tmp_path, capsys):
 
     config_settings: dict[str, list[str] | str] = {}
 
-    settings_reader = SettingsReader(pyproject_toml, config_settings)
+    settings_reader = SettingsReader.from_file(pyproject_toml, config_settings)
     assert list(settings_reader.unrecognized_options()) == [
         "tool.scikit-build.cmake.minimum-verison",
         "tool.scikit-build.logger",
@@ -263,7 +263,7 @@ def test_skbuild_settings_pyproject_conf_broken(tmp_path, capsys):
         "logger.level": "INFO",
     }
 
-    settings_reader = SettingsReader(pyproject_toml, config_settings)
+    settings_reader = SettingsReader.from_file(pyproject_toml, config_settings)
     assert list(settings_reader.unrecognized_options()) == [
         "cmake.minimum-verison",
         "logger",