-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
Copy pathtest_reader.py
1845 lines (1601 loc) · 56.9 KB
/
test_reader.py
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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Test the pypdf._reader module."""
import io
import time
from io import BytesIO
from pathlib import Path
from typing import List, Union
import pytest
from pypdf import PdfReader, PdfWriter
from pypdf._crypt_providers import crypt_provider
from pypdf._reader import convert_to_int
from pypdf.constants import ImageAttributes as IA
from pypdf.constants import PageAttributes as PG
from pypdf.constants import UserAccessPermissions as UAP
from pypdf.errors import (
EmptyFileError,
FileNotDecryptedError,
PdfReadError,
PdfStreamError,
WrongPasswordError,
)
from pypdf.generic import (
ArrayObject,
Destination,
DictionaryObject,
NameObject,
NumberObject,
TextStringObject,
)
from . import get_data_from_url, normalize_warnings
HAS_AES = crypt_provider[0] in ["pycryptodome", "cryptography"]
TESTS_ROOT = Path(__file__).parent.resolve()
PROJECT_ROOT = TESTS_ROOT.parent
RESOURCE_ROOT = PROJECT_ROOT / "resources"
SAMPLE_ROOT = PROJECT_ROOT / "sample-files"
NestedList = Union[int, None, List["NestedList"]]
@pytest.mark.parametrize(
("src", "num_pages"),
[("selenium-pypdf-issue-177.pdf", 1), ("pdflatex-outline.pdf", 4)],
)
def test_get_num_pages(src, num_pages):
src = RESOURCE_ROOT / src
with PdfReader(src) as reader:
assert len(reader.pages) == num_pages
# from #1911
assert "/Size" in reader.trailer
@pytest.mark.parametrize(
("pdf_path", "expected"),
[
(
RESOURCE_ROOT / "crazyones.pdf",
{
"/CreationDate": "D:20150604133406-06'00'",
"/Creator": " XeTeX output 2015.06.04:1334",
"/Producer": "xdvipdfmx (20140317)",
},
),
(
RESOURCE_ROOT / "metadata.pdf",
{
"/CreationDate": "D:20220415093243+02'00'",
"/ModDate": "D:20220415093243+02'00'",
"/Creator": "pdflatex, or other tool",
"/Producer": "Latex with hyperref, or other system",
"/Author": "Martin Thoma",
"/Keywords": "Some Keywords, other keywords; more keywords",
"/Subject": "The Subject",
"/Title": "The Title",
"/Trapped": "/False",
"/PTEX.Fullbanner": (
"This is pdfTeX, Version "
"3.141592653-2.6-1.40.23 (TeX Live 2021) "
"kpathsea version 6.3.3"
),
},
),
],
ids=["crazyones", "metadata"],
)
def test_read_metadata(pdf_path, expected):
with open(pdf_path, "rb") as inputfile:
reader = PdfReader(inputfile)
docinfo = reader.metadata
assert docinfo is not None
metadict = dict(docinfo)
assert metadict == expected
docinfo.title
docinfo.title_raw
docinfo.author
docinfo.author_raw
docinfo.creator
docinfo.creator_raw
docinfo.producer
docinfo.producer_raw
docinfo.subject
docinfo.subject_raw
docinfo.creation_date
docinfo.creation_date_raw
docinfo.modification_date
docinfo.modification_date_raw
docinfo.keywords
docinfo.keywords_raw
if "/Title" in metadict:
assert isinstance(docinfo.title, str)
assert metadict["/Title"] == docinfo.title
def test_read_metadata_title_is_utf8():
with open(RESOURCE_ROOT / "bytes.pdf", "rb") as inputfile:
reader = PdfReader(inputfile)
title = reader.metadata.title
# Should be a str.
assert title == "Microsoft Word - トランスバース社買収電話会議英語Final.docx"
def test_iss1943():
with PdfReader(RESOURCE_ROOT / "crazyones.pdf") as reader:
docinfo = reader.metadata
docinfo.update(
{
NameObject("/CreationDate"): TextStringObject(
"D:20230705005151Z00'00'"
),
NameObject("/ModDate"): TextStringObject("D:20230705005151Z00'00'"),
}
)
docinfo.creation_date
docinfo.creation_date_raw
docinfo.modification_date
docinfo.modification_date_raw
docinfo.update({NameObject("/CreationDate"): NumberObject(1)})
assert docinfo.creation_date is None
@pytest.mark.samples
@pytest.mark.parametrize(
"pdf_path", [SAMPLE_ROOT / "017-unreadable-meta-data/unreadablemetadata.pdf"]
)
def test_broken_meta_data(pdf_path):
with open(pdf_path, "rb") as f:
reader = PdfReader(f)
assert reader.metadata is None
with open(RESOURCE_ROOT / "crazyones.pdf", "rb") as f:
b = f.read(-1)
reader = PdfReader(BytesIO(b.replace(b"/Info 2 0 R", b"/Info 2 ")))
with pytest.raises(PdfReadError) as exc:
reader.metadata
assert "does not point to document information directory" in repr(exc)
@pytest.mark.parametrize(
"src",
[
RESOURCE_ROOT / "crazyones.pdf",
RESOURCE_ROOT / "commented.pdf",
],
)
def test_get_annotations(src):
with PdfReader(src) as reader:
for page in reader.pages:
if PG.ANNOTS in page:
for annot in page[PG.ANNOTS]:
subtype = annot.get_object()[IA.SUBTYPE]
if subtype == "/Text":
annot.get_object()[PG.CONTENTS]
@pytest.mark.parametrize(
("src", "nb_attachments"),
[
(RESOURCE_ROOT / "attachment.pdf", 1),
(RESOURCE_ROOT / "crazyones.pdf", 0),
],
)
def test_get_attachments(src, nb_attachments):
reader = PdfReader(src)
attachments = {}
for page in reader.pages:
if PG.ANNOTS in page:
for annotation in page[PG.ANNOTS]:
annotobj = annotation.get_object()
if annotobj[IA.SUBTYPE] == "/FileAttachment":
fileobj = annotobj["/FS"]
attachments[fileobj["/F"]] = fileobj["/EF"]["/F"].get_data()
assert len(attachments) == nb_attachments
@pytest.mark.parametrize(
("src", "outline_elements"),
[
(RESOURCE_ROOT / "pdflatex-outline.pdf", 9),
(RESOURCE_ROOT / "crazyones.pdf", 0),
],
)
def test_get_outline(src, outline_elements):
reader = PdfReader(src)
outline = reader.outline
assert len(outline) == outline_elements
@pytest.mark.samples
@pytest.mark.parametrize(
("src", "expected_images"),
[
("pdflatex-outline.pdf", []),
("crazyones.pdf", []),
("git.pdf", ["Image9.png"]),
pytest.param(
"imagemagick-lzw.pdf",
["Im0.png"],
marks=pytest.mark.xfail(reason="broken image extraction"),
),
pytest.param(
"imagemagick-ASCII85Decode.pdf",
["Im0.png"],
# marks=pytest.mark.xfail(reason="broken image extraction"),
),
("imagemagick-CCITTFaxDecode.pdf", ["Im0.tiff"]),
(SAMPLE_ROOT / "019-grayscale-image/grayscale-image.pdf", ["X0.png"]),
],
)
def test_get_images(src, expected_images):
from PIL import Image
src_abs = RESOURCE_ROOT / src
reader = PdfReader(src_abs)
page = reader.pages[0]
images_extracted = page.images
assert len(images_extracted) == len(expected_images)
for image, expected_image in zip(images_extracted, expected_images):
assert image.name == expected_image
assert (
image.name.split(".")[-1].upper()
== Image.open(io.BytesIO(image.data)).format
)
@pytest.mark.parametrize(
("strict", "with_prev_0", "startx_correction", "should_fail", "warning_msgs"),
[
(
True,
False,
-1,
False,
[
"startxref on same line as offset",
"Xref table not zero-indexed. "
"ID numbers for objects will be corrected.",
],
), # all nominal => no fail
(True, True, -1, True, ""), # Prev=0 => fail expected
(
False,
False,
-1,
False,
[
"startxref on same line as offset",
],
),
(
False,
True,
-1,
False,
[
"startxref on same line as offset",
"/Prev=0 in the trailer - assuming there is no previous xref table",
],
), # Prev =0 => no strict so tolerant
(True, False, 0, True, ""), # error on startxref, in strict => fail expected
(True, True, 0, True, ""),
(
False,
False,
0,
False,
[
"startxref on same line as offset",
"incorrect startxref pointer(1)",
"parsing for Object Streams",
],
), # error on startxref, but no strict => xref rebuilt,no fail
(
False,
True,
0,
False,
[
"startxref on same line as offset",
"incorrect startxref pointer(1)",
"parsing for Object Streams",
],
),
],
)
def test_get_images_raw(
caplog, strict, with_prev_0, startx_correction, should_fail, warning_msgs
):
pdf_data = (
b"%%PDF-1.7\n"
b"1 0 obj << /Count 1 /Kids [4 0 R] /Type /Pages >> endobj\n"
b"2 0 obj << >> endobj\n"
b"3 0 obj << >> endobj\n"
b"4 0 obj << /Contents 3 0 R /CropBox [0.0 0.0 2550.0 3508.0]"
b" /MediaBox [0.0 0.0 2550.0 3508.0] /Parent 1 0 R"
b" /Resources << /Font << >> >>"
b" /Rotate 0 /Type /Page >> endobj\n"
b"5 0 obj << /Pages 1 0 R /Type /Catalog >> endobj\n"
b"xref 1 5\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"trailer << %s/Root 5 0 R /Size 6 >>\n"
b"startxref %d\n"
b"%%%%EOF"
)
pdf_data = pdf_data % (
# - 1 below in the find because of the double %
pdf_data.find(b"1 0 obj") - 1,
pdf_data.find(b"2 0 obj") - 1,
pdf_data.find(b"3 0 obj") - 1,
pdf_data.find(b"4 0 obj") - 1,
pdf_data.find(b"5 0 obj") - 1,
b"/Prev 0 " if with_prev_0 else b"",
# startx_correction should be -1 due to double % at the beginning
# inducing an error on startxref computation
pdf_data.find(b"xref") + startx_correction,
)
pdf_stream = io.BytesIO(pdf_data)
if should_fail:
with pytest.raises(PdfReadError) as exc:
PdfReader(pdf_stream, strict=strict)
assert exc.type == PdfReadError
if startx_correction == -1:
assert (
exc.value.args[0]
== "/Prev=0 in the trailer (try opening with strict=False)"
)
else:
PdfReader(pdf_stream, strict=strict)
assert normalize_warnings(caplog.text) == warning_msgs
def test_issue297(caplog):
path = RESOURCE_ROOT / "issue-297.pdf"
with pytest.raises(PdfReadError) as exc:
reader = PdfReader(path, strict=True)
assert caplog.text == ""
assert "Broken xref table" in exc.value.args[0]
reader = PdfReader(path, strict=False)
assert normalize_warnings(caplog.text) == [
"incorrect startxref pointer(1)",
"parsing for Object Streams",
]
reader.pages[0]
@pytest.mark.parametrize(
("pdffile", "password", "should_fail"),
[
("encrypted-file.pdf", "test", False),
("encrypted-file.pdf", b"test", False),
("encrypted-file.pdf", "qwerty", True),
("encrypted-file.pdf", b"qwerty", True),
],
)
def test_get_page_of_encrypted_file(pdffile, password, should_fail):
"""
Check if we can read a page of an encrypted file.
This is a regression test for issue 327:
IndexError for get_page() of decrypted file
"""
path = RESOURCE_ROOT / pdffile
if should_fail:
with pytest.raises(PdfReadError):
PdfReader(path, password=password)
else:
PdfReader(path, password=password).pages[0]
@pytest.mark.parametrize(
("src", "expected", "expected_get_fields"),
[
(
"form.pdf",
{"foo": ""},
{"foo": {"/DV": "", "/FT": "/Tx", "/T": "foo", "/V": ""}},
),
(
"form_acrobatReader.pdf",
{"foo": "Bar"},
{"foo": {"/DV": "", "/FT": "/Tx", "/T": "foo", "/V": "Bar"}},
),
(
"form_evince.pdf",
{"foo": "bar"},
{"foo": {"/DV": "", "/FT": "/Tx", "/T": "foo", "/V": "bar"}},
),
(
"crazyones.pdf",
{},
None,
),
],
)
def test_get_form(src, expected, expected_get_fields, txt_file_path):
"""Check if we can read out form data."""
src = RESOURCE_ROOT / src
reader = PdfReader(src)
fields = reader.get_form_text_fields()
assert fields == expected
with open(txt_file_path, "w") as f:
fields = reader.get_fields(fileobj=f)
assert fields == expected_get_fields
if fields:
for field in fields.values():
# Just access the attributes
[
field.field_type,
field.parent,
field.kids,
field.name,
field.alternate_name,
field.mapping_name,
field.flags,
field.value,
field.default_value,
field.additional_actions,
]
@pytest.mark.parametrize(
("src", "page_number"),
[
("form.pdf", 0),
("pdflatex-outline.pdf", 2),
],
)
def test_get_page_number(src, page_number):
src = RESOURCE_ROOT / src
reader = PdfReader(src)
reader.get_page(0)
page = reader.pages[page_number]
assert reader.get_page_number(page) == page_number
@pytest.mark.parametrize(
("src", "expected"),
[("form.pdf", None), ("AutoCad_Simple.pdf", "/SinglePage")],
)
def test_get_page_layout(src, expected):
src = RESOURCE_ROOT / src
reader = PdfReader(src)
assert reader.page_layout == expected
@pytest.mark.parametrize(
("src", "expected"),
[
("form.pdf", "/UseNone"),
("crazyones.pdf", None),
],
)
def test_get_page_mode(src, expected):
src = RESOURCE_ROOT / src
reader = PdfReader(src)
assert reader.page_mode == expected
def test_read_empty():
with pytest.raises(EmptyFileError) as exc:
PdfReader(io.BytesIO())
assert exc.value.args[0] == "Cannot read an empty file"
def test_read_malformed_header(caplog):
with pytest.raises(PdfReadError) as exc:
PdfReader(io.BytesIO(b"foo"), strict=True)
assert exc.value.args[0] == "PDF starts with 'foo', but '%PDF-' expected"
caplog.clear()
try:
PdfReader(io.BytesIO(b"foo"), strict=False)
except Exception:
pass
assert caplog.messages[0].startswith("invalid pdf header")
def test_read_malformed_body():
with pytest.raises(PdfReadError) as exc:
PdfReader(io.BytesIO(b"%PDF-"), strict=True)
assert (
exc.value.args[0] == "EOF marker not found"
) # used to be:STREAM_TRUNCATED_PREMATURELY
def test_read_prev_0_trailer():
pdf_data = (
b"%%PDF-1.7\n"
b"1 0 obj << /Count 1 /Kids [4 0 R] /Type /Pages >> endobj\n"
b"2 0 obj << >> endobj\n"
b"3 0 obj << >> endobj\n"
b"4 0 obj << /Contents 3 0 R /CropBox [0.0 0.0 2550.0 3508.0]"
b" /MediaBox [0.0 0.0 2550.0 3508.0] /Parent 1 0 R"
b" /Resources << /Font << >> >>"
b" /Rotate 0 /Type /Page >> endobj\n"
b"5 0 obj << /Pages 1 0 R /Type /Catalog >> endobj\n"
b"xref 1 5\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"trailer << %s/Root 5 0 R /Size 6 >>\n"
b"startxref %d\n"
b"%%%%EOF"
)
with_prev_0 = True
pdf_data = pdf_data % (
pdf_data.find(b"1 0 obj"),
pdf_data.find(b"2 0 obj"),
pdf_data.find(b"3 0 obj"),
pdf_data.find(b"4 0 obj"),
pdf_data.find(b"5 0 obj"),
b"/Prev 0 " if with_prev_0 else b"",
pdf_data.find(b"xref") - 1,
)
pdf_stream = io.BytesIO(pdf_data)
with pytest.raises(PdfReadError) as exc:
PdfReader(pdf_stream, strict=True)
assert exc.value.args[0] == "/Prev=0 in the trailer (try opening with strict=False)"
def test_read_missing_startxref():
pdf_data = (
b"%%PDF-1.7\n"
b"1 0 obj << /Count 1 /Kids [4 0 R] /Type /Pages >> endobj\n"
b"2 0 obj << >> endobj\n"
b"3 0 obj << >> endobj\n"
b"4 0 obj << /Contents 3 0 R /CropBox [0.0 0.0 2550.0 3508.0]"
b" /MediaBox [0.0 0.0 2550.0 3508.0] /Parent 1 0 R"
b" /Resources << /Font << >> >>"
b" /Rotate 0 /Type /Page >> endobj\n"
b"5 0 obj << /Pages 1 0 R /Type /Catalog >> endobj\n"
b"xref 1 5\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"trailer << /Root 5 0 R /Size 6 >>\n"
# Removed for this test: b"startxref %d\n"
b"%%%%EOF"
)
pdf_data = pdf_data % (
pdf_data.find(b"1 0 obj"),
pdf_data.find(b"2 0 obj"),
pdf_data.find(b"3 0 obj"),
pdf_data.find(b"4 0 obj"),
pdf_data.find(b"5 0 obj"),
# Removed for this test: pdf_data.find(b"xref") - 1,
)
pdf_stream = io.BytesIO(pdf_data)
with pytest.raises(PdfReadError) as exc:
PdfReader(pdf_stream, strict=True)
assert exc.value.args[0] == "startxref not found"
def test_read_unknown_zero_pages(caplog):
pdf_data = (
b"%%PDF-1.7\n"
b"1 0 obj << /Count 1 /Kids [4 0 R] /Type /Pages >> endobj\n"
b"2 0 obj << >> endobj\n"
b"3 0 obj << >> endobj\n"
b"4 0 obj << /Contents 3 0 R /CropBox [0.0 0.0 2550.0 3508.0]"
b" /MediaBox [0.0 0.0 2550.0 3508.0] /Parent 1 0 R"
b" /Resources << /Font << >> >>"
b" /Rotate 0 /Type /Page >> endobj\n"
# Pages 0 0 is the key point:
b"5 0 obj << /Pages 0 0 R /Type /Catalog >> endobj\n"
b"xref 1 5\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"%010d 00000 n\n"
b"trailer << /Root 5 1 R /Size 6 >>\n"
b"startxref %d\n"
b"%%%%EOF"
)
pdf_data = pdf_data % (
pdf_data.find(b"1 0 obj") - 1,
pdf_data.find(b"2 0 obj") - 1,
pdf_data.find(b"3 0 obj") - 1,
pdf_data.find(b"4 0 obj") - 1,
pdf_data.find(b"5 0 obj") - 1,
pdf_data.find(b"xref") - 1,
)
pdf_stream = io.BytesIO(pdf_data)
reader = PdfReader(pdf_stream, strict=True)
warnings = [
"startxref on same line as offset",
"Xref table not zero-indexed. ID numbers for objects will be corrected.",
]
assert normalize_warnings(caplog.text) == warnings
with pytest.raises(PdfReadError) as exc:
len(reader.pages)
assert exc.value.args[0] == "Could not find object."
reader = PdfReader(pdf_stream, strict=False)
warnings += [
"Object 5 1 not defined.",
"startxref on same line as offset",
]
assert normalize_warnings(caplog.text) == warnings
with pytest.raises(PdfReadError) as exc:
len(reader.pages)
assert exc.value.args[0] == "Invalid object in /Pages"
def test_read_encrypted_without_decryption():
src = RESOURCE_ROOT / "libreoffice-writer-password.pdf"
reader = PdfReader(src)
with pytest.raises(FileNotDecryptedError) as exc:
len(reader.pages)
assert exc.value.args[0] == "File has not been decrypted"
def test_get_destination_page_number():
src = RESOURCE_ROOT / "pdflatex-outline.pdf"
reader = PdfReader(src)
outline = reader.outline
for outline_item in outline:
if not isinstance(outline_item, list):
reader.get_destination_page_number(outline_item)
def test_do_not_get_stuck_on_large_files_without_start_xref():
"""
Tests for the absence of a DoS bug, where a large file without an
startxref mark would cause the library to hang for minutes to hours.
"""
start_time = time.time()
broken_stream = BytesIO(b"\0" * 5 * 1000 * 1000)
with pytest.raises(PdfReadError):
PdfReader(broken_stream)
parse_duration = time.time() - start_time
# parsing is expected take less than a second on a modern cpu, but include
# a large tolerance to account for busy or slow systems
assert parse_duration < 60
@pytest.mark.enable_socket
def test_decrypt_when_no_id():
"""
Decrypt an encrypted file that's missing the 'ID' value in its trailer.
https://github.com/py-pdf/pypdf/issues/608
"""
with open(RESOURCE_ROOT / "encrypted_doc_no_id.pdf", "rb") as inputfile:
ipdf = PdfReader(inputfile)
ipdf.decrypt("")
assert ipdf.metadata == {"/Producer": "European Patent Office"}
def test_reader_properties():
reader = PdfReader(RESOURCE_ROOT / "crazyones.pdf")
assert reader.outline == []
assert len(reader.pages) == 1
assert reader.page_layout is None
assert reader.page_mode is None
assert reader.is_encrypted is False
@pytest.mark.parametrize(
"strict",
[True, False],
)
def test_issue604(caplog, strict):
"""Test with invalid destinations."""
with open(RESOURCE_ROOT / "issue-604.pdf", "rb") as f:
pdf = None
outline = None
if strict:
pdf = PdfReader(f, strict=strict)
with pytest.raises(PdfReadError) as exc:
outline = pdf.outline
if "Unknown Destination" not in exc.value.args[0]:
raise Exception("Expected exception not raised")
return # outline is not correct
else:
pdf = PdfReader(f, strict=strict)
outline = pdf.outline
msg = [
"Unknown destination: ms_Thyroid_2_2020_071520_watermarked.pdf [0, 1]"
]
assert normalize_warnings(caplog.text) == msg
def get_dest_pages(x) -> NestedList:
if isinstance(x, list):
return [get_dest_pages(y) for y in x]
else:
destination_page_number = pdf.get_destination_page_number(x)
if destination_page_number is None:
return destination_page_number
return destination_page_number + 1
out = []
# oi can be destination or a list:preferred to just print them
for oi in outline:
out.append(get_dest_pages(oi)) # noqa: PERF401
def test_decode_permissions():
reader = PdfReader(RESOURCE_ROOT / "crazyones.pdf")
base = {
"accessability": False, # Do not fix typo, as part of official, but deprecated API.
"annotations": False,
"assemble": False,
"copy": False,
"forms": False,
"modify": False,
"print_high_quality": False,
"print": False,
}
print_ = base.copy()
print_["print"] = True
with pytest.warns(
DeprecationWarning,
match="decode_permissions is deprecated and will be removed in pypdf 5.0.0. Use user_access_permissions instead", # noqa: E501
):
assert reader.decode_permissions(4) == print_
modify = base.copy()
modify["modify"] = True
with pytest.warns(
DeprecationWarning,
match="decode_permissions is deprecated and will be removed in pypdf 5.0.0. Use user_access_permissions instead", # noqa: E501
):
assert reader.decode_permissions(8) == modify
@pytest.mark.skipif(not HAS_AES, reason="No AES implementation")
def test_user_access_permissions():
# Not encrypted.
reader = PdfReader(RESOURCE_ROOT / "crazyones.pdf")
assert reader.user_access_permissions is None
# Encrypted.
reader = PdfReader(RESOURCE_ROOT / "encryption" / "r6-owner-password.pdf")
assert reader.user_access_permissions == UAP.all()
# Custom writer permissions.
writer = PdfWriter(clone_from=RESOURCE_ROOT / "crazyones.pdf")
writer.encrypt(
user_password="",
owner_password="abc",
permissions_flag=UAP.PRINT | UAP.FILL_FORM_FIELDS,
)
output = BytesIO()
writer.write(output)
reader = PdfReader(output)
assert reader.user_access_permissions == (UAP.PRINT | UAP.FILL_FORM_FIELDS)
# All writer permissions.
writer = PdfWriter(clone_from=RESOURCE_ROOT / "crazyones.pdf")
writer.encrypt(
user_password="",
owner_password="abc",
permissions_flag=UAP.all(),
)
output = BytesIO()
writer.write(output)
reader = PdfReader(output)
assert reader.user_access_permissions == UAP.all()
def test_pages_attribute():
pdf_path = RESOURCE_ROOT / "crazyones.pdf"
reader = PdfReader(pdf_path)
# Test if getting as slice throws an error
assert len(reader.pages[:]) == 1
with pytest.raises(IndexError) as exc:
reader.pages[-1000]
assert exc.value.args[0] == "Sequence index out of range"
with pytest.raises(IndexError):
reader.pages[1000]
assert exc.value.args[0] == "Sequence index out of range"
def test_convert_to_int():
assert convert_to_int(b"\x01", 8) == 1
def test_convert_to_int_error():
with pytest.raises(PdfReadError) as exc:
convert_to_int(b"256", 16)
assert exc.value.args[0] == "Invalid size in convert_to_int"
@pytest.mark.enable_socket
def test_iss925():
url = "https://github.com/py-pdf/pypdf/files/8796328/1.pdf"
reader = PdfReader(BytesIO(get_data_from_url(url, name="iss925.pdf")))
for page_sliced in reader.pages:
page_object = page_sliced.get_object()
# Extracts the PDF's Annots (Annotations and Commenting):
annots = page_object.get("/Annots")
if annots is not None:
for annot in annots:
annot.get_object()
def test_get_object():
reader = PdfReader(RESOURCE_ROOT / "hello-world.pdf")
assert reader.get_object(22)["/Type"] == "/Catalog"
assert reader._get_indirect_object(22, 0)["/Type"] == "/Catalog"
def test_extract_text_hello_world():
reader = PdfReader(RESOURCE_ROOT / "hello-world.pdf")
text = reader.pages[0].extract_text().split("\n")
assert text == [
"English:",
"Hello World",
"Arabic:",
"مرحبا بالعالم",
"Russian:",
"Привет, мир",
"Chinese (traditional):",
"你好世界",
"Thai:",
"สวัสดีชาวโลก",
"Japanese:",
"こんにちは世界",
]
def test_read_path():
path = Path(RESOURCE_ROOT, "crazyones.pdf")
reader = PdfReader(path)
assert len(reader.pages) == 1
def test_read_not_binary_mode(caplog):
with open(RESOURCE_ROOT / "crazyones.pdf") as f:
msg = (
"PdfReader stream/file object is not in binary mode. "
"It may not be read correctly."
)
with pytest.raises(io.UnsupportedOperation):
PdfReader(f)
assert normalize_warnings(caplog.text) == [msg]
@pytest.mark.enable_socket
@pytest.mark.skipif(not HAS_AES, reason="No AES algorithm available")
def test_read_form_416():
url = (
"https://www.fda.gov/downloads/AboutFDA/ReportsManualsForms/Forms/UCM074728.pdf"
)
reader = PdfReader(BytesIO(get_data_from_url(url, name="issue_416.pdf")))
fields = reader.get_form_text_fields()
assert len(fields) > 0
def test_form_topname_with_and_without_acroform(caplog):
r = PdfReader(RESOURCE_ROOT / "crazyones.pdf")
r.add_form_topname("no")
r.rename_form_topname("renamed")
assert "/AcroForm" not in r.trailer["/Root"]
r.trailer["/Root"][NameObject("/AcroForm")] = DictionaryObject()
r.add_form_topname("toto")
r.rename_form_topname("renamed")
assert len(r.get_fields()) == 0
r = PdfReader(RESOURCE_ROOT / "form.pdf")
r.add_form_topname("top")
flds = r.get_fields()
assert "top" in flds
assert "top.foo" in flds
r.rename_form_topname("renamed")
flds = r.get_fields()
assert "renamed" in flds
assert "renamed.foo" in flds
r = PdfReader(RESOURCE_ROOT / "form.pdf")
r.get_fields()["foo"].indirect_reference.get_object()[
NameObject("/Parent")
] = DictionaryObject()
r.add_form_topname("top")
assert "have a non-expected parent" in caplog.text
@pytest.mark.enable_socket
def test_extract_text_xref_issue_2(caplog):
# pdf/0264cf510015b2a4b395a15cb23c001e.pdf
url = "https://github.com/user-attachments/files/18381758/tika-981961.pdf"
msg = [
"incorrect startxref pointer(2)",
"parsing for Object Streams",
]
reader = PdfReader(BytesIO(get_data_from_url(url, name="tika-981961.pdf")))
for page in reader.pages:
page.extract_text()
assert normalize_warnings(caplog.text) == msg
@pytest.mark.enable_socket
@pytest.mark.slow
def test_extract_text_xref_issue_3(caplog):
# pdf/0264cf510015b2a4b395a15cb23c001e.pdf
url = "https://github.com/user-attachments/files/18381755/tika-977774.pdf"
msg = [
"incorrect startxref pointer(3)",
]
reader = PdfReader(BytesIO(get_data_from_url(url, name="tika-977774.pdf")))
for page in reader.pages:
page.extract_text()
assert normalize_warnings(caplog.text) == msg
@pytest.mark.enable_socket
def test_extract_text_pdf15():
# pdf/0264cf510015b2a4b395a15cb23c001e.pdf
url = "https://github.com/user-attachments/files/18381751/tika-976030.pdf"
reader = PdfReader(BytesIO(get_data_from_url(url, name="tika-976030.pdf")))
for page in reader.pages:
page.extract_text()
@pytest.mark.enable_socket
def test_extract_text_xref_table_21_bytes_clrf():
# pdf/0264cf510015b2a4b395a15cb23c001e.pdf
url = "https://github.com/user-attachments/files/18381723/tika-956939.pdf"
reader = PdfReader(BytesIO(get_data_from_url(url, name="tika-956939.pdf")))
for page in reader.pages:
page.extract_text()
@pytest.mark.enable_socket
def test_get_fields():
url = "https://github.com/user-attachments/files/18381747/tika-972486.pdf"
name = "tika-972486.pdf"
reader = PdfReader(BytesIO(get_data_from_url(url, name=name)))
fields = reader.get_fields()
assert fields is not None
assert "c1-1" in fields
assert dict(fields["c1-1"]) == (
{"/FT": "/Btn", "/T": "c1-1", "/_States_": ["/On", "/Off"]}
)
@pytest.mark.enable_socket
def test_get_full_qualified_fields():
url = "https://github.com/py-pdf/pypdf/files/10142389/fields_with_dots.pdf"
name = "fields_with_dots.pdf"
reader = PdfReader(BytesIO(get_data_from_url(url, name=name)))
fields = reader.get_form_text_fields(True)
assert fields is not None
assert "customer.name" in fields
fields = reader.get_form_text_fields(False)
assert fields is not None
assert "customer.name" not in fields
assert "name" in fields
fields = reader.get_fields(True)
assert fields is not None
assert "customer.name" in fields
assert fields["customer.name"]["/T"] == "name"
@pytest.mark.enable_socket
@pytest.mark.filterwarnings("ignore::pypdf.errors.PdfReadWarning")