Python调用C,python call c,pybind11

本文详细介绍了如何将pybind11项目集成到C++项目中,包括克隆库、添加到CMakeLists.txt、编写接口cpp文件,以及处理编译和Python导入问题。最后,对比了Python和C++执行效率。


前言

通过https://github.com/pybind/pybind11项目实现Python调用C/C++代码


实现步骤

1.将pybind11 clone至当前项目下的extern目录下

git clone https://github.com/pybind/pybind11.git

2.在CmakeLists.txt中将pybind11项目包含

cmake_minimum_required(VERSION 3.10)

project(python_call_c)

# set(PYTHON_EXECUTABLE "/usr/bin/python3")
# set(PYTHON_INCLUDE_DIRECTORY "/usr/include/python3.10")

add_subdirectory(extern/pybind11)

pybind11_add_module(UserPythonModule test.cpp)

其中pybind11_add_module是由pybind11库提供的cmake宏,必须将pybind11项目包含后才会包含该宏。
UserPythonModule为Python导入模块的名字,test.cpp: 这是包含要绑定到 Python 的 C++ 代码的源文件

3.接口cpp文件格式

#include "extern/pybind11/include/pybind11/pybind11.h"

int add(int a, int b)
{
    return a + b;
}

PYBIND11_MODULE(UserPythonModule/* python module name */, m/*variable*/)
{
    m.doc() = "jslkdjf";    // optional module docstring
    // 定义模块内的函数
    m.def("add"/*module function name*/, &add/*bind with c func*/, "Afun"/*fun docstring*/);
}

第一行为导入的pybind11的头文件

  • PYBIND11_MODULE:头文件宏
  • m:参数,代表这个模块
  • m.doc(): 模块的docstring
  • m.def: 在模块内定义一个函数
    • “add”:函数名
    • &add:绑定到C的函数指针
    • function的docstring

4.编译

编译项目,在编译时可能会包找不到头文件<Python.h>,意味着编译器无法找到Python开发库的头文件。需要安装Python开发库

apt-get install python3-dev

编译:

mkdir build
cd build
cmake ..
make

编译好后会有一个名为UserPythonModule.cpython-310-x86_64-linux-gnu.so的库文件

5.导入Python使用

import UserPythonModule
UserPythonModule.add(4, 6)

6.性能比较

import UserPythonModule

import time

# 记录开始时间
start_time = time.time()

# 执行你的代码段
# 例如:
sum = 0
for i in range(10000000):
    sum += i

# 记录结束时间
end_time = time.time()

# 计算执行时间
execution_time = end_time - start_time

print("python 执行结果为:", sum, " 代码执行时间为:", execution_time, "秒")
print("-----------------")

start_time = time.time()
sum = UserPythonModule.add(10000000-1)
end_time = time.time()
execution_time = end_time - start_time
print("call C 执行结果为:", sum, " 代码执行时间为:", execution_time, "秒")

out:

python 执行结果为: 49999995000000  代码执行时间为: 0.4630615711212158 秒
-----------------
call C 执行结果为: 49999995000000  代码执行时间为: 0.006102561950683594 秒

pybind11项目地址

https://github.com/pybind/pybind11

