Python C API: 如何检查一个对象是否是一个类型的实例

Python C API: How to check if an object is an instance of a type

我想检查一个对象是否是某个 class 的实例。在 Python 中,我可以用 instanceof 做到这一点。在C/C++中,我发现了一个名为PyObject_IsInstance的函数。但它似乎不像 isinstance.

那样工作

详细说明(下面也描述为示例代码):

  1. 在 C++ 中,我定义了自定义类型 My。类型定义为MyType,对象定义为MyObject.
  2. MyType 添加到名称为 My 的导出模块。
  3. 在Python中创建一个新实例my = My(),并且isinstance(my, My)returnsTrue.
  4. 而在 C++ 中我们使用 PyObject_IsInstance(my, (PyObject*)&MyType) 来检查 my,而这个 returns 0,这意味着 my 不是 class 由 MyType.
  5. 定义

完整的 C++ 代码:

#define PY_SSIZE_T_CLEAN
#include <python3.6/Python.h>
#include <python3.6/structmember.h>
#include <stddef.h>

typedef struct {
    PyObject_HEAD
    int num;
} MyObject;

static PyTypeObject MyType = []{
    PyTypeObject ret = {
        PyVarObject_HEAD_INIT(NULL, 0)
    };
    ret.tp_name = "cpp.My";
    ret.tp_doc = NULL;
    ret.tp_basicsize = sizeof(MyObject);
    ret.tp_itemsize = 0;
    ret.tp_flags = Py_TPFLAGS_DEFAULT;
    ret.tp_new = PyType_GenericNew;
    return ret;
}();

// check if obj is an instance of MyType
static PyObject *Py_fn_checkMy(PyObject *obj) {
    if (PyObject_IsInstance(obj, (PyObject *)&MyType)) Py_RETURN_TRUE;
    else Py_RETURN_FALSE;
}

static PyMethodDef modmethodsdef[] = {
    { "checkMy", (PyCFunction)Py_fn_checkMy, METH_VARARGS, NULL },
    { NULL }
};

static PyModuleDef moddef = []{
    PyModuleDef ret = {
        PyModuleDef_HEAD_INIT
    };
    ret.m_name = "cpp";
    ret.m_doc = NULL;
    ret.m_size = -1;
    return ret;
}();

PyMODINIT_FUNC
PyInit_cpp(void)
{
    PyObject *mod;
    if (PyType_Ready(&MyType) < 0)
        return NULL;
    mod = PyModule_Create(&moddef);
    if (mod == NULL)
        return NULL;
    Py_INCREF(&MyType);
    PyModule_AddObject(mod, "My", (PyObject *)&MyType);
    PyModule_AddFunctions(mod, modmethodsdef);
    return mod;
}

将其编译成 cpp.so,并在 Python 中进行测试:

>>> import cpp
>>> isinstance(cpp.My(), cpp.My)
True
>>> cpp.checkMy(cpp.My())
False

METH_VARARGS

This is the typical calling convention, where the methods have the type PyCFunction. The function expects two PyObject* values. The first one is the self object for methods; for module functions, it is the module object. The second parameter (often called args) is a tuple object representing all arguments. This parameter is typically processed using PyArg_ParseTuple() or PyArg_UnpackTuple().

Py_fn_checkMy 的函数签名与此不匹配。它应该有两个参数。第一个是模块,这就是您要对照 MyType 检查的内容。第二个参数(您实际上并不接受)是一个包含您传递的对象的元组。您应该从元组中提取参数并检查其类型。

您最好使用 METH_O 指定单个参数,而不是从元组中提取参数:

static PyObject *Py_fn_checkMy(PyObject *self, PyObject *obj) {
    if (PyObject_IsInstance(obj, (PyObject *)&MyType)) Py_RETURN_TRUE;
    else Py_RETURN_FALSE;
}


static PyMethodDef modmethodsdef[] = {
    { "checkMy", (PyCFunction)Py_fn_checkMy, METH_O, NULL },
    { NULL }
};