Python和C++混合编程指南.pdfVIP

Python和C++混合编程指南

目录

Python和C++混合编程指南

第1篇函数2

第2篇构建9

第3篇Pybind11面向对象特性

第4篇使用Pybind11加速：小例子

第5篇Pybind11HelloWorld

第6篇Pybind11简介

第1篇函数

第1篇函数

本文使用ZhihuOnVSCode创作并发布

本篇内容基于官方文档。

返回值策略(returnvaluepolicies)

Python和C++使用不同的内存管理策略（Python使用引用计数，C++则是自己管理内存），因

此，当C++函数返回一个non-trivialtype时，可能会出现问题。单看返回值，Python方不

知道是否该接管返回值的内存管理。因此，pybind11允许你使用返回值策略来指定不同的行为，

默认的策略是return_value_policy::automatic。

/*Functiondeclaration*/

Data*get_data(){return_data;/*(pointertoastaticdatastructure)*/}

...

/*Bindingcode*/

m.def(get_data,get_data);//--KABOOM,willcausecrashwhencalledfrom

Python

以上是一个会出问题的代码例子，当在Python中使用getData()时，返回的指针会被包装成

(wrapped)一个Python类型，默认的return_value_policy::automatic会使得Python获得其

所有权(ownership)。

当Python的垃圾回收机制删除wrapper类型时，也会同时在C++方调用delete操作。这时

由于删除一个指针两次，程序会可能崩溃。

这时，需要指定返回值策略return_value_policy::reference，这样，Python只是管理一个引

用，不会获得所有权。

m.def(getData,getData,return_value_policy::reference);

相反，当Python该获得所有权时使用return_value_policy::reference则会导致资源泄露。

因此，使用者需要根据场景指定不同的返回值策略，保证程序能正常运行。

返回值策略描述

return_value_policy::take_ownership以引用形式返回数据（不会复制），并获得所有权。当引

用计数降到0时，Python方会调用析构器和delete操作。如果C++方也这样做，会导致未定

义行为。

return_value_policy::copy以复制形式返回数据（会进行复制)，并交由Python方全权管理。

这种方式相比而言较为安全，因为Python方和C++方拥有不同的实例，双方的生命周期是解耦

的。

return_value_policy::move以std::move返回数据，并由Python管理。由于数据被移动到了

Python的实例，这种方式也较为安全。

第1页/共25页

第1篇函数

return_value_policy::reference以引用形式返回数据，但并不获得所有权。C++方会负责资源

的回收和释放。但注意，如果Python还在使用而C++已经释放了资源，则会导致未定义行为。

return_value_policy::reference_internal返回值与其父亲对象(this或self)绑定在一起。这

种模式有点像return_value_policy::reference，加上keep_alive0,1调用策略。在这种策

略下，只要这个返回值还在使