使用python-c-api调用

时间:2016-07-29 07:04:10

标签: python c++ cython python-c-api

使用具有C库的eGige相机的控件,我已经开始使用cython代码project,并希望拥有每种语言的最佳功能。

该库提供了一种从相机监听心跳以了解它是否已断开连接的方法。我已经在C ++类中进行了回调,但是从这个C ++类中调用一个类的python方法正在以我所有的方式落入 Segmentation fault 试过。

我已将其封装在特定的C ++类中:

#include <Python.h>
/* (...) */
PyCallback::PyCallback(PyObject* self, const char* methodName)
{
  Py_XINCREF(self);
  _self = self;
  _method = PyObject_GetAttrString(self, methodName);
}
PyCallback::~PyCallback()
{
  Py_XDECREF(_self);
}
void PyCallback::execute()
{
  try
  {
    PyObject *args = PyTuple_Pack(1,_self);
    PyObject_CallFunctionObjArgs(_method, args);
  }catch(...){
    _error("Exception calling python");
  }
}

从一个cython对象代码是:

cdef class Camera(...):
    # (...)
    cdef registerRemovalCallback(self):
        cdef:
            PyCallback* obj
        obj = new PyCallback(<PyObject*> self, <char*> "cameraRemovalCallback")
    cdef cameraRemovalCallback(self):
        self._isPresent = False

在尝试准备参数时,回溯的最低部分。

#0  0x00007ffff7b24592 in PyErr_Restore () from /usr/lib64/libpython2.6.so.1.0
#1  0x00007ffff7b23fef in PyErr_SetString () from /usr/lib64/libpython2.6.so.1.0
#2  0x00007ffff7b314dd in ?? () from /usr/lib64/libpython2.6.so.1.0
#3  0x00007ffff7b313ca in ?? () from /usr/lib64/libpython2.6.so.1.0
#4  0x00007ffff7b316c1 in ?? () from /usr/lib64/libpython2.6.so.1.0
#5  0x00007ffff7b31d2f in ?? () from /usr/lib64/libpython2.6.so.1.0
#6  0x00007ffff7b31e9c in Py_BuildValue () from /usr/lib64/libpython2.6.so.1.0
#7  0x00007ffff637cbf8 in PyCallback::execute (this=0x16212a0) at pylon/PyCallback.cpp:53
#8  0x00007ffff6376248 in CppCamera::removalCallback (this=0x161fb30, pDevice=<value optimized out>) at pylon/Camera.cpp:387

