Python通过ctypes调用C++传递与返回数组的方法
本文详解Python利用ctypes模块与C++动态库交互时,如何高效传递和接收数组数据。通过两个完整示例,演示了结构体指针引用传参、嵌套结构体以及二维数组内存布局的一致性处理。涵盖Linux编译脚本与Windows DLL构建步骤,并强调32位与64位环境匹配的关键注意事项,帮助开发者解决跨语言数据交互中的内存访问问题。
示例1展示了基础的结构体传递方式。
C++源文件pycallclass.cpp的实现代码如下:
#include <iostream>
using namespace std;
typedef unsigned char BYTE;
#define MAX_COUNT 20
struct tagOutCardResult_py
{
BYTE cbCardCount;
BYTE cbResultCard1;
BYTE cbResultCard2;
BYTE cbResultCard3;
BYTE cbResultCard4;
BYTE cbResultCard5;
BYTE cbResultCard6;
BYTE cbResultCard7;
BYTE cbResultCard8;
BYTE cbResultCard9;
BYTE cbResultCard10;
BYTE cbResultCard11;
BYTE cbResultCard12;
BYTE cbResultCard13;
BYTE cbResultCard14;
BYTE cbResultCard15;
BYTE cbResultCard16;
BYTE cbResultCard17;
BYTE cbResultCard18;
BYTE cbResultCard19;
BYTE cbResultCard20;
};
struct tagOutCardResult
{
BYTE cbCardCount;
BYTE cbResultCard[MAX_COUNT];
void clear()
{
cbCardCount = 0;
for (int nIdx = 0;nIdx < MAX_COUNT;++nIdx)
{
cbResultCard[nIdx] = 0;
}
}
void topy(tagOutCardResult_py* ppy)
{
cout<<"topy function begin"<<endl;
ppy->cbCardCount = cbCardCount;
cout<<"topy function 1"<<endl;
ppy->cbResultCard1 = cbResultCard[1 - 1];
cout<<"topy function 2"<<endl;
ppy->cbResultCard2 = cbResultCard[2 - 1];
ppy->cbResultCard3 = cbResultCard[3 - 1];
ppy->cbResultCard4 = cbResultCard[4 - 1];
ppy->cbResultCard5 = cbResultCard[5 - 1];
ppy->cbResultCard6 = cbResultCard[6 - 1];
ppy->cbResultCard7 = cbResultCard[7 - 1];
ppy->cbResultCard8 = cbResultCard[8 - 1];
ppy->cbResultCard9 = cbResultCard[9 - 1];
ppy->cbResultCard10 = cbResultCard[10 - 1];
ppy->cbResultCard11 = cbResultCard[11 - 1];
ppy->cbResultCard12 = cbResultCard[12 - 1];
ppy->cbResultCard13 = cbResultCard[13 - 1];
ppy->cbResultCard14 = cbResultCard[14 - 1];
ppy->cbResultCard15 = cbResultCard[15 - 1];
ppy->cbResultCard16 = cbResultCard[16 - 1];
ppy->cbResultCard17 = cbResultCard[17 - 1];
ppy->cbResultCard18 = cbResultCard[18 - 1];
ppy->cbResultCard19 = cbResultCard[19 - 1];
ppy->cbResultCard20 = cbResultCard[20 - 1];
cout<<"topy function end"<<endl;
}
};
class TestLib
{
public:
void display(tagOutCardResult& ret);
};
void TestLib::display(tagOutCardResult& ret) {
ret.cbCardCount = 3;
ret.cbResultCard[0] = 1;
ret.cbResultCard[1] = 50;
ret.cbResultCard[2] = 100;
cout<<"First display aaa ";
cout<<"hello ";
cout<<"world ";
}
extern "C" {
TestLib oGameLogic;
void display(tagOutCardResult_py* ret_py) {
tagOutCardResult oRet;
oGameLogic.display(oRet);
cout<<"before topy"<<endl;
oRet.topy(ret_py);
cout<<"after topy"<<endl;
cout<<"in cpp:ret_py->cbCardCount:"<<ret_py->cbCardCount<<endl;
cout<<"in cpp:ret_py->cbResultCard1:"<<ret_py->cbResultCard1<<endl;
cout<<" this:" << ret_py << endl;
}
}
编译该C++代码生成共享库的脚本如下:
g++ -o libpycallclass.so -shared -fPIC pycallclass.cpp -I/usr/include/python2.6 -L/usr/lib64/python2.6/config
在Python脚本Game.py中,首先声明对应的类结构:
import ctypes
class tagOutCardResult_py(ctypes.Structure):
_fields_ = [("cbCardCount", ctypes.c_ubyte), \
("cbResultCard1", ctypes.c_ubyte), \
("cbResultCard2", ctypes.c_ubyte), \
("cbResultCard3", ctypes.c_ubyte), \
("cbResultCard4", ctypes.c_ubyte), \
("cbResultCard5", ctypes.c_ubyte), \
("cbResultCard6", ctypes.c_ubyte), \
("cbResultCard7", ctypes.c_ubyte), \
("cbResultCard8", ctypes.c_ubyte), \
("cbResultCard9", ctypes.c_ubyte), \
("cbResultCard10", ctypes.c_ubyte), \
("cbResultCard11", ctypes.c_ubyte), \
("cbResultCard12", ctypes.c_ubyte), \
("cbResultCard13", ctypes.c_ubyte), \
("cbResultCard14", ctypes.c_ubyte), \
("cbResultCard15", ctypes.c_ubyte), \
("cbResultCard16", ctypes.c_ubyte), \
("cbResultCard17", ctypes.c_ubyte), \
("cbResultCard18", ctypes.c_ubyte), \
("cbResultCard19", ctypes.c_ubyte), \
("cbResultCard20", ctypes.c_ubyte)]
接着是具体的调用逻辑:
import ctypes
so = ctypes.cdll.LoadLibrary
lib = so("./libpycallclass.so")
ERROR_MSG('display(\)')
ret = tagOutCardResult_py(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
ERROR_MSG("before lib.display(ctypes.byref(ret))")
lib.display(ctypes.byref(ret))
ERROR_MSG("after lib.display(ctypes.byref(ret))")
ERROR_MSG('#######################################################################################')
ERROR_MSG(ret)
ERROR_MSG(ret.cbCardCount)
ERROR_MSG(ret.cbResultCard1)
ERROR_MSG(ret.cbResultCard2)
ERROR_MSG(ret.cbResultCard3)
ERROR_MSG(type(ret))
通过传入结构体并使用引用方式返回数据,在Python端打印结果验证正确性。
至此,实现了数据的传入与传出功能。
示例1结束#########################################################################
示例2演示了更复杂的数组与嵌套结构处理。
C++源文件pycallclass.cpp的相关实现:
#include <iostream>
using namespace std;
typedef unsigned char BYTE;
#define MAX_COUNT 20
#if defined(WIN32)||defined(WINDOWS)
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT
#endif
struct ByteArray_20
{
BYTE e1;
BYTE e2;
BYTE e3;
BYTE e4;
BYTE e5;
BYTE e6;
BYTE e7;
BYTE e8;
BYTE e9;
BYTE e10;
BYTE e11;
BYTE e12;
BYTE e13;
BYTE e14;
BYTE e15;
BYTE e16;
BYTE e17;
BYTE e18;
BYTE e19;
BYTE e20;
};
struct ByteArray_20_3
{
ByteArray_20 e1;
ByteArray_20 e2;
ByteArray_20 e3;
};
struct ByteArrayNew_20_3
{
BYTE e[3][20];
};
class TestLib
{
public:
void LogicFunc(ByteArray_20_3& ret);
void LogicFuncNew(ByteArrayNew_20_3& ret);
};
void TestLib::LogicFunc(ByteArray_20_3& ret) {
ret.e1.e1 = 3;
ret.e1.e2 = 1;
ret.e1.e3 = 50;
ret.e2.e1 = 100;
ret.e2.e2 = 200;
ret.e2.e3 = 20;
cout<<"TestLib::LogicFunc"<<endl;
}
void TestLib::LogicFuncNew(ByteArrayNew_20_3& ret) {
ret.e[0][0] = 31;
ret.e[0][1] = 11;
ret.e[0][2] = 51;
ret.e[1][0] = 101;
ret.e[1][1] = 201;
ret.e[1][2] = 21;
cout << "TestLib::LogicFuncNew" << endl;
}
extern "C" {
TestLib oGameLogic;
void DLL_EXPORT display(ByteArray_20_3* pret) {
cout<<"cpp display func begin"<<endl;
oGameLogic.LogicFunc(*pret);
cout<<"cpp display func end"<<endl;
}
void DLL_EXPORT display2(ByteArrayNew_20_3* pret) {
cout << "cpp display2 func begin" << endl;
oGameLogic.LogicFuncNew(*pret);
cout << "cpp display2 func end" << endl;
}
}
Python调用脚本pycallclass.py的内容:
import ctypes
def ERROR_MSG(str):
print str
class ByteArray_20(ctypes.Structure):
_fields_ = [\
("e1", ctypes.c_ubyte), \
("e2", ctypes.c_ubyte), \
("e3", ctypes.c_ubyte), \
("e4", ctypes.c_ubyte), \
("e5", ctypes.c_ubyte), \
("e6", ctypes.c_ubyte), \
("e7", ctypes.c_ubyte), \
("e8", ctypes.c_ubyte), \
("e9", ctypes.c_ubyte), \
("e10", ctypes.c_ubyte), \
("e11", ctypes.c_ubyte), \
("e12", ctypes.c_ubyte), \
("e13", ctypes.c_ubyte), \
("e14", ctypes.c_ubyte), \
("e15", ctypes.c_ubyte), \
("e16", ctypes.c_ubyte), \
("e17", ctypes.c_ubyte), \
("e18", ctypes.c_ubyte), \
("e19", ctypes.c_ubyte), \
("e20", ctypes.c_ubyte)]
class ByteArray_20_3(ctypes.Structure):
_fields_ = [\
("e1", ByteArray_20), \
("e2", ByteArray_20), \
("e3", ByteArray_20)]
def __init__(self):
self.aaa = 123
self.bbb = [1, 2, 3, 4, 5]
self.ccc = "alksdfjlasdfjk"
def test(self):
self.aaa = 123
self.bbb = [1, 2, 3, 4, 5]
self.ccc = "alksdfjlasdfjk"
self.e1.e1 = 5
self.e1.e2 = 20
so = ctypes.cdll.LoadLibrary
lib = so("./libpycallclass.dll")
print('display()')
ret = ByteArray_20_3()
ret.test()
ERROR_MSG(ret.e1.e1)
ERROR_MSG(ret.e1.e2)
print("before lib.display(ctypes.byref(ret))")
lib.display(ctypes.byref(ret))
print("after lib.display(ctypes.byref(ret))")
print('#######################################################################################')
print(ret)
ERROR_MSG(ret.e1)
ERROR_MSG(ret.e2)
ERROR_MSG(ret.e3)
ERROR_MSG(ret.e1.e1)
ERROR_MSG(ret.e1.e2)
ERROR_MSG(ret.e1.e3)
ERROR_MSG(ret.e2.e1)
ERROR_MSG(ret.e2.e2)
ERROR_MSG(ret.e2.e3)
ERROR_MSG(type(ret))
print("before lib.display2(ctypes.byref(ret))")
lib.display2(ctypes.byref(ret))
print("after lib.display2(ctypes.byref(ret))")
print('#######################################################################################')
print(ret)
ERROR_MSG(ret.e1)
ERROR_MSG(ret.e2)
ERROR_MSG(ret.e3)
ERROR_MSG(ret.e1.e1)
ERROR_MSG(ret.e1.e2)
ERROR_MSG(ret.e1.e3)
ERROR_MSG(ret.e2.e1)
ERROR_MSG(ret.e2.e2)
ERROR_MSG(ret.e2.e3)
ERROR_MSG(type(ret))
ret.test()
ERROR_MSG(ret.e1.e1)
ERROR_MSG(ret.e1.e2)
Linux环境下的编译命令g++:
g++ -o libpycallclass.so -shared -fPIC pycallclass.cpp -I/usr/include/python2.6 -L/usr/lib64/python2.6/config
Windows环境下的处理方式:
新建一个DLL工程,将pycallclass.cpp添加进去,编译生成DLL即可。
务必注意Python运行时环境的位数(32位或64位),确保生成的DLL或SO库与之严格对应,否则会导致加载失败。
Python类支持嵌套使用,通过继承ctypes.Structure,部分成员在_fields_中定义,其余成员可在__init__中定义。此类实例可通过ctypes.byref(self)传入C++,传递的是指针,从而实现传入传出的完整交互。
注意示例2中ByteArrayNew_20_3的用法,Python中定义了20个变量,而C++中直接使用二维数组。由于内存结构一致,可以直接这样使用。需特别注意类型和长度必须一致,否则可能引发内存访问越界错误。
以上关于Python调用C++ ctypes传递或返回数组的方法即为全部内容,希望能提供有益参考,欢迎支持本站。
本站声明
本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。













