pdf_processor¶
pdf_processor
¶
PDF processing engine for translating text-based and scanned PDF files.
Uses PyMuPDF's extract-overlay approach: extract text blocks with style metadata, translate via LLM, redact originals, and overlay translated text at the same positions. Scanned pages are handled via the existing OCR pipeline when the embedded image translation setting is enabled.
_should_translate_pdf_comments
¶
Checks whether PDF sticky-note comment translation is enabled.
Gated by SETTING_TRANSLATE_DOC_COMMENTS — the same toggle used for
Office comments.
| PARAMETER | DESCRIPTION |
|---|---|
config
|
Optional TranslationConfig snapshot; falls back to
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True if sticky-note translation should proceed. |
Source code in src/core/pdf_processor.py
_should_translate_pdf_textboxes
¶
Checks whether PDF FreeText annotation and form widget translation is enabled.
Gated by SETTING_TRANSLATE_DOC_SHAPES — the same toggle used for
Office shapes/text boxes.
| PARAMETER | DESCRIPTION |
|---|---|
config
|
Optional TranslationConfig snapshot; falls back to
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True if FreeText and widget translation should proceed. |
Source code in src/core/pdf_processor.py
_extract_page_comments
¶
Extracts sticky-note (Text) annotations from a PDF page.
Iterates over page.annots(), filtering to type 0 (sticky notes).
Whitespace-only content is skipped.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
List of annotation dicts with keys: type ("annot"), annot_type, |
list[dict[str, Any]]
|
annot_id, text. |
Source code in src/core/pdf_processor.py
_extract_page_freetext
¶
Extracts FreeText (visible text box) annotations from a PDF page.
Iterates over page.annots(), filtering to type 2 (FreeText).
Whitespace-only content is skipped.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
List of annotation dicts with keys: type ("annot"), annot_type, |
list[dict[str, Any]]
|
annot_id, text, rect. |
Source code in src/core/pdf_processor.py
_inject_page_annotations
¶
Injects translated text back into PDF annotations on a page.
Builds a lookup from annotation ID to translated text, then iterates
page.annots() and updates matching annotations via set_info
and update().
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
annot_entries
|
List of annotation dicts containing
TYPE:
|
Source code in src/core/pdf_processor.py
_translate_bookmarks
¶
_translate_bookmarks(
doc,
target_lang,
src_lang,
glossary_entries,
cancel_check,
*,
provider=None,
model=None,
)
Translates the document outline (bookmarks / table of contents).
Extracts all TOC entries via doc.get_toc(), translates their
titles in a single batch, and writes the updated TOC back via
doc.set_toc(). Structure (level, page, destination) is
preserved.
| PARAMETER | DESCRIPTION |
|---|---|
doc
|
An open PyMuPDF Document.
TYPE:
|
target_lang
|
Target language name.
TYPE:
|
src_lang
|
Source language name, or empty for auto-detect.
TYPE:
|
glossary_entries
|
Optional glossary entries for translation.
TYPE:
|
cancel_check
|
Returns True if the task was cancelled.
TYPE:
|
provider
|
Optional LLM provider override.
TYPE:
|
model
|
Optional LLM model override.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True on success, False on cancellation. |
Source code in src/core/pdf_processor.py
_is_fatal_llm_error
¶
Returns True when error_tag is in _FATAL_LLM_ERRORS.
Delegates to :func:src.constants.errors.base_error_tag to strip
the optional :Service suffix the engine appends to AUTH_ERROR
so "AUTH_ERROR:Gemini" matches as fatal alongside the bare
"AUTH_ERROR".
Source code in src/core/pdf_processor.py
_extract_page_widgets
¶
Extracts translatable form field values from a PDF page.
Handles text fields, combo boxes, and list boxes. Whitespace-only values are skipped.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
List of widget dicts with keys: type ("widget"), widget_type, |
list[dict[str, Any]]
|
field_name, text, and choice_index (combo/list only). |
Source code in src/core/pdf_processor.py
_inject_page_widgets
¶
Injects translated text back into form fields on a PDF page.
Builds a lookup from (field_name, widget_type) to translated values,
then iterates page.widgets() and updates matching fields.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
widget_entries
|
List of widget dicts with
TYPE:
|
Source code in src/core/pdf_processor.py
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 | |
_translate_page_images
¶
_translate_page_images(
doc,
page,
target_lang,
src_lang,
glossary_entries,
ocr_method,
cancel_check,
translated_xrefs,
*,
provider=None,
model=None,
)
Translates embedded raster images within a text-based PDF page.
Extracts each image by xref, runs OCR → LLM translation → render,
and replaces the original image via page.replace_image().
Skips tiny images (icons/bullets) and full-page images (handled by
the scanned-page pipeline).
| PARAMETER | DESCRIPTION |
|---|---|
doc
|
An open PyMuPDF Document.
TYPE:
|
page
|
A PyMuPDF Page object (text page with embedded images).
TYPE:
|
target_lang
|
Target language name.
TYPE:
|
src_lang
|
Source language name.
TYPE:
|
glossary_entries
|
Optional glossary entries.
TYPE:
|
ocr_method
|
OCR method name.
TYPE:
|
cancel_check
|
Returns True if the task was cancelled.
TYPE:
|
translated_xrefs
|
Set of already-translated image xrefs (mutated in-place to track progress across pages).
TYPE:
|
provider
|
Optional LLM provider override.
TYPE:
|
model
|
Optional LLM model override.
TYPE:
|
Source code in src/core/pdf_processor.py
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 | |
_translate_single_pdf_image
¶
_translate_single_pdf_image(
image_bytes,
ext,
target_lang,
src_lang,
glossary_entries,
ocr_method,
*,
provider=None,
model=None,
)
Translates a single embedded PDF image using the OCR pipeline.
Writes the image to a temp file, processes OCR → LLM → render, and returns the translated image bytes. Returns None if the image has no translatable text.
| PARAMETER | DESCRIPTION |
|---|---|
image_bytes
|
Raw image data.
TYPE:
|
ext
|
File extension including dot (e.g. ".png").
TYPE:
|
target_lang
|
Target language name.
TYPE:
|
src_lang
|
Source language name.
TYPE:
|
glossary_entries
|
Optional glossary entries.
TYPE:
|
ocr_method
|
OCR method name.
TYPE:
|
provider
|
Optional LLM provider override.
TYPE:
|
model
|
Optional LLM model override.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bytes | None
|
Translated image bytes, or None. |
Source code in src/core/pdf_processor.py
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 | |
process_pdf_file
¶
process_pdf_file(
file_path,
output_path,
target_lang,
src_lang="",
progress_callback=None,
glossary_entries=None,
cancel_check=None,
checkpoint_dir=None,
config=None,
*,
provider=None,
model=None,
)
Translates a PDF file and writes the result to output_path.
For text-based pages: extracts text blocks, translates via LLM, redacts originals, and overlays translated text. For scanned pages (no embedded text): falls back to OCR pipeline when the translate-document-images setting is enabled.
| PARAMETER | DESCRIPTION |
|---|---|
file_path
|
Path to the source PDF.
TYPE:
|
output_path
|
Path to write the translated PDF.
TYPE:
|
target_lang
|
Target language name.
TYPE:
|
src_lang
|
Source language name, or empty for auto-detect.
TYPE:
|
progress_callback
|
Called with 0-100 progress percentage.
TYPE:
|
glossary_entries
|
Optional glossary entries for translation.
TYPE:
|
cancel_check
|
Returns True if the task was cancelled.
TYPE:
|
checkpoint_dir
|
Directory for saving/loading checkpoints.
TYPE:
|
config
|
Optional TranslationConfig for dependency injection.
TYPE:
|
provider
|
Optional LLM provider override.
TYPE:
|
model
|
Optional LLM model override.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True on success, False on cancellation. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
With error tag on import/open/save failures. |
Source code in src/core/pdf_processor.py
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 | |
_get_form_xobject_rects
¶
Compute page-level bounding boxes of Form XObjects that render text.
Some PDFs embed diagrams as Form XObjects that render text as both
text operators and path/outline commands. apply_redactions()
removes the text operators but the path-based rendering survives
(when graphics=PDF_REDACT_LINE_ART_NONE), leaving original text
visually present. Blocks inside these regions must be skipped so
translated text is not overlaid on irremovable originals.
The function:
- Identifies Form XObjects (type 0) whose stream contains text
drawing operators (
Tj/TJ). - Parses the page content stream to track the Current Transformation
Matrix (CTM) and locates
/Name Docommands. - Transforms each XObject's internal
BBoxto page coordinates.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[Any]
|
List of |
list[Any]
|
top-left). Empty if no text-bearing Form XObjects are found. |
Source code in src/core/pdf_processor.py
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 | |
_block_inside_any_xobject
¶
Check if a block is completely inside any Form XObject region.
| PARAMETER | DESCRIPTION |
|---|---|
block_rect
|
[x0, y0, x1, y1] of the text block.
TYPE:
|
xobject_rects
|
List of
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True if the block is fully contained in an XObject region. |
Source code in src/core/pdf_processor.py
_get_image_rects
¶
Collect bounding boxes of image blocks from the page text dict.
Image blocks have type == 1 in PyMuPDF's get_text("dict")
output.
| PARAMETER | DESCRIPTION |
|---|---|
page_dict
|
Result of
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[tuple[float, ...]]
|
List of |
Source code in src/core/pdf_processor.py
_block_overlaps_image
¶
Check if a text block is mostly inside any raster image.
Returns True when the intersection area between the block and any
image exceeds _IMAGE_OVERLAP_THRESHOLD of the block's area.
Such blocks are almost certainly invisible OCR text layers placed
on top of raster images for searchability. Since redaction cannot
remove text baked into image pixels, translating these blocks would
overlay translated text on top of still-visible originals.
| PARAMETER | DESCRIPTION |
|---|---|
block_rect
|
TYPE:
|
image_rects
|
Image bounding boxes from
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True if the block should be skipped to avoid overlap. |
Source code in src/core/pdf_processor.py
_get_freetext_annot_rects
¶
Collect bounding rects of FreeText annotations on the page.
FreeText annotations (type 2) render their text directly on the
page. get_text("dict") includes this text as ordinary text
blocks. Redacting those blocks destroys the annotation, so they
must be identified and skipped during text block extraction.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[Any]
|
List of |
list[Any]
|
empty if none exist. |
Source code in src/core/pdf_processor.py
_block_inside_freetext
¶
Check if a text block's center falls inside any FreeText annotation.
Uses center-point containment because the rendered text bbox from
get_text("dict") often extends slightly beyond the annotation
rect (e.g. font descenders), so strict contains() would miss it.
| PARAMETER | DESCRIPTION |
|---|---|
block_rect
|
TYPE:
|
freetext_rects
|
Rects from
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True if the block is rendered by a FreeText annotation. |
Source code in src/core/pdf_processor.py
_span_in_any_table
¶
Check if a span's center falls within any table bounding box.
Source code in src/core/pdf_processor.py
_is_vertical_block
¶
Returns True if all lines in the block are non-horizontal.
Horizontal text has dir close to (1, 0). Vertical or
rotated text (e.g. arXiv identifiers, watermarks) has a different
direction vector and cannot be faithfully redacted + re-overlaid
via insert_htmlbox.
| PARAMETER | DESCRIPTION |
|---|---|
lines
|
List of line dicts from
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True if every line has a non-horizontal direction. |
Source code in src/core/pdf_processor.py
_is_math_font
¶
_has_complex_math_layout
¶
Return True if spans form a complex 2D math arrangement.
Counts the number of distinct y-levels (baselines) occupied by
math-font spans. Inline math — footnote markers (†/‡), small
formulas like O(n²), isolated symbols (∼) — sits on 1–2
y-levels. Complex 2D layouts — fractions, stacked operators,
algorithm pseudocode — span many more.
Returns True when the math y-level count reaches
_COMPLEX_MATH_YLEVELS (default 3). Works on any collection
of spans (table cells, blocks, arbitrary regions).
Source code in src/core/pdf_processor.py
_is_pure_math_line
¶
Return True if every text-bearing span in the line uses a math font.
Separator spans (from same-y / subscript merges) and math-placeholder spans are ignored. Returns False when the line has no text spans.
Source code in src/core/pdf_processor.py
_split_at_display_gaps
¶
Split a PyMuPDF text block at large vertical gaps between lines.
Display equations often appear within the same PyMuPDF block as the
preceding body text, separated by a gap much larger than normal line
spacing. This function detects such gaps and returns a list of
synthetic sub-blocks, each with its own lines list and a
recomputed bbox.
A gap is "large" when it exceeds _DISPLAY_GAP_FACTOR × the dominant font size of the preceding line group.
If no large gaps are found, the original block is returned as-is (wrapped in a single-element list) to avoid unnecessary copies.
Source code in src/core/pdf_processor.py
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 | |
_merge_continuation_lines
¶
Transfer continuation lines from adjacent blocks.
PyMuPDF sometimes places the tail of a visual line (e.g. a
radicand 2/δ after a radical √) into a separate raw block.
When this happens the pure-math line is later misclassified as a
display equation and dropped, orphaning the math content.
This function detects such splits by checking whether the first
line of block N+1 is on the same visual line (within
_LINE_Y_TOLERANCE) as the last line of block N and is
x-adjacent (gap < _ADJACENT_BLOCK_MAX_GAP). Matching lines
are transferred to block N so the same-y merge inside
_extract_page_blocks can reunite the spans.
Source code in src/core/pdf_processor.py
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 | |
_cm_design_size
¶
Extract the numeric design size from a CM font name.
Returns 10 (body-text default) when no trailing digits are found.
Source code in src/core/pdf_processor.py
_remap_cm_char
¶
Remap a raw-extracted character to its correct Unicode glyph.
TeX CM fonts use non-standard encodings. When a PDF lacks a ToUnicode CMap, PyMuPDF outputs the raw character code as ASCII. This function converts those mis-mapped characters to correct Unicode using the CMEX / CMSY / MSBM encoding tables.
If the font is not a recognized math font, or the character is not in the map (e.g. already correctly mapped via a ToUnicode CMap), the character is returned unchanged.
The Unicode replacement character (U+FFFD) is suppressed: it represents an undecoded glyph (e.g. CMEX delimiter extensions) that would render as a garbled box in the overlay.
Source code in src/core/pdf_processor.py
_skip_middle
¶
Return index after consecutive chars matching middle_set.
Source code in src/core/pdf_processor.py
_try_compose
¶
Try prefix + middles + suffix pattern, return (char, end_index).
with_middle is used when middle chars are present; without_middle is used when no middle chars exist (prefix + suffix). If without_middle is empty the match requires at least one middle.
Source code in src/core/pdf_processor.py
_collapse_tex_composed
¶
Collapse TeX-composed multi-glyph sequences to single Unicode chars.
TeX renders certain symbols (long arrows, mapsto variants) as overlapping glyphs from different CM fonts. After per-character remapping, these appear as two or three Unicode characters that should be a single symbol.
Each entry is (char, font, role) where role is "sup",
"sub", or None. The role of the first glyph in a
collapsed group is preserved.
Supported collapses:
↦ (+ dashes) + →→↦(mapsto) or⟼(longmapsto)dashes + →→⟶(longrightarrow)← + dashes→⟵(longleftarrow)← + dashes + →→⟷(longleftrightarrow)= + ⇒→⟹(Longrightarrow)⇐ + =→⟸(Longleftarrow)⇐ + = + ⇒→⟺(Longleftrightarrow)
Source code in src/core/pdf_processor.py
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 | |
_capture_glyph_image
¶
Render a small glyph region as an inline <img> tag.
Captures the page region at 2× resolution for crisp rendering,
then returns an HTML <img> tag with base64-encoded PNG data
sized to the original glyph's point dimensions.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
PyMuPDF Page object.
TYPE:
|
bbox
|
(x0, y0, x1, y1) bounding box in points.
TYPE:
|
pymupdf
|
The pymupdf module reference.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
HTML |
Source code in src/core/pdf_processor.py
_merge_math_spans
¶
_merge_math_spans(
span_texts,
line_span_items,
math_map,
ph_counter,
page=None,
pymupdf=None,
line_dom_size=0,
line_y0=0,
line_y1=0,
)
Merge consecutive math-font spans into placeholders.
Walks span_texts / line_span_items (parallel, 1:1) and groups
consecutive math-font spans into a single placeholder token
⟪N⟫. The mapping placeholder → char_font_list is added to
math_map, where each value is a list of (char, font_name, role)
tuples preserving per-character font identity and super/subscript
role ("sup", "sub", or None).
When page and pymupdf are provided, undecoded glyphs
(U+FFFD) from CM fonts are captured as inline images
instead of being suppressed.
| RETURNS | DESCRIPTION |
|---|---|
tuple[list[str], list[dict[str, Any]], int]
|
(merged_texts, merged_items, updated_counter) |
Source code in src/core/pdf_processor.py
2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 | |
_reclassify_merged_math_roles
¶
_reclassify_merged_math_roles(
line_spans_data, math_map, line_y_positions, line_y_ends, line_font_sizes
)
Re-evaluate unclassified math roles after same-y merging.
_merge_math_spans runs per raw line before same-y merging.
A math span that was alone on its line (e.g. a fraction numerator
"1") has span_mid == line_mid, so the size-based classifier
leaves role=None. The fallback in _restore_math_placeholders
then blindly picks "sub", which is wrong for numerators.
After same-y / subscript-fragment merging, the math span now shares
a line with body text, providing a proper dominant size and midpoint.
This function finds such unclassified math placeholders and assigns
the correct role ("sup" or "sub") using the merged line
geometry.
Source code in src/core/pdf_processor.py
_absorb_math_sub_labels
¶
Absorb body-font subscript labels following math placeholders.
TeX renders subscript labels (e.g. schematic in R²_schematic)
in the body/text font at subscript size. After same-y and
fragment merges, these labels sit right after the math placeholder
in the span list. This function detects them and absorbs their
characters into the placeholder's char_fonts, then removes the
absorbed spans so the LLM does not translate variable-name
fragments.
Modifies line_spans_data, line_texts, and math_map in place.
Source code in src/core/pdf_processor.py
2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 | |
_restore_math_placeholders
¶
Replace ⟪N⟫ placeholders with Unicode text.
Each placeholder maps to a list of (char, font_name, role)
tuples. role is "sup", "sub", or None (determined
from span y-position during extraction). When role is None,
the function falls back to the CM design-size heuristic (smaller
design size → subscript).
Characters from italic math fonts (CMMI*) are wrapped in <i>
tags. This avoids re-embedding CM subset fonts (which share a
common PostScript family name and break in external PDF viewers).
Source code in src/core/pdf_processor.py
2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 | |
_wrap_math_chars
¶
Wrap math characters in appropriate HTML tags.
| PARAMETER | DESCRIPTION |
|---|---|
chars
|
The concatenated characters.
TYPE:
|
key
|
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
HTML string with |
Source code in src/core/pdf_processor.py
_body_len
¶
Non-math (body) text length of a block.
Returns the length of text remaining after removing all math placeholders and surrounding whitespace. A block whose body is only whitespace and placeholders returns 0.
Source code in src/core/pdf_processor.py
_is_display_equation
¶
Return True if b is a display equation with body-font labels.
TeX display equations like R²_schematic = max(R²_linear, R²_poly)
use body fonts for subscript labels ("schematic", "linear") so
_body_len > 0. They are distinguished from real body text by
being narrow (< 50 % page width) and centred on the page.
Body text paragraphs start at the left margin and are not centred.
Source code in src/core/pdf_processor.py
_coalesce_line_extents
¶
Merge line-extent fragments from two blocks into full lines.
Fragments on the same y-row (same printed line) are coalesced
so _detect_block_alignment sees complete line widths instead
of partial sub-block fragments.
Returns (extents, sizes, y_mids) ready to store on the merged block.
Source code in src/core/pdf_processor.py
_merge_two_math_blocks
¶
Merge two overlapping blocks into one, renumbering placeholders.
When blocks are on separate visual lines, the higher block (smaller y0) provides text first. When blocks share the same visual line (significant vertical overlap), the leftmost block (smaller x0) provides text first — this preserves left-to-right reading order for inline formula fragments split across blocks by PyMuPDF.
Placeholders in the second block are renumbered so indices don't collide with the first block's placeholders.
Font properties are taken from the block with more body text.
Source code in src/core/pdf_processor.py
2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 | |
_is_split_paragraph
¶
Return True when a and b are halves of a split paragraph.
PyMuPDF sometimes splits a paragraph into two blocks when math-font subscripts/superscripts create overlapping bboxes. The halves are detected by four criteria:
- Spatial proximity: block B's top is near block A's bottom (within one line height), and their x-ranges overlap significantly (same column, not a two-column false match).
- Font size similarity: both blocks share the same dominant font size (within 20%), since split halves come from the same paragraph.
- Mid-sentence end: block A does not end with
.!?. - Lowercase continuation: block B starts with a lowercase letter.
Math placeholders are stripped before text checks.
Source code in src/core/pdf_processor.py
_merge_overlapping_math_blocks
¶
Merge blocks that overlap vertically when at least one has math.
When two blocks overlap vertically and at least one carries
_math_map, overlaid translations collide visually. Instead of
dropping one, both are merged into a single block so all body text
is preserved and only one overlay rectangle is rendered.
Blocks with small overlaps (below _MATH_MERGE_MIN_OVERLAP) are
also merged when text-continuity analysis shows they are halves of
the same paragraph that PyMuPDF split due to math subscripts.
Placeholders in the absorbed block are renumbered to avoid collisions with the primary block's placeholder indices.
Source code in src/core/pdf_processor.py
2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 | |
_cell_short_line_ratio
¶
Compute a dynamic short-line threshold for a table cell.
Narrow cells (few characters per line) need a low threshold because word wrapping can leave large gaps. Wide cells behave like paragraphs — wrapped lines fill most of the width.
Formula: 1.0 − k × font_size / cell_w, where k approximates
the gap left by an average word at the end of a wrapped line.
Result is clamped to [_CELL_SHORT_LINE_MIN, _CELL_SHORT_LINE_MAX].
Source code in src/core/pdf_processor.py
_upgrade_list_joins
¶
_upgrade_list_joins(
line_texts,
joins,
line_extents=None,
line_font_sizes=None,
line_font_styles=None,
)
Upgrade space→newline when the next line starts with a list marker.
Detects numbered lists (1., (1), [1]), lettered lists
(a), (a)), bullet characters, and dash prefixes. Only
promotes existing space joins — never demotes newlines.
After upgrading list marker boundaries, also demotes joins
between a marker line and its non-marker continuation back to
space. This fixes false paragraph breaks from indent-shift
detection in _detect_line_joins that misidentify hanging-
indent continuations as new paragraphs. The demote is guarded
by three checks:
- (a) Font size — sizes differ by more than
_LIST_DEMOTE_SIZE_TOL→ heading at a different scale. - (b) Short marker — the marker line is shorter than
_SHORT_LINE_RATIOof the block width → text ended naturally rather than being forced to wrap. - (c) Font style + full-width continuation — the marker and continuation differ in bold or italic AND the continuation is full-width → a styled heading followed by a body paragraph.
Finally, when line_extents is provided, detects dedent after list continuation lines: if a non-marker line is followed by a line that shifts significantly to the left, the join is upgraded to newline. This catches the transition from a list item's continuation body back to regular body text.
| PARAMETER | DESCRIPTION |
|---|---|
line_texts
|
Text content of each line.
TYPE:
|
joins
|
Mutable list of join characters to update in-place.
TYPE:
|
line_extents
|
Optional
TYPE:
|
line_font_sizes
|
Optional dominant font size per line for heading detection in Pass 2.
TYPE:
|
line_font_styles
|
Optional
TYPE:
|
Source code in src/core/pdf_processor.py
2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 | |
_get_first_content_flags
¶
Return the flags of the first non-math, non-whitespace span.
Source code in src/core/pdf_processor.py
_upgrade_emphasis_start_joins
¶
Promote space→newline when a repeating emphasis-start pattern is found.
Academic and technical PDFs often use a definition-list pattern
where each paragraph opens with a bold or italic term (e.g.
**Hyperparameters.** We use ... or *Term:* Description)
followed by plain body text. When vertical spacing between such
paragraphs is tight, _detect_line_joins incorrectly marks them
as line wraps.
Two guards prevent false positives on inline emphasis (e.g. "uniquely to the overall"):
- The current paragraph must also start with the same emphasis type — this captures the repeating structural pattern of definition lists while rejecting isolated mid-sentence emphasis.
- The emphasized text at line i+1 must end with definition-list
punctuation (
. : ; ) ! ]). Real terms always have a separator before the body text; plain words like "uniquely" do not.
Each emphasis type (bold, italic) is checked independently.
Note: PDF underline is a drawn rule, not a font flag, so it cannot be detected from span metadata.
| PARAMETER | DESCRIPTION |
|---|---|
line_spans_data
|
Per-line span data (list of span dicts with
TYPE:
|
joins
|
Mutable list of join characters to update in-place.
TYPE:
|
Source code in src/core/pdf_processor.py
3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 | |
_compute_para_indents
¶
Compute block-level and first-line indent for each paragraph.
Three indent patterns are detected:
- Block indent (
padding-left) — all lines of the paragraph are shifted inward from the block margin. Detected by looking at the body lines (lines after the first) of multi-line paragraphs. - First-line indent (positive
text-indent) — the first line is shifted further inward than the body. - Hanging indent (negative
text-indent) — the first line (e.g. a list marker) starts further left than the body. Common in numbered/bulleted lists where the marker and content form two visual columns.
| PARAMETER | DESCRIPTION |
|---|---|
line_extents
|
TYPE:
|
line_sizes
|
Dominant font size per line.
TYPE:
|
joins
|
Join characters between consecutive lines.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[tuple[float, float]]
|
List of |
list[tuple[float, float]]
|
one per paragraph. |
list[tuple[float, float]]
|
hanging indents. Empty list when no indentation is detected. |
Source code in src/core/pdf_processor.py
3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 | |
_detect_line_joins
¶
_detect_line_joins(
y_positions,
line_sizes,
line_extents=None,
line_texts=None,
line_y_ends=None,
)
Decides whether consecutive lines should be joined by space or newline.
Uses font size as the reference for expected line spacing rather
than comparing gaps to each other (median). Typical leading is
~1.2× font size; gaps within _LEADING_TOLERANCE × that value are
treated as line wraps (joined with space). Larger gaps or
significant font-size changes between adjacent lines indicate a
paragraph / section break (joined with newline).
When line_extents is supplied, two layout-based upgrades can promote a space join to a newline:
- Short line (justified text only) — line i is significantly narrower than the block width → it is the last line of a paragraph. Width-based so it works for both LTR and RTL.
- Indent — line i + 1 is shifted inward from the reading-start margin while line i sits at the margin. Supports both LTR (left-margin indent) and RTL (right-margin indent).
| PARAMETER | DESCRIPTION |
|---|---|
y_positions
|
Y-coordinates of each line (from
TYPE:
|
line_sizes
|
Dominant font size per line (same length as y_positions).
TYPE:
|
line_extents
|
Optional
TYPE:
|
line_texts
|
Optional text content per line for sentence-ending detection (upgrades space→newline when a line ends with sentence-terminating punctuation and doesn't fill the block).
TYPE:
|
line_y_ends
|
Optional bottom y-coordinates per line. When provided, the gap is measured from the bottom of line i to the top of line i + 1 instead of top-to-top. This prevents tall merged lines (e.g. math subscripts expanding a line's bbox) from inflating the gap and causing false paragraph breaks.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[str]
|
List of join characters ( |
list[str]
|
|
Source code in src/core/pdf_processor.py
3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 | |
_fix_url_line_joins
¶
Convert space joins to empty joins when a line ends mid-URL.
When a URL wraps across PDF lines, _detect_line_joins inserts a
space between the two fragments. This function detects the pattern
(:// present and URL extends to end of line) and removes the
space so the URL stays intact.
Modifies joins in place.
Source code in src/core/pdf_processor.py
_join_lines
¶
Joins line texts using the join characters from _detect_line_joins.
| PARAMETER | DESCRIPTION |
|---|---|
lines
|
Text content of each line.
TYPE:
|
joins
|
Join characters between consecutive lines.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
Combined text string. |
Source code in src/core/pdf_processor.py
_resolve_vertical_alignment
¶
Resolves rotation and insertion point for grouped vertical blocks.
PyMuPDF reports dir=(0, -1) for ALL vertical text regardless of
visual orientation. This function groups vertical blocks by y-overlap,
then determines the actual growth direction by comparing the variance
of bbox_y0 (top), bbox_y1 (bottom), and mid_y (center):
- Smallest variance on bbox_y1 → bottom-aligned →
rotate=90(text grows upward from the shared bottom edge). - Smallest variance on bbox_y0 → top-aligned →
rotate=270(text grows downward from the shared top edge). - Smallest variance on mid_y → center-aligned →
rotate=90(text grows upward, insertion point adjusted to center).
Each vertical block in a resolved group receives _vert_align
("bottom", "top", or "center") and _vert_align_y
(the shared edge coordinate). The overlay function uses these to
compute the correct insertion point based on text length.
Rows with _MIN_AXIS_LABEL_COUNT or more blocks are treated as
figure-axis label grids (e.g. attention visualisation tokens) and
are removed — translating single-word labels without sentence
context produces meaningless results.
| PARAMETER | DESCRIPTION |
|---|---|
blocks
|
List of block dicts (some may have
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
Filtered list with alignment metadata set on grouped vertical |
list[dict[str, Any]]
|
blocks and axis-label rows removed. |
Source code in src/core/pdf_processor.py
3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 | |
_extract_page_blocks
¶
Extracts text blocks with style metadata from a PDF page.
Detects tables via find_tables() and splits them into per-cell
blocks so each cell is translated independently. Regular (non-table)
text blocks are extracted as before. For blocks that partially
overlap a table, spans inside the table region are filtered out so
that only non-table text remains (e.g. captions below a table).
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
List of block dicts with keys: rect, text, font_size, font_name, |
list[dict[str, Any]]
|
color, bold, italic. Table cells additionally carry text_align |
list[dict[str, Any]]
|
and is_table_cell. Whitespace-only blocks are skipped. |
Source code in src/core/pdf_processor.py
3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 | |
_most_common
¶
Returns the most common value in a list, or default if empty.
Source code in src/core/pdf_processor.py
_find_overlap_index
¶
Return the index of the first significantly overlapping table.
Returns the index when the intersection area exceeds
_DEDUP_OVERLAP_THRESHOLD of either the candidate or existing
table bbox (whichever is smaller).
| PARAMETER | DESCRIPTION |
|---|---|
bbox
|
(x0, y0, x1, y1) of the candidate table.
TYPE:
|
existing
|
List of already-accepted table dicts with 'bbox' key.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int | None
|
Index into existing, or |
Source code in src/core/pdf_processor.py
_bbox_overlaps_any
¶
Check if a bbox overlaps significantly with any existing table.
Returns True when the intersection area exceeds
_DEDUP_OVERLAP_THRESHOLD of either the new bbox or any existing
table bbox (whichever is smaller). This prevents both a large table
from swallowing a smaller one and vice-versa.
| PARAMETER | DESCRIPTION |
|---|---|
bbox
|
(x0, y0, x1, y1) of the candidate table.
TYPE:
|
existing
|
List of already-accepted table dicts with 'bbox' key.
TYPE:
|
Source code in src/core/pdf_processor.py
_table_text_density
¶
Fraction of table cells that contain at least one text span.
Used to filter false-positive tables from figure grid lines where hundreds of cells exist but almost none contain text.
Source code in src/core/pdf_processor.py
_find_page_tables
¶
Detect tables on a page.
Runs all detectors and combines their results. Later detectors only add tables whose bounding box does not overlap a region already found by an earlier (higher-confidence) detector.
Tables with many cells but very low text density (< 15%) are discarded as false positives from figure grid lines.
Detector priority (highest confidence first):
1. PyMuPDF find_tables() — full-grid tables.
2. _detect_ruled_tables() — booktabs-style (horizontal rules only).
3. _detect_vline_tables() — vertical column separators only.
4. _detect_framed_tables() — outer-border rectangle with tabular
content verification.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
page_dict
|
Optional pre-computed
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
List of dicts with 'bbox' (4-tuple) and 'cells' (list of 4-tuples). |
list[dict[str, Any]]
|
Empty list if no tables are found or on error. |
Source code in src/core/pdf_processor.py
4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 | |
_merge_visual_and_inferred
¶
Merge visual borders (from find_tables) with inferred sub-columns.
Visual borders from drawn lines are geometrically exact and are kept
as anchors. Inferred dividers from text-gap analysis are added only
when they fall inside a visual column and create sub-columns that
are at least _MIN_SUBCOL_WIDTH wide.
| PARAMETER | DESCRIPTION |
|---|---|
visual_table
|
Table dict from
TYPE:
|
ruled_table
|
Table dict from
TYPE:
|
page_dict
|
Result of
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
dict[str, Any]
|
A new table dict with merged column dividers and rebuilt cells. |
Source code in src/core/pdf_processor.py
4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 | |
_find_horizontal_rules
¶
Find wide horizontal lines drawn on a page.
Scans all vector drawings for line items that are horizontal
(Δy < 1pt) and wider than _MIN_RULE_WIDTH.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
drawings
|
Optional pre-computed
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, float]]
|
List of dicts with keys 'y', 'x0', 'x1'. |
Source code in src/core/pdf_processor.py
_group_rules_by_xrange
¶
Group horizontal lines that share the same x-range.
Two lines are considered part of the same group when their left and
right endpoints are both within _RULE_XRANGE_TOLERANCE of the
group's first line.
| RETURNS | DESCRIPTION |
|---|---|
list[list[dict[str, float]]]
|
List of groups, each a list of line dicts. |
Source code in src/core/pdf_processor.py
_adjust_dividers_for_text
¶
Adjust column dividers so they don't cut through text.
Gap-voting and most-common strategies compute dividers from a subset of rows (typically the densest ones). Rows excluded from the analysis may have wider text that extends past the computed divider.
Two adjustments are applied to each interior divider:
-
Shift left: when a span starts before the divider but its center is past it (e.g. a header like "Maximum Path Length" that is wider than the data rows used to compute the gap).
-
Shift right: when a span whose center is clearly in the left column has its right edge past the divider (e.g. "Self-Attention (restricted)" is wider than "Recurrent" used for gap computation). The divider moves to the midpoint between that span's right edge and the nearest right-column span's left edge.
| PARAMETER | DESCRIPTION |
|---|---|
dividers
|
Column boundary x-positions (modified in place).
TYPE:
|
text_rows
|
List of rows (each a sorted list of span dicts).
TYPE:
|
Source code in src/core/pdf_processor.py
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 | |
_infer_columns
¶
Infer column count and x-boundaries from text row data.
Two strategies are tried and the one producing more columns wins:
-
Most-common: uses the most common span count across rows and derives dividers from rows matching that count. Works well when most rows have the same number of populated cells.
-
Gap-voting: collects inter-span gaps across all rows and clusters them by x-position. A gap position that appears in at least 2 rows becomes a column divider. Handles sparse tables where row span counts vary widely.
| PARAMETER | DESCRIPTION |
|---|---|
text_rows
|
List of rows, each a list of PyMuPDF span dicts (already sorted by x within each row).
TYPE:
|
table_bbox
|
(x0, y0, x1, y1) of the table region.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int
|
Tuple of (column_count, col_dividers) where col_dividers is a |
list[float]
|
list of length column_count + 1 (table-left, dividers, table-right). |
Source code in src/core/pdf_processor.py
4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 | |
_infer_columns_by_gaps
¶
Infer column dividers from inter-span gaps in the densest rows.
Uses only the rows with the highest span counts (≥70% of the max span count) for gap analysis. These rows have the most complete column structure and produce the most reliable gaps — sparse rows would contribute noisy wide gaps that span multiple real columns.
Gaps at similar x-positions across multiple dense rows are clustered and each cluster with sufficient support becomes a column divider.
| PARAMETER | DESCRIPTION |
|---|---|
text_rows
|
List of rows (each a sorted list of span dicts).
TYPE:
|
table_bbox
|
(x0, y0, x1, y1) of the table region.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[float]
|
Column dividers list (table-left, dividers, table-right), or |
list[float]
|
empty list if no meaningful gaps are found. |
Source code in src/core/pdf_processor.py
5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 | |
_group_spans_into_rows
¶
Group spans by y-position into text rows, sorted by x within each.
| PARAMETER | DESCRIPTION |
|---|---|
spans
|
Flat list of PyMuPDF span dicts.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[list[dict[str, Any]]]
|
List of rows, each a list of spans sorted by x. |
Source code in src/core/pdf_processor.py
_row_column_count
¶
Count how many distinct column regions a text row occupies.
Source code in src/core/pdf_processor.py
_build_row_boundaries
¶
Compute row y-boundaries for a ruled table.
For horizontal-rule intervals that contain multiple data-like text rows (each having spans across multiple columns), each text row becomes its own row. For intervals where a row spans only one column (e.g. wrapped text within a cell), the entire interval remains one row.
| PARAMETER | DESCRIPTION |
|---|---|
text_rows
|
Text rows within the table (sorted by y).
TYPE:
|
rule_ys
|
Sorted y-positions of horizontal rules.
TYPE:
|
col_count
|
Expected number of columns.
TYPE:
|
table_bbox
|
(x0, y0, x1, y1) of the table.
TYPE:
|
col_dividers
|
Column boundary x-positions for multi-column check.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[float]
|
Sorted list of row boundary y-values (length = row_count + 1). |
Source code in src/core/pdf_processor.py
5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 | |
_build_row_cells_with_spanning
¶
Build cells for one table row, merging columns when spans cross dividers.
For most rows in sparse tables, each span sits within a single column and produces a narrow cell. When a span extends across multiple column dividers (e.g. a label like "(E) positional embedding..."), the affected columns are merged into a single wider cell for that row.
| PARAMETER | DESCRIPTION |
|---|---|
page_dict
|
Result of
TYPE:
|
col_dividers
|
Sorted list of column boundary x-positions.
TYPE:
|
ry0
|
Top y of the row.
TYPE:
|
ry1
|
Bottom y of the row.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[tuple[float, ...]]
|
List of cell tuples |
Source code in src/core/pdf_processor.py
5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 | |
_detect_ruled_tables
¶
Detect booktabs-style tables bounded by horizontal rules only.
Academic papers commonly use tables with horizontal rules (top, header
separator, bottom) but no vertical column separators. find_tables()
cannot detect these. This function identifies them from drawn horizontal
lines, then infers column structure from text span positions.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
page_dict
|
Result of
TYPE:
|
drawings
|
Optional pre-computed
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
Same format as |
list[dict[str, Any]]
|
and 'cells'. |
Source code in src/core/pdf_processor.py
5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 | |
_get_spans_in_rect
¶
Find all text spans whose center falls within the given rect.
| PARAMETER | DESCRIPTION |
|---|---|
page_dict
|
Result of page.get_text("dict").
TYPE:
|
rect
|
(x0, y0, x1, y1) bounding box.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
List of span dicts from PyMuPDF. |
Source code in src/core/pdf_processor.py
_detect_block_alignment
¶
Detect text alignment and first-line indent for a text block.
Uses the same median-based approach as _detect_line_joins for
robust alignment detection. Adds "justify" to the possible results
and computes a first-line indent in points when the first line is
shifted rightward from the typical left margin.
For single-line blocks, multi-line heuristics cannot work so the function falls back to page-level centering detection: if the block has significant, roughly symmetric margins relative to the page width, it is classified as centered.
| PARAMETER | DESCRIPTION |
|---|---|
line_extents
|
List of (line_x0, line_x1) for each text line.
TYPE:
|
block_rect
|
(x0, y0, x1, y1) bounding box of the block.
TYPE:
|
line_sizes
|
Optional per-line dominant font sizes.
TYPE:
|
page_width
|
Full page width in points for single-line centering.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
Tuple of (css_text_align, first_line_indent_pt). |
float
|
css_text_align is "left", "center", "right", or "justify". |
tuple[str, float]
|
first_line_indent_pt is 0.0 when no indent is detected. |
Source code in src/core/pdf_processor.py
5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 | |
_is_body_text_block
¶
Return True if block is a multi-line body-text block.
A block qualifies when it has ≥ 2 text lines and its font size is
within _CONTEXT_ALIGN_SIZE_TOL of median_size. Single-line
blocks, headings, and captions are excluded.
Source code in src/core/pdf_processor.py
_refine_alignments_from_context
¶
Upgrade ambiguous left alignments to justify using context.
Per-block alignment detection is purely geometric; short or 2-line
paragraphs can be ambiguous (left vs justify). This function
determines the dominant body-text alignment across all blocks on
the page and upgrades ambiguous left blocks when justify
clearly dominates.
Only multi-line blocks in the same font-size band qualify as body text — single-line blocks and different-sized headings / captions are excluded from both the vote and the upgrade.
Modifies blocks in place (only upgrades, never downgrades).
Source code in src/core/pdf_processor.py
_build_cell_text
¶
Build cell text from spans, preserving line breaks.
Groups spans by y-position into lines, joins same-line spans based on horizontal gap (space if gap > 1pt, else concatenate), then joins lines with newlines.
When base_bold is not None, spans whose bold/italic differs
from the base value are wrapped with <b>/<i> tags.
| PARAMETER | DESCRIPTION |
|---|---|
spans
|
List of PyMuPDF span dicts, sorted by (y, x).
TYPE:
|
base_bold
|
If not None, enables tagged mode with this base bold.
TYPE:
|
base_italic
|
Base italic value (used only when base_bold is set).
TYPE:
|
cell_rect
|
Optional (x0, y0, x1, y1) cell rectangle. When provided, cell width is computed from this rectangle rather than from text extents, preventing false space joins in sparse columns where all values have similar widths.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
tuple[str, list[float]]
|
Tuple of (reconstructed text, list of line y0 positions). |
Source code in src/core/pdf_processor.py
5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 | |
_detect_column_alignment
¶
Detect alignment for an entire table column.
Compares consistency (variance) of left edges, right edges, and center points across all cells in the column. The most consistent edge/center indicates the alignment.
| PARAMETER | DESCRIPTION |
|---|---|
col_spans
|
List of span lists, one per cell in the column.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
CSS text-align value: "left", "center", or "right". |
Source code in src/core/pdf_processor.py
_get_extracted_cell_bboxes
¶
Return bboxes of table cells that will be extracted (not skipped).
Math-heavy cells (algorithm/theorem box bodies) are skipped by
_extract_table_cell_blocks — their content goes through normal
block extraction with full math-placeholder support. This function
pre-computes the list of cell bboxes that WILL be extracted so the
main extraction loop can filter spans only in those cells, letting
skipped cells' spans pass through to normal extraction.
Cells with incidental math (footnote markers, isolated symbols) are NOT skipped — they are extracted as normal table cells.
Source code in src/core/pdf_processor.py
_extract_table_cell_blocks
¶
Create per-cell blocks from detected tables.
For each cell in each table, finds matching spans, extracts text
and font properties, detects alignment, and creates a block dict
compatible with _apply_translated_blocks.
| PARAMETER | DESCRIPTION |
|---|---|
page_tables
|
List of table info dicts from
TYPE:
|
page_dict
|
Result of
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
List of block dicts with keys: rect, text, font_size, font_name, |
list[dict[str, Any]]
|
color, bold, italic, text_align, is_table_cell. |
Source code in src/core/pdf_processor.py
5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 | |
_find_vertical_lines
¶
Find tall vertical lines drawn on a page.
Scans all vector drawings for line items that are vertical
(Δx < 1pt) and taller than _MIN_VLINE_HEIGHT.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
drawings
|
Optional pre-computed
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, float]]
|
List of dicts with keys 'x', 'y0', 'y1'. |
Source code in src/core/pdf_processor.py
_group_vlines_by_yrange
¶
Group vertical lines that share the same y-range.
Two lines are considered part of the same group when their top and
bottom endpoints are both within _VLINE_YRANGE_TOLERANCE of the
group's first line.
| RETURNS | DESCRIPTION |
|---|---|
list[list[dict[str, float]]]
|
List of groups, each a list of line dicts. |
Source code in src/core/pdf_processor.py
_detect_vline_tables
¶
Detect tables defined by vertical column separators only.
Some tables use vertical lines between columns but no horizontal rules. This function identifies them from drawn vertical lines, uses their x-positions as column dividers, and infers row boundaries from text span y-positions.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
page_dict
|
Result of
TYPE:
|
drawings
|
Pre-fetched drawing items, or None to fetch.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
Same format as |
list[dict[str, Any]]
|
and 'cells'. |
Source code in src/core/pdf_processor.py
6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 | |
_detect_framed_tables
¶
Detect tables enclosed in a rectangular frame (outer borders only).
Some tables have only an outer rectangle with no internal grid lines. This function finds rectangle drawing items, verifies that the content inside has a consistent columnar structure, and if so creates per-cell blocks.
To avoid false positives on boxed paragraphs and callout boxes, the
content must have at least _MIN_TABULAR_ROWS text rows matching
the inferred column count.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
page_dict
|
Result of
TYPE:
|
drawings
|
Pre-fetched drawing items, or None to fetch.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
Same format as |
list[dict[str, Any]]
|
and 'cells'. |
Source code in src/core/pdf_processor.py
6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 | |
_page_has_images
¶
Returns True if the page contains at least one raster image.
Used to distinguish truly scanned pages (raster-only, worth OCR) from vector-only pages (diagrams, charts) that should be left alone.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
Source code in src/core/pdf_processor.py
_join_textbox_lines
¶
Join multi-line get_textbox() output into a single search string.
- Hyphen break —
"Mod-\\nels"→"Models"(dehyphenate). - Normal break —
"Hello\\nWorld"→"Hello World"(space).
| PARAMETER | DESCRIPTION |
|---|---|
text
|
Raw text from
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
Single-line string suitable for |
Source code in src/core/pdf_processor.py
_save_page_links
¶
Save all links on a page for later restoration.
Preserves LINK_NAMED (kind 4) links with their nameddest
field so the PDF viewer resolves them at display time. Named
destinations survive page redaction (they live in the document
name tree, not the page content stream).
Extracts visible text under each link rect as _inner via
character-level majority overlap (>50% of char width AND
y-intersection). When chars span multiple lines, only the line
closest to the link rect center is kept to prevent contamination
from adjacent body text.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
List of cleaned link dicts suitable for |
Source code in src/core/pdf_processor.py
6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 | |
_links_to_checkpoint
¶
Convert saved link dicts to JSON-serializable checkpoint entries.
PyMuPDF Rect / Point objects are converted to plain lists.
Each entry is tagged with "type": "link" for checkpoint
discrimination.
| PARAMETER | DESCRIPTION |
|---|---|
saved_links
|
Link dicts from
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
List of JSON-safe dicts. |
Source code in src/core/pdf_processor.py
_map_stripped_pos
¶
Map a character position in tag-stripped text to the original.
Walks text counting only non-tag characters. Returns the index
in the original string corresponding to stripped_pos characters
of visible content. Any tags immediately following the landing
position are skipped so the result points past closing tags like
</sup> rather than into the middle of one.
| PARAMETER | DESCRIPTION |
|---|---|
text
|
Original text potentially containing HTML tags.
TYPE:
|
stripped_pos
|
Character offset in the tag-free version.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int
|
Corresponding index in text. |
Source code in src/core/pdf_processor.py
_inject_link_tags
¶
Wrap link text inside block text with <a id="N"> tags.
Links are grouped by intersecting block and sorted in reading
order (top-to-bottom, left-to-right) within each block. A shared
search_start is advanced after each successful injection so
that short/ambiguous _inner strings match sequentially.
Searches in the tag-stripped version of the block text so that
inline formatting tags (<sup>, <b>, etc.) do not prevent
matching. Positions are mapped back to the original tagged text
and trailing closing tags are included for valid HTML nesting.
| PARAMETER | DESCRIPTION |
|---|---|
blocks
|
Block dicts with
TYPE:
|
saved_links
|
Link dicts from
TYPE:
|
pymupdf
|
The pymupdf module reference.
TYPE:
|
Source code in src/core/pdf_processor.py
6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 | |
_extract_link_translations
¶
Extract translated link text from <a> tags and strip them.
After LLM translation, <a id="N">translated</a> tags in
translated_text are parsed. The translated content is stored
as _translated on the corresponding saved link so that
_restore_page_links can search for the translated text on the
overlay page. Then all <a> tags are removed for clean overlay.
| PARAMETER | DESCRIPTION |
|---|---|
blocks
|
Block dicts with
TYPE:
|
saved_links
|
Link dicts to receive
TYPE:
|
Source code in src/core/pdf_processor.py
_get_block_chars
¶
Return characters whose center falls within a block rect.
| PARAMETER | DESCRIPTION |
|---|---|
all_chars
|
List of (char, pymupdf.Rect) tuples for the page.
TYPE:
|
block_rect
|
pymupdf.Rect for the block area.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[tuple[str, Any]]
|
Filtered list of (char, rect) tuples in reading order. |
Source code in src/core/pdf_processor.py
_expand_ligatures
¶
Expand Unicode ligatures to ASCII equivalents.
Returns the expanded text and a position map: pos_map[i]
is the index in the original text that expanded char i
came from. Ligatures expand to multiple chars sharing the same
original index.
Source code in src/core/pdf_processor.py
_find_link_in_chars
¶
Find a link's rects in block characters by text search.
Searches sequentially from search_pos for _translated
(preferred) then _inner (fallback). Context-char matching
(_left_char / _right_char) is tried first to pick the
correct occurrence; raw substring is used as a last resort.
Handles Unicode ligatures (e.g. fl → fl) that PyMuPDF
may produce after insert_htmlbox rendering.
When the matched text spans multiple visual lines, a separate rect is returned for each line so that link borders follow the text instead of creating a single oversized rectangle.
| PARAMETER | DESCRIPTION |
|---|---|
block_chars
|
Characters within the block as (char, rect) tuples.
TYPE:
|
block_text
|
Concatenated text from block_chars.
TYPE:
|
link
|
Saved link dict.
TYPE:
|
search_pos
|
Start position for sequential search.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[Any]
|
(link_rects, next_search_pos) where link_rects is a list of |
int
|
per-line Rect objects (empty list if not found). |
Source code in src/core/pdf_processor.py
6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 | |
_insert_link_with_style
¶
Insert a link annotation and restore its visual style.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
link
|
Saved link dict with optional
TYPE:
|
link_rect
|
New rect for the link, or
TYPE:
|
Source code in src/core/pdf_processor.py
_restore_page_links
¶
Re-insert previously saved links onto a page.
Uses character-level position mapping when block information
is available (_block_idx set by _inject_link_tags):
- Extracts all character bounding boxes from the rendered page.
- For each block, collects characters within its rect.
- Finds each link's text sequentially in the block's character stream, ensuring correct disambiguation by reading order.
- Computes the link rect from matched character bounding boxes.
Falls back to search_for for links without _block_idx.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
saved_links
|
Link dicts from
TYPE:
|
redact_rects
|
Rects that were redacted (used for position remapping).
TYPE:
|
blocks
|
Block dicts with
TYPE:
|
Source code in src/core/pdf_processor.py
6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 | |
_dir_to_rotate
¶
Converts a PyMuPDF line direction vector to a rotation angle.
| PARAMETER | DESCRIPTION |
|---|---|
direction
|
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int
|
Rotation angle for |
Source code in src/core/pdf_processor.py
_overlay_vertical_block
¶
Overlays translated text for a vertical (rotated) text block.
Uses insert_text with the appropriate rotate parameter
instead of insert_htmlbox (which does not support vertical text).
The text direction (rotation angle) comes from the _dir
vector via _dir_to_rotate(). The alignment (where to
anchor the text within a label row) comes from
_resolve_vertical_alignment() — stored as _vert_align
("bottom" / "top" / "center") and _vert_align_y
on the block dict.
For rotate=90 (bottom-to-top, the common case):
- bottom — insert at the shared bottom y; text grows upward.
- top — insert at
shared_top + text_lengthso the text grows upward and its top edge lands on the shared top. - center — insert at
shared_mid + text_length / 2.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
block
|
Block dict with
TYPE:
|
pymupdf
|
The pymupdf module reference.
TYPE:
|
fontname
|
Registered font name for Unicode support. When
TYPE:
|
font_obj
|
A
TYPE:
|
Source code in src/core/pdf_processor.py
7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 | |
_apply_translated_blocks
¶
Redacts original text and overlays translated text on a PDF page.
For each block with translated_text:
1. Adds a white-filled redaction annotation over the original area.
2. Applies all redactions, preserving images and vector graphics.
3. Inserts translated text via insert_htmlbox.
4. Restores all saved links.
| PARAMETER | DESCRIPTION |
|---|---|
page
|
A PyMuPDF Page object.
TYPE:
|
blocks
|
Block dicts, each with at least
TYPE:
|
pymupdf
|
The pymupdf module reference.
TYPE:
|
saved_links
|
Pre-saved links from
TYPE:
|
target_lang
|
Target language name for font selection.
TYPE:
|
Source code in src/core/pdf_processor.py
7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 | |
_font_family_from_flags
¶
Derive a CSS generic font-family from PyMuPDF font flags.
Delegates to :func:src.utils.font_utils.classify_generic_family.
Source code in src/core/pdf_processor.py
_resolve_fontfile
¶
Resolve a font family name to a font file path.
Uses fc-match (fontconfig) on Linux/macOS, falling back to
known system paths for common universal fonts. Results are cached
at module level.
| PARAMETER | DESCRIPTION |
|---|---|
font_name
|
Font family name (e.g. "DejaVu Sans", "Noto Sans CJK SC").
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str | None
|
Absolute path to a |
Source code in src/core/pdf_processor.py
_classify_sup_sub
¶
Classify a span as superscript or subscript.
A span is a candidate when its font size is significantly smaller than the line's dominant size. Position within the line determines whether it is superscript (upper half) or subscript (lower half).
| PARAMETER | DESCRIPTION |
|---|---|
span_size
|
Font size of the span.
TYPE:
|
span_y0
|
Top of span bounding box.
TYPE:
|
span_y1
|
Bottom of span bounding box.
TYPE:
|
line_dom_size
|
Dominant font size for the line.
TYPE:
|
line_y0
|
Top of line bounding box.
TYPE:
|
line_y1
|
Bottom of line bounding box.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str | None
|
|
Source code in src/core/pdf_processor.py
_has_mixed_formatting
¶
Check if spans have varying bold/italic/color/size or super/subscript.
Returns True when at least one span differs in bold, italic, color, or font size from the others, or when any span is classified as superscript or subscript — indicating formatting that should be preserved via inline HTML tags during translation.
Font size variation is only counted for non-sup/sub spans so that
size differences already captured by <sup>/<sub> do not
redundantly trigger mixed formatting.
| PARAMETER | DESCRIPTION |
|---|---|
flags_list
|
List of PyMuPDF span flag integers.
TYPE:
|
roles
|
Optional parallel list of
TYPE:
|
colors
|
Optional parallel list of color integers (0xRRGGBB).
TYPE:
|
sizes
|
Optional parallel list of font sizes in pt.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True if formatting varies across spans. |
Source code in src/core/pdf_processor.py
_tag_span_text
¶
_tag_span_text(
text,
flags,
base_bold,
base_italic,
role=None,
color=None,
base_color=None,
size=None,
base_size=None,
)
Wrap span text with formatting tags when it deviates from base.
Only wraps when the span's formatting differs from the dominant
(base) value. Tags are <b>/<i>/<sup>/<sub> for
weight/style/position, <span style="color:#rrggbb"> for color
deviations, and <span style="font-size:Xpt"> for size
deviations (only when the span is not already sup/sub).
When both color and size deviate, they are combined in a single
<span> tag to reduce token noise.
Whitespace-only spans are never wrapped — tagging spaces adds noise without visual effect.
Note: when the base is bold/italic and a span is not, we
cannot easily undo the <p>-level weight/style with plain
HTML. This is acceptable because in practice the minority
formatting (bold labels, italic headings) is almost always the
deviation, not the base.
| PARAMETER | DESCRIPTION |
|---|---|
text
|
Plain span text (not HTML-escaped).
TYPE:
|
flags
|
PyMuPDF span flags integer.
TYPE:
|
base_bold
|
Dominant bold value for the block/cell.
TYPE:
|
base_italic
|
Dominant italic value for the block/cell.
TYPE:
|
role
|
TYPE:
|
color
|
Span color as 0xRRGGBB integer, or
TYPE:
|
base_color
|
Dominant block color as 0xRRGGBB integer, or
TYPE:
|
size
|
Span font size in pt, or
TYPE:
|
base_size
|
Dominant block font size in pt, or
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
Text optionally wrapped with formatting tags. |
Source code in src/core/pdf_processor.py
7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 | |
_merge_adjacent_tags
¶
Merge adjacent identical formatting tags into single spans.
Replaces patterns like </b><b> or </b> <b> with just the
space (or nothing), collapsing consecutive same-format runs into
one pair of tags. Also merges adjacent <span> tags that share
the same style. Reduces token noise sent to the LLM.
| PARAMETER | DESCRIPTION |
|---|---|
text
|
Tagged text potentially containing redundant adjacent tags.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
Text with adjacent same tags merged. |
Source code in src/core/pdf_processor.py
_cap_by_neighbors
¶
Cap proposed_x1 so it doesn't collide with any other block.
Checks ALL blocks (including table cells) for vertical overlap. For blocks starting to the right of bx1, caps at their left edge. For blocks that straddle bx1 (start before, extend past), caps at bx1 itself so the extension doesn't overlap.
Source code in src/core/pdf_processor.py
_cap_by_left_neighbors
¶
Cap proposed_x0 so leftward growth doesn't collide with any block.
Symmetric to :func:_cap_by_neighbors but for growing leftward.
For blocks ending to the left of bx0, caps at their right edge.
For blocks that straddle bx0 (end after, start before), caps
at bx0 itself so the extension doesn't overlap.
Source code in src/core/pdf_processor.py
_split_multiline_blocks
¶
Split multi-line blocks at \n boundaries into sub-blocks.
When a block contains multiple paragraphs (joined by \n),
_widen_render_rects skips it because widening a multi-line block
changes line breaks. By splitting into per-paragraph sub-blocks,
each paragraph can be independently widened without affecting others.
Each sub-block gets its own rect derived from the y-extents of
its constituent lines and inherits all properties from the parent.
The _math_map placeholders are distributed to the sub-block
whose text contains them.
Table cells and vertical text are never split — their layout depends on the enclosing cell / rotation origin.
| PARAMETER | DESCRIPTION |
|---|---|
blocks
|
List of block dicts (not modified; returns a new list).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[dict[str, Any]]
|
New list with multi-line blocks replaced by sub-blocks. |
Source code in src/core/pdf_processor.py
7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 | |
_measure_htmlbox_spare
¶
Measure spare height and scale factor on a scratch page.
Renders html into rect on a temporary page of measure_doc
and returns (spare_height, scale_factor) without touching the
real page. The scratch page is deleted immediately so the temp
doc stays lightweight.
Source code in src/core/pdf_processor.py
_is_multiline_block
¶
Return True if a block contains multiple visual lines.
Detects both explicit newlines (\n) and implicit line wrapping
(block height > 2× font size).
Source code in src/core/pdf_processor.py
_ends_with_math_placeholder
¶
Return True if block text ends with a math placeholder.
Predominantly-math blocks ending with math (e.g. radical √,
delimiters) should not be widened — the math content fills the
original rect's right edge, and widening causes radical overlines /
delimiter bars to extend into empty space.
Source code in src/core/pdf_processor.py
_widen_render_rects
¶
Extend render_rect to fill available column width.
Groups non-table blocks by column (similar left edge) and extends each block's rendering rectangle to the column's right boundary. This prevents font shrinkage when translated text is longer than the original — headings and short lines get the full column width.
Full-width blocks (spanning > 60% of the page width, inferred from the widest block) are excluded from column boundary calculation so they don't inflate narrow columns on pages with few blocks.
Only sets render_rect when the column boundary exceeds the
block's own right edge. The original rect is preserved for
redaction so only the actual text area is cleared.
| PARAMETER | DESCRIPTION |
|---|---|
blocks
|
List of block dicts (modified in place).
TYPE:
|
Source code in src/core/pdf_processor.py
8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 | |
_escape_preserving_tags
¶
HTML-escape text while preserving allowed inline formatting tags.
Escapes all HTML entities first, then selectively restores
<b>, <i>, <sup>, <sub>, </span>, and
<span style="..."> tags whose style contains only allowed
CSS properties (color and font-size) so they render
correctly in insert_htmlbox().
| PARAMETER | DESCRIPTION |
|---|---|
text
|
Text potentially containing formatting tags.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
HTML-safe string with allowed tags preserved. |
Source code in src/core/pdf_processor.py
_build_overlay_html
¶
Builds an HTML snippet for overlaying translated text.
Extracts RGB from the block's color int and applies font properties. When target_lang is provided, selects a concrete font that supports the target language within the same generic family (serif / sans-serif / monospace) as the source font. Falls back to the generic family name when no concrete match is found.
For blocks with has_mixed_formatting, inline <b>/<i> tags
in the translated text are preserved so insert_htmlbox renders
them with the correct weight/style.
| PARAMETER | DESCRIPTION |
|---|---|
block
|
Block dict with translated_text, font_size, color, bold, italic, font_flags keys. Optionally text_align, is_table_cell, and has_mixed_formatting.
TYPE:
|
target_lang
|
Target language name for font selection.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
HTML string for |
Source code in src/core/pdf_processor.py
8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 | |
_process_scanned_pages
¶
_process_scanned_pages(
output_path,
scanned_indices,
target_lang,
src_lang,
glossary_entries,
progress_callback,
cancel_check,
text_weight,
config=None,
*,
provider=None,
model=None,
)
Processes scanned PDF pages using the OCR → LLM → render pipeline.
Re-opens the saved output PDF, renders each scanned page to a temp image, runs OCR + vision translation, and replaces the page content.
| PARAMETER | DESCRIPTION |
|---|---|
output_path
|
Path to the (already saved) output PDF.
TYPE:
|
scanned_indices
|
List of zero-based page indices to OCR.
TYPE:
|
target_lang
|
Target language name.
TYPE:
|
src_lang
|
Source language name.
TYPE:
|
glossary_entries
|
Optional glossary entries.
TYPE:
|
progress_callback
|
Called with 0-100 progress percentage.
TYPE:
|
cancel_check
|
Returns True if the task was cancelled.
TYPE:
|
text_weight
|
Fraction of progress already consumed by text pages.
TYPE:
|
config
|
Optional TranslationConfig snapshot; falls back to
TYPE:
|
provider
|
Optional LLM provider override.
TYPE:
|
model
|
Optional LLM model override.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
True on success, False on cancellation. |
Source code in src/core/pdf_processor.py
8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 | |