在为C ++库编写Cython包装器时,我遇到了一个不清楚如何正确决定何时删除某些C ++实例的情况。
C ++库看起来像这样:
#include <stdio.h>
#include <string.h>
class Widget {
char *name;
public:
Widget() : name(strdup("a widget")) {}
~Widget() { printf("Widget destruct\n"); }
void foo() { printf("Widget::foo %s\n", this->name); }
};
class Sprocket {
private:
Widget *important;
public:
Sprocket(Widget* important) : important(important) {}
~Sprocket() { important->foo(); }
};
此库的一个重要方面是Sprocket
析构函数使用了Widget*
,因此Widget
必须在Sprocket
之后才能销毁cdef extern from "somelib.h":
cdef cppclass Widget:
pass
cdef cppclass Sprocket:
Sprocket(Widget*)
cdef class PyWidget:
cdef Widget *thisptr
def __init__(self):
self.thisptr = new Widget()
def __dealloc__(self):
print 'PyWidget dealloc'
del self.thisptr
cdef class PySprocket:
cdef PyWidget widget
cdef Sprocket *thisptr
def __init__(self, PyWidget widget):
self.widget = widget
self.thisptr = new Sprocket(self.widget.thisptr)
def __dealloc__(self):
print 'PySprocket dealloc with widget', self.widget
del self.thisptr
我写的Cython包装器看起来像这样:
$ cython --cplus somelib.pyx
$ g++ -I/usr/include/python2.6 -L/usr/lib somelib.cpp -shared -o somelib.so
$
在构建Python构建之后:
$ python -c 'from somelib import PyWidget, PySprocket
spr = PySprocket(PyWidget())
del spr
'
PySprocket dealloc with widget <somelib.PyWidget object at 0xb7537080>
Widget::foo a widget
PyWidget dealloc
Widget destruct
$
在琐碎的案例中,似乎有效:
cdef Widget
PyWidget
字段使PySprocket.__dealloc__
保持活跃状态,直到Sprocket
销毁tp_clear
为止。但是,一旦收集到Python垃圾,PySprocket
函数Cython为$ python -c 'from somelib import PyWidget, PySprocket
class BadWidget(PyWidget):
pass
widget = BadWidget()
sprocket = PySprocket(widget)
widget.cycle = sprocket
del widget
del sprocket
'
PyWidget dealloc
Widget destruct
PySprocket dealloc with widget None
Widget::foo ��h�
构造就会混淆:
tp_clear
由于存在引用循环,垃圾收集器会调用tp_clear
来尝试打破循环。 Cython的PySprocket.__dealloc__
删除了对Python对象的所有引用。只有在这种情况发生后cdef class PySprocket:
cdef void *widget
cdef Sprocket *thisptr
def __init__(self, PyWidget widget):
Py_INCREF(widget)
self.widget = <void*>widget
self.thisptr = new Sprocket(self.widget.thisptr)
def __dealloc__(self):
del self.thisptr
Py_DECREF(<object>self.widget)
才能运行。
Cython文档warns about __dealloc__
(虽然我花了一些时间来了解它所讨论的条件,因为它没有详细说明)。所以也许这种方法完全无效。
Cython可以支持这个用例吗?
作为(我希望是)临时解决方案,我已经采用了一种看起来像这样的方法:
__dealloc__
换句话说,隐藏Cython中的引用,使其在{{1}}中仍然有效,并手动对其进行引用计数。
答案 0 :(得分:5)
cdef extern from "somelib.h":
cdef cppclass Widget:
pass
cdef cppclass Sprocket:
Sprocket(Widget*)
cdef class PyWidget:
cdef Widget *thisptr
cdef set sprockets
def __init__(self):
self.thisptr = new Widget()
self.sprockets = set()
def __dealloc__(self):
print 'PyWidget dealloc'
#PyWidget knows the sprockets and notifies them on destroy
sprockets_to_dealloc = self.sprockets.copy()
#with this solution spr items can call back to detach
for spr in sprockets_to_dealloc:
del spr
del self.thisptr
def attach(PySprocket spr):
print 'PySprocket attach'
self.sprockets.add(spr)
def detach(PySprocket spr):
print 'PySprocket detach'
self.sprockets.remove(spr)
cdef class PySprocket:
cdef PyWidget widget
cdef Sprocket *thisptr
def __init__(self, PyWidget widget):
self.thisptr = new Sprocket(widget.thisptr)
#You should be sure here that the widget exists
widget.attach(self)
self.widget = widget
def __dealloc__(self):
self.widget.detach(self)
del self.thisptr
我稍后回来检查我写的是什么,因为我很累, 但重要的是:关键在于你 想要在销毁Widget时通知Sprockets,反之亦然。
这是一个通用的解决方案,可以调整。
你还必须包含错误处理,我绝对会跳过它。 与垃圾收集器无关,代码中存在设计问题。
修改强>
这些代码是等同的:
甲
class BadWidget(PyWidget):
pass
widget = BadWidget()
sprocket = PySprocket(widget)
widget.cycle = sprocket ###1
del widget ###2
del sprocket
乙
class BadWidget(PyWidget):
pass
widget = BadWidget()
sprocket = PySprocket(widget)
sprocket.widget.cycle = sprocket ###1
del sprocket.widget ###2
del sprocket
###2
将调用sprocket.widget.__deallocate__()
并且它不会释放sprocket.widget.cycle
,因此链接符将在窗口小部件中存活