Python：ctypes 库高级用法举例和应用详解

Travis Tang

2024-07-25

ctypes, python动态链接库, python标准库, python高级应用

Python：ctypes库高级用法举例和应用详解

模块介绍

ctypes 是 Python 的一个外部函数接口库，允许 Python 代码调用动态链接库（DLL 或者共享库），并且能够将 C 语言的自然数据类型映射到 Python 类型上。在 Python 2.5 及之后的版本中，ctypes 已成为标准库的一部分，因此在现代的 Python 3.x 版本中也默认内置。

应用场景

ctypes 模块的主要用途包括以下几个方面：

调用 C 语言编写的库：通过 ctypes 可以直接使用已经存在的 C 语言库，无需重新实现相同的功能。
提高 Python 程序性能：部分高性能或者按需调用的函数可以用 C 编写，Python 通过 ctypes 调用以提高执行速度。
与操作系统底层交互：ctypes 库常被用来调用操作系统提供的底层 API，进行系统编程。

安装说明

由于 ctypes 是 Python 内置的标准库，因此在 Python 2.5 及之后的版本中，不需要单独安装 ctypes。你可以通过确保 Python 环境正确配置来使用它。

# 确认你的Python版本
python --version

# 如果使用Python虚拟环境，可以这样创建并激活环境
python -m venv myenv
source myenv/bin/activate  # Linux或MacOS
myenv\Scripts\activate  # Windows

用法举例

示例 1：调用简单的 C 函数

我们假设有一个简单的 C 函数用来计算两个整数的和，该函数编译成动态链接库供 Python 调用。

C 代码 (sum.c)

// sum.c
#include <stdio.h>

int add(int a, int b) {
    return a + b;
}

编译成共享库

1 2	gcc -shared -o libsum.so -fPIC sum.c # Linux gcc -shared -o sum.dll -fPIC sum.c # Windows

Python 调用代码

import ctypes

# 加载共享库
lib = ctypes.CDLL('./libsum.so')  # Linux
# lib = ctypes.CDLL('./sum.dll')  # Windows 注释掉Linux代码，激活Windows代码

# 定义返回值类型和参数
lib.add.restype = ctypes.c_int
lib.add.argtypes = [ctypes.c_int, ctypes.c_int]

# 调用C函数
result = lib.add(5, 3)  # 加法操作
print(f"5加3等于 {result}")  # 输出： "5加3等于 8"

示例 2：操作复杂数据类型

假设我们有一个 C 函数，用来处理结构体数据，并返回结果。

C 代码 (person.c)

// person.c
#include <stdio.h>

typedef struct {
    int age;
    char name[20];
} Person;

Person create_person(int age, const char* name) {
    Person person;
    person.age = age;
    snprintf(person.name, 20, "%s", name);
    return person;
}

编译成共享库

1 2	gcc -shared -o libperson.so -fPIC person.c # Linux gcc -shared -o person.dll -fPIC person.c # Windows

Python 调用代码

import ctypes

# 定义结构体类型
class Person(ctypes.Structure):
    _fields_ = [("age", ctypes.c_int), ("name", ctypes.c_char * 20)]

# 加载库
lib = ctypes.CDLL('./libperson.so')  # Linux
# lib = ctypes.CDLL('./person.dll')  # Windows 注释掉Linux代码，激活Windows代码

# 定义返回值类型和参数
lib.create_person.restype = Person
lib.create_person.argtypes = [ctypes.c_int, ctypes.c_char_p]

# 调用C函数创建 Person
person = lib.create_person(30, b'Alice')  # Python 3中需要显式地将字符串转换为字节类型
print(f"名字: {person.name.decode('utf-8')}, 年龄: {person.age}")  # 输出： "名字: Alice, 年龄: 30"

示例 3：操作系统层面的交互

我们模拟一个调用系统库函数来获取系统时间的例子，该函数在 Linux 下通过调用 libc 库实现。

Python 调用代码

import ctypes
import time

# 加载系统共有库 libc
libc = ctypes.CDLL('libc.so.6')

# 定义 timeval 结构体
class TimeVal(ctypes.Structure):
    _fields_ = [("tv_sec", ctypes.c_long), ("tv_usec", ctypes.c_long)]

# 定义函数原型
libc.gettimeofday.argtypes = [ctypes.POINTER(TimeVal), ctypes.POINTER(ctypes.c_void_p)]
libc.gettimeofday.restype = ctypes.c_int

# 创建 timeval 实例并调用函数
tv = TimeVal()
libc.gettimeofday(ctypes.byref(tv), None)

# 转换获取的时间
current_time = tv.tv_sec + tv.tv_usec / 1e6
local_time = time.ctime(current_time)
print(f"当前时间: {local_time}")  # 输出当前系统时间

通过以上示例，我们展示了如何使用 ctypes 库调用动态链接库中的 C 函数，操作复杂数据类型，以及与操作系统底层进行交互。希望这些示例能帮助你更好地理解和使用 ctypes 模块。

作为一个热爱 Python 开发的博主，在全糖冲击博客中，我持续分享各种实用的 Python 库和使用教程。关注我的博客，你将获得以下好处：

系统化学习资源：包含所有 Python 标准库的使用教程，帮助你系统化学习和查找资源。
实践经验分享：分享在实际项目中使用这些库的经验和技巧，提高你的编程水平。
前沿技术更新：紧跟编程语言和库的更新，为你提供最新技术和最佳实践。

欢迎大家关注全糖冲击博客，共同进步，遇到问题也可以在博客中留言，我们一起探讨和解决。感谢你的支持！

软件版本可能变动

如果本文档不再适用或有误，请留言或联系我进行更新。让我们一起营造良好的学习氛围。感谢您的支持！ - Travis Tang