fix: allow more fields in regex

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

Author: henryiii

src/scikit_build_core/_compat/graphlib.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+import sys
+
+if sys.version_info < (3, 9):
+    from graphlib_backport import TopologicalSorter
+else:
+    from graphlib import TopologicalSorter
+
+__all__ = ["TopologicalSorter"]
+
+
+def __dir__() -> list[str]:
+    return __all__

src/scikit_build_core/metadata/__init__.py

@@ -1,6 +1,12 @@
 from __future__ import annotations
 
-__all__: list[str] = ["_DICT_LIST_FIELDS", "_LIST_STR_FIELDS", "_STR_FIELDS"]
+import typing
+
+if typing.TYPE_CHECKING:
+    from collections.abc import Callable
+
+
+__all__: list[str] = ["_process_dynamic_metadata"]
 
 
 # Name is not dynamically settable, so not in this list
@@ -23,9 +29,38 @@
     ]
 )
 
-_DICT_LIST_FIELDS = frozenset(
-    [
-        "urls",
-        "optional-dependencies",
-    ]
-)
+T = typing.TypeVar("T", bound="str | list[str] | dict[str, str] | dict[str, list[str]]")
+
+
+def _process_dynamic_metadata(field: str, action: Callable[[str], str], result: T) -> T:
+    """
+    Helper function for processing the an action on the various possible metadata fields.
+    """
+
+    if field in _STR_FIELDS:
+        if not isinstance(result, str):
+            msg = f"Field {field!r} must be a string"
+            raise RuntimeError(msg)
+        return action(result)  # type: ignore[return-value]
+    if field in _LIST_STR_FIELDS:
+        if not (isinstance(result, list) and all(isinstance(r, str) for r in result)):
+            msg = f"Field {field!r} must be a list of strings"
+            raise RuntimeError(msg)
+        return [action(r) for r in result]  # type: ignore[return-value]
+    if field == "urls":
+        if not isinstance(result, dict) or not all(
+            isinstance(v, str) for v in result.values()
+        ):
+            msg = "Field 'urls' must be a dictionary of strings"
+            raise RuntimeError(msg)
+        return {k: action(v) for k, v in result.items()}  # type: ignore[return-value]
+    if field == "optional-dependencies":
+        if not isinstance(result, dict) or not all(
+            isinstance(v, list) for v in result.values()
+        ):
+            msg = "Field 'optional-dependencies' must be a dictionary of lists"
+            raise RuntimeError(msg)
+        return {k: [action(r) for r in v] for k, v in result.items()}  # type: ignore[return-value]
+
+    msg = f"Unsupported field {field!r} for action"
+    raise RuntimeError(msg)

src/scikit_build_core/metadata/regex.py

@@ -1,10 +1,11 @@
 from __future__ import annotations
 
+import functools
 import re
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
-from . import _STR_FIELDS
+from . import _process_dynamic_metadata
 
 if TYPE_CHECKING:
     from collections.abc import Mapping
@@ -19,14 +20,18 @@ def __dir__() -> list[str]:
 KEYS = {"input", "regex", "result", "remove"}
 
 
+def _process(match: re.Match[str], remove: str, result: str) -> str:
+    retval = result.format(*match.groups(), **match.groupdict())
+    if remove:
+        retval = re.sub(remove, "", retval)
+    return retval
+
+
 def dynamic_metadata(
     field: str,
     settings: Mapping[str, Any],
 ) -> str:
     # Input validation
-    if field not in _STR_FIELDS:
-        msg = "Only string fields supported by this plugin"
-        raise RuntimeError(msg)
     if settings.keys() > KEYS:
         msg = f"Only {KEYS} settings allowed by this plugin"
         raise RuntimeError(msg)
@@ -57,7 +62,6 @@ def dynamic_metadata(
         msg = f"Couldn't find {regex!r} in {input_filename}"
         raise RuntimeError(msg)
 
-    retval = result.format(*match.groups(), **match.groupdict())
-    if remove:
-        retval = re.sub(remove, "", retval)
-    return retval
+    return _process_dynamic_metadata(
+        field, functools.partial(_process, match, remove), result
+    )

src/scikit_build_core/metadata/template.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+from . import _process_dynamic_metadata
+
+__all__ = ["dynamic_metadata", "dynamic_metadata_needs"]
+
+
+def __dir__() -> list[str]:
+    return __all__
+
+
+KEYS = {"needs", "result"}
+
+
+def dynamic_metadata(
+    field: str,
+    settings: Mapping[str, str | list[str] | dict[str, str] | dict[str, list[str]]],
+    metadata: Mapping[str, Any],
+) -> str | list[str] | dict[str, str] | dict[str, list[str]]:
+    if settings.keys() > KEYS:
+        msg = f"Only {KEYS} settings allowed by this plugin"
+        raise RuntimeError(msg)
+
+    if "result" not in settings:
+        msg = "Must contain the 'result' setting with a template substitution"
+        raise RuntimeError(msg)
+
+    result = settings["result"]
+
+    return _process_dynamic_metadata(
+        field,
+        lambda r: r.format(**metadata),
+        result,
+    )
+
+
+def dynamic_metadata_needs(
+    field: str,  # noqa: ARG001
+    settings: Mapping[str, Any],
+) -> list[str]:
+    return settings.get("needs", [])

tests/conftest.py

@@ -60,6 +60,9 @@ def pep518_wheelhouse(tmp_path_factory: pytest.TempPathFactory) -> Path:
     if importlib.util.find_spec("ninja") is not None:
         packages.append("ninja")
 
+    if sys.version_info < (3, 9):
+        packages.append("graphlib_backport")
+
     subprocess.run(
         [
             sys.executable,

tests/packages/dynamic_metadata/plugin_project.toml

@@ -12,7 +12,7 @@ readme.provider = "scikit_build_core.metadata.fancy_pypi_readme"
 
 [tool.scikit-build.metadata.optional-dependencies]
 provider = "scikit_build_core.metadata.template"
-needs = ["version", "name"]
+needs = ["version"]
 result = {"dev" = ["{name}=={version}"]}
 
 [tool.setuptools_scm]

tests/test_dynamic_metadata.py

@@ -277,8 +277,6 @@ def test_regex(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
 def test_regex_errors() -> None:
     with pytest.raises(RuntimeError):
         regex.dynamic_metadata("version", {})
-    with pytest.raises(RuntimeError, match="Only string fields supported"):
-        regex.dynamic_metadata("author", {"input": "x", "regex": "x"})
 
 
 def test_multipart_regex(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None: