fix: better JSON schema generator, use Version/Path/Union (#455)

In support of #1480.

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

Author: henryiii

.github/workflows/ci.yml

@@ -21,6 +21,8 @@ jobs:
     timeout-minutes: 5
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - uses: actions/setup-python@v4
         with:
           python-version: "3.11"
@@ -31,6 +33,10 @@ jobs:
         run: |
           echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json"
           pipx run nox -s pylint
+      - name: Run nox generator
+        run: |
+          pipx run nox -s generate_schema -s readme
+          git diff --exit-code
 
   checks:
     name:

README.md

@@ -146,7 +146,7 @@ cmake.build-type = "Release"
 
 # The source directory to use when building the project. Currently only affects
 # the native builder (not the setuptools plugin).
-cmake.source-dir = ""
+cmake.source-dir = "."
 
 # The build targets to use when building the project. Empty builds the default
 # target.
@@ -195,11 +195,9 @@ wheel.py-api = ""
 # (before 21.0.1) find the correct wheel.
 wheel.expand-macos-universal-tags = false
 
-# The install directory for the wheel. This is relative to the platlib root. You
-# might set this to the package name. The original dir is still at
-# SKBUILD_PLATLIB_DIR (also SKBUILD_DATA_DIR, etc. are available). EXPERIMENTAL:
-# An absolute path will be one level higher than the platlib root, giving access
-# to "/platlib", "/data", "/headers", and "/scripts".
+# The install directory for the wheel. This is relative to the platlib root.
+# EXPERIMENTAL: An absolute path will be one level higher than the platlib root,
+# giving access to "/platlib", "/data", "/headers", and "/scripts".
 wheel.install-dir = ""
 
 # A list of license files to include in the wheel. Supports glob patterns.

noxfile.py

@@ -62,6 +62,9 @@ def _run_tests(
 
 @nox.session(reuse_venv=True)
 def generate_schema(session: nox.Session) -> None:
+    """
+    (Re)generate src/scikit_build_core/resources/scikit-build.schema.json from model.
+    """
     session.install("-e.")
     schema = session.run(
         "python", "-m", "scikit_build_core.settings.skbuild_schema", silent=True

pyproject.toml

@@ -151,10 +151,12 @@ show_error_codes = true
 enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
 strict = true
 disallow_untyped_defs = false
+disallow_incomplete_defs = false
 
 [[tool.mypy.overrides]]
 module = ["scikit_build_core.*"]
 disallow_untyped_defs = true
+disallow_incomplete_defs = true
 
 [[tool.mypy.overrides]]
 module = ["numpy", "pathspec", "setuptools_scm", "hatch_fancy_pypi_readme"]

src/scikit_build_core/build/sdist.py

@@ -98,9 +98,9 @@ def build_sdist(
     pkg_info = bytes(copy.deepcopy(metadata).as_rfc822())
 
     # Only normalize SDist name if 0.5+ is requested for backwards compat
-    should_normalize_name = settings.minimum_version is None or Version(
-        settings.minimum_version
-    ) >= Version("0.5")
+    should_normalize_name = (
+        settings.minimum_version is None or settings.minimum_version >= Version("0.5")
+    )
 
     sdist_name = (
         canonicalize_name(metadata.name).replace("-", "_")

src/scikit_build_core/build/wheel.py

@@ -9,8 +9,6 @@
 from collections.abc import Sequence
 from pathlib import Path
 
-from packaging.version import Version
-
 from .. import __version__
 from .._compat import tomllib
 from .._logging import logger, rich_print
@@ -100,9 +98,7 @@ def _build_wheel_impl(
     if wheel_directory is None:
         action = f"metadata_{action}"
 
-    cmake = CMake.default_search(
-        minimum_version=Version(settings.cmake.minimum_version)
-    )
+    cmake = CMake.default_search(minimum_version=settings.cmake.minimum_version)
 
     rich_print(
         f"[green]***[/green] [bold][green]scikit-build-core {__version__}[/green]",
@@ -170,7 +166,7 @@ def _build_wheel_impl(
 
         config = CMaker(
             cmake,
-            source_dir=Path(settings.cmake.source_dir or "."),
+            source_dir=settings.cmake.source_dir,
             build_dir=build_dir,
             build_type=settings.cmake.build_type,
         )

src/scikit_build_core/builder/builder.py

@@ -82,14 +82,17 @@ def get_cmake_args(self) -> list[str]:
     def configure(
         self,
         *,
-        defines: Mapping[str, str],
+        defines: Mapping[str, str | bool],
         cache_entries: Mapping[str, str | Path] | None = None,
         name: str | None = None,
         version: Version | None = None,
         limited_abi: bool | None = None,
         configure_args: Iterable[str] = (),
     ) -> None:
-        cmake_defines = dict(defines)
+        cmake_defines = {
+            k: ("TRUE" if v else "FALSE") if isinstance(v, bool) else v
+            for k, v in defines.items()
+        }
 
         # Add any extra CMake modules
         eps = metadata.entry_points(group="cmake.module")
@@ -108,8 +111,7 @@ def configure(
             logger.debug("Extra SITE_PACKAGES: {}", site_packages)
 
         # Add the FindPython backport if needed
-        fp_backport = self.settings.backport.find_python
-        if fp_backport and self.config.cmake.version < Version(fp_backport):
+        if self.config.cmake.version < self.settings.backport.find_python:
             fp_dir = Path(find_python.__file__).parent.resolve()
             self.config.module_dirs.append(fp_dir)
             logger.debug("FindPython backport activated at {}", fp_dir)
@@ -180,7 +182,12 @@ def configure(
                 cmake_defines["CMAKE_OSX_ARCHITECTURES"] = ";".join(archs)
 
         # Add the pre-defined or passed CMake defines
-        cmake_defines.update(self.settings.cmake.define)
+        cmake_defines.update(
+            {
+                k: ("TRUE" if v else "FALSE") if isinstance(v, bool) else v
+                for k, v in self.settings.cmake.define.items()
+            }
+        )
 
         self.config.configure(
             defines=cmake_defines,

src/scikit_build_core/builder/generator.py

@@ -6,8 +6,6 @@
 import sysconfig
 from collections.abc import Mapping, MutableMapping
 
-from packaging.version import Version
-
 from .._logging import logger
 from ..cmake import CMake
 from ..errors import NinjaNotFoundError
@@ -87,8 +85,9 @@ def set_environment_for_gen(
         default = "Ninja"
 
     if env.get("CMAKE_GENERATOR", default or "Ninja") == "Ninja":
-        min_ninja = Version(ninja_settings.minimum_version)
-        ninja = best_program(get_ninja_programs(), minimum_version=min_ninja)
+        ninja = best_program(
+            get_ninja_programs(), minimum_version=ninja_settings.minimum_version
+        )
 
         if ninja is not None:
             env.setdefault("CMAKE_GENERATOR", "Ninja")

src/scikit_build_core/builder/get_requires.py

@@ -7,7 +7,6 @@
 from collections.abc import Generator, Mapping
 
 from packaging.tags import sys_tags
-from packaging.version import Version
 
 from .._compat import tomllib
 from .._compat.typing import Literal
@@ -50,7 +49,7 @@ def __post_init__(self) -> None:
         ).settings
 
     def cmake(self) -> Generator[str, None, None]:
-        cmake_min = Version(self._settings.cmake.minimum_version)
+        cmake_min = self._settings.cmake.minimum_version
         cmake = best_program(
             get_cmake_programs(module=False), minimum_version=cmake_min
         )
@@ -74,7 +73,7 @@ def ninja(self) -> Generator[str, None, None]:
         if os.environ.get("CMAKE_MAKE_PROGRAM", ""):
             return
 
-        ninja_min = Version(self._settings.ninja.minimum_version)
+        ninja_min = self._settings.ninja.minimum_version
         ninja = best_program(
             get_ninja_programs(module=False), minimum_version=ninja_min
         )

src/scikit_build_core/resources/scikit-build.schema.json

@@ -25,7 +25,14 @@
           "type": "object",
           "patternProperties": {
             ".+": {
-              "type": "string"
+              "oneOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "boolean"
+                }
+              ]
             }
           },
           "description": "A table of defines to pass to CMake when configuring the project. Additive."
@@ -42,7 +49,7 @@
         },
         "source-dir": {
           "type": "string",
-          "default": "",
+          "default": ".",
           "description": "The source directory to use when building the project. Currently only affects the native builder (not the setuptools plugin)."
         },
         "targets": {
@@ -103,11 +110,6 @@
           "type": "boolean",
           "default": true,
           "description": "If set to True, try to build a reproducible distribution (Unix and Python 3.9+ recommended).  ``SOURCE_DATE_EPOCH`` will be used for timestamps, or a fixed value if not set."
-        },
-        "cmake": {
-          "type": "boolean",
-          "default": false,
-          "description": "If set to True, CMake will be run before building the SDist."
         }
       }
     },