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调用Prometheus监控数据并计算
Prometheus是一套开源监控系统和告警为一体，由go语言(golang)开发，是监控+报警+时间序列数据库的组合。本文将介绍Python如何调用Prometheus实现数据的监控与计算，需要的可以参考一下
2021-12-12
Python换行与不换行的输出实例
这篇文章主要介绍了Python换行与不换行的输出实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-02-02
python3实现飞机大战
这篇文章主要为大家详细介绍了python3实现飞机大战，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-11-11
Python使用win32com模块实现数据库表结构自动生成word表格的方法
这篇文章主要介绍了Python使用win32com模块实现数据库表结构自动生成word表格的方法,结合实例形式分析了win32com模块下载、连接mysql、查询获取表结构以及使用win32com生成word表格的相关操作技巧,需要的朋友可以参考下
2018-07-07
Python中模块pymysql查询结果后如何获取字段列表
pymsql是Python中操作MySQL的模块，其使用方法和MySQLdb几乎相同。下面这篇文章主要给大家介绍了关于Python中模块pymysql查询结果后如何获取字段列表的相关资料，文中介绍的非常详细，需要的朋友可以参考借鉴，下面来看看详细的介绍。
2017-06-06
Python理解递归的方法总结
在本篇文章里小编给大家分享了关于如何使用Python来理解递归的知识点内容，有兴趣的朋友们学习下。
2019-01-01
Python学习之字典和集合的使用详解
Python 中字典和集合也是非常相近的概念，而且从外观看上去，也有那么一丝丝的相似。本文将从字典基本知识入手，为你展开字典类型数据的各个知识点，需要的可以参考一下
2022-11-11
Pycharm使用远程linux服务器conda/python环境在本地运行的方法(图解）)
这篇文章主要介绍了Pycharm使用远程linux服务器conda/python环境在本地运行的方法，本文图文并茂给大家介绍的非常详细，具有一定的参考借鉴价值,需要的朋友可以参考下
2019-12-12
Python3.x中自定义比较函数
这篇文章主要介绍了Python3.x中自定义比较函数,本文给出了自定义对象的比较、字典值value的比较实现方法,需要的朋友可以参考下
2015-04-04
python去掉空白行的多种实现代码
这篇文章主要介绍了python去掉空白行实现代码,需要的朋友可以参考下
2018-03-03