boost::python 包装对象的 C++ 析构函数调用
C++ destructor calling of boost::python wrapped objects
boost::python 是否在 C++ 析构函数时提供任何保证
考虑到到达零的时刻,被包裹的对象被调用
相应 python 对象的引用计数?
我担心一个 C++ 对象打开文件进行写入并在其析构函数中执行文件关闭。当对象的所有 python 引用被删除或超出范围时,是否保证写入文件?
我的意思是:
A=MyBoostPythonObject()
del A # Is the C++ destructor of MyBoostPythonObject called here?
我的经验表明析构函数总是在此时被调用,但找不到任何保证。
Boost.Python 保证如果 Python 对象拥有被包装的 C++ 对象的所有权,那么当 Python 对象被删除时,被包装的 C++ 对象也将被删除。 Python 对象的生命周期由 Python 决定,其中当对象的引用计数达到零时,对象 可能 立即被销毁。对于非简单的情况,比如循环引用,对象会被垃圾回收器管理,可能在程序退出前被销毁
一个 Pythonic 解决方案可能是公开实现 context manager protocol 的类型。内容管理器协议由一对方法组成:一个在进入运行时上下文时调用,一个在退出运行时上下文时调用。通过使用上下文管理器,可以控制文件打开的范围。
>>> with MyBoostPythonObject() as A: # opens file.
... A.write(...) # file remains open while in scope.
... # A destroyed once context's scope is exited.
这里是一个示例demonstrating,将 RAII 类型 class 作为上下文管理器公开给 Python:
#include <boost/python.hpp>
#include <iostream>
// Legacy API.
struct spam
{
spam(int x) { std::cout << "spam(): " << x << std::endl; }
~spam() { std::cout << "~spam()" << std::endl; }
void perform() { std::cout << "spam::perform()" << std::endl; }
};
/// @brief Python Context Manager for the Spam class.
class spam_context_manager
{
public:
spam_context_manager(int x): x_(x) {}
void perform() { return impl_->perform(); }
// context manager protocol
public:
// Use a static member function to get a handle to the self Python
// object.
static boost::python::object enter(boost::python::object self)
{
namespace python = boost::python;
spam_context_manager& myself =
python::extract<spam_context_manager&>(self);
// Construct the RAII object.
myself.impl_ = std::make_shared<spam>(myself.x_);
// Return this object, allowing caller to invoke other
// methods exposed on this class.
return self;
}
bool exit(boost::python::object type,
boost::python::object value,
boost::python::object traceback)
{
// Destroy the RAII object.
impl_.reset();
return false; // Do not suppress the exception.
}
private:
std::shared_ptr<spam> impl_;
int x_;
};
BOOST_PYTHON_MODULE(example)
{
namespace python = boost::python;
python::class_<spam_context_manager>("Spam", python::init<int>())
.def("perform", &spam_context_manager::perform)
.def("__enter__", &spam_context_manager::enter)
.def("__exit__", &spam_context_manager::exit)
;
}
交互使用:
>>> import example
>>> with example.Spam(42) as spam:
... spam.perform()
...
spam(): 42
spam::perform()
~spam()
boost::python 是否在 C++ 析构函数时提供任何保证 考虑到到达零的时刻,被包裹的对象被调用 相应 python 对象的引用计数?
我担心一个 C++ 对象打开文件进行写入并在其析构函数中执行文件关闭。当对象的所有 python 引用被删除或超出范围时,是否保证写入文件?
我的意思是:
A=MyBoostPythonObject()
del A # Is the C++ destructor of MyBoostPythonObject called here?
我的经验表明析构函数总是在此时被调用,但找不到任何保证。
Boost.Python 保证如果 Python 对象拥有被包装的 C++ 对象的所有权,那么当 Python 对象被删除时,被包装的 C++ 对象也将被删除。 Python 对象的生命周期由 Python 决定,其中当对象的引用计数达到零时,对象 可能 立即被销毁。对于非简单的情况,比如循环引用,对象会被垃圾回收器管理,可能在程序退出前被销毁
一个 Pythonic 解决方案可能是公开实现 context manager protocol 的类型。内容管理器协议由一对方法组成:一个在进入运行时上下文时调用,一个在退出运行时上下文时调用。通过使用上下文管理器,可以控制文件打开的范围。
>>> with MyBoostPythonObject() as A: # opens file.
... A.write(...) # file remains open while in scope.
... # A destroyed once context's scope is exited.
这里是一个示例demonstrating,将 RAII 类型 class 作为上下文管理器公开给 Python:
#include <boost/python.hpp>
#include <iostream>
// Legacy API.
struct spam
{
spam(int x) { std::cout << "spam(): " << x << std::endl; }
~spam() { std::cout << "~spam()" << std::endl; }
void perform() { std::cout << "spam::perform()" << std::endl; }
};
/// @brief Python Context Manager for the Spam class.
class spam_context_manager
{
public:
spam_context_manager(int x): x_(x) {}
void perform() { return impl_->perform(); }
// context manager protocol
public:
// Use a static member function to get a handle to the self Python
// object.
static boost::python::object enter(boost::python::object self)
{
namespace python = boost::python;
spam_context_manager& myself =
python::extract<spam_context_manager&>(self);
// Construct the RAII object.
myself.impl_ = std::make_shared<spam>(myself.x_);
// Return this object, allowing caller to invoke other
// methods exposed on this class.
return self;
}
bool exit(boost::python::object type,
boost::python::object value,
boost::python::object traceback)
{
// Destroy the RAII object.
impl_.reset();
return false; // Do not suppress the exception.
}
private:
std::shared_ptr<spam> impl_;
int x_;
};
BOOST_PYTHON_MODULE(example)
{
namespace python = boost::python;
python::class_<spam_context_manager>("Spam", python::init<int>())
.def("perform", &spam_context_manager::perform)
.def("__enter__", &spam_context_manager::enter)
.def("__exit__", &spam_context_manager::exit)
;
}
交互使用:
>>> import example
>>> with example.Spam(42) as spam:
... spam.perform()
...
spam(): 42
spam::perform()
~spam()