fix: change metadata entrypoints to take pyproject contents not path

Also changes the name of the entrypoint group to scikit_build.metadata.

This commit also changes the SettingsReader to load from a pyproject dict
rather than loading from file, this saves parsing the file multiple times
to access the metadata as well. A new class method `from_file()` provides the
previous functionality of loading from a path.

Author: Ben Rowland

pyproject.toml

@@ -91,7 +91,7 @@ Examples = "https://github.com/scikit-build/scikit-build-core/tree/main/tests/pa
 cmake_extensions = "scikit_build_core.setuptools.extension:cmake_extensions"
 cmake_source_dir = "scikit_build_core.setuptools.extension:cmake_source_dir"
 
-[project.entry-points.skbuild]
+[project.entry-points."scikit_build.metadata"]
 setuptools_scm = "scikit_build_core.settings.metadata:setuptools_scm_version"
 fancy_pypi_readme = "scikit_build_core.settings.metadata:fancy_pypi_readme"
 

src/scikit_build_core/build/sdist.py

@@ -8,9 +8,8 @@
 import tarfile
 from pathlib import Path
 
-from pyproject_metadata import StandardMetadata
-
 from .._compat import tomllib
+from ..settings.metadata import get_standard_metadata
 from ..settings.skbuild_read_settings import SettingsReader
 from ._file_processor import each_unignored_file
 from ._init import setup_logging
@@ -69,23 +68,23 @@ 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 {})
+    with Path("pyproject.toml").open("rb") as f:
+        pyproject = tomllib.load(f)
+
+    settings_reader = SettingsReader(pyproject, config_settings or {})
     settings = settings_reader.settings
     setup_logging(settings.logging.level)
 
     settings_reader.validate_may_exit()
 
     sdist_dir = Path(sdist_directory)
 
-    with Path("pyproject.toml").open("rb") as f:
-        pyproject = tomllib.load(f)
-
     reproducible = settings.sdist.reproducible
     timestamp = get_reproducible_epoch() if reproducible else None
 
+    metadata = get_standard_metadata(pyproject, settings)
     # Using deepcopy here because of a bug in pyproject-metadata
     # https://github.com/FFY00/python-pyproject-metadata/pull/49
-    metadata = StandardMetadata.from_pyproject(pyproject)
     pkg_info = bytes(copy.deepcopy(metadata).as_rfc822())
 
     srcdirname = f"{metadata.name}-{metadata.version}"

src/scikit_build_core/build/wheel.py

@@ -9,6 +9,7 @@
 from packaging.version import Version
 
 from .. import __version__
+from .._compat import tomllib
 from .._logging import logger, rich_print
 from ..builder.builder import Builder
 from ..builder.wheel_tag import WheelTag
