ReportLabを使用すると、Pythonを使用してPDFの指定位置に画像を挿入することができます。
本記事では、ReportLabを使用した、PDFの指定位置に線を描画する方法について、詳しくご説明します。
- Pythonを使用したPDFの操作方法を知りたい人
- PDFの指定位置に線を描画する方法を知りたい人
ReportLabとは
ReportLabは、Pythonを使用してPDFを操作するための外部ライブラリの１つです。
PDF操作用ライブラリは他にも、PyPDF4やPDFMinerなどいくつか存在します。
それぞれのライブラリの用途は、以下の通りです。
| ライブラリ | 用途 |
|---|---|
| ReportLab | ・PDFの新規作成 |
| PDFMiner | ・テキストの抽出 |
| PyPDF4 | ・画像の抽出 ・PDFファイルの結合や分割 ・しおり（目次）の追加 |
本記事では、ReportLabによる、PDFの指定位置に線を描画する方法をご紹介します。
ReportLabのインストール
「ReportLab」は、以下コマンドを入力することで、インストールすることができます。
コマンドの入力は、コマンドプロンプトあるいはターミナルから行います。
pip install reportlab動作確認として、試しに以下を入力します。
from reportlab.pdfgen import canvas上記を入力してもエラーが発生しなければ、正常にインストールされています。
PDFの指定位置に線を描画する
実線の描画
「reportlab.pdfgen」クラスのcanvas.Canvas()で用意したPDFに対して、line()関数を使用することで、指定位置に線を挿入することができます。
line()の引数には、PDFの左下を原点として、X座標（始点）、Y座標（始点）、X座標（終点）、Y座標（終点）の順番で指定します。
線の色の指定は、setStrokeColorRGB()やsetStrokeColor()メソッドを使用します。
線の太さの指定は、setLineWidth()メソッドを使用します。
上記メソッドを使用して、PDFの指定位置に線を描画してみます。
#input
from reportlab.pdfgen import canvas
from reportlab.lib.pagesizes import A4, portrait, landscape
from reportlab.lib.units import mm
import os
# A4（横）の新規PDFファイルを作成
p = canvas.Canvas("sample.pdf", pagesize=landscape(A4))
# 線の色を指定(R：赤、G：緑、B：青の強さを0～1で指定)
p.setStrokeColorRGB(1, 0, 0)
# 線挿入位置の指定
x1 = 30*mm
y1 = 100*mm
x2 = 270*mm
y2 = 100*mm
# 線の太さを指定
p.setLineWidth(2*mm)
# 線を描画する
p.line(x1, y1, x2, y2)
# 保存
p.showPage()
p.save()
指定した位置に、幅2mmの赤線を描画しました。
setLineCap()を使用すると、線の端を丸めることができます。
線の端を丸めるには、引数に「1」（round）を指定します。
試しに、幅10mmの線を丸めて描画してみます。
#input
from reportlab.pdfgen import canvas
from reportlab.lib.pagesizes import A4, portrait, landscape
from reportlab.lib.units import mm
import os
# A4（横）の新規PDFファイルを作成
p = canvas.Canvas("sample.pdf", pagesize=landscape(A4))
# 線の色を指定(R：赤、G：緑、B：青の強さを0～1で指定)
p.setStrokeColorRGB(0, 1, 0)
# 線挿入位置の指定
x1 = 30*mm
y1 = 100*mm
x2 = 270*mm
y2 = 100*mm
# 線の太さを指定
p.setLineWidth(10*mm)
# 線の端を丸める
p.setLineCap(1)
# 線を描画する
p.line(x1, y1, x2, y2)
# 保存
p.showPage()
p.save()
点線の描画
setDash()を使用すると、点線を描画することができます。
引数には、繰り返す線の間隔を配列で指定します。
#input
from reportlab.pdfgen import canvas
from reportlab.lib.pagesizes import A4, portrait, landscape
from reportlab.lib.units import mm
import os
# A4（横）の新規PDFファイルを作成
p = canvas.Canvas("sample.pdf", pagesize=landscape(A4))
# 線の色を指定(R：赤、G：緑、B：青の強さを0～1で指定)
p.setStrokeColorRGB(0, 0, 1)
# 線挿入位置の指定
x1 = 30*mm
y1 = 100*mm
x2 = 270*mm
y2 = 100*mm
# 線の太さを指定
p.setLineWidth(3*mm)
# 破線の間隔を指定
p.setDash([10,20])
# 線を描画する
p.line(x1, y1, x2, y2)
# 保存
p.showPage()
p.save()
破線の描画
setDash()を使用すると、破線も描画することができます。
#input
from reportlab.pdfgen import canvas
from reportlab.lib.pagesizes import A4, portrait, landscape
from reportlab.lib.units import mm
import os
# A4（横）の新規PDFファイルを作成
p = canvas.Canvas("sample.pdf", pagesize=landscape(A4))
# 線の色を指定(R：赤、G：緑、B：青の強さを0～1で指定)
p.setStrokeColorRGB(1, 0, 1)
# 線挿入位置の指定
x1 = 30*mm
y1 = 100*mm
x2 = 270*mm
y2 = 100*mm
# 線の太さを指定
p.setLineWidth(3*mm)
# 破線の間隔を指定
p.setDash([10,20,30])
# 線を描画する
p.line(x1, y1, x2, y2)
# 保存
p.showPage()
p.save()
まとめ
この記事では、ReportLabを使用した、PDFの指定位置に線を描画する方法について、ご説明しました。
本記事を参考に、ぜひ試してみて下さい。
参考
Python学習用おすすめ教材
Pythonの基本を学びたい方向け
統計学基礎を学びたい方向け
Pythonの統計解析を学びたい方向け
おすすめプログラミングスクール
Pythonをはじめ、プログラミングを学ぶなら、TechAcademy（テックアカデミー）がおすすめです。
私も入っていますが、好きな時間に気軽にオンラインで学べますので、何より楽しいです。
現役エンジニアからマンツーマンで学べるので、一人では中々続かない人にも、向いていると思います。
無料体験ができますので、まずは試してみてください！
