Pytest之测试命名规则的使用

更新时间：2021年04月15日 17:07:01 作者：阿刁阿

这篇文章主要介绍了Pytest之测试命名规则的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

背景：

pytest以特定规则搜索测试用例，所以测试用例文件、测试类以及类中的方法、测试函数这些命名都必须符合规则，才能被pytest搜索到并加入测试运行队列中。

默认搜索规则：

如果pytest命令行有指定目录，则从该目录中开始查找测试用例文件，如果没有指定，则从当前运行目录开始查找文件。注意，该查找是递归查找，子目录中的文件也会被查找到。
并不是能够查找到目录下的所有文件，只有符合命名规则的文件才会被查找。默认规则是以test_开头或者以_test结尾的.py文件。
在测试文件中查找Test开头的类，以及类中以test_开头的方法，查找测试文件中test_开头的函数。

测试用例默认命名规则

除非pytest命令指定到测试用例文件，否则测试用例文件命名应该以 test_开头或者以_test结尾。
测试函数命名，测试类的方法命名应该以test_开头。
测试类命名应当以Test开头。

tips: 测试类的不应该有构造函数。

笔者习惯装测试用例的文件夹，测试用例文件，测试函数，类中的测试方法都以test_开头。建议保持一种统一的风格。

示例：

# func.py
def add(a,b):
 return a+b

# ./test_case/test_func.py
import pytest
from func import *

class TestFunc:

 #def __init__(self):
  #self.a = 1

 def test_add_by_class(self):
  assert add(2,3) == 5


def test_add_by_func():
 assert add(4,6) == 10

'''
# stdout:
============================= test session starts =============================
platform win32 -- Python 3.7.0, pytest-5.3.4, py-1.8.1, pluggy-0.13.1
rootdir: D:\Python3.7\project\pytest
plugins: allure-pytest-2.8.9, rerunfailures-8.0
collected 2 items

test_case\test_func.py ..                                                [100%]

============================== 2 passed in 0.04s ==============================
[Finished in 1.3s]
######################################################################
'''

测试结果中，test_case\test_func.py … 。两个点号代表两个测试用例。

错误示范，当测试类有构造函数时：

# func.py
def add(a,b):
 return a+b

# ./test_case/test_func.py
import pytest
from func import *

class TestFunc:

 def __init__(self):
  self.a = 1

 def test_add_by_class(self):
  assert add(2,3) == 5


def test_add_by_func():
 assert add(4,6) == 10

'''
# stdout:
============================= test session starts =============================
platform win32 -- Python 3.7.0, pytest-5.3.4, py-1.8.1, pluggy-0.13.1
rootdir: D:\Python3.7\project\pytest
plugins: allure-pytest-2.8.9, rerunfailures-8.0
collected 1 item

test_case\test_func.py .                                                 [100%]

============================== warnings summary ===============================
test_case\test_func.py:4
  D:\Python3.7\project\pytest\test_case\test_func.py:4: PytestCollectionWarning: cannot collect test class 'TestFunc' because it has a __init__ constructor (from: test_case/test_func.py)
    class TestFunc:

-- Docs: https://docs.pytest.org/en/latest/warnings.html
======================== 1 passed, 1 warning in 0.04s =========================
[Finished in 1.4s]
######################################################################
'''

会报错，pytest只能找到test_开头的函数，但是不能找到Test开头的含有构造函数的测试类。

自定义测试用例命名规则

如果因为某种需要，需要使用其他命名规则命名的测试文件、测试函数、测试类以及测试类的方法，可以通过pytest.ini配置文件做到。

在测试系统的顶层目录创建pytest.ini文件，在pytest.ini文件中写入如下配置：

[pytest]
# 更改测试文件命名规则
python_files = HG*

# 更改测试类命名规则
python_classes = HG*

# 更嗨测试函数命名规则
python_functions = HG*

示例：

# func.py
def add(a,b):
 return a+b

# ./test_case/HG_func.py
import pytest
from func import *

class HGFunc:

 #def __init__(self):
  #self.a = 1

 def HG_add_by_class(self):
  assert add(2,3) == 5


def HG_add_by_func():
 assert add(4,6) == 10

'''
stdout:
============================= test session starts =============================
platform win32 -- Python 3.7.0, pytest-5.3.4, py-1.8.1, pluggy-0.13.1 -- D:\Python3.7\python.exe
cachedir: .pytest_cache
rootdir: D:\Python3.7\project\pytest, inifile: pytest.ini
plugins: allure-pytest-2.8.9, rerunfailures-8.0
collecting ... collected 2 items

test_case/HG_func.py::HGFunc::HG_add_by_class PASSED                     [ 50%]
test_case/HG_func.py::HG_add_by_func PASSED                              [100%]

============================== 2 passed in 0.03s ==============================
[Finished in 1.3s]
'''

Tips：

pytest.ini是可以改变pytest运行方式的配置文件，但是正常情况下，测试系统里根本不需要存在pytest.ini文件，我们使用默认的运行方式即可工作。
pytest.ini还有许多其他个性化配置，当有需要时，可以在自动化测试项目的顶层目录里创建pytest.ini文件，添加配置，达到个性化运行的目的。

到此这篇关于Pytest之测试命名规则的使用的文章就介绍到这了,更多相关Pytest 命名规则内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

python和flask中返回JSON数据的方法
下面小编就为大家整理了一篇python和flask中返回JSON数据的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2018-03-03
python进行OpenCV实战之画图（直线、矩形、圆形）
这篇文章主要为大家详细介绍了python进行OpenCV实战之画图功能，画出直线、矩形、圆形，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-08-08
python中print函数的用法示例与详细讲解
这篇文章主要给大家介绍了关于python中print函数的用法示例与详细讲解,print()函数可以将输出的信息打印出来,即发送给标准输出流,文中通过代码介绍的非常详细,需要的朋友可以参考下
2024-05-05
Python通用验证码识别OCR库之ddddocr验证码识别
dddd_ocr也是一个用于识别验证码的开源库,又名带带弟弟ocr,爬虫界大佬sml2h3开发,识别效果也是非常不错,下面这篇文章主要给大家介绍了关于Python通用验证码识别OCR库之ddddocr验证码识别的相关资料,需要的朋友可以参考下
2022-05-05
Python文件操作与数据处理实战指南
文件操作与数据处理是Python编程中最基础也是最重要的技能之一,无论是数据分析、Web开发还是自动化脚本编写,都离不开对文件的读写和各种数据处理操作,本文将全面介绍Python中的文件操作方法和常用数据处理技巧,需要的朋友可以参考下
2025-04-04
Python Web静态服务器非堵塞模式实现方法示例
这篇文章主要介绍了Python Web静态服务器非堵塞模式实现方法,结合实例形式分析了Python单进程非堵塞模式实现的Web静态服务器相关操作技巧,需要的朋友可以参考下
2019-11-11
python最常用的三种输出格式解读
这篇文章主要介绍了python最常用的三种输出格式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-02-02
python版简单工厂模式
这篇文章主要为大家详细介绍了python版简单工厂模式，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-10-10
Python使用textcase库轻松实现文本格式处理
在Python开发中,规范的文本格式处理是提升代码可读性和维护性的关键一环,本文将系统讲解textcase库的核心功能,典型应用场景及性能优化策略,感兴趣的小伙伴可以跟随小编一起学习一下
2025-04-04
利用Python脚本实现自动刷网课
这篇文章主要介绍了利用Python脚本实现自动刷网课，非常不错，具有一定的参考借鉴价值,需要的朋友可以参考下
2020-02-02