Python测试之Pytest详解

news2024/11/28 12:56:38

640?wx_fmt=jpeg&wxfrom=5&wx_lazy=1&wx_co=1

概要

当涉及到python的测试框架时，pytest是一个功能强大且广泛应用的第三方库。它提供简洁而灵活的方式来编写和执行测试用例，并具有广泛的应用场景。下面是pytest的介绍和详细使用说明：

pytest是一个用于python单元测试的框架，它建立在标准的unittest模块之上，并提供了更简洁、更易于使用的语法风格。它支持丰富的断言库，提供丰富的插件和扩展性，可以轻松地进行测试的编写、执行和报告。pytest的设计哲学强调可读性、灵活性和可扩展性，使得它适用于各种单元测试和集成测试场景。

在使用pytest工具之前，我们有必要了解一下python的一个关键字assert：

1. assert关键字

assert是python中的一个关键字，用于在代码中执行断言。它用于检查一个条件是否为真，如果条件为假，则会引发AssertionError异常，以指示代码中的错误或意外情况。assert语句通常在调试和测试中使用，用于验证程序的正确性。使用方法如下：

1.1 基本使用

assert语句的一般用法如下：

assert condition, message

其中：

condition 是要检查的条件，如果为 False，则会引发 AssertionError 异常。
message 是可选的附加消息，用于在断言失败时提供更具体的错误信息。这对于识别断言失败的原因非常有用。

示例：

def divide(a, b):
    assert b != 0, "除数不能为零"
    return a / b

result = divide(10, 0)
print(result)

在上面的示例中，我们定义了一个 divide 函数，它执行两个数相除的操作。在执行除法之前，我们使用 assert语句来确保除数 b 不为零，如果为零，则会引发 AssertionError 异常，并在错误消息中指定除数不能为零的原因。

1.2 注意事项

assert语句主要用于调试和测试目的，因此在正式生产代码中使用时要谨慎，并注意在所需的情况下使用适当的异常处理机制。
断言的目的是在运行时检查代码的假设条件，并帮助捕获潜在的错误。它不应该用于处理预期的错误情况（例如输入验证），而应该用于检查不应该发生的情况。

1.3 小结

assert关键字是python中的一个断言语句，用于检查条件的真假，并在条件为假时引发 AssertionError。它用于调试和测试目的，帮助识别代码中的错误或意外情况。但请注意，在正式生产代码中使用时要谨慎，并遵循适当的异常处理机制。

聊完了，assert，接下来我们可以深入了解一下pytest这个第三方库在代码测试方面的使用。

2.`pytest`代码测试

它提供了简洁而灵活的方式来编写和执行测试用例，并且具有广泛的应用场景。以下是一些关于 Pytest 的介绍：

简洁的语法：Pytest 具有简洁、直观的语法，比传统的 unittest 更易于使用和阅读。你可以使用函数来定义测试用例，以 test_ 开头，并使用断言来验证预期结果。
自动发现：Pytest 能够自动发现项目中的测试文件和测试用例，并在不需要额外配置的情况下执行它们。只需运行 pytest 命令，它会根据约定的命名规则查找测试文件和测试函数。
丰富的断言支持：Pytest 提供了丰富的断言支持，包括标准的 assert 语句、使用内置的 assert 断言模块的自定义断言、以及第三方断言库（如 pytest-assume 和 pytest-check）。

2.1 使用方法

安装pytest，可以使用pip安装pytest：

pip install pytest

编写测试用例：pytest使用一种基于函数的方式编写测试用例。创建一个以test_开头的函数，根据需要添加断言来验证预期结果。示例代码如下：

def test_addition():
    assert 1 + 1 == 2

def test_subtraction():
    assert 5 - 2 == 3

运行测试：在命令行中，运行以下命令来执行测试用例：

pytest

pytest将会自动发现项目中以test_开头的函数，并执行这些函数作为测试用例。

下面给出一个简单的测试用例：

class Bag:
    def __init__(self, maxsize=10):
        self.size = maxsize
        self._item = []

    def add(self, item):
        if len(self) >= self.size:
            raise Exception('full')
        self._item.append(item)

    def remove(self, item):
        self._item.remove(item)

    def __len__(self):
        return len(self._item)

    def __iter__(self):
        for item in self._item:
            yield item


def test_bag():
    bag = Bag()
    bag.add(1)
    bag.add(2)
    bag.add(3)

    assert len(bag) == 3

    bag.remove(3)

    assert len(bag) == 2

    for item in bag:
        print(item)



if __name__ == '__main__':
    test_bag()

运行如下：