1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
import io
from pathlib import Path
import pytest
from PIL import Image
from fpdf import FPDF, drawing
from test.conftest import assert_pdf_equal
HERE = Path(__file__).resolve().parent
imgpath = str(HERE / "../image/image_types/insert_images_insert_jpg.jpg")
def add_pages_with_rgb_tuple_background(pdf, fill_set=None):
"""
sets the background using a tuple representing an RGB color and adds a page with text and a small rectangle,
then writes multiline-text to trigger a page break to test if the background color is retained
"""
pdf.set_page_background((170, 200, 100))
pdf.add_page()
pdf.rect(20, 20, 60, 60, style="F")
pdf.cell(0, 30, "RGB tuple", align="R", border=1)
pdf.ln()
if fill_set:
pdf.cell(0, 30, "fill color set", align="R", fill=True)
else:
pdf.cell(0, 30, "default fill color", align="R")
pdf.ln()
pdf.multi_cell(0, pdf.h / 2, "PAGE 1\nPAGE 2")
def add_page_with_DeviceRGB_background(pdf):
"""sets the background using an instance of DeviceRGB and adds a page with text and a small rectangle"""
pdf.set_page_background(drawing.DeviceRGB(0.2, 0.4, 0.1))
pdf.add_page()
pdf.rect(20, 20, 60, 60, style="F")
pdf.cell(0, 10, "DeviceRGB", align="R", border=1)
def _add_pages_with_image_background(pdf):
"""
sets the background to an image specified with a path and adds a page with text and a small rectangle,
then writes multi-line text to trigger a page break to test if the background image is retained
"""
pdf.set_page_background(imgpath)
pdf.add_page()
pdf.rect(20, 20, 60, 60, style="F")
pdf.cell(0, 10, "Image file path", align="R", border=1)
pdf.ln()
pdf.multi_cell(0, pdf.h / 2, "PAGE 1\nPAGE 2")
def add_page_with_image_url_background(pdf):
"""sets the background to an image specified with a link and adds a page with text and a small rectangle"""
pdf.set_page_background(
"https://raw.githubusercontent.com/py-pdf/fpdf2/master/test/image/image_types/insert_images_insert_jpg.jpg"
)
pdf.add_page()
pdf.rect(20, 20, 60, 60, style="F")
pdf.cell(0, 10, "Image file link", align="R", border=1)
def add_page_with_Pillow_image_background(pdf):
"""sets the background using an instance of PIL.Image.Image and adds a page with text and a small rectangle"""
img = Image.open(imgpath)
pdf.set_page_background(img)
pdf.add_page()
pdf.rect(20, 20, 60, 60, style="F")
pdf.cell(0, 10, "PIL.Image.Image", align="R", border=1)
def add_page_with_BytesIO_background(pdf):
"""sets the background using an instance of io.BytesIO of an image and adds a page with text and a small rectangle"""
with open(imgpath, "rb") as f:
buffer = io.BytesIO(f.read())
pdf.set_page_background(buffer)
pdf.add_page()
pdf.rect(20, 20, 60, 60, style="F")
pdf.cell(0, 10, "io.BytesIO", align="R", border=1)
def add_page_without_background(pdf):
"""sets the background to None (=removes the background) and adds a page with text and a small rectangle"""
pdf.set_page_background(None)
pdf.add_page()
pdf.rect(20, 20, 60, 60, style="F")
pdf.cell(0, 10, "No background", align="R", border=1)
@pytest.mark.skip(reason="requires internet access")
def test_page_background(tmp_path):
"""
Test creating a PDF with multiple pages using all pfsible inputs to set a page background,
drawing a rectangle and writing text on every page, testing if any other color is overwritten,
writing a multi-line text to test if the background is retained on an automatic page break,
then setting a fill color, testing if the background color gets overridden and vice versa
by printing another two pages with a background color and image
"""
pdf = FPDF()
pdf.set_font("Helvetica", style="B", size=30)
add_pages_with_rgb_tuple_background(pdf)
_add_pages_with_image_background(pdf)
add_page_with_DeviceRGB_background(pdf)
add_page_with_image_url_background(pdf)
add_page_with_Pillow_image_background(pdf)
add_page_with_BytesIO_background(pdf)
add_page_without_background(pdf)
pdf.set_fill_color(255, 200, 210)
add_pages_with_rgb_tuple_background(pdf, fill_set=True)
_add_pages_with_image_background(pdf)
add_page_without_background(pdf)
assert_pdf_equal(pdf, HERE / "page_background.pdf", tmp_path)
|
