神器Jinja2，用 Python 快速生成分析报告！

青旅半醒 2022-09-10 13:30 77阅读 0赞

点击上方“**Python爬虫与数据挖掘**”，进行关注

回复“**书籍**”即可获赠Python从入门到进阶共10本电子书

今

日

鸡

汤

夜阑卧听风吹雨，铁马冰河入梦来。

大家好，我是早起。

在之前的[文章][Link 1]中，我们使用 Python 开发了一个简单的基金购买策略的回测系统。在代码执行完毕后，会生成一系列的结果，包含大量图片、表格如下![411a1c531cc352a75e55f554f60020dc.png][]

此时如果一个一个查看的话便十分低效，如果能使用一个文件把全部输出结果都保存将会大大提高体验。

首先想到的当然是 `PDF` 格式，利用 Python 操作 PDF 也是之前文章分享过很多，想必利用表格+图片生成一个新的PDF并不困难。研究了一番后，发现确实不难，但是**太繁琐了**，并且 PDF **涉及格式、分页等**，如果没有调整好可能会将一张图片放在两页或者一页只有一张图其余全是空白，十分影响美观，由于我每次产生的结果并不固定，因此很难找到一个通用的模版，遂放弃。

PDF 既然不行，Word就更不用考虑了，所以只能选择 `html` 格式，虽然跨平台性没有 PDF 好，但是胜在**排版简单**，不需要考虑分页处理。基于 Python 生成 html 有很多成熟的 web 开发框架可以选择，但为了整体过程不太复杂，最终选择 `Jinja2` 来实现这个需求。

jinja2

Jinja2 是一个 Python 的功能齐全的模板引擎，简单来说就是**我们将 html 的主要部分写好，将需要填充的内容空出来，这样就是一个模版，之后就可以使用 Jinja2 来自动将模版文件填充，形成一个完整的 html 文件。**

## 填入文字 ##

首先我们需要制作一个最简单的模版文件`template.html`，内容如下

<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
        <title>report</title>
    </head>
    <h1>基金策略回测报告</h1>
        <body>
        <h2>一、策略详情</h2>
        <p>策略描述：{
        { strategy_name }}</p>
        <p>回测时间段：{
        { start_time }} --> {
        { end_time }}  </p>
        <p>初始本金：{
        { money }}</p>
        </body>
    </html>

直接打开如下![7117493416461303ab904693fd0da9cc.png][]

其中被 `{ {}}` 包起来的变量，就是我们需要用 Python 传递给模版的，很明显上方代码缺少四个变量，下面是 Python 代码

import pandas as pd
    from jinja2 import Environment, FileSystemLoader
    
    
    data = {'strategy_name': '第一个策略',
            'start_time': '2020-01-01',
            'end_time': '2021-06-01',
            'money': 20000}
    
    env = Environment(loader=FileSystemLoader('./'))
    
    template = env.get_template('template.html')
    
    with open("out.html", 'w+', encoding='utf-8') as f:
        out = template.render(strategy_name=data['strategy_name'],
                              start_time=data['start_time'],
                              end_time=data['end_time'],
                              money=data['money'])
        f.write(out)
        f.close()

在上面的代码中，我们使用`env.get_template('template.html')`读取模版文件，并将需要需要传入的数据写入字典中，并将 `value` 通过`template.render`传给模版并渲染输出，现在打开生成的 out.html 内容如下![e06a2062fdc67ccdb29945555f2d16db.png][]

可以看到目标位置的文字都被正确填充，当然填入文字是最基本的操作，下面继续介绍如何自动创建表格。

## 填入表格 ##

其实填入表格和填入文字本质上是一样的，只不过需要使用循环来操作，例如将`回测指标汇总.xlsx`添加到html中![c85e6b031539361f8dfb50b15037a70c.png][]

首先在模版文件中创建一个表格

