Pytest 如何正确地从 Python 测试 C API，C API 以返回码的形式返回错误

在本文中，我们将介绍如何使用 Pytest 来正确测试 C API，并且了解如何处理 C API 以返回码的形式返回的错误。首先，我们需要了解一些基本概念和术语才能更好地理解如何进行测试。然后，我们将展示一些示例代码来说明如何编写和运行这些测试。

阅读更多：Pytest 教程

术语和概念

在开始之前，让我们先了解一些与 C API 相关的术语和概念。

C API：C API 是一个允许其他编程语言（如 Python）与 C 代码进行交互的接口。它定义了一组函数和数据结构，允许其他编程语言调用和操作 C 代码。
返回码：在 C 语言中，函数返回一个整数值作为执行的结果。这个整数值被称为返回码。返回码通常用来表示函数执行是否成功，以及错误的类型。

现在我们已经了解了这些基本概念，让我们开始编写测试代码。

编写测试代码

首先，我们需要安装 Pytest。你可以在命令行中运行以下命令来安装 Pytest：

pip install pytest

安装完成后，我们可以编写测试代码了。以下是一个简单的示例来说明如何测试一个返回码的功能。

# sample.c

int divide(int a, int b) {
    if (b == 0) {
        return -1;  // 返回错误码表示除数为零
    }

    return a / b;  // 返回计算结果
}

# test_sample.py

import ctypes
import pytest

def test_divide():
    # Load the C library
    sample = ctypes.CDLL('./sample.so')

    # Call the C function
    result = sample.divide(10, 0)

    # Check the return code
    assert result == -1

在这个示例中，我们首先编写了一个名为 divide 的 C 函数并保存在名为 sample.c 的文件中。该函数接受两个整数作为参数，如果除数为零，则返回值为 -1 来表示错误。然后，我们在 test_sample.py 文件中导入 ctypes 模块来加载 C 库，并编写了一个名为 test_divide 的测试函数。在这个测试函数中，我们调用了 C 函数并检查返回的返回码是否与预期的错误码相同。

现在我们已经编写了测试代码，让我们运行测试并查看结果。

运行测试

要运行测试，我们只需在命令行中运行以下命令：

pytest test_sample.py

如果一切顺利，你将会看到类似以下的输出：

============================= test session starts ==============================
platform linux -- Python 3.8.5, pytest-6.2.3, py-1.10.0, pluggy-0.13.1
collected 1 item

test_sample.py .                                                          [100%]

============================== 1 passed in 0.01s ===============================

这意味着我们的测试通过了！现在我们已经成功地测试了一个返回码的功能。让我们总结一下我们在本文中学到的内容。