mirror of
https://github.com/VectifyAI/PageIndex.git
synced 2026-07-15 21:11:05 +02:00
Addresses items 9-13 and a/b/c/f from the max-effort review of PR #272. - pdf.py: image colorspace check was `pix.n > 4`, which treats CMYK-without- alpha (n==4, same as RGBA) as not needing RGB conversion; pix.save() as .png then raises "unsupported colorspace", silently dropped by the surrounding except. Fixed to `pix.n - pix.alpha >= 4` (correctly converts CMYK, leaves RGBA untouched). - pipeline.py: detect_strategy([]) (an empty/whitespace-only source file) returned "content_based", routing into the PDF-oriented TOC-detection pipeline -- wasting a real LLM call before raising IndexingError. Empty node lists now route to level_based, whose build_tree_from_levels([]) returns an empty structure instantly with zero LLM calls. - page_index.py (shim): pageindex/__init__.py binds the canonical `page_index` function as the package attribute, but this file is ALSO a real submodule of the same name -- importing it anywhere (import machinery, unconditional) overwrites that attribute with the module object, breaking `from pageindex import page_index; page_index(x)` for the rest of the process. Made the shim module itself callable (delegates to the real function via a ModuleType subclass), so whichever object ends up in that slot is callable regardless of import order. - storage/sqlite.py: create_collection let a raw sqlite3.IntegrityError escape on a duplicate name (new CollectionAlreadyExistsError); the collections table's CHECK constraint only validated the name's first character (GLOB '*' is a wildcard, not a regex quantifier over the preceding class) -- fixed to validate the whole string, and SQLiteStorage now also validates in Python (it's a public StorageEngine usable directly, bypassing LocalBackend's own check). - tests/test_review_fixes_2.py: two tests used a ContentNode with no `level` set, so build_index took the content_based path and made real (retried, slow, and -- with a valid key -- billable) LLM calls instead of testing the text-stripping logic they claimed to. Mocked out _content_based_pipeline. - retrieve.py: _parse_pages/_get_pdf_page_content were independent copies of the canonical parse_pages/get_pdf_page_content that had already drifted (missing the p>=1 filter and 1000-page DoS cap) -- delegate to canonical now, so the legacy pageindex.get_page_content path can't silently regress again. - parser/markdown.py: a leading UTF-8 BOM broke first-header detection (not whitespace, .strip() doesn't remove it) -- decode utf-8-sig. Only backtick fences were recognized as code blocks, so a '#'-prefixed line inside a ~~~-fenced block (valid CommonMark) was misparsed as a heading -- recognize both fence styles. - run_pageindex.py: --if-thinning wasn't migrated to the bare-flag + legacy-yes/no convention the other four --if-add-* flags got; bare usage raised an argparse error and it never went through the shared coercion. - types.py: DocumentDetail's `structure` field was inside the class's total=False body, so TypedDict rules made it optional even though every backend always populates it. Split into a required base class. Adds regression tests for all of the above. Full suite: 244 passed, 2 skipped (one pre-existing, unrelated flaky cloud-streaming test). Claude-Session: https://claude.ai/code/session_01Kx5DgKbhK1N8autqXH8SmS
125 lines
6 KiB
Python
125 lines
6 KiB
Python
import argparse
|
|
import os
|
|
import json
|
|
from pageindex.index.page_index import *
|
|
# Reuse the canonical yes/no coercion (as _cli_bool) instead of a second copy —
|
|
# a bare ``--flag`` (no value) resolves to True via argparse's ``const``; an
|
|
# explicit value keeps the legacy yes/no style working, so ``--flag no`` turns
|
|
# it off. argparse only ever passes a str here (const/default bypass type=).
|
|
from pageindex.index.page_index_md import md_to_tree, _coerce_bool as _cli_bool
|
|
from pageindex.config import IndexConfig
|
|
|
|
|
|
if __name__ == "__main__":
|
|
# Set up argument parser
|
|
parser = argparse.ArgumentParser(description='Process PDF or Markdown document and generate structure')
|
|
parser.add_argument('--pdf_path', type=str, help='Path to the PDF file')
|
|
parser.add_argument('--md_path', type=str, help='Path to the Markdown file')
|
|
|
|
parser.add_argument('--model', type=str, default=None, help='Model to use')
|
|
|
|
parser.add_argument('--toc-check-pages', type=int, default=None,
|
|
help='Number of pages to check for table of contents (PDF only)')
|
|
parser.add_argument('--max-pages-per-node', type=int, default=None,
|
|
help='Maximum number of pages per node (PDF only)')
|
|
parser.add_argument('--max-tokens-per-node', type=int, default=None,
|
|
help='Maximum number of tokens per node (PDF only)')
|
|
|
|
# Bare flag (e.g. --if-add-node-id) turns the option on; an explicit value
|
|
# keeps the legacy yes/no style, so --if-add-node-id no turns it off.
|
|
parser.add_argument('--if-add-node-id', nargs='?', const=True, type=_cli_bool, default=None,
|
|
help='Add node IDs (on by default). Bare flag or yes/no, e.g. --if-add-node-id no')
|
|
parser.add_argument('--if-add-node-summary', nargs='?', const=True, type=_cli_bool, default=None,
|
|
help='Add node summaries (on by default). Bare flag or yes/no')
|
|
parser.add_argument('--if-add-doc-description', nargs='?', const=True, type=_cli_bool, default=None,
|
|
help='Add a document description (on by default). Bare flag or yes/no')
|
|
parser.add_argument('--if-add-node-text', nargs='?', const=True, type=_cli_bool, default=None,
|
|
help='Add raw text to nodes (off by default). Bare flag or yes/no')
|
|
|
|
# Markdown specific arguments
|
|
parser.add_argument('--if-thinning', nargs='?', const=True, type=_cli_bool, default=None,
|
|
help='Apply tree thinning (off by default, markdown only). Bare flag or yes/no')
|
|
parser.add_argument('--thinning-threshold', type=int, default=5000,
|
|
help='Minimum token threshold for thinning (markdown only)')
|
|
parser.add_argument('--summary-token-threshold', type=int, default=200,
|
|
help='Token threshold for generating summaries (markdown only)')
|
|
args = parser.parse_args()
|
|
|
|
# Validate that exactly one file type is specified
|
|
if not args.pdf_path and not args.md_path:
|
|
raise ValueError("Either --pdf_path or --md_path must be specified")
|
|
if args.pdf_path and args.md_path:
|
|
raise ValueError("Only one of --pdf_path or --md_path can be specified")
|
|
|
|
# Build IndexConfig from CLI args (None values use defaults)
|
|
config_overrides = {
|
|
k: v for k, v in {
|
|
"model": args.model,
|
|
"toc_check_page_num": args.toc_check_pages,
|
|
"max_page_num_each_node": args.max_pages_per_node,
|
|
"max_token_num_each_node": args.max_tokens_per_node,
|
|
"if_add_node_id": args.if_add_node_id,
|
|
"if_add_node_summary": args.if_add_node_summary,
|
|
"if_add_doc_description": args.if_add_doc_description,
|
|
"if_add_node_text": args.if_add_node_text,
|
|
}.items() if v is not None
|
|
}
|
|
opt = IndexConfig(**config_overrides)
|
|
|
|
if args.pdf_path:
|
|
# Validate PDF file
|
|
if not args.pdf_path.lower().endswith('.pdf'):
|
|
raise ValueError("PDF file must have .pdf extension")
|
|
if not os.path.isfile(args.pdf_path):
|
|
raise ValueError(f"PDF file not found: {args.pdf_path}")
|
|
|
|
# Process the PDF
|
|
toc_with_page_number = page_index_main(args.pdf_path, opt)
|
|
print('Parsing done, saving to file...')
|
|
|
|
# Save results
|
|
pdf_name = os.path.splitext(os.path.basename(args.pdf_path))[0]
|
|
output_dir = './results'
|
|
output_file = f'{output_dir}/{pdf_name}_structure.json'
|
|
os.makedirs(output_dir, exist_ok=True)
|
|
|
|
with open(output_file, 'w', encoding='utf-8') as f:
|
|
json.dump(toc_with_page_number, f, indent=2)
|
|
|
|
print(f'Tree structure saved to: {output_file}')
|
|
|
|
elif args.md_path:
|
|
# Validate Markdown file
|
|
if not args.md_path.lower().endswith(('.md', '.markdown')):
|
|
raise ValueError("Markdown file must have .md or .markdown extension")
|
|
if not os.path.isfile(args.md_path):
|
|
raise ValueError(f"Markdown file not found: {args.md_path}")
|
|
|
|
# Process markdown file
|
|
print('Processing markdown file...')
|
|
import asyncio
|
|
|
|
toc_with_page_number = asyncio.run(md_to_tree(
|
|
md_path=args.md_path,
|
|
if_thinning=bool(args.if_thinning),
|
|
min_token_threshold=args.thinning_threshold,
|
|
if_add_node_summary=opt.if_add_node_summary,
|
|
summary_token_threshold=args.summary_token_threshold,
|
|
model=opt.model,
|
|
if_add_doc_description=opt.if_add_doc_description,
|
|
if_add_node_text=opt.if_add_node_text,
|
|
if_add_node_id=opt.if_add_node_id
|
|
))
|
|
|
|
print('Parsing done, saving to file...')
|
|
|
|
# Save results
|
|
md_name = os.path.splitext(os.path.basename(args.md_path))[0]
|
|
output_dir = './results'
|
|
output_file = f'{output_dir}/{md_name}_structure.json'
|
|
os.makedirs(output_dir, exist_ok=True)
|
|
|
|
with open(output_file, 'w', encoding='utf-8') as f:
|
|
json.dump(toc_with_page_number, f, indent=2, ensure_ascii=False)
|
|
|
|
print(f'Tree structure saved to: {output_file}')
|