metadata.py

from __future__ import annotations

import copy
import dataclasses
import sys
from typing import TYPE_CHECKING, Any

from packaging.version import Version

from .._vendor.pyproject_metadata import (
    StandardMetadata,
    errors,
    extras_build_system,
    extras_top_level,
)
from ..settings._load_provider import load_dynamic_metadata

if TYPE_CHECKING:
    from collections.abc import Mapping

    from ..settings.skbuild_model import ScikitBuildSettings

__all__ = ["get_standard_metadata"]


def __dir__() -> list[str]:
    return __all__


# Use exceptiongroup backport
if sys.version_info < (3, 11):
    from exceptiongroup import ExceptionGroup

    errors.ExceptionGroup = ExceptionGroup  # type: ignore[misc, assignment]


# If pyproject-metadata eventually supports updates, this can be simplified
def get_standard_metadata(
    pyproject_dict: Mapping[str, Any],
    settings: ScikitBuildSettings,
) -> StandardMetadata:
    new_pyproject_dict = copy.deepcopy(pyproject_dict)

    # Handle any dynamic metadata
    for field, provider, config in load_dynamic_metadata(settings.metadata):
        if provider is None:
            msg = f"{field} is missing provider"
            raise KeyError(msg)
        if field not in pyproject_dict.get("project", {}).get("dynamic", []):
            msg = f"{field} is not in project.dynamic"
            raise KeyError(msg)
        new_pyproject_dict["project"][field] = provider.dynamic_metadata(field, config)
        new_pyproject_dict["project"]["dynamic"].remove(field)

    extra_validate = (
        settings.minimum_version is None or settings.minimum_version >= Version("0.10")
    )
    try:
        metadata = StandardMetadata.from_pyproject(
            new_pyproject_dict, all_errors=True, allow_extra_keys=not extra_validate
        )
    except ExceptionGroup as e:
        if extra_validate:
            extra_keys_top = extras_top_level(new_pyproject_dict)
            if extra_keys_top:
                msg = f"Unknown keys in top-level of pyproject.toml: {', '.join(extra_keys_top)}"
                e = ExceptionGroup(
                    e.message, (*e.exceptions, errors.ConfigurationError(msg))
                )
            extra_keys_build = extras_build_system(new_pyproject_dict)
            if extra_keys_build:
                msg = f"Unknown keys in build-system of pyproject.toml: {', '.join(extra_keys_build)}"
                e = ExceptionGroup(
                    e.message, (*e.exceptions, errors.ConfigurationError(msg))
                )
        raise e from None

    # For scikit-build-core < 0.5, we keep the normalized name for back-compat
    if settings.minimum_version is not None and settings.minimum_version < Version(
        "0.5"
    ):
        metadata = dataclasses.replace(metadata, name=metadata.canonical_name)

    # The description field is required to be one line. Instead of merging it
    # or cutting off subsequent lines (setuptools), we throw a nice error.
    # But we didn't validate before 0.9.
    if (
        settings.minimum_version is None or settings.minimum_version >= Version("0.9")
    ) and "\n" in (metadata.description or ""):
        msg = "Multiple lines in project.description are not supported; this is supposed to be a one line summary"
        raise ValueError(msg)

    return metadata