<think>好的,用户现在想了解如何使用pybind11调用Python类,而之前的对话已经讨论了Pybind11支持的Python版本以及一些基本的调用Python函数的例子。用户现在需要更深入的内容,特别是关于类的调用。我需要结合用户提供的引用内容,特别是引用[1]、[2]、[3],其中引用[2]展示了一个调用Python函数的例子,但用户需要的是调用类,这可能涉及到创建类的实例、调用方法等。 首先,我需要回忆pybind11的相关知识。pybind11允许在C++中嵌入Python,并且可以操作Python对象。调用类的话,通常步骤是导入模块,获取类对象,然后实例化,最后调用方法。用户提供的引用[2]中的代码使用了py::module_::import来导入模块,然后获取函数属性,但类的话可能需要类似的方式,然后调用attr来获取类,再通过构造参数来实例化。 接下来,我需要构建一个示例,展示如何在C++调用Python类。例如,用户可能在Python中定义了一个类,然后在C++中导入该类,创建实例,并调用其方法。需要确保代码示例的正确性,比如使用正确的头文件、初始化解释器、处理异常等。 还要考虑CMakeLists.txt的配置,因为用户之前的引用[2]和[3]都涉及CMake的配置,需要确保用户能够正确编译项目。可能需要添加pybind11的路径,链接embed模块等。 另外,用户可能遇到的常见问题包括模块导入失败、实例化错误、方法调用参数不正确等,需要在说明中提及这些问题的解决方法,比如路径设置、Python解释器的初始化等。 需要参考用户之前的问题中的回答结构,确保结构清晰,分步骤说明,并包含代码示例和解释。同时,生成相关问题,帮助用户进一步探索,比如如何传递参数、处理异常、继承类等。 最后,确保所有数学公式和代码格式符合之前的系统级指令,使用正确的中文表达,引用标记正确。</think>### **Pybind11调用Python类完整实现** #### **1. 环境准备 - **Python类定义**:创建包含类定义的`.py`文件,例如`myclass.py`: ```python class MyPythonClass: def __init__(self, name: str): self.name = name def greet(self, prefix: str) -> str: return f"{prefix}, {self.name}!" @staticmethod def static_method(): return "This is a static method" ``` #### **2. C++调用Python类的核心步骤 ##### **(1) 初始化Python解释器** ```cpp #include <pybind11/embed.h> namespace py = pybind11; int main() { py::scoped_interpreter guard{}; // 初始化解释器 // ... } ``` ##### **(2) 导入模块并获取类对象** ```cpp py::module_ mymodule = py::module_::import("myclass"); py::object MyClass = mymodule.attr("MyPythonClass"); // 获取类引用 ``` ##### **(3) 实例化Python类** ```cpp // 直接构造实例 py::object instance1 = MyClass("Alice"); // 通过__call__方法构造实例 py::object instance2 = MyClass.attr("__call__")("Bob"); ``` ##### **(4) 调用类方法** ```cpp // 调用成员方法 std::string result1 = instance1.attr("greet")("Hello").cast<std::string>(); std::cout << result1 << std::endl; // 输出: Hello, Alice! // 调用静态方法 std::string result2 = MyClass.attr("static_method")().cast<std::string>(); std::cout << result2 << std::endl; // 输出: This is a static method ``` ##### **(5) 访问类属性** ```cpp instance1.attr("name") = "Carol"; // 修改属性 std::string name = instance1.attr("name").cast<std::string>(); std::cout << name << std::endl; // 输出: Carol ``` #### **3. 完整C++代码示例** ```cpp #include <pybind11/embed.h> #include <iostream> namespace py = pybind11; int main() { py::scoped_interpreter guard{}; try { // 导入模块和类 py::module_ mymodule = py::module_::import("myclass"); py::object MyClass = mymodule.attr("MyPythonClass"); // 实例化对象 py::object obj = MyClass("David"); // 调用方法 std::string greeting = obj.attr("greet")("Hi").cast<std::string>(); std::cout << greeting << std::endl; // 输出: Hi, David! // 调用静态方法 std::cout << MyClass.attr("static_method")().cast<std::string>() << std::endl; } catch (const py::error_already_set &e) { std::cerr << "Python错误: " << e.what() << std::endl; } return 0; } ``` #### **4. CMake配置关键点** ```cmake cmake_minimum_required(VERSION 3.12) project(call_python_class) add_subdirectory(pybind11) # 假设pybind11源码在项目目录下 add_executable(main main.cpp) target_link_libraries(main PRIVATE pybind11::embed ) ``` #### **5. 运行注意事项** 1. **Python路径设置**: 确保C++程序能定位到`myclass.py`,可通过以下方式之一: ```cpp Py_SetPythonHome(L"/path/to/python"); // 设置Python环境路径 py::module_::import("sys").attr("path").attr("append")("/path/to/scripts"); ``` 2. **异常处理**: 使用`try-catch`捕获`py::error_already_set`异常,避免Python错误导致C++崩溃。 3. **对象生命周期**: Python对象在离开作用域后会自动释放,若需长期持有对象,需用`py::object`保存。 --- ### **高级用法示例** #### **继承Python类** ```cpp // 定义C++类继承Python类 struct CppDerived : public py::object { using py::object::object; void cpp_method() { std::cout << "C++调用Python基类方法: " << this->attr("greet")("Bonjour").cast<std::string>() << std::endl; } }; // 主函数中实例化 py::object base = MyClass("Eve"); CppDerived derived(base); derived.cpp_method(); // 输出: Bonjour, Eve! ``` --- ### **常见问题解决** | 问题现象 | 解决方案 | |-------------------------------|--------------------------------------------------------------------------| | `ImportError: No module named 'myclass'` | 添加`sys.path.append("/脚本所在路径")`到C++代码[^2] | | `TypeError: MyPythonClass() takes 1 positional argument but 2 were given` | 检查Python类的`__init__`方法参数匹配性 | | 段错误(Segmentation Fault) | 确保`py::scoped_interpreter`在访问Python API前已初始化[^3] | --- ### **相关问题** 1. **如何在C++中捕获Python类的异常?** 2. **如何将C++对象传递给Python类方法?** 3. **Pybind11调用Python类时如何处理线程安全问题?** [^1]: 示例代码参考了Pybind11官方文档中关于嵌入Python解释器的实现方式。 [^2]: 路径问题在跨平台开发中需特别注意,Windows需使用`L"路径"`格式。 [^3]: `scoped_interpreter`会在析构时自动关闭Python解释器,避免资源泄漏。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值