Move the special default handling to the dataclass definition

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

Author: LecrisUT

src/scikit_build_core/settings/documentation.py

@@ -10,6 +10,7 @@
 from packaging.specifiers import SpecifierSet
 from packaging.version import Version
 
+from .. import __version__
 from .._compat.typing import get_args, get_origin
 
 if TYPE_CHECKING:
@@ -26,6 +27,9 @@ def __dir__() -> list[str]:
     return __all__
 
 
+version_display = ".".join(__version__.split(".")[:2])
+
+
 def _get_value(value: ast.expr) -> str:
     assert isinstance(value, ast.Constant)
     assert isinstance(value.value, str)
@@ -93,7 +97,12 @@ def mk_docs(dc: type[object], prefix: str = "") -> Generator[DCDoc, None, None]:
                 yield from mk_docs(field_type, prefix=f"{prefix}{field.name}[].")
                 continue
 
-        if field.default is not dataclasses.MISSING and field.default is not None:
+        if default_before_format := get_metadata_field(field, "display_default", None):
+            assert isinstance(default_before_format, str)
+            default = default_before_format.format(
+                version=version_display,
+            )
+        elif field.default is not dataclasses.MISSING and field.default is not None:
             default = repr(
                 str(field.default)
                 if isinstance(field.default, (Path, Version, SpecifierSet))

src/scikit_build_core/settings/skbuild_docs.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from .. import __version__
 from .documentation import mk_docs
 from .skbuild_model import ScikitBuildSettings
 
@@ -11,22 +10,13 @@ def __dir__() -> list[str]:
     return __all__
 
 
-version = ".".join(__version__.split(".")[:2])
-
-
 def mk_skbuild_docs() -> str:
     """
     Makes documentation for the skbuild model.
     """
-    items = [x for x in mk_docs(ScikitBuildSettings) if not x.deprecated]
-    for item in items:
-        if item.name == "minimum-version":
-            item.default = f'"{version}"  # current version'
-        if item.name == "install.strip":
-            item.default = "true"
-        if item.name == "wheel.packages":
-            item.default = '["src/<package>", "python/<package>", "<package>"]'
-    return "\n".join(str(item) for item in items)
+    return "\n".join(
+        str(item) for item in mk_docs(ScikitBuildSettings) if not item.deprecated
+    )
 
 
 if __name__ == "__main__":

src/scikit_build_core/settings/skbuild_model.py

@@ -36,6 +36,7 @@ class SettingsFieldMetadata(Mapping[str, Any]):
     Convenience dataclass to store field metadata for documentation.
     """
 
+    display_default: Optional[str] = None
     deprecated: bool = False
 
     def __getitem__(self, key: str) -> Any:
@@ -198,7 +199,12 @@ class SDistSettings:
 
 @dataclasses.dataclass
 class WheelSettings:
-    packages: Optional[Union[List[str], Dict[str, str]]] = None
+    packages: Optional[Union[List[str], Dict[str, str]]] = dataclasses.field(
+        default=None,
+        metadata=SettingsFieldMetadata(
+            display_default='["src/<package>", "python/<package>", "<package>"]'
+        ),
+    )
     """
     A list of packages to auto-copy into the wheel. If this is not set, it will
     default to the first of ``src/<package>``, ``python/<package>``, or
@@ -324,7 +330,9 @@ class InstallSettings:
     The components to install. If empty, all default components are installed.
     """
 
-    strip: Optional[bool] = None
+    strip: Optional[bool] = dataclasses.field(
+        default=None, metadata=SettingsFieldMetadata(display_default="true")
+    )
     """
     Whether to strip the binaries. True for release builds on scikit-build-core
     0.5+ (0.5-0.10.5 also incorrectly set this for debug builds).
@@ -406,7 +414,12 @@ class ScikitBuildSettings:
     Enable early previews of features not finalized yet.
     """
 
-    minimum_version: Optional[Version] = None
+    minimum_version: Optional[Version] = dataclasses.field(
+        default=None,
+        metadata=SettingsFieldMetadata(
+            display_default='"{version}"  # current version'
+        ),
+    )
     """
     If set, this will provide a method for backward compatibility.
     """