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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
|
from pathlib import Path
from fpdf import FPDF
from fpdf.enums import TableCellFillMode, VAlign
from fpdf.fonts import FontFace
from fpdf.table import draw_box_borders
from test.conftest import assert_pdf_equal, LOREM_IPSUM
HERE = Path(__file__).resolve().parent
IMG_DIR = HERE.parent / "image"
IMAGE = IMG_DIR / "image_types/pythonknight.png"
IMAGES_DATA = (
(IMAGE, IMAGE, IMAGE, IMAGE),
(IMAGE, IMAGE, IMAGE, IMAGE),
(IMAGE, IMAGE, IMAGE, IMAGE),
(IMAGE, IMAGE, IMAGE, IMAGE),
(IMAGE, IMAGE, IMAGE, IMAGE),
(IMAGE, IMAGE, IMAGE, IMAGE),
(IMAGE, IMAGE, IMAGE, IMAGE),
)
MULTILINE_TABLE_DATA = (
("Multilines text", "Image"),
(LOREM_IPSUM[:200], IMG_DIR / "png_images/ba2b2b6e72ca0e4683bb640e2d5572f8.png"),
(LOREM_IPSUM[200:400], IMG_DIR / "png_images/ac6343a98f8edabfcc6e536dd75aacb0.png"),
(LOREM_IPSUM[400:600], IMG_DIR / "image_types/insert_images_insert_png.png"),
(LOREM_IPSUM[600:800], IMG_DIR / "image_types/circle.bmp"),
)
TABLE_DATA = (
("First name", "Last name", "Age", "City"),
("Jules", "Smith", "34", "San Juan"),
(
"Brave Sir Robin ",
"the Not-Quite-So-Brave-As-Sir-Lancelot",
"+",
"Bridge of Death",
),
("Mary", "Ramos", "45", "Orlando"),
("Carlson", "Banks", "19", "Los Angeles"),
("Lucas", "Cimon", "31", "Angers"),
)
LONG_TEXT = (
"\nProfessor: (Eric Idle) It's an entirely new strain of sheep, a killer sheep that can not only hold a rifle but is also a first-class shot.\n"
"Assistant: But where are they coming from, professor?\n"
"Professor: That I don't know. I just don't know. I really just don't know. I'm afraid I really just don't know. I'm afraid even I really just"
" don't know. I have to tell you I'm afraid even I really just don't know. I'm afraid I have to tell you... (she hands him a glass of water"
" which she had been busy getting as soon as he started into this speech) ... thank you ... (resuming normal breezy voice) ... I don't know."
" Our only clue is this portion of wolf's clothing which the killer sheep ..."
)
TABLE_DATA_LIST = ["And", "now", "for", "something", "completely", "different"]
def test_table_with_multiline_cells_and_images_padding_and_pagebreak(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=16)
red = (255, 100, 100)
black = (0, 0, 0)
deathstyle = FontFace(color=black, fill_color=red)
with pdf.table(
line_height=pdf.font_size,
padding=(5, 5, 5, 5),
col_widths=(0.3, 0.2),
width=80,
outer_border_width=3,
) as table:
for i, data_row in enumerate(MULTILINE_TABLE_DATA):
row = table.row()
for j, datum in enumerate(data_row):
if j == 1 and i > 0:
row.cell(img=datum, img_fill_width=False, style=deathstyle)
else:
row.cell(datum)
assert_pdf_equal(
pdf,
HERE / "table_with_multiline_cells_and_images_padding_and_pagebreak.pdf",
tmp_path,
)
def test_table_with_single_row_of_images(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=16)
pdf.text(60, 100, "All these images should be the same size")
with pdf.table(
line_height=pdf.font_size,
padding=(5, 7, 3, 4),
width=120,
col_widths=(2, 2, 2, 2),
cell_fill_color=(150, 200, 255),
cell_fill_mode=TableCellFillMode.ROWS,
) as table:
data_row = IMAGES_DATA[0]
row = table.row()
for datum in data_row:
row.cell(img=datum)
assert_pdf_equal(pdf, HERE / "table_with_single_row_of_images.pdf", tmp_path)
def test_table_with_only_images(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=16)
with pdf.table(
line_height=pdf.font_size,
padding=(5, 7, 3, 4),
width=120,
col_widths=(1, 2, 3, 2),
cell_fill_color=(150, 200, 255),
cell_fill_mode=TableCellFillMode.ROWS,
) as table:
for data_row in IMAGES_DATA:
row = table.row()
for datum in data_row:
row.cell(img=datum)
assert_pdf_equal(pdf, HERE / "table_with_only_images.pdf", tmp_path)
def test_table_vertical_alignment(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=12)
red = (255, 100, 100)
black = (0, 0, 0)
pdf.rect(pdf.l_margin, pdf.t_margin, pdf.epw, pdf.eph)
pdf.rect(0, pdf.t_margin, pdf.l_margin, pdf.eph)
pdf.rect(pdf.l_margin + pdf.epw, pdf.t_margin, pdf.r_margin, pdf.eph)
# pdf.rect(0, pdf.t_margin, pdf.l_margin, pdf.eph)
deathstyle = FontFace(color=black, fill_color=red)
# write_html() doesn't add a nl at the very top of the page anymore.
pdf.ln(0.1)
for v in (VAlign.T, VAlign.M, VAlign.B):
pdf.write_html(f"<h1>Vertical alignment: {v}</h1>")
with pdf.table(line_height=pdf.font_size, padding=3, v_align=v) as table:
for data_row in TABLE_DATA:
row = table.row()
for datum in data_row:
if "Death" in datum:
row.cell(datum, style=deathstyle)
else:
row.cell(datum)
assert_pdf_equal(pdf, HERE / "table_vertical_alignment.pdf", tmp_path)
def test_table_padding_per_cell(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=12)
red = (255, 100, 100)
black = (0, 0, 0)
deathstyle = FontFace(color=black, fill_color=red)
with pdf.table(line_height=pdf.font_size, padding=2) as table:
for irow in range(5):
row = table.row()
for icol in range(5):
datum = "Circus"
if irow == 3 and icol % 2 == 0:
row.cell(
"custom padding", style=deathstyle, padding=(2 * icol, 8, 8, 8)
)
else:
row.cell(datum)
assert_pdf_equal(pdf, HERE / "table_padding_per_cell.pdf", tmp_path)
def test_table_valign_per_row(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=12)
with pdf.table(first_row_as_headings=False, padding=2) as table:
for _irow, v_align in enumerate(VAlign):
row = table.row(v_align=v_align)
for icol in range(5):
datum = icol * "Circus\n"
row.cell(
f"{datum}v_align={v_align}",
v_align=v_align,
)
assert_pdf_equal(pdf, HERE / "table_valign_per_row.pdf", tmp_path)
def test_table_valign_per_cell(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=12)
red = (255, 100, 100)
black = (0, 0, 0)
deathstyle = FontFace(color=black, fill_color=red)
with pdf.table(line_height=pdf.font_size, padding=2, v_align=VAlign.M) as table:
for irow in range(5):
row = table.row()
for icol in range(5):
datum = icol * "Circus\n"
if irow in (2, 3):
if irow == 2:
v_align = VAlign.T
else:
v_align = VAlign.B
row.cell(
f"{datum}: custom v-align {v_align}",
style=deathstyle,
v_align=v_align,
)
else:
row.cell(datum)
assert_pdf_equal(pdf, HERE / "table_valign_per_cell.pdf", tmp_path)
def test_table_with_gutter_and_padding_and_outer_border_width(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=16)
with pdf.table(
TABLE_DATA,
gutter_height=3,
gutter_width=5,
line_height=pdf.font_size,
align="L",
outer_border_width=2,
):
pass
assert_pdf_equal(
pdf, HERE / "table_with_gutter_and_padding_and_outer_border_width.pdf", tmp_path
)
def test_table_with_colspan(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=12)
def make_text(n):
a = TABLE_DATA_LIST[int(n / 2) % len(TABLE_DATA_LIST)]
b = TABLE_DATA_LIST[(int(n**2 * 10) + 4) % len(TABLE_DATA_LIST)]
if n % 4 == 0:
return f"{a} {b}"
if n % 4 == 1:
return f"{a} {b} {a}"
if n % 4 == 2:
return f"{b} {a}"
return a
with pdf.table(line_height=pdf.font_size, gutter_height=3, gutter_width=3) as table:
for irow in range(10):
row = table.row()
for icol in range(10):
txt = make_text(irow * 10 + icol)
txt = str(icol) + " " + txt
if irow > 0:
if icol == 2:
row.cell(txt + " SPAN 2", colspan=2)
continue
if icol == 3:
continue
row.cell(txt)
assert_pdf_equal(pdf, HERE / "table_with_colspan.pdf", tmp_path)
def test_table_outside_border_width(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=12)
with pdf.table(outer_border_width=1, gutter_height=10, gutter_width=15) as table:
for _ in range(5):
row = table.row()
for _ in range(5):
datum = "Circus"
row.cell(datum)
assert_pdf_equal(pdf, HERE / "table_with_outside_border_width.pdf", tmp_path)
def test_table_colspan_and_padding(tmp_path):
pdf = FPDF()
pdf.set_font("Times", size=12)
pdf.add_page()
with pdf.table(col_widths=(1, 2, 1, 1), padding=5) as table:
row = table.row()
row.cell("0")
row.cell("1")
row.cell("2")
row.cell("3")
row = table.row()
row.cell("A1")
row.cell("A2", colspan=2)
# row.cell("void") # <--- this cell is not rendered
row.cell("A4")
row = table.row()
row.cell("B1", colspan=2)
# row.cell("void") # <--- this cell is not rendered
row.cell("B3")
row.cell("B4")
pdf.c_margin = 10
with pdf.table(col_widths=(1, 2, 1, 1), padding=5) as table:
row = table.row()
row.cell("0")
row.cell("1")
row.cell("2")
row.cell("3")
row = table.row()
row.cell("A1")
row.cell("A2", colspan=2)
# row.cell("void") # <--- this cell is not rendered
row.cell("A4")
row = table.row()
row.cell("B1", colspan=2)
# row.cell("void") # <--- this cell is not rendered
row.cell("B3")
row.cell("B4")
assert_pdf_equal(pdf, HERE / "table_colspan_and_padding.pdf", tmp_path)
def test_table_colspan_and_padding_and_gutter(tmp_path):
pdf = FPDF()
pdf.set_font("Times", size=12)
pdf.add_page()
with pdf.table(
col_widths=(1, 2, 1, 1), padding=5, gutter_height=3, gutter_width=5
) as table:
row = table.row()
row.cell("0")
row.cell("1")
row.cell("2")
row.cell("3")
row = table.row()
row.cell("A1")
row.cell("A2", colspan=2)
row.cell("A4")
row = table.row()
row.cell("B1", colspan=2)
row.cell("B3")
row.cell("B4")
assert_pdf_equal(pdf, HERE / "table_colspan_and_padding_and_gutter.pdf", tmp_path)
def test_table_colspan_and_padding_and_gutter_and_width(tmp_path):
pdf = FPDF()
pdf.set_font("Times", size=12)
pdf.add_page()
with pdf.table(
col_widths=(1, 2, 1, 1), padding=5, gutter_height=3, gutter_width=5, width=100
) as table:
row = table.row()
row.cell("0")
row.cell("1")
row.cell("2")
row.cell("3")
row = table.row()
row.cell("A1")
row.cell("A2,3,4", colspan=3)
row = table.row()
row.cell("B1", colspan=2)
row.cell("B3")
row.cell("B4")
assert_pdf_equal(
pdf, HERE / "table_colspan_and_padding_and_gutter_and_width.pdf", tmp_path
)
def test_table_with_cell_overflow(tmp_path):
pdf = FPDF()
pdf.set_font("Times", size=30)
pdf.add_page()
boldstyle = FontFace("Times", emphasis="B")
with pdf.table(width=pdf.epw / 2, col_widths=(1, 2, 1)) as table:
row = table.row()
row.cell("left")
row.cell("center")
row.cell("right") # triggers header cell overflow on last column
row = table.row()
row.cell("left")
row.cell("center")
row.cell(
"right", style=boldstyle
) # triggers header cell overflow on last column
row = table.row()
row.cell("A1")
row.cell("A2")
row.cell("A33333333") # triggers cell overflow on last column
row = table.row()
row.cell("B1")
row.cell("B2")
row.cell("B3")
assert_pdf_equal(pdf, HERE / "table_with_cell_overflow_font_setting.pdf", tmp_path)
def test_table_draw_box_borders(tmp_path):
pdf = FPDF()
pdf.set_font("Times", size=16)
pdf.add_page()
def box(x, y, borders):
draw_box_borders(
pdf,
x - 10,
y - 10,
x + 40,
y + 20,
fill_color=(200, 200, 200),
border="None",
)
draw_box_borders(pdf, x - 20, y - 20, x + 50, y + 30, border=borders)
pdf.set_xy(x, y)
pdf.cell(text=borders)
box(40, 40, "L")
box(140, 40, "R")
box(40, 140, "T")
box(140, 140, "B")
assert_pdf_equal(pdf, HERE / "table_draw_box_borders.pdf", tmp_path)
|
