pybind11—类，结构体

前言

在C++代码中， 类(class)的使用频率非常高, 类将数据和对数据的操作方法封装在一起，使得代码的抽象层次增加。如何将C++中定义好的类在python中调用?下面举例简单说明。

开发/测试环境

windows 10, 64bit
Anaconda3, with python 3.7
pycharm
visaul studio 2017

示例一

定义一个简单的类

class Student {

public:
    std::string name;
    std::string gender;
    int age;

public:
    Student() {}
    Student(std::string name, std::string gender, int age) {
        this->name = name;
        this->gender = gender;
        this->age = age;
    }
    ~Student() {};

public:
    //setter
    void setName(std::string name) {
        this->name = name;
    }

    void setGender(std::string gender) {
        this->gender = gender;
    }

    void setAge(int age) {
        this->age = age;
    }

    //getter
    std::string getName() {
        return this->name;
    }

    std::string getGender() {
        return this->gender;
    }

    int getAge() {
        return this->age;
    }

};

编写python扩展



PYBIND11_MODULE(example, m) {
    // Studnet
    py::class_<Student>(m, "Student")
        .def(py::init<std::string, std::string, int>())
        .def("setName", &Student::setName)
        .def("setGender", &Student::setGender)
        .def("setAge", &Student::setAge)
        .def("getName", &Student::getName)
        .def("getGender", &Student::getGender)
        .def("getAge", &Student::getAge);

}

编译生成python扩展

image.png

测试代码

image.png

静态方法

image.png

代码

class Student {

public:
    std::string name;
    std::string gender;
    int age;
    
public:
    Student() {}
    Student(std::string name, std::string gender, int age) {
        this->name = name;
        this->gender = gender;
        this->age = age;
    }
    ~Student() {};

public:
    //setter
    void setName(std::string name) {
        this->name = name;
    }

    void setGender(std::string gender) {
        this->gender = gender;
    }

    void setAge(int age) {
        this->age = age;
    }

    //getter
    std::string getName() {
        return this->name;
    }

    std::string getGender() {
        return this->gender;
    }

    int getAge() {
        return this->age;
    }

public:
    //声明静态成员
    static std::string university;

    // static method
    static std::string getUniversity() {
        return university;
    }

};

// 定义并且初始化static变量
std::string Student::university = "Xidian University";

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

    // Studnet
    py::class_<Student>(m, "Student")
        .def(py::init<std::string, std::string, int>())
        .def("setName", &Student::setName)
        .def("setGender", &Student::setGender)
        .def("setAge", &Student::setAge)
        .def("getName", &Student::getName)
        .def("getGender", &Student::getGender)
        .def("getAge", &Student::getAge)
        .def_static("getUniversity", &Student::getUniversity);  //def_static() 静态方法

}

image.png

例子2

定义一个Person类, 包含：

无参构造函数
含参构造函数
private成员变量
public成员变量
static静态成员变量
static静态函数
setter/getter函数


class Person
{

public:
    std::string habbit;             //兴趣爱好

private:
    std::string name;               //姓名
    std::string gender;             //性别
    int age;                        //年龄
    std::string idCardNum;          //身份证号码
    std::string address;            //住址

public:
    void setName(std::string name) {
        this->name = name;
    }

    void setAge(int age) {
        this->age = age;
    }

    void setGender(std::string gender) {
        this->gender = gender;
    }

    void setAddress(std::string address) {
        this->address = address;
    }

    void setIdCardNum(std::string idCardNum) {
        this->idCardNum = idCardNum;
    }

    std::string getName() {
        return this->name;
    }

    std::string getGender() {
        return this->gender;
    }

    int getAge() {
        return this->age;
    }

    std::string getAddress() {
        return this->address;
    }

    std::string getIdCardNum() {
        return this->idCardNum;
    }


public:
    //
    static std::string university;
    static std::string getUniversity() {
        return university;
    }

public:
    Person() {};
    Person(std::string name, std::string gender, int age) {
        this->name = name;
        this->gender = gender;
        this->age = age;
    }
    ~Person() {};

};

std::string Person::university = "xidian University";

python扩展代码

