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
|
from pathlib import Path
import pytest
from fpdf import FPDF, FPDFException
from test.conftest import assert_pdf_equal, LOREM_IPSUM
HERE = Path(__file__).resolve().parent
FONTS_DIR = HERE.parent / "fonts"
PNG_DIR = HERE.parent / "image/png_images"
SVG_DIR = HERE.parent / "svg/svg_sources"
def test_tcols_align(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=12)
col = pdf.text_columns()
with col:
col.write(text=LOREM_IPSUM[:100])
pdf.set_font("Times", size=12)
col.write(text=LOREM_IPSUM[100:200])
pdf.set_font("Courier", size=12)
col.write(text=LOREM_IPSUM[200:300])
pdf.set_font("Helvetica", style="I", size=12)
with col:
with col.paragraph(text_align="J", top_margin=pdf.font_size * 2) as par:
par.write(text=LOREM_IPSUM[:100])
pdf.set_font("Times", style="I", size=12)
par.write(text=LOREM_IPSUM[100:200])
pdf.set_font("Courier", style="I", size=12)
par.write(text=LOREM_IPSUM[200:300])
pdf.set_font("Helvetica", style="B", size=12)
with col:
with col.paragraph(text_align="R", top_margin=pdf.font_size * 2) as par:
par.write(text=LOREM_IPSUM[:100])
pdf.set_font("Times", style="B", size=12)
par.write(text=LOREM_IPSUM[100:200])
pdf.set_font("Courier", style="B", size=12)
par.write(text=LOREM_IPSUM[200:300])
pdf.set_font("Helvetica", style="BI", size=12)
with col:
with col.paragraph(text_align="C", top_margin=pdf.font_size * 2) as par:
par.write(text=LOREM_IPSUM[:100])
pdf.set_font("Times", style="BI", size=12)
par.write(text=LOREM_IPSUM[100:200])
pdf.set_font("Courier", style="BI", size=12)
par.write(text=LOREM_IPSUM[200:300])
assert_pdf_equal(pdf, HERE / "tcols_align.pdf", tmp_path)
def test_tcols_3cols(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.t_margin = 50
pdf.set_auto_page_break(True, 100)
pdf.set_font("Helvetica", size=6)
cols = pdf.text_columns(
text=LOREM_IPSUM,
text_align="J",
img=SVG_DIR / "SVG_logo.svg",
img_fill_width=True,
ncols=3,
gutter=5,
)
with cols:
pdf.set_font("Times", size=8)
cols.write(text=LOREM_IPSUM)
pdf.set_font("Courier", size=10)
cols.write(text=LOREM_IPSUM)
pdf.set_font("Helvetica", size=12)
cols.write(text=LOREM_IPSUM)
pdf.set_font("Times", size=14)
cols.write(text=LOREM_IPSUM)
pdf.set_font("Courier", size=16)
cols.write(text=LOREM_IPSUM)
assert_pdf_equal(pdf, HERE / "tcols_3cols.pdf", tmp_path)
def test_tcols_balance(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_auto_page_break(True, 100)
pdf.set_font("Helvetica", size=6)
cols_2 = pdf.text_columns(text_align="J", ncols=2, gutter=10, balance=True)
cols_3 = pdf.text_columns(text_align="J", ncols=3, gutter=5, balance=True)
with cols_2:
pdf.set_font("Times", size=8)
cols_2.write(text=LOREM_IPSUM[:300])
with cols_3:
pdf.set_font("Courier", size=10)
cols_3.write(text=LOREM_IPSUM[300:600])
with cols_2:
pdf.set_font("Helvetica", size=12)
cols_2.write(text=LOREM_IPSUM[600:900])
with cols_3:
pdf.set_font("Times", size=14)
cols_3.write(text=LOREM_IPSUM[:300])
assert_pdf_equal(pdf, HERE / "tcols_balance.pdf", tmp_path)
def test_tcols_charwrap(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("courier", size=16)
col = pdf.text_columns(l_margin=50, r_margin=50)
# wrapmode on paragraph
with col.paragraph(wrapmode="CHAR", bottom_margin=pdf.font_size) as par:
par.write(text=LOREM_IPSUM[:500])
col.render()
# wrapmode on column
with pdf.text_columns(
l_margin=50,
r_margin=50,
wrapmode="CHAR",
) as col:
with col.paragraph() as par:
par.write(text=LOREM_IPSUM[500:1000])
assert_pdf_equal(pdf, HERE / "tcols_charwrap.pdf", tmp_path)
def test_tcols_images(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=12)
cols = pdf.text_columns(ncols=3, text_align="J")
left, right = cols.current_x_extents(pdf.y, 0)
pdf.line(left, pdf.t_margin, left, pdf.h - pdf.b_margin)
pdf.line(right, pdf.t_margin, right, pdf.h - pdf.b_margin)
with cols:
cols.write(text="Images at Native Size\n(Raster 72 dpi, SVG 90 dpi)\n\n")
cols.write(text=LOREM_IPSUM[:100])
cols.image(PNG_DIR / "ac6343a98f8edabfcc6e536dd75aacb0.png")
cols.write(text=LOREM_IPSUM[100:200])
cols.image(SVG_DIR / "SVG_logo.svg")
cols.write(text=LOREM_IPSUM[200:300])
cols.new_column()
cols.write(text="Images at Full Column Width\n\n")
cols.write(text=LOREM_IPSUM[:100])
cols.image(
PNG_DIR / "ac6343a98f8edabfcc6e536dd75aacb0.png",
fill_width=True,
)
cols.write(text=LOREM_IPSUM[100:200])
cols.image(SVG_DIR / "SVG_logo.svg", fill_width=True)
cols.write(text=LOREM_IPSUM[200:300])
cols.new_column()
cols.write(text="Images Aligned Right and Center\n\n")
cols.write(text=LOREM_IPSUM[:100])
cols.image(
PNG_DIR / "ac6343a98f8edabfcc6e536dd75aacb0.png",
align="RIGHT",
)
cols.write(text=LOREM_IPSUM[100:200])
cols.image(SVG_DIR / "SVG_logo.svg", align="CENTER")
cols.write(text=LOREM_IPSUM[200:300])
cols.new_column()
cols.write(text="Images at Size 50x20\ntop/bottom margin\n\n")
cols.write(text=LOREM_IPSUM[:100])
cols.image(
PNG_DIR / "ac6343a98f8edabfcc6e536dd75aacb0.png",
width=50,
height=20,
top_margin=10,
)
cols.write(text=LOREM_IPSUM[100:200])
cols.image(
SVG_DIR / "SVG_logo.svg",
width=50,
height=20,
bottom_margin=10,
)
cols.write(text=LOREM_IPSUM[200:300])
cols.new_column()
cols.write(text="Images at Size 50x20 and keep_aspect_ratio=True\n\n")
cols.write(text=LOREM_IPSUM[:100])
cols.image(
PNG_DIR / "ac6343a98f8edabfcc6e536dd75aacb0.png",
width=50,
height=20,
keep_aspect_ratio=True,
)
cols.write(text=LOREM_IPSUM[100:200])
cols.image(
SVG_DIR / "SVG_logo.svg",
width=50,
height=20,
keep_aspect_ratio=True,
)
cols.write(text=LOREM_IPSUM[200:300])
cols.new_column()
cols.write(text="Images at Size 20x50 and keep_aspect_ratio=True\n\n")
cols.write(text=LOREM_IPSUM[:100])
cols.image(
PNG_DIR / "ac6343a98f8edabfcc6e536dd75aacb0.png",
width=20,
height=50,
keep_aspect_ratio=True,
)
cols.write(text=LOREM_IPSUM[100:200])
cols.image(
SVG_DIR / "SVG_logo.svg",
width=20,
height=50,
keep_aspect_ratio=True,
)
cols.write(text=LOREM_IPSUM[200:300])
cols.new_column()
cols.write(text="Column break by image\n\n")
cols.write(text=LOREM_IPSUM[:100])
cols.image(
PNG_DIR / "ac6343a98f8edabfcc6e536dd75aacb0.png",
fill_width=True,
)
cols.write(text=LOREM_IPSUM[100:200])
cols.image(SVG_DIR / "SVG_logo.svg", fill_width=True)
cols.write(text=LOREM_IPSUM[200:300])
cols.image(
PNG_DIR / "ac6343a98f8edabfcc6e536dd75aacb0.png",
fill_width=True,
)
cols.image(SVG_DIR / "SVG_logo.svg", fill_width=True)
assert_pdf_equal(pdf, HERE / "tcols_images.pdf", tmp_path)
def test_tcols_no_font():
pdf = FPDF()
pdf.add_page()
with pytest.raises(FPDFException) as error:
col = pdf.text_columns()
col.write("something")
expected_msg = "No font set, you need to call set_font() beforehand"
assert str(error.value) == expected_msg
with pytest.raises(FPDFException) as error:
col.ln()
expected_msg = "No font set, you need to call set_font() beforehand"
assert str(error.value) == expected_msg
def test_tcols_bad_uses():
pdf = FPDF()
pdf.add_page()
pdf.set_font("courier", size=16)
col = pdf.text_columns()
# recursive text region context
with col:
col.write("something")
with pytest.raises(FPDFException) as error:
with col:
pass
expected_msg = "Unable to enter the same TextColumns context recursively."
assert str(error.value) == expected_msg
# recursive use of paragraph context
with col.paragraph() as par:
par.write("something")
with pytest.raises(FPDFException) as error:
col.paragraph()
expected_msg = "Unable to nest paragraphs."
assert str(error.value) == expected_msg
# writing to column while we have an explicit paragraph active
with col.paragraph() as par:
par.write("something")
with pytest.raises(FPDFException) as error:
col.write("else")
expected_msg = "Conflicts with active paragraph. Either close the current paragraph or write your text inside it."
assert str(error.value) == expected_msg
# ending a non-existent paragraph
with pytest.raises(FPDFException) as error:
col.end_paragraph()
expected_msg = "No active paragraph to end."
assert str(error.value) == expected_msg
# column with negative width
with pytest.raises(FPDFException) as error:
col = pdf.text_columns(l_margin=150, r_margin=150)
expected_msg = (
"TextColumns(): Right limit (60.00155555555551) lower than left limit (150)."
)
assert str(error.value) == expected_msg
# invalid alignment values
with pytest.raises(ValueError) as error:
col = pdf.text_columns(text_align="X_CENTER")
expected_msg = (
"Text_align must be 'LEFT', 'CENTER', 'RIGHT', or 'JUSTIFY', not 'X_CENTER'."
)
assert str(error.value) == expected_msg
with pytest.raises(ValueError) as error:
with pdf.text_columns() as col:
par = col.paragraph(text_align="X_CENTER")
assert str(error.value) == expected_msg
with pytest.raises(ValueError) as error:
with pdf.text_columns() as col:
col.image(name="foo", align="JUSTIFY")
expected_msg = "Align must be 'LEFT', 'CENTER', or 'RIGHT', not 'JUSTIFY'."
assert str(error.value) == expected_msg
# Wrong call sequence for ImageParagraph.
with pdf.text_columns() as col:
col.image(name=PNG_DIR / "ac6343a98f8edabfcc6e536dd75aacb0.png")
with pytest.raises(RuntimeError) as error:
col._paragraphs[-1].render(1, 2, 3) # pylint: disable=protected-access
expected_msg = "ImageParagraph.build_line() must be called before render()."
assert str(error.value) == expected_msg
def test_tcols_break_top_margin(tmp_path): # regression test for #1214
"""Ensure that the top/bottom margins of a paragraph trigger
a column break.
"""
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=14)
pdf.set_top_margin(50)
pdf.set_auto_page_break(True, 50)
pdf.rect(pdf.l_margin, pdf.t_margin, pdf.epw, pdf.eph)
with pdf.text_columns(text_align="J", ncols=2) as cols:
for _ in range(3):
with cols.paragraph(
text_align="J",
bottom_margin=pdf.font_size * 5,
top_margin=pdf.font_size * 5,
) as par:
par.write(text=LOREM_IPSUM)
assert_pdf_equal(pdf, HERE / "tcols_break_top_margin.pdf", tmp_path)
def test_paragraph_emphasis(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=32)
column = pdf.text_columns()
# Paragraph 1:
par = column.paragraph()
par.write(text="Un.")
column.end_paragraph()
# Paragraph 2:
pdf.set_font(style="B")
par = column.paragraph()
par.write(text="Deux.")
pdf.set_font(style="I")
par.write(text="Trois.")
column.end_paragraph()
column.render()
assert_pdf_equal(pdf, HERE / "paragraph_emphasis.pdf", tmp_path)
def test_paragraph_first_line_indent(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=12)
with pdf.text_columns() as cols:
with cols.paragraph(first_line_indent=10, text_align="J") as paragraph:
paragraph.write(text=LOREM_IPSUM)
assert_pdf_equal(pdf, HERE / "paragraph_first_line_indent.pdf", tmp_path)
@pytest.mark.skip(reason="uharfbuzz is not available in debian")
def test_text_columns_with_text_shaping(tmp_path): # issue 1439
pdf = FPDF()
pdf.add_page()
pdf.set_text_shaping(True)
pdf.set_font("Times", "", 14)
with pdf.text_columns(ncols=2) as cols:
cols.write("Lorem ipsum dolor sit amet")
cols.new_column()
cols.write("Lorem ipsum dolor sit amet")
assert_pdf_equal(pdf, HERE / "text_columns_with_text_shaping.pdf", tmp_path)
@pytest.mark.skip(reason="uharfbuzz is not available in debian")
def test_text_columns_with_shorter_2nd_column(tmp_path): # issue 1442
pdf = FPDF()
pdf.add_page()
pdf.set_text_shaping(True)
pdf.set_font("Times", size=14)
pdf.write(text="Headline")
pdf.ln()
pdf.ln()
with pdf.text_columns(ncols=2) as cols:
cols.write(
"Lorem ipsum dolor sit amet, consetetur sadipscing elitr,"
" sed diam nonumy eirmod tempor invidunt ut labore"
" et dolore magna aliquyam erat, sed diam voluptua."
)
cols.new_column()
cols.write("Lorem ipsum dolor sit amet")
pdf.ln()
pdf.write(text="More text after columns.")
pdf.ln()
assert_pdf_equal(pdf, HERE / "text_columns_with_shorter_2nd_column.pdf", tmp_path)
|
