python - 将结构数组从 Python 传递到 C

Question

[更新:问题已解决!见帖子底部]

我需要允许 python 开发人员将一组打包数据(在本例中为顶点)传递到我的 API，这是一系列通过 Python C API 手动公开的 C++ 接口(interface)。我对此的最初印象是使用 ctypes Structure 类来允许这样的接口(interface):

class Vertex(Structure):
_fields_ = [
    ('x', c_float),
    ('y', c_float),
    ('z', c_float),
    ('u', c_float),
    ('v', c_float),
    ('color', c_int)
] 

verts = (Vertex * 3)()
verts[0] = Vertex(0.0, 0.5, 0.0, 0.0, 0.5, 0xFF0000FF)
verts[1] = Vertex(0.5, -0.5, 0.0, 0.5, -0.5, 0x00FF00FF)
verts[2] = Vertex(-0.5, -0.5, 0.0, -0.5, -0.5, 0x0000FFFF)

device.ReadVertices(verts, 3) # This is the interfaces to the C++ object

我要传递给的函数具有以下签名:

void Device::ReadVertices(Vertex* verts, int count);

Python 包装器看起来像这样:

static PyObject* Device_ReadVertices(Py_Device* self, PyObject* args)
{
    PyObject* py_verts;
    int count;

    if(!PyArg_ParseTuple(args, "Oi", &py_verts, &count)) 
        return NULL;

    // This Doesn't Work!
    Vertex* verts = static_cast<Vertex*>(PyCObject_AsVoidPtr(py_verts));

    self->device->ReadVertices(verts, count);

    Py_RETURN_NONE;
}

当然，我遇到的最大问题是:我可以检索结构的 PyObject，但我不知道如何将它转换为正确的类型。上面的代码惨遭失败。那么我将如何允许用户从 Python 向我传递这种数据呢？

现在，需要考虑几件事:首先，我已经编写了相当多的 Python/C++ 层，并且对此非常满意(我离开了 SWIG，因此我可以获得更大的灵 active )。我不想重新编码它，所以我更喜欢一个可以在本地使用 C API 的解决方案。其次，我确实打算在我的 C++ 代码中预先定义 Vertex 结构，所以我不想让用户需要在 Python 中重新定义它(这样可以减少错误)，但我不确定如何公开这样的连续结构。第三，除了不知道另一种方法之外，我没有理由尝试 ctypes 结构。欢迎提出任何建议。最后，由于这是(正如您可能已经猜到的)图形应用程序，我更喜欢更快的方法而不是方便的方法，即使更快的方法需要更多的工作。

感谢您的帮助!我仍在摸索 python 扩展，因此在一些棘手的部分获得社区意见是一个很大的帮助。

[解决方案]

首先，感谢所有提出想法的人。最终的答案是由很多小花絮组成的。最后，这是我的发现:Sam 关于使用 struct.pack 的建议最终物有所值。看到我使用的是 Python 3，我不得不稍微调整它，但是当一切都说完之后，我的屏幕上实际上出现了一个三角形:

verts = bytes()
verts += struct.pack("fffffI", 0.0, 0.5, 0.0, 0.0, 0.5, 0xFF0000FF)
verts += struct.pack("fffffI", 0.5, -0.5, 0.0, 0.5, -0.5, 0x00FF00FF)
verts += struct.pack("fffffI", -0.5, -0.5, 0.0, -0.5, -0.5, 0x0000FFFF)

device.ReadVertices(verts, 3)

我的元组解析现在看起来像这样:

static PyObject* Device_ReadVertices(Py_Device* self, PyObject* args)
{
    void* py_verts;
    int len, count;

    if(!PyArg_ParseTuple(args, "y#i", &py_verts, &len, &count)) 
        return NULL;

    // Works now!
    Vertex* verts = static_cast<Vertex*>(py_verts);

    self->device->ReadVertices(verts, count);

    Py_RETURN_NONE;
}

请注意，即使我在这个示例中没有使用 len 变量(尽管我会在最终产品中使用)，但我需要使用 'y#' 而不是仅使用 'y' 来解析元组' 否则它将在第一个 NULL 处停止(根据文档)。还要考虑:像这样的 void* 转换非常危险，所以请做比我在这里展示的更多的错误检查!

那么，干得好，快乐的一天，收拾行李回家，是吗？

等等!没那么快!还有更多!

我对这一切的结果感到满意，我一时兴起，决定看看我之前的尝试是否仍然对我不利，并恢复到这篇文章中的第一个 python 片段。 (当然是使用新的 C 代码)而且……它成功了!结果与 struct.pack 版本相同!哇!

因此，这意味着您的用户可以选择他们将如何提供此类数据，并且您的代码可以在不进行任何更改的情况下处理这两种数据。就个人而言，我将鼓励使用 ctype.Structure 方法，因为我认为它更易于阅读，但实际上它是用户喜欢的任何东西。 (哎呀，如果他们愿意的话，他们可以手动输入十六进制的字节串。它有效。我试过了。)

老实说，我认为这是最好的结果，所以我欣喜若狂。再次感谢大家，祝其他遇到此问题的人好运!

Answer 1

未经测试，但您应该尝试一下，如果它的速度足以满足您的需求，请告诉我们。

在 python 端，将顶点打包成字符串而不是对象。

str = "" # byte stream for encoding data
str += struct.pack("5f i", vert1.x, vert1.y, vert1.z, vert1.u, vert1.v, vert1.color) # 5 floats and an int
# same for other vertices

device. ReadVertices( verts, 3) # send vertices to C library

在 C 库/python 包装器上，修改 PyArgs_ParseTuple 以使用格式字符串 "si"。这会将您的 python 字符串转换为 C 字符串 (char*)，然后您可以将其类型转换为指向向量结构的指针。此时，C 字符串是字节/字/ float 流，应该就是您要查找的内容。

祝你好运!