使用pytest的小伙伴一定对插件pytest-html不陌生。pytest-html主要是用来生成HTML格式的测试报告。

大家最常用的两个参数一定是--html=report.html 和--self-contained-html

那么pytest-html除了这两个参数还有哪些参数供大家使用呢？本文就来介绍一下：

pytest-html 插件提供了多个参数来自定义生成的 HTML 测试报告。以下是常用的参数及其详细解释：

1. --html=report.html

• 作用：指定生成的 HTML 报告的文件名和路径。

• 示例：pytest --html=report.html

• 说明：默认生成名为 report.html 的文件在当前目录，可自定义路径如 --html=reports/report.html。

2. --self-contained-html

• 作用：将 CSS 样式和图片内联到 HTML 文件中，生成独立的报告。

• 示例：pytest --html=report.html --self-contained-html

• 说明：无需外部文件支持，适合通过邮件发送或离线查看。

3. --css=path/to/style.css

• 作用：添加自定义 CSS 文件以覆盖默认样式。

• 示例：pytest --html=report.html --css=custom.css

• 说明：可修改报告的颜色、字体、布局等样式。

4. --metadata KEY VALUE

• 作用：向报告中添加元数据（如项目版本、环境信息）。

• 示例：pytest --html=report.html --metadata Version 1.0 --metadata Environment QA

• 说明：多个 --metadata 参数可添加多个键值对，显示在报告的“Environment”部分。

5. --title=Report Title

• 作用：设置 HTML 报告的标题。

• 示例：pytest --html=report.html --title="Test Results"

• 说明：标题显示在浏览器的标签页和报告头部。

6. --logo=logo.png

• 作用：在报告中添加 Logo 图片。

• 示例：pytest --html=report.html --logo=company_logo.png

• 说明：需结合自定义 CSS 调整 Logo 的位置和大小。

7. --environment KEY VALUE

• 作用：添加特定的环境变量到报告中。

• 示例：pytest --html=report.html --environment OS Linux --environment Python 3.9

• 说明：与 --metadata 类似，但专门用于环境信息。

8. --template=template.html

• 作用：使用自定义的 Jinja2 模板生成报告。

• 示例：pytest --html=report.html --template=custom_template.html

• 说明：允许完全自定义 HTML 结构和样式，需熟悉模板语法。

10. --no-header

• 作用：不显示报告的头部信息（如标题、元数据）。

• 示例：pytest --html=report.html --no-header

• 说明：生成更简洁的报告，直接展示测试结果表格。

11. --asset-url=URL

• 作用：指定外部资源的 URL（当未使用自包含 HTML 时）。

• 示例：pytest --html=report.html --asset-url=https://example.com/assets

• 说明：CSS 或图片等资源从指定 URL 加载，减少报告文件大小。

12. --extra=EXTRA

• 作用：向报告中添加额外内容（如自定义链接或文本）。

• 示例：需结合钩子函数使用，非直接命令行参数。

• 说明：通过编写 pytest_configure 钩子添加额外数据。