Pybind11技术咨询：PYBIND11_MODULE代码应放置在何处？

我来帮你理清这个问题——拆分Test类到头文件和实现文件后，PYBIND11_MODULE的放置其实很灵活，核心是要兼顾代码可维护性和编译逻辑，下面是几种常见的合理方案：

1. 放在单独的绑定源码文件中（最推荐） #

新建一个专门的绑定文件，比如test_bindings.cpp，把绑定逻辑和业务代码完全分离，这是大型项目的标准做法，后续维护起来特别清晰。

示例代码：

// test_bindings.cpp
#include <pybind11/pybind11.h>
#include "Test.h"

namespace py = pybind11;

PYBIND11_MODULE(test_module, m) {
    m.doc() = "绑定Test类的模块"; // 可选的模块文档
    
    py::class_<Test>(m, "Test")
        .def(py::init<>()) // 绑定构造函数
        .def("your_method", &Test::your_method) // 绑定成员函数
        .def_readwrite("your_member", &Test::your_member); // 绑定成员变量
}

编译时只需把Test.cpp、test_bindings.cpp以及嵌入Python的主程序文件一起编译链接即可，逻辑清晰，互不干扰。

2. 放在Test.cpp文件末尾 #

如果你的项目很小，不想额外增加文件数量，也可以直接把PYBIND11_MODULE写在Test.cpp的最后。因为Test.cpp本身已经包含了类的实现，不需要额外引入头文件，写起来很省事。

示例代码：

// Test.cpp
#include "Test.h"

// Test类的实现代码
void Test::your_method() {
    // ...业务逻辑
}

// 绑定代码放在文件末尾
#include <pybind11/pybind11.h>
namespace py = pybind11;

PYBIND11_MODULE(test_module, m) {
    py::class_<Test>(m, "Test")
        .def(py::init<>())
        .def("your_method", &Test::your_method);
}

这种方式适合小型Demo或快速原型，但项目规模变大后，业务代码和绑定代码混在一起会降低可读性。

3. 放在嵌入Python的主程序文件中 #

如果你的嵌入逻辑和绑定逻辑联系特别紧密，也可以把PYBIND11_MODULE直接写在启动Python解释器的主文件里。需要注意的是，主文件必须包含Test.h，编译时要把Test.cpp一起链接进来。

示例代码：

// main.cpp（嵌入Python的主文件）
#include <pybind11/embed.h>
#include "Test.h"

namespace py = pybind11;

// 绑定代码
PYBIND11_MODULE(test_module, m) {
    py::class_<Test>(m, "Test")
        .def(py::init<>())
        .def("your_method", &Test::your_method);
}

int main() {
    py::scoped_interpreter guard{}; // 初始化Python解释器
    
    // 导入绑定的模块并使用Test类
    auto test_module = py::module_::import("test_module");
    auto Test = test_module.attr("Test");
    auto test_obj = Test();
    test_obj.attr("your_method")();
    
    return 0;
}

这种方式适合快速验证功能，但项目复杂后会让主文件显得臃肿，不推荐长期使用。

额外注意点 #

• 无论选择哪种方案，编译时都要确保所有相关的.cpp文件（Test.cpp、绑定文件、主程序文件）都被包含在编译命令中，并且正确链接pybind11的库。
• 如果使用CMake构建，可以用pybind11_add_module来处理绑定模块，或者把相关源文件添加到可执行目标的源列表里。

内容的提问来源于stack exchange，提问作者Simerax