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
|
from pathlib import Path
import pytest
from fpdf import FPDF, drawing
from test.conftest import assert_pdf_equal
HERE = Path(__file__).resolve().parent
def test_graphics_context(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("helvetica", size=12)
pdf.set_text_color(0x00, 0xFF, 0x00)
pdf.set_fill_color(0xFF, 0x88, 0xFF)
pdf.set_y(20)
pdf.cell(text="outer 01", new_x="LMARGIN", new_y="NEXT", fill=True)
with pdf.local_context():
pdf.set_font("courier", style="BIU", size=30)
pdf.set_text_color(0xFF, 0x00, 0x00)
pdf.set_fill_color(0xFF, 0xFF, 0x00)
pdf.cell(text="inner 01", new_x="LMARGIN", new_y="NEXT", fill=True)
pdf.set_x(70)
with pdf.rotation(30, pdf.get_x(), pdf.get_y()):
pdf.set_fill_color(0x00, 0xFF, 0x00)
pdf.cell(text="inner 02", new_x="LMARGIN", new_y="NEXT", fill=True)
pdf.set_stretching(150)
pdf.cell(text="inner 03", new_x="LMARGIN", new_y="NEXT", fill=True)
pdf.cell(text="outer 02", new_x="LMARGIN", new_y="NEXT", fill=True)
assert_pdf_equal(pdf, HERE / "graphics_context.pdf", tmp_path)
def test_change_settings():
"""
Make sure all the the set_xxx() methods stored in the graphics context
do the right thing, both when changing something or using the same value
again (the latter will often execute a separate, shortened code path).
"""
red = (255, 0, 0)
blue = (0, 255, 0)
green = (0, 0, 255)
# draw color
pdf = FPDF()
# verify default
tgt_draw_color = pdf.DEFAULT_DRAW_COLOR
assert pdf.draw_color == tgt_draw_color, (
f"pdf.draw_color ({pdf.draw_color})" f" != tgt_draw_color ({tgt_draw_color})"
)
# change to red
tgt_draw_color = drawing.DeviceRGB(*[c / 255 for c in red])
pdf.set_draw_color(*red)
assert pdf.draw_color == tgt_draw_color, (
f"pdf.draw_color ({pdf.draw_color})" f" != tgt_draw_color ({tgt_draw_color})"
)
# stays the same
pdf.set_draw_color(*red)
assert pdf.draw_color == tgt_draw_color, (
f"pdf.draw_color ({pdf.draw_color})" f" != tgt_draw_color ({tgt_draw_color})"
)
# fill color
pdf = FPDF()
# verify default
tgt_fill_color = pdf.DEFAULT_FILL_COLOR
assert pdf.fill_color == tgt_fill_color, (
f"pdf.fill_color ({pdf.fill_color})" f" != tgt_fill_color ({tgt_fill_color})"
)
# change to green
tgt_fill_color = drawing.DeviceRGB(*[c / 255 for c in green])
pdf.set_fill_color(*green)
assert pdf.fill_color == tgt_fill_color, (
f"pdf.fill_color ({pdf.fill_color})" f" != tgt_fill_color ({tgt_fill_color})"
)
# stays the same
pdf.set_fill_color(*green)
assert pdf.fill_color == tgt_fill_color, (
f"pdf.fill_color ({pdf.fill_color})" f" != tgt_fill_color ({tgt_fill_color})"
)
# text color
pdf = FPDF()
# verify default
tgt_text_color = pdf.DEFAULT_TEXT_COLOR
assert pdf.text_color == tgt_text_color, (
f"pdf.text_color ({pdf.text_color})" f" != tgt_text_color ({tgt_text_color})"
)
# change to blue
tgt_text_color = drawing.DeviceRGB(*[c / 255 for c in blue])
pdf.set_text_color(*blue)
assert pdf.text_color == tgt_text_color, (
f"pdf.text_color ({pdf.text_color})" f" != tgt_text_color ({tgt_text_color})"
)
# stays the same
pdf.set_text_color(*blue)
assert pdf.text_color == tgt_text_color, (
f"pdf.text_color ({pdf.text_color})" f" != tgt_text_color ({tgt_text_color})"
)
# underline
# no setter method for this one
# font_stretching
pdf = FPDF()
# verify default
tgt_font_stretching = 100
assert pdf.font_stretching == tgt_font_stretching, (
f"pdf.font_stretching ({pdf.font_stretching})"
f" != tgt_font_stretching ({tgt_font_stretching})"
)
# change
tgt_font_stretching = 120
pdf.set_stretching(tgt_font_stretching)
assert pdf.font_stretching == tgt_font_stretching, (
f"pdf.font_stretching ({pdf.font_stretching})"
f" != tgt_font_stretching ({tgt_font_stretching})"
)
# stays the same
pdf.set_stretching(tgt_font_stretching)
assert pdf.font_stretching == tgt_font_stretching, (
f"pdf.font_stretching ({pdf.font_stretching})"
f" != tgt_font_stretching ({tgt_font_stretching})"
)
# char_spacing
pdf = FPDF()
# verify default
tgt_char_spacing = 0
assert pdf.char_spacing == tgt_char_spacing, (
f"pdf.char_spacing ({pdf.char_spacing})"
f" != tgt_char_spacing ({tgt_char_spacing})"
)
# change
tgt_char_spacing = 5
pdf.set_char_spacing(tgt_char_spacing)
assert pdf.char_spacing == tgt_char_spacing, (
f"pdf.char_spacing ({pdf.char_spacing})"
f" != tgt_char_spacing ({tgt_char_spacing})"
)
# stays the same
pdf.set_char_spacing(tgt_char_spacing)
assert pdf.char_spacing == tgt_char_spacing, (
f"pdf.char_spacing ({pdf.char_spacing})"
f" != tgt_char_spacing ({tgt_char_spacing})"
)
# dash_pattern
pdf = FPDF()
pdf.add_page()
# verify default
tgt_dash_pattern = dict(dash=0, gap=0, phase=0)
assert pdf.dash_pattern == tgt_dash_pattern, (
f"pdf.dash_pattern ({pdf.dash_pattern})"
f" != tgt_dash_pattern ({tgt_dash_pattern})"
)
# change
tgt_dash_pattern = dict(dash=2, gap=1, phase=0)
pdf.set_dash_pattern(**tgt_dash_pattern)
assert pdf.dash_pattern == tgt_dash_pattern, (
f"pdf.dash_pattern ({pdf.dash_pattern})"
f" != tgt_dash_pattern ({tgt_dash_pattern})"
)
# stays the same
pdf.set_dash_pattern(**tgt_dash_pattern)
assert pdf.dash_pattern == tgt_dash_pattern, (
f"pdf.dash_pattern ({pdf.dash_pattern})"
f" != tgt_dash_pattern ({tgt_dash_pattern})"
)
# line_width
pdf = FPDF()
# verify default
tgt_line_width = 0.567 / pdf.k
assert pdf.line_width == tgt_line_width, (
f"pdf.line_width ({pdf.line_width})" f" != tgt_line_width ({tgt_line_width})"
)
# change
tgt_line_width = 0.5
pdf.set_line_width(tgt_line_width)
assert pdf.line_width == tgt_line_width, (
f"pdf.line_width ({pdf.line_width})" f" != tgt_line_width ({tgt_line_width})"
)
# stays the same
pdf.set_line_width(tgt_line_width)
assert pdf.line_width == tgt_line_width, (
f"pdf.line_width ({pdf.line_width})" f" != tgt_line_width ({tgt_line_width})"
)
# text_mode
# no setter method for this one
# font_size_pt
pdf = FPDF()
# verify default
tgt_font_size_pt = 12
tgt_font_size = tgt_font_size_pt / pdf.k
assert pdf.font_size_pt == tgt_font_size_pt, (
f"pdf.font_size_pt ({pdf.font_size_pt})"
f" != tgt_font_size_pt ({tgt_font_size_pt})"
)
assert pdf.font_size == tgt_font_size, (
f"pdf.font_size ({pdf.font_size})" f" != tgt_font_size ({tgt_font_size})"
)
# change
tgt_font_size_pt = 14
tgt_font_size = tgt_font_size_pt / pdf.k
pdf.set_font_size(tgt_font_size_pt)
assert pdf.font_size_pt == tgt_font_size_pt, (
f"pdf.font_size_pt ({pdf.font_size_pt})"
f" != tgt_font_size_pt ({tgt_font_size_pt})"
)
assert pdf.font_size == tgt_font_size, (
f"pdf.font_size ({pdf.font_size})" f" != tgt_font_size ({tgt_font_size})"
)
# stays the same
pdf.set_font_size(tgt_font_size_pt)
assert pdf.font_size_pt == tgt_font_size_pt, (
f"pdf.font_size_pt ({pdf.font_size_pt})"
f" != tgt_font_size_pt ({tgt_font_size_pt})"
)
assert pdf.font_size == tgt_font_size, (
f"pdf.font_size ({pdf.font_size})" f" != tgt_font_size ({tgt_font_size})"
)
# font
pdf = FPDF()
# verify default
tgt_font = ("", "", 12)
assert pdf.font_family == tgt_font[0], (
f"pdf.font_family ({pdf.font_family})" f" != tgt_font[0] ({tgt_font[0]})"
)
assert pdf.font_style == tgt_font[1], (
f"pdf.font_style ({pdf.font_style})" f" != tgt_font[1] ({tgt_font[1]})"
)
assert pdf.font_size_pt == tgt_font[2], (
f"pdf.font_size_pt ({pdf.font_size_pt})" f" != tgt_font[2] ({tgt_font[2]})"
)
# change
for tgt_font in (
dict(family="helvetica"),
dict(family="helvetica", style="B"),
dict(family="helvetica", size=14),
dict(family="helvetica", style="I", size=12),
):
pdf = FPDF()
pdf.set_font(**tgt_font)
assert pdf.font_family == tgt_font.get("family", ""), (
f"pdf.font_family ({pdf.font_family})"
f" != tgt_font.get('family', '') ({tgt_font.get('family', '')})"
)
assert pdf.font_style == tgt_font.get("style", ""), (
f"pdf.font_style ({pdf.font_style})"
f" != tgt_font.get('style', '') ({tgt_font.get('style', '')})"
)
assert pdf.font_size_pt == tgt_font.get("size", 12), (
f"pdf.font_size_pt ({pdf.font_size_pt})"
f" != tgt_font.get('size', 12) ({tgt_font.get('size', 12)})"
)
# stays the same
pdf.set_font(**tgt_font)
assert pdf.font_family == tgt_font.get("family"), (
f"pdf.font_family ({pdf.font_family})"
f" != tgt_font.get('family', '') ({tgt_font.get('family', '')})"
)
assert pdf.font_style == tgt_font.get("style"), (
f"pdf.font_style ({pdf.font_style})"
f" != tgt_font.get('style', '') ({tgt_font.get('style', '')})"
)
assert pdf.font_size_pt == tgt_font.get("size"), (
f"pdf.font_size_pt ({pdf.font_size_pt})"
f" != tgt_font.get('size', 12) ({tgt_font.get('size', 12)})"
)
def test_vpos_properties():
pdf = FPDF()
sub_scale = 0.8
pdf.sub_scale = sub_scale
assert (
pdf.sub_scale == sub_scale
), f"pdf.sub_scale ({pdf.sub_scale}) != sub_scale ({sub_scale})"
sup_scale = 0.81
pdf.sup_scale = sup_scale
assert (
pdf.sup_scale == sup_scale
), f"pdf.sup_scale ({pdf.sup_scale}) != sup_scale ({sup_scale})"
nom_scale = 0.82
pdf.nom_scale = nom_scale
assert (
pdf.nom_scale == nom_scale
), f"pdf.nom_scale ({pdf.nom_scale}) != nom_scale ({nom_scale})"
denom_scale = 0.83
pdf.denom_scale = denom_scale
assert (
pdf.denom_scale == denom_scale
), f"pdf.denom_scale ({pdf.denom_scale}) != denom_scale ({denom_scale})"
sub_lift = -0.2
pdf.sub_lift = sub_lift
assert (
pdf.sub_lift == sub_lift
), f"pdf.sub_lift ({pdf.sub_lift}) != sub_lift ({sub_lift})"
sup_lift = 0.5
pdf.sup_lift = sup_lift
assert (
pdf.sup_lift == sup_lift
), f"pdf.sup_lift ({pdf.sup_lift}) != sup_lift ({sup_lift})"
nom_lift = 0.3
pdf.nom_lift = nom_lift
assert (
pdf.nom_lift == nom_lift
), f"pdf.nom_lift ({pdf.nom_lift}) != nom_lift ({nom_lift})"
denom_lift = 1
pdf.denom_lift = denom_lift
assert (
pdf.denom_lift == denom_lift
), f"pdf.denom_lift ({pdf.denom_lift}) != denom_lift ({denom_lift})"
def test_local_context_init(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=12)
with pdf.local_context(
font_family="Courier", font_style="B", font_size_pt=24, text_color=(255, 128, 0)
):
pdf.cell(text="Local context")
pdf.ln()
pdf.cell(text="Back to base")
assert_pdf_equal(pdf, HERE / "local_context_init.pdf", tmp_path)
def test_local_context_shared_props(tmp_path):
"Test local_context() with settings that are controlled by both GraphicsStateMixin and drawing.GraphicsStyle"
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=12)
with pdf.local_context(
draw_color=(0, 128, 255),
fill_color=(255, 128, 0),
line_width=2,
dash_pattern=dict(dash=0.5, gap=9.5, phase=3.25),
):
pdf.rect(x=60, y=60, w=60, h=60, style="DF")
pdf.rect(x=60, y=150, w=60, h=60, style="DF")
assert_pdf_equal(pdf, HERE / "local_context_shared_props.pdf", tmp_path)
def test_local_context_inherited_shared_props(tmp_path):
"The only thing that should differ between the 2 squares is their opacity"
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=12)
pdf.set_draw_color(0, 128, 255)
pdf.set_fill_color(255, 128, 0)
pdf.set_line_width(2)
pdf.set_dash_pattern(dash=0.5, gap=9.5, phase=3.25)
pdf.write(text="normal")
with pdf.local_context(
fill_opacity=0.5, char_vpos="SUP"
): # => triggers creation of a local GraphicsStyle
pdf.rect(x=60, y=60, w=60, h=60, style="DF")
pdf.write(text="sup")
pdf.rect(x=60, y=150, w=60, h=60, style="DF")
pdf.write(text="normal")
assert_pdf_equal(pdf, HERE / "local_context_inherited_shared_props.pdf", tmp_path)
def test_invalid_local_context_init():
pdf = FPDF()
pdf.add_page()
with pytest.raises(ValueError):
with pdf.local_context(stroke_width=2):
pass
def test_local_context_font_size_and_header_footer(tmp_path): # issue 1204
class PDF(FPDF):
def header(self):
self.cell(text=f"Header {self.page_no()}")
self.ln()
def footer(self):
self.set_y(-15)
self.cell(text=f"Footer {self.page_no()}")
pdf = PDF()
pdf.set_font(family="Helvetica", size=12)
pdf.add_page()
with pdf.local_context(font_size_pt=36): # LABEL C
pdf.multi_cell(w=0, text="\n".join(f"Line {i + 1}" for i in range(21)))
assert pdf.font_size_pt == 12
assert_pdf_equal(
pdf, HERE / "local_context_font_size_and_header_footer.pdf", tmp_path
)
|
