hatch-cpp 0.0.0__tar.gz → 0.1.1__tar.gz

hatch_cpp-0.1.1/.gitignore

@@ -0,0 +1,169 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.a
+*.so
+*.obj
+*.dll
+*.exp
+*.lib
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+python_junit.xml
+junit.xml
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+.pytest_cache
+.ruff_cache
+js/playwright-report
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask instance folder
+instance/
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/source
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+*.ipynb
+.autoversion
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# =========================
+# Operating System Files
+# =========================
+
+# OSX
+# =========================
+
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows
+# =========================
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+
+# NPM
+# ----
+**/node_modules/
+
+# Coverage data
+# -------------
+**/coverage/
+
+# Notebook and lab extensions
+
+nbprint/extension/*
+nbprint/templates/nbprint/static/*
+nbprint/voila/static/*
+tmp.html
+examples/output/

{hatch_cpp-0.0.0 → hatch_cpp-0.1.1}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024, the hatch-cpp authors
+   Copyright [yyyy] [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

hatch_cpp-0.1.1/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: hatch-cpp
+Version: 0.1.1
+Summary: Hatch plugin for C++ builds
+Project-URL: Repository, https://github.com/python-project-templates/hatch-cpp
+Project-URL: Homepage, https://github.com/python-project-templates/hatch-cpp
+Author-email: the hatch-cpp authors <t.paine154@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: build,c++,cmake,cpp,hatch,python
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9
+Requires-Dist: hatchling>=1.20
+Provides-Extra: develop
+Requires-Dist: build; extra == 'develop'
+Requires-Dist: bump-my-version; extra == 'develop'
+Requires-Dist: check-manifest; extra == 'develop'
+Requires-Dist: pytest; extra == 'develop'
+Requires-Dist: pytest-cov; extra == 'develop'
+Requires-Dist: ruff<0.9,>=0.3; extra == 'develop'
+Requires-Dist: twine; extra == 'develop'
+Requires-Dist: wheel; extra == 'develop'
+Description-Content-Type: text/markdown
+
+# hatch-cpp
+
+Hatch plugin for C++ builds
+
+[![Build Status](https://github.com/python-project-templates/hatch-cpp/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/hatch-cpp/actions/workflows/build.yml)
+[![codecov](https://codecov.io/gh/python-project-templates/hatch-cpp/branch/main/graph/badge.svg)](https://codecov.io/gh/python-project-templates/hatch-cpp)
+[![License](https://img.shields.io/github/license/python-project-templates/hatch-cpp)](https://github.com/python-project-templates/hatch-cpp)
+[![PyPI](https://img.shields.io/pypi/v/hatch-cpp.svg)](https://pypi.python.org/pypi/hatch-cpp)
+
+## Overview
+
+> [!NOTE]
+> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).

hatch_cpp-0.1.1/README.md

@@ -0,0 +1,13 @@
+# hatch-cpp
+
+Hatch plugin for C++ builds
+
+[![Build Status](https://github.com/python-project-templates/hatch-cpp/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/hatch-cpp/actions/workflows/build.yml)
+[![codecov](https://codecov.io/gh/python-project-templates/hatch-cpp/branch/main/graph/badge.svg)](https://codecov.io/gh/python-project-templates/hatch-cpp)
+[![License](https://img.shields.io/github/license/python-project-templates/hatch-cpp)](https://github.com/python-project-templates/hatch-cpp)
+[![PyPI](https://img.shields.io/pypi/v/hatch-cpp.svg)](https://pypi.python.org/pypi/hatch-cpp)
+
+## Overview
+
+> [!NOTE]
+> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).

hatch_cpp-0.1.1/hatch_cpp/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.1"

hatch_cpp-0.1.1/hatch_cpp/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+if __name__ == "__main__":
+    main()

hatch_cpp-0.1.1/hatch_cpp/hooks.py

@@ -0,0 +1,10 @@
+from typing import Type
+
+from hatchling.plugin import hookimpl
+
+from .plugin import HatchCppBuildHook
+
+
+@hookimpl
+def hatch_register_build_hook() -> Type[HatchCppBuildHook]:
+    return HatchCppBuildHook

hatch_cpp-0.1.1/hatch_cpp/plugin.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+import logging
+import os
+import typing as t
+from dataclasses import fields
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+from .structs import HatchCppBuildConfig, HatchCppBuildPlan, HatchCppLibrary, HatchCppPlatform
+
+__all__ = ("HatchCppBuildHook",)
+
+
+class HatchCppBuildHook(BuildHookInterface[HatchCppBuildConfig]):
+    """The hatch-cpp build hook."""
+
+    PLUGIN_NAME = "hatch-cpp"
+    _logger = logging.getLogger(__name__)
+
+    def initialize(self, version: str, _: dict[str, t.Any]) -> None:
+        """Initialize the plugin."""
+        self._logger.info("Running hatch-cpp")
+
+        if self.target_name != "wheel":
+            self._logger.info("ignoring target name %s", self.target_name)
+            return
+
+        if os.getenv("SKIP_HATCH_CPP"):
+            self._logger.info("Skipping the build hook since SKIP_HATCH_CPP was set")
+            return
+
+        kwargs = {k.replace("-", "_"): v if not isinstance(v, bool) else str(v) for k, v in self.config.items()}
+        available_fields = [f.name for f in fields(HatchCppBuildConfig)]
+        for key in list(kwargs):
+            if key not in available_fields:
+                del kwargs[key]
+        config = HatchCppBuildConfig(**kwargs)
+
+        library_kwargs = [
+            {k.replace("-", "_"): v if not isinstance(v, bool) else str(v) for k, v in library_kwargs.items()} for library_kwargs in config.libraries
+        ]
+        libraries = [HatchCppLibrary(**library_kwargs) for library_kwargs in library_kwargs]
+        platform = HatchCppPlatform.default()
+        if config.toolchain == "raw":
+            build_plan = HatchCppBuildPlan(libraries=libraries, platform=platform)
+            build_plan.generate()
+            if config.verbose:
+                for command in build_plan.commands:
+                    self._logger.info(command)
+            build_plan.execute()
+            build_plan.cleanup()
+
+        # build_kwargs = config.build_kwargs
+        # if version == "editable":
+        #     build_kwargs = config.editable_build_kwargs or build_kwargs
+
+        # should_skip_build = False
+        # if not config.build_function:
+        #     log.warning("No build function found")
+        #     should_skip_build = True
+
+        # elif config.skip_if_exists and version == "standard":
+        #     should_skip_build = should_skip(config.skip_if_exists)
+        #     if should_skip_build:
+        #         log.info("Skip-if-exists file(s) found")
+
+        # # Get build function and call it with normalized parameter names.
+        # if not should_skip_build and config.build_function:
+        #     build_func = get_build_func(config.build_function)
+        #     build_kwargs = normalize_kwargs(build_kwargs)
+        #     log.info("Building with %s", config.build_function)
+        #     log.info("With kwargs: %s", build_kwargs)
+        #     try:
+        #         build_func(self.target_name, version, **build_kwargs)
+        #     except Exception as e:
+        #         if version == "editable" and config.optional_editable_build.lower() == "true":
+        #             warnings.warn(f"Encountered build error:\n{e}", stacklevel=2)
+        #         else:
+        #             raise e
+        # else:
+        #     log.info("Skipping build")
+
+        # # Ensure targets in distributable dists.
+        # if version == "standard":
+        #     ensure_targets(config.ensured_targets)
+
+        self._logger.info("Finished running hatch-cpp")
+        return

hatch_cpp-0.1.1/hatch_cpp/structs.py

@@ -0,0 +1,159 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from os import environ, system
+from pathlib import Path
+from sys import executable, platform as sys_platform
+from sysconfig import get_path
+from typing import Literal
+
+from hatchling.builders.config import BuilderConfig
+
+__all__ = (
+    "HatchCppBuildConfig",
+    "HatchCppLibrary",
+    "HatchCppPlatform",
+    "HatchCppBuildPlan",
+)
+
+Platform = Literal["linux", "darwin", "win32"]
+CompilerToolchain = Literal["gcc", "clang", "msvc"]
+PlatformDefaults = {
+    "linux": {"CC": "gcc", "CXX": "g++"},
+    "darwin": {"CC": "clang", "CXX": "clang++"},
+    "win32": {"CC": "cl", "CXX": "cl"},
+}
+
+
+@dataclass
+class HatchCppBuildConfig(BuilderConfig):
+    """Build config values for Hatch C++ Builder."""
+
+    toolchain: str | None = field(default="raw")
+    libraries: list[dict[str, str]] = field(default_factory=list)
+    verbose: bool | None = field(default=False)
+    # build_function: str | None = None
+    # build_kwargs: t.Mapping[str, str] = field(default_factory=dict)
+    # editable_build_kwargs: t.Mapping[str, str] = field(default_factory=dict)
+    # ensured_targets: list[str] = field(default_factory=list)
+    # skip_if_exists: list[str] = field(default_factory=list)
+
+
+@dataclass
+class HatchCppLibrary(object):
+    """A C++ library."""
+
+    name: str
+    sources: list[str]
+
+    include_dirs: list[str] = field(default_factory=list)
+    library_dirs: list[str] = field(default_factory=list)
+    libraries: list[str] = field(default_factory=list)
+    extra_compile_args: list[str] = field(default_factory=list)
+    extra_link_args: list[str] = field(default_factory=list)
+    extra_objects: list[str] = field(default_factory=list)
+    define_macros: list[str] = field(default_factory=list)
+    undef_macros: list[str] = field(default_factory=list)
+
+    export_symbols: list[str] = field(default_factory=list)
+    depends: list[str] = field(default_factory=list)
+
+
+@dataclass
+class HatchCppPlatform(object):
+    cc: str
+    cxx: str
+    platform: Platform
+    toolchain: CompilerToolchain
+
+    @staticmethod
+    def default() -> HatchCppPlatform:
+        platform = environ.get("HATCH_CPP_PLATFORM", sys_platform)
+        CC = environ.get("CC", PlatformDefaults[platform]["CC"])
+        CXX = environ.get("CXX", PlatformDefaults[platform]["CXX"])
+        if "gcc" in CC and "g++" in CXX:
+            toolchain = "gcc"
+        elif "clang" in CC and "clang++" in CXX:
+            toolchain = "clang"
+        elif "cl" in CC and "cl" in CXX:
+            toolchain = "msvc"
+        else:
+            raise Exception(f"Unrecognized toolchain: {CC}, {CXX}")
+        return HatchCppPlatform(cc=CC, cxx=CXX, platform=platform, toolchain=toolchain)
+
+    def get_compile_flags(self, library: HatchCppLibrary) -> str:
+        flags = ""
+        if self.toolchain == "gcc":
+            flags = f"-I{get_path('include')}"
+            flags += " " + " ".join(f"-I{d}" for d in library.include_dirs)
+            flags += " -fPIC -shared"
+            flags += " " + " ".join(library.extra_compile_args)
+            flags += " " + " ".join(library.extra_link_args)
+            flags += " " + " ".join(library.extra_objects)
+            flags += " " + " ".join(f"-l{lib}" for lib in library.libraries)
+            flags += " " + " ".join(f"-L{lib}" for lib in library.library_dirs)
+            flags += " " + " ".join(f"-D{macro}" for macro in library.define_macros)
+            flags += " " + " ".join(f"-U{macro}" for macro in library.undef_macros)
+            flags += f" -o {library.name}.so"
+        elif self.toolchain == "clang":
+            flags = f"-I{get_path('include')} "
+            flags += " ".join(f"-I{d}" for d in library.include_dirs)
+            flags += " -undefined dynamic_lookup -fPIC -shared"
+            flags += " " + " ".join(library.extra_compile_args)
+            flags += " " + " ".join(library.extra_link_args)
+            flags += " " + " ".join(library.extra_objects)
+            flags += " " + " ".join(f"-l{lib}" for lib in library.libraries)
+            flags += " " + " ".join(f"-L{lib}" for lib in library.library_dirs)
+            flags += " " + " ".join(f"-D{macro}" for macro in library.define_macros)
+            flags += " " + " ".join(f"-U{macro}" for macro in library.undef_macros)
+            flags += f" -o {library.name}.so"
+        elif self.toolchain == "msvc":
+            flags = f"/I{get_path('include')} "
+            flags += " ".join(f"/I{d}" for d in library.include_dirs)
+            flags += " " + " ".join(library.extra_compile_args)
+            flags += " " + " ".join(library.extra_link_args)
+            flags += " " + " ".join(library.extra_objects)
+            flags += " " + " ".join(f"/D{macro}" for macro in library.define_macros)
+            flags += " " + " ".join(f"/U{macro}" for macro in library.undef_macros)
+            flags += " /EHsc /DWIN32 /LD"
+            flags += f" /Fo:{library.name}.obj"
+            flags += f" /Fe:{library.name}.pyd"
+            flags += " /link /DLL"
+            if (Path(executable).parent / "libs").exists():
+                flags += f" /LIBPATH:{str(Path(executable).parent / 'libs')}"
+            flags += " " + " ".join(f"{lib}.lib" for lib in library.libraries)
+            flags += " " + " ".join(f"/LIBPATH:{lib}" for lib in library.library_dirs)
+        # clean
+        while flags.count("  "):
+            flags = flags.replace("  ", " ")
+        return flags
+
+    def get_link_flags(self, library: HatchCppLibrary) -> str:
+        flags = ""
+        return flags
+
+
+@dataclass
+class HatchCppBuildPlan(object):
+    libraries: list[HatchCppLibrary] = field(default_factory=list)
+    platform: HatchCppPlatform = field(default_factory=HatchCppPlatform.default)
+    commands: list[str] = field(default_factory=list)
+
+    def generate(self):
+        self.commands = []
+        for library in self.libraries:
+            flags = self.platform.get_compile_flags(library)
+            self.commands.append(f"{self.platform.cc} {' '.join(library.sources)} {flags}")
+        return self.commands
+
+    def execute(self):
+        for command in self.commands:
+            system(command)
+        return self.commands
+
+    def cleanup(self):
+        if self.platform.platform == "win32":
+            for library in self.libraries:
+                temp_obj = Path(f"{library.name}.obj")
+                if temp_obj.exists():
+                    temp_obj.unlink()

hatch_cpp-0.1.1/hatch_cpp/tests/test_all.py

@@ -0,0 +1,2 @@
+def test_import():
+    pass

hatch_cpp-0.1.1/hatch_cpp/tests/test_project_basic/cpp/basic-project/basic.cpp

@@ -0,0 +1,5 @@
+#include "basic-project/basic.hpp"
+
+PyObject* hello(PyObject*, PyObject*) {
+    return PyUnicode_FromString("A string");
+}

hatch_cpp-0.1.1/hatch_cpp/tests/test_project_basic/cpp/basic-project/basic.hpp

@@ -0,0 +1,17 @@
+#pragma once
+#include "Python.h"
+
+PyObject* hello(PyObject*, PyObject*);
+
+static PyMethodDef extension_methods[] = {
+  {"hello", (PyCFunction)hello, METH_NOARGS},
+  {nullptr, nullptr, 0, nullptr}
+};
+
+static PyModuleDef extension_module = {
+  PyModuleDef_HEAD_INIT, "extension", "extension", -1, extension_methods};
+
+PyMODINIT_FUNC PyInit_extension(void) {
+  Py_Initialize();
+  return PyModule_Create(&extension_module);
+}

hatch_cpp-0.1.1/hatch_cpp/tests/test_project_basic/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["hatchling>=1.20"]
+build-backend = "hatchling.build"
+
+[project]
+name = "hatch-cpp-test-project-basic"
+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 = [
+    "basic_project/*.dll",
+    "basic_project/*.dylib",
+    "basic_project/*.so",
+]
+
+[tool.hatch.build.sources]
+src = "/"
+
+[tool.hatch.build.targets.sdist]
+packages = ["basic_project"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["basic_project"]
+
+[tool.hatch.build.hooks.hatch-cpp]
+verbose = true
+libraries = [
+    {name = "basic_project/extension", sources = ["cpp/basic-project/basic.cpp"], include-dirs = ["cpp"]}
+]
+
+# build-function = "hatch_cpp.cpp_builder"
+
+# [tool.hatch.build.hooks.defaults]
+# build-type = "release"
+
+# [tool.hatch.build.hooks.env-vars]
+# TODO: these will all be available via
+# CLI after https://github.com/pypa/hatch/pull/1743
+# e.g. --hatch-cpp-build-type=debug
+# build-type = "BUILD_TYPE"
+# ccache = "USE_CCACHE"
+# manylinux = "MANYLINUX"
+# vcpkg = "USE_VCPKG"
+
+# [tool.hatch.build.hooks.cmake]
+
+# [tool.hatch.build.hooks.vcpkg]
+# triplets = {linux="x64-linux", macos="x64-osx", windows="x64-windows-static-md"}
+# clone = true
+# update = true
+
+# [tool.hatch.build.hooks.hatch-cpp.build-kwargs]
+# path = "cpp"
+
+[tool.pytest.ini_options]
+asyncio_mode = "strict"
+testpaths = "basic_project/tests"

hatch_cpp-0.1.1/hatch_cpp/tests/test_project_basic.py

@@ -0,0 +1,28 @@
+from os import listdir
+from pathlib import Path
+from shutil import rmtree
+from subprocess import check_output
+from sys import path, platform
+
+
+class TestProject:
+    def test_basic(self):
+        rmtree("hatch_cpp/tests/test_project_basic/basic_project/extension.so", ignore_errors=True)
+        rmtree("hatch_cpp/tests/test_project_basic/basic_project/extension.pyd", ignore_errors=True)
+        check_output(
+            [
+                "hatchling",
+                "build",
+                "--hooks-only",
+            ],
+            cwd="hatch_cpp/tests/test_project_basic",
+        )
+        if platform == "win32":
+            assert "extension.pyd" in listdir("hatch_cpp/tests/test_project_basic/basic_project")
+        else:
+            assert "extension.so" in listdir("hatch_cpp/tests/test_project_basic/basic_project")
+        here = Path(__file__).parent / "test_project_basic"
+        path.insert(0, str(here))
+        import basic_project.extension
+
+        assert basic_project.extension.hello() == "A string"