<h2>二、回测结果</h2>
    
        <table border="1" width = "40%" cellspacing='0' cellpadding='0'>
        <tr>
            <th>基金名称</th>
            <th>总投入本金</th>
            <th>总收益率</th>
            <th>最大回测率</th>
        </tr>
    
        {% for item in items %}
        <tr align='center'>
            <td>{
        { item.基金名称 }}</td>
            <td>{
        { item.消耗本金 }}</td>
            <td>{
        { item.总收益率 }}</td>
            <td>{
        { item.最大回撤率 }}</td>
        </tr>
        {% endfor%}
        </table>

在上面的代码中，我们使用创建了一个table，并将表头写好，将 cell 内容设置为待填充，注意在jinja2中的循环是通过`{% %}`来完成的。

例如`{% for item in items %}` 就需要我们传入一个字典形式 items ，并且里面包含基金名称、消耗本金、总收益率、最大回撤率四个key，此时 Python 代码修改如下

import pandas as pd
    from jinja2 import Environment, FileSystemLoader
    
    df = pd.read_excel('回测指标汇总.xlsx')
    df['消耗本金'] = df['消耗本金'].astype(str) + ' 元'
    df['最大回撤率'] = df['最大回撤率'].astype(str) + '%'
    df['总收益率'] = df['总收益率'].astype(str) + '%'
    data = df.to_dict('records')
    
    results = {}
    results.update({'strategy_name': '第一个策略',
                    'start_time': '2020-01-01',
                    'end_time': '2021-06-01',
                    'money': 20000,
                    'items': data})
    
    env = Environment(loader=FileSystemLoader('./'))
    
    template = env.get_template('template.html')
    
    with open("out.html", 'w+', encoding='utf-8') as f:
        out = template.render(strategy_name=results['strategy_name'],
                              start_time=results['start_time'],
                              end_time=results['end_time'],
                              money=results['money'],
                              items = results['items'])
        f.write(out)
        f.close()

需要注意的是因为我们需要循环操作，所以传入的 items 就需要是可迭代的，但又需要根据关键字匹配值，所以可以将每一行数据转换为字典，并放在 list 中，这一步可以使用 pandas 读取excel并直接使用`df.to_dict('records')`完成（吹一波`pandas`）![d5dcefde5f3869191ec52676121b9579.png][]现在执行上面的代码，并打开输出后的 html![d8b091984ec66846590614b6bfe36074.png][]

可以看到，Excel的全部内容都被正确的填入，下面介绍如何填入图片。

## 填入图片 ##

其实 html 展示图片就是通过`<a>`标签超链接指向图片地址，所以本质上和填充文字差不多，只需要在模版文件中把本地图片地址预留出来，之后使用 jinja2 传入即可，例如可以在模版中添加以下内容

<a name="{
        { 回测指标 }}"> <img src="{
        { indicator }}" width="850"></a>

此时在 Python 代码中指定indicator图片路径并传入即可

indicator = 'images/' + '回测指标.png'
    with open("out.html", 'w+', encoding='utf-8') as f:
        out = template.render(strategy_name=results['strategy_name'],
                              start_time=results['start_time'],
                              end_time=results['end_time'],
                              money=results['money'],
                              items = results['items'],
                              indicator = indicator)
        f.write(out)
        f.close()

执行后即可正确展示图片如下![1bb4d5481bb8b5af02c0ce3703d90e93.png][]

当然我们的图片不止一张，可以像上面插入表格一样将图片地址循环填入即可，本文不再赘述，感兴趣读者可以自己研究。

## 修改样式 ##

当然，默认生成的 html 样式可能不够好看，我们也可以进一步添加一点CSS代码来调整，为了简化可以直接将代码写在标签中

主要是添加了一点缩进和间距，让结果看起来更舒服一点，现在自动生成的 html 文件部分如下![a002d766f886da3909ddaf7bac6584f3.png][]

最后只需要将上述 Python 代码封装，然后在主函数运行结束后自动将相关参数进行传递，即可全程自动化生成 `html` 报告！

当然本文介绍的 Jinja2 操作只是其简单的一个应用，更多的用法与功能感兴趣的读者可以自己查阅官方文档。

![c600b5e20bc57b8bf8704bd4896668d1.png][]

