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

hatch_cpp-0.1.6/.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.6}/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.6/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: hatch-cpp
+Version: 0.1.6
+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
+Requires-Dist: pydantic
+Provides-Extra: develop
+Requires-Dist: build; extra == 'develop'
+Requires-Dist: bump-my-version; extra == 'develop'
+Requires-Dist: check-manifest; extra == 'develop'
+Requires-Dist: nanobind; extra == 'develop'
+Requires-Dist: pybind11; 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
+
+A simple, extensible C++ build plugin for [hatch](https://hatch.pypa.io/latest/).
+
+```toml
+[tool.hatch.build.hooks.hatch-cpp]
+libraries = [
+    {name = "project/extension", sources = ["cpp/project/basic.cpp"], include-dirs = ["cpp"]}
+]
+```
+
+For more complete systems, see:
+- [scikit-build-core](https://github.com/scikit-build/scikit-build-core)
+- [setuptools](https://setuptools.pypa.io/en/latest/userguide/ext_modules.html)
+
+## Environment Variables
+| Name | Default | Description |
+|:-----|:--------|:------------|
+|`CC`| | |
+|`CXX`| | |
+|`LD`| | |
+|`HATCH_CPP_PLATFORM`| | |
+|`HATCH_CPP_DISABLE_CCACHE`| | |
+
+> [!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.6/README.md

@@ -0,0 +1,35 @@
+# 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
+
+A simple, extensible C++ build plugin for [hatch](https://hatch.pypa.io/latest/).
+
+```toml
+[tool.hatch.build.hooks.hatch-cpp]
+libraries = [
+    {name = "project/extension", sources = ["cpp/project/basic.cpp"], include-dirs = ["cpp"]}
+]
+```
+
+For more complete systems, see:
+- [scikit-build-core](https://github.com/scikit-build/scikit-build-core)
+- [setuptools](https://setuptools.pypa.io/en/latest/userguide/ext_modules.html)
+
+## Environment Variables
+| Name | Default | Description |
+|:-----|:--------|:------------|
+|`CC`| | |
+|`CXX`| | |
+|`LD`| | |
+|`HATCH_CPP_PLATFORM`| | |
+|`HATCH_CPP_DISABLE_CCACHE`| | |
+
+> [!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.6/hatch_cpp/__init__.py

@@ -0,0 +1,5 @@
+__version__ = "0.1.6"
+
+from .hooks import hatch_register_build_hook
+from .plugin import HatchCppBuildHook
+from .structs import *

hatch_cpp-0.1.6/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.6/hatch_cpp/plugin.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+import logging
+import os
+import platform as sysplatform
+import sys
+import typing as t
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+from .structs import HatchCppBuildConfig, HatchCppBuildPlan
+from .utils import import_string
+
+__all__ = ("HatchCppBuildHook",)
+
+
+class HatchCppBuildHook(BuildHookInterface[HatchCppBuildConfig]):
+    """The hatch-cpp build hook."""
+
+    PLUGIN_NAME = "hatch-cpp"
+    _logger = logging.getLogger(__name__)
+
+    def initialize(self, version: str, build_data: dict[str, t.Any]) -> None:
+        """Initialize the plugin."""
+        # Log some basic information
+        self._logger.info("Initializing hatch-cpp plugin version %s", version)
+        self._logger.info("Running hatch-cpp")
+
+        # Only run if creating wheel
+        # TODO: Add support for specify sdist-plan
+        if self.target_name != "wheel":
+            self._logger.info("ignoring target name %s", self.target_name)
+            return
+
+        # Skip if SKIP_HATCH_CPP is set
+        # TODO: Support CLI once https://github.com/pypa/hatch/pull/1743
+        if os.getenv("SKIP_HATCH_CPP"):
+            self._logger.info("Skipping the build hook since SKIP_HATCH_CPP was set")
+            return
+
+        # Get build config class or use default
+        build_config_class = import_string(self.config["build-config-class"]) if "build-config-class" in self.config else HatchCppBuildConfig
+
+        # Instantiate build config
+        config = build_config_class(**self.config)
+
+        # Grab libraries and platform
+        libraries = config.libraries
+        platform = config.platform
+
+        # Get build plan class or use default
+        build_plan_class = import_string(self.config["build-plan-class"]) if "build-plan-class" in self.config else HatchCppBuildPlan
+
+        # Instantiate builder
+        build_plan = build_plan_class(libraries=libraries, platform=platform)
+
+        # Generate commands
+        build_plan.generate()
+
+        # Log commands if in verbose mode
+        if config.verbose:
+            for command in build_plan.commands:
+                self._logger.warning(command)
+
+        # Execute build plan
+        build_plan.execute()
+
+        # Perform any cleanup actions
+        build_plan.cleanup()
+
+        # force include libraries
+        for library in libraries:
+            name = library.get_qualified_name(build_plan.platform.platform)
+            build_data["force_include"][name] = name
+
+        if libraries:
+            build_data["pure_python"] = False
+            machine = sysplatform.machine()
+            version_major = sys.version_info.major
+            version_minor = sys.version_info.minor
+            # TODO abi3
+            if "darwin" in sys.platform:
+                os_name = "macosx_11_0"
+            elif "linux" in sys.platform:
+                os_name = "linux"
+            else:
+                os_name = "win"
+            if all([lib.py_limited_api for lib in libraries]):
+                build_data["tag"] = f"cp{version_major}{version_minor}-abi3-{os_name}_{machine}"
+            else:
+                build_data["tag"] = f"cp{version_major}{version_minor}-cp{version_major}{version_minor}-{os_name}_{machine}"

hatch_cpp-0.1.6/hatch_cpp/structs.py

@@ -0,0 +1,252 @@
+from __future__ import annotations
+
+from os import environ, system
+from pathlib import Path
+from re import match
+from shutil import which
+from sys import executable, platform as sys_platform
+from sysconfig import get_path
+from typing import Any, List, Literal, Optional
+
+from pydantic import AliasChoices, BaseModel, Field, field_validator, model_validator
+
+__all__ = (
+    "HatchCppBuildConfig",
+    "HatchCppLibrary",
+    "HatchCppPlatform",
+    "HatchCppBuildPlan",
+)
+
+BuildType = Literal["debug", "release"]
+CompilerToolchain = Literal["gcc", "clang", "msvc"]
+Language = Literal["c", "c++"]
+Binding = Literal["cpython", "pybind11", "nanobind"]
+Platform = Literal["linux", "darwin", "win32"]
+PlatformDefaults = {
+    "linux": {"CC": "gcc", "CXX": "g++", "LD": "ld"},
+    "darwin": {"CC": "clang", "CXX": "clang++", "LD": "ld"},
+    "win32": {"CC": "cl", "CXX": "cl", "LD": "link"},
+}
+
+
+class HatchCppLibrary(BaseModel, validate_assignment=True):
+    """A C++ library."""
+
+    name: str
+    sources: List[str]
+    language: Language = "c++"
+
+    binding: Binding = "cpython"
+    std: Optional[str] = None
+
+    include_dirs: List[str] = Field(default_factory=list, alias=AliasChoices("include_dirs", "include-dirs"))
+    library_dirs: List[str] = Field(default_factory=list, alias=AliasChoices("library_dirs", "library-dirs"))
+    libraries: List[str] = Field(default_factory=list)
+
+    extra_compile_args: List[str] = Field(default_factory=list, alias=AliasChoices("extra_compile_args", "extra-compile-args"))
+    extra_link_args: List[str] = Field(default_factory=list, alias=AliasChoices("extra_link_args", "extra-link-args"))
+    extra_objects: List[str] = Field(default_factory=list, alias=AliasChoices("extra_objects", "extra-objects"))
+
+    define_macros: List[str] = Field(default_factory=list, alias=AliasChoices("define_macros", "define-macros"))
+    undef_macros: List[str] = Field(default_factory=list, alias=AliasChoices("undef_macros", "undef-macros"))
+
+    export_symbols: List[str] = Field(default_factory=list, alias=AliasChoices("export_symbols", "export-symbols"))
+    depends: List[str] = Field(default_factory=list)
+
+    py_limited_api: Optional[str] = Field(default="", alias=AliasChoices("py_limited_api", "py-limited-api"))
+
+    @field_validator("py_limited_api", mode="before")
+    @classmethod
+    def check_py_limited_api(cls, value: Any) -> Any:
+        if value:
+            if not match(r"cp3\d", value):
+                raise ValueError("py-limited-api must be in the form of cp3X")
+        return value
+
+    def get_qualified_name(self, platform):
+        if platform == "win32":
+            suffix = "dll" if self.binding == "none" else "pyd"
+        elif platform == "darwin":
+            suffix = "dylib" if self.binding == "none" else "so"
+        else:
+            suffix = "so"
+        if self.py_limited_api and platform != "win32":
+            return f"{self.name}.abi3.{suffix}"
+        return f"{self.name}.{suffix}"
+
+    @model_validator(mode="after")
+    def check_binding_and_py_limited_api(self):
+        if self.binding == "pybind11" and self.py_limited_api:
+            raise ValueError("pybind11 does not support Py_LIMITED_API")
+        return self
+
+
+class HatchCppPlatform(BaseModel):
+    cc: str
+    cxx: str
+    ld: 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"])
+        LD = environ.get("LD", PlatformDefaults[platform]["LD"])
+        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}")
+
+        # Customizations
+        if which("ccache") and not environ.get("HATCH_CPP_DISABLE_CCACHE"):
+            CC = f"ccache {CC}"
+            CXX = f"ccache {CXX}"
+
+        # https://github.com/rui314/mold/issues/647
+        # if which("ld.mold"):
+        #     LD = which("ld.mold")
+        # elif which("ld.lld"):
+        #     LD = which("ld.lld")
+        return HatchCppPlatform(cc=CC, cxx=CXX, ld=LD, platform=platform, toolchain=toolchain)
+
+    def get_compile_flags(self, library: HatchCppLibrary, build_type: BuildType = "release") -> str:
+        flags = ""
+
+        # Python.h
+        library.include_dirs.append(get_path("include"))
+
+        if library.binding == "pybind11":
+            import pybind11
+
+            library.include_dirs.append(pybind11.get_include())
+            if not library.std:
+                library.std = "c++11"
+        elif library.binding == "nanobind":
+            import nanobind
+
+            library.include_dirs.append(nanobind.include_dir())
+            if not library.std:
+                library.std = "c++17"
+            library.sources.append(str(Path(nanobind.include_dir()).parent / "src" / "nb_combined.cpp"))
+            library.include_dirs.append(str((Path(nanobind.include_dir()).parent / "ext" / "robin_map" / "include")))
+
+        if library.py_limited_api:
+            if library.binding == "pybind11":
+                raise ValueError("pybind11 does not support Py_LIMITED_API")
+            library.define_macros.append(f"Py_LIMITED_API=0x0{library.py_limited_api[2]}0{hex(int(library.py_limited_api[3:]))[2:]}00f0")
+
+        # Toolchain-specific flags
+        if self.toolchain == "gcc":
+            flags += " " + " ".join(f"-I{d}" for d in library.include_dirs)
+            flags += " -fPIC"
+            flags += " " + " ".join(library.extra_compile_args)
+            flags += " " + " ".join(f"-D{macro}" for macro in library.define_macros)
+            flags += " " + " ".join(f"-U{macro}" for macro in library.undef_macros)
+            if library.std:
+                flags += f" -std={library.std}"
+        elif self.toolchain == "clang":
+            flags += " ".join(f"-I{d}" for d in library.include_dirs)
+            flags += " -fPIC"
+            flags += " " + " ".join(library.extra_compile_args)
+            flags += " " + " ".join(f"-D{macro}" for macro in library.define_macros)
+            flags += " " + " ".join(f"-U{macro}" for macro in library.undef_macros)
+            if library.std:
+                flags += f" -std={library.std}"
+        elif self.toolchain == "msvc":
+            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"
+            if library.std:
+                flags += f" /std:{library.std}"
+        # clean
+        while flags.count("  "):
+            flags = flags.replace("  ", " ")
+        return flags
+
+    def get_link_flags(self, library: HatchCppLibrary, build_type: BuildType = "release") -> str:
+        flags = ""
+        if self.toolchain == "gcc":
+            flags += " -shared"
+            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 += f" -o {library.get_qualified_name(self.platform)}"
+            if self.platform == "darwin":
+                flags += " -undefined dynamic_lookup"
+            if "mold" in self.ld:
+                flags += f" -fuse-ld={self.ld}"
+            elif "lld" in self.ld:
+                flags += " -fuse-ld=lld"
+        elif self.toolchain == "clang":
+            flags += " -shared"
+            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 += f" -o {library.get_qualified_name(self.platform)}"
+            if self.platform == "darwin":
+                flags += " -undefined dynamic_lookup"
+            if "mold" in self.ld:
+                flags += f" -fuse-ld={self.ld}"
+            elif "lld" in self.ld:
+                flags += " -fuse-ld=lld"
+        elif self.toolchain == "msvc":
+            flags += " " + " ".join(library.extra_link_args)
+            flags += " " + " ".join(library.extra_objects)
+            flags += " /LD"
+            flags += f" /Fe:{library.get_qualified_name(self.platform)}"
+            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
+
+
+class HatchCppBuildPlan(BaseModel):
+    build_type: BuildType = "release"
+    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:
+            compile_flags = self.platform.get_compile_flags(library, self.build_type)
+            link_flags = self.platform.get_link_flags(library, self.build_type)
+            self.commands.append(
+                f"{self.platform.cc if library.language == 'c' else self.platform.cxx} {' '.join(library.sources)} {compile_flags} {link_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 temp_obj in Path(".").glob("*.obj"):
+                temp_obj.unlink()
+
+
+class HatchCppBuildConfig(BaseModel):
+    """Build config values for Hatch C++ Builder."""
+
+    verbose: Optional[bool] = Field(default=False)
+    libraries: List[HatchCppLibrary] = Field(default_factory=list)
+    platform: Optional[HatchCppPlatform] = Field(default_factory=HatchCppPlatform.default)

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

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

hatch_cpp-0.1.6/hatch_cpp/tests/test_project_basic/cpp/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);
+}