feat: add --rasterizer CLI option to select PDF rasterization backend
Add user control over which rasterizer is used for PDF page rendering: - 'auto' (default): prefers pypdfium when available, falls back to Ghostscript - 'pypdfium': force pypdfium2 (errors if not installed) - 'ghostscript': force traditional Ghostscript rasterizer Changes: - Add rasterizer field with validation to OCROptions model - Add --rasterizer CLI argument in the Advanced options group - Update rasterize_pdf_page hookspec to pass options to plugins - Update pypdfium plugin with check_options hook for availability check - Update both plugins to respect the rasterizer option 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.5
parent
938ce8e285
commit
ed813cec67
@@ -147,6 +147,7 @@ class OCROptions(BaseModel):
|
||||
# Advanced options
|
||||
max_image_mpixels: float = 250.0
|
||||
pdf_renderer: str = 'auto'
|
||||
rasterizer: str = 'auto'
|
||||
rotate_pages_threshold: float = DEFAULT_ROTATE_PAGES_THRESHOLD
|
||||
user_words: os.PathLike | None = None
|
||||
user_patterns: os.PathLike | None = None
|
||||
@@ -207,6 +208,15 @@ class OCROptions(BaseModel):
|
||||
raise ValueError(f"pdf_renderer must be one of {valid_renderers}")
|
||||
return v
|
||||
|
||||
@field_validator('rasterizer')
|
||||
@classmethod
|
||||
def validate_rasterizer(cls, v):
|
||||
"""Validate rasterizer is one of the allowed values."""
|
||||
valid_rasterizers = {'auto', 'ghostscript', 'pypdfium'}
|
||||
if v not in valid_rasterizers:
|
||||
raise ValueError(f"rasterizer must be one of {valid_rasterizers}")
|
||||
return v
|
||||
|
||||
@field_validator('clean_final')
|
||||
@classmethod
|
||||
def validate_clean_final(cls, v, info):
|
||||
|
||||
@@ -405,6 +405,7 @@ def rasterize_preview(input_file: Path, page_context: PageContext) -> Path:
|
||||
rotation=0,
|
||||
filter_vector=False,
|
||||
stop_on_soft_error=not page_context.options.continue_on_soft_render_error,
|
||||
options=page_context.options,
|
||||
)
|
||||
return output_file
|
||||
|
||||
@@ -564,6 +565,7 @@ def rasterize(
|
||||
rotation=correction,
|
||||
filter_vector=remove_vectors,
|
||||
stop_on_soft_error=not page_context.options.continue_on_soft_render_error,
|
||||
options=page_context.options,
|
||||
)
|
||||
return output_file
|
||||
|
||||
|
||||
@@ -328,6 +328,7 @@ def ocr( # noqa: D417
|
||||
tesseract_oem: int | None = None,
|
||||
tesseract_thresholding: int | None = None,
|
||||
pdf_renderer: str | None = None,
|
||||
rasterizer: str | None = None,
|
||||
tesseract_timeout: float | None = None,
|
||||
tesseract_non_ocr_timeout: float | None = None,
|
||||
tesseract_downsample_above: int | None = None,
|
||||
@@ -481,6 +482,7 @@ def _pdf_to_hocr( # noqa: D417
|
||||
tesseract_downsample_above: int | None = None,
|
||||
tesseract_downsample_large_images: bool | None = None,
|
||||
rotate_pages_threshold: float | None = None,
|
||||
rasterizer: str | None = None,
|
||||
user_words: os.PathLike | None = None,
|
||||
user_patterns: os.PathLike | None = None,
|
||||
continue_on_soft_render_error: bool | None = None,
|
||||
|
||||
@@ -128,8 +128,13 @@ def rasterize_pdf_page(
|
||||
rotation,
|
||||
filter_vector,
|
||||
stop_on_soft_error,
|
||||
options=None,
|
||||
):
|
||||
"""Rasterize a single page of a PDF file using Ghostscript."""
|
||||
# Check if user explicitly requested a different rasterizer
|
||||
if options is not None and options.rasterizer == 'pypdfium':
|
||||
return None # Let pypdfium handle it (it will error in check_options if unavailable)
|
||||
|
||||
ghostscript.rasterize_pdf(
|
||||
input_file,
|
||||
output_file,
|
||||
|
||||
@@ -13,13 +13,20 @@ except ImportError:
|
||||
pdfium = None
|
||||
|
||||
from ocrmypdf import hookimpl
|
||||
from ocrmypdf.exceptions import MissingDependencyError
|
||||
from ocrmypdf.helpers import Resolution
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
# Note: No check_options hook - pypdfium is optional. If pypdfium2 is not
|
||||
# installed, the rasterize_pdf_page hook returns None and Ghostscript is used.
|
||||
@hookimpl
|
||||
def check_options(options):
|
||||
"""Check that pypdfium2 is available if explicitly requested."""
|
||||
if options.rasterizer == 'pypdfium' and pdfium is None:
|
||||
raise MissingDependencyError(
|
||||
"The --rasterizer pypdfium option requires the pypdfium2 package. "
|
||||
"Install it with: pip install pypdfium2"
|
||||
)
|
||||
|
||||
|
||||
def _open_pdf_document(input_file: Path):
|
||||
@@ -123,11 +130,17 @@ def rasterize_pdf_page(
|
||||
rotation: int | None,
|
||||
filter_vector: bool,
|
||||
stop_on_soft_error: bool,
|
||||
options=None,
|
||||
) -> Path | None:
|
||||
"""Rasterize a single page of a PDF file using pypdfium2.
|
||||
|
||||
Returns None if pypdfium2 is not available, allowing Ghostscript to be used.
|
||||
Returns None if pypdfium2 is not available or if the user has selected
|
||||
a different rasterizer, allowing Ghostscript to be used.
|
||||
"""
|
||||
# Check if user explicitly requested a different rasterizer
|
||||
if options is not None and options.rasterizer == 'ghostscript':
|
||||
return None # Let Ghostscript handle it
|
||||
|
||||
if pdfium is None:
|
||||
return None # Fall back to Ghostscript
|
||||
|
||||
|
||||
@@ -373,6 +373,14 @@ Online documentation is located at:
|
||||
help="Choose OCR PDF renderer - the default option is to let OCRmyPDF "
|
||||
"choose. See documentation for discussion.",
|
||||
)
|
||||
advanced.add_argument(
|
||||
'--rasterizer',
|
||||
choices=['auto', 'ghostscript', 'pypdfium'],
|
||||
default='auto',
|
||||
help="Choose PDF page rasterizer. 'auto' prefers pypdfium when available, "
|
||||
"falling back to Ghostscript. 'pypdfium' is faster but requires the "
|
||||
"pypdfium2 package. 'ghostscript' uses the traditional Ghostscript rasterizer.",
|
||||
)
|
||||
advanced.add_argument(
|
||||
'--rotate-pages-threshold',
|
||||
default=DEFAULT_ROTATE_PAGES_THRESHOLD,
|
||||
|
||||
@@ -213,6 +213,7 @@ def rasterize_pdf_page(
|
||||
rotation: int | None,
|
||||
filter_vector: bool,
|
||||
stop_on_soft_error: bool,
|
||||
options: OCROptions | None = None,
|
||||
) -> Path: # type: ignore[return-value]
|
||||
"""Rasterize one page of a PDF at resolution raster_dpi in canvas units.
|
||||
|
||||
@@ -236,6 +237,9 @@ def rasterize_pdf_page(
|
||||
cannot proceed, it should always raise an exception, regardless of
|
||||
this setting. One "soft error" would be a missing font that is
|
||||
required to properly rasterize the PDF.
|
||||
options: OCRmyPDF options. Plugins may use this to check settings like
|
||||
``options.rasterizer`` to determine whether they should handle the
|
||||
request or defer to another plugin. Introduced in version 17.0.
|
||||
|
||||
Returns:
|
||||
Path: output_file if successful
|
||||
|
||||
Reference in New Issue
Block a user