**---\--\---\---\---\--\---** End **---\--\---\--\---\---\--\-**

往期精彩文章推荐：

*  [手把手教你采集京东销售数据并做简单的数据分析和可视化][Link 2]  
    
 *  [手把手教你用Pyecharts库对淘宝数据进行可视化展示][Pyecharts]
 *  [手把手教你用Pandas库对淘宝原始数据进行数据处理和分词处理][Pandas]
 *  [盘点Flask与数据库的交互插件--Flask-Sqlalchemy][Flask_--Flask-Sqlalchemy]

![ed7d909bf552c07c0bd63558fcd685cb.png][]

欢迎大家**点赞，****留言，****转发，转载，**感谢大家的相伴与支持

想加入Python学习群请在后台回复【**入群**】

万水千山总是情，点个【**在看**】行不行

**/今日留言主题/**

随便说一两句吧~~

[Link 1]: https://mp.weixin.qq.com/s?__biz=Mzg5OTU3NjczMQ%3D%3D&idx=1&mid=2247516711&scene=21&sn=b6e550cee3831082b05f8529e7855eeb#wechat_redirect
[411a1c531cc352a75e55f554f60020dc.png]: /images/20220829/44517c12b1d64d889bb594b855ed7fbe.png
[7117493416461303ab904693fd0da9cc.png]: /images/20220829/366d038f4043443b8bafae982f83d33a.png
[e06a2062fdc67ccdb29945555f2d16db.png]: /images/20220829/8cd3b52f1c6541ca972fe0c2d409fc70.png
[c85e6b031539361f8dfb50b15037a70c.png]: /images/20220829/c446fa4d5a3146ebb823dc8fc74f4118.png
[d5dcefde5f3869191ec52676121b9579.png]: https://img-blog.csdnimg.cn/img_convert/d5dcefde5f3869191ec52676121b9579.png
[d8b091984ec66846590614b6bfe36074.png]: /images/20220829/16bc1616b5fc40378598f5a26845e852.png
[1bb4d5481bb8b5af02c0ce3703d90e93.png]: /images/20220829/fac88909b1154b128a6dd567c8cfb7e0.png
[a002d766f886da3909ddaf7bac6584f3.png]: /images/20220829/34105078e74344c3b188207b3d28b82c.png
[c600b5e20bc57b8bf8704bd4896668d1.png]: /images/20220829/7d85df1206274c99bc87158df9426726.png
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzU3MzQxMjE2NA%3D%3D&chksm=fcc0b39dcbb73a8b9fcf4d04678b7c4eed3092183c9550593be754f51ed4815b5272e7cf249d&idx=1&mid=2247497142&scene=21&sn=2317d8b28822b9df6da8527db8627987#wechat_redirect
[Pyecharts]: http://mp.weixin.qq.com/s?__biz=MzU3MzQxMjE2NA%3D%3D&chksm=fcc0b33ccbb73a2a1f4d56275c695dbe8e9ad08cbd54bffa1f20c4de6a434378c9e63967390a&idx=1&mid=2247496983&scene=21&sn=b3db9b4cf5f129b660448bb3d7beed8c#wechat_redirect
[Pandas]: http://mp.weixin.qq.com/s?__biz=MzU3MzQxMjE2NA%3D%3D&chksm=fcc0b32ecbb73a3899a12142429ce31e0758595bb6f46d69be7559f84d5814a48dfcf9a0b05d&idx=1&mid=2247496965&scene=21&sn=f34b655ead49dadd8abb24463e2e607f#wechat_redirect
[Flask_--Flask-Sqlalchemy]: http://mp.weixin.qq.com/s?__biz=MzU3MzQxMjE2NA%3D%3D&chksm=fcc0b2bdcbb73bab9267a53ac5bd3a6f4af4cc76c521f4c5ebef7aa1351039776291289f2b48&idx=1&mid=2247496854&scene=21&sn=60c64c22e97ce97756857b7dae96996e#wechat_redirect
[ed7d909bf552c07c0bd63558fcd685cb.png]: /images/20220829/e40e5e392214416284f85ee834cafa2a.png