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

hatch_cpp-0.1.8/.gitignore

@@ -0,0 +1,159 @@
+# 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

{hatch_cpp-0.1.6 → hatch_cpp-0.1.8}/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.8/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: hatch-cpp
+Version: 0.1.8
+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<0.8,>=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; 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.8/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.6 → hatch_cpp-0.1.8}/hatch_cpp/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.6"
+__version__ = "0.1.8"
 
 from .hooks import hatch_register_build_hook
 from .plugin import HatchCppBuildHook

hatch_cpp-0.1.8/hatch_cpp/plugin.py

@@ -0,0 +1,113 @@
+from __future__ import annotations
+
+from logging import getLogger
+from os import getenv
+from pathlib import Path
+from platform import machine as platform_machine
+from sys import platform as sys_platform, version_info
+from typing import Any
+
+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 = getLogger(__name__)
+
+    def initialize(self, version: str, build_data: dict[str, Any]) -> None:
+        """Initialize the plugin."""
+        # Log some basic information
+        project_name = self.metadata.config["project"]["name"]
+        self._logger.info("Initializing hatch-cpp plugin version %s", version)
+        self._logger.info(f"Running hatch-cpp: {project_name}")
+
+        # 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 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(name=project_name, **self.config)
+
+        # 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(**config.model_dump())
+
+        # 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()
+
+        if build_plan.libraries:
+            # force include libraries
+            for library in build_plan.libraries:
+                name = library.get_qualified_name(build_plan.platform.platform)
+                build_data["force_include"][name] = name
+
+            build_data["pure_python"] = False
+            machine = platform_machine()
+            version_major = version_info.major
+            version_minor = version_info.minor
+            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 build_plan.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}"
+        else:
+            build_data["pure_python"] = False
+            machine = platform_machine()
+            version_major = version_info.major
+            version_minor = 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"
+            build_data["tag"] = f"cp{version_major}{version_minor}-cp{version_major}{version_minor}-{os_name}_{machine}"
+
+            # force include libraries
+            for path in Path(".").rglob("*"):
+                if path.is_dir():
+                    continue
+                if str(path).startswith(str(build_plan.cmake.build)) or str(path).startswith("dist"):
+                    continue
+                if path.suffix in (".pyd", ".dll", ".so", ".dylib"):
+                    build_data["force_include"][str(path)] = str(path)
+
+        for path in build_data["force_include"]:
+            self._logger.warning(f"Force include: {path}")