PyCharm pytest详解|极客笔记

PyCharm pytest详解

一、PyCharm简介

PyCharm是由JetBrains开发的一款专业的Python集成开发环境（IDE），具备强大的功能和灵活的配置选项，是Python开发者首选的开发工具之一。

二、pytest概述

pytest是一款使用广泛的Python单元测试框架，它扩展了Python标准库中的unittest模块，提供了更多的功能和更友好的语法，使得编写和运行测试变得更加简单和高效。

PyCharm是全面集成了pytest的开发环境，通过PyCharm可以方便地编写、运行和管理pytest测试用例。

三、安装与配置pytest

安装pytest

在PyCharm中安装pytest非常简单，只需要在PyCharm的Settings中找到”Python Interpreter”，点击”+”按钮搜索pytest，选择安装即可。

配置pytest

在PyCharm的Settings中，可以对pytest进行详细的配置，例如设置pytest的启动参数、指定pytest运行的测试目录、配置pytest插件等。

四、编写pytest测试用例

创建pytest测试文件

在PyCharm中，右键点击项目目录，选择”New” -> “Python File”，输入文件名并选择文件保存路径，即可创建一个新的pytest测试文件。

编写pytest测试用例

pytest测试用例的命名规则是以”test_”开头的函数，使用特定的断言方法来进行测试判断。下面是一个简单的示例：

# -------------------test_example.py-------------------
def add(x, y):
    return x + y

def test_add():
    assert add(3, 4) == 7
    assert add(1, 2) == 3

在上述示例中，我们定义了一个add函数，然后使用pytest的assert断言方法来判断add函数的返回结果是否符合预期。如果assert断言失败，则意味着测试用例失败。

五、运行pytest测试用例

运行单个测试文件

在PyCharm中，可以通过右键点击测试文件，选择”Run ‘pytest in test_example'”来运行当前文件中的所有测试用例。

在PyCharm的运行配置中，可以选择”Python tests” -> “pytest”作为运行配置类型，并指定运行目录为当前项目的测试目录。然后点击运行按钮即可运行整个测试目录中的所有测试用例。

查看测试结果

运行测试用例后，PyCharm会将测试结果以树形结构显示在界面的”Run”面板中。绿色的叶子节点表示测试用例通过，红色的叶子节点表示测试用例失败。点击叶子节点，可以查看具体的测试结果和错误信息。

六、pytest高级功能

pytest提供了许多高级功能，帮助开发者编写更复杂、更灵活的测试用例。

参数化测试

pytest支持使用@pytest.mark.parametrize装饰器来实现参数化测试，可以在一个测试函数中运行多组测试数据，减少重复的代码。例如：

# -------------------test_parameterize.py-------------------
import pytest

def add(x, y):
    return x + y

@pytest.mark.parametrize("a, b, expected", [
    (1, 2, 3),
    (3, 4, 7),
])
def test_add(a, b, expected):
    assert add(a, b) == expected

在上述示例中，使用了pytest.mark.parametrize装饰器，将多组测试数据作为参数传入测试函数，并使用assert断言判断函数返回结果是否符合预期。

跳过测试

有时候我们希望暂时跳过某些测试用例，可以使用pytest提供的@pytest.mark.skip或@pytest.mark.skipif装饰器来实现。例如：

# -------------------test_skip.py-------------------
import pytest

def add(x, y):
    return x + y

@pytest.mark.skip(reason="暂时跳过此测试")
def test_add():
    assert add(3, 4) == 7

@pytest.mark.skipif(pytest.__version__ < "5.0", reason="pytest版本低于5.0，跳过此测试")
def test_version():
    assert pytest.__version__ == "5.0"

在上述示例中，使用了@pytest.mark.skip装饰器标记test_add函数，暂时跳过这个测试。使用了@pytest.mark.skipif装饰器标记test_version函数，如果pytest的版本低于5.0，则跳过这个测试。

使用自定义Fixture

pytest提供了一种fixture的机制，用于在测试函数执行前后进行一些准备和清理工作。通过pytest.fixture装饰器，可以定义一个fixture函数，然后在测试函数中使用该fixture函数。例如：

# -------------------test_fixture.py-------------------
import pytest

@pytest.fixture()
def setup_data():
    data = [1, 2, 3, 4, 5]
    return data

def test_length(setup_data):
    assert len(setup_data) == 5

def test_sum(setup_data):
    assert sum(setup_data) == 15

在上述示例中，定义了一个名为setup_data的fixture函数，返回一个数据列表。在test_length和test_sum两个测试函数中，通过参数传入setup_data，即可使用fixture函数提供的数据。