При написании обертки Cython для библиотеки С++ я столкнулся с ситуацией, когда он не понял, как правильно решить, когда удалять определенные экземпляры С++.
Библиотека С++ выглядит примерно так:
#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
, чтобы попытаться сломать цикл. Cython tp_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__
и делала ссылку на нее вручную.