ctypes使用浅谈

news2024/11/28 12:33:53

什么是ctypes：

　　ctypes 是 Python 的一个标准库，用于与 C 语言进行交互。它提供了一组工具和函数，可以方便地调用动态链接库（DLL）或共享对象（SO）中的 C 函数，并处理 C 数据类型的转换。

说的易懂点就是ctypes在c与python之间做类型转换的。既然是做类型转换的，那么对于c/c++中常用的类型，是如何用ctypes方式去做转换的，接下来一探究竟：

什么是动态链接库：

　　动态链接库是一个已经编译好、程序在运行时就可直接使用的数据-函数库。与静态链接库不同，动态链接库在程序运行时被加载和链接，而不是在编译时动态链接库必须先载入，为此ctypes提供三个对象：cdll、windll（windows-only）、oledll（windows-only），并使得载入dll就如访问这些对象的属性一样。这三个区别是：

(1) cdll：cdll对象载入使用标准cdecl调用约定的函数库

(2) windll：windll对象载入使用stdcall调用约定的函数库

(3) oledll：oledll对象载入使用stdcall调用约定的函数库

使用步骤：

(1) 加载动态链接库：

　　使用 ctypes 的 cdll 或 windll （Windows 平台）函数来加载动态链接库或共享对象。只需要提供库的路径或名称，ctypes 将自动根据操作系统的不同来选择正确的加载函数，

示例如下：


# 示例 1: 加载动态链接库
my_lib = ctypes.CDLL('/path/to/my_lib.so')
 
# 示例 2: 加载共享对象（在 Windows 上）
my_lib = ctypes.windll.LoadLibrary('my_lib.dll')

(2) 获取DLL/共享库中的函数

my_function = my_lib.my_function # my_function 是动态库中已导出的函数，不导出则不可调用，像访问一个类实例属性一样来载入my_function.argtypes = [ctypes.c_int, ctypes.c_float] my_function.restype = ctypes.c_double # 指定函数的返回类型和参数类型。

(3) 进行类型转换，从而可以传给调用的c函数：　　

（1）C语言中基础的数据类型

这部分的使用比较简单，直接使用ctypes内置的方法创建对象即可，ctypes提供的方法和C语言对应的数据类型如下表：

ctypes 类型	C 类型	Python 类型
c_bool	_Bool	bool (1)
c_char	char	单字符字节串对象
c_wchar	`wchar_t`	单字符字符串
c_byte	char	int
c_ubyte	unsigned char	int
c_short	short	int
c_ushort	unsigned short	int
c_int	int	int
c_uint	unsigned int	int
c_long	long	int
c_ulong	unsigned long	int
c_longlong	__int64 或 long long	int
c_ulonglong	unsigned __int64 或 unsigned long long	int
c_size_t	`size_t`	int
c_ssize_t	`ssize_t` 或 Py_ssize_t	int
c_float	float	float
c_double	double	float
c_longdouble	long double	float
c_char_p	char* (以 NUL 结尾)	字节串对象或 `None`
c_wchar_p	wchar_t* (以 NUL 结尾)	字符串或 `None`
c_void_p	void*	int 或 `None`

使用的几个小示例：


import ctypes
 
# 加载动态链接库
my_lib = ctypes.CDLL('/path/to/my_lib.so')
 
# 定义函数原型
my_function = my_lib.my_function
my_function.argtypes = [ctypes.c_int]
 
# 转换整型数据类
my_int = 10
my_function(ctypes.c_int(my_int))
 
#转换浮点型数据类型：
my_float = 3.14
my_function(ctypes.c_float(my_float))
 
#转换字符串类型：
my_string = "Hello"
my_function(ctypes.c_char_p(my_string.encode('utf-8')))#转换数组类型：char_array = c_char * 3

（2）C语言中高级数据类型

对于 C 语言中的高级数据类型，如结构体、嵌套结构体、结构体数组、结构体指针等，ctypes 提供了一些工具和方法来进行转换。假设在 C 代码中有一个结构体类型 MyStruct，下面是几个示例：

