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 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
|
import io
import os
import codecs
import random
import string
from tempfile import mkdtemp
from unittest import TestCase
from zipfile import ZipFile, ZIP_DEFLATED
from boltons import ioutils
CUR_FILE_PATH = os.path.abspath(__file__)
class AssertionsMixin:
def assertIsNone(self, item, msg=None):
self.assertTrue(item is None, msg)
class BaseTestMixin:
"""
A set of tests that work the same for SpooledBtyesIO and SpooledStringIO
"""
def test_getvalue_norollover(self):
"""Make sure getvalue function works with in-memory flo"""
self.spooled_flo.write(self.test_str)
self.assertEqual(self.spooled_flo.getvalue(), self.test_str)
def test_getvalue_rollover(self):
"""Make sure getvalue function works with on-disk flo"""
self.spooled_flo.write(self.test_str)
self.assertFalse(self.spooled_flo._rolled)
self.spooled_flo.rollover()
self.assertEqual(self.spooled_flo.getvalue(), self.test_str)
self.assertTrue(self.spooled_flo._rolled)
def test_rollover_custom_directory(self):
"""dir keyword argument is passed to TemporaryFile instantiation"""
custom_dir = mkdtemp()
try:
# Re-instantiate self.spooled_flo with the custom dir argument
_spooled_flo = type(self.spooled_flo)(dir=custom_dir)
self.assertEqual(_spooled_flo._dir, custom_dir)
# TemporaryFile is kind of a black box, we can't really test it
# since the directory entry for the file is removed immediately
# after the file is created. So we can't check path using fd.name
# or listdir(custom_dir). We could either convert rollover() to
# use NamedtemporaryFile-s or assume it's well tested enough that
# passing dir= into the constructor will work as expected. We'll
# call rollover() with the dir attribute set just to ensure
# nothing has gone absurdly wrong.
_spooled_flo.write(self.test_str)
_spooled_flo.rollover()
self.assertEqual(_spooled_flo.getvalue(), self.test_str)
self.assertTrue(_spooled_flo._rolled)
_spooled_flo.close()
finally:
os.rmdir(custom_dir)
def test_compare_err(self):
"""Read-heads are reset if a comparison raises an error."""
def _monkey_err(*args, **kwargs):
raise Exception('A sad error has occurred today')
a = self.spooled_flo.__class__()
a.write(self.test_str)
b = self.spooled_flo.__class__()
b.write(self.test_str)
a.seek(1)
b.seek(2)
b.__next__ = _monkey_err
try:
a == b
except Exception:
pass
self.assertEqual(a.tell(), 1)
self.assertEqual(b.tell(), 2)
def test_truncate_noargs_norollover(self):
"""Test truncating with no args with in-memory flo"""
self.spooled_flo.write(self.test_str)
self.spooled_flo.seek(10)
self.spooled_flo.truncate()
self.assertEqual(self.spooled_flo.getvalue(), self.test_str[:10])
def test_truncate_noargs_rollover(self):
"""Test truncating with no args with on-disk flo"""
self.spooled_flo.write(self.test_str)
self.spooled_flo.seek(10)
self.spooled_flo.rollover()
self.spooled_flo.truncate()
self.assertEqual(self.spooled_flo.getvalue(), self.test_str[:10])
def test_truncate_with_args_norollover(self):
"""Test truncating to a value with in-memory flo"""
self.spooled_flo.write(self.test_str)
self.spooled_flo.seek(5)
self.spooled_flo.truncate(10)
self.assertEqual(self.spooled_flo.getvalue(), self.test_str[:10])
def test_truncate_with_args_rollover(self):
"""Test truncating to a value with on-disk flo"""
self.spooled_flo.write(self.test_str)
self.spooled_flo.seek(5)
self.spooled_flo.rollover()
self.spooled_flo.truncate(10)
self.assertEqual(self.spooled_flo.getvalue(), self.test_str[:10])
def test_type_error_too_many_args(self):
"""Make sure TypeError raised if too many args passed to truncate"""
self.spooled_flo.write(self.test_str)
self.assertRaises(TypeError, self.spooled_flo.truncate, 0, 10)
def test_io_error_negative_truncate(self):
"""Make sure IOError raised trying to truncate with negative value"""
self.spooled_flo.write(self.test_str)
self.assertRaises(IOError, self.spooled_flo.truncate, -1)
def test_compare_different_instances(self):
"""Make sure two different instance types are not considered equal"""
a = ioutils.SpooledBytesIO()
a.write(b"I am equal!")
b = ioutils.SpooledStringIO()
b.write("I am equal!")
self.assertNotEqual(a, b)
def test_compare_unequal_instances(self):
"""Comparisons of non-SpooledIOBase classes should fail"""
self.assertNotEqual("Bummer dude", self.spooled_flo)
def test_set_softspace_attribute(self):
"""Ensure softspace attribute can be retrieved and set"""
self.spooled_flo.softspace = True
self.assertTrue(self.spooled_flo.softspace)
def test_set_softspace_attribute_rolled(self):
"""Ensure softspace attribute can be retrieved and set if rolled"""
self.spooled_flo.softspace = True
self.assertTrue(self.spooled_flo.softspace)
self.spooled_flo.rollover()
self.spooled_flo.softspace = True
self.assertTrue(self.spooled_flo.softspace)
def test_buf_property(self):
"""'buf' property returns the same value as getvalue()"""
self.assertEqual(self.spooled_flo.buf, self.spooled_flo.getvalue())
def test_pos_property(self):
"""'pos' property returns the same value as tell()"""
self.assertEqual(self.spooled_flo.pos, self.spooled_flo.tell())
def test_closed_property(self):
"""'closed' property works as expected"""
self.assertFalse(self.spooled_flo.closed)
self.spooled_flo.close()
self.assertTrue(self.spooled_flo.closed)
def test_readline(self):
"""Make readline returns expected values"""
self.spooled_flo.write(self.test_str_lines)
self.spooled_flo.seek(0)
self.assertEqual(self.spooled_flo.readline().rstrip(self.linesep),
self.test_str_lines.split(self.linesep)[0])
def test_readlines(self):
"""Make sure readlines returns expected values"""
self.spooled_flo.write(self.test_str_lines)
self.spooled_flo.seek(0)
self.assertEqual(
[x.rstrip(self.linesep) for x in self.spooled_flo.readlines()],
self.test_str_lines.split(self.linesep)
)
def test_next(self):
"""Make next returns expected values"""
self.spooled_flo.write(self.test_str_lines)
self.spooled_flo.seek(0)
self.assertEqual(self.spooled_flo.next().rstrip(self.linesep),
self.test_str_lines.split(self.linesep)[0])
def test_isatty(self):
"""Make sure we can check if the value is a tty"""
# This should simply not fail
self.assertTrue(self.spooled_flo.isatty() is True or
self.spooled_flo.isatty() is False)
def test_truthy(self):
"""Make sure empty instances are still considered truthy"""
self.spooled_flo.seek(0)
self.spooled_flo.truncate()
if not self.spooled_flo:
raise AssertionError("Instance is not truthy")
def test_instance_check(self):
"""Instance checks against IOBase succeed."""
if not isinstance(self.spooled_flo, io.IOBase):
raise AssertionError(f'{type(self.spooled_flo)} is not an instance of IOBase')
def test_closed_file_method_valueerrors(self):
"""ValueError raised on closed files for certain methods."""
self.spooled_flo.close()
methods = (
'flush', 'isatty', 'pos', 'buf', 'truncate', '__next__', '__iter__',
'__enter__', 'read', 'readline', 'tell',
)
for method_name in methods:
with self.assertRaises(ValueError):
getattr(self.spooled_flo, method_name)()
class TestSpooledBytesIO(TestCase, BaseTestMixin, AssertionsMixin):
linesep = os.linesep.encode('ascii')
def setUp(self):
self.spooled_flo = ioutils.SpooledBytesIO()
self.test_str = b"Armado en los EE, UU. para S. P. Richards co.,"
self.test_str_lines = (
f"Text with:{os.linesep}newlines!".encode('ascii')
)
self.data_type = bytes
def test_compare_not_equal_instances(self):
"""Make sure instances with different values fail == check."""
a = ioutils.SpooledBytesIO()
a.write(b"I am a!")
b = ioutils.SpooledBytesIO()
b.write(b"I am b!")
self.assertNotEqual(a, b)
def test_compare_two_equal_instances(self):
"""Make sure we can compare instances"""
a = ioutils.SpooledBytesIO()
a.write(b"I am equal!")
b = ioutils.SpooledBytesIO()
b.write(b"I am equal!")
self.assertEqual(a, b)
def test_auto_rollover(self):
"""Make sure file rolls over to disk after max_size reached"""
tmp = ioutils.SpooledBytesIO(max_size=10)
tmp.write(b"The quick brown fox jumped over the lazy dogs.")
self.assertTrue(tmp._rolled)
def test_use_as_context_mgr(self):
"""Make sure SpooledBytesIO can be used as a context manager"""
test_str = b"Armado en los EE, UU. para S. P. Richards co.,"
with ioutils.SpooledBytesIO() as f:
f.write(test_str)
self.assertEqual(f.getvalue(), test_str)
def test_len_no_rollover(self):
"""Make sure len works with in-memory flo"""
self.spooled_flo.write(self.test_str)
self.assertEqual(self.spooled_flo.len, len(self.test_str))
self.assertEqual(len(self.spooled_flo), len(self.test_str))
def test_len_rollover(self):
"""Make sure len works with on-disk flo"""
self.spooled_flo.write(self.test_str)
self.spooled_flo.rollover()
self.assertEqual(self.spooled_flo.len, len(self.test_str))
self.assertEqual(len(self.spooled_flo), len(self.test_str))
def test_invalid_type(self):
"""Ensure TypeError raised when writing unicode to SpooledBytesIO"""
self.assertRaises(TypeError, self.spooled_flo.write, "hi")
def test_flush_after_rollover(self):
"""Make sure we can flush before and after rolling to a real file"""
self.spooled_flo.write(self.test_str)
self.assertIsNone(self.spooled_flo.flush())
self.spooled_flo.rollover()
self.assertIsNone(self.spooled_flo.flush())
def test_zip_compat(self):
"""Make sure object is compatible with ZipFile library"""
self.spooled_flo.seek(0)
self.spooled_flo.truncate()
doc = ZipFile(self.spooled_flo, 'w', ZIP_DEFLATED)
doc.writestr("content.txt", "test")
self.assertTrue('content.txt' in doc.namelist())
doc.close()
def test_iter(self):
"""Make sure iter works as expected"""
self.spooled_flo.write(b"a\nb")
self.spooled_flo.seek(0)
self.assertEqual([x for x in self.spooled_flo], [b"a\n", b"b"])
def test_writelines(self):
"""An iterable of lines can be written"""
lines = [b"1", b"2", b"3"]
expected = b"123"
self.spooled_flo.writelines(lines)
self.assertEqual(self.spooled_flo.getvalue(), expected)
class TestSpooledStringIO(TestCase, BaseTestMixin, AssertionsMixin):
linesep = os.linesep
def setUp(self):
self.spooled_flo = ioutils.SpooledStringIO()
self.test_str = "Remember kids, always use an emdash: '\u2014'"
self.test_str_lines = f"Text with\u2014{os.linesep}newlines!"
self.data_type = str
def test_compare_not_equal_instances(self):
"""Make sure instances with different values fail == check."""
a = ioutils.SpooledStringIO()
a.write("I am a!")
b = ioutils.SpooledStringIO()
b.write("I am b!")
self.assertNotEqual(a, b)
def test_compare_two_equal_instances(self):
"""Make sure we can compare instances"""
a = ioutils.SpooledStringIO()
a.write("I am equal!")
b = ioutils.SpooledStringIO()
b.write("I am equal!")
self.assertEqual(a, b)
def test_auto_rollover(self):
"""Make sure file rolls over to disk after max_size reached"""
tmp = ioutils.SpooledStringIO(max_size=10)
tmp.write("The quick brown fox jumped over the lazy dogs.")
self.assertTrue(tmp._rolled)
def test_use_as_context_mgr(self):
"""Make sure SpooledStringIO can be used as a context manager"""
test_str = "Armado en los EE, UU. para S. P. Richards co.,"
with ioutils.SpooledStringIO() as f:
f.write(test_str)
self.assertEqual(f.getvalue(), test_str)
def test_len_no_rollover(self):
"""Make sure len property works with in-memory flo"""
self.spooled_flo.write(self.test_str)
self.assertEqual(self.spooled_flo.len, len(self.test_str))
def test_len_rollover(self):
"""Make sure len property works with on-disk flo"""
self.spooled_flo.write(self.test_str)
self.spooled_flo.rollover()
self.assertEqual(self.spooled_flo.len, len(self.test_str))
def test_invalid_type(self):
"""Ensure TypeError raised when writing bytes to SpooledStringIO"""
self.assertRaises(TypeError, self.spooled_flo.write, b"hi")
def test_tell_codepoints(self):
"""Verify tell() returns codepoint position, not bytes position"""
self.spooled_flo.write(self.test_str)
self.spooled_flo.seek(0)
self.spooled_flo.read(40)
self.assertEqual(self.spooled_flo.tell(), 40)
self.spooled_flo.seek(10)
self.assertEqual(self.spooled_flo.tell(), 10)
def test_codepoints_all_enc(self):
""""Test getting read, seek, tell, on various codepoints"""
test_str = "\u2014\u2014\u2014"
self.spooled_flo.write(test_str)
self.spooled_flo.seek(1)
self.assertEqual(self.spooled_flo.read(), "\u2014\u2014")
self.assertEqual(len(self.spooled_flo), len(test_str))
def test_seek_codepoints_SEEK_END(self):
"""Make sure seek() moves to codepoints relative to file end"""
self.spooled_flo.write(self.test_str)
ret = self.spooled_flo.seek(0, os.SEEK_END)
self.assertEqual(ret, len(self.test_str))
def test_seek_codepoints_large_SEEK_END(self):
"""Make sure seek() moves to codepoints relative to file end"""
test_str = "".join(random.choice(string.ascii_letters) for
x in range(34000))
self.spooled_flo.write(test_str)
ret = self.spooled_flo.seek(0, os.SEEK_END)
self.assertEqual(ret, len(test_str))
def test_seek_codepoints_SEEK_SET(self):
"""Make sure seek() moves to codepoints relative to file start"""
self.spooled_flo.write(self.test_str)
ret = self.spooled_flo.seek(3, os.SEEK_SET)
self.assertEqual(ret, 3)
def test_seek_codepoints_large_SEEK_SET(self):
"""Make sure seek() moves to codepoints relative to file start"""
test_str = "".join(random.choice(string.ascii_letters) for
x in range(34000))
self.spooled_flo.write(test_str)
ret = self.spooled_flo.seek(33000, os.SEEK_SET)
self.assertEqual(ret, 33000)
def test_seek_codepoints_SEEK_CUR(self):
"""Make sure seek() moves to codepoints relative to current_position"""
test_str = "\u2014\u2014\u2014"
self.spooled_flo.write(test_str)
self.spooled_flo.seek(1)
self.assertEqual(self.spooled_flo.tell(), 1)
ret = self.spooled_flo.seek(2, os.SEEK_CUR)
self.assertEqual(ret, 3)
def test_seek_codepoints_large_SEEK_CUR(self):
"""Make sure seek() moves to codepoints relative to current_position"""
test_str = "".join(random.choice(string.ascii_letters) for
x in range(34000))
self.spooled_flo.write(test_str)
self.spooled_flo.seek(1)
ret = self.spooled_flo.seek(33000, os.SEEK_CUR)
self.assertEqual(ret, 33001)
def test_x80_codepoint(self):
"""Make sure x80 codepoint doesn't confuse read value"""
test_str = '\x8000'
self.spooled_flo.write(test_str)
self.spooled_flo.seek(0)
self.assertEqual(len(self.spooled_flo.read(2)), 2)
self.assertEqual(self.spooled_flo.read(), '0')
def test_seek_encoded(self):
"""Make sure reading works when bytes exceeds read val"""
test_str = "\u2014\u2014\u2014"
self.spooled_flo.write(test_str)
self.spooled_flo.seek(0)
self.assertEqual(self.spooled_flo.read(3), test_str)
def test_iter(self):
"""Make sure iter works as expected"""
self.spooled_flo.write("a\nb")
self.spooled_flo.seek(0)
self.assertEqual([x for x in self.spooled_flo], ["a\n", "b"])
def test_writelines(self):
"""An iterable of lines can be written"""
lines = ["1", "2", "3"]
expected = "123"
self.spooled_flo.writelines(lines)
self.assertEqual(self.spooled_flo.getvalue(), expected)
class TestMultiFileReader(TestCase):
def test_read_seek_bytes(self):
r = ioutils.MultiFileReader(io.BytesIO(b'narf'), io.BytesIO(b'troz'))
self.assertEqual([b'nar', b'ftr', b'oz'],
list(iter(lambda: r.read(3), b'')))
r.seek(0)
self.assertEqual(b'narftroz', r.read())
def test_read_seek_text(self):
r = ioutils.MultiFileReader(io.StringIO('narf'),
io.StringIO('troz'))
self.assertEqual(['nar', 'ftr', 'oz'],
list(iter(lambda: r.read(3), '')))
r.seek(0)
self.assertEqual('narftroz', r.read())
def test_no_mixed_bytes_and_text(self):
self.assertRaises(ValueError, ioutils.MultiFileReader,
io.BytesIO(b'narf'), io.StringIO('troz'))
def test_open(self):
with open(CUR_FILE_PATH) as f:
r_file_str = f.read()
with open(CUR_FILE_PATH) as f1:
with open(CUR_FILE_PATH) as f2:
mfr = ioutils.MultiFileReader(f1, f2)
r_double_file_str = mfr.read()
assert r_double_file_str == (r_file_str * 2)
with open(CUR_FILE_PATH, 'rb') as f:
rb_file_str = f.read()
with open(CUR_FILE_PATH, 'rb') as f1:
with open(CUR_FILE_PATH, 'rb') as f2:
mfr = ioutils.MultiFileReader(f1, f2)
rb_double_file_str = mfr.read()
assert rb_double_file_str == (rb_file_str * 2)
utf8_file_str = codecs.open(CUR_FILE_PATH, encoding='utf8').read()
f1, f2 = (codecs.open(CUR_FILE_PATH, encoding='utf8'),
codecs.open(CUR_FILE_PATH, encoding='utf8'))
mfr = ioutils.MultiFileReader(f1, f2)
utf8_double_file_str = mfr.read()
assert utf8_double_file_str == (utf8_file_str * 2)
|