1. ReportLabの基本操作
Canvasの利用
ReportLabでPDFを作成するメインツールはcanvasクラスです。これにより、テキスト、線、四角形、その他のグラフィック要素を追加するためのメソッドが提供されます。
簡単なテキスト付きPDFの作成
from reportlab.pdfgen import canvas
from reportlab.lib.pagesizes import A4
# 新しいPDFファイルを作成
pdf_file = canvas.Canvas("basic_report.pdf", pagesize=A4)
width, height = A4
# テキストを追加
pdf_file.setFont("Helvetica", 12) # フォントとサイズを設定
pdf_file.drawString(100, height - 100, "こんにちは!ReportLabを使って作成されたレポートです。")
# PDFを保存して閉じる
pdf_file.save()
この例では、"こんにちは!ReportLabを使って作成されたレポートです。"というテキストを含む簡単なPDFファイルが1ページ目に作成されます。
2. PDFにテキストを追加する
ReportLabは、テキストのサイズ、フォント、色などを柔軟にカスタマイズできます。この機能は、ヘッダー、サブタイトル、メインテキストを分けて設定できるので構造化されたレポートの作成に重要です。
フォントとテキストサイズの設定
setFont()メソッドを使用してフォントとテキストサイズを設定できます。ReportLabは、Helvetica、Times-Roman、Courierなどの標準フォントをサポートしています。
pdf_file.setFont("Helvetica-Bold", 16) # 太字フォント
pdf_file.drawString(100, height - 50, "販売レポート") # タイトル
テキストの色を変更
ReportLabは、setFillColorRGB()メソッドを使用してRGB値(0から1の範囲)でテキストの色を設定できます。
pdf_file.setFillColorRGB(0, 0, 1) # 青色
pdf_file.drawString(100, height - 150, "このテキストは青色です。")
3. テキストブロックと複数行のテキストの操作
テキストが長い場合、drawString()を使い各行の座標を指定してブロック形式にすることができます。ただし、テキストを自動的に改行するにはdrawText()やTextObjectを使用する方が便利です。
TextObjectを使った複数行テキストの追加
text = """
2023年売上レポート。
このレポートには、販売データの詳細、分析、および予測が含まれます。
"""
# テキストオブジェクトを作成
text_object = pdf_file.beginText(100, height - 200)
text_object.setFont("Helvetica", 12)
text_object.setFillColorRGB(0, 0, 0)
# テキストを追加
for line in text.split("\n"):
text_object.textLine(line)
pdf_file.drawText(text_object)
この例では、TextObjectを使って各行を自動的に改行するテキストオブジェクトが作成されます。
4. 複数ページのレポートの作成
複数ページのレポートを作成することで、より多くのデータを収容し、読みやすいドキュメント構造を作成できます。ReportLabで新しいページに移動するにはshowPage()メソッドを使用します。
複数ページPDFの作成
from reportlab.pdfgen import canvas
from reportlab.lib.pagesizes import A4
# PDFを作成
pdf_file = canvas.Canvas("multi_page_report.pdf", pagesize=A4)
width, height = A4
# ページ1
pdf_file.setFont("Helvetica-Bold", 16)
pdf_file.drawString(100, height - 100, "ページ1: 序章")
pdf_file.setFont("Helvetica", 12)
pdf_file.drawString(100, height - 130, "このレポートの最初のページです。")
pdf_file.showPage() # 新しいページに移動
# ページ2
pdf_file.setFont("Helvetica-Bold", 16)
pdf_file.drawString(100, height - 100, "ページ2: データ")
pdf_file.setFont("Helvetica", 12)
pdf_file.drawString(100, height - 130, "このレポートの2ページ目です。")
# PDFを保存して閉じる
pdf_file.save()
この例では、それぞれ独自のタイトルとテキストを持つ2ページから成るPDFが作成されます。メソッドshowPage()は現在のページを終了し、新しいページを開始します。
5. PDFに動的データを追加
ReportLabを使うことで、レポート自動化のためのリストや辞書など、動的データをPDFに追加できます。これは、テーブルやリストデータを含む定期的に更新されるレポートを作成する際に役立ちます。
リストからデータを追加
from reportlab.pdfgen import canvas
from reportlab.lib.pagesizes import A4
data = [
{"月": "1月", "販売": 200},
{"月": "2月", "販売": 300},
{"月": "3月", "販売": 250},
]
pdf_file = canvas.Canvas("sales_report.pdf", pagesize=A4)
width, height = A4
# タイトル
pdf_file.setFont("Helvetica-Bold", 16)
pdf_file.drawString(100, height - 100, "販売レポート")
# データを追加
pdf_file.setFont("Helvetica", 12)
y_position = height - 150
for item in data:
line = f"{item['月']}: 販売 = {item['販売']}"
pdf_file.drawString(100, y_position, line)
y_position -= 20
# PDFを保存
pdf_file.save()
このコードでは、月ごとの販売データを各行に追加し、PDFファイルを作成します。
6. 画像を追加する
PDF文書にはテキストのほかに、画像やグラフも入れられます。さっそく画像を追加してみましょう:
from reportlab.lib.pagesizes import letter
from reportlab.pdfgen import canvas
def create_pdf_with_image(file_path):
c = canvas.Canvas(file_path, pagesize=letter)
width, height = letter
c.drawString(100, height - 100, "ここに画像が入ります:")
# 画像へのパス
image_path = "example_image.jpg"
c.drawImage(image_path, 100, height - 300, width=200, height=150)
c.showPage()
c.save()
file_path = "image_example.pdf"
create_pdf_with_image(file_path)
簡単でしょう? これで画像入りのPDFができました!
テキストと画像の入ったPDFの作り方が分かったところで、これを現実でどう使えるか考えてみましょう。あなたが分析会社で働いていて、毎月売上レポートを作らなければならないとします。毎回手で書類を用意する代わりに、データを自動で集めてPDFレポートを生成するスクリプトを書けばいい。時間の節約になるだけでなく、レポート内のデータの正確さと一貫性も上がります。
7. PDFに表を追加する
ここで、ただのテキストから少し離れてみましょう。たとえば商品の一覧とその値段のようなデータを入れたくなったら? ごく簡単な例で見てみます:
from reportlab.lib.pagesizes import letter
from reportlab.pdfgen import canvas
items = [("アイロン", 42.99), ("ケトル", 15.00), ("テレビ", 250.00)]
def create_pdf_with_table(file_path):
c = canvas.Canvas(file_path, pagesize=letter)
width, height = letter
c.drawString(100, height - 100, "商品の一覧と価格:")
y = height - 150
for item in items:
c.drawString(100, y, f"{item[0]} - {item[1]:.2f} $")
y -= 20
c.showPage()
c.save()
file_path = "table_example.pdf"
create_pdf_with_table(file_path)
ここでは価格付きの商品リストをそのまま並べています。可能性を想像してみてください。別のデータベース——たとえばお気に入りのpandasのDataFrame——から取ってきたデータで、本格的な表を作ることだってできるんです!
8. テンプレートを使ったレポートの自動化
レポート作成を自動化する、とても強力なやり方のひとつがテンプレートの利用です。要するに、構造とデザインを持つ文書のテンプレートを用意しておいて、あとはスクリプトでデータを流し込むわけです。
テンプレート文書の作成
まず、ロゴや固定の見出しといった変わらない要素を含む土台のテンプレートを作ります。そこへ日付やグラフ、一覧といった動的なデータを自動で流し込みます。たとえばテンプレートのテキストにJinja2を使い、そのうえで最終的なPDF文書を生成する、といった構成にできます。
ReportLabでテンプレートを作るときは、静的なデータと動的なデータを組み合わせられます。たとえば、企業ロゴや固定要素を配置したレポート用の背景をあらかじめ用意しておき、そこにアプリケーションのデータから作った動的なコンテンツを重ねる、という形です。
GO TO FULL VERSION