背景
因為近期工作需要，常常要將測試結果/數據統計、匯總和展示，因此會有寫靜態HTML的需求，本文記錄下python寫靜態HTML的小技巧
靈感
靈感時來源於unittest測試框架最常用的報告插件：HTMLTestRunner，該插件本身基於python2且已經更新了，好在@蟲師一直在維護和更新這個插件，使得它能繼續被大家所使用，了解詳情請移步：SeldomQA/HTMLTestRunner
回到HTMLTestRunner報告插件，閱讀源碼發現，作者只用了一個python文件便巧妙的將寫HTML、頁面繪制和數據嵌入搞定了。進一步分析可以看到，作者先是在Template基類中定義了測試報告的HTML結構模板和各個模塊/表格模板，然后再以格式化輸入的形式給每一個模板中填充目標數據，再將填充好的模板以格式化輸入的形式填充到HTML結構模板中，最后再將所有內容寫成一個HTML文件即可。
class Template_mixin(object):
"""
Define a HTML template for report customerization and generation.
Overall structure of an HTML report
HTML
+------------------------+
|<html> |
| <head> |
| |
| STYLESHEET |
| +----------------+ |
| | | |
| +----------------+ |
| |
| </head> |
| |
| <body> |
| |
| HEADING |
| +----------------+ |
| | | |
| +----------------+ |
| |
| REPORT |
| +----------------+ |
| | | |
| +----------------+ |
| |
| ENDING |
| +----------------+ |
| | | |
| +----------------+ |
| |
| </body> |
|</html> |
+------------------------+
"""
可以看到，這樣的設計其實優點在於非常小巧和輕量，缺點在於可維護和可移植性差，數據量小還尚可，不太適合大量數據的統計和繪制。
技巧
這種設計的關鍵在於建模板，然后按需填充數據，最后再寫HTML，通常我的做法是：
- 網上找到想要的頁面或着表格，copy其HTML結構，將變動的部分（需要動態填充數據的部分）提取出來，並用格式化輸入形式替代，如：
%(style)s, %(rows)s
HTML_TMPL = r"""
<!DOCTYPE html>
<html lang="en">
<head>
<title>Overview</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
%(style)s
</head>
<body>
<h1> 總覽 </h1>
<table class="pure-table pure-table-bordered">
<thead>
<tr>
<th>#</th>
<th>設備</th>
<th>環境</th>
<th>耗時</th>
<th>結果</th>
<th>統計</th>
<th>報告</th>
</tr>
</thead>
<tbody>
<tr>
%(rows)s
</tr>
<tr>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
%(total)s
</tr>
</tbody>
</table>
</body>
</html>
""" # style, rows, total
- 將變動的部分單拎出來，形成模板，依然用格式化輸入形式替代
TBODY_TOTAL_TMPL = """
<tr>
<th> 合計 </th>
<th colspan="6"> 通過率: {passing_rate}% 失敗率: {failure_rate}%
錯誤率: {error_rate}% 跳過率: {skip_rate}% </th>
</tr>
"""
- 按照模板格式，組裝數據並填充
total += TBODY_TOTAL_TMPL.format(
passing_rate=np.mean(p_rates).round(2),
failure_rate=np.mean(f_rates).round(2),
error_rate=np.mean(e_rates).round(2),
skip_rate=np.mean(s_rates).round(2))
- 最后將所有數據填充到主模板，並寫HTML
# write reporter
with open(filepath, 'w', encoding='utf-8') as wf:
wf.write(HTML_TMPL % dict(rows=rows, total=total, style=STYLE_TMPL))