当前位置：首页 > news >正文

【python自动化一】pytest的基础使用

news 来源：原创 2025/5/11 3:06:18

1.pytest简述

pytest‌ 是一个功能强大且灵活的Python测试框架，其主要是用于流程控制，具体用于UI还是接口自动化根据个人需要而定。且其具有丰富插件，使用时较为方便。咱们具体看下方的内容，本文按照使用场景展开，不完全按模块划分，减少割裂感。

2.安装pytest

安装命令（已安装python及pip）：

pip install -U pytest  # cmd命令行中直接输入即可

在这里插入图片描述
查看是否已经安装成功：

pytest --version

在这里插入图片描述
参考文档：
链接: pytest文档

3.新建工程

1.新建工程

这里我们使用编译器pycharm直接新建一个工程
在这里插入图片描述
这个工程用的虚拟环境，这里我们为这个工程再安装一次pytest

在这里插入图片描述
当然，要是希望系统装的依赖可以使用，或者其他项目可以共用依赖，可以将这两个选项勾选上，就不用再额外安装了

这里我们先介绍下pytest的文件、类、方法的命名规范（当然也可以有其他的规则，这个我们后面再说，我们这里只定义一个规则）
1 pytest的测试类文件，文件名小写，且必须以test_开头，多个单词以_连接
2 测试类名必须以Test开头，大驼峰格式
3 测试方法名必须以test_开头，多个单词以_连接，全小写
上述都是针对测试方法和测试类，普通的方法类不要包含test字样，其它规则保持一致即可

2.新建测试类

在这里插入图片描述
如图所示，我们这边新建一个文件test_app1.py，文件中新建了一个测试类TestA，类中创建了4个方法，其中test开头的两个方法是有默认执行按键（向右的三角）的。这就是我们上面说的文件、类、函数的命名规则

3.运行方式

1.主函数运行

我们直接点击下方的主函数运行当前测试文件中的测试方法
在这里插入图片描述
可以看到这边执行了两个测试方法

2.命令行运行

我们在下方命令行中输入

pytest 文件名

在这里插入图片描述
可以看到这里也显示有两个用例通过，但是注意这里是没有print信息打印的哦，我们在pytest后加-s即可打印print信息

3.使用pytest.ini配置文件运行

pytest.ini文件是整个工程的配置文件，通常创建在工程的根目录下，里面的配置我们在执行工程时会自动调用。
这里我们先介绍下pytest.ini的常用配置：

参数	作用
[pytest]	用于标志这个文件是pytest的配置文件
addopts	命令行参数，多个参数用空格间隔，例如上面的-s就可以加在这个参数后面
testpaths	执行用例的范围，如果工程中有多个目录，可以在这里配置
python_files	改变默认的文件搜索规则，这里指的就是以test开头的文件名
python_classes	改变默认的类名搜索规则，这里指的就是以Test开头的类名
python_functions	改变默认的方法名搜索规则，这里指的就是以test开头的方法名
markers	用例标记；当用例较多时，可用这个参数分类标记用例，执行时可按标记执行相应的用例

在这里插入图片描述

这里我们在pytest.ini中配置了执行参数-s，然后我们在命令行中直接执行pytest，它会自动带参数执行自动化工程（主函数和命令行执行都会默认带pytest.ini下配置的参数），这里我们没有配置python_files，python_classes，python_functions参数，但是它还是执行了这两个方法，说明它是按照默认规则来执行的。
这里我们也可以修改规则来是适配我们特殊的规则
例如：
我们修改下文件方法的搜索适配规则
在这里插入图片描述
然后我们新建一个文件

直接输入pytest，查看执行结果，可以看到只执行了两个符合规则的用例

然后我们再加入testpaths这个参数

可以看到执行的下面这个文件夹中的用例

我们虽然可以修改用例的匹配规则，但建议不修改。修改后不一定所有人都能完全按照新规则编写，而且有时候新规则和默认规则会有冲突，不会完全修改默认规则（这里面还是有点坑的，慎踩），所以不建议修改。
然后我们再补充一点命令行执行参数，即加在addopts参数后的
具体可参考这篇文档
https://docs.pytest.org/en/stable/reference/reference.html#command-line-flags

4.流程控制

1.类中定义的setup和teardown方法

和多数自动化测试框架一样，pytest也支持在类中增加setup和teardown方法，直接上个例子

在这里插入图片描述
在类中我添加了方法和类的setup和teardown方法
这里可以看到其执行顺序为

2.用fixture来实现前后置操作

我们先介绍下装饰器@pytest.fixture()
其函数名为：

def fixture(fixture_function: FixtureFunction | None = None,*,scope: _ScopeName | Callable[[str, Config], _ScopeName] = "function",params: Iterable[object] | None = None,autouse: bool = False,ids: Sequence[object | None] | Callable[[Any], object | None] | None = None,name: str | None = None,
)

其中我们主要关注的参数为：

参数	作用
scope	作用域，Literal[‘session’, ‘package’, ‘module’, ‘class’, ‘function’]
params	方法入参，用例可从这个参数里取到入参
autouse	是否自动生效
ids	可和上方的params配合使用。作为每个参数的标识
name	用于对fixture函数的重命名

下面我们介绍各个参数的具体用法

1.scope

scope为该方法的作用范围

取值	说明
function	函数级，即每个用例前后都会调用
class	类级，每个类前后都会调用
module	模块级，每个py文件前后都会调用
package	包级，每个模块包前后会调用
session	会话级，即执行自动化工程前后会调用

这里我们举两个例子：
1、我们scope取值为function，可以看到每个用例前都执行了一次
在这里插入图片描述 2、我们scope取值为class，可以看到每个类前都执行了一次，注意：这里有两个方法是不在类下面的，这两个方法之前也执行了fixture方法，说明类外的用例方法前都是执行scope作用域为class的fixture

3、接下来我们讲一下module、package和class级的，要注意这几个都是会在多个文件前后执行的。上面我们介绍的fixture方法是写在一个py文件中的，在执行时不会作用到其他py文件中去，哪怕scope取值为function和class也一样，我们有时候在每个用例或每个类前后都要执行公共操作，这样每个文件里写一个方法，显然很不方便。这里引入一个文件:

conftest.py

如果我们希望多个py文件可以共享fixture方法，可以将fixture方法放在conftest.py文件中，这样工程中所有的文件都会共享到这些fixture方法
在这里插入图片描述
这里可以看到两个py文件都使用了这些方法

当然，除了工程根目录下可以建conftest.py文件，其他目录或者包下也可以存放conftest.py，但是要注意作用域范围，一般执行的优先级为（根目录>二级目录>三级目录…）
这里有两点要注意：
1.conftest.py文件名不能写错，写错无法找到fixture方法
2.fixture方法名不能一样，否则会冲突，只执行一个
4.这里我们再讲一下scope为session的
在这里插入图片描述
这里我们看到只在整个工程执行之前执行了一次，平时我们自己执行工程也就会执行一次，比如像一些登录或初始化的动作可以写在这个方法里；但是我们大批量执行自动化时，可能自动化工程分散在多个执行机或多个批次执行时，那这个方法就会执行多次，即每次输入执行pytest时，执行一次session方法

2.autouse

默认值为False，即默认不执行，如果设置为True，则默认调用
可以看到上面举scope的例子的时候，autouse都是赋值的True，这样它就会默认在每个类/方法前自动调用了。
我们不赋值时，就是默认不调用了，如果我们某些方法需要调用呢，可以手动调用；手动调用则直接在用例方法中传入fixture方法名即可（这里为了方便截图，我还是把fixture方法写在同一个py文件中）

在这里插入图片描述
可以看到，这里只有test_2方法前执行了fixture方法。
如果这里的作用域是class呢，同一个class中多次手动调用fixture方法，它只会在第一次调用时执行

到这里，我们只介绍了如何执行前置步骤，如果我们需要后置步骤，或者前置步骤中需要传值出来呢
要想传值出来，我们有两种方法

1.关键字return

在这里插入图片描述
可以看到我们调用函数名即可获取其返回值
此外，fixture函数可以多层调用，假如我们有两个fixture方法，第二个方法调用第一个方法

可以看到，第二个方法调用了第一个方法，test_2用例方法又调用了第二个方法，其先执行的是第一个fixture方法，即先执行最内层被调用的方法，一层一层向外执行，如果需要用到这种场景，可以参考

2.关键字yield

yield关键字可以用来返回值和操作后置步骤，yield后跟返回值，yield下面则跟后置步骤

在这里插入图片描述
可以看到，我们这里的fixture作用域是class，且是自动调用的，所以在test_1那里就调用了前置步骤，test_2处调用了其返回值，test_3后即整个class后调用了后置步骤

3.params和ids

params可以向fixture中传入参数，并且可以与ids一起使用，作为每个参数的标识。
fixture将params列表中传入的每一组值都会执行一遍，与此对应的testcase也都会执行多遍，具体调用如下，用request关键字来承接入参，并使用request.param来获取入参
在这里插入图片描述

可以看到test_2方法执行了3次，每次都输出了从fixture方法中获取的值，并且可以看到我这边params中传入的值不是一个类型的，所以params整个是一个大数组，具体每个数组位是什么类型的值都不影响，且类型不一样也可以。
这时候我们可以再加个ids
在这里插入图片描述
可以看到这里就显示ids了，我们后面集成allure显示报告时也会用到（实际使用看个人需要了，一般场景下可不用）

4.name

fixture方法的重命名，一般我们调用fixture方法时，直接写其方法名即可，如果使用了name参数，则调用时只能使用name后赋值的新函数名，使用原函数名会报错
这里我们重命名一下fixture函数，但是调用时还调用原函数名，就报错找不到这个函数
在这里插入图片描述
我们调用重命名的setup，即可调用成功

综上所述：fixture方法用得比较多的就是scope和autouse两个参数，其他几个参数请根据各自场景选用。

注：本文纯手打，有疏漏之处可留言指出。后续会继续更新自动化工程的其他部分。