Implement the build_dir format variables

Signed-off-by: Cristian Le <[email protected]>

Author: LecrisUT

src/scikit_build_core/build/_file_processor.py

@@ -7,6 +7,8 @@
 
 import pathspec
 
+from scikit_build_core.format import pyproject_format
+
 if TYPE_CHECKING:
     from collections.abc import Generator, Sequence
 
@@ -51,12 +53,7 @@ def each_unignored_file(
         if p != Path(".gitignore")
     }
 
-    exclude_build_dir = build_dir.format(
-        cache_tag="*",
-        wheel_tag="*",
-        build_type="*",
-        state="*",
-    )
+    exclude_build_dir = build_dir.format(**pyproject_format(dummy=True))
 
     exclude_lines = (
         [*EXCLUDE_LINES, exclude_build_dir] if exclude_build_dir else EXCLUDE_LINES

src/scikit_build_core/build/wheel.py

@@ -3,7 +3,6 @@
 import dataclasses
 import os
 import shutil
-import sys
 import sysconfig
 import tempfile
 from collections.abc import Mapping
@@ -20,6 +19,7 @@
 from ..builder.wheel_tag import WheelTag
 from ..cmake import CMake, CMaker
 from ..errors import FailedLiveProcessError
+from ..format import pyproject_format
 from ..settings.skbuild_read_settings import SettingsReader
 from ._editable import editable_redirect, libdir_to_installed, mapping_to_modules
 from ._init import setup_logging
@@ -279,10 +279,11 @@ def _build_wheel_impl_impl(
             build_dir = (
                 Path(
                     settings.build_dir.format(
-                        cache_tag=sys.implementation.cache_tag,
-                        wheel_tag=str(tags),
-                        build_type=settings.cmake.build_type,
-                        state=state,
+                        **pyproject_format(
+                            settings=settings,
+                            tags=tags,
+                            state=state,
+                        )
                     )
                 )
                 if settings.build_dir

src/scikit_build_core/format.py

@@ -2,9 +2,13 @@
 
 from __future__ import annotations
 
+import sys
 from typing import TYPE_CHECKING, TypedDict
 
 if TYPE_CHECKING:
+    from typing import Literal
+
+    from scikit_build_core.builder.wheel_tag import WheelTag
     from scikit_build_core.settings.skbuild_model import ScikitBuildSettings
 
 __all__ = [
@@ -24,14 +28,36 @@ class PyprojectFormatter(TypedDict, total=False):
     in the pyproject.toml config file.
     """
 
+    cache_tag: str
+    wheel_tag: str
+    build_type: str
+    state: str
+
 
 def pyproject_format(
     *,
-    settings: ScikitBuildSettings | None = None,  # noqa: ARG001
+    settings: ScikitBuildSettings | None = None,
+    state: (
+        Literal["sdist", "wheel", "editable", "metadata_wheel", "metadata_editable"]
+        | None
+    ) = None,
+    tags: WheelTag | None = None,
     dummy: bool = False,
 ) -> PyprojectFormatter | dict[str, str]:
     """Generate :py:class:`PyprojectFormatter` dictionary to use in f-string format."""
     if dummy:
         # Return a dict with all the known keys but with values replaced with dummy values
         return {key: "*" for key in PyprojectFormatter.__annotations__}
-    return PyprojectFormatter()
+    # First set all known values
+    res = PyprojectFormatter(
+        cache_tag=sys.implementation.cache_tag,
+    )
+    # Then compute all optional keys depending on the function input
+    if settings is not None:
+        res["build_type"] = settings.cmake.build_type
+    if tags is not None:
+        res["wheel_tag"] = str(tags)
+    if state is not None:
+        res["state"] = state
+    # Construct the final dict including the always known keys
+    return res

src/scikit_build_core/hatch/plugin.py

@@ -6,7 +6,6 @@
 import importlib.metadata
 import os
 import shutil
-import sys
 import sysconfig
 import tempfile
 import typing
@@ -24,6 +23,7 @@
 from ..builder.get_requires import GetRequires
 from ..builder.wheel_tag import WheelTag
 from ..cmake import CMake, CMaker
+from ..format import pyproject_format
 from ..settings.skbuild_read_settings import SettingsReader
 
 __all__ = ["ScikitBuildHook"]
@@ -162,10 +162,11 @@ def _initialize(self, *, build_data: dict[str, Any]) -> None:
         build_dir = (
             Path(
                 settings.build_dir.format(
-                    cache_tag=sys.implementation.cache_tag,
-                    wheel_tag=str(tags),
-                    build_type=settings.cmake.build_type,
-                    state=state,
+                    **pyproject_format(
+                        settings=settings,
+                        tags=tags,
+                        state=state,
+                    )
                 )
             )
             if settings.build_dir