pytest单元测试框架

off999 2025-05-21 15:45 65 浏览 0 评论

概述

pytest 是 python 语言中一款强大的单元测试框架（也是最好用的单元测试框架），用来管理和组织测试用例，可应用在单元测试、自动化测试工作中。

1、安装

pip install pytest

在unittest中，写case必须得定义类，继承TestCase，而pytest不需要，类和函数都支持，

函数需要以test开头，类需要以Test开头，

断言只使用assert关键字即可，代码如下：

2、pytest用例编写规则、断言

2.1、pytest用例编写规则

模块名必须以 test_ 开头，或者以 _test 结尾；
测试类必须以 Test 开头，并且不能有 init 方法;
测试方法（函数）必须以 test 开头;
断言是用基本的 assert 即可

示例：

2.2、断言

就是使用python自己的断言。assert

assert flag is True
assert 1==1
assert 'a' in 'abc'

3、pytest测试用例的运行

3.1、运行模式：主函数模式来运行

运行所有模块的用例：pytest.main()
运行指定模块的用例：pytest.main([ '-vs', 'test_add_fun.py' ])
运行指定模块的用例：pytest.main([ '-vs', '模块文件名' ])
运行指定模块的用例：pytest.main([ '模块文件名' ])
运行指定目录下的用例：pytest.main([ '-vs', '目录名' ]) （需要把主函数放到测试项目最外层）
通过nodeid指定用例运行：nodeid由模块名、分隔符，类名，方法名，函数名组成。
pytest.main([ '-vs', '目录名/模块名::类名::方法名' ])
pytest.main([ '-vs', '目录名/模块名::函数名' ])

3.2、命令行模式来运行

（切换到 case的对应路径下使用该命令）

运行所有模块的用例：pytest
运行指定模块的用例：pytest -vs test_add_fun.py pytest -vs 模块文件名
运行指定目录下的用例：pytest -vs 目录名（需要把主函数放到测试项目最外层）
通过nodeid指定用例运行：pytest -vs 目录名/模块名::类名::方法名 pytest -vs 目录名/模块名::函数名

全局配置文件pytest.ini配置文件+主函数/命令行模式运行

一般放在项目的根目录下，名称必须是pytest.ini
当有中文时可能需要改变编码格式为GB2312
pytest.ini文件可以改变默认的测试用例规则。
不管是命令行运行也好还是说主函数运行也好，都会加载这个配置文件。

[pytest]
addopts = -vs -m "smoke"
testpaths = ./testcases
python_files = test_*.py
python_classes = Test*
python_functions = test_*
markers =
 	smoke
    online

addopts #执行的命令这里-m "smoke"表示只执行冒烟用例。
testpaths #查找用例的目录
python_files = test_*.py #默认执行“test_”开头的case文件
python_classes = Test* #默认执行“Test”开头的测试类
python_functions = test_* #默认执行“test_”开头的测试函数或方法
markers = #给测试类、方法、函数定义的标签名称

3.2、运行参数详解：

-s: 显示程序中的调试信息，包括print/logging输出

-v: 丰富信息模式, 输出更详细的用例执行信息（可以和-s合并“-vs”）

展示被测试的具体类、方法，函数

-q: 安静模式, 不输出环境信息

-k：关键字匹配，用and或者or区分：匹配范围（文件名、类名、函数名）

运行测试用例名称中包含某个字符串的测试用例，如：pytest -vs -k"login or pay"

-m：mark匹配

--last-failed : 只运行上一次失败的case

--failed-first：优先运行上一次失败的case

-n：多线程运行。（前提安装插件：pytest-xdist）如：pytest -vs -n 2

--reruns num：失败重跑（前提安装插件：pytest-rerunfailres）如：pytest -vs --reruns=2

-x：出现一个用例失败则停止测试。如：pytest -vs -x

--maxfail：出现几个失败才终止。如：pytest -vs --maxfail=s

--html：生成html的测试报告（前提安装插件：pytest-html），如：pytest -vs --html ./report/result.html

4、用例执行的优先级

实现用例优先级：需要安装pytest-ordering这个模块

使用的时候使用 pytest.mark.run(order=xx) 装饰即可;数字越小，优先级越高。（数字全部用正数即可）

pip install pytest-ordering

5、前后置操作

用例为测试函数的实现方式

函数使用

setup_module：函数的所有case运行之前执行
teardown_module：函数的所有case执行之后执行
setup_function：函数的每个case运行之前执行
teardown_function：函数的每个case运行之后执行

import pytest


def calc(a, b):
    return a + b


def test_calc1():  # 函数方式写case
    print("这是test_calc1执行的")
    ret = calc(1, 2)
    assert ret == 3


def test_calc2():
    print("这是test_calc2执行的")
    ret = calc(1, 1)
    assert ret == 3  # 这是一条失败的case


def setup_module():
    print("所有case执行之前执行setup_module")


def teardown_module():
    print("所有case执行之后执行teardown_module")


def setup_function():
    print("每个case执行之前执行setup_function")


def teardown_function():
    print("每个case执行之后执行teardown_function")



if __name__ == '__main__':
    pytest.main(['-s',__file__])  # 运行当前文件里面所有用例,
    # -s表示详细模式，否则不会print我们在函数里面的内容，__file__代表的是当前这个py文件，也可以直接写当前这个python文件的名字

用例为测试类的实现方式

测试类使用

setup_class： 每个类的所有case运行之前执行
teardown_class： 每个类的所有case运行之后执行
setup_method：每个类的每个case运行之前执行
teardown_method：每个类的每个case运行之后执行

import pytest


def minus(a, b):
    return a - b


class TestMinus:  # 定义类的方式写case
    def test_minus_01(self):
        print("这是test_minus_01执行的")
        ret = minus(9, 4)
        assert ret == 5

    def test_minus_02(self):
        print("这是test_minus_02执行的")
        ret = minus(3, 5)
        assert ret == -2

    def setup_class(self):
        print("所有case执行之前执行setup_class")

    def teardown_class(self):
        print("所有case执行之后执行teardown_class")

    def setup_method(self):
        print("每条case执行之前执行setup_method")

    def teardown_method(self):
        print("每条case执行之后执行setup_method")


if __name__ == '__main__':
    pytest.main(["-s", __file__])  # 运行当前文件里面所有用例,
    # -s表示详细模式，__file__代表的是当前这个py文件，也可以直接写当前这个python文件的名字

python单元测试