Pytest 作为基于 Python 的全功能测试框架,凭借简单易读的语法、灵活的测试用例编写方式,还能轻松管理测试流程、生成测试报告,支持 fixture 和各类插件,成为了很多开发者的首选。不过,不少 Windows 用户在安装配置 Pytest 时总会遇到各种问题,今天就给大家带来一篇超详细的教程,从 Python 环境搭建到 Pytest 配置,再到 PyCharm 集成,手把手教你搞定。
一、先装 Python,这是基础中的基础
要使用 Pytest,首先得有 Python 环境。别担心,步骤很简单:
- 打开浏览器,访问 Python 官网(https://www.python.org/downloads/windows/),找到 Windows 系统对应的最新版本 Python 安装包,点击下载。
- 下载完成后,双击安装包开始安装。这里有个关键步骤,一定要勾选 “Add Python to PATH” 选项,把 Python 添加到系统环境变量中,这样后续在任何目录下都能调用 Python 解释器,避免后续出现 “Python 不是内部或外部命令” 的报错。
- 按照安装向导一步步点击 “下一步”,直到安装完成。
二、安装 Pytest,两种方式任你选
Python 环境搞定后,就该安装 Pytest 了,最常用的是直接用 pip 命令安装,还有一种是结合虚拟环境安装,先给大家说第一种简单的:
方式一:直接用 pip 安装
- 按下 Win+R 键,输入 “cmd” 打开命令提示符。
- 在命令行中输入 “pip install pytest”,然后按下回车键,等待安装完成。
- 安装结束后,输入 “pytest --version” 来验证是否安装成功。如果能显示出 Pytest 的版本信息,比如 “pytest 7.4.3”,那就说明安装没问题了。
方式二:结合虚拟环境安装(推荐)
为什么推荐这种方式呢?因为虚拟环境能保证 Python 依赖库版本一致,避免不同项目之间的依赖冲突,尤其是在多人协作或者多个项目开发时,特别有用。
- 打开命令提示符,用 “cd” 命令进入到你想创建虚拟环境的目录,比如 “cd D:\test_project”。
- 输入 “python -m venv venv” 命令,在当前目录下创建一个名为 “venv” 的虚拟环境。这里第二个 “venv” 是虚拟环境的名称,你也可以改成自己喜欢的,不过建议用简单好记的名字。
- 激活虚拟环境,输入 “venv\Scripts\activate”。激活成功后,你会看到命令行提示符前面多了 “(venv)”,这就表示现在处于虚拟环境中了。
- 在虚拟环境里,同样输入 “pip install pytest” 安装 Pytest。
- 当不需要使用虚拟环境时,输入 “deactivate” 命令就能退出虚拟环境,命令行提示符前面的 “(venv)” 会消失。
三、配置 Pytest,让测试更顺手
安装好 Pytest 后,还需要进行一些配置,比如指定测试文件路径、设置日志输出等,这样测试用例才能正确运行。
- 确保处于虚拟环境中,在命令行输入 “pytest --genscript=pytest.ini”,会在当前目录下生成一个 pytest.ini 配置文件。
- 找到生成的 pytest.ini 文件,用记事本或者其他文本编辑器打开,修改里面的内容。下面给大家一个常用的配置示例,大家可以根据自己的需求调整:
[pytest]
addopts = -s -q --alluredir allure-report
testpaths = tests
log_cli = true
log_cli_level = INFO
log_cli_format = %(asctime)s [%(levelname)s] %(message)s (%(filename)s:%(lineno)s)
log_file = logs/test.log
log_file_level = INFO
log_file_format = %(asctime)s [%(levelname)s] %(message)s (%(filename)s:%(lineno)s)
junit_family = xunit2
markers =
smoke: run the smoke test cases
regression: run the regression test cases
performance: run the performance test cases
给大家解释下关键配置项的含义:
- addopts:指定 Pytest 命令行参数,“-s” 能打印测试函数中的 print 和 logging 信息,“-q” 简化输出,只展示关键信息,“--alluredir allure-report” 指定 Allure 测试报告的生成目录。
- testpaths:指定要运行测试用例的目录或文件,这里设置为 “tests”,表示从 tests 目录下找测试用例。
- log_cli:设置为 “true”,表示将日志输出到控制台,方便实时查看。
- log_cli_level:控制台输出日志的级别,这里设为 “INFO”,常见的级别还有 DEBUG、WARNING、ERROR 等。
- log_file:指定日志文件的路径,把日志保存到 “logs/test.log” 文件中,方便后续查看历史日志。
- markers:给测试用例分类标记,比如 “smoke” 表示冒烟测试用例,后续可以通过标记只运行特定类型的测试用例。
四、PyCharm 配置测试环境,可视化操作更简单
很多开发者习惯用 PyCharm 写 Python 代码,在 PyCharm 中配置 Pytest 环境,能更方便地编写和运行测试用例,步骤如下:
- 打开 PyCharm,点击菜单栏的 “File -> New Project”,创建一个新的项目。选择项目保存路径,然后在 “Python interpreter” 这里,建议选择之前创建的虚拟环境中的解释器,路径一般是 “venv\Scripts\python.exe”,这样能保证项目依赖和虚拟环境一致。
- 在新建的项目中,右键点击项目名称,选择 “New -> Python File”,给文件命名为 “test_example.py”,然后在文件中编写简单的测试用例,比如:
def test_addition():
assert 2 + 3 == 5
def test_subtraction():
assert 5 - 3 == 2
这两个测试用例很简单,分别测试加法和减法是否正确,用 “assert” 断言判断结果是否符合预期。
3. 安装 Pytest 插件。点击菜单栏的 “File -> Settings”,在弹出的窗口左侧找到 “Plugins”,在搜索框中输入 “Pytest”,找到对应的插件后点击 “Install” 进行安装,安装完成后需要重启 PyCharm 生效。
4. 配置测试环境。点击菜单栏的 “Run -> Edit Configurations”,在弹出的窗口中,点击左上角的 “+” 号,选择 “Python tests -> pytest”。
5. 在配置页面中,“Script Path” 这里输入要运行的测试文件路径,比如 “D:\test_project\test_example.py”;“Python interpreter” 选择虚拟环境中的解释器;“Additional Arguments” 可以输入 Pytest 的参数,比如 “-s -v”,“-v” 能显示更详细的测试结果。
6. 配置完成后点击 “OK”,然后点击菜单栏的 “Run -> Run 'pytest in test_example.py'”,就能运行测试用例了。运行完成后,在 PyCharm 的控制台会显示测试结果,包括测试用例是否通过、运行时间等信息。