pybind11教程

文章目录

pybind11教程
- 1. pybind11简介
- 2. cmake使用pybind11教程
- 3. pybind11的历史

1. pybind11简介

在这里插入图片描述
项目的GitHub地址为： pybind11

pybind11 是一个轻量级的头文件库，用于在 Python 和 C++ 之间进行互操作。它允许 C++ 代码被 Python 调用，反之亦然。

pybind11 的优点包括：

易于使用：pybind11 的 API 简单易懂，即使是初学者也可以快速上手。
高性能：pybind11 使用 C++ 的编译器来生成 Python 的 C 扩展，因此性能非常高。
跨平台：pybind11 支持 Windows、Linux 和 macOS。

pybind11 的使用方法非常简单。只需在 C++ 代码中包含 pybind11 头文件，然后使用 pybind11 提供的 API 来将 C++ 类型和函数暴露给 Python。

2. cmake使用pybind11教程

这部分代码开源在： GitHub pybind- example

cmake_minimum_required(VERSION 3.6)
project(py11_t VERSION 0.1.0 LANGUAGES C CXX)

# 下载pybind11的代码
# 声明 FetchContent 模块
include(FetchContent)

# 声明 pybind11 模块
FetchContent_Declare(
    pybind11
    GIT_REPOSITORY https://github.com/pybind/pybind11.git
    GIT_TAG v2.11.1
)

# 使 pybind11 模块可用
FetchContent_MakeAvailable(pybind11)

# 设置pybind11绑定的python版本
set(PYBIND11_PYTHON_VERSION "3.10·")

# pybind11相关的代码将会写入到core文件夹内
add_subdirectory(core)

实现一个 C++ 代码，然后通过 pybind11 包装给 python

#include"fun.hpp"
#include <pybind11/pybind11.h>
namespace py = pybind11;

PYBIND11_MODULE(cmake_example, m) {
    m.doc() = "pybind11 example plugin"; // optional module docstring
    // 该方法在"fun.hpp"中实现
    m.def("add", &add, "A function that adds two numbers");
    // 该方法在"fun.hpp"中实现
    m.def("sayHi", &sayHi, "say hi");
    // 该方法由lamada表达式形成匿名函数实现
    m.def("hi", [](int i,int j) {return i + j;}, "xxx")
}

之后将上述代码进行编译，编译后会在build文件夹内生成python对应的库：
在这里插入图片描述

这个库就是python需要的,将库所在的路径，加入到系统环境变量中，这样就可以在python中间进行调用了。

import os
import sys
sys.path.append("/Users/chendongsheng/github/py11/build/core")
sys.path.append("/Users/chendongsheng/github/py11/build/")
import cmake_example
cmake_example.sayHi()
print(cmake_example.hi(4,9))
print(cmake_example.add(1,2))