Python知识点：如何使用PyBind11进行C++扩展

超哥同学

于 2024-09-28 09:19:21 发布

阅读量482

点赞数 21

分类专栏： Python系列文章标签： python c++ 开发语言面试编程

本文链接：https://blog.csdn.net/bifengmiaozhuan/article/details/142610526

版权

Python系列专栏收录该内容

124 篇文章 1 订阅

订阅专栏

开篇，先说一个好消息，截止到2025年1月1日前，翻到文末找到我，赠送定制版的开题报告和任务书，先到先得！过期不候！

使用PyBind11进行C++扩展的完整指南

PyBind11是一个轻量级的库，用于在C++和Python之间创建接口，使得Python代码可以方便地调用C++代码，同时保持C++的性能优势。本文将详细介绍如何使用PyBind11进行C++扩展，包括安装、基本使用、编译和示例。

一、PyBind11简介

PyBind11是一个header-only的库，这意味着你不需要编译或安装PyBind11的动态库或静态库，只需在C++代码中包含相应的头文件即可。PyBind11支持Python 2.7、Python 3.x和PyPy，并且具有高度的灵活性和性能。

二、安装PyBind11

PyBind11的安装非常简单，可以通过pip直接安装，或者从源代码编译。

通过pip安装

在命令行中运行以下命令：

pip install pybind11

从源代码安装

如果你希望从源代码安装PyBind11，可以访问其GitHub仓库：

git clone https://github.com/pybind/pybind11.git
cd pybind11
mkdir build
cd build
cmake ..
make install

注意：通常情况下，直接使用pip安装就足够了，因为PyBind11是header-only的，不需要编译安装。

三、基本使用

1. 暴露C++函数

首先，我们创建一个简单的C++函数，并使用PyBind11将其暴露给Python。

C++代码 (example.cpp):

#include <pybind11/pybind11.h
>
int add(int i, int j) {
    return i function + which j adds; two
 numbers}");


}namespace
 py```=
 py
bind###1 12;.
 
编译PYCBIND++1代码1
_
MODULE编译(Cexample++,代码 m时)， {需要
链接    m.def("add", &add, "APython的动态库，并确保包含PyBind11的头文件。

**编译命令 (Linux/macOS)**:

```bash
c++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) example.cpp -o example$(python3-config --extension-suffix)

注意：在Windows上，你需要使用CMake和MSVC（Microsoft Visual Studio）来编译，因为直接编译cpp文件需要加入PyBind11和Python的相关文件和库。

3. 在Python中使用

编译完成后，你可以在Python中导入并使用这个模块。

Python代码:

import example
print(example.add(2, 3))  # 输出: 5

四、暴露C++类

PyBind11还允许你暴露C++类给Python，使得Python代码可以创建和操作C++类的实例。

C++代码 (example.cpp):

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

class Pet {
public:
    Pet(const std::string& name) : name(name) {}
    void setName(const std::string& name_) { name = name_; }
    std::string getName() const { return name; }
private:
    std::string name;
};

namespace py = pybind11;

PYBIND11_MODULE(example, m) {
    py::class_<Pet>(m, "Pet")
        .def(py::init<const std::string&>())
        .def("setName", &Pet::setName)
        .def("getName", &Pet::getName);
}