Merge pull request #73 from python-project-templates/tkp/cli

Add support for hatch-build

Author: timkpaine

README.md

@@ -83,6 +83,20 @@ cmake_env_args = {} # env-specific cmake args to pass
 include_flags = {} # include flags to pass -D
 ```
 
+### CLI
+
+`hatch-cpp` is integrated with [`hatch-build`](https://github.com/python-project-templates/hatch-build) to allow easy configuration of options via command line:
+
+```bash
+hatch-build \
+    -- \
+    --verbose \
+    --platform linux \
+    --vcpkg.vcpkg a/path/to/vcpkg.json \
+    --libraries.0.binding pybind11 \
+    --libraries.0.include-dirs cpp,another-dir
+```
+
 ### Environment Variables
 
 `hatch-cpp` will respect standard environment variables for compiler control.

hatch_cpp/plugin.py

@@ -7,6 +7,7 @@
 from sys import platform as sys_platform, version_info
 from typing import Any
 
+from hatch_build import parse_extra_args_model
 from hatchling.builders.hooks.plugin.interface import BuildHookInterface
 
 from .config import HatchCppBuildConfig, HatchCppBuildPlan
@@ -52,6 +53,9 @@ def initialize(self, version: str, build_data: dict[str, Any]) -> None:
         # Instantiate builder
         build_plan = build_plan_class(**config.model_dump())
 
+        # Parse override args
+        parse_extra_args_model(build_plan)
+
         # Generate commands
         build_plan.generate()
 

hatch_cpp/tests/test_hatch_build.py

@@ -0,0 +1,46 @@
+from os import listdir
+from pathlib import Path
+from shutil import rmtree
+from subprocess import check_call
+from sys import modules, path, platform
+
+
+class TestHatchBuild:
+    def test_hatch_build(self):
+        project = "test_project_hatch_build"
+
+        rmtree(f"hatch_cpp/tests/{project}/project/extension.so", ignore_errors=True)
+        rmtree(f"hatch_cpp/tests/{project}/project/extension.pyd", ignore_errors=True)
+        modules.pop("project", None)
+        modules.pop("project.extension", None)
+
+        # compile
+        check_call(
+            [
+                "hatch-build",
+                "--hooks-only",
+                "--",
+                "--libraries.0.name=project/extension",
+                "--libraries.0.sources=cpp/project/basic.cpp",
+                "--libraries.0.include-dirs=cpp",
+                "--libraries.0.binding=nanobind",
+            ],
+            cwd=f"hatch_cpp/tests/{project}",
+        )
+
+        # assert built
+
+        if project == "test_project_limited_api" and platform != "win32":
+            assert "extension.abi3.so" in listdir(f"hatch_cpp/tests/{project}/project")
+        else:
+            if platform == "win32":
+                assert "extension.pyd" in listdir(f"hatch_cpp/tests/{project}/project")
+            else:
+                assert "extension.so" in listdir(f"hatch_cpp/tests/{project}/project")
+
+        # import
+        here = Path(__file__).parent / project
+        path.insert(0, str(here))
+        import project.extension
+
+        assert project.extension.hello() == "A string"

hatch_cpp/tests/test_project_cmake/pyproject.toml

@@ -29,7 +29,7 @@ packages = ["project"]
 packages = ["project"]
 
 [tool.hatch.build.hooks.hatch-cpp]
-verbose = true
+verbose = false
 
 [tool.hatch.build.hooks.hatch-cpp.cmake]
 root = "CMakeLists.txt"

hatch_cpp/tests/test_project_hatch_build/cpp/project/basic.cpp

@@ -0,0 +1,2 @@
+#include "project/basic.hpp"
+

hatch_cpp/tests/test_project_hatch_build/cpp/project/basic.hpp

@@ -0,0 +1,7 @@
+#pragma once
+#include <nanobind/nanobind.h>
+#include <nanobind/stl/string.h>
+
+NB_MODULE(extension, m) {
+    m.def("hello", []() { return "A string"; });
+}

hatch_cpp/tests/test_project_hatch_build/project/__init__.py

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["hatchling>=1.20"]
+build-backend = "hatchling.build"
+
+[project]
+name = "hatch-cpp-test-project-nanobind"
+description = "Basic test project for hatch-cpp"
+version = "0.1.0"
+requires-python = ">=3.9"
+dependencies = [
+    "hatchling>=1.20",
+    "hatch-cpp",
+]
+
+[tool.hatch.build]
+artifacts = [
+    "project/*.dll",
+    "project/*.dylib",
+    "project/*.so",
+]
+
+[tool.hatch.build.sources]
+src = "/"
+
+[tool.hatch.build.targets.sdist]
+packages = ["project"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["project"]
+
+[tool.hatch.build.hooks.hatch-cpp]
+verbose = true
+libraries = [
+    # {name = "project/extension", sources = ["cpp/project/basic.cpp"], include-dirs = ["cpp"], binding = "nanobind"},
+    {name = "wrong", sources = ["wrong"], include-dirs = ["wrong"], binding = "generic"},
+]

hatch_cpp/tests/test_project_hatch_build/pyproject.toml

@@ -3,7 +3,7 @@
 from os import environ
 from pathlib import Path
 from sys import version_info
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Optional, Union
 
 from pydantic import BaseModel, Field
 
@@ -23,15 +23,15 @@
 
 
 class HatchCppCmakeConfiguration(BaseModel):
-    root: Path
+    root: Optional[Path] = None
     build: Path = Field(default_factory=lambda: Path("build"))
     install: Optional[Path] = Field(default=None)
 
     cmake_arg_prefix: Optional[str] = Field(default=None)
     cmake_args: Dict[str, str] = Field(default_factory=dict)
     cmake_env_args: Dict[Platform, Dict[str, str]] = Field(default_factory=dict)
 
-    include_flags: Optional[Dict[str, Any]] = Field(default=None)
+    include_flags: Optional[Dict[str, Union[str, int, float, bool]]] = Field(default=None)
 
     def generate(self, config) -> Dict[str, Any]:
         commands = []

hatch_cpp/toolchains/cmake.py

@@ -35,6 +35,7 @@ classifiers = [
 
 dependencies = [
     "hatchling>=1.20",
+    "hatch-build>=0.4,<0.5",
     "pydantic",
 ]
 
@@ -45,7 +46,7 @@ develop = [
     "check-manifest",
     "codespell>=2.4,<2.5",
     "hatchling",
-    "hatch-build",
+    "hatch-build>=0.3.2",
     "mdformat>=0.7.22,<1.1",
     "mdformat-tables>=1",
     "pytest",