『Python』pytest 单元测试迅速上手 (for Pycharm)

背景介绍
进行项目交付之前，甲方通常需要开发者保证项目代码的测试覆盖率达到某个值，为此我们需要为项目中的代码编写相应的单元测试，然后把代码提交到 $CI$ 工具，运行 $pipeilne$ 并得到单元测试(后面简称 $UT$)代码对项目代码的覆盖率
在项目开发的过程中，若可以确定某部分代码在未来不怎么会改动，就可以为这部分代码写 $UT$ 代码了

$$写UT前的准备工作$$

一、文件夹创建

为 $UT$ 单独创建一个文件夹 $tests$，用于存放单元测试需要用到的所有东西

二、创建测试文件

存放$UTcode$的 $py$ 文件个人习惯以 ‘$test$_’ 开头
比如我想为项目代码里的 $logic$ 写 $UTcode$ ,那就可以创建一个这样的文件：

三、安装 $package$

# Cmd code in Anaconda Prompt(Anaconda3):
pip install pytest==6.2.4
pip install pytest-cov==2.11.1

$$开始编写UTcode$$

写 $UTcode$ 的目的，实际上就是验证某个代码块(通常为函数)的输出是否符合我们的预期。其中用到的核心方法是 assert,若输出与预期相符,则该测试函数就能成功覆盖项目代码中使用到该代码块的区域

一个简单的例子：
比如在项目代码中使用了这样的函数:
def sum_two_number(a, b):
    result = a + b
    return result

那么相应的测试函数可以为：
def test_sum_two_number():
    a = 3
    b = 2
    expected_num = 5
    output = sum_two_number(a, b)
    assert expected_num == output

$$写UTcode可以参考的一些思想$$

一、针对没有返回对象的函数

在 $development$ 阶段，项目内的一些函数并不需要任何代码层面的输出，比如不需要 $return$ 一个变量但是可能会在 $local$ 生成文件,对于这种函数，在你确保它肯定能正常运行(工期很赶 )的前提下，可以简单粗暴地在测试函数中调用该函数，然后在测试函数的结尾直接 $assertTrue$：

🔺：在被测函数能正常运行的前提下，这似乎是万能的方法，不过别人在看你的 $UTcode$时会一脸懵逼 😛，除非真的是逼不得已要提高覆盖率或者某个函数很易懂没必要浪费精力去写，不然还是不建议这样写的
当然如果该函数生成了一个文件，那也可以选择使用 assert Path(file_path).exists() 进行简单验证

二、生成DataFrame的中间函数

这种函数的测试方法就很多了,可以视情况而定,基本思想是利用 $df$ 的属性($shape、column$等)进行验证

• 若确定它的行数是固定的，直接assert len(df) == row_number即可；
• 若确定它的 $column$ 不变，可以在测试函数中直接 $hardcode$ 一个列表(columns_list)，然后assert df.columns.tolist() == columns_list即可

当然以上都是比较粗粒度层面的验证，仅作为思路提供

三、有多个输出的函数

由于一个测试函数只能存在一个 $assert$，但我们希望在一个测试函数内尽量把所有输出都覆盖,那可以通过元组同时验证这些输出：
output_1, output_2 = function_1()
assert (output_1, output_2) == (expected_1, expected_2)

$$如何在本地终端运行UT代码$$

一、运行某个测试文件下的所有测试函数

python -m pytest 测试文件夹/测试函数文件

python -m pytest tests/tests_logic.py

二、运行某个测试文件下的单个测试函数(类)

python -m pytest 测试文件夹/测试函数文件/测试类(测试函数)

python -m pytest tests/test_logic.py::class(function)

三、查看某个测试文件对某文件夹的测试覆盖率

该命令运行结束后会在项目文件夹下生成一个名为 $htmlcov$ 的文件夹，里面包含多个 $html$ 格式的报告，从 $index.html$ 进入，能方便地查看自己编写的测试函数覆盖了项目代码的哪些区域以及各个区域的覆盖率：

python -m pytest --cov=要看覆盖率的文件夹 测试文件夹/测试函数文件 --cov-report=html

python -m pytest --cov=src tests/test_logic.py --cov-report=html