【亲测免费】 CMake示例：使用Pybind11构建Python扩展模块

CMake示例：使用Pybind11构建Python扩展模块

本教程将指导您了解并使用从https://github.com/pybind/cmake_example.git获取的开源项目。这个项目展示了一个基于CMake构建系统的Pybind11模块实例，适用于那些已经有CMake项目结构的C++代码库。

1. 项目目录结构及介绍

目录结构：

cmake_example/
├── appveyor.yml                    # AppVeyor持续集成配置文件
├── CMakeLists.txt                  # CMake主配置文件
├── gitignore                       # Git忽略文件配置
├── gitmodules                      # 子模块信息（用于pybind11）
├── pre-commit-config.yaml          # Pre-commit 配置文件，用于代码质量检查
├── LICENSE                         # 许可证文件
├── MANIFEST.in                     # 包含在最终分发包中的额外文件列表
├── README.md                       # 项目读我文件
├── pyproject.toml                  # Python项目配置文件，定义依赖等
├── setup.py                        # Python安装脚本
├── cmake                            # CMake相关子目录
│   └── ...
├── docs                             # 文档目录
│   ├── ...
│   └── make.bat                     # 构建文档的批处理文件（Windows）
├── src                              # 源码目录
│   ├── cmake_example.cpp            # 主要的C++源代码文件
│   └── ...
└── tests                            # 测试目录
    ├── ...
    └── test_cmake_example.cpp       # 测试文件

目录介绍：

• CMakeLists.txt 是构建的核心，指导CMake如何编译项目。
• src 目录存放C++源代码，如cmake_example.cpp是主要实现。
• tests 包含测试代码，以确保功能正确性。
• docs 相关文件用于生成项目文档，利用Sphinx。
• pyproject.toml 和 setup.py 分别用于现代Python项目的元数据和安装脚本。
• appveyor.yml 是自动化部署到Windows的配置。
• LICENSE 文件包含了项目使用的BSD风格许可证条款。

2. 项目启动文件介绍

项目没有传统意义上的“启动文件”，但其核心在于执行Python代码时导入的模块。当你通过Python运行下面的命令：

import cmake_example
cmake_example.add(1, 2)

这里，启动点变为了Python环境下的import cmake_example。实际的工作由C++代码完成，该代码由src/cmake_example.cpp提供，并通过Pybind11绑定到Python中。

3. 项目的配置文件介绍

CMakeLists.txt

这是最重要的配置文件，它定义了如何构建整个项目。关键部分包括设置Python版本、添加Pybind11作为子模块、创建Python扩展模块目标以及指定编译选项。例如，它可能会包含类似于以下的关键指令：

find_package(pybind11 REQUIRED)
add_library(cmake_example SHARED src/cmake_example.cpp)
pybind11_wrap_cpp(cmake_example MODULE cmake_example.cpp EXPORT_NAME cmake_example)
target_include_directories(cmake_example PUBLIC ${pybind11_INCLUDE_DIRS})

这串指令寻找pybind11库，定义一个共享库，并使用pybind11包装C++代码成Python模块。

setup.py

虽然项目强调CMake构建，但setup.py提供了传统的Python安装方式。它调用CMake来编译Python扩展：

from setuptools import setup, Extension
from setuptools.command.build_ext import build_ext
import pybind11

class CMakeBuild(build_ext):
    # Customized build command details...

setup(
    name="cmake_example",
    ext_modules=[Extension("cmake_example", sources=["src/cmake_example.cpp"],
                           language="cpp",
                           include_dirs=[pybind11.get_include()])],
    cmdclass={"build_ext": CMakeBuild},
)

此文件对习惯于Python生态的开发者提供便利，尽管实际的构建逻辑外包给了CMake。

---

以上就是关于cmake_example项目的基本结构、启动机制和核心配置的介绍。遵循这些指南，您可以轻松地理解和使用该项目来学习Pybind11与CMake结合的威力。