在为 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
。
我编写的 Cython 包装器如下所示:
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
像这样构建 Python 构建后:
$ cython --cplus somelib.pyx
$ g++ -I/usr/include/python2.6 -L/usr/lib somelib.cpp -shared -o somelib.so
$
在微不足道的情况下,它似乎有效:
$ 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
. 但是,一旦涉及到 Python 垃圾收集,tp_clear
Cython 构造的函数就会搞砸PySprocket
:
$ 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
来尝试打破循环。Cythontp_clear
删除了对 Python 对象的所有引用。只有在这种情况发生后PySprocket.__dealloc__
才能运行。
Cython 文档发出警告__dealloc__
(尽管我花了一段时间才知道它在谈论什么条件,因为它没有详细说明)。所以也许这种方法是完全无效的。
Cython 可以支持这个用例吗?
作为(我希望是)一个临时的解决方法,我已经转向一种看起来像这样的方法:
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 的引用,使其在 中仍然有效__dealloc__
,并手动对其进行引用计数。