reportlab 生成pdf文件 (python)

2024-04-17 20:45
文章标签 python 生成 pdf reportlab

本文主要是介绍reportlab 生成pdf文件 (python),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1 安装

pip install reportlab

2 应用场景

  • 通过网页动态生成PDF文档
  • 大量的报告和数据发布
  • 用XML一步生成PDF
    官网案例

3 PLATYPUS

Platypus是“Page Layout and Typography Using Scripts”,是使用脚本的页面布局和印刷术的缩写,这是一个高层次页面布局库,它可以让你通过编程创造复杂的文档,并且毫不费力。

Platypus设计的目的是尽可能地将高层布局设计与文档内容分离,比如,段落使用段落格式构造,页面使用页面模板,这样做是有好处的,在仅仅修改几行代码的情况下,包含数百个页面的数百个文档就能够被构造成不同的风格。

  • Platypus从上到下,可以被看成具备多个层次。
  • DocTemplates:文档最外层的容器
  • PageTemplates:各种页面布局的规格
  • Frames:包含流动的文本和图形的文档区域规范
  • Flowables:能够被“流入文档”的文本、图形和段落等。
    在这里插入图片描述

3.1 start demo

import reportlab
from reportlab.platypus import SimpleDocTemplate, Paragraph
from reportlab.lib.styles import getSampleStyleSheet# 调用模板,创建指定名称的PDF文档
doc = SimpleDocTemplate("start_demo.pdf")
# 获得模板表格
styles = getSampleStyleSheet()
# 指定模板
style = styles['Normal']
# 初始化内容
story =[]
# 将段落添加到内容中
story.append(Paragraph("this is a demo pdf!",style))
# 将内容输出到PDF中
doc.build(story)

在Python文件的同目录下,生成一个文件名为”start_demo.pdf“的文件:
在这里插入图片描述

