hatch-cpp 0.1.7__tar.gz → 0.1.9__tar.gz

hatch_cpp-0.1.9/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.a
+*.so
+*.obj
+*.dll
+*.exp
+*.lib
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+junit.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# PyBuilder
+target/
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Documentation
+/site
+index.md
+docs/_build/
+docs/src/_build/
+docs/api
+docs/index.md
+docs/html
+docs/jupyter_execute
+index.md
+
+# JS
+js/coverage
+js/dist
+js/lib
+js/node_modules
+js/test-results
+js/playwright-report
+js/*.tgz
+hatch_cpp/extension
+
+# Jupyter
+.ipynb_checkpoints
+.autoversion
+Untitled*.ipynb
+!hatch_cpp/extension/hatch_cpp.json
+!hatch_cpp/extension/install.json
+hatch_cpp/nbextension
+hatch_cpp/labextension
+
+# Mac
+.DS_Store
+
+# Rust
+target
+
+vcpkg
+vcpkg_installed

{hatch_cpp-0.1.7 → hatch_cpp-0.1.9}/LICENSE

@@ -186,7 +186,11 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
+<<<<<<< before updating
    Copyright [yyyy] [name of copyright owner]
+=======
+   Copyright 2025 the hatch-cpp authors
+>>>>>>> after updating
 
    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.9/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: hatch-cpp
+Version: 0.1.9
+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 :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+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: codespell<2.5,>=2.4; extra == 'develop'
+Requires-Dist: hatch-build; extra == 'develop'
+Requires-Dist: hatchling; extra == 'develop'
+Requires-Dist: mdformat-tables>=1; extra == 'develop'
+Requires-Dist: mdformat<1.1,>=0.7.22; extra == 'develop'
+Requires-Dist: nanobind<2.10.0; extra == 'develop'
+Requires-Dist: pybind11; extra == 'develop'
+Requires-Dist: pytest; extra == 'develop'
+Requires-Dist: pytest-cov; extra == 'develop'
+Requires-Dist: ruff<0.15,>=0.9; extra == 'develop'
+Requires-Dist: toml; extra == 'develop'
+Requires-Dist: twine; extra == 'develop'
+Requires-Dist: uv; 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.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/hatch-cpp/actions/workflows/build.yaml)
+[![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)
+
+## Configuration
+
+Configuration is driven from the `[tool.hatch.build.hooks.hatch-cpp]` hatch hook configuration field in a `pyproject.toml`.
+It is designed to closely match existing Python/C/C++ packaging tools.
+
+```toml
+verbose = true
+libraries = { Library Args }
+cmake = { CMake Args }
+platform = { Platform, either "linux", "darwin", or "win32" }
+```
+
+See the [test cases](./hatch_cpp/tests/) for more concrete examples.
+
+`hatch-cpp` is driven by [pydantic](https://docs.pydantic.dev/latest/) models for configuration and execution of the build.
+These models can themselves be overridden by setting `build-config-class` / `build-plan-class`.
+
+### Library Arguments
+
+```toml
+name = "mylib"
+sources = [
+    "path/to/file.cpp",
+]
+language = "c++"
+
+binding = "cpython" # or "pybind11", "nanobind", "generic"
+std = "" # Passed to -std= or /std:
+
+include_dirs = ["paths/to/add/to/-I"]
+library_dirs = ["paths/to/add/to/-L"]
+libraries = ["-llibraries_to_link"]
+
+extra_compile_args = ["--extra-compile-args"]
+extra_link_args = ["--extra-link-args"]
+extra_objects = ["extra_objects"]
+
+define_macros = ["-Ddefines_to_use"]
+undef_macros = ["-Uundefines_to_use"]
+
+py_limited_api = "cp39"  # limited API to use
+```
+
+### CMake Arguments
+
+`hatch-cpp` has some convenience integration with CMake.
+Though this is not designed to be as full-featured as e.g. `scikit-build`, it should be satisfactory for many small projects.
+
+```toml
+root = "path/to/cmake/root"
+build = "path/to/cmake/build/folder"
+install = "path/to/cmake/install/folder"
+
+cmake_arg_prefix = "MYPROJECT_"
+cmake_args = {}  # any other cmake args to pass
+cmake_env_args = {} # env-specific cmake args to pass
+
+include_flags = {} # include flags to pass -D
+```
+
+### Environment Variables
+
+`hatch-cpp` will respect standard environment variables for compiler control.
+
+| Name                       | Default | Description           |
+| :------------------------- | :------ | :-------------------- |
+| `CC`                       |         | C Compiler override   |
+| `CXX`                      |         | C++ Compiler override |
+| `LD`                       |         | Linker override       |
+| `HATCH_CPP_PLATFORM`       |         | Platform to build     |
+| `HATCH_CPP_DISABLE_CCACHE` |         | Disable CCache usage  |
+
+> [!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.9/README.md

@@ -0,0 +1,99 @@
+# hatch-cpp
+
+Hatch plugin for C++ builds
+
+[![Build Status](https://github.com/python-project-templates/hatch-cpp/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/hatch-cpp/actions/workflows/build.yaml)
+[![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)
+
+## Configuration
+
+Configuration is driven from the `[tool.hatch.build.hooks.hatch-cpp]` hatch hook configuration field in a `pyproject.toml`.
+It is designed to closely match existing Python/C/C++ packaging tools.
+
+```toml
+verbose = true
+libraries = { Library Args }
+cmake = { CMake Args }
+platform = { Platform, either "linux", "darwin", or "win32" }
+```
+
+See the [test cases](./hatch_cpp/tests/) for more concrete examples.
+
+`hatch-cpp` is driven by [pydantic](https://docs.pydantic.dev/latest/) models for configuration and execution of the build.
+These models can themselves be overridden by setting `build-config-class` / `build-plan-class`.
+
+### Library Arguments
+
+```toml
+name = "mylib"
+sources = [
+    "path/to/file.cpp",
+]
+language = "c++"
+
+binding = "cpython" # or "pybind11", "nanobind", "generic"
+std = "" # Passed to -std= or /std:
+
+include_dirs = ["paths/to/add/to/-I"]
+library_dirs = ["paths/to/add/to/-L"]
+libraries = ["-llibraries_to_link"]
+
+extra_compile_args = ["--extra-compile-args"]
+extra_link_args = ["--extra-link-args"]
+extra_objects = ["extra_objects"]
+
+define_macros = ["-Ddefines_to_use"]
+undef_macros = ["-Uundefines_to_use"]
+
+py_limited_api = "cp39"  # limited API to use
+```
+
+### CMake Arguments
+
+`hatch-cpp` has some convenience integration with CMake.
+Though this is not designed to be as full-featured as e.g. `scikit-build`, it should be satisfactory for many small projects.
+
+```toml
+root = "path/to/cmake/root"
+build = "path/to/cmake/build/folder"
+install = "path/to/cmake/install/folder"
+
+cmake_arg_prefix = "MYPROJECT_"
+cmake_args = {}  # any other cmake args to pass
+cmake_env_args = {} # env-specific cmake args to pass
+
+include_flags = {} # include flags to pass -D
+```
+
+### Environment Variables
+
+`hatch-cpp` will respect standard environment variables for compiler control.
+
+| Name                       | Default | Description           |
+| :------------------------- | :------ | :-------------------- |
+| `CC`                       |         | C Compiler override   |
+| `CXX`                      |         | C++ Compiler override |
+| `LD`                       |         | Linker override       |
+| `HATCH_CPP_PLATFORM`       |         | Platform to build     |
+| `HATCH_CPP_DISABLE_CCACHE` |         | Disable CCache usage  |
+
+> [!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.9/hatch_cpp/__init__.py

@@ -0,0 +1,6 @@
+__version__ = "0.1.9"
+
+from .config import *
+from .hooks import *
+from .plugin import *
+from .toolchains import *

hatch_cpp-0.1.9/hatch_cpp/config.py

@@ -0,0 +1,101 @@
+from __future__ import annotations
+
+from logging import getLogger
+from os import system as system_call
+from pathlib import Path
+from typing import List, Optional
+
+from pydantic import BaseModel, Field, model_validator
+
+from .toolchains import BuildType, HatchCppCmakeConfiguration, HatchCppLibrary, HatchCppPlatform, HatchCppVcpkgConfiguration, Toolchain
+
+__all__ = (
+    "HatchCppBuildConfig",
+    "HatchCppBuildPlan",
+)
+
+
+_log = getLogger(__name__)
+
+
+class HatchCppBuildConfig(BaseModel):
+    """Build config values for Hatch C++ Builder."""
+
+    verbose: Optional[bool] = Field(default=False)
+    name: Optional[str] = Field(default=None)
+    libraries: List[HatchCppLibrary] = Field(default_factory=list)
+    cmake: Optional[HatchCppCmakeConfiguration] = Field(default=None)
+    platform: Optional[HatchCppPlatform] = Field(default_factory=HatchCppPlatform.default)
+    vcpkg: Optional[HatchCppVcpkgConfiguration] = Field(default_factory=HatchCppVcpkgConfiguration)
+
+    @model_validator(mode="wrap")
+    @classmethod
+    def validate_model(cls, data, handler):
+        if "toolchain" in data:
+            data["platform"] = HatchCppPlatform.platform_for_toolchain(data["toolchain"])
+            data.pop("toolchain")
+        elif "platform" not in data:
+            data["platform"] = HatchCppPlatform.default()
+        if "cc" in data:
+            data["platform"].cc = data["cc"]
+            data.pop("cc")
+        if "cxx" in data:
+            data["platform"].cxx = data["cxx"]
+            data.pop("cxx")
+        if "ld" in data:
+            data["platform"].ld = data["ld"]
+            data.pop("ld")
+        if "vcpkg" in data and data["vcpkg"] == "false":
+            data["vcpkg"] = None
+        model = handler(data)
+        if model.cmake and model.libraries:
+            raise ValueError("Must not provide libraries when using cmake toolchain.")
+        return model
+
+
+class HatchCppBuildPlan(HatchCppBuildConfig):
+    build_type: BuildType = "release"
+    commands: List[str] = Field(default_factory=list)
+
+    _active_toolchains: List[Toolchain] = []
+
+    def generate(self):
+        self.commands = []
+
+        # Evaluate toolchains
+        if self.vcpkg and Path(self.vcpkg.vcpkg).exists():
+            self._active_toolchains.append("vcpkg")
+        if self.libraries:
+            self._active_toolchains.append("vanilla")
+        elif self.cmake:
+            self._active_toolchains.append("cmake")
+
+        # Collect toolchain commands
+        if "vcpkg" in self._active_toolchains:
+            self.commands.extend(self.vcpkg.generate(self))
+
+        if "vanilla" in self._active_toolchains:
+            if "vcpkg" in self._active_toolchains:
+                _log.warning("vcpkg toolchain is active; ensure that your compiler is configured to use vcpkg includes and libs.")
+
+            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}"
+                )
+
+        if "cmake" in self._active_toolchains:
+            self.commands.extend(self.cmake.generate(self))
+
+        return self.commands
+
+    def execute(self):
+        for command in self.commands:
+            system_call(command)
+        return self.commands
+
+    def cleanup(self):
+        if self.platform.platform == "win32":
+            for temp_obj in Path(".").glob("*.obj"):
+                temp_obj.unlink()

{hatch_cpp-0.1.7 → hatch_cpp-0.1.9}/hatch_cpp/plugin.py

@@ -9,7 +9,7 @@ from typing import Any
 
 from hatchling.builders.hooks.plugin.interface import BuildHookInterface
 
-from .structs import HatchCppBuildConfig, HatchCppBuildPlan
+from .config import HatchCppBuildConfig, HatchCppBuildPlan
 from .utils import import_string
 
 __all__ = ("HatchCppBuildHook",)

hatch_cpp-0.1.9/hatch_cpp/tests/test_project_cmake_vcpkg/CMakeLists.txt

@@ -0,0 +1,92 @@
+cmake_minimum_required(VERSION 3.20.0)
+project(hatch-cpp-test-project-basic VERSION "0.1.0")
+set(CMAKE_CXX_STANDARD 20)
+include(CheckCCompilerFlag)
+include(CheckLinkerFlag)
+
+if(${CMAKE_SYSTEM_NAME} MATCHES "Windows")
+    set(WIN32 ON)
+    set(MACOS OFF)
+    set(LINUX OFF)
+elseif(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
+    set(WIN32 OFF)
+    set(MACOS ON)
+    set(LINUX OFF)
+else()
+    set(WIN32 OFF)
+    set(MACOS OFF)
+    set(LINUX ON)
+endif()
+
+option(CMAKE_BUILD_TYPE "Release/Debug build" RELEASE)
+option(HATCH_CPP_TEST_PROJECT_BASIC_BUILD_TESTS "Build tests" OFF)
+option(HATCH_CPP_TEST_PROJECT_BASIC_MANYLINUX "Build for python's manylinux setup" OFF)
+
+string(TOLOWER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_LOWER)
+
+set(BUILD_SHARED_LIBS TRUE)
+set(CMAKE_MACOSX_RPATH TRUE)
+set(CMAKE_SKIP_RPATH FALSE)
+set(CMAKE_SKIP_BUILD_RPATH FALSE)
+set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)
+set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
+set(CMAKE_INSTALL_NAME_DIR "@rpath")
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+string(REGEX REPLACE "[ ]*-O[^ ]+[ ]*" " " CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
+string(REGEX REPLACE "[ ]*-Wl,-O2 -Wl,[^ ]+[ ]*" " " CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS}")
+string(REGEX REPLACE "[ ]*-Wl,-O2 -Wl,[^ ]+[ ]*" " " CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS}")
+
+
+if(MACOS)
+    set(CMAKE_THREAD_LIBS_INIT "-lpthread")
+    set(CMAKE_HAVE_THREADS_LIBRARY 1)
+    set(CMAKE_USE_WIN32_THREADS_INIT 0)
+    set(CMAKE_USE_PTHREADS_INIT 1)
+    set(THREADS_PREFER_PTHREAD_FLAG ON)
+    set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -undefined dynamic_lookup")
+endif()
+
+
+if(MACOS)
+    set(CMAKE_INSTALL_RPATH "@loader_path/")
+elseif(LINUX)
+    set(CMAKE_INSTALL_RPATH "\$ORIGIN")
+endif()
+
+if(WIN32)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /EHsc /MP /bigobj")
+    foreach(warning 4244 4251 4267 4275 4290 4786 4305 4996)
+        SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /wd${warning}")
+    endforeach(warning)
+else()
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} \
+    -g \
+    -Wall \
+    -Werror \
+    -Wno-deprecated-declarations \
+    -Wno-deprecated \
+    ")
+endif()
+
+
+find_package(Python ${CSP_PYTHON_VERSION} EXACT REQUIRED COMPONENTS Interpreter Development.Module)
+link_directories(${Python_LIBRARY_DIRS})
+include_directories(${Python_INCLUDE_DIRS})
+
+set(CMAKE_SHARED_LIBRARY_PREFIX "")
+if(NOT WIN32)
+    set(CMAKE_SHARED_LIBRARY_SUFFIX .so)
+else()
+    set(CMAKE_SHARED_LIBRARY_SUFFIX .pyd)
+endif()
+
+include_directories("${CMAKE_SOURCE_DIR}/cpp")
+
+add_library(extension SHARED cpp/project/basic.cpp)
+set_target_properties(extension PROPERTIES PUBLIC_HEADER cpp/project/basic.hpp)
+install(TARGETS extension
+        PUBLIC_HEADER DESTINATION project/include/project
+        RUNTIME DESTINATION project/
+        LIBRARY DESTINATION project/
+       )