[更新:问题解决了!见文章底部]
我需要允许 python 开发人员将一组打包数据(在本例中为顶点)传递到我的 API,这是通过 Python C API 手动公开的一系列 C++ 接口。我对此的最初印象是使用 ctypes Structure 类来允许这样的接口:
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,因此我可以拥有更多的灵活性)。我不想重新编码,所以我更喜欢原生使用 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 方法,因为我认为它更易于阅读,但实际上它是用户喜欢的任何东西。(哎呀,如果他们愿意,他们可以手动输入十六进制的字节字符串。它有效。我试过了。)
老实说,我认为这是最好的结果,所以我欣喜若狂。再次感谢大家,祝遇到此问题的其他人好运!