def(py::init()) python中构造方法，无参数
.def(py::init<std::string, std::string, int>()) 构造方法，含参数
.def("setName", &Person::setName) set()方法
.def("getName", &Person::getName) get()方法
.def_static("getUniversity", &Person::getUniversity) static静态方法
.def_readonly_static("university", &Person::university) static静态只读成员
.def_readwrite("habbit", &Person::habbit) 可读可写成员

对于C++ class中private成员：

image.png

.def_property("name", &Person::getName, &Person::setName)
        .def_property("age", &Person::getAge, &Person::setAge)
        .def_property("gender", &Person::getGender, &Person::setGender)
        .def_property("address", &Person::getAddress, &Person::setAddress)
        .def_property("idCardNum", &Person::getIdCardNum, &Person::setIdCardNum);

完整代码

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

namespace py = pybind11;

class Person
{

public:
    std::string habbit;             //兴趣爱好

private:
    std::string name;               //姓名
    std::string gender;             //性别
    int age;                        //年龄
    std::string idCardNum;          //身份证号码
    std::string address;            //住址

public:
    void setName(std::string name) {
        this->name = name;
    }

    void setAge(int age) {
        this->age = age;
    }

    void setGender(std::string gender) {
        this->gender = gender;
    }

    void setAddress(std::string address) {
        this->address = address;
    }

    void setIdCardNum(std::string idCardNum) {
        this->idCardNum = idCardNum;
    }

    std::string getName() {
        return this->name;
    }

    std::string getGender() {
        return this->gender;
    }

    int getAge() {
        return this->age;
    }

    std::string getAddress() {
        return this->address;
    }

    std::string getIdCardNum() {
        return this->idCardNum;
    }


public:
    //
    static std::string university;
    static std::string getUniversity() {
        return university;
    }

public:
    Person() {};
    Person(std::string name, std::string gender, int age) {
        this->name = name;
        this->gender = gender;
        this->age = age;
    }
    ~Person() {};

};

std::string Person::university = "xidian University";


PYBIND11_MODULE(demo3, m) {

    m.doc() = "Simple Class";
    
    py::class_<Person>(m, "Person")
        .def(py::init())
        .def(py::init<std::string, std::string, int>())
        .def("setName", &Person::setName)
        .def("setAge", &Person::setAge)
        .def("setGender", &Person::setGender)
        .def("setAddress", &Person::setAddress)
        .def("getName", &Person::getName)
        .def("getAge", &Person::getAge)
        .def("getGender", &Person::getGender)
        .def("getAddress", &Person::getAddress)
        .def_static("getUniversity", &Person::getUniversity)
        .def_readonly_static("university", &Person::university)
        .def_readwrite("habbit", &Person::habbit)
        .def_property("name", &Person::getName, &Person::setName)
        .def_property("age", &Person::getAge, &Person::setAge)
        .def_property("gender", &Person::getGender, &Person::setGender)
        .def_property("address", &Person::getAddress, &Person::setAddress)
        .def_property("idCardNum", &Person::getIdCardNum, &Person::setIdCardNum);


}

在pycharm中测试

将vs生成的lib和pyd文件复制到python代码所在目录，直接import即可：

image.png

python代码

person1 = demo3.Person()
person1.name = 'tianyu'
person1.age = 23
person1.gender = 'female'
print(person1.getName())
print(person1.getAge())
print(person1.getGender())
print(person1.university)

测试结果

image.png

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 193,968评论 5赞 459
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 81,682评论 2赞 371
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 141,254评论 0赞 319
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 52,074评论 1赞 263
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 60,964评论 4赞 355
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 46,055评论 1赞 272
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 36,484评论 3赞 381
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 35,170评论 0赞 253
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 39,433评论 1赞 290
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 34,512评论 2赞 308
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 36,296评论 1赞 325
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 32,184评论 3赞 312
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 37,545评论 3赞 298
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 28,880评论 0赞 17
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 30,150评论 1赞 250
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 41,437评论 2赞 341
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 40,630评论 2赞 335

pybind11—类，结构体

前言

开发/测试环境

示例一

例子2

在pycharm中测试

推荐阅读更多精彩内容