change: rename render_html_report to gen_html_report

This commit is contained in:
debugtalk
2019-11-02 01:01:01 +08:00
parent 6a943eb424
commit 3daed4e884
5 changed files with 17 additions and 11 deletions

View File

@@ -2,9 +2,15 @@
## 2.3.2 (2019-11-01)
**Added**
- docs: add docs content to repo, visit at `https://docs.httprunner.org`
- docs: update developer interface docs
**Changed**
- make render_html_report separate with HttpRunner().run_tests()
- rename `render_html_report` to `gen_html_report`
- make gen_html_report separate with HttpRunner().run_tests()
- `--report-file`: specify report file path, this has higher priority than specifying report dir.
- remove `summary` property from HttpRunner

View File

@@ -314,12 +314,12 @@ summary = runner.run(path_or_tests)
## 生成 HTML 测试报告
如需生成 HTML 测试报告,可调用 `report.render_html_report` 方法。
如需生成 HTML 测试报告,可调用 `report.gen_html_report` 方法。
```python
from httprunner import report
report_path = report.render_html_report(
report_path = report.gen_html_report(
summary,
report_template="/path/to/custom_report_template",
report_dir="/path/to/reports_dir",
@@ -327,7 +327,7 @@ report_path = report.render_html_report(
)
```
`render_html_report()` 的参数有四个:
`gen_html_report()` 的参数有四个:
- summary必传: 测试运行结果汇总数据
- report_template可选: 指定自定义的 HTML 报告模板,模板必须采用 Jinja2 的格式