Files
OCRmyPDF/tests/test_page_numbers.py
James R. Barlow 9748208e68 Support 'end' alias for last page in --pages
Closes #1615. The token 'end' (case-insensitive) is now accepted as an
alias for the document's last page, e.g. --pages 3-end. Resolution is
deferred until the page count is known from the input PDF.
2026-05-26 12:18:09 -07:00

123 lines
3.2 KiB
Python

# SPDX-FileCopyrightText: 2022 James R. Barlow
# SPDX-License-Identifier: MPL-2.0
from __future__ import annotations
import pytest
import ocrmypdf
from ocrmypdf._options import _pages_from_ranges
from ocrmypdf.exceptions import BadArgsError
from ocrmypdf.pdfinfo import PdfInfo
@pytest.mark.parametrize(
'pages, result',
[
['1', {0}],
['1,2', {0, 1}],
['1-3', {0, 1, 2}],
['2,5,6', {1, 4, 5}],
['11-15, 18, ', {10, 11, 12, 13, 14, 17}],
[',,3', {2}],
['3, 3, 3, 3,', {2}],
['3, 2, 1, 42', {0, 1, 2, 41}],
['-1', BadArgsError],
['1,3,-11', BadArgsError],
['1-,', BadArgsError],
['start-end', BadArgsError],
['1-0', BadArgsError],
['99-98', BadArgsError],
['0-0', BadArgsError],
['1-0,3-4', BadArgsError],
[',', BadArgsError],
['', BadArgsError],
],
)
def test_pages(pages, result):
if isinstance(result, type):
with pytest.raises(result):
_pages_from_ranges(pages)
else:
assert _pages_from_ranges(pages) == result
@pytest.mark.parametrize(
'pages, total_pages, result',
[
['end', 10, {9}],
['END', 10, {9}],
['1-end', 3, {0, 1, 2}],
['3-end', 5, {2, 3, 4}],
['end-end', 7, {6}],
['1,end', 4, {0, 3}],
['2-4,end', 10, {1, 2, 3, 9}],
['end,end,end', 5, {4}],
['end-1', 5, BadArgsError], # empty range when end > 1
],
)
def test_pages_end_alias(pages, total_pages, result):
if isinstance(result, type):
with pytest.raises(result):
_pages_from_ranges(pages, total_pages=total_pages)
else:
assert _pages_from_ranges(pages, total_pages=total_pages) == result
def test_end_alias_requires_total_pages():
with pytest.raises(BadArgsError, match="total page count"):
_pages_from_ranges('1-end')
with pytest.raises(BadArgsError, match="total page count"):
_pages_from_ranges('end')
def test_nonmonotonic_warning(caplog):
pages = _pages_from_ranges('1, 3, 2')
assert pages == {0, 1, 2}
assert 'out of order' in caplog.text
def test_limited_pages(multipage, outpdf):
ocrmypdf.ocr(
multipage,
outpdf,
pages='5-6',
optimize=0,
output_type='pdf',
plugins=['tests/plugins/tesseract_cache.py'],
)
pi = PdfInfo(outpdf)
assert not pi.pages[0].has_text
assert pi.pages[4].has_text
assert pi.pages[5].has_text
def test_limited_pages_end_alias(multipage, outpdf):
# multipage has 6 pages; 5-end == pages 5..6
ocrmypdf.ocr(
multipage,
outpdf,
pages='5-end',
optimize=0,
output_type='pdf',
plugins=['tests/plugins/tesseract_cache.py'],
)
pi = PdfInfo(outpdf)
assert not pi.pages[0].has_text
assert pi.pages[4].has_text
assert pi.pages[5].has_text
def test_pages_end_alone(multipage, outpdf):
ocrmypdf.ocr(
multipage,
outpdf,
pages='end',
optimize=0,
output_type='pdf',
plugins=['tests/plugins/tesseract_cache.py'],
)
pi = PdfInfo(outpdf)
assert not pi.pages[0].has_text
assert pi.pages[5].has_text