快捷導(dǎo)航

Python利用reportlab實(shí)現(xiàn)制作pdf報(bào)告

更新時(shí)間：2022年12月23日 10:40:38 作者：我輩李想

這篇文章主要為大家詳細(xì)介紹了reportlab生成流文件格式、reportlab分頁(yè)和圖片流文件寫(xiě)入reportlab等內(nèi)容，文中的示例代碼講解詳細(xì)，感興趣的小伙伴可以了解一下

前言

本博客重點(diǎn)內(nèi)容：reportlab生成流文件格式、reportlab分頁(yè)和圖片流文件寫(xiě)入reportlab等。

我講一下我這個(gè)需求的來(lái)源，做的項(xiàng)目是一個(gè)地理空間查詢(xún)和使用的系統(tǒng)，通過(guò)在前端調(diào)用高德地圖api創(chuàng)建了一個(gè)查詢(xún)區(qū)域，獲取區(qū)域內(nèi)的地理數(shù)據(jù)(數(shù)據(jù)庫(kù))。具體的需求就是，將查詢(xún)區(qū)域和地理數(shù)據(jù)制作成一個(gè)覆蓋率分析報(bào)告，報(bào)告中的其他內(nèi)容都已完成，但報(bào)告中需要展示高德地圖、查詢(xún)區(qū)域、地理數(shù)據(jù)的完整圖片這個(gè)功能卡了2個(gè)星期，主要原因是我對(duì)地理空間數(shù)據(jù)不熟悉，很多python相關(guān)庫(kù)也不清楚，在構(gòu)建圖形的過(guò)程中走了很多彎路。

現(xiàn)在將整個(gè)實(shí)現(xiàn)過(guò)程梳理完成，希望對(duì)各位同道有幫助，跟其他文章和官網(wǎng)不同，本博客是以使用的優(yōu)先級(jí)來(lái)講解這個(gè)庫(kù)。<我們靠所得來(lái)謀生，但靠給予來(lái)創(chuàng)造生活>

reportlab是什么

reportlab是Python的一個(gè)標(biāo)準(zhǔn)庫(kù)，可以畫(huà)圖、畫(huà)表格、編輯文字，最后可以輸出PDF格式。它的邏輯和編輯一個(gè)word文檔或者PPT很像。有兩種方法：

1）建立一個(gè)空白文檔，然后在上面寫(xiě)文字、畫(huà)圖等；

2）建立一個(gè)空白list，以填充表格的形式插入各種文本框、圖片等，最后生成PDF文檔。

因?yàn)樾枰a(chǎn)生一份給用戶(hù)看的報(bào)告，里面需要插入圖片、表格等，所以采用的是第二種方法。

**由于我們這個(gè)功能是django網(wǎng)站項(xiàng)目上，我們并不想生成一個(gè)文件，第二種方法還可以生成io流文件，進(jìn)而傳遞給前端生成pdf，這樣后端就不存在文件的存寫(xiě)讀的操作了。**本篇文章在方法2的基礎(chǔ)上，加入了reportlab生成流文件格式、reportlab分頁(yè)和圖片流文件寫(xiě)入reportlab等功能。

安裝和導(dǎo)入庫(kù)

官網(wǎng)鏈接：https://pypi.org/project/reportlab/

官方文檔：https://docs.reportlab.com/reportlab/userguide/ch1_intro/

pip install reportlab

代碼如下（示例）：

from reportlab.pdfbase import pdfmetrics   # 注冊(cè)字體
from reportlab.pdfbase.ttfonts import TTFont # 字體類(lèi)
from reportlab.platypus import Table, SimpleDocTemplate, Paragraph, Image  # 報(bào)告內(nèi)容相關(guān)類(lèi)
from reportlab.lib.pagesizes import letter  # 頁(yè)面的標(biāo)志尺寸(8.5*inch, 11*inch)
from reportlab.lib.styles import getSampleStyleSheet  # 文本樣式
from reportlab.lib import colors  # 顏色模塊
from reportlab.graphics.charts.barcharts import VerticalBarChart  # 圖表類(lèi)
from reportlab.graphics.charts.legends import Legend  # 圖例類(lèi)
from reportlab.graphics.shapes import Drawing  # 繪圖工具
from reportlab.lib.units import cm  # 單位：cm
 
# 注冊(cè)字體(提前準(zhǔn)備好字體文件, 如果同一個(gè)文件需要多種字體可以注冊(cè)多個(gè))
pdfmetrics.registerFont(TTFont('SimSun', 'SimSun.ttf'))

將畫(huà)圖、畫(huà)表格、編輯文字抽象為類(lèi)

