学习利用ReportLab生成PDF报表 -- 准备工作及Demo

  1. 官方Demo
    官网提供了一个demo,下载地址:
    http://www.reportlab.com/static/cms/files/RLtutorial.zip
    在运行前需要安装相关的依赖包。在ReportLab网站注册并登陆后会有更完整的文档。
  • rlextra: 安装该包前需要注册ReportLab用户,登陆后才能下载。
    pip install rlextra -i https://www.reportlab.com/pypi
    在下载完成rlextra后会自动下载其他依赖包。
  • preppy: 一种预处理程序,利用其来读取模板template。
    参考: https://bitbucket.org/rptlab/preppy
  • reportlab
  • pyRXP
  • 等等

安装完成相关包后执行文件夹下product_catalog.py,仍发现有很多错误,主要集中在编码,StringIO/BytesIO(Demo文件中是用了StringIO作为buf,但执行报错,查看相关源码文件后发现需要用BytesIO。)上,除此之外Demo中的数据是通过解析XML文件得到的,可能以后使用中不会使用XML来获取数据,所以决定自己重新写一个新的Demo。

  1. 自己编写的SimpleDemo
    简单的生成一份pdf报表主要需要三方面的准备:数据,模板文件(prep, rml),相关简单工具方法。编写模板文件和数据准备相比较更重要,更繁琐,而简单的编写工具方法比较轻松,不过后期肯定需要优化。
  • 数据: 从mongodb数据库中获取。
  • 模板文件: 利用RML(Report Markup Language)编写模板,可在其中嵌套Python代码,详细文档可登陆ReportLab后下载。下面是一个最基本的RML模板(取自官方RML2PDF with Django Demo):
<!DOCTYPE document SYSTEM "rml.dtd">
<document filename="hello.pdf">
    <template showBoundary="0">
        <pageTemplate id="main">
             <frame id="first" x1="50" y1="200" width="450" height="300"/>
        </pageTemplate>
    </template>
    <stylesheet>
        <paraStyle name="textstyle1" fontName="Helvetica" fontSize="24" leading="24" />
    </stylesheet>
    <story>
        <para style="textstyle1">
             Welcome<b>{{name}}<b>, to the world of RML!
        </para>
    </story>
</document>
  • 相关简单工具方法:
from rlextra.rml2pdf import rml2pdf
import preppy
from io import BytesIO
class PDFUtils(object):
        def __init__(self, template_name, namespace, output_filename=None):
            self.template_name = template_name
            self.namespace = namespace
            self.output_filename = output_filename
          
            # 其他相关操作(注册字体等)

        def create_pdf(self):
            source_text = open(self.template_name, 'r', encoding='utf-8').read()
            template = preppy.getModule(self.template_name, sourcetext=source_text)
            # template = preppy.getModule(self.template_name)
            rml = template.getOutput(self.namespace)

            if self.output_filename:
                rml2pdf.go(rml, outputFileName=self.output_filename)
                return True
            else:
                buf = BytesIO()
                rml2pdf.go(rml, outputFileName=buf)
                pdf_data = buf.getvalue()
                return pdf_data

需要注意的是,若要输出IO流(如web请求时下载pdf报表文件),这里用的是BytesIO。若像官方Demo中用StringIO,在执行rml2pdf.go()时会抛出TypeError: string argument expected, got 'bytes'异常,查看文件pdfdoc.py源码:

data = self.GetPDFData(canvas)
if isUnicode(data):
        data = data.encode('latin1')
f.write(data)

这里self.GetPDFData(canvas)返回的是bytes,在f.write()时需要BytesIO类型。(暂时不知道其他解决办法)
除此之外,在利用preppy.getModule()解析rml文件时,若rml文件中出现中文字符直接利用preppy.getModule(template_name)会出现gbk无法解析中文的情况,查看源码发现当只有一个name参数时,getModule()会默认open(name, 'r').read()出现UnicodeDecodeError。所以使用利用sourcetext参数,先按指定编码读取文件内容再解析,即

source_text = open(template_name, 'r', encoding='utf-8').read()
template = preppy.getModule(template_name, sourcetext=source_text)
```,同时需要在rml文件中注册中文字体。
 * main(): 

if name == 'main':
# 模板文件
template = 'hello.rml'
# 输出的pdf
output_filename = 'output/simple_demo.pdf'
# 数据
namespace = {
'name': 'JiangW'
}
p = PDFUtils(template, namespace, output_filename=output_filename)
p.create_pdf()

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容

  • 在生成PDF报表时,往往需要动态的生成表格和一些折线图、饼状图等,利用RML文件和reportlab的api来动态...
    蒋狗阅读 2,814评论 1 1
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,504评论 18 399
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,678评论 6 342
  • 【天界传说】第一部 微互助,全民参与,操作易懂,小投资大收益, 拒绝假实体,拒绝黑客攻击 严谨控盘团队,公开透明,...
    大磊哥哥阅读 188评论 0 0