doc = SimpleDocTemplate("start_demo.pdf") 调用了 BaseDocTemplate模板BaseDocTemplate 基本思想很简单。
1) 该文档有一个与之相关的数据列表,这些数据应该来自流动性。我们会特殊类,如PageBreak、FrameBreak,用于执行强制页面结束等操作。
2) 文档有一个或多个页面模板。
3) 每个页面模板都有一个或多个框架。
4) document类提供了处理故事事件的基本方法,以及将故事流放入框架的一些合理方法。
5) 文档实例可以覆盖基本处理程序例程。
这个类的大多数方法不是由用户直接调用的,但在一些高级用法中,它们可能需要通过子类化来重写。
异常:必须调用doctemplate.build(…)才能获得最合理的用途,因为它使用页面模板生成文档。
每个文档模板在初始化时将恰好一个文档构建到filename参数指定的文件中。
初始化的可能关键字参数:
-pageTemplates:模板列表。必须是非空的。指定给模板的名称用于引用它们,因此使用的两个模板不应具有相同的名称。例如,在奇数页和偶数页上,您可能需要一个标题页模板、一个章节首页模板、一章首页模板和两个章节内部模板。如果省略了此参数,则在生成文档之前,应使用addPageTemplates方法至少提供一个pageTemplate。
-pageSize:reportlab/lib/pagesizes.pu中的2元组或大小常量。由SimpleDocTemplate子类使用,该子类不接受的列表
pageTemplates,但为您制作一个;使用pageTemplates时忽略。
-showBoundary:如果设置,则在框架边界周围绘制一个框。
-左边距:
-右侧边距:
-顶部边距:
-底部边距:以点为单位的边距大小(默认为1英寸)。这些页边距可能会被pageTemplates覆盖。它们主要是SimpleDocumentTemplate子类感兴趣的。
-allowSpliting:如果设置了流动性(如段落),则可以在框架或页面之间进行拆分(默认值:1-title:文档的内部标题(不会自动显示在任何页面上)
-author:文档的内部作者(不会自动显示在任何页面上)初始化参数:'pagesize':defaultPageSize,'pageTemplates':[],'showBoundary':0,'leftMargin':inch,'rightMargin':inch,'topMargin':inch,'bottomMargin':inch,'allowSplitting':1,'title':None,'author':None,'subject':None,'creator':None,'producer':None,'keywords':[],'invariant':None,'pageCompression':None,'_pageBreakQuick':1,'rotation':0,'_debug':0,'encrypt': None,'cropMarks': None,'enforceColorSpace': None,'displayDocTitle': None,'lang': None,'initialFontName': None,'initialFontSize': None,'initialLeading': None,'cropBox': None,'artBox': None,'trimBox': None,'bleedBox': None,'keepTogetherClass': KeepTogether,'hideToolbar': None,'hideMenubar': None,'hideWindowUI': None,'fitWindow': None,'centerWindow': None,'nonFullScreenPageMode': None,'direction': None,'viewArea': None,'viewClip': None,'printArea': None,'printClip': None,'printScaling': None,'duplex': None,

4 段落

段落是一种重要的Flowables,它可以格式化任意的文本。

段落中主要包括两种信息:文本和格式。Paragraph(text, style)

  • text参数提供了段落的文本,末尾和换行处的空白都会被删除。
  • style参数用于设置段落的格式,这里段落的格式是指参数的集合,包括字体大小、行间距、首行缩进等参数。我们可以调用如下语句来获得默认段落格式。
from reportlab.lib.styles import ParagraphStyle

4.1 ParagraphStyle 参数

class ParagraphStyle(PropertySet):defaults = {'fontName':_baseFontName,'fontSize':10,'leading':12,'leftIndent':0,'rightIndent':0,'firstLineIndent':0,'alignment':TA_LEFT,'spaceBefore':0,'spaceAfter':0,'bulletFontName':_baseFontName,'bulletFontSize':10,'bulletIndent':0,#'bulletColor':black,'textColor': black,'backColor':None,'wordWrap':None,        #None means do nothing special#CJK use Chinese Line breaking#LTR RTL use left to right / right to left#with support from pyfribi2 if available'borderWidth': 0,'borderPadding': 0,'borderColor': None,'borderRadius': None,'allowWidows': 1,'allowOrphans': 0,'textTransform':None,   #uppercase lowercase (captitalize not yet) or None or absent'endDots':None,         #dots on the last line of left/right justified paras#string or object with text and optional fontName, fontSize, textColor & backColor#dy'splitLongWords':1,     #make best efforts to split long words'underlineWidth': _baseUnderlineWidth,  #underline width default'bulletAnchor': 'start',    #where the bullet is anchored ie start, middle, end or numeric'justifyLastLine': 0,   #n allow justification on the last line for more than n words 0 means don't bother'justifyBreaks': 0,     #justify lines broken with <br/>'spaceShrinkage': _spaceShrinkage,  #allow shrinkage of percentage of space to fit on line'strikeWidth': _baseStrikeWidth,    #stroke width default'underlineOffset': _baseUnderlineOffset,    #fraction of fontsize to offset underlines'underlineGap': _baseUnderlineGap,      #gap for double/triple underline'strikeOffset': _baseStrikeOffset,  #fraction of fontsize to offset strikethrough'strikeGap': _baseStrikeGap,        #gap for double/triple strike'linkUnderline': _platypus_link_underline,'underlineColor':   None,'strikeColor': None,'hyphenationLang': _hyphenationLang,#'hyphenationMinWordLength': _hyphenationMinWordLength,'embeddedHyphenation': _embeddedHyphenation,'uriWasteReduce': _uriWasteReduce,}

几个重要的参数说明:

  • fontName:字体名称
  • fontSize:字体大小
  • leading:行间距
  • leftIndent:左缩进
  • rightIndent:右缩进
  • firstLineIndent:首行缩进
  • alignment:对齐方式
  • spaceBefore:段前间隙
  • spaceAfter:段后间隙
  • bulletFontName:列表名称
  • bulletFontSize:列表字体大小
  • bulletIndent:列表缩进
  • textColor:字体颜色
  • backColor:背景色
  • borderWidth:边框粗细
  • borderPadding:边框间距
  • borderColor:边框颜色

ParagraphStyle是段落的默认格式,也就是在调用Paragraph(text, style)语句时,如果不传入style参数,默认的段落格式。

还有其他方式获得ReportLab提供的段落格式:

from reportlab.lib.styles import getSampleStyleSheet
stylesheet=getSampleStyleSheet()
normalStyle = stylesheet['Normal']

这里获得系统提供的Normal格式,其实Normal格式与ParagraphStyle是一模一样的,除了Normal格式,还可以获得其他的格式:

  • Normal
  • BodyText
  • Italic
  • Title
  • Heading1
  • Heading2
  • Heading3
  • Heading4
  • Heading5
  • Heading6
  • Bullet
  • Definition
  • Code
  • UnorderedList
  • OrderedList
def getSampleStyleSheet():"""Returns a stylesheet object"""stylesheet = StyleSheet1()stylesheet.add(ParagraphStyle(name='Normal',fontName=_baseFontName,fontSize=10,leading=12))stylesheet.add(ParagraphStyle(name='BodyText',parent=stylesheet['Normal'],spaceBefore=6))stylesheet.add(ParagraphStyle(name='Italic',parent=stylesheet['BodyText'],fontName = _baseFontNameI))stylesheet.add(ParagraphStyle(name='Heading1',parent=stylesheet['Normal'],fontName = _baseFontNameB,fontSize=18,leading=22,spaceAfter=6),alias='h1')stylesheet.add(ParagraphStyle(name='Title',parent=stylesheet['Normal'],fontName = _baseFontNameB,fontSize=18,leading=22,alignment=TA_CENTER,spaceAfter=6),alias='title')stylesheet.add(ParagraphStyle(name='Heading2',parent=stylesheet['Normal'],fontName = _baseFontNameB,fontSize=14,leading=18,spaceBefore=12,spaceAfter=6),alias='h2')stylesheet.add(ParagraphStyle(name='Heading3',parent=stylesheet['Normal'],fontName = _baseFontNameBI,fontSize=12,leading=14,spaceBefore=12,spaceAfter=6),alias='h3')stylesheet.add(ParagraphStyle(name='Heading4',parent=stylesheet['Normal'],fontName = _baseFontNameBI,fontSize=10,leading=12,spaceBefore=10,spaceAfter=4),alias='h4')stylesheet.add(ParagraphStyle(name='Heading5',parent=stylesheet['Normal'],fontName = _baseFontNameB,fontSize=9,leading=10.8,spaceBefore=8,spaceAfter=4),alias='h5')stylesheet.add(ParagraphStyle(name='Heading6',parent=stylesheet['Normal'],fontName = _baseFontNameB,fontSize=7,leading=8.4,spaceBefore=6,spaceAfter=2),alias='h6')stylesheet.add(ParagraphStyle(name='Bullet',parent=stylesheet['Normal'],firstLineIndent=0,spaceBefore=3),alias='bu')stylesheet.add(ParagraphStyle(name='Definition',parent=stylesheet['Normal'],firstLineIndent=0,leftIndent=36,bulletIndent=0,spaceBefore=6,bulletFontName=_baseFontNameBI),alias='df')stylesheet.add(ParagraphStyle(name='Code',parent=stylesheet['Normal'],fontName='Courier',fontSize=8,leading=8.8,firstLineIndent=0,leftIndent=36,hyphenationLang=''))stylesheet.add(ListStyle(name='UnorderedList',parent=None,leftIndent=18,rightIndent=0,bulletAlign='left',bulletType='1',bulletColor=black,bulletFontName='Helvetica',bulletFontSize=12,bulletOffsetY=0,bulletDedent='auto',bulletDir='ltr',bulletFormat=None,#start='circle square blackstar sparkle disc diamond'.split(),start=None,),alias='ul')stylesheet.add(ListStyle(name='OrderedList',parent=None,leftIndent=18,rightIndent=0,bulletAlign='left',bulletType='1',bulletColor=black,bulletFontName='Helvetica',bulletFontSize=12,bulletOffsetY=0,bulletDedent='auto',bulletDir='ltr',bulletFormat=None,#start='1 a A i I'.split(),start=None,),alias='ol')return stylesheet

假如想要获得Title格式,我们只需要按照如下格式调用即可:

from reportlab.lib.styles import getSampleStyleSheet
stylesheet=getSampleStyleSheet()
titleStyle = stylesheet['Title']

从Title的源代码可知:Title的效果是:字体18号;行间距22;对齐方式:居中;段落后间距:6。

5 表格

表格是Flowable的派生类,是一种简单文本表格机制。表格可以保存所有能被转换为字符串或Flowerable是所有事物。
如果我们不提供行高,它们可以根据数据自动计算出行高。
如果需要,它们可以跨页分割,你可以指定跨页分割后,需要重复的行数。
表格风格和表格数据是分离的,因此你可以声明一系列的风格,然后将它们用于一大堆报告。
表格使用如下代码进行创建:

Table(data, colWidths=None, rowHeights=None, style=None, splitByRow=1,
repeatRows=0, repeatCols=0, rowSplitRange=None, spaceBefore=None,
spaceAfter=None)

几个关键参数:

  • data:数据参数是一系列的表格值,每个表格值能够被转换为字符串或者Flowable实例。data值的第一行是data[0],第i行j列表格值是data[i] [j]。
  • colWidths:是一系列值,这些值代表每列的宽度。如果传递的是None,则对应列宽需要被自动计算。
  • rowHeights:是一系列值,这些值代表每行的高度。如果传递的是None,则对应的行高需要被自动计算。
  • style:表格被创建时的初始样式值。
  • splitByRow:布尔值,当指定值为1时,允许跨页分割表格,当指定指为0时,不允许跨页分割表格。
  • repeatRows:指定跨页分行时,需要重复的行数。
  • repeatCols:暂时没用。
  • spaceBefore:指定表格前的行数。
  • spaceAfter:指定表格后的行数。
from reportlab.platypus import SimpleDocTemplate, Table
from reportlab.lib.styles import getSampleStyleSheet# 调用模板,创建指定名称的PDF文档
doc = SimpleDocTemplate("my_pdf_01.pdf")
# 获得模板表格
styles = getSampleStyleSheet()
# 指定模板
style = styles['Normal']
# 初始化内容
story =[]# 初始化表格内容
data= [['00', '01', '02', '03', '04'],['10', '11', '12', '13', '14'],['20', '21', '22', '23', '24'],['30', '31', '32', '33', '34']]# 根据内容创建表格
t = Table(data)
# 将表格添加到内容中
story.append(t)
# 将内容输出到PDF中
doc.build(story)

在这里插入图片描述

5.1 表格格式

指定表格格式有两种方式,一种是在调用创建表格接口时,传入style参数,一种是在创建完表格后,调用如下接口:

Table.setStyle(tblStyle)

5.1.1 直接传入style参数

from reportlab.platypus import SimpleDocTemplate, Table
from reportlab.lib import colors
from reportlab.lib.styles import getSampleStyleSheet# 调用模板,创建指定名称的PDF文档,输入参数为路径文件名
doc = SimpleDocTemplate("../datas/wws_tables.pdf")
# 获得模板表格
styles = getSampleStyleSheet()
# 指定模板
style = styles['Normal']
# 初始化内容
story = []# 初始化表格内容
data = [['00', '01', '02', '03', '04'],['10', '11', '12', '13', '14'],['20', '21', '22', '23', '24'],['30', '31', '32', '33', '34']]# 根据内容创建表格,同时添加格式
t = Table(data,style=[('GRID', (0, 0), (-1, -1), 1, colors.grey),('GRID', (1, 1), (-2, -2), 1, colors.green),('BOX', (0, 0), (1, -1), 2, colors.red),('BACKGROUND', (0, 0), (0, 1), colors.pink),('BACKGROUND', (1, 1), (1, 2), colors.lavender),('BACKGROUND', (2, 2), (2, 3), colors.orange),])# 将表格添加到内容中
story.append(t)
# 将内容输出到PDF中
doc.build(story)

在这里插入图片描述

5.1.2 调用setStyle

from reportlab.platypus import SimpleDocTemplate, Table, TableStyle
from reportlab.lib import colors
from reportlab.lib.styles import getSampleStyleSheet# 调用模板,创建指定名称的PDF文档
doc = SimpleDocTemplate("../datas/wws_tables.pdf")
# 获得模板表格
styles = getSampleStyleSheet()
# 指定模板
style = styles['Normal']
# 初始化内容
story = []# 初始化表格内容
data = [['00', '01', '02', '03', '04'],['10', '11', '12', '13', '14'],['20', '21', '22', '23', '24'],['30', '31', '32', '33', '34']]# 根据内容创建表格
t = Table(data)# 然后调用setStyle添加格式
t.setStyle(TableStyle([('INNERGRID', (0, 0), (-1, -1), 0.25, colors.black),('BOX', (0, 0), (-1, -1), 2, colors.black),('LINEBELOW', (0, 0), (-1, 0), 2, colors.yellow),('LINEAFTER', (0, 0), (0, -1), 2, colors.blue),('ALIGN', (1, 1), (-1, -1), 'RIGHT')]))# 将表格添加到内容中
story.append(t)
# 将内容输出到PDF中
doc.build(story)

在这里插入图片描述

  • 表格的位置索引方式与列表的索引方式一致
  • 左上角第一个是data[0] [0]
  • 第二行第一个是data[1] [0]
  • 最后一行第一个位置是data[-1] [0],依次类推。

重点表格格式化命令:

  • FONTNAME:字体名称
  • FONTSIZE:字体大小
  • LEADING:行间距
  • TEXTCOLOR:字体颜色
  • ALIGNMENT:水平对齐方式(可选值:“LEFT”,”RIGHT“,”CENTER“)
  • LEFTPADDING:左边填充
  • RIGHTPADDING:右边填充
  • BOTTOMPADDING:底部填充
  • TOPPADDING:顶部填充
  • BACKGROUND:背景色
  • VALIGN:垂直对齐方式(可选值:“TOP”,“MIDDLE”,“BOTTOM”)
  • GRID:表格颜色,被指定的行列中的所有子行和子列都被设置成相应颜色
  • INNERGRID:表格颜色,仅仅修改指定的子行和子列的相应颜色(不包括边框)
  • BOX:边框颜色,被指定的边框的颜色
  • LINEBELOW:指定块底部的行颜色
  • LINEAFTER:指定块右边的行颜色。

6 图片

在调用接口时,支持默认的jpeg格式。接口如下:

Image(filename, width=None, height=None)
  • filename:指定文件名
  • width:指定图片的宽度
  • height:指定图片的高度

如果宽度和高度有一个没有被指定,则参考原来的图片像素。

from reportlab.platypus import SimpleDocTemplate, Table, TableStyle
from reportlab.lib import colors
from reportlab.lib.styles import getSampleStyleSheetfrom reportlab.platypus import SimpleDocTemplate, Imagefrom reportlab.lib.styles import getSampleStyleSheet# 调用模板,创建指定名称的PDF文档
doc = SimpleDocTemplate("../datas/wws_tables.pdf")
# 获得模板表格
styles = getSampleStyleSheet()
# 指定模板
style = styles['Normal']
# 初始化内容
story = []# 初始化表格内容
data = [['00', '01', '02', '03', '04'],['10', '11', '12', '13', '14'],['20', '21', '22', '23', '24'],['30', '31', '32', '33', '34']]# 根据内容创建表格, 表格后空两行,不然图片连一块了,难看
t = Table(data, spaceAfter=10)# 然后调用setStyle添加格式
t.setStyle(TableStyle([('INNERGRID', (0, 0), (-1, -1), 0.25, colors.black),('BOX', (0, 0), (-1, -1), 2, colors.black),('LINEBELOW', (0, 0), (-1, 0), 2, colors.yellow),('LINEAFTER', (0, 0), (0, -1), 2, colors.blue),('ALIGN', (1, 1), (-1, -1), 'RIGHT')]))# 将表格添加到内容中
story.append(t)
# 添加图片
IMG = Image("C:\\Users\\admin\\Documents\\index\\PS图片\\20230926-144332.jpg", width=120, height=160)
story.append(IMG)# 将内容输出到PDF中
doc.build(story)

在这里插入图片描述


参考

python 生成pdf
reportlab 官网案例
reportlab 官方文档
文档官方demo
flask_reportlab
adding-links-to-pdf
Python的reportlab制作pdf时,如何让插入的图片适应pdf的大小
reportlab 中文问题

这篇关于reportlab 生成pdf文件 (python)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/912807

相关文章

Python实现Word转PDF全攻略(从入门到实战)

《Python实现Word转PDF全攻略(从入门到实战)》在数字化办公场景中,Word文档的跨平台兼容性始终是个难题,而PDF格式凭借所见即所得的特性,已成为文档分发和归档的标准格式,下面小编就来和大... 目录一、为什么需要python处理Word转PDF?二、主流转换方案对比三、五套实战方案详解方案1:

基于Python Playwright进行前端性能测试的脚本实现

《基于PythonPlaywright进行前端性能测试的脚本实现》在当今Web应用开发中,性能优化是提升用户体验的关键因素之一,本文将介绍如何使用Playwright构建一个自动化性能测试工具,希望... 目录引言工具概述整体架构核心实现解析1. 浏览器初始化2. 性能数据收集3. 资源分析4. 关键性能指

使用Python的requests库调用API接口的详细步骤

《使用Python的requests库调用API接口的详细步骤》使用Python的requests库调用API接口是开发中最常用的方式之一,它简化了HTTP请求的处理流程,以下是详细步骤和实战示例,涵... 目录一、准备工作:安装 requests 库二、基本调用流程(以 RESTful API 为例)1.

Python清空Word段落样式的三种方法

《Python清空Word段落样式的三种方法》:本文主要介绍如何用python-docx库清空Word段落样式,提供三种方法:设置为Normal样式、清除直接格式、创建新Normal样式,注意需重... 目录方法一:直接设置段落样式为"Normal"方法二:清除所有直接格式设置方法三:创建新的Normal样

Python调用LibreOffice处理自动化文档的完整指南

《Python调用LibreOffice处理自动化文档的完整指南》在数字化转型的浪潮中,文档处理自动化已成为提升效率的关键,LibreOffice作为开源办公软件的佼佼者,其命令行功能结合Python... 目录引言一、环境搭建:三步构建自动化基石1. 安装LibreOffice与python2. 验证安装

把Python列表中的元素移动到开头的三种方法

《把Python列表中的元素移动到开头的三种方法》在Python编程中,我们经常需要对列表(list)进行操作,有时,我们希望将列表中的某个元素移动到最前面,使其成为第一项,本文给大家介绍了把Pyth... 目录一、查找删除插入法1. 找到元素的索引2. 移除元素3. 插入到列表开头二、使用列表切片(Lis

Python按照24个实用大方向精选的上千种工具库汇总整理

《Python按照24个实用大方向精选的上千种工具库汇总整理》本文整理了Python生态中近千个库,涵盖数据处理、图像处理、网络开发、Web框架、人工智能、科学计算、GUI工具、测试框架、环境管理等多... 目录1、数据处理文本处理特殊文本处理html/XML 解析文件处理配置文件处理文档相关日志管理日期和

Django HTTPResponse响应体中返回openpyxl生成的文件过程

《DjangoHTTPResponse响应体中返回openpyxl生成的文件过程》Django返回文件流时需通过Content-Disposition头指定编码后的文件名,使用openpyxl的sa... 目录Django返回文件流时使用指定文件名Django HTTPResponse响应体中返回openp

Python标准库datetime模块日期和时间数据类型解读

《Python标准库datetime模块日期和时间数据类型解读》文章介绍Python中datetime模块的date、time、datetime类,用于处理日期、时间及日期时间结合体,通过属性获取时间... 目录Datetime常用类日期date类型使用时间 time 类型使用日期和时间的结合体–日期时间(

使用Python开发一个Ditto剪贴板数据导出工具

《使用Python开发一个Ditto剪贴板数据导出工具》在日常工作中,我们经常需要处理大量的剪贴板数据,下面将介绍如何使用Python的wxPython库开发一个图形化工具,实现从Ditto数据库中读... 目录前言运行结果项目需求分析技术选型核心功能实现1. Ditto数据库结构分析2. 数据库自动定位3