抽象為類(lèi)后，可實(shí)現(xiàn)多次調(diào)用，方便處理。這里我將頁(yè)眉和頁(yè)腳的方法也放在了抽象類(lèi)中。在生成文件時(shí)，實(shí)現(xiàn)pdf報(bào)告的自動(dòng)分頁(yè)。

class Graphs(object):

    def __init__(self):
        # 獲取所有樣式表
        self.style = getSampleStyleSheet()

    # 繪制標(biāo)題
    def draw_1_title(self, title1: str):
        # 拿到標(biāo)題樣式
        ct = self.style['Heading1']
        # 單獨(dú)設(shè)置樣式相關(guān)屬性
        ct.fontName = 'hei'  # 字體名
        ct.fontSize = 20  # 字體大小
        ct.leading = 1.5 * ct.fontSize  # 行間距
        ct.textColor = colors.black  # 字體顏色
        ct.alignment = 1  # 居中
        return Paragraph(title1, ct)

    # 繪制小標(biāo)題（黑色）
    def draw_2_title(self, title: str, content: str):
        # 拿到標(biāo)題樣式
        ct = self.style['Normal']
        # 單獨(dú)設(shè)置樣式相關(guān)屬性
        ct.fontName = 'song'  # 字體名
        ct.fontSize = 15  # 字體大小
        ct.leading = 1.5 * ct.fontSize  # 行間距
        ct.textColor = colors.black  # 字體顏色
        return Paragraph(("<font name='Dengb'>%s</font>" % title) + content, ct)

    # 繪制普通段落內(nèi)容
    def draw_text(self, text: str):
        # 獲取普通樣式
        ct = self.style['Normal']
        ct.fontName = 'song'
        ct.fontSize = 12
        ct.leading = 1.5 * ct.fontSize  # 行間距
        ct.wordWrap = 'CJK'  # 設(shè)置自動(dòng)換行
        ct.alignment = 0  # 左對(duì)齊
        ct.firstLineIndent = 32  # 第一行開(kāi)頭空格
        ct.leading = 25
        return Paragraph(text, ct)

    # 繪制表格標(biāo)題
    def draw_table_title(self, title: str):
        # 拿到標(biāo)題樣式
        ct = self.style['Heading1']
        # 單獨(dú)設(shè)置樣式相關(guān)屬性
        ct.fontName = 'Dengb'  # 字體名
        ct.fontSize = 14  # 字體大小
        ct.leading = 15  # 行間距
        ct.textColor = colors.black  # 字體顏色
        ct.alignment = 1  # 居中
        ct.bold = True
        # 創(chuàng)建標(biāo)題對(duì)應(yīng)的段落，并且返回
        return Paragraph(title, ct)

    # 繪制表格
    @staticmethod
    def draw_table(*args):
        # 列寬度
        col_width = [50, 300, 50, 50]
        style = TableStyle(
            [('FONTNAME', (0, 0), (-1, -1), 'song'),  # 全表字體
             ('FONTNAME', (0, 0), (-1, 0), 'Dengb'),  # 首行字體
             ('FONTSIZE', (0, 0), (-1, 0), 12),  # 第一行的字體大小
             ('FONTSIZE', (0, 1), (-1, -1), 10),  # 第二行到最后一行的字體大小
             ('ALIGN', (0, 0), (-1, -1), 'CENTER'),  # 第一行水平居中
             ('VALIGN', (0, 0), (-1, -1), 'MIDDLE'),  # 所有表格上下居中對(duì)齊
             ('TEXTCOLOR', (0, 0), (-1, -1), colors.black),  # 設(shè)置表格內(nèi)文字顏色（不包含第一行）
             ('GRID', (0, 0), (-1, -1), 0.5, colors.black),  # 設(shè)置表格框線為grey色，線寬為0.5
             # ('SPAN', (0, 1), (0, 2)),  # 合并第一列二三行
             # ('SPAN', (0, 3), (0, 4)),  # 合并第一列三四行
             # ('SPAN', (0, 5), (0, 6)),  # 合并第一列五六行
             # ('SPAN', (0, 7), (0, 8)),  # 合并第一列五六行
             ])
        table = Table(args, colWidths=col_width, style=style)
        return table

    # 創(chuàng)建圖表
    @staticmethod
    def draw_bar(bar_data: list, ax: list, items: list):
        drawing = Drawing(500, 250)
        bc = VerticalBarChart()
        bc.x = 45  # 整個(gè)圖表的x坐標(biāo)
        bc.y = 45  # 整個(gè)圖表的y坐標(biāo)
        bc.height = 200  # 圖表的高度
        bc.width = 350  # 圖表的寬度
        bc.data = bar_data
        bc.strokeColor = colors.black  # 頂部和右邊軸線的顏色
        bc.valueAxis.valueMin = 5000  # 設(shè)置y坐標(biāo)的最小值
        bc.valueAxis.valueMax = 26000  # 設(shè)置y坐標(biāo)的最大值
        bc.valueAxis.valueStep = 2000  # 設(shè)置y坐標(biāo)的步長(zhǎng)
        bc.categoryAxis.labels.dx = 2
        bc.categoryAxis.labels.dy = -8
        bc.categoryAxis.labels.angle = 20
        bc.categoryAxis.categoryNames = ax

        # 圖示
        leg = Legend()
        leg.fontName = 'song'
        leg.alignment = 'right'
        leg.boxAnchor = 'ne'
        leg.x = 475  # 圖例的x坐標(biāo)
        leg.y = 240
        leg.dxTextSpace = 10
        leg.columnMaximum = 3
        leg.colorNamePairs = items
        drawing.add(leg)
        drawing.add(bc)
        return drawing

    # 繪制圖片
    @staticmethod
    def draw_img(path):
        img = Image(path, width=500, height=500, kind='bound')  # 讀取指定路徑下的圖片
        return img

    # 設(shè)置頁(yè)腳
    def footer(self, canvas, doc):
        """
        設(shè)置頁(yè)腳--頁(yè)碼
        :param canvas:Canvas類(lèi)型  pdf畫(huà)布
        :param doc:doc類(lèi)型   整個(gè)pdf文件
        """  # 拿到標(biāo)題樣式
        ct = self.style['Heading1']
        # 單獨(dú)設(shè)置樣式相關(guān)屬性
        ct.fontName = 'song'  # 字體名
        ct.fontSize = 14  # 字體大小
        ct.leading = 15  # 行間距
        ct.textColor = colors.black  # 字體顏色
        ct.alignment = 1  # 居中
        canvas.saveState()  # 先保存當(dāng)前的畫(huà)布狀態(tài)
        pageNumber = ("%s" % canvas.getPageNumber())  # 獲取當(dāng)前的頁(yè)碼
        p = Paragraph(pageNumber, ct)
        p.wrap(1 * cm, 1 * cm)  # 申請(qǐng)一塊1cm大小的空間，返回值是實(shí)際使用的空間
        p.drawOn(canvas, 520, 50)  # 將頁(yè)碼放在指示坐標(biāo)處
        canvas.restoreState()

    # 設(shè)置頁(yè)眉
    def header(self, canvas, doc):
        """
        設(shè)置頁(yè)眉
        :param canvas:Canvas類(lèi)型  pdf畫(huà)布
        :param doc:doc類(lèi)型     整個(gè)pdf文件
        https://cxybb.com/article/liyadian/81253117
        """
        canvas.saveState()
        im = Image("utils/map_png/image/logo.png", height=20, width=98)
        im.drawOn(canvas, 430, 780)
        # canvas.setStrokeColorRGB(0.8, 0.8, 0.8)
        # canvas.setFillColorRGB(0, 0, 0)
        # canvas.line(15, 28, doc.width - 15, 28)
        # canvas.setFont('regular', 8)
        # str = f"XXX銀行 | Page {doc.page}"
        # textLen = stringWidth(str, 'regular', 8)
        # canvas.drawCentredString(int((doc.width - textLen) / 2), 0.15 * inch, str)
        canvas.restoreState()

