James R. Barlow
08e40f96e8
When Tesseract cannot find its 'hocr' or 'txt' config files in the tessdata configs/ directory, it prints "read_params_file: Can't open" warnings, exits 0, and produces no output. OCRmyPDF then crashed with a confusing FileNotFoundError on the missing hOCR file (issue #1687). Promote read_params_file warnings to TesseractConfigError with guidance on the likely cause, and verify the expected output file exists after Tesseract claims success as defense-in-depth for other silent-failure modes.
162 lines
4.8 KiB
Python
162 lines
4.8 KiB
Python
# SPDX-FileCopyrightText: 2022 James R. Barlow
|
|
# SPDX-License-Identifier: MPL-2.0
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import os
|
|
import subprocess
|
|
from os import fspath
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from ocrmypdf import pdfinfo
|
|
from ocrmypdf._exec import tesseract
|
|
from ocrmypdf.exceptions import BadArgsError, MissingDependencyError
|
|
|
|
from .conftest import check_ocrmypdf, run_ocrmypdf_api
|
|
|
|
# pylint: disable=redefined-outer-name
|
|
|
|
|
|
@pytest.mark.parametrize('basename', ['graph_ocred.pdf', 'cardinal.pdf'])
|
|
def test_skip_pages_does_not_replicate(resources, basename, outdir):
|
|
infile = resources / basename
|
|
outpdf = outdir / basename
|
|
|
|
check_ocrmypdf(
|
|
infile,
|
|
outpdf,
|
|
'--pdf-renderer',
|
|
'sandwich',
|
|
'--force-ocr',
|
|
'--tesseract-timeout',
|
|
'0',
|
|
)
|
|
|
|
info_in = pdfinfo.PdfInfo(infile)
|
|
|
|
info = pdfinfo.PdfInfo(outpdf)
|
|
for page in info:
|
|
assert len(page.images) == 1, "skipped page was replicated"
|
|
|
|
for n, info_out_n in enumerate(info):
|
|
assert info_out_n.width_inches == info_in[n].width_inches, "output resized"
|
|
assert info_out_n.height_inches == info_in[n].height_inches, "output resized"
|
|
|
|
|
|
def test_content_preservation(resources, outpdf):
|
|
infile = resources / 'masks.pdf'
|
|
|
|
check_ocrmypdf(
|
|
infile, outpdf, '--pdf-renderer', 'fpdf2', '--tesseract-timeout', '0'
|
|
)
|
|
|
|
info = pdfinfo.PdfInfo(outpdf)
|
|
page = info[0]
|
|
assert len(page.images) > 1, "masks were rasterized"
|
|
|
|
|
|
@pytest.mark.skipif(
|
|
tesseract.version() >= tesseract.TesseractVersion('5'), reason="doesn't fool Tess 5"
|
|
)
|
|
def test_no_languages(tmp_path, monkeypatch):
|
|
(tmp_path / 'tessdata').mkdir()
|
|
monkeypatch.setenv('TESSDATA_PREFIX', fspath(tmp_path))
|
|
with pytest.raises(MissingDependencyError):
|
|
tesseract.get_languages()
|
|
|
|
|
|
def test_image_too_large_hocr(monkeypatch, resources, outdir):
|
|
def dummy_run(args, *, env=None, **kwargs):
|
|
raise subprocess.CalledProcessError(1, 'tesseract', output=b'Image too large')
|
|
|
|
monkeypatch.setattr(tesseract, 'run', dummy_run)
|
|
tesseract.generate_hocr(
|
|
input_file=resources / 'crom.png',
|
|
output_hocr=outdir / 'out.hocr',
|
|
output_text=outdir / 'out.txt',
|
|
languages=['eng'],
|
|
engine_mode=None,
|
|
tessconfig=[],
|
|
timeout=180.0,
|
|
pagesegmode=None,
|
|
thresholding=0,
|
|
user_words=None,
|
|
user_patterns=None,
|
|
)
|
|
assert Path(outdir / 'out.hocr').read_text() == ''
|
|
|
|
|
|
def test_image_too_large_pdf(monkeypatch, resources, outdir):
|
|
def dummy_run(args, *, env=None, **kwargs):
|
|
raise subprocess.CalledProcessError(1, 'tesseract', output=b'Image too large')
|
|
|
|
monkeypatch.setattr(tesseract, 'run', dummy_run)
|
|
tesseract.generate_pdf(
|
|
input_file=resources / 'crom.png',
|
|
output_pdf=outdir / 'pdf.pdf',
|
|
output_text=outdir / 'txt.txt',
|
|
languages=['eng'],
|
|
engine_mode=None,
|
|
tessconfig=[],
|
|
timeout=180.0,
|
|
pagesegmode=None,
|
|
thresholding=0,
|
|
user_words=None,
|
|
user_patterns=None,
|
|
)
|
|
assert Path(outdir / 'txt.txt').read_text() == '[skipped page]'
|
|
if os.name != 'nt': # different semantics
|
|
assert Path(outdir / 'pdf.pdf').stat().st_size == 0
|
|
|
|
|
|
def test_timeout(caplog):
|
|
tesseract.page_timedout(5)
|
|
assert "took too long" in caplog.text
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
'in_, logged',
|
|
[
|
|
(b'Tesseract Open Source', ''),
|
|
(b'lots of diacritics blah blah', 'diacritics'),
|
|
(b'Warning in pixReadMem', ''),
|
|
(b'OSD: Weak margin', 'unsure about page orientation'),
|
|
(b'Error in pixScanForForeground', ''),
|
|
(b'Error in boxClipToRectangle', ''),
|
|
(b'an unexpected error', 'an unexpected error'),
|
|
(b'a dire warning', 'a dire warning'),
|
|
(b'an innocent message', 'innocent'),
|
|
(b'\x7f\x7f\x80innocent unicode failure', 'innocent'),
|
|
],
|
|
)
|
|
def test_tesseract_log_output(caplog, in_, logged):
|
|
caplog.set_level(logging.INFO)
|
|
tesseract.tesseract_log_output(in_)
|
|
if logged == '':
|
|
assert caplog.text == ''
|
|
else:
|
|
assert logged in caplog.text
|
|
|
|
|
|
def test_tesseract_log_output_raises(caplog):
|
|
with pytest.raises(tesseract.TesseractConfigError):
|
|
tesseract.tesseract_log_output(b'parameter not found: moo')
|
|
assert 'not found' in caplog.text
|
|
|
|
|
|
def test_tesseract_log_output_raises_on_missing_config(caplog):
|
|
with pytest.raises(tesseract.TesseractConfigError) as excinfo:
|
|
tesseract.tesseract_log_output(b"read_params_file: Can't open hocr")
|
|
assert 'hocr' in excinfo.value.args[0]
|
|
assert 'read_params_file' in caplog.text
|
|
|
|
|
|
def test_blocked_language(resources, no_outpdf):
|
|
infile = resources / 'masks.pdf'
|
|
for bad_lang in ['osd', 'equ']:
|
|
with pytest.raises(BadArgsError):
|
|
run_ocrmypdf_api(infile, no_outpdf, '-l', bad_lang)
|