@@ -70,14 +71,17 @@ def _build_wheel_impl(
     """
     Build a wheel or just prepare metadata (if wheel dir is None).
     """
+    pyproject_path = Path("pyproject.toml")
+    with pyproject_path.open("rb") as ft:
+        pyproject = tomllib.load(ft)
 
-    settings_reader = SettingsReader(Path("pyproject.toml"), config_settings or {})
+    settings_reader = SettingsReader(pyproject, config_settings or {})
     settings = settings_reader.settings
     setup_logging(settings.logging.level)
 
     settings_reader.validate_may_exit()
 
-    metadata = get_standard_metadata(Path("pyproject.toml"), settings)
+    metadata = get_standard_metadata(pyproject, settings)
 
     if metadata.version is None:
         msg = "project.version is not statically specified, must be present currently"

src/scikit_build_core/builder/get_requires.py

@@ -42,7 +42,9 @@ 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(
+        Path("pyproject.toml"), config_settings or {}
+    ).settings
 
     packages = []
     cmake_min = Version(settings.cmake.minimum_version)

src/scikit_build_core/settings/metadata.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
 
-import pathlib
 import warnings
+from pathlib import Path
+from typing import Any
 
 from pyproject_metadata import StandardMetadata
 
-from .._compat import importlib, tomllib
+from .._compat import importlib
 from ..settings.skbuild_model import ScikitBuildSettings
 
 __all__ = ["setuptools_scm_version", "fancy_pypi_readme", "get_standard_metadata"]
@@ -15,24 +16,23 @@ def __dir__() -> list[str]:
     return __all__
 
 
-def setuptools_scm_version(pyproject_path: pathlib.Path) -> str:
+def setuptools_scm_version(_pyproject_dict: dict[str, Any]) -> str:
+    # this is a placeholder version of this function, waiting for the release
+    # of vcs-versioning and an improved public interface
     from setuptools_scm import Configuration, _get_version
 
-    config = Configuration.from_file(str(pyproject_path))
+    config = Configuration.from_file(str(Path("pyproject.toml")))
     version: str = _get_version(config)
 
     return version
 
 
-def fancy_pypi_readme(pyproject_path: pathlib.Path) -> str | dict[str, str | None]:
+def fancy_pypi_readme(pyproject_dict: dict[str, Any]) -> str | dict[str, str | None]:
     from hatch_fancy_pypi_readme._builder import build_text
     from hatch_fancy_pypi_readme._config import load_and_validate_config
 
-    with pyproject_path.open("rb") as ft:
-        pyproject = tomllib.load(ft)
-
     config = load_and_validate_config(
-        pyproject["tool"]["hatch"]["metadata"]["hooks"]["fancy-pypi-readme"]
+        pyproject_dict["tool"]["hatch"]["metadata"]["hooks"]["fancy-pypi-readme"]
     )
 
     return {
@@ -42,16 +42,14 @@ def fancy_pypi_readme(pyproject_path: pathlib.Path) -> str | dict[str, str | Non
 
 
 def get_standard_metadata(
-    pyproject_path: pathlib.Path, settings: ScikitBuildSettings
+    pyproject_dict: dict[str, Any], settings: ScikitBuildSettings
 ) -> StandardMetadata:
-    with pyproject_path.open("rb") as ft:
-        pyproject = tomllib.load(ft)
-    metadata = StandardMetadata.from_pyproject(pyproject)
+    metadata = StandardMetadata.from_pyproject(pyproject_dict)
 
     # handle any dynamic metadata
     # start by collecting all the scikit-build entrypoints
     eps: importlib.metadata.EntryPoints = importlib.metadata.entry_points(
-        group="skbuild"
+        group="scikit_build.metadata"
     )
     for field, ep_name in settings.metadata.items():
         if field not in metadata.dynamic:
@@ -67,9 +65,9 @@ def get_standard_metadata(
             # would be better to update the metadata directly but this is
             # currently not supported by pyproject_metadata
             # metadata.__setattr__(field, ep.load()(pyproject_path)
-            pyproject["project"][field] = ep.load()(pyproject_path)
-            pyproject["project"]["dynamic"].remove(field)
+            pyproject_dict["project"][field] = ep.load()(pyproject_dict)
+            pyproject_dict["project"]["dynamic"].remove(field)
 
     # if pyproject-metadata supports updates, we won't need this line anymore
-    metadata = StandardMetadata.from_pyproject(pyproject)
+    metadata = StandardMetadata.from_pyproject(pyproject_dict)
     return metadata

src/scikit_build_core/settings/skbuild_read_settings.py

@@ -4,6 +4,7 @@
 import sys
 from collections.abc import Generator, Mapping
 from pathlib import Path
+from typing import Any
 
 from packaging.version import Version
 
@@ -24,13 +25,10 @@ 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 +83,15 @@ 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: Path,
+        config_settings: Mapping[str, str | list[str]],
+        verify_conf: bool = True,
+    ) -> SettingsReader:
+        with pyproject_path.open("rb") as f:
+            pyproject = tomllib.load(f)
+
+        return cls(pyproject, config_settings, 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(Path("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(Path("pyproject.toml"), {}).settings
 
     assert attr == "cmake_extensions"
     assert value

tests/packages/dynamic_metadata/fancy_project.toml renamed to tests/packages/dynamic_metadata/plugin_project.toml

@@ -8,7 +8,7 @@
 import pyproject_metadata
 import pytest
 
-from scikit_build_core._compat import importlib
+from scikit_build_core._compat import importlib, tomllib
 from scikit_build_core.build import build_wheel
 from scikit_build_core.settings.metadata import get_standard_metadata
 from scikit_build_core.settings.skbuild_read_settings import SettingsReader
@@ -56,22 +56,25 @@ def mock_ep(**_):
 def test_dynamic_metadata(monkeypatch):
     monkeypatch.chdir(DYNAMIC)
 
-    settings_reader = SettingsReader(Path("pyproject.toml"), {})
+    with Path("pyproject.toml").open("rb") as ft:
+        pyproject = tomllib.load(ft)
+    settings_reader = SettingsReader(pyproject, {})
     settings = settings_reader.settings
 
     settings_reader.validate_may_exit()
 
-    metadata = get_standard_metadata(Path("pyproject.toml"), settings)
+    metadata = get_standard_metadata(pyproject, settings)
 
     assert str(metadata.version) == "0.0.2"
     assert metadata.license == pyproject_metadata.License("MIT License", None)
     assert metadata.readme == pyproject_metadata.Readme("Some text", None, "text/x-rst")
 
 
-def test_fancy_metadata(tmp_path, monkeypatch):
+def test_plugin_metadata(tmp_path, monkeypatch):
     build_dir = tmp_path / "build"
+    build_dir.mkdir()
 
-    shutil.copytree(DYNAMIC, build_dir)
+    shutil.copy(DYNAMIC / "plugin_project.toml", build_dir / "pyproject.toml")
     monkeypatch.chdir(build_dir)
 
     repo = git.repo.base.Repo.init(build_dir, initial_branch="main")
@@ -81,12 +84,14 @@ def test_fancy_metadata(tmp_path, monkeypatch):
     repo.index.commit("first commit")
     repo.create_tag("v0.1.0", message="initial commit")
 
-    settings_reader = SettingsReader(Path("fancy_project.toml"), {})
+    with Path("pyproject.toml").open("rb") as ft:
+        pyproject = tomllib.load(ft)
+    settings_reader = SettingsReader(pyproject, {})
     settings = settings_reader.settings
 
     settings_reader.validate_may_exit()
 
-    metadata = get_standard_metadata(Path("fancy_project.toml"), settings)
+    metadata = get_standard_metadata(pyproject, settings)
 
     assert str(metadata.version) == "0.1.0"
     assert metadata.readme == pyproject_metadata.Readme(
@@ -96,24 +101,29 @@ def test_fancy_metadata(tmp_path, monkeypatch):
 
 def test_faulty_metadata(monkeypatch):
     monkeypatch.chdir(DYNAMIC)
-    settings_reader = SettingsReader(Path("faulty_project.toml"), {})
+
+    with Path("faulty_project.toml").open("rb") as ft:
+        pyproject = tomllib.load(ft)
+    settings_reader = SettingsReader(pyproject, {})
     settings = settings_reader.settings
 
     settings_reader.validate_may_exit()
 
     with pytest.raises(KeyError):
-        get_standard_metadata(Path("faulty_project.toml"), settings)
+        get_standard_metadata(pyproject, settings)
 
 
 def test_warn_metadata(monkeypatch):
     monkeypatch.chdir(DYNAMIC)
-    settings_reader = SettingsReader(Path("warn_project.toml"), {})
+    with Path("warn_project.toml").open("rb") as ft:
+        pyproject = tomllib.load(ft)
+    settings_reader = SettingsReader(pyproject, {})
     settings = settings_reader.settings
 
     settings_reader.validate_may_exit()
 
     with pytest.warns():
-        get_standard_metadata(Path("warn_project.toml"), settings)
+        get_standard_metadata(pyproject, settings)
 
 
 @pytest.mark.compile()

tests/test_dynamic_metadata.py

@@ -15,7 +15,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()) == []
 
@@ -70,7 +70,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()) == []
 
@@ -126,7 +126,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()) == []
 
@@ -186,7 +186,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()) == []
 
@@ -228,7 +228,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",
@@ -260,7 +260,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",