-
Notifications
You must be signed in to change notification settings - Fork 904
/
Copy pathtest_pdf.py
1563 lines (1353 loc) · 53.1 KB
/
test_pdf.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
from __future__ import annotations
import base64
import logging
import math
import os
import tempfile
from dataclasses import dataclass
from pathlib import Path
from tempfile import SpooledTemporaryFile
from unittest import mock
import pytest
from pdf2image.exceptions import PDFPageCountError
from PIL import Image
from pytest_mock import MockFixture
from unstructured_inference.inference import layout
from unstructured_inference.inference.elements import Rectangle
from unstructured_inference.inference.layout import DocumentLayout, PageLayout
from unstructured_inference.inference.layoutelement import LayoutElement
from test_unstructured.unit_utils import assert_round_trips_through_JSON, example_doc_path
from unstructured.chunking.title import chunk_by_title
from unstructured.documents.coordinates import PixelSpace
from unstructured.documents.elements import (
CoordinatesMetadata,
Element,
ElementMetadata,
ElementType,
Footer,
Header,
ListItem,
NarrativeText,
Text,
Title,
)
from unstructured.errors import PageCountExceededError
from unstructured.partition import pdf, strategies
from unstructured.partition.pdf_image import ocr, pdfminer_processing
from unstructured.partition.pdf_image.pdfminer_processing import get_uris_from_annots
from unstructured.partition.utils.constants import (
SORT_MODE_BASIC,
SORT_MODE_DONT,
SORT_MODE_XY_CUT,
UNSTRUCTURED_INCLUDE_DEBUG_METADATA,
PartitionStrategy,
)
class MockResponse:
def __init__(self, status_code, response):
self.status_code = status_code
self.response = response
def json(self):
return self.response
def mock_healthy_get(url, **kwargs):
return MockResponse(status_code=200, response={})
def mock_unhealthy_get(url, **kwargs):
return MockResponse(status_code=500, response={})
def mock_unsuccessful_post(url, **kwargs):
return MockResponse(status_code=500, response={})
def mock_successful_post(url, **kwargs):
response = {
"pages": [
{
"number": 0,
"elements": [
{"type": "Title", "text": "Charlie Brown and the Great Pumpkin"},
],
},
{
"number": 1,
"elements": [{"type": "Title", "text": "A Charlie Brown Christmas"}],
},
],
}
return MockResponse(status_code=200, response=response)
class MockPageLayout(layout.PageLayout):
def __init__(self, number: int, image: Image):
self.number = number
self.image = image
self.image_metadata = {"width": 10, "height": 10}
self.detection_model = None
self.elements = [
layout.LayoutElement.from_coords(
type="Title",
x1=0.0,
y1=0.0,
x2=2.0,
y2=2.0,
text="Charlie Brown and the Great Pumpkin",
),
]
self.elements_array = layout.LayoutElements.from_list(self.elements)
class MockSinglePageLayout(layout.PageLayout):
def __init__(self, number: int, image: Image.Image):
self.number = number
self.image = image
self.image_metadata = {"width": 10, "height": 10}
@property
def elements(self):
return [
LayoutElement(
type="Headline",
text="Charlie Brown and the Great Pumpkin",
bbox=Rectangle(None, None, None, None),
),
LayoutElement(
type="Subheadline",
text="The Beginning",
bbox=Rectangle(None, None, None, None),
),
LayoutElement(
type="Text",
text="This time Charlie Brown had it really tricky...",
bbox=Rectangle(None, None, None, None),
),
LayoutElement(
type="Title",
text="Another book title in the same page",
bbox=Rectangle(None, None, None, None),
),
]
@property
def elements_array(self):
return layout.LayoutElements.from_list(self.elements)
class MockDocumentLayout(layout.DocumentLayout):
@property
def pages(self):
return [
MockPageLayout(number=0, image=Image.new("1", (1, 1))),
MockPageLayout(number=1, image=Image.new("1", (1, 1))),
]
class MockSinglePageDocumentLayout(layout.DocumentLayout):
@property
def pages(self):
return [
MockSinglePageLayout(number=1, image=Image.new("1", (1, 1))),
]
@pytest.mark.parametrize(
("filename", "file"),
[
(example_doc_path("pdf/layout-parser-paper-fast.pdf"), None),
(None, b"0000"),
],
)
def test_partition_pdf_local(monkeypatch, filename, file):
monkeypatch.setattr(
layout,
"process_data_with_model",
lambda *args, **kwargs: MockDocumentLayout(),
)
monkeypatch.setattr(
layout,
"process_file_with_model",
lambda *args, **kwargs: MockDocumentLayout(),
)
monkeypatch.setattr(
pdfminer_processing,
"process_data_with_pdfminer",
lambda *args, **kwargs: MockDocumentLayout(),
)
monkeypatch.setattr(
pdfminer_processing,
"process_file_with_pdfminer",
lambda *args, **kwargs: MockDocumentLayout(),
)
monkeypatch.setattr(
ocr,
"process_data_with_ocr",
lambda *args, **kwargs: MockDocumentLayout(),
)
monkeypatch.setattr(
ocr,
"process_file_with_ocr",
lambda *args, **kwargs: MockDocumentLayout(),
)
partition_pdf_response = pdf._partition_pdf_or_image_local(filename, file)
assert partition_pdf_response[0].text == "Charlie Brown and the Great Pumpkin"
def test_partition_pdf_local_raises_with_no_filename():
with pytest.raises((FileNotFoundError, PDFPageCountError)):
pdf._partition_pdf_or_image_local(filename="", file=None, is_image=False)
@pytest.mark.parametrize("file_mode", ["filename", "rb", "spool"])
@pytest.mark.parametrize(
("strategy", "starting_page_number", "expected_page_numbers", "origin"),
# fast: can't capture the "intentionally left blank page" page
# others: will ignore the actual blank page
[
(PartitionStrategy.FAST, 1, {1, 4}, {"pdfminer"}),
(PartitionStrategy.FAST, 3, {3, 6}, {"pdfminer"}),
(PartitionStrategy.HI_RES, 4, {4, 6, 7}, {"yolox", "pdfminer", "ocr_tesseract"}),
(PartitionStrategy.OCR_ONLY, 1, {1, 3, 4}, {"ocr_tesseract"}),
],
)
def test_partition_pdf_outputs_valid_amount_of_elements_and_metadata_values(
file_mode,
strategy,
starting_page_number,
expected_page_numbers,
origin,
filename=example_doc_path("pdf/layout-parser-paper-with-empty-pages.pdf"),
):
# Test that the partition_pdf function can handle filename
def _test(result):
# validate that the result is a non-empty list of dicts
assert len(result) > 10
# check that the pdf has multiple different page numbers
assert {element.metadata.page_number for element in result} == expected_page_numbers
if UNSTRUCTURED_INCLUDE_DEBUG_METADATA:
print(
[
(element.metadata.detection_origin, element.category, element.text)
for element in result
]
)
assert {element.metadata.detection_origin for element in result} == origin
if file_mode == "filename":
result = pdf.partition_pdf(
filename=filename, strategy=strategy, starting_page_number=starting_page_number
)
_test(result)
elif file_mode == "rb":
with open(filename, "rb") as f:
result = pdf.partition_pdf(
file=f, strategy=strategy, starting_page_number=starting_page_number
)
_test(result)
else:
with open(filename, "rb") as test_file:
with SpooledTemporaryFile() as spooled_temp_file:
spooled_temp_file.write(test_file.read())
spooled_temp_file.seek(0)
result = pdf.partition_pdf(
file=spooled_temp_file,
strategy=strategy,
starting_page_number=starting_page_number,
)
_test(result)
@mock.patch.dict(os.environ, {"UNSTRUCTURED_HI_RES_MODEL_NAME": "checkbox"})
def test_partition_pdf_with_model_name_env_var(
monkeypatch,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
monkeypatch.setattr(pdf, "extractable_elements", lambda *args, **kwargs: [])
with mock.patch.object(
layout,
"process_file_with_model",
return_value=MockDocumentLayout(),
) as mock_process:
pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.HI_RES)
assert mock_process.call_args[1]["model_name"] == "checkbox"
@pytest.mark.parametrize("model_name", ["checkbox", "yolox"])
def test_partition_pdf_with_model_name(
monkeypatch,
model_name,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
monkeypatch.setattr(pdf, "extractable_elements", lambda *args, **kwargs: [])
with mock.patch.object(
layout,
"process_file_with_model",
return_value=MockDocumentLayout(),
) as mock_process:
pdf.partition_pdf(
filename=filename,
strategy=PartitionStrategy.HI_RES,
model_name=model_name,
)
assert mock_process.call_args[1]["model_name"] == model_name
with mock.patch.object(
layout,
"process_data_with_model",
return_value=MockDocumentLayout(),
) as mock_process:
with open(filename, "rb") as f:
pdf.partition_pdf(
file=f,
strategy=PartitionStrategy.HI_RES,
model_name=model_name,
)
assert mock_process.call_args[1]["model_name"] == model_name
def test_partition_pdf_with_hi_res_model_name(
monkeypatch,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
monkeypatch.setattr(pdf, "extractable_elements", lambda *args, **kwargs: [])
with mock.patch.object(
layout,
"process_file_with_model",
return_value=MockDocumentLayout(),
) as mock_process:
pdf.partition_pdf(
filename=filename, strategy=PartitionStrategy.HI_RES, hi_res_model_name="checkbox"
)
# unstructured-ingest uses `model_name` instead of `hi_res_model_name`
assert mock_process.call_args[1]["model_name"] == "checkbox"
def test_partition_pdf_or_image_with_hi_res_model_name(
monkeypatch,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
monkeypatch.setattr(pdf, "extractable_elements", lambda *args, **kwargs: [])
with mock.patch.object(
layout,
"process_file_with_model",
return_value=MockDocumentLayout(),
) as mock_process:
pdf.partition_pdf_or_image(
filename=filename, strategy=PartitionStrategy.HI_RES, hi_res_model_name="checkbox"
)
# unstructured-ingest uses `model_name` instead of `hi_res_model_name`
assert mock_process.call_args[1]["model_name"] == "checkbox"
def test_partition_pdf_with_auto_strategy(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
elements = pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.AUTO)
title = "LayoutParser: A Unified Toolkit for Deep Learning Based Document Image Analysis"
assert elements[6].text == title
assert elements[6].metadata.filename == "layout-parser-paper-fast.pdf"
assert elements[6].metadata.file_directory == os.path.dirname(filename)
def test_partition_pdf_with_page_breaks(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
elements = pdf.partition_pdf(filename=filename, url=None, include_page_breaks=True)
assert "PageBreak" in [elem.category for elem in elements]
def test_partition_pdf_with_no_page_breaks(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
elements = pdf.partition_pdf(filename=filename, url=None)
assert "PageBreak" not in [elem.category for elem in elements]
def test_partition_pdf_with_fast_strategy(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
elements = pdf.partition_pdf(
filename=filename, url=None, strategy=PartitionStrategy.FAST, starting_page_number=3
)
assert len(elements) > 10
# check that the pdf has multiple different page numbers
assert {element.metadata.page_number for element in elements} == {3, 4}
for element in elements:
assert element.metadata.filename == "layout-parser-paper-fast.pdf"
def test_partition_pdf_with_fast_neg_coordinates():
filename = example_doc_path("pdf/negative-coords.pdf")
elements = pdf.partition_pdf(filename=filename, url=None, strategy=PartitionStrategy.FAST)
assert len(elements) == 5
assert elements[0].metadata.coordinates.points[0][0] < 0
assert elements[0].metadata.coordinates.points[1][0] < 0
def test_partition_pdf_with_fast_groups_text(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
elements = pdf.partition_pdf(filename=filename, url=None, strategy=PartitionStrategy.FAST)
first_narrative_element = None
for element in elements:
if isinstance(element, NarrativeText):
first_narrative_element = element
break
assert len(first_narrative_element.text) > 1000
assert first_narrative_element.text.startswith("Abstract. Recent advances")
assert first_narrative_element.text.endswith("https://layout-parser.github.io.")
assert first_narrative_element.metadata.filename == "layout-parser-paper-fast.pdf"
def test_partition_pdf_with_fast_strategy_from_file(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
with open(filename, "rb") as f:
elements = pdf.partition_pdf(file=f, url=None, strategy=PartitionStrategy.FAST)
assert len(elements) > 10
def test_partition_pdf_with_fast_strategy_and_page_breaks(
caplog,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
elements = pdf.partition_pdf(
filename=filename,
url=None,
strategy=PartitionStrategy.FAST,
include_page_breaks=True,
)
assert len(elements) > 10
assert "PageBreak" in [elem.category for elem in elements]
assert "unstructured_inference is not installed" not in caplog.text
for element in elements:
assert element.metadata.filename == "layout-parser-paper-fast.pdf"
def test_partition_pdf_raises_with_bad_strategy(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
with pytest.raises(ValueError):
pdf.partition_pdf(filename=filename, url=None, strategy="made_up")
def test_partition_pdf_falls_back_to_fast(
monkeypatch,
caplog,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
def mock_exists(dep):
return dep not in ["unstructured_inference", "unstructured_pytesseract"]
monkeypatch.setattr(strategies, "dependency_exists", mock_exists)
mock_return = [[Text("Hello there!")], []]
with mock.patch.object(
pdf,
"extractable_elements",
return_value=mock_return,
) as mock_partition:
pdf.partition_pdf(filename=filename, url=None, strategy=PartitionStrategy.HI_RES)
mock_partition.assert_called_once()
assert "unstructured_inference is not installed" in caplog.text
def test_partition_pdf_falls_back_to_fast_from_ocr_only(
monkeypatch,
caplog,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
def mock_exists(dep):
return dep not in ["unstructured_pytesseract"]
monkeypatch.setattr(strategies, "dependency_exists", mock_exists)
mock_return = [[Text("Hello there!")], []]
with mock.patch.object(
pdf,
"extractable_elements",
return_value=mock_return,
) as mock_partition, mock.patch.object(
pdf,
"_partition_pdf_or_image_with_ocr",
) as mock_partition_ocr:
pdf.partition_pdf(filename=filename, url=None, strategy=PartitionStrategy.OCR_ONLY)
mock_partition.assert_called_once()
mock_partition_ocr.assert_not_called()
assert "pytesseract is not installed" in caplog.text
def test_partition_pdf_falls_back_to_hi_res_from_ocr_only(
monkeypatch,
caplog,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
def mock_exists(dep):
return dep not in ["unstructured_pytesseract"]
monkeypatch.setattr(strategies, "dependency_exists", mock_exists)
monkeypatch.setattr(pdf, "extractable_elements", lambda *args, **kwargs: [])
mock_return = [Text("Hello there!")]
with mock.patch.object(
pdf,
"_partition_pdf_or_image_local",
return_value=mock_return,
) as mock_partition:
pdf.partition_pdf(filename=filename, url=None, strategy=PartitionStrategy.OCR_ONLY)
mock_partition.assert_called_once()
assert "pytesseract is not installed" in caplog.text
def test_partition_pdf_falls_back_to_ocr_only(
monkeypatch,
caplog,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
def mock_exists(dep):
return dep not in ["unstructured_inference"]
monkeypatch.setattr(strategies, "dependency_exists", mock_exists)
mock_return = [Text("Hello there!")]
with mock.patch.object(
pdf,
"_partition_pdf_or_image_with_ocr",
return_value=mock_return,
) as mock_partition:
pdf.partition_pdf(filename=filename, url=None, strategy=PartitionStrategy.HI_RES)
mock_partition.assert_called_once()
assert "unstructured_inference is not installed" in caplog.text
def test_partition_pdf_uses_table_extraction():
filename = example_doc_path("pdf/layout-parser-paper-fast.pdf")
with mock.patch(
"unstructured.partition.pdf_image.ocr.process_file_with_ocr",
) as mock_process_file_with_model:
pdf.partition_pdf(filename, infer_table_structure=True)
assert mock_process_file_with_model.call_args[1]["infer_table_structure"]
@pytest.mark.parametrize(
"ocr_mode",
[
"entire_page",
"individual_blocks",
],
)
def test_partition_pdf_hi_table_extraction_with_languages(ocr_mode):
filename = example_doc_path("pdf/korean-text-with-tables.pdf")
elements = pdf.partition_pdf(
filename=filename,
ocr_mode=ocr_mode,
languages=["kor"],
strategy=PartitionStrategy.HI_RES,
infer_table_structure=True,
)
table = [el.metadata.text_as_html for el in elements if el.metadata.text_as_html]
assert elements[0].metadata.languages == ["kor"]
assert len(table) == 2
assert "<table><thead><tr>" in table[0]
assert "</thead><tbody><tr>" in table[0]
# FIXME(yuming): didn't test full sentence here since unit test and docker test have
# some differences on spaces between characters
assert "업" in table[0]
@pytest.mark.parametrize(
"strategy",
[
PartitionStrategy.FAST,
PartitionStrategy.HI_RES,
PartitionStrategy.OCR_ONLY,
],
)
def test_partition_pdf_strategies_keep_languages_metadata(strategy):
filename = example_doc_path("pdf/korean-text-with-tables.pdf")
elements = pdf.partition_pdf(
filename=filename,
languages=["kor"],
strategy=strategy,
)
assert elements[0].metadata.languages == ["kor"]
@pytest.mark.parametrize(
"ocr_mode",
[
"entire_page",
"individual_blocks",
],
)
def test_partition_pdf_hi_res_ocr_mode_with_table_extraction(ocr_mode):
filename = example_doc_path("pdf/layout-parser-paper.pdf")
elements = pdf.partition_pdf(
filename=filename,
ocr_mode=ocr_mode,
strategy=PartitionStrategy.HI_RES,
infer_table_structure=True,
)
table = [el.metadata.text_as_html for el in elements if el.metadata.text_as_html]
assert len(table) == 2
assert "<table><thead><tr>" in table[0]
assert "</thead><tbody><tr>" in table[0]
assert "Layouts of history Japanese documents" in table[0]
assert "Layouts of scanned modern magazines and scientific report" in table[0]
assert "Layouts of scanned US newspapers from the 20th century" in table[0]
def test_partition_pdf_hi_res_ocr_mode_none():
filename = example_doc_path("pdf/layout-parser-paper.pdf")
elements = pdf.partition_pdf(
filename=filename,
ocr_mode="none",
strategy=PartitionStrategy.HI_RES,
# FIXME: table structure still requires OCR for no good reason
infer_table_structure=False,
)
fast_elements = pdf.partition_pdf(
filename=filename,
strategy=PartitionStrategy.FAST,
)
assert elements != fast_elements
def test_partition_pdf_with_copy_protection():
filename = example_doc_path("pdf/copy-protected.pdf")
elements = pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.HI_RES)
title = "LayoutParser: A Unified Toolkit for Deep Learning Based Document Image Analysis"
idx = 22
assert elements[idx].text == title
assert {element.metadata.page_number for element in elements} == {1, 2}
assert elements[idx].metadata.detection_class_prob is not None
assert isinstance(elements[idx].metadata.detection_class_prob, float)
def test_partition_pdf_with_dpi():
filename = example_doc_path("pdf/copy-protected.pdf")
with mock.patch.object(
layout, "process_file_with_model", return_value=MockDocumentLayout()
) as mock_process:
pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.HI_RES, pdf_image_dpi=100)
assert mock_process.call_args[1]["pdf_image_dpi"] == 100
def test_partition_pdf_requiring_recursive_text_grab(filename=example_doc_path("pdf/reliance.pdf")):
elements = pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.FAST)
assert len(elements) > 50
assert elements[0].metadata.page_number == 1
assert elements[-1].metadata.page_number == 3
def test_partition_pdf_text_not_extractable():
filename = example_doc_path("pdf/loremipsum-flat.pdf")
elements = pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.FAST)
assert len(elements) == 0
def test_partition_pdf_fails_if_pdf_not_processable(
monkeypatch,
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
def mock_exists(dep):
return dep not in ["unstructured_inference", "unstructured_pytesseract"]
monkeypatch.setattr(strategies, "dependency_exists", mock_exists)
monkeypatch.setattr(pdf, "extractable_elements", lambda *args, **kwargs: [])
with pytest.raises(ValueError):
pdf.partition_pdf(filename=filename)
def test_partition_pdf_fast_groups_text_in_text_box():
filename = example_doc_path("pdf/chevron-page.pdf")
elements = pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.FAST)
expected_coordinate_points_0 = (
(193.1741, 71.94000000000005),
(193.1741, 91.94000000000005),
(418.6881, 91.94000000000005),
(418.6881, 71.94000000000005),
)
expected_coordinate_system_0 = PixelSpace(width=612, height=792)
expected_elem_metadata_0 = ElementMetadata(
coordinates=CoordinatesMetadata(
points=expected_coordinate_points_0,
system=expected_coordinate_system_0,
),
)
assert elements[0] == Title(
"eastern mediterranean",
metadata=expected_elem_metadata_0,
)
assert isinstance(elements[1], NarrativeText)
assert str(elements[1]).startswith("We")
assert str(elements[1]).endswith("Jordan and Egypt.")
expected_coordinate_points_3 = (
(95.6683, 181.16470000000004),
(95.6683, 226.16470000000004),
(166.7908, 226.16470000000004),
(166.7908, 181.16470000000004),
)
expected_coordinate_system_3 = PixelSpace(width=612, height=792)
expected_elem_metadata_3 = ElementMetadata(
coordinates=CoordinatesMetadata(
points=expected_coordinate_points_3,
system=expected_coordinate_system_3,
),
)
assert elements[2] == Text("2.5", metadata=expected_elem_metadata_3)
def test_partition_pdf_with_metadata_filename(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
elements = pdf.partition_pdf(
filename=filename,
url=None,
include_page_breaks=True,
metadata_filename="test",
)
for element in elements:
assert element.metadata.filename == "test"
def test_partition_pdf_with_fast_strategy_from_file_with_metadata_filename(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
with open(filename, "rb") as f:
elements = pdf.partition_pdf(
file=f,
url=None,
strategy=PartitionStrategy.FAST,
metadata_filename="test",
)
for element in elements:
assert element.metadata.filename == "test"
@pytest.mark.parametrize("file_mode", ["filename", "rb", "spool"])
@pytest.mark.parametrize(
"strategy",
[
PartitionStrategy.AUTO,
PartitionStrategy.HI_RES,
PartitionStrategy.FAST,
PartitionStrategy.OCR_ONLY,
],
)
@pytest.mark.parametrize("metadata_last_modified", [None, "2020-07-05T09:24:28"])
def test_partition_pdf_metadata_date(
mocker: MockFixture,
file_mode: str,
strategy: str,
metadata_last_modified: str | None,
):
filename = example_doc_path("pdf/copy-protected.pdf")
filesystem_last_modified = "2029-07-05T09:24:28"
expected_last_modified = (
metadata_last_modified if metadata_last_modified else filesystem_last_modified
)
if not metadata_last_modified and file_mode != "filename":
expected_last_modified = None
mocker.patch(
"unstructured.partition.pdf.get_last_modified_date",
return_value=filesystem_last_modified,
)
if file_mode == "filename":
elements = pdf.partition_pdf(
filename=filename,
strategy=strategy,
metadata_last_modified=metadata_last_modified,
)
elif file_mode == "rb":
with open(filename, "rb") as f:
elements = pdf.partition_pdf(
file=f,
strategy=strategy,
metadata_last_modified=metadata_last_modified,
)
else:
with open(filename, "rb") as test_file:
with SpooledTemporaryFile() as spooled_temp_file:
spooled_temp_file.write(test_file.read())
spooled_temp_file.seek(0)
elements = pdf.partition_pdf(
file=spooled_temp_file,
strategy=strategy,
metadata_last_modified=metadata_last_modified,
)
assert {el.metadata.last_modified for el in elements} == {expected_last_modified}
@pytest.mark.parametrize("strategy", [PartitionStrategy.FAST, PartitionStrategy.HI_RES])
def test_partition_pdf_with_json(strategy: str):
elements = pdf.partition_pdf(
example_doc_path("pdf/layout-parser-paper-fast.pdf"),
strategy=strategy,
)
assert_round_trips_through_JSON(elements)
def test_add_chunking_strategy_by_title_on_partition_pdf(
filename=example_doc_path("pdf/layout-parser-paper-fast.pdf"),
):
elements = pdf.partition_pdf(filename=filename)
chunk_elements = pdf.partition_pdf(filename, chunking_strategy="by_title")
chunks = chunk_by_title(elements)
assert chunk_elements != elements
assert chunk_elements == chunks
def test_partition_pdf_formats_languages_for_tesseract():
filename = example_doc_path("pdf/DA-1p.pdf")
with mock.patch.object(ocr, "process_file_with_ocr", mock.MagicMock()) as mock_process:
pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.HI_RES, languages=["en"])
assert mock_process.call_args[1]["ocr_languages"] == "eng"
def test_partition_pdf_warns_with_ocr_languages(caplog):
filename = example_doc_path("pdf/chevron-page.pdf")
pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.HI_RES, ocr_languages="eng")
assert "The ocr_languages kwarg will be deprecated" in caplog.text
def test_partition_categorization_backup():
text = "This is Clearly a Title"
with mock.patch.object(pdf, "_partition_pdf_or_image_local", return_value=[Text(text)]):
elements = pdf.partition_pdf_or_image(
example_doc_path("pdf/layout-parser-paper-fast.pdf"),
strategy=PartitionStrategy.HI_RES,
)
# Should have changed the element class from Text to Title
assert isinstance(elements[0], Title)
assert elements[0].text == text
@pytest.mark.parametrize(
"filename",
[example_doc_path("pdf/layout-parser-paper-fast.pdf")],
)
def test_combine_numbered_list(filename):
elements = pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.AUTO)
first_list_element = None
for element in elements:
if isinstance(element, ListItem):
first_list_element = element
break
assert len(elements) < 28
assert len([element for element in elements if isinstance(element, ListItem)]) == 4
assert first_list_element.text.endswith(
"character recognition, and other DIA tasks (Section 3)",
)
@pytest.mark.parametrize(
("filename", "strategy"),
[
(example_doc_path("pdf/layout-parser-paper-fast.pdf"), "fast"),
(example_doc_path("pdf/layout-parser-paper-fast.pdf"), "hi_res"),
],
)
def test_partition_pdf_hyperlinks(filename, strategy):
elements = pdf.partition_pdf(filename=filename, strategy=strategy)
links = [
{
"text": "8",
"url": "cite.gardner2018allennlp",
"start_index": 138,
},
{
"text": "34",
"url": "cite.wolf2019huggingface",
"start_index": 141,
},
{
"text": "35",
"url": "cite.wu2019detectron2",
"start_index": 168,
},
]
assert elements[-1].metadata.links == links
@pytest.mark.parametrize(
("filename", "strategy"),
[
(example_doc_path("pdf/embedded-link.pdf"), "fast"),
(example_doc_path("pdf/embedded-link.pdf"), "hi_res"),
],
)
def test_partition_pdf_hyperlinks_multiple_lines(filename, strategy):
elements = pdf.partition_pdf(filename=filename, strategy=strategy)
assert elements[-1].metadata.links[-1]["text"] == "capturing"
assert len(elements[-1].metadata.links) == 2
def test_partition_pdf_uses_model_name():
with mock.patch.object(
pdf,
"_partition_pdf_or_image_local",
) as mockpartition:
pdf.partition_pdf(
example_doc_path("pdf/layout-parser-paper-fast.pdf"),
model_name="test",
strategy=PartitionStrategy.HI_RES,
)
mockpartition.assert_called_once()
assert "model_name" in mockpartition.call_args.kwargs
assert mockpartition.call_args.kwargs["model_name"]
def test_partition_pdf_uses_hi_res_model_name():
with mock.patch.object(
pdf,
"_partition_pdf_or_image_local",
) as mockpartition:
pdf.partition_pdf(
example_doc_path("pdf/layout-parser-paper-fast.pdf"),
hi_res_model_name="test",
strategy=PartitionStrategy.HI_RES,
)
mockpartition.assert_called_once()
assert "hi_res_model_name" in mockpartition.call_args.kwargs
assert mockpartition.call_args.kwargs["hi_res_model_name"]
def test_partition_pdf_word_bbox_not_char(
filename=example_doc_path("pdf/interface-config-guide-p93.pdf"),
):
try:
elements = pdf.partition_pdf(filename=filename, strategy="fast")
except Exception as e:
raise ("Partitioning fail: %s" % e)
assert len(elements) == 17
def test_partition_pdf_fast_no_mapping_errors(
filename=example_doc_path("pdf/a1977-backus-p21.pdf"),
):
"""Verify there is no regression for https://github.com/Unstructured-IO/unstructured/pull/2940,
failing to map old parent_id's to new"""
pdf.partition_pdf(filename=filename, strategy="fast")
def test_partition_pdf_raises_TypeError_for_invalid_languages():
filename = example_doc_path("pdf/chevron-page.pdf")
with pytest.raises(TypeError):
pdf.partition_pdf(filename=filename, strategy=PartitionStrategy.HI_RES, languages="eng")
@pytest.mark.parametrize(
("threshold", "expected"),
[
(0.4, [True, False, False, False, False]),
(0.1, [True, True, False, False, False]),
],
)
def test_check_annotations_within_element(threshold, expected):
annotations = [
{"bbox": [0, 0, 1, 1], "page_number": 1},
{"bbox": [0, 0, 3, 1], "page_number": 1},
{"bbox": [0, 0, 1, 1], "page_number": 2},
{"bbox": [0, 0, 0, 1], "page_number": 1},
{"bbox": [3, 0, 4, 1], "page_number": 1},
]
element_bbox = (0, 0, 1, 1)
filtered = pdf.check_annotations_within_element(annotations, element_bbox, 1, threshold)
results = [annotation in filtered for annotation in annotations]
assert results == expected
@pytest.mark.parametrize(
("env", "expected"),
[
(None, "yolox"),
("test", "test"),
],
)
def test_default_hi_res_model(env, expected, monkeypatch):
if env is not None:
monkeypatch.setenv("UNSTRUCTURED_HI_RES_MODEL_NAME", env)
assert pdf.default_hi_res_model() == expected
def test_partition_model_name_default_to_None():
filename = example_doc_path("pdf/DA-1p.pdf")
try:
pdf.partition_pdf(
filename=filename,
strategy=PartitionStrategy.HI_RES,