使用 Ctypes 从 Python 传递一个 C 结构指针

Question

我有一个 yec.c 文件，它定义了一个具有两个函数的结构：

#include <python2.7/Python.h>

struct mec
{
    int age;
    int number;
};


static PyObject* nopoint(PyObject* self, PyObject* args)
{
    struct mec m;
    int n1, n2;

    if (!PyArg_ParseTuple(args, "ii", &n1, &n2))
        return NULL;

    printf("nopoint(c) nombres: %d et %d!\n", n1, n2);

    m.age = n1;
    m.number = n2;
    printf("nopoint(c) age nb: %d et %d!\n", m.age, m.number);
    return Py_BuildValue("i", n1 + n2);
}


static PyObject* viapoint(PyObject* self, PyObject* args)
{
    struct mec *m;

    if (!PyArg_ParseTuple(args, "o", &m))
        return NULL;

    printf("viapoint av(c) age nb: %d et %d!\n", m->age, m->number);

    m->age = 10;
    m->number = 1;
    printf("viapoint ap(c) age nb: %d et %d!\n", m->age, m->number);
    return Py_BuildValue("i", m->age + m->number);
}


static PyMethodDef MyYecMethods[] = {
    {"nopoint", nopoint, METH_VARARGS, "Description de fune"},
    {"viapoint", viapoint, METH_VARARGS, "Description de fdeux"},
    {NULL, NULL, 0, NULL}
};

PyMODINIT_FUNC
inityec(void)
{
    (void) Py_InitModule("yec", MyYecMethods);
}

我在以下 setup_yec.py 文件中使用python setup_yec.py build 命令将 yec.c 文件编译为 yec.so：

from distutils.core import setup, Extension

module1 = Extension('yec', sources = ['yec.c'])

setup (name = 'YecPkg',
        version = '1.0',
        description = 'This is a demo of yec pkg',
        ext_modules = [module1])

我可以在 Python 下使用我编译的库，并且 nopoint() 函数有效：

import yec
yec.nopoint(3, 4)

我想使用第二个功能；我的库的 viapoint() 应该接受来自 Python 的结构指针，我在其中定义了相关的 ctypes.Structure：

from ctypes import *

class Mec(Structure):
    _fields_ = [("age", c_int),
        ("number", c_int)]

m = Mec(1, 2)

print "py mec class", m.age, m.number

yec.viapoint(byref(m))

当然不行：

Traceback (most recent call last):
  File "testyec.py", line 18, in <module>
    yec.viapoint(byref(m))
TypeError: must be impossible<bad format char>, not CArgObject

如果有人知道如何修改 viapoint() 函数以便能够通过 PyArg_ParseTuple() 解析结构指针以及如何在 python 中传递 python 结构指针（使用 byref？），那将是一个很大的帮助。

谢谢。

Answer 1

您可以将 Structure 解析为读写缓冲区 ("w#")。通过将其作为参数传递，您可以放心，它是一个引用对象。它还确保传入的缓冲区是正确大小的可写内存。崩溃的 Python 是不可接受的。你应该在 Python 中得到异常。如果你的 Python 代码让解释器的段错误变得微不足道，那你就大错特错了。

static PyObject* viapoint(PyObject* self, PyObject* args)
{
    struct mec *m;
    size_t size;

    if (!PyArg_ParseTuple(args, "w#", &m, &size))
        return NULL;

    if (size != sizeof(struct mec)) {
        PyErr_SetString(PyExc_TypeError, "wrong buffer size");
        return NULL;
    }

    printf("viapoint av(c) age nb: %d et %d!\n", m->age, m->number);
    m->age = 10;
    m->number = 1;

    return Py_BuildValue("i", m->age + m->number);
}

Python：

from ctypes import *
import yec

class Mec(Structure):
    _fields_ = [
        ("age", c_int),
        ("number", c_int),
    ]

class Bad(Structure):
    _fields_ = [
        ("age", c_int),
        ("number", c_int),
        ("extra", c_int),
    ]

m = Mec(1, 2)
print yec.viapoint(m)

# TypeError
b = Bad(1, 2, 3)
print yec.viapoint(b)

---

如果您只接受一个地址作为参数，您的函数可能会在无效指针上出现段错误，或者只是返回垃圾或修改内存，这将使您的程序稍后以一种难以理解的方式崩溃。此外，通过解析地址，您需要有条件地定义在预处理器中是解析为long 还是long long，具体取决于void * 与long 相比的大小。例如，在 Win64 上，long 是 32 位的，将指针解析为 long 会截断它。最后，要求您首先在 Python 中调用 addressof 的 API 是一种低效的组合。

Answer 2

您需要使用 Python 脚本中的 ctypes.addressof，而不是 ctypes.byref（与 C 指针不同的对象），然后在 yec.c 中将输入值解析为 long（或 int 如果是 32 位）并将其分配给“struct mec *”。

请看下面的工作示例：

#include <python2.7/Python.h>

struct mec
{
    int age;
    int number;
};


static PyObject* nopoint(PyObject* self, PyObject* args)
{
    struct mec m;
    int n1, n2;

    if (!PyArg_ParseTuple(args, "ii", &n1, &n2))
        return NULL;

    printf("nopoint(c) nombres: %d et %d!\n", n1, n2);

    m.age = n1;
    m.number = n2;
    printf("nopoint(c) age nb: %d et %d!\n", m.age, m.number);
    return Py_BuildValue("i", n1 + n2);
}


static PyObject* viapoint(PyObject* self, PyObject* args)
{
    struct mec *m;

    if (!PyArg_ParseTuple(args, "l", &m))
        return NULL;

    printf("viapoint av(c) age nb: %d et %d!\n", m->age, m->number);

    m->age = 10;
    m->number = 1;
    printf("viapoint ap(c) age nb: %d et %d!\n", m->age, m->number);
    return Py_BuildValue("i", m->age + m->number);
}


static PyMethodDef MyYecMethods[] = {
    {"nopoint", nopoint, METH_VARARGS, "Description de fune"},
    {"viapoint", viapoint, METH_VARARGS, "Description de fdeux"},
    {NULL, NULL, 0, NULL}
};

PyMODINIT_FUNC
inityec(void)
{
    (void) Py_InitModule("yec", MyYecMethods);
}

在 Python 中：

from ctypes import *
import yec


class Mec(Structure):
    _fields_ = [
        ("age", c_int),
        ("number", c_int)]


m = Mec(1, 2)

print "py mec class", m.age, m.number

yec.viapoint(addressof(m))

运行它，我得到：

> python run.py                                                                                   
py mec class 1 2
viapoint av(c) age nb: 1 et 2!
viapoint ap(c) age nb: 10 et 1!