我试图使用_Py_BuildValue(&#34;(自我)&#34;, self); 来制作参数但是我已经有 segfault 那里。

我还在参数字段中使用 PyObject_CallFunctionObjArgs NULL 进行了尝试,认为可能指向&#34; self &#34;已嵌入方法指向此对象中的特定地址。但他们在那里得到了 segfault

有人看到我的错误吗?那里的东西应该用不同的方式制作?我希望这是我个人对这个问题的误解。

更新 @ 2016/08/01

根据评论指示,代码中进行了两处修改:

首先, PyCallback 的指针存储已存储为 Camera cython类的成员:

cdef class Camera(...):
    cdef:
        #(...)
        PyCallback* _cbObj
    # (...)
    cdef registerRemovalCallback(self):
        self._cbObj = new PyCallback(<PyObject*> self, <char*> "cameraRemovalCallback")
    cdef cameraRemovalCallback(self):
        self._isPresent = False

即使这是段错误的基本来源,它看起来并没有涉及当前的错误。

然后在c ++中使用PyCallback :: execute(),我做了一些更改。在阅读了 GIL (Global Interpreter Lock)并添加了一些调用之后,我添加了一个可以指导解决方案的检查:

PyCallback::PyCallback(PyObject* self, const char* methodName)
{
  Py_Initialize();
  Py_XINCREF(self);
  _self = self;
  _method = PyObject_GetAttrString(self, methodName);
}

PyCallback::~PyCallback()
{
  Py_XDECREF(_self);
  Py_Finalize();
}

void PyCallback::execute()
{
  PyGILState_STATE gstate;

  gstate = PyGILState_Ensure();
  try
  {
    if ( PyCallable_Check(_method) )
    {
      _info("Build arguments and call method");
      PyObject *args = Py_BuildValue("(O)", _self);
      PyObject *kwargs = Py_BuildValue("{}", "", NULL);
      PyObject_Call(_method, args, kwargs);
    }
    else
    {
      _warning("The given method is not callable!");
    }
  }
  catch(...)
  {
    // TODO: collect and show more information about the exception
    _error("Exception calling python");
  }
  PyGILState_Release(gstate);
}

即使我不确定如何进行通话,主要的一点是_PyCallable_Check_返回false。

我还测试过使用 typedef 选项和 C 指针来使用相同的 segfault 结果来调用它。

更新 @ 2016/08/03

我已继续进行建议的修改。 cameraRemovalCallback现已从cdef更改为defif中的某些PyCallback报告现已找到该方法。如果在构造函数中找到它,~PyCallback()也会添加Py_XDECREF(_method)。无用的try-catch也已删除。

从提及Python's Object protocolDavidW引用,我检查了许多*Call*组合:落入段错误。

我认为这个问题变得并且正在出现论坛(问题 - >答案 - &gt;重播 - &gt; ...)。对此我感到很抱歉,下次我写信时,我会尝试告诉段错误已经解决,而且是什么原因。

1 个答案:

答案 0 :(得分:1)

我不承诺这是唯一的问题,但这肯定是 问题:

cameraRemovalCallbackcdef函数。这意味着该函数可以从C / Cython中纯粹访问,但不能从Python访问。这意味着PyObject_GetAttrString失败(因为cameraRemovalCallback不是Python属性)。

您应该使用cameraRemovalCallback而不是def来定义cdef,并且可以通过普通的Python机制访问它。您还应检查PyObject_GetAttrString的结果 - 如果它返回NULL,则表示找不到该属性。

因此,您最终尝试将NULL称为Python函数。

其他较小的问题:

您应该在_method中减少~PyCallback

您应该致电Py_InitializePy_Finalize。您似乎无论如何都要在Python中创建类,因此它不需要初始化或最终化。敲定肯定会给你带来麻烦。

我认为您不需要将self作为参数传递给PyObject_Call。 (虽然我可能错了)

Python C api不会引发C ++异常,所以你的try{} catch(...)永远不会抓到任何东西。而是检查返回值。

你需要将Py_BuildValue(当你完成它们)的两次调用的结果也减去PyObject_Call的结果。如果你不这样做,你就会泄漏记忆。

以下完整示例适用于我(使用Python 3.5 - 我无法使用早期版本轻松测试它)。如果它适合你,那么你可能需要确定你的情况有什么不同?如果它不适合你,那就更神秘了。

pycallback.hpp:

#include <Python.h>
#include <stdexcept>

inline PyObject* getCallable(PyObject* o, const char* methodName) {
    // assume o is not null
    PyObject* callable = PyObject_GetAttrString(o,methodName);
    if (callable == nullptr) {
        throw std::runtime_error("Attribute does not exist");
    }
    return callable;
}

class PyCallback {
private:
    PyObject* _callable;

public:
    PyCallback(PyObject* callable) {
        // assume callable isn't null
        if (!PyCallable_Check(callable)) {
            throw std::runtime_error("object passed to PyCallback is not callable");
        }
        _callable = callable;
        Py_XINCREF(_callable);
    }

    PyCallback(PyObject* o, const char* methodName) : 
    PyCallback(getCallable(o,methodName)) { // needs C++11 to compile
    }

    // don't define copy operators
    PyCallback(const PyCallback&) = delete;
    PyCallback& operator=(const PyCallback&) = delete;

    ~PyCallback() {
        Py_XDECREF(_callable);
    }

    void execute() {
        PyGILState_STATE gstate;
        gstate = PyGILState_Ensure();

        PyObject* result = PyObject_CallFunctionObjArgs(_callable,nullptr);

        Py_XDECREF(result); // allowed to be null
        PyGILState_Release(gstate);
    }
};

camera.pyx

cdef extern from "pycallback.hpp":
    cdef cppclass PyCallback:
        PyCallback(object) except +
        PyCallback(object, const char*) except +
        void execute()

cdef class Camera:
    cdef PyCallback* o
    cdef public ispresent

    def __init__(self):
        self.o = NULL
        self.ispresent = True

    def registerRemovalCallback(self):
        self.o = new PyCallback(self,'cameraRemovalCallback')
        #self.o = new PyCallback(self.cameraRemovalCallback)

    def cameraRemovalCallback(self):
        self.ispresent = False

    def triggerCallback(self):
        if self.o != NULL:
            self.o.execute()

setup.py

from distutils.core import setup
from distutils.extension import Extension
from Cython.Distutils import build_ext

setup(
    ext_modules = [
        Extension('camera',sources=["camera.pyx"],
            language="c++",
            extra_compile_args=['-std=c++11'])],
    cmdclass={'build_ext': build_ext})

test.py

import camera

c = camera.Camera()
print(c.ispresent)
c.triggerCallback()
print(c.ispresent)
c.registerRemovalCallback()
print(c.ispresent)
c.triggerCallback()
print(c.ispresent)

注意 - 这有一个小问题。 Camera和它所拥有的回调形成一个引用循环,因此它们永远不会被释放。这会导致内存泄漏,但不会导致分段错误。