[C/C++] cppimport：无缝集成Python与C++，提升混合编程开发效率

安装

开始使用 cppimport 之前，您需要通过 pip 进行安装。在终端或命令提示符中执行以下命令：

pip install cppimport

快速示例

下面我们通过一个简单示例，直观展示如何利用 cppimport 和 pybind11，直接从 Python 导入并使用 C++ 文件。

创建C++代码

首先，创建一个名为 somecode.cpp 的 C++ 文件，并写入以下代码：

// cppimport
#include <pybind11/pybind11.h>

namespace py = pybind11;

int square(int x) {
    return x * x;
}

PYBIND11_MODULE(somecode, m) {
    m.def("square", &square);
}

/*
<%
setup_pybind11(cfg)
%>
*/

导入并使用C++代码

现在，在 Python 解释器中导入这个 C++ 扩展：

import cppimport.import_hook
import somecode

# 调用C++函数从Python
somecode.square(9)

执行后您将看到输出 81 ，这证明 C++ 函数 square 已经被 Python 成功调用。至此，您已经通过 cppimport 和 pybind11 轻松将 C++ 代码集成到了 Python 环境中。

详细解析

顶部的注释

注释行 // cppimport 至关重要，它相当于一个“触发器”，告诉 cppimport 工具：接下来的代码片段需要被编译并作为 Python 扩展模块导入。如果缺少这行注释，cppimport 将不会处理这个文件。

主要逻辑

您 C++ 代码的核心部分，其写法与一个标准的 pybind11 扩展模版无异：引入 pybind11 头文件，然后定义您希望暴露给 Python 的函数（例如这里的 square 函数）。

配置块

在 somecode.cpp 文件的末尾，有一个由 <% 和 %> 包裹的配置块：

/*
<%
setup_pybind11(cfg)
%>
*/

这个配置块会在构建过程中被 cppimport 当作 Python 代码来执行。它允许您指定编译器参数、链接器选项、依赖关系等细节，以满足特定项目的编译需求，极大地增强了灵活性。

生产环境构建

在开发时，cppimport 的即时编译非常方便，但在生产部署环境中，您可能不希望每次启动都触发潜在的编译过程。为此，cppimport 提供了命令行工具来进行预编译：

python -m cppimport build

执行此命令会编译当前目录及其所有子目录中，所有包含 // cppimport 注释的 .c 和 .cpp 文件（假设其配置已正确设置）。这确保了生产环境中使用的是预先编译好的二进制模块。

生产环境优化

跳过校验码和二进制存在检查

为了进一步优化应用程序的启动性能，您可以配置 cppimport 跳过模块的校验和存在性检查，直接进入“发布模式”：

cppimport.settings['release_mode'] = True

警告：启用此模式前，请务必确认所有必需的二进制文件都已预先编译完成。否则，尝试导入缺失的模块将会导致运行时异常。

常见问题

到底发生了什么？

cppimport 的核心价值在于简化了 C++ 功能集成到 Python 应用的过程。它自动化了“编辑 C++ 源码 -> 编译 -> Python 导入”这个循环，让开发者能够像编辑纯 Python 脚本一样，无缝地同时修改和调试 Python 与 C++ 代码，从而大幅提升开发效率。

cppimport每次导入模块时都会重新编译吗？

不会。只有在第一次导入某个模块时，cppimport 才会执行编译操作。此后的导入操作不会触发重新编译，但工具会检查 C++ 源文件或其依赖项是否有更改。只有当检测到变化时，它才会在下一次导入时重新编译，以确保模块始终是最新的。

如何在一个扩展中使用多个源文件？

您可以在上述的配置块中，通过扩展 cfg['sources'] 列表来指定多个源文件。例如：

<%
cfg['sources'] = ['main.cpp', 'helper.cpp']
setup_pybind11(cfg)
%>

如何强制重新编译，即使检查码匹配？

如果您确信需要重新编译（例如依赖的系统库已更新），可以通过以下设置强制 cppimport 执行重建：

cppimport.settings['force_rebuild'] = True

我可以获取更详细的输出信息吗？

可以。cppimport 使用 Python 的标准日志模块。您可以通过为根日志记录器或特定的 cppimport 日志记录器添加处理器，来获得更详细的构建过程输出信息，便于调试。

总结

cppimport 是一款强大的开发利器，它允许开发者直接从 Python 导入 C++ 文件，打通了两种语言之间的壁垒。通过结合 cppimport、pybind11 等工具，开发者可以轻松地将现有 C/C++ 库集成到 Python 项目中，或者用 C++ 重写性能瓶颈函数，从而在享受 Python 开发高效率的同时，获得 C++ 的运行高性能。如果您在混合编程中遇到了效率或集成难题，不妨试试 cppimport，或许它能为您打开一扇新的大门。也欢迎您到 云栈社区 分享您的使用经验和技巧。

项目地址： https://github.com/tbenthompson/cppimport