import ctypes
 
# 定义 C 结构体类型
class MyStruct(ctypes.Structure):
    _fields_ = [("field1", ctypes.c_int),
                ("field2", ctypes.c_float)]
 
# 加载动态链接库
my_lib = ctypes.CDLL('/path/to/my_lib.so')
 
# 定义函数原型
my_function = my_lib.my_function
my_function.argtypes = [MyStruct]
 
# 创建结构体实例并传递给 C 函数
my_struct = MyStruct()
my_struct.field1 = 10
my_struct.field2 = 3.14
my_function(my_struct)
#转换嵌套结构体
class InnerStruct(ctypes.Structure):
    _fields_ = [("inner_field", ctypes.c_int)] # 定义 C 内部引用结构体class OuterStruct(ctypes.Structure):
    _fields_ = [("outer_field", ctypes.POINTER(InnerStruct))] # 创建结构体实例，并传递给 C 函数
inner = InnerStruct()
inner.inner_field = 10
 
outer = OuterStruct()
outer.outer_field = ctypes.pointer(inner)
 
my_function(ctypes.cast(ctypes.pointer(outer), ctypes.POINTER(OuterStruct)))array_size = 5
my_array = (MyStruct * array_size)()
for i in range(array_size):
    my_array[i].field1 = i
    my_array[i].field2 = float(i)
 
my_function(my_array, array_size)#转换结构体指针和结构体指针数组：#对于结构体指针和结构体指针数组，可以使用 ctypes.POINTER 类型和 ctypes.cast 函数进行转换。# 定义函数原型
my_function = my_lib.my_function
my_function.argtypes = [ctypes.POINTER(MyStruct)]
 
# 创建结构体实例，并传递给 C 函数
my_struct = MyStruct()
my_struct.field1 = 10
my_struct.field2 = 3.14
 
# 传递结构体指针给 C 函数
my_function(ctypes.pointer(my_struct))
 
# 创建结构体指针数组，并传递给 C 函数
array_size = 5
my_array = (ctypes.POINTER(MyStruct) * array_size)()
for i in range(array_size):
    my_array[i] = ctypes.pointer(MyStruct())
     
my_function(ctypes.cast(my_array, ctypes.POINTER(ctypes.POINTER(MyStruct))))

（3）C语言中回调函数的转换

假设在 C 代码中有一个函数 register_callback，它接受一个函数指针作为参数，并在适当的时候调用该函数。我们可以使用 ctypes 来定义回调函数，并将其传递给 register_callback。

首先，我们需要定义回调函数的类型，然后将其转换为函数指针类型。在调用 register_callback 时，我们将转换后的函数指针作为参数传递。

import ctypes
 
# 定义回调函数类型
CallbackFunc = ctypes.CFUNCTYPE(None, ctypes.c_int)
 
# 定义回调函数
def my_callback(value):
    print("Callback called with value:", value)
 
# 加载动态链接库
my_lib = ctypes.CDLL('/path/to/my_lib.so')
 
# 定义函数原型
register_callback = my_lib.register_callback
register_callback.argtypes = [CallbackFunc]
 
# 将 Python 回调函数转换为函数指针
callback_func = CallbackFunc(my_callback)
 
# 注册回调函数
register_callback(callback_func)

首先使用 ctypes.CFUNCTYPE 定义了回调函数类型 CallbackFunc。它的第一个参数是回调函数的返回类型，这里是 None，表示没有返回值；第二个参数是回调函数的参数类型，这里是 ctypes.c_int。

然后，我们定义了 Python 中的回调函数 my_callback，它接受一个整数参数，并在函数内部打印该参数的值。

接下来，我们使用 CallbackFunc 将 Python 回调函数转换为函数指针类型 callback_func。

最后，我们加载动态链接库，并调用 register_callback 函数，将转换后的函数指针作为参数传递给 C 函数。