pdf插入圖片

pdf中插入圖片會(huì)有2中方式，網(wǎng)絡(luò)上常用的方式都是文件路徑，本片文章的圖片是通過(guò)Html2Image生成的，無(wú)法保存成流文件格式，只能保存至本地文件。但是如果圖片是通過(guò)其他途徑生成的，可以直接以流文件的方式寫(xiě)入pdf，這樣可以節(jié)省文件的創(chuàng)建、寫(xiě)入、讀取和刪除等操作，節(jié)省內(nèi)存和磁盤(pán)空間。

以文件路徑寫(xiě)入pdf

    # base 是當(dāng)前文件所在路徑的上一級(jí)路徑，此種方法適用Windows和linux等多種系統(tǒng)，其他方法無(wú)法保證，多系統(tǒng)路徑是否一致。
    base = Path(__file__).resolve().parent
    # out_file就是文件名字（即Html2Image生成的圖片），img_path 是拼接后的文件路徑
    content.append(graphs.draw_table_title('圖1 影像覆蓋情況'))
    img_path = os.path.join(base, 'map_png', out_file)
    content.append(graphs.draw_img(img_path))
    content.append(Spacer(0, 10))

以流文件寫(xiě)入pdf

from pillow import Image as pilImage

	with open('test.png',mode='rb') as f:
		# 讀取到圖片
	    content.append(graphs.draw_img(f))
	    content.append(Spacer(0, 10))

pdf分頁(yè)

在第二部分我們已經(jīng)寫(xiě)入了pdf頁(yè)眉和頁(yè)腳的方法和參數(shù)，具體如何加載到pdf中可以參考下列方法。

    doc = SimpleDocTemplate('report.pdf', pagesize=letter)
    # 聲明一塊Frame，存放頁(yè)碼
    frame_footer = Frame(doc.leftMargin, doc.bottomMargin, doc.width, doc.height, id='normal')
    # 設(shè)置頁(yè)面模板，在加載頁(yè)面時(shí)先運(yùn)行herder函數(shù)，在加載完頁(yè)面后運(yùn)行footer函數(shù)
    template = PageTemplate(id='test', frames=frame_footer, onPage=graphs.header, onPageEnd=graphs.footer)
    doc.addPageTemplates([template])
    doc.build(content)

以生成pdf流文件為例

def pics_2_pdf(info, table, out_file):
    """
    info:基本信息
    table:表格數(shù)據(jù)
    """
    # 獲取Graphs類(lèi)
    graphs = Graphs()
    # 創(chuàng)建內(nèi)容對(duì)應(yīng)的空列表
    content = list()

    # 1.添加標(biāo)題
    content.append(graphs.draw_1_title('數(shù)據(jù)中心'))
	# 隔行的高度
    content.append(Spacer(0, 10))
    
    # 2.添加小標(biāo)題
    content.append(graphs.draw_2_title("報(bào)告形成日期: ", str(datetime.date.today().strftime("%Y/%m/%d"))))
    content.append(Spacer(0, 10))
    
    # 3.添加圖片
    base = Path(__file__).resolve().parent
    content.append(graphs.draw_table_title('圖1 影像覆蓋情況'))
    img_path = os.path.join(base, 'map_png', out_file)
    content.append(graphs.draw_img(img_path))
    content.append(Spacer(0, 10))
    # 4.添加表格標(biāo)題
    content.append(graphs.draw_table_title('表1 框選區(qū)域覆蓋數(shù)據(jù)清單'))
    # 5.添加表格數(shù)據(jù)
    # data = [
    #     ['職位名稱(chēng)', '平均薪資', '較上年增長(zhǎng)率'],
    #     ['數(shù)據(jù)分析師', '18.5K', '25%'],
    #     ('高級(jí)數(shù)據(jù)分析師', '25.5K', '14%'),
    #     ('資深數(shù)據(jù)分析師', '29.3K', '10%')
    # ]
    content.append(graphs.draw_table(*table))
    # 生成圖表
    # content.append(Graphs.draw_title(''))
    # content.append(Graphs.draw_little_title('熱門(mén)城市的就業(yè)情況'))
    # b_data = [(25400, 12900, 20100, 20300, 20300, 17400), (15800, 9700, 12982, 9283, 13900, 7623)]
    # ax_data = ['BeiJing', 'ChengDu', 'ShenZhen', 'ShangHai', 'HangZhou', 'NanJing']
    # leg_items = [(colors.red, '平均薪資'), (colors.green, '招聘量')]
    # content.append(Graphs.draw_bar(b_data, ax_data, leg_items))
    # 添加文字
    # content.append(Graphs.draw_text(
    #     '眾所周知，大數(shù)據(jù)分析師崗位是香餑餑，近幾年數(shù)據(jù)分析熱席卷了整個(gè)互聯(lián)網(wǎng)行業(yè)，與數(shù)據(jù)分析的相關(guān)的崗位招聘、培訓(xùn)數(shù)不勝數(shù)。很多人前赴后繼，想要參與到這波紅利當(dāng)中。那么數(shù)據(jù)分析師就業(yè)前景到底怎么樣呢？'))

    # 生成pdf文件
    # 方式一:
    # doc = SimpleDocTemplate('report.pdf', pagesize=letter)
    # 方式二-存儲(chǔ)文件:
    # doc = BaseDocTemplate('report.pdf')
    # 方式二-流文件格式
    buffer = io.BytesIO()  # 重點(diǎn) 起一個(gè) io
    doc = BaseDocTemplate(buffer)

    # 聲明一塊Frame，存放頁(yè)碼
    frame_footer = Frame(doc.leftMargin, doc.bottomMargin, doc.width, doc.height, id='normal')
    # 設(shè)置頁(yè)面模板，在加載頁(yè)面時(shí)先運(yùn)行herder函數(shù)，在加載完頁(yè)面后運(yùn)行footer函數(shù)
    template = PageTemplate(id='test', frames=frame_footer, onPage=graphs.header, onPageEnd=graphs.footer)
    doc.addPageTemplates([template])
    doc.build(content)
    return buffer

到此這篇關(guān)于Python利用reportlab實(shí)現(xiàn)制作pdf報(bào)告的文章就介紹到這了,更多相關(guān)Python reportlab制作pdf內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: