1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
import io
import os
from pathlib import Path
import pytest
import PyPDF2._utils
from PyPDF2 import PdfReader
from PyPDF2._utils import (
File,
_get_max_pdf_version_header,
_human_readable_bytes,
deprecate_bookmark,
mark_location,
matrix_multiply,
read_block_backwards,
read_previous_line,
read_until_regex,
read_until_whitespace,
skip_over_comment,
skip_over_whitespace,
)
from PyPDF2.errors import PdfReadError, PdfStreamError
from . import get_pdf_from_url
TESTS_ROOT = Path(__file__).parent.resolve()
PROJECT_ROOT = TESTS_ROOT.parent
RESOURCE_ROOT = PROJECT_ROOT / "resources"
@pytest.mark.parametrize(
("stream", "expected"),
[
(io.BytesIO(b"foo"), False),
(io.BytesIO(b""), False),
(io.BytesIO(b" "), True),
(io.BytesIO(b" "), True),
(io.BytesIO(b" \n"), True),
(io.BytesIO(b" \n"), True),
],
)
def test_skip_over_whitespace(stream, expected):
assert skip_over_whitespace(stream) == expected
def test_read_until_whitespace():
assert read_until_whitespace(io.BytesIO(b"foo"), maxchars=1) == b"f"
@pytest.mark.parametrize(
("stream", "remainder"),
[
(io.BytesIO(b"% foobar\n"), b""),
(io.BytesIO(b""), b""),
(io.BytesIO(b" "), b" "),
(io.BytesIO(b"% foo%\nbar"), b"bar"),
],
)
def test_skip_over_comment(stream, remainder):
skip_over_comment(stream)
assert stream.read() == remainder
def test_read_until_regex_premature_ending_raise():
import re
stream = io.BytesIO(b"")
with pytest.raises(PdfStreamError) as exc:
read_until_regex(stream, re.compile(b"."))
assert exc.value.args[0] == "Stream has ended unexpectedly"
def test_read_until_regex_premature_ending_name():
import re
stream = io.BytesIO(b"")
assert read_until_regex(stream, re.compile(b"."), ignore_eof=True) == b""
@pytest.mark.parametrize(
("a", "b", "expected"),
[
(((3,),), ((7,),), ((21,),)),
(((3, 7),), ((5,), (13,)), ((3 * 5.0 + 7 * 13,),)),
(((3,), (7,)), ((5, 13),), ((3 * 5, 3 * 13), (7 * 5, 7 * 13))),
],
)
def test_matrix_multiply(a, b, expected):
assert matrix_multiply(a, b) == expected
def test_mark_location():
stream = io.BytesIO(b"abde" * 6000)
mark_location(stream)
os.remove("PyPDF2_pdfLocation.txt") # cleanup
def test_hex_str():
assert PyPDF2._utils.hex_str(10) == "0xa"
def test_b():
assert PyPDF2._utils.b_("foo") == b"foo"
assert PyPDF2._utils.b_("π") == "π".encode()
assert PyPDF2._utils.b_("β°") == "β°".encode()
assert PyPDF2._utils.b_("β·") == "β·".encode()
assert PyPDF2._utils.b_("δΈ") == "δΈ".encode()
def test_deprecate_no_replacement():
with pytest.warns(PendingDeprecationWarning) as warn:
PyPDF2._utils.deprecate_no_replacement("foo")
error_msg = "foo is deprecated and will be removed in PyPDF2 3.0.0."
assert warn[0].message.args[0] == error_msg
@pytest.mark.parametrize(
("left", "up", "upleft", "expected"),
[
(0, 0, 0, 0),
(1, 0, 0, 1),
(0, 1, 0, 1),
(0, 0, 1, 0),
(1, 2, 3, 1),
(2, 1, 3, 1),
(1, 3, 2, 2),
(3, 1, 2, 2),
(3, 2, 1, 3),
],
)
def test_paeth_predictor(left, up, upleft, expected):
assert PyPDF2._utils.paeth_predictor(left, up, upleft) == expected
@pytest.mark.parametrize(
("dat", "pos", "to_read"),
[
(b"", 0, 1),
(b"a", 0, 1),
(b"abc", 0, 10),
],
)
def test_read_block_backwards_errs(dat, pos, to_read):
with pytest.raises(PdfStreamError) as _:
s = io.BytesIO(dat)
s.seek(pos)
read_block_backwards(s, to_read)
@pytest.mark.parametrize(
("dat", "pos", "to_read", "expected", "expected_pos"),
[
(b"abc", 1, 0, b"", 1),
(b"abc", 1, 1, b"a", 0),
(b"abc", 2, 1, b"b", 1),
(b"abc", 2, 2, b"ab", 0),
(b"abc", 3, 1, b"c", 2),
(b"abc", 3, 2, b"bc", 1),
(b"abc", 3, 3, b"abc", 0),
],
)
def test_read_block_backwards(dat, pos, to_read, expected, expected_pos):
s = io.BytesIO(dat)
s.seek(pos)
assert read_block_backwards(s, to_read) == expected
assert s.tell() == expected_pos
def test_read_block_backwards_at_start():
s = io.BytesIO(b"abc")
with pytest.raises(PdfStreamError) as _:
read_previous_line(s)
@pytest.mark.parametrize(
("dat", "pos", "expected", "expected_pos"),
[
(b"abc", 1, b"a", 0),
(b"abc", 2, b"ab", 0),
(b"abc", 3, b"abc", 0),
(b"abc\n", 3, b"abc", 0),
(b"abc\n", 4, b"", 3),
(b"abc\n\r", 4, b"", 3),
(b"abc\nd", 5, b"d", 3),
# Skip over multiple CR/LF bytes
(b"abc\n\r\ndef", 9, b"def", 3),
],
ids=list(range(8)),
)
def test_read_previous_line(dat, pos, expected, expected_pos):
s = io.BytesIO(dat)
s.seek(pos)
assert read_previous_line(s) == expected
assert s.tell() == expected_pos
# for unknown reason if the parameters are passed through pytest, errors are reported
def test_read_previous_line2():
# Include a block full of newlines...
test_read_previous_line(
b"abc" + b"\n" * (2 * io.DEFAULT_BUFFER_SIZE) + b"d",
2 * io.DEFAULT_BUFFER_SIZE + 4,
b"d",
3,
)
# Include a block full of non-newline characters
test_read_previous_line(
b"abc\n" + b"d" * (2 * io.DEFAULT_BUFFER_SIZE),
2 * io.DEFAULT_BUFFER_SIZE + 4,
b"d" * (2 * io.DEFAULT_BUFFER_SIZE),
3,
)
# Both
test_read_previous_line(
b"abcxyz"
+ b"\n" * (2 * io.DEFAULT_BUFFER_SIZE)
+ b"d" * (2 * io.DEFAULT_BUFFER_SIZE),
4 * io.DEFAULT_BUFFER_SIZE + 6,
b"d" * (2 * io.DEFAULT_BUFFER_SIZE),
6,
)
def test_get_max_pdf_version_header():
with pytest.raises(ValueError) as exc:
_get_max_pdf_version_header(b"", b"PDF-1.2")
assert exc.value.args[0] == "neither b'' nor b'PDF-1.2' are proper headers"
def test_read_block_backwards_exception():
stream = io.BytesIO(b"foobar")
stream.seek(6)
with pytest.raises(PdfReadError) as exc:
read_block_backwards(stream, 7)
assert exc.value.args[0] == "Could not read malformed PDF file"
def test_deprecate_bookmark():
@deprecate_bookmark(old_param="new_param")
def foo(old_param=1, baz=2):
return old_param * baz
with pytest.raises(TypeError) as exc:
foo(old_param=12, new_param=13)
expected_msg = (
"foo received both old_param and new_param as an argument. "
"old_param is deprecated. Use new_param instead."
)
assert exc.value.args[0] == expected_msg
@pytest.mark.external
def test_escapedcode_followed_by_int():
# iss #1294
url = "https://github.com/timedegree/playground_files/raw/main/%E8%AE%BA%E6%96%87/AN%20EXACT%20ANALYTICAL%20SOLUTION%20OF%20KEPLER'S%20EQUATION.pdf"
name = "keppler.pdf"
return
reader = PdfReader(io.BytesIO(get_pdf_from_url(url, name=name)))
for page in reader.pages:
page.extract_text()
@pytest.mark.parametrize(
("input_int", "expected_output"),
[
(123, "123 Byte"),
(1234, "1.2 kB"),
(123_456, "123.5 kB"),
(1_234_567, "1.2 MB"),
(1_234_567_890, "1.2 GB"),
(1_234_567_890_000, "1234.6 GB"),
],
)
def test_human_readable_bytes(input_int, expected_output):
assert _human_readable_bytes(input_int) == expected_output
def test_file():
f = File(name="image.png", data=b"")
assert str(f) == "File(name=image.png, data: 0 Byte)"
assert repr(f) == "File(name=image.png, data: 0 Byte, hash: 0)"
|