test_io.py 141 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
"""Unit tests for the io module."""

# Tests of io are scattered over the test suite:
# * test_bufio - tests file buffering
# * test_memoryio - tests BytesIO and StringIO
# * test_fileio - tests FileIO
# * test_file - tests the file interface
# * test_io - tests everything else in the io module
# * test_univnewlines - tests universal newline support
# * test_largefile - tests operations on a file greater than 2**32 bytes
#     (only enabled with -ulargefile)

################################################################################
# ATTENTION TEST WRITERS!!!
################################################################################
# When writing tests for io, it's important to test both the C and Python
# implementations. This is usually done by writing a base test that refers to
18
# the type it is testing as an attribute. Then it provides custom subclasses to
19 20
# test both implementations. This file has lots of examples.
################################################################################
21

22 23 24 25
import abc
import array
import errno
import locale
26
import os
27 28 29
import pickle
import random
import signal
30
import sys
31
import time
32
import unittest
33
import warnings
34
import weakref
35
from collections import deque, UserList
36
from itertools import cycle, count
37
from test import support
38
from test.support.script_helper import assert_python_ok, run_python_until_end
Guido van Rossum's avatar
Guido van Rossum committed
39

40
import codecs
41 42
import io  # C implementation of io
import _pyio as pyio # Python implementation of io
43 44 45 46
try:
    import threading
except ImportError:
    threading = None
47

48 49
def _default_chunk_size():
    """Get the default TextIOWrapper chunk size"""
50
    with open(__file__, "r", encoding="latin-1") as f:
51 52 53
        return f._CHUNK_SIZE


54 55 56
class MockRawIOWithoutRead:
    """A RawIO implementation without read(), so as to exercise the default
    RawIO.read() which calls readinto()."""
57

Guido van Rossum's avatar
Guido van Rossum committed
58 59 60
    def __init__(self, read_stack=()):
        self._read_stack = list(read_stack)
        self._write_stack = []
61
        self._reads = 0
62
        self._extraneous_reads = 0
63

64
    def write(self, b):
65
        self._write_stack.append(bytes(b))
66 67 68 69 70
        return len(b)

    def writable(self):
        return True

71 72 73 74 75 76
    def fileno(self):
        return 42

    def readable(self):
        return True

77
    def seekable(self):
78 79
        return True

80
    def seek(self, pos, whence):
81
        return 0   # wrong but we gotta return something
82 83

    def tell(self):
84 85 86 87 88 89 90 91
        return 0   # same comment as above

    def readinto(self, buf):
        self._reads += 1
        max_len = len(buf)
        try:
            data = self._read_stack[0]
        except IndexError:
92
            self._extraneous_reads += 1
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
            return 0
        if data is None:
            del self._read_stack[0]
            return None
        n = len(data)
        if len(data) <= max_len:
            del self._read_stack[0]
            buf[:n] = data
            return n
        else:
            buf[:] = data[:max_len]
            self._read_stack[0] = data[max_len:]
            return max_len

    def truncate(self, pos=None):
        return pos

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
class CMockRawIOWithoutRead(MockRawIOWithoutRead, io.RawIOBase):
    pass

class PyMockRawIOWithoutRead(MockRawIOWithoutRead, pyio.RawIOBase):
    pass


class MockRawIO(MockRawIOWithoutRead):

    def read(self, n=None):
        self._reads += 1
        try:
            return self._read_stack.pop(0)
        except:
            self._extraneous_reads += 1
            return b""

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
class CMockRawIO(MockRawIO, io.RawIOBase):
    pass

class PyMockRawIO(MockRawIO, pyio.RawIOBase):
    pass


class MisbehavedRawIO(MockRawIO):
    def write(self, b):
        return super().write(b) * 2

    def read(self, n=None):
        return super().read(n) * 2

    def seek(self, pos, whence):
        return -123

    def tell(self):
        return -456

    def readinto(self, buf):
        super().readinto(buf)
        return len(buf) * 5

class CMisbehavedRawIO(MisbehavedRawIO, io.RawIOBase):
    pass

class PyMisbehavedRawIO(MisbehavedRawIO, pyio.RawIOBase):
    pass


class CloseFailureIO(MockRawIO):
    closed = 0

    def close(self):
        if not self.closed:
            self.closed = 1
164
            raise OSError
165 166 167

class CCloseFailureIO(CloseFailureIO, io.RawIOBase):
    pass
168

169 170
class PyCloseFailureIO(CloseFailureIO, pyio.RawIOBase):
    pass
171

172 173

class MockFileIO:
174 175 176

    def __init__(self, data):
        self.read_history = []
177
        super().__init__(data)
178 179

    def read(self, n=None):
180
        res = super().read(n)
181 182 183
        self.read_history.append(None if res is None else len(res))
        return res

184 185 186 187 188 189 190 191 192 193
    def readinto(self, b):
        res = super().readinto(b)
        self.read_history.append(res)
        return res

class CMockFileIO(MockFileIO, io.BytesIO):
    pass

class PyMockFileIO(MockFileIO, pyio.BytesIO):
    pass
194

195

196 197 198 199 200 201 202 203 204 205
class MockUnseekableIO:
    def seekable(self):
        return False

    def seek(self, *args):
        raise self.UnsupportedOperation("not seekable")

    def tell(self, *args):
        raise self.UnsupportedOperation("not seekable")

206 207 208
    def truncate(self, *args):
        raise self.UnsupportedOperation("not seekable")

209 210 211 212 213 214 215
class CMockUnseekableIO(MockUnseekableIO, io.BytesIO):
    UnsupportedOperation = io.UnsupportedOperation

class PyMockUnseekableIO(MockUnseekableIO, pyio.BytesIO):
    UnsupportedOperation = pyio.UnsupportedOperation


216 217 218
class MockNonBlockWriterIO:

    def __init__(self):
219
        self._write_stack = []
220
        self._blocker_char = None
221

222 223 224 225 226 227 228 229 230 231 232 233 234 235
    def pop_written(self):
        s = b"".join(self._write_stack)
        self._write_stack[:] = []
        return s

    def block_on(self, char):
        """Block when a given char is encountered."""
        self._blocker_char = char

    def readable(self):
        return True

    def seekable(self):
        return True
236

237 238
    def writable(self):
        return True
239

240 241 242 243 244 245 246 247 248
    def write(self, b):
        b = bytes(b)
        n = -1
        if self._blocker_char:
            try:
                n = b.index(self._blocker_char)
            except ValueError:
                pass
            else:
249 250 251 252 253 254 255 256
                if n > 0:
                    # write data up to the first blocker
                    self._write_stack.append(b[:n])
                    return n
                else:
                    # cancel blocker and indicate would block
                    self._blocker_char = None
                    return None
257 258 259 260 261 262 263 264 265
        self._write_stack.append(b)
        return len(b)

class CMockNonBlockWriterIO(MockNonBlockWriterIO, io.RawIOBase):
    BlockingIOError = io.BlockingIOError

class PyMockNonBlockWriterIO(MockNonBlockWriterIO, pyio.RawIOBase):
    BlockingIOError = pyio.BlockingIOError

266

267 268
class IOTest(unittest.TestCase):

269
    def setUp(self):
270
        support.unlink(support.TESTFN)
271

272
    def tearDown(self):
273
        support.unlink(support.TESTFN)
274

275
    def write_ops(self, f):
276 277 278 279 280
        self.assertEqual(f.write(b"blah."), 5)
        f.truncate(0)
        self.assertEqual(f.tell(), 5)
        f.seek(0)

281 282 283
        self.assertEqual(f.write(b"blah."), 5)
        self.assertEqual(f.seek(0), 0)
        self.assertEqual(f.write(b"Hello."), 6)
284
        self.assertEqual(f.tell(), 6)
285
        self.assertEqual(f.seek(-1, 1), 5)
286
        self.assertEqual(f.tell(), 5)
287
        self.assertEqual(f.write(bytearray(b" world\n\n\n")), 9)
288
        self.assertEqual(f.seek(0), 0)
289
        self.assertEqual(f.write(b"h"), 1)
290 291
        self.assertEqual(f.seek(-1, 2), 13)
        self.assertEqual(f.tell(), 13)
292

293
        self.assertEqual(f.truncate(12), 12)
294
        self.assertEqual(f.tell(), 13)
295
        self.assertRaises(TypeError, f.seek, 0.0)
296

297 298 299
    def read_ops(self, f, buffered=False):
        data = f.read(5)
        self.assertEqual(data, b"hello")
300
        data = bytearray(data)
301 302 303 304 305 306 307 308
        self.assertEqual(f.readinto(data), 5)
        self.assertEqual(data, b" worl")
        self.assertEqual(f.readinto(data), 2)
        self.assertEqual(len(data), 5)
        self.assertEqual(data[:2], b"d\n")
        self.assertEqual(f.seek(0), 0)
        self.assertEqual(f.read(20), b"hello world\n")
        self.assertEqual(f.read(1), b"")
309
        self.assertEqual(f.readinto(bytearray(b"x")), 0)
310 311 312
        self.assertEqual(f.seek(-6, 2), 6)
        self.assertEqual(f.read(5), b"world")
        self.assertEqual(f.read(0), b"")
313
        self.assertEqual(f.readinto(bytearray()), 0)
314 315 316
        self.assertEqual(f.seek(-6, 1), 5)
        self.assertEqual(f.read(5), b" worl")
        self.assertEqual(f.tell(), 10)
317
        self.assertRaises(TypeError, f.seek, 0.0)
318 319 320 321 322 323 324
        if buffered:
            f.seek(0)
            self.assertEqual(f.read(), b"hello world\n")
            f.seek(6)
            self.assertEqual(f.read(), b"world\n")
            self.assertEqual(f.read(), b"")

325 326
    LARGE = 2**31

327 328 329
    def large_file_ops(self, f):
        assert f.readable()
        assert f.writable()
330 331
        self.assertEqual(f.seek(self.LARGE), self.LARGE)
        self.assertEqual(f.tell(), self.LARGE)
332
        self.assertEqual(f.write(b"xxx"), 3)
333 334
        self.assertEqual(f.tell(), self.LARGE + 3)
        self.assertEqual(f.seek(-1, 1), self.LARGE + 2)
335
        self.assertEqual(f.truncate(), self.LARGE + 2)
336 337
        self.assertEqual(f.tell(), self.LARGE + 2)
        self.assertEqual(f.seek(0, 2), self.LARGE + 2)
338
        self.assertEqual(f.truncate(self.LARGE + 1), self.LARGE + 1)
339
        self.assertEqual(f.tell(), self.LARGE + 2)
340 341
        self.assertEqual(f.seek(0, 2), self.LARGE + 1)
        self.assertEqual(f.seek(-1, 2), self.LARGE)
342 343
        self.assertEqual(f.read(2), b"x")

344 345
    def test_invalid_operations(self):
        # Try writing on a file opened in read mode and vice-versa.
346
        exc = self.UnsupportedOperation
347
        for mode in ("w", "wb"):
348
            with self.open(support.TESTFN, mode) as fp:
349 350 351 352 353 354 355 356
                self.assertRaises(exc, fp.read)
                self.assertRaises(exc, fp.readline)
        with self.open(support.TESTFN, "wb", buffering=0) as fp:
            self.assertRaises(exc, fp.read)
            self.assertRaises(exc, fp.readline)
        with self.open(support.TESTFN, "rb", buffering=0) as fp:
            self.assertRaises(exc, fp.write, b"blah")
            self.assertRaises(exc, fp.writelines, [b"blah\n"])
357
        with self.open(support.TESTFN, "rb") as fp:
358 359
            self.assertRaises(exc, fp.write, b"blah")
            self.assertRaises(exc, fp.writelines, [b"blah\n"])
360
        with self.open(support.TESTFN, "r") as fp:
361 362 363 364 365
            self.assertRaises(exc, fp.write, "blah")
            self.assertRaises(exc, fp.writelines, ["blah\n"])
            # Non-zero seeking from current or end pos
            self.assertRaises(exc, fp.seek, 1, self.SEEK_CUR)
            self.assertRaises(exc, fp.seek, -1, self.SEEK_END)
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
    def test_optional_abilities(self):
        # Test for OSError when optional APIs are not supported
        # The purpose of this test is to try fileno(), reading, writing and
        # seeking operations with various objects that indicate they do not
        # support these operations.

        def pipe_reader():
            [r, w] = os.pipe()
            os.close(w)  # So that read() is harmless
            return self.FileIO(r, "r")

        def pipe_writer():
            [r, w] = os.pipe()
            self.addCleanup(os.close, r)
            # Guarantee that we can write into the pipe without blocking
            thread = threading.Thread(target=os.read, args=(r, 100))
            thread.start()
            self.addCleanup(thread.join)
            return self.FileIO(w, "w")

        def buffered_reader():
            return self.BufferedReader(self.MockUnseekableIO())

        def buffered_writer():
            return self.BufferedWriter(self.MockUnseekableIO())

        def buffered_random():
            return self.BufferedRandom(self.BytesIO())

        def buffered_rw_pair():
            return self.BufferedRWPair(self.MockUnseekableIO(),
                self.MockUnseekableIO())

        def text_reader():
            class UnseekableReader(self.MockUnseekableIO):
                writable = self.BufferedIOBase.writable
                write = self.BufferedIOBase.write
            return self.TextIOWrapper(UnseekableReader(), "ascii")

        def text_writer():
            class UnseekableWriter(self.MockUnseekableIO):
                readable = self.BufferedIOBase.readable
                read = self.BufferedIOBase.read
            return self.TextIOWrapper(UnseekableWriter(), "ascii")

        tests = (
            (pipe_reader, "fr"), (pipe_writer, "fw"),
            (buffered_reader, "r"), (buffered_writer, "w"),
            (buffered_random, "rws"), (buffered_rw_pair, "rw"),
            (text_reader, "r"), (text_writer, "w"),
            (self.BytesIO, "rws"), (self.StringIO, "rws"),
        )
        for [test, abilities] in tests:
            if test is pipe_writer and not threading:
                continue  # Skip subtest that uses a background thread
            with self.subTest(test), test() as obj:
                readable = "r" in abilities
                self.assertEqual(obj.readable(), readable)
                writable = "w" in abilities
                self.assertEqual(obj.writable(), writable)
                seekable = "s" in abilities
                self.assertEqual(obj.seekable(), seekable)

                if isinstance(obj, self.TextIOBase):
                    data = "3"
                elif isinstance(obj, (self.BufferedIOBase, self.RawIOBase)):
                    data = b"3"
                else:
                    self.fail("Unknown base class")

                if "f" in abilities:
                    obj.fileno()
                else:
                    self.assertRaises(OSError, obj.fileno)

                if readable:
                    obj.read(1)
                    obj.read()
                else:
                    self.assertRaises(OSError, obj.read, 1)
                    self.assertRaises(OSError, obj.read)

                if writable:
                    obj.write(data)
                else:
                    self.assertRaises(OSError, obj.write, data)

                if seekable:
                    obj.tell()
                    obj.seek(0)
                else:
                    self.assertRaises(OSError, obj.tell)
                    self.assertRaises(OSError, obj.seek, 0)

                if writable and seekable:
                    obj.truncate()
                    obj.truncate(0)
                else:
                    self.assertRaises(OSError, obj.truncate)
                    self.assertRaises(OSError, obj.truncate, 0)

468 469
    def test_open_handles_NUL_chars(self):
        fn_with_NUL = 'foo\0bar'
470 471
        self.assertRaises(ValueError, self.open, fn_with_NUL, 'w')
        self.assertRaises(ValueError, self.open, bytes(fn_with_NUL, 'ascii'), 'w')
472

473
    def test_raw_file_io(self):
Benjamin Peterson's avatar
Benjamin Peterson committed
474 475 476 477 478 479 480 481 482 483
        with self.open(support.TESTFN, "wb", buffering=0) as f:
            self.assertEqual(f.readable(), False)
            self.assertEqual(f.writable(), True)
            self.assertEqual(f.seekable(), True)
            self.write_ops(f)
        with self.open(support.TESTFN, "rb", buffering=0) as f:
            self.assertEqual(f.readable(), True)
            self.assertEqual(f.writable(), False)
            self.assertEqual(f.seekable(), True)
            self.read_ops(f)
484

485
    def test_buffered_file_io(self):
Benjamin Peterson's avatar
Benjamin Peterson committed
486 487 488 489 490 491 492 493 494 495
        with self.open(support.TESTFN, "wb") as f:
            self.assertEqual(f.readable(), False)
            self.assertEqual(f.writable(), True)
            self.assertEqual(f.seekable(), True)
            self.write_ops(f)
        with self.open(support.TESTFN, "rb") as f:
            self.assertEqual(f.readable(), True)
            self.assertEqual(f.writable(), False)
            self.assertEqual(f.seekable(), True)
            self.read_ops(f, True)
496

497
    def test_readline(self):
Benjamin Peterson's avatar
Benjamin Peterson committed
498 499 500 501 502 503 504 505
        with self.open(support.TESTFN, "wb") as f:
            f.write(b"abc\ndef\nxyzzy\nfoo\x00bar\nanother line")
        with self.open(support.TESTFN, "rb") as f:
            self.assertEqual(f.readline(), b"abc\n")
            self.assertEqual(f.readline(10), b"def\n")
            self.assertEqual(f.readline(2), b"xy")
            self.assertEqual(f.readline(4), b"zzy\n")
            self.assertEqual(f.readline(), b"foo\x00bar\n")
506
            self.assertEqual(f.readline(None), b"another line")
Benjamin Peterson's avatar
Benjamin Peterson committed
507 508 509
            self.assertRaises(TypeError, f.readline, 5.3)
        with self.open(support.TESTFN, "r") as f:
            self.assertRaises(TypeError, f.readline, 5.3)
510

511
    def test_raw_bytes_io(self):
512
        f = self.BytesIO()
513 514 515
        self.write_ops(f)
        data = f.getvalue()
        self.assertEqual(data, b"hello world\n")
516
        f = self.BytesIO(data)
517
        self.read_ops(f, True)
518

519
    def test_large_file_ops(self):
520 521 522 523
        # On Windows and Mac OSX this test comsumes large resources; It takes
        # a long time to build the >2GB file and takes >2GB of disk space
        # therefore the resource must be enabled to run this test.
        if sys.platform[:3] == 'win' or sys.platform == 'darwin':
524 525 526
            support.requires(
                'largefile',
                'test requires %s bytes and a long time to run' % self.LARGE)
527 528 529 530
        with self.open(support.TESTFN, "w+b", 0) as f:
            self.large_file_ops(f)
        with self.open(support.TESTFN, "w+b") as f:
            self.large_file_ops(f)
531 532 533 534

    def test_with_open(self):
        for bufsize in (0, 1, 100):
            f = None
535
            with self.open(support.TESTFN, "wb", bufsize) as f:
536
                f.write(b"xxx")
537 538 539
            self.assertEqual(f.closed, True)
            f = None
            try:
540
                with self.open(support.TESTFN, "wb", bufsize) as f:
541 542 543 544 545 546
                    1/0
            except ZeroDivisionError:
                self.assertEqual(f.closed, True)
            else:
                self.fail("1/0 didn't raise an exception")

547 548
    # issue 5008
    def test_append_mode_tell(self):
549
        with self.open(support.TESTFN, "wb") as f:
550
            f.write(b"xxx")
551
        with self.open(support.TESTFN, "ab", buffering=0) as f:
552
            self.assertEqual(f.tell(), 3)
553
        with self.open(support.TESTFN, "ab") as f:
554
            self.assertEqual(f.tell(), 3)
555
        with self.open(support.TESTFN, "a") as f:
556
            self.assertGreater(f.tell(), 0)
557

558 559
    def test_destructor(self):
        record = []
560
        class MyFileIO(self.FileIO):
561 562
            def __del__(self):
                record.append(1)
563 564 565 566 567 568
                try:
                    f = super().__del__
                except AttributeError:
                    pass
                else:
                    f()
569 570
            def close(self):
                record.append(2)
571
                super().close()
572 573
            def flush(self):
                record.append(3)
574
                super().flush()
575 576 577 578 579 580 581 582
        with support.check_warnings(('', ResourceWarning)):
            f = MyFileIO(support.TESTFN, "wb")
            f.write(b"xxx")
            del f
            support.gc_collect()
            self.assertEqual(record, [1, 2, 3])
            with self.open(support.TESTFN, "rb") as f:
                self.assertEqual(f.read(), b"xxx")
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609

    def _check_base_destructor(self, base):
        record = []
        class MyIO(base):
            def __init__(self):
                # This exercises the availability of attributes on object
                # destruction.
                # (in the C version, close() is called by the tp_dealloc
                # function, not by __del__)
                self.on_del = 1
                self.on_close = 2
                self.on_flush = 3
            def __del__(self):
                record.append(self.on_del)
                try:
                    f = super().__del__
                except AttributeError:
                    pass
                else:
                    f()
            def close(self):
                record.append(self.on_close)
                super().close()
            def flush(self):
                record.append(self.on_flush)
                super().flush()
        f = MyIO()
610
        del f
611
        support.gc_collect()
612 613
        self.assertEqual(record, [1, 2, 3])

614 615 616 617 618 619 620 621 622 623 624 625
    def test_IOBase_destructor(self):
        self._check_base_destructor(self.IOBase)

    def test_RawIOBase_destructor(self):
        self._check_base_destructor(self.RawIOBase)

    def test_BufferedIOBase_destructor(self):
        self._check_base_destructor(self.BufferedIOBase)

    def test_TextIOBase_destructor(self):
        self._check_base_destructor(self.TextIOBase)

626
    def test_close_flushes(self):
Benjamin Peterson's avatar
Benjamin Peterson committed
627 628 629 630
        with self.open(support.TESTFN, "wb") as f:
            f.write(b"xxx")
        with self.open(support.TESTFN, "rb") as f:
            self.assertEqual(f.read(), b"xxx")
631

632 633
    def test_array_writes(self):
        a = array.array('i', range(10))
634
        n = len(a.tobytes())
Benjamin Peterson's avatar
Benjamin Peterson committed
635 636 637 638
        with self.open(support.TESTFN, "wb", 0) as f:
            self.assertEqual(f.write(a), n)
        with self.open(support.TESTFN, "wb") as f:
            self.assertEqual(f.write(a), n)
639

640
    def test_closefd(self):
641
        self.assertRaises(ValueError, self.open, support.TESTFN, 'w',
642
                          closefd=False)
643

644 645
    def test_read_closed(self):
        with self.open(support.TESTFN, "w") as f:
Christian Heimes's avatar
Christian Heimes committed
646
            f.write("egg\n")
647 648
        with self.open(support.TESTFN, "r") as f:
            file = self.open(f.fileno(), "r", closefd=False)
Christian Heimes's avatar
Christian Heimes committed
649 650 651 652 653 654 655
            self.assertEqual(file.read(), "egg\n")
            file.seek(0)
            file.close()
            self.assertRaises(ValueError, file.read)

    def test_no_closefd_with_filename(self):
        # can't use closefd in combination with a file name
656
        self.assertRaises(ValueError, self.open, support.TESTFN, "r", closefd=False)
Christian Heimes's avatar
Christian Heimes committed
657 658

    def test_closefd_attr(self):
659
        with self.open(support.TESTFN, "wb") as f:
Christian Heimes's avatar
Christian Heimes committed
660
            f.write(b"egg\n")
661
        with self.open(support.TESTFN, "r") as f:
Christian Heimes's avatar
Christian Heimes committed
662
            self.assertEqual(f.buffer.raw.closefd, True)
663
            file = self.open(f.fileno(), "r", closefd=False)
Christian Heimes's avatar
Christian Heimes committed
664 665
            self.assertEqual(file.buffer.raw.closefd, False)

666 667 668
    def test_garbage_collection(self):
        # FileIO objects are collected, and collecting them flushes
        # all data to disk.
Benjamin Peterson's avatar
Benjamin Peterson committed
669 670 671 672 673 674 675
        with support.check_warnings(('', ResourceWarning)):
            f = self.FileIO(support.TESTFN, "wb")
            f.write(b"abcxxx")
            f.f = f
            wr = weakref.ref(f)
            del f
            support.gc_collect()
676
        self.assertIsNone(wr(), wr)
677
        with self.open(support.TESTFN, "rb") as f:
678
            self.assertEqual(f.read(), b"abcxxx")
Christian Heimes's avatar
Christian Heimes committed
679

680 681 682 683
    def test_unbounded_file(self):
        # Issue #1174606: reading from an unbounded stream such as /dev/zero.
        zero = "/dev/zero"
        if not os.path.exists(zero):
684
            self.skipTest("{0} does not exist".format(zero))
685
        if sys.maxsize > 0x7FFFFFFF:
686
            self.skipTest("test can only run in a 32-bit address space")
687
        if support.real_max_memuse < support._2G:
688
            self.skipTest("test requires at least 2GB of memory")
689
        with self.open(zero, "rb", buffering=0) as f:
690
            self.assertRaises(OverflowError, f.read)
691
        with self.open(zero, "rb") as f:
692
            self.assertRaises(OverflowError, f.read)
693
        with self.open(zero, "r") as f:
694 695
            self.assertRaises(OverflowError, f.read)

696 697 698 699 700
    def check_flush_error_on_close(self, *args, **kwargs):
        # Test that the file is closed despite failed flush
        # and that flush() is called before file closed.
        f = self.open(*args, **kwargs)
        closed = []
701
        def bad_flush():
702
            closed[:] = [f.closed]
703
            raise OSError()
704
        f.flush = bad_flush
705
        self.assertRaises(OSError, f.close) # exception not swallowed
706
        self.assertTrue(f.closed)
707 708
        self.assertTrue(closed)      # flush() called
        self.assertFalse(closed[0])  # flush() called before file closed
709
        f.flush = lambda: None  # break reference loop
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733

    def test_flush_error_on_close(self):
        # raw file
        # Issue #5700: io.FileIO calls flush() after file closed
        self.check_flush_error_on_close(support.TESTFN, 'wb', buffering=0)
        fd = os.open(support.TESTFN, os.O_WRONLY|os.O_CREAT)
        self.check_flush_error_on_close(fd, 'wb', buffering=0)
        fd = os.open(support.TESTFN, os.O_WRONLY|os.O_CREAT)
        self.check_flush_error_on_close(fd, 'wb', buffering=0, closefd=False)
        os.close(fd)
        # buffered io
        self.check_flush_error_on_close(support.TESTFN, 'wb')
        fd = os.open(support.TESTFN, os.O_WRONLY|os.O_CREAT)
        self.check_flush_error_on_close(fd, 'wb')
        fd = os.open(support.TESTFN, os.O_WRONLY|os.O_CREAT)
        self.check_flush_error_on_close(fd, 'wb', closefd=False)
        os.close(fd)
        # text io
        self.check_flush_error_on_close(support.TESTFN, 'w')
        fd = os.open(support.TESTFN, os.O_WRONLY|os.O_CREAT)
        self.check_flush_error_on_close(fd, 'w')
        fd = os.open(support.TESTFN, os.O_WRONLY|os.O_CREAT)
        self.check_flush_error_on_close(fd, 'w', closefd=False)
        os.close(fd)
734 735 736 737 738 739 740 741

    def test_multi_close(self):
        f = self.open(support.TESTFN, "wb", buffering=0)
        f.close()
        f.close()
        f.close()
        self.assertRaises(ValueError, f.flush)

742 743 744 745 746 747 748 749 750 751 752 753 754
    def test_RawIOBase_read(self):
        # Exercise the default RawIOBase.read() implementation (which calls
        # readinto() internally).
        rawio = self.MockRawIOWithoutRead((b"abc", b"d", None, b"efg", None))
        self.assertEqual(rawio.read(2), b"ab")
        self.assertEqual(rawio.read(2), b"c")
        self.assertEqual(rawio.read(2), b"d")
        self.assertEqual(rawio.read(2), None)
        self.assertEqual(rawio.read(2), b"ef")
        self.assertEqual(rawio.read(2), b"g")
        self.assertEqual(rawio.read(2), None)
        self.assertEqual(rawio.read(2), b"")

755 756 757 758 759 760 761 762 763 764 765
    def test_types_have_dict(self):
        test = (
            self.IOBase(),
            self.RawIOBase(),
            self.TextIOBase(),
            self.StringIO(),
            self.BytesIO()
        )
        for obj in test:
            self.assertTrue(hasattr(obj, "__dict__"))

766 767 768 769 770 771 772 773 774
    def test_opener(self):
        with self.open(support.TESTFN, "w") as f:
            f.write("egg\n")
        fd = os.open(support.TESTFN, os.O_RDONLY)
        def opener(path, flags):
            return fd
        with self.open("non-existent", "r", opener=opener) as f:
            self.assertEqual(f.read(), "egg\n")

775 776 777 778 779 780 781 782 783 784 785 786
    def test_fileio_closefd(self):
        # Issue #4841
        with self.open(__file__, 'rb') as f1, \
             self.open(__file__, 'rb') as f2:
            fileio = self.FileIO(f1.fileno(), closefd=False)
            # .__init__() must not close f1
            fileio.__init__(f2.fileno(), closefd=False)
            f1.readline()
            # .close() must not close f2
            fileio.close()
            f2.readline()

787
    def test_nonbuffered_textio(self):
788
        with support.check_no_resource_warning(self):
789 790 791 792
            with self.assertRaises(ValueError):
                self.open(support.TESTFN, 'w', buffering=0)

    def test_invalid_newline(self):
793
        with support.check_no_resource_warning(self):
794 795 796
            with self.assertRaises(ValueError):
                self.open(support.TESTFN, 'w', newline='invalid')

797

798
class CIOTest(IOTest):
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815

    def test_IOBase_finalize(self):
        # Issue #12149: segmentation fault on _PyIOBase_finalize when both a
        # class which inherits IOBase and an object of this class are caught
        # in a reference cycle and close() is already in the method cache.
        class MyIO(self.IOBase):
            def close(self):
                pass

        # create an instance to populate the method cache
        MyIO()
        obj = MyIO()
        obj.obj = obj
        wr = weakref.ref(obj)
        del MyIO
        del obj
        support.gc_collect()
816
        self.assertIsNone(wr(), wr)
817

818 819
class PyIOTest(IOTest):
    pass
820

821

822 823
@support.cpython_only
class APIMismatchTest(unittest.TestCase):
824 825 826

    def test_RawIOBase_io_in_pyio_match(self):
        """Test that pyio RawIOBase class has all c RawIOBase methods"""
827 828
        mismatch = support.detect_api_mismatch(pyio.RawIOBase, io.RawIOBase,
                                               ignore=('__weakref__',))
829 830 831 832 833 834 835 836
        self.assertEqual(mismatch, set(), msg='Python RawIOBase does not have all C RawIOBase methods')

    def test_RawIOBase_pyio_in_io_match(self):
        """Test that c RawIOBase class has all pyio RawIOBase methods"""
        mismatch = support.detect_api_mismatch(io.RawIOBase, pyio.RawIOBase)
        self.assertEqual(mismatch, set(), msg='C RawIOBase does not have all Python RawIOBase methods')


837 838
class CommonBufferedTests:
    # Tests common to BufferedReader, BufferedWriter and BufferedRandom
839

840 841 842 843 844 845
    def test_detach(self):
        raw = self.MockRawIO()
        buf = self.tp(raw)
        self.assertIs(buf.detach(), raw)
        self.assertRaises(ValueError, buf.detach)

846 847
        repr(buf)  # Should still work

848 849 850
    def test_fileno(self):
        rawio = self.MockRawIO()
        bufio = self.tp(rawio)
851

852
        self.assertEqual(42, bufio.fileno())
853

854 855 856 857 858
    def test_invalid_args(self):
        rawio = self.MockRawIO()
        bufio = self.tp(rawio)
        # Invalid whence
        self.assertRaises(ValueError, bufio.seek, 0, -1)
859
        self.assertRaises(ValueError, bufio.seek, 0, 9)
860

861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
    def test_override_destructor(self):
        tp = self.tp
        record = []
        class MyBufferedIO(tp):
            def __del__(self):
                record.append(1)
                try:
                    f = super().__del__
                except AttributeError:
                    pass
                else:
                    f()
            def close(self):
                record.append(2)
                super().close()
            def flush(self):
                record.append(3)
                super().flush()
        rawio = self.MockRawIO()
        bufio = MyBufferedIO(rawio)
        del bufio
882
        support.gc_collect()
883
        self.assertEqual(record, [1, 2, 3])
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908

    def test_context_manager(self):
        # Test usability as a context manager
        rawio = self.MockRawIO()
        bufio = self.tp(rawio)
        def _with():
            with bufio:
                pass
        _with()
        # bufio should now be closed, and using it a second time should raise
        # a ValueError.
        self.assertRaises(ValueError, _with)

    def test_error_through_destructor(self):
        # Test that the exception state is not modified by a destructor,
        # even if close() fails.
        rawio = self.CloseFailureIO()
        def f():
            self.tp(rawio).xyzzy
        with support.captured_output("stderr") as s:
            self.assertRaises(AttributeError, f)
        s = s.getvalue().strip()
        if s:
            # The destructor *may* have printed an unraisable error, check it
            self.assertEqual(len(s.splitlines()), 1)
909
            self.assertTrue(s.startswith("Exception OSError: "), s)
910
            self.assertTrue(s.endswith(" ignored"), s)
911

912 913 914
    def test_repr(self):
        raw = self.MockRawIO()
        b = self.tp(raw)
915
        clsname = "%s.%s" % (self.tp.__module__, self.tp.__qualname__)
916 917 918 919 920 921
        self.assertEqual(repr(b), "<%s>" % clsname)
        raw.name = "dummy"
        self.assertEqual(repr(b), "<%s name='dummy'>" % clsname)
        raw.name = b"dummy"
        self.assertEqual(repr(b), "<%s name=b'dummy'>" % clsname)

922
    def test_flush_error_on_close(self):
923 924
        # Test that buffered file is closed despite failed flush
        # and that flush() is called before file closed.
925
        raw = self.MockRawIO()
926
        closed = []
927
        def bad_flush():
928
            closed[:] = [b.closed, raw.closed]
929
            raise OSError()
930 931
        raw.flush = bad_flush
        b = self.tp(raw)
932
        self.assertRaises(OSError, b.close) # exception not swallowed
933
        self.assertTrue(b.closed)
934 935 936 937
        self.assertTrue(raw.closed)
        self.assertTrue(closed)      # flush() called
        self.assertFalse(closed[0])  # flush() called before file closed
        self.assertFalse(closed[1])
938
        raw.flush = lambda: None  # break reference loop
939 940 941 942

    def test_close_error_on_close(self):
        raw = self.MockRawIO()
        def bad_flush():
943
            raise OSError('flush')
944
        def bad_close():
945
            raise OSError('close')
946 947 948
        raw.close = bad_close
        b = self.tp(raw)
        b.flush = bad_flush
949
        with self.assertRaises(OSError) as err: # exception not swallowed
950 951
            b.close()
        self.assertEqual(err.exception.args, ('close',))
952
        self.assertIsInstance(err.exception.__context__, OSError)
953 954
        self.assertEqual(err.exception.__context__.args, ('flush',))
        self.assertFalse(b.closed)
955

956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
    def test_nonnormalized_close_error_on_close(self):
        # Issue #21677
        raw = self.MockRawIO()
        def bad_flush():
            raise non_existing_flush
        def bad_close():
            raise non_existing_close
        raw.close = bad_close
        b = self.tp(raw)
        b.flush = bad_flush
        with self.assertRaises(NameError) as err: # exception not swallowed
            b.close()
        self.assertIn('non_existing_close', str(err.exception))
        self.assertIsInstance(err.exception.__context__, NameError)
        self.assertIn('non_existing_flush', str(err.exception.__context__))
        self.assertFalse(b.closed)

973 974 975 976 977 978 979 980
    def test_multi_close(self):
        raw = self.MockRawIO()
        b = self.tp(raw)
        b.close()
        b.close()
        b.close()
        self.assertRaises(ValueError, b.flush)

981 982 983 984 985
    def test_unseekable(self):
        bufio = self.tp(self.MockUnseekableIO(b"A" * 10))
        self.assertRaises(self.UnsupportedOperation, bufio.tell)
        self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)

986 987 988 989 990 991 992
    def test_readonly_attributes(self):
        raw = self.MockRawIO()
        buf = self.tp(raw)
        x = self.MockRawIO()
        with self.assertRaises(AttributeError):
            buf.raw = x

993

994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
class SizeofTest:

    @support.cpython_only
    def test_sizeof(self):
        bufsize1 = 4096
        bufsize2 = 8192
        rawio = self.MockRawIO()
        bufio = self.tp(rawio, buffer_size=bufsize1)
        size = sys.getsizeof(bufio) - bufsize1
        rawio = self.MockRawIO()
        bufio = self.tp(rawio, buffer_size=bufsize2)
        self.assertEqual(sys.getsizeof(bufio), size + bufsize2)

1007 1008 1009 1010 1011 1012 1013 1014
    @support.cpython_only
    def test_buffer_freeing(self) :
        bufsize = 4096
        rawio = self.MockRawIO()
        bufio = self.tp(rawio, buffer_size=bufsize)
        size = sys.getsizeof(bufio) - bufsize
        bufio.close()
        self.assertEqual(sys.getsizeof(bufio), size)
1015

1016 1017 1018 1019 1020 1021 1022 1023 1024
class BufferedReaderTest(unittest.TestCase, CommonBufferedTests):
    read_mode = "rb"

    def test_constructor(self):
        rawio = self.MockRawIO([b"abc"])
        bufio = self.tp(rawio)
        bufio.__init__(rawio)
        bufio.__init__(rawio, buffer_size=1024)
        bufio.__init__(rawio, buffer_size=16)
1025
        self.assertEqual(b"abc", bufio.read())
1026 1027 1028 1029 1030
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
        rawio = self.MockRawIO([b"abc"])
        bufio.__init__(rawio)
1031
        self.assertEqual(b"abc", bufio.read())
1032

1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
    def test_uninitialized(self):
        bufio = self.tp.__new__(self.tp)
        del bufio
        bufio = self.tp.__new__(self.tp)
        self.assertRaisesRegex((ValueError, AttributeError),
                               'uninitialized|has no attribute',
                               bufio.read, 0)
        bufio.__init__(self.MockRawIO())
        self.assertEqual(bufio.read(0), b'')

1043
    def test_read(self):
1044 1045 1046
        for arg in (None, 7):
            rawio = self.MockRawIO((b"abc", b"d", b"efg"))
            bufio = self.tp(rawio)
1047
            self.assertEqual(b"abcdefg", bufio.read(arg))
1048 1049 1050 1051 1052 1053
        # Invalid args
        self.assertRaises(ValueError, bufio.read, -2)

    def test_read1(self):
        rawio = self.MockRawIO((b"abc", b"d", b"efg"))
        bufio = self.tp(rawio)
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
        self.assertEqual(b"a", bufio.read(1))
        self.assertEqual(b"b", bufio.read1(1))
        self.assertEqual(rawio._reads, 1)
        self.assertEqual(b"c", bufio.read1(100))
        self.assertEqual(rawio._reads, 1)
        self.assertEqual(b"d", bufio.read1(100))
        self.assertEqual(rawio._reads, 2)
        self.assertEqual(b"efg", bufio.read1(100))
        self.assertEqual(rawio._reads, 3)
        self.assertEqual(b"", bufio.read1(100))
        self.assertEqual(rawio._reads, 4)
1065 1066 1067 1068 1069 1070 1071
        # Invalid args
        self.assertRaises(ValueError, bufio.read1, -1)

    def test_readinto(self):
        rawio = self.MockRawIO((b"abc", b"d", b"efg"))
        bufio = self.tp(rawio)
        b = bytearray(2)
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
        self.assertEqual(bufio.readinto(b), 2)
        self.assertEqual(b, b"ab")
        self.assertEqual(bufio.readinto(b), 2)
        self.assertEqual(b, b"cd")
        self.assertEqual(bufio.readinto(b), 2)
        self.assertEqual(b, b"ef")
        self.assertEqual(bufio.readinto(b), 1)
        self.assertEqual(b, b"gf")
        self.assertEqual(bufio.readinto(b), 0)
        self.assertEqual(b, b"gf")
1082 1083 1084 1085 1086 1087
        rawio = self.MockRawIO((b"abc", None))
        bufio = self.tp(rawio)
        self.assertEqual(bufio.readinto(b), 2)
        self.assertEqual(b, b"ab")
        self.assertEqual(bufio.readinto(b), 1)
        self.assertEqual(b, b"cb")
1088

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
    def test_readinto1(self):
        buffer_size = 10
        rawio = self.MockRawIO((b"abc", b"de", b"fgh", b"jkl"))
        bufio = self.tp(rawio, buffer_size=buffer_size)
        b = bytearray(2)
        self.assertEqual(bufio.peek(3), b'abc')
        self.assertEqual(rawio._reads, 1)
        self.assertEqual(bufio.readinto1(b), 2)
        self.assertEqual(b, b"ab")
        self.assertEqual(rawio._reads, 1)
        self.assertEqual(bufio.readinto1(b), 1)
        self.assertEqual(b[:1], b"c")
        self.assertEqual(rawio._reads, 1)
        self.assertEqual(bufio.readinto1(b), 2)
        self.assertEqual(b, b"de")
        self.assertEqual(rawio._reads, 2)
        b = bytearray(2*buffer_size)
        self.assertEqual(bufio.peek(3), b'fgh')
        self.assertEqual(rawio._reads, 3)
        self.assertEqual(bufio.readinto1(b), 6)
        self.assertEqual(b[:6], b"fghjkl")
        self.assertEqual(rawio._reads, 4)

    def test_readinto_array(self):
        buffer_size = 60
        data = b"a" * 26
        rawio = self.MockRawIO((data,))
        bufio = self.tp(rawio, buffer_size=buffer_size)

        # Create an array with element size > 1 byte
        b = array.array('i', b'x' * 32)
        assert len(b) != 16

        # Read into it. We should get as many *bytes* as we can fit into b
        # (which is more than the number of elements)
        n = bufio.readinto(b)
        self.assertGreater(n, len(b))

        # Check that old contents of b are preserved
        bm = memoryview(b).cast('B')
        self.assertLess(n, len(bm))
        self.assertEqual(bm[:n], data[:n])
        self.assertEqual(bm[n:], b'x' * (len(bm[n:])))

    def test_readinto1_array(self):
        buffer_size = 60
        data = b"a" * 26
        rawio = self.MockRawIO((data,))
        bufio = self.tp(rawio, buffer_size=buffer_size)

        # Create an array with element size > 1 byte
        b = array.array('i', b'x' * 32)
        assert len(b) != 16

        # Read into it. We should get as many *bytes* as we can fit into b
        # (which is more than the number of elements)
        n = bufio.readinto1(b)
        self.assertGreater(n, len(b))

        # Check that old contents of b are preserved
        bm = memoryview(b).cast('B')
        self.assertLess(n, len(bm))
        self.assertEqual(bm[:n], data[:n])
        self.assertEqual(bm[n:], b'x' * (len(bm[n:])))

1154 1155 1156 1157
    def test_readlines(self):
        def bufio():
            rawio = self.MockRawIO((b"abc\n", b"d\n", b"ef"))
            return self.tp(rawio)
1158 1159 1160
        self.assertEqual(bufio().readlines(), [b"abc\n", b"d\n", b"ef"])
        self.assertEqual(bufio().readlines(5), [b"abc\n", b"d\n"])
        self.assertEqual(bufio().readlines(None), [b"abc\n", b"d\n", b"ef"])
1161

1162
    def test_buffering(self):
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
        data = b"abcdefghi"
        dlen = len(data)

        tests = [
            [ 100, [ 3, 1, 4, 8 ], [ dlen, 0 ] ],
            [ 100, [ 3, 3, 3],     [ dlen ]    ],
            [   4, [ 1, 2, 4, 2 ], [ 4, 4, 1 ] ],
        ]

        for bufsize, buf_read_sizes, raw_read_sizes in tests:
1173 1174
            rawio = self.MockFileIO(data)
            bufio = self.tp(rawio, buffer_size=bufsize)
1175 1176
            pos = 0
            for nbytes in buf_read_sizes:
1177
                self.assertEqual(bufio.read(nbytes), data[pos:pos+nbytes])
1178
                pos += nbytes
1179
            # this is mildly implementation-dependent
1180
            self.assertEqual(rawio.read_history, raw_read_sizes)
1181

1182
    def test_read_non_blocking(self):
1183
        # Inject some None's in there to simulate EWOULDBLOCK
1184 1185
        rawio = self.MockRawIO((b"abc", b"d", None, b"efg", None, None, None))
        bufio = self.tp(rawio)
1186 1187 1188 1189
        self.assertEqual(b"abcd", bufio.read(6))
        self.assertEqual(b"e", bufio.read(1))
        self.assertEqual(b"fg", bufio.read())
        self.assertEqual(b"", bufio.peek(1))
1190
        self.assertIsNone(bufio.read())
1191
        self.assertEqual(b"", bufio.read())
1192

1193 1194 1195 1196
        rawio = self.MockRawIO((b"a", None, None))
        self.assertEqual(b"a", rawio.readall())
        self.assertIsNone(rawio.readall())

1197 1198 1199
    def test_read_past_eof(self):
        rawio = self.MockRawIO((b"abc", b"d", b"efg"))
        bufio = self.tp(rawio)
1200

1201
        self.assertEqual(b"abcdefg", bufio.read(9000))
1202

1203 1204 1205
    def test_read_all(self):
        rawio = self.MockRawIO((b"abc", b"d", b"efg"))
        bufio = self.tp(rawio)
1206

1207
        self.assertEqual(b"abcdefg", bufio.read())
1208

1209
    @unittest.skipUnless(threading, 'Threading required for this test.')
1210
    @support.requires_resource('cpu')
1211
    def test_threads(self):
1212 1213 1214 1215 1216 1217 1218 1219
        try:
            # Write out many bytes with exactly the same number of 0's,
            # 1's... 255's. This will help us check that concurrent reading
            # doesn't duplicate or forget contents.
            N = 1000
            l = list(range(256)) * N
            random.shuffle(l)
            s = bytes(bytearray(l))
1220
            with self.open(support.TESTFN, "wb") as f:
1221
                f.write(s)
1222
            with self.open(support.TESTFN, self.read_mode, buffering=0) as raw:
1223
                bufio = self.tp(raw, 8)
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
                errors = []
                results = []
                def f():
                    try:
                        # Intra-buffer read then buffer-flushing read
                        for n in cycle([1, 19]):
                            s = bufio.read(n)
                            if not s:
                                break
                            # list.append() is atomic
                            results.append(s)
                    except Exception as e:
                        errors.append(e)
                        raise
                threads = [threading.Thread(target=f) for x in range(20)]
1239 1240
                with support.start_threads(threads):
                    time.sleep(0.02) # yield
1241 1242 1243 1244 1245 1246 1247 1248 1249
                self.assertFalse(errors,
                    "the following exceptions were caught: %r" % errors)
                s = b''.join(results)
                for i in range(256):
                    c = bytes(bytearray([i]))
                    self.assertEqual(s.count(c), N)
        finally:
            support.unlink(support.TESTFN)

1250 1251 1252 1253 1254 1255 1256 1257
    def test_unseekable(self):
        bufio = self.tp(self.MockUnseekableIO(b"A" * 10))
        self.assertRaises(self.UnsupportedOperation, bufio.tell)
        self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
        bufio.read(1)
        self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
        self.assertRaises(self.UnsupportedOperation, bufio.tell)

1258 1259 1260
    def test_misbehaved_io(self):
        rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
        bufio = self.tp(rawio)
1261 1262
        self.assertRaises(OSError, bufio.seek, 0)
        self.assertRaises(OSError, bufio.tell)
1263

1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
    def test_no_extraneous_read(self):
        # Issue #9550; when the raw IO object has satisfied the read request,
        # we should not issue any additional reads, otherwise it may block
        # (e.g. socket).
        bufsize = 16
        for n in (2, bufsize - 1, bufsize, bufsize + 1, bufsize * 2):
            rawio = self.MockRawIO([b"x" * n])
            bufio = self.tp(rawio, bufsize)
            self.assertEqual(bufio.read(n), b"x" * n)
            # Simple case: one raw read is enough to satisfy the request.
            self.assertEqual(rawio._extraneous_reads, 0,
                             "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
            # A more complex case where two raw reads are needed to satisfy
            # the request.
            rawio = self.MockRawIO([b"x" * (n - 1), b"x"])
            bufio = self.tp(rawio, bufsize)
            self.assertEqual(bufio.read(n), b"x" * n)
            self.assertEqual(rawio._extraneous_reads, 0,
                             "failed for {}: {} != 0".format(n, rawio._extraneous_reads))

1284 1285 1286 1287 1288 1289 1290 1291
    def test_read_on_closed(self):
        # Issue #23796
        b = io.BufferedReader(io.BytesIO(b"12"))
        b.read(1)
        b.close()
        self.assertRaises(ValueError, b.peek)
        self.assertRaises(ValueError, b.read1, 1)

1292

1293
class CBufferedReaderTest(BufferedReaderTest, SizeofTest):
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
    tp = io.BufferedReader

    def test_constructor(self):
        BufferedReaderTest.test_constructor(self)
        # The allocation can succeed on 32-bit builds, e.g. with more
        # than 2GB RAM and a 64-bit kernel.
        if sys.maxsize > 0x7FFFFFFF:
            rawio = self.MockRawIO()
            bufio = self.tp(rawio)
            self.assertRaises((OverflowError, MemoryError, ValueError),
                bufio.__init__, rawio, sys.maxsize)

    def test_initialization(self):
        rawio = self.MockRawIO([b"abc"])
        bufio = self.tp(rawio)
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
        self.assertRaises(ValueError, bufio.read)
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
        self.assertRaises(ValueError, bufio.read)
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
        self.assertRaises(ValueError, bufio.read)

    def test_misbehaved_io_read(self):
        rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
        bufio = self.tp(rawio)
        # _pyio.BufferedReader seems to implement reading different, so that
        # checking this is not so easy.
1321
        self.assertRaises(OSError, bufio.read, 10)
1322 1323 1324 1325

    def test_garbage_collection(self):
        # C BufferedReader objects are collected.
        # The Python version has __del__, so it ends into gc.garbage instead
1326 1327 1328 1329 1330 1331 1332
        with support.check_warnings(('', ResourceWarning)):
            rawio = self.FileIO(support.TESTFN, "w+b")
            f = self.tp(rawio)
            f.f = f
            wr = weakref.ref(f)
            del f
            support.gc_collect()
1333
        self.assertIsNone(wr(), wr)
1334

1335 1336 1337 1338 1339 1340
    def test_args_error(self):
        # Issue #17275
        with self.assertRaisesRegex(TypeError, "BufferedReader"):
            self.tp(io.BytesIO(), 1024, 1024, 1024)


1341 1342
class PyBufferedReaderTest(BufferedReaderTest):
    tp = pyio.BufferedReader
1343

1344

1345 1346
class BufferedWriterTest(unittest.TestCase, CommonBufferedTests):
    write_mode = "wb"
1347

1348 1349 1350 1351 1352 1353
    def test_constructor(self):
        rawio = self.MockRawIO()
        bufio = self.tp(rawio)
        bufio.__init__(rawio)
        bufio.__init__(rawio, buffer_size=1024)
        bufio.__init__(rawio, buffer_size=16)
1354
        self.assertEqual(3, bufio.write(b"abc"))
1355 1356 1357 1358 1359
        bufio.flush()
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
        bufio.__init__(rawio)
1360
        self.assertEqual(3, bufio.write(b"ghi"))
1361
        bufio.flush()
1362
        self.assertEqual(b"".join(rawio._write_stack), b"abcghi")
1363

1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
    def test_uninitialized(self):
        bufio = self.tp.__new__(self.tp)
        del bufio
        bufio = self.tp.__new__(self.tp)
        self.assertRaisesRegex((ValueError, AttributeError),
                               'uninitialized|has no attribute',
                               bufio.write, b'')
        bufio.__init__(self.MockRawIO())
        self.assertEqual(bufio.write(b''), 0)

1374 1375 1376 1377 1378 1379 1380 1381
    def test_detach_flush(self):
        raw = self.MockRawIO()
        buf = self.tp(raw)
        buf.write(b"howdy!")
        self.assertFalse(raw._write_stack)
        buf.detach()
        self.assertEqual(raw._write_stack, [b"howdy!"])

1382 1383 1384 1385
    def test_write(self):
        # Write to the buffered IO but don't overflow the buffer.
        writer = self.MockRawIO()
        bufio = self.tp(writer, 8)
Guido van Rossum's avatar
Guido van Rossum committed
1386
        bufio.write(b"abc")
1387
        self.assertFalse(writer._write_stack)
1388

1389 1390 1391 1392 1393 1394 1395 1396 1397
    def test_write_overflow(self):
        writer = self.MockRawIO()
        bufio = self.tp(writer, 8)
        contents = b"abcdefghijklmnop"
        for n in range(0, len(contents), 3):
            bufio.write(contents[n:n+3])
        flushed = b"".join(writer._write_stack)
        # At least (total - 8) bytes were implicitly flushed, perhaps more
        # depending on the implementation.
1398
        self.assertTrue(flushed.startswith(contents[:-8]), flushed)
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413

    def check_writes(self, intermediate_func):
        # Lots of writes, test the flushed output is as expected.
        contents = bytes(range(256)) * 1000
        n = 0
        writer = self.MockRawIO()
        bufio = self.tp(writer, 13)
        # Generator of write sizes: repeat each N 15 times then proceed to N+1
        def gen_sizes():
            for size in count(1):
                for i in range(15):
                    yield size
        sizes = gen_sizes()
        while n < len(contents):
            size = min(next(sizes), len(contents) - n)
1414
            self.assertEqual(bufio.write(contents[n:n+size]), size)
1415 1416 1417
            intermediate_func(bufio)
            n += size
        bufio.flush()
1418
        self.assertEqual(contents, b"".join(writer._write_stack))
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444

    def test_writes(self):
        self.check_writes(lambda bufio: None)

    def test_writes_and_flushes(self):
        self.check_writes(lambda bufio: bufio.flush())

    def test_writes_and_seeks(self):
        def _seekabs(bufio):
            pos = bufio.tell()
            bufio.seek(pos + 1, 0)
            bufio.seek(pos - 1, 0)
            bufio.seek(pos, 0)
        self.check_writes(_seekabs)
        def _seekrel(bufio):
            pos = bufio.seek(0, 1)
            bufio.seek(+1, 1)
            bufio.seek(-1, 1)
            bufio.seek(pos, 0)
        self.check_writes(_seekrel)

    def test_writes_and_truncates(self):
        self.check_writes(lambda bufio: bufio.truncate(bufio.tell()))

    def test_write_non_blocking(self):
        raw = self.MockNonBlockWriterIO()
1445
        bufio = self.tp(raw, 8)
1446

1447 1448
        self.assertEqual(bufio.write(b"abcd"), 4)
        self.assertEqual(bufio.write(b"efghi"), 5)
1449 1450
        # 1 byte will be written, the rest will be buffered
        raw.block_on(b"k")
1451
        self.assertEqual(bufio.write(b"jklmn"), 5)
1452 1453 1454 1455 1456 1457 1458 1459 1460

        # 8 bytes will be written, 8 will be buffered and the rest will be lost
        raw.block_on(b"0")
        try:
            bufio.write(b"opqrwxyz0123456789")
        except self.BlockingIOError as e:
            written = e.characters_written
        else:
            self.fail("BlockingIOError should have been raised")
1461 1462
        self.assertEqual(written, 16)
        self.assertEqual(raw.pop_written(),
1463 1464
            b"abcdefghijklmnopqrwxyz")

1465
        self.assertEqual(bufio.write(b"ABCDEFGHI"), 9)
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
        s = raw.pop_written()
        # Previously buffered bytes were flushed
        self.assertTrue(s.startswith(b"01234567A"), s)

    def test_write_and_rewind(self):
        raw = io.BytesIO()
        bufio = self.tp(raw, 4)
        self.assertEqual(bufio.write(b"abcdef"), 6)
        self.assertEqual(bufio.tell(), 6)
        bufio.seek(0, 0)
        self.assertEqual(bufio.write(b"XY"), 2)
        bufio.seek(6, 0)
        self.assertEqual(raw.getvalue(), b"XYcdef")
        self.assertEqual(bufio.write(b"123456"), 6)
        bufio.flush()
        self.assertEqual(raw.getvalue(), b"XYcdef123456")
1482

1483 1484 1485
    def test_flush(self):
        writer = self.MockRawIO()
        bufio = self.tp(writer, 8)
Guido van Rossum's avatar
Guido van Rossum committed
1486 1487
        bufio.write(b"abc")
        bufio.flush()
1488
        self.assertEqual(b"abc", writer._write_stack[0])
1489

1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
    def test_writelines(self):
        l = [b'ab', b'cd', b'ef']
        writer = self.MockRawIO()
        bufio = self.tp(writer, 8)
        bufio.writelines(l)
        bufio.flush()
        self.assertEqual(b''.join(writer._write_stack), b'abcdef')

    def test_writelines_userlist(self):
        l = UserList([b'ab', b'cd', b'ef'])
        writer = self.MockRawIO()
        bufio = self.tp(writer, 8)
        bufio.writelines(l)
        bufio.flush()
        self.assertEqual(b''.join(writer._write_stack), b'abcdef')

    def test_writelines_error(self):
        writer = self.MockRawIO()
        bufio = self.tp(writer, 8)
        self.assertRaises(TypeError, bufio.writelines, [1, 2, 3])
        self.assertRaises(TypeError, bufio.writelines, None)
        self.assertRaises(TypeError, bufio.writelines, 'abc')

1513 1514 1515 1516 1517
    def test_destructor(self):
        writer = self.MockRawIO()
        bufio = self.tp(writer, 8)
        bufio.write(b"abc")
        del bufio
1518
        support.gc_collect()
1519
        self.assertEqual(b"abc", writer._write_stack[0])
1520

1521 1522
    def test_truncate(self):
        # Truncate implicitly flushes the buffer.
1523
        with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
1524 1525 1526
            bufio = self.tp(raw, 8)
            bufio.write(b"abcdef")
            self.assertEqual(bufio.truncate(3), 3)
1527
            self.assertEqual(bufio.tell(), 6)
1528
        with self.open(support.TESTFN, "rb", buffering=0) as f:
1529 1530
            self.assertEqual(f.read(), b"abc")

1531
    @unittest.skipUnless(threading, 'Threading required for this test.')
1532
    @support.requires_resource('cpu')
1533
    def test_threads(self):
1534
        try:
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
            # Write out many bytes from many threads and test they were
            # all flushed.
            N = 1000
            contents = bytes(range(256)) * N
            sizes = cycle([1, 19])
            n = 0
            queue = deque()
            while n < len(contents):
                size = next(sizes)
                queue.append(contents[n:n+size])
                n += size
            del contents
1547 1548 1549 1550 1551
            # We use a real file object because it allows us to
            # exercise situations where the GIL is released before
            # writing the buffer to the raw streams. This is in addition
            # to concurrency issues due to switching threads in the middle
            # of Python code.
1552
            with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
1553
                bufio = self.tp(raw, 8)
1554 1555 1556
                errors = []
                def f():
                    try:
1557 1558 1559 1560 1561
                        while True:
                            try:
                                s = queue.popleft()
                            except IndexError:
                                return
1562 1563 1564 1565 1566
                            bufio.write(s)
                    except Exception as e:
                        errors.append(e)
                        raise
                threads = [threading.Thread(target=f) for x in range(20)]
1567 1568
                with support.start_threads(threads):
                    time.sleep(0.02) # yield
1569 1570
                self.assertFalse(errors,
                    "the following exceptions were caught: %r" % errors)
1571
                bufio.close()
1572
            with self.open(support.TESTFN, "rb") as f:
1573 1574
                s = f.read()
            for i in range(256):
1575
                self.assertEqual(s.count(bytes([i])), N)
1576 1577 1578
        finally:
            support.unlink(support.TESTFN)

1579 1580 1581
    def test_misbehaved_io(self):
        rawio = self.MisbehavedRawIO()
        bufio = self.tp(rawio, 5)
1582 1583 1584
        self.assertRaises(OSError, bufio.seek, 0)
        self.assertRaises(OSError, bufio.tell)
        self.assertRaises(OSError, bufio.write, b"abcdef")
1585

1586 1587
    def test_max_buffer_size_removal(self):
        with self.assertRaises(TypeError):
1588 1589
            self.tp(self.MockRawIO(), 8, 12)

1590 1591 1592
    def test_write_error_on_close(self):
        raw = self.MockRawIO()
        def bad_write(b):
1593
            raise OSError()
1594 1595 1596
        raw.write = bad_write
        b = self.tp(raw)
        b.write(b'spam')
1597
        self.assertRaises(OSError, b.close) # exception not swallowed
1598 1599
        self.assertTrue(b.closed)

1600

1601
class CBufferedWriterTest(BufferedWriterTest, SizeofTest):
1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
    tp = io.BufferedWriter

    def test_constructor(self):
        BufferedWriterTest.test_constructor(self)
        # The allocation can succeed on 32-bit builds, e.g. with more
        # than 2GB RAM and a 64-bit kernel.
        if sys.maxsize > 0x7FFFFFFF:
            rawio = self.MockRawIO()
            bufio = self.tp(rawio)
            self.assertRaises((OverflowError, MemoryError, ValueError),
                bufio.__init__, rawio, sys.maxsize)

    def test_initialization(self):
        rawio = self.MockRawIO()
        bufio = self.tp(rawio)
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
        self.assertRaises(ValueError, bufio.write, b"def")
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
        self.assertRaises(ValueError, bufio.write, b"def")
        self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
        self.assertRaises(ValueError, bufio.write, b"def")

    def test_garbage_collection(self):
        # C BufferedWriter objects are collected, and collecting them flushes
        # all data to disk.
        # The Python version has __del__, so it ends into gc.garbage instead
1628 1629 1630 1631 1632 1633 1634 1635
        with support.check_warnings(('', ResourceWarning)):
            rawio = self.FileIO(support.TESTFN, "w+b")
            f = self.tp(rawio)
            f.write(b"123xxx")
            f.x = f
            wr = weakref.ref(f)
            del f
            support.gc_collect()
1636
        self.assertIsNone(wr(), wr)
1637
        with self.open(support.TESTFN, "rb") as f:
1638 1639
            self.assertEqual(f.read(), b"123xxx")

1640 1641 1642 1643 1644
    def test_args_error(self):
        # Issue #17275
        with self.assertRaisesRegex(TypeError, "BufferedWriter"):
            self.tp(io.BytesIO(), 1024, 1024, 1024)

1645 1646 1647

class PyBufferedWriterTest(BufferedWriterTest):
    tp = pyio.BufferedWriter
1648

1649
class BufferedRWPairTest(unittest.TestCase):
1650

1651 1652
    def test_constructor(self):
        pair = self.tp(self.MockRawIO(), self.MockRawIO())
Benjamin Peterson's avatar
Benjamin Peterson committed
1653
        self.assertFalse(pair.closed)
1654

1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668
    def test_uninitialized(self):
        pair = self.tp.__new__(self.tp)
        del pair
        pair = self.tp.__new__(self.tp)
        self.assertRaisesRegex((ValueError, AttributeError),
                               'uninitialized|has no attribute',
                               pair.read, 0)
        self.assertRaisesRegex((ValueError, AttributeError),
                               'uninitialized|has no attribute',
                               pair.write, b'')
        pair.__init__(self.MockRawIO(), self.MockRawIO())
        self.assertEqual(pair.read(0), b'')
        self.assertEqual(pair.write(b''), 0)

1669 1670 1671 1672
    def test_detach(self):
        pair = self.tp(self.MockRawIO(), self.MockRawIO())
        self.assertRaises(self.UnsupportedOperation, pair.detach)

1673 1674
    def test_constructor_max_buffer_size_removal(self):
        with self.assertRaises(TypeError):
1675 1676
            self.tp(self.MockRawIO(), self.MockRawIO(), 8, 12)

1677 1678 1679 1680 1681
    def test_constructor_with_not_readable(self):
        class NotReadable(MockRawIO):
            def readable(self):
                return False

1682
        self.assertRaises(OSError, self.tp, NotReadable(), self.MockRawIO())
1683 1684 1685 1686 1687 1688

    def test_constructor_with_not_writeable(self):
        class NotWriteable(MockRawIO):
            def writable(self):
                return False

1689
        self.assertRaises(OSError, self.tp, self.MockRawIO(), NotWriteable())
1690 1691 1692 1693 1694 1695 1696

    def test_read(self):
        pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())

        self.assertEqual(pair.read(3), b"abc")
        self.assertEqual(pair.read(1), b"d")
        self.assertEqual(pair.read(), b"ef")
1697 1698 1699 1700 1701 1702 1703 1704
        pair = self.tp(self.BytesIO(b"abc"), self.MockRawIO())
        self.assertEqual(pair.read(None), b"abc")

    def test_readlines(self):
        pair = lambda: self.tp(self.BytesIO(b"abc\ndef\nh"), self.MockRawIO())
        self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
        self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
        self.assertEqual(pair().readlines(5), [b"abc\n", b"def\n"])
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758

    def test_read1(self):
        # .read1() is delegated to the underlying reader object, so this test
        # can be shallow.
        pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())

        self.assertEqual(pair.read1(3), b"abc")

    def test_readinto(self):
        pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())

        data = bytearray(5)
        self.assertEqual(pair.readinto(data), 5)
        self.assertEqual(data, b"abcde")

    def test_write(self):
        w = self.MockRawIO()
        pair = self.tp(self.MockRawIO(), w)

        pair.write(b"abc")
        pair.flush()
        pair.write(b"def")
        pair.flush()
        self.assertEqual(w._write_stack, [b"abc", b"def"])

    def test_peek(self):
        pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())

        self.assertTrue(pair.peek(3).startswith(b"abc"))
        self.assertEqual(pair.read(3), b"abc")

    def test_readable(self):
        pair = self.tp(self.MockRawIO(), self.MockRawIO())
        self.assertTrue(pair.readable())

    def test_writeable(self):
        pair = self.tp(self.MockRawIO(), self.MockRawIO())
        self.assertTrue(pair.writable())

    def test_seekable(self):
        # BufferedRWPairs are never seekable, even if their readers and writers
        # are.
        pair = self.tp(self.MockRawIO(), self.MockRawIO())
        self.assertFalse(pair.seekable())

    # .flush() is delegated to the underlying writer object and has been
    # tested in the test_write method.

    def test_close_and_closed(self):
        pair = self.tp(self.MockRawIO(), self.MockRawIO())
        self.assertFalse(pair.closed)
        pair.close()
        self.assertTrue(pair.closed)

1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
    def test_reader_close_error_on_close(self):
        def reader_close():
            reader_non_existing
        reader = self.MockRawIO()
        reader.close = reader_close
        writer = self.MockRawIO()
        pair = self.tp(reader, writer)
        with self.assertRaises(NameError) as err:
            pair.close()
        self.assertIn('reader_non_existing', str(err.exception))
        self.assertTrue(pair.closed)
        self.assertFalse(reader.closed)
        self.assertTrue(writer.closed)

    def test_writer_close_error_on_close(self):
        def writer_close():
            writer_non_existing
        reader = self.MockRawIO()
        writer = self.MockRawIO()
        writer.close = writer_close
        pair = self.tp(reader, writer)
        with self.assertRaises(NameError) as err:
            pair.close()
        self.assertIn('writer_non_existing', str(err.exception))
        self.assertFalse(pair.closed)
        self.assertTrue(reader.closed)
        self.assertFalse(writer.closed)

    def test_reader_writer_close_error_on_close(self):
        def reader_close():
            reader_non_existing
        def writer_close():
            writer_non_existing
        reader = self.MockRawIO()
        reader.close = reader_close
        writer = self.MockRawIO()
        writer.close = writer_close
        pair = self.tp(reader, writer)
        with self.assertRaises(NameError) as err:
            pair.close()
        self.assertIn('reader_non_existing', str(err.exception))
        self.assertIsInstance(err.exception.__context__, NameError)
        self.assertIn('writer_non_existing', str(err.exception.__context__))
        self.assertFalse(pair.closed)
        self.assertFalse(reader.closed)
        self.assertFalse(writer.closed)

1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825
    def test_isatty(self):
        class SelectableIsAtty(MockRawIO):
            def __init__(self, isatty):
                MockRawIO.__init__(self)
                self._isatty = isatty

            def isatty(self):
                return self._isatty

        pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(False))
        self.assertFalse(pair.isatty())

        pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(False))
        self.assertTrue(pair.isatty())

        pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(True))
        self.assertTrue(pair.isatty())

        pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(True))
        self.assertTrue(pair.isatty())
1826

1827 1828 1829 1830 1831 1832
    def test_weakref_clearing(self):
        brw = self.tp(self.MockRawIO(), self.MockRawIO())
        ref = weakref.ref(brw)
        brw = None
        ref = None # Shouldn't segfault.

1833 1834
class CBufferedRWPairTest(BufferedRWPairTest):
    tp = io.BufferedRWPair
1835

1836 1837
class PyBufferedRWPairTest(BufferedRWPairTest):
    tp = pyio.BufferedRWPair
1838

1839 1840 1841 1842 1843 1844 1845 1846 1847

class BufferedRandomTest(BufferedReaderTest, BufferedWriterTest):
    read_mode = "rb+"
    write_mode = "wb+"

    def test_constructor(self):
        BufferedReaderTest.test_constructor(self)
        BufferedWriterTest.test_constructor(self)

1848 1849 1850 1851
    def test_uninitialized(self):
        BufferedReaderTest.test_uninitialized(self)
        BufferedWriterTest.test_uninitialized(self)

1852 1853
    def test_read_and_write(self):
        raw = self.MockRawIO((b"asdf", b"ghjk"))
1854
        rw = self.tp(raw, 8)
1855 1856 1857 1858

        self.assertEqual(b"as", rw.read(2))
        rw.write(b"ddd")
        rw.write(b"eee")
Guido van Rossum's avatar
Guido van Rossum committed
1859
        self.assertFalse(raw._write_stack) # Buffer writes
1860
        self.assertEqual(b"ghjk", rw.read())
1861
        self.assertEqual(b"dddeee", raw._write_stack[0])
1862

1863 1864 1865
    def test_seek_and_tell(self):
        raw = self.BytesIO(b"asdfghjkl")
        rw = self.tp(raw)
1866

1867 1868
        self.assertEqual(b"as", rw.read(2))
        self.assertEqual(2, rw.tell())
1869
        rw.seek(0, 0)
1870
        self.assertEqual(b"asdf", rw.read(4))
1871

1872
        rw.write(b"123f")
1873
        rw.seek(0, 0)
1874
        self.assertEqual(b"asdf123fl", rw.read())
1875
        self.assertEqual(9, rw.tell())
1876
        rw.seek(-4, 2)
1877
        self.assertEqual(5, rw.tell())
1878
        rw.seek(2, 1)
1879 1880
        self.assertEqual(7, rw.tell())
        self.assertEqual(b"fl", rw.read(11))
1881 1882 1883
        rw.flush()
        self.assertEqual(b"asdf123fl", raw.getvalue())

1884
        self.assertRaises(TypeError, rw.seek, 0.0)
1885

1886 1887 1888 1889
    def check_flush_and_read(self, read_func):
        raw = self.BytesIO(b"abcdefghi")
        bufio = self.tp(raw)

1890
        self.assertEqual(b"ab", read_func(bufio, 2))
1891
        bufio.write(b"12")
1892 1893
        self.assertEqual(b"ef", read_func(bufio, 2))
        self.assertEqual(6, bufio.tell())
1894
        bufio.flush()
1895 1896
        self.assertEqual(6, bufio.tell())
        self.assertEqual(b"ghi", read_func(bufio))
1897 1898 1899 1900 1901
        raw.seek(0, 0)
        raw.write(b"XYZ")
        # flush() resets the read buffer
        bufio.flush()
        bufio.seek(0, 0)
1902
        self.assertEqual(b"XYZ", read_func(bufio, 3))
1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933

    def test_flush_and_read(self):
        self.check_flush_and_read(lambda bufio, *args: bufio.read(*args))

    def test_flush_and_readinto(self):
        def _readinto(bufio, n=-1):
            b = bytearray(n if n >= 0 else 9999)
            n = bufio.readinto(b)
            return bytes(b[:n])
        self.check_flush_and_read(_readinto)

    def test_flush_and_peek(self):
        def _peek(bufio, n=-1):
            # This relies on the fact that the buffer can contain the whole
            # raw stream, otherwise peek() can return less.
            b = bufio.peek(n)
            if n != -1:
                b = b[:n]
            bufio.seek(len(b), 1)
            return b
        self.check_flush_and_read(_peek)

    def test_flush_and_write(self):
        raw = self.BytesIO(b"abcdefghi")
        bufio = self.tp(raw)

        bufio.write(b"123")
        bufio.flush()
        bufio.write(b"45")
        bufio.flush()
        bufio.seek(0, 0)
1934 1935
        self.assertEqual(b"12345fghi", raw.getvalue())
        self.assertEqual(b"12345fghi", bufio.read())
1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969

    def test_threads(self):
        BufferedReaderTest.test_threads(self)
        BufferedWriterTest.test_threads(self)

    def test_writes_and_peek(self):
        def _peek(bufio):
            bufio.peek(1)
        self.check_writes(_peek)
        def _peek(bufio):
            pos = bufio.tell()
            bufio.seek(-1, 1)
            bufio.peek(1)
            bufio.seek(pos, 0)
        self.check_writes(_peek)

    def test_writes_and_reads(self):
        def _read(bufio):
            bufio.seek(-1, 1)
            bufio.read(1)
        self.check_writes(_read)

    def test_writes_and_read1s(self):
        def _read1(bufio):
            bufio.seek(-1, 1)
            bufio.read1(1)
        self.check_writes(_read1)

    def test_writes_and_readintos(self):
        def _read(bufio):
            bufio.seek(-1, 1)
            bufio.readinto(bytearray(1))
        self.check_writes(_read)

1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
    def test_write_after_readahead(self):
        # Issue #6629: writing after the buffer was filled by readahead should
        # first rewind the raw stream.
        for overwrite_size in [1, 5]:
            raw = self.BytesIO(b"A" * 10)
            bufio = self.tp(raw, 4)
            # Trigger readahead
            self.assertEqual(bufio.read(1), b"A")
            self.assertEqual(bufio.tell(), 1)
            # Overwriting should rewind the raw stream if it needs so
            bufio.write(b"B" * overwrite_size)
            self.assertEqual(bufio.tell(), overwrite_size + 1)
            # If the write size was smaller than the buffer size, flush() and
            # check that rewind happens.
            bufio.flush()
            self.assertEqual(bufio.tell(), overwrite_size + 1)
            s = raw.getvalue()
            self.assertEqual(s,
                b"A" + b"B" * overwrite_size + b"A" * (9 - overwrite_size))

1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015
    def test_write_rewind_write(self):
        # Various combinations of reading / writing / seeking backwards / writing again
        def mutate(bufio, pos1, pos2):
            assert pos2 >= pos1
            # Fill the buffer
            bufio.seek(pos1)
            bufio.read(pos2 - pos1)
            bufio.write(b'\x02')
            # This writes earlier than the previous write, but still inside
            # the buffer.
            bufio.seek(pos1)
            bufio.write(b'\x01')

        b = b"\x80\x81\x82\x83\x84"
        for i in range(0, len(b)):
            for j in range(i, len(b)):
                raw = self.BytesIO(b)
                bufio = self.tp(raw, 100)
                mutate(bufio, i, j)
                bufio.flush()
                expected = bytearray(b)
                expected[j] = 2
                expected[i] = 1
                self.assertEqual(raw.getvalue(), expected,
                                 "failed result for i=%d, j=%d" % (i, j))

2016 2017 2018 2019 2020 2021 2022 2023
    def test_truncate_after_read_or_write(self):
        raw = self.BytesIO(b"A" * 10)
        bufio = self.tp(raw, 100)
        self.assertEqual(bufio.read(2), b"AA") # the read buffer gets filled
        self.assertEqual(bufio.truncate(), 2)
        self.assertEqual(bufio.write(b"BB"), 2) # the write buffer increases
        self.assertEqual(bufio.truncate(), 4)

2024 2025 2026 2027
    def test_misbehaved_io(self):
        BufferedReaderTest.test_misbehaved_io(self)
        BufferedWriterTest.test_misbehaved_io(self)

2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064
    def test_interleaved_read_write(self):
        # Test for issue #12213
        with self.BytesIO(b'abcdefgh') as raw:
            with self.tp(raw, 100) as f:
                f.write(b"1")
                self.assertEqual(f.read(1), b'b')
                f.write(b'2')
                self.assertEqual(f.read1(1), b'd')
                f.write(b'3')
                buf = bytearray(1)
                f.readinto(buf)
                self.assertEqual(buf, b'f')
                f.write(b'4')
                self.assertEqual(f.peek(1), b'h')
                f.flush()
                self.assertEqual(raw.getvalue(), b'1b2d3f4h')

        with self.BytesIO(b'abc') as raw:
            with self.tp(raw, 100) as f:
                self.assertEqual(f.read(1), b'a')
                f.write(b"2")
                self.assertEqual(f.read(1), b'c')
                f.flush()
                self.assertEqual(raw.getvalue(), b'a2c')

    def test_interleaved_readline_write(self):
        with self.BytesIO(b'ab\ncdef\ng\n') as raw:
            with self.tp(raw) as f:
                f.write(b'1')
                self.assertEqual(f.readline(), b'b\n')
                f.write(b'2')
                self.assertEqual(f.readline(), b'def\n')
                f.write(b'3')
                self.assertEqual(f.readline(), b'\n')
                f.flush()
                self.assertEqual(raw.getvalue(), b'1b\n2def\n3\n')

2065 2066 2067
    # You can't construct a BufferedRandom over a non-seekable stream.
    test_unseekable = None

2068

2069
class CBufferedRandomTest(BufferedRandomTest, SizeofTest):
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085
    tp = io.BufferedRandom

    def test_constructor(self):
        BufferedRandomTest.test_constructor(self)
        # The allocation can succeed on 32-bit builds, e.g. with more
        # than 2GB RAM and a 64-bit kernel.
        if sys.maxsize > 0x7FFFFFFF:
            rawio = self.MockRawIO()
            bufio = self.tp(rawio)
            self.assertRaises((OverflowError, MemoryError, ValueError),
                bufio.__init__, rawio, sys.maxsize)

    def test_garbage_collection(self):
        CBufferedReaderTest.test_garbage_collection(self)
        CBufferedWriterTest.test_garbage_collection(self)

2086 2087 2088 2089 2090 2091
    def test_args_error(self):
        # Issue #17275
        with self.assertRaisesRegex(TypeError, "BufferedRandom"):
            self.tp(io.BytesIO(), 1024, 1024, 1024)


2092 2093 2094 2095
class PyBufferedRandomTest(BufferedRandomTest):
    tp = pyio.BufferedRandom


2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125
# To fully exercise seek/tell, the StatefulIncrementalDecoder has these
# properties:
#   - A single output character can correspond to many bytes of input.
#   - The number of input bytes to complete the character can be
#     undetermined until the last input byte is received.
#   - The number of input bytes can vary depending on previous input.
#   - A single input byte can correspond to many characters of output.
#   - The number of output characters can be undetermined until the
#     last input byte is received.
#   - The number of output characters can vary depending on previous input.

class StatefulIncrementalDecoder(codecs.IncrementalDecoder):
    """
    For testing seek/tell behavior with a stateful, buffering decoder.

    Input is a sequence of words.  Words may be fixed-length (length set
    by input) or variable-length (period-terminated).  In variable-length
    mode, extra periods are ignored.  Possible words are:
      - 'i' followed by a number sets the input length, I (maximum 99).
        When I is set to 0, words are space-terminated.
      - 'o' followed by a number sets the output length, O (maximum 99).
      - Any other word is converted into a word followed by a period on
        the output.  The output word consists of the input word truncated
        or padded out with hyphens to make its length equal to O.  If O
        is 0, the word is output verbatim without truncating or padding.
    I and O are initially set to 1.  When I changes, any buffered input is
    re-scanned according to the new I.  EOF also terminates the last word.
    """

    def __init__(self, errors='strict'):
Christian Heimes's avatar
Christian Heimes committed
2126
        codecs.IncrementalDecoder.__init__(self, errors)
2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
        self.reset()

    def __repr__(self):
        return '<SID %x>' % id(self)

    def reset(self):
        self.i = 1
        self.o = 1
        self.buffer = bytearray()

    def getstate(self):
        i, o = self.i ^ 1, self.o ^ 1 # so that flags = 0 after reset()
        return bytes(self.buffer), i*100 + o

    def setstate(self, state):
        buffer, io = state
        self.buffer = bytearray(buffer)
        i, o = divmod(io, 100)
        self.i, self.o = i ^ 1, o ^ 1

    def decode(self, input, final=False):
        output = ''
        for b in input:
            if self.i == 0: # variable-length, terminated with period
                if b == ord('.'):
                    if self.buffer:
                        output += self.process_word()
                else:
                    self.buffer.append(b)
            else: # fixed-length, terminate after self.i bytes
                self.buffer.append(b)
                if len(self.buffer) == self.i:
                    output += self.process_word()
        if final and self.buffer: # EOF terminates the last word
            output += self.process_word()
        return output

    def process_word(self):
        output = ''
        if self.buffer[0] == ord('i'):
            self.i = min(99, int(self.buffer[1:] or 0)) # set input length
        elif self.buffer[0] == ord('o'):
            self.o = min(99, int(self.buffer[1:] or 0)) # set output length
        else:
            output = self.buffer.decode('ascii')
            if len(output) < self.o:
                output += '-'*self.o # pad out with hyphens
            if self.o:
                output = output[:self.o] # truncate to output length
            output += '.'
        self.buffer = bytearray()
        return output

2180 2181 2182 2183 2184
    codecEnabled = False

    @classmethod
    def lookupTestDecoder(cls, name):
        if cls.codecEnabled and name == 'test_decoder':
2185
            latin1 = codecs.lookup('latin-1')
2186
            return codecs.CodecInfo(
2187
                name='test_decoder', encode=latin1.encode, decode=None,
2188 2189 2190 2191 2192 2193 2194 2195 2196
                incrementalencoder=None,
                streamreader=None, streamwriter=None,
                incrementaldecoder=cls)

# Register the previous decoder for testing.
# Disabled by default, tests will enable it.
codecs.register(StatefulIncrementalDecoder.lookupTestDecoder)


2197 2198 2199 2200 2201 2202
class StatefulIncrementalDecoderTest(unittest.TestCase):
    """
    Make sure the StatefulIncrementalDecoder actually works.
    """

    test_cases = [
2203
        # I=1, O=1 (fixed-length input == fixed-length output)
2204
        (b'abcd', False, 'a.b.c.d.'),
2205
        # I=0, O=0 (variable-length input, variable-length output)
2206
        (b'oiabcd', True, 'abcd.'),
2207
        # I=0, O=0 (should ignore extra periods)
2208
        (b'oi...abcd...', True, 'abcd.'),
2209 2210 2211
        # I=0, O=6 (variable-length input, fixed-length output)
        (b'i.o6.x.xyz.toolongtofit.', False, 'x-----.xyz---.toolon.'),
        # I=2, O=6 (fixed-length input < fixed-length output)
2212
        (b'i.i2.o6xyz', True, 'xy----.z-----.'),
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226
        # I=6, O=3 (fixed-length input > fixed-length output)
        (b'i.o3.i6.abcdefghijklmnop', True, 'abc.ghi.mno.'),
        # I=0, then 3; O=29, then 15 (with longer output)
        (b'i.o29.a.b.cde.o15.abcdefghijabcdefghij.i3.a.b.c.d.ei00k.l.m', True,
         'a----------------------------.' +
         'b----------------------------.' +
         'cde--------------------------.' +
         'abcdefghijabcde.' +
         'a.b------------.' +
         '.c.------------.' +
         'd.e------------.' +
         'k--------------.' +
         'l--------------.' +
         'm--------------.')
2227 2228
    ]

2229
    def test_decoder(self):
2230 2231 2232
        # Try a few one-shot test cases.
        for input, eof, output in self.test_cases:
            d = StatefulIncrementalDecoder()
2233
            self.assertEqual(d.decode(input, eof), output)
2234 2235 2236

        # Also test an unfinished decode, followed by forcing EOF.
        d = StatefulIncrementalDecoder()
2237 2238
        self.assertEqual(d.decode(b'oiabcd'), '')
        self.assertEqual(d.decode(b'', 1), 'abcd.')
2239 2240

class TextIOWrapperTest(unittest.TestCase):
2241

2242 2243 2244
    def setUp(self):
        self.testdata = b"AAA\r\nBBB\rCCC\r\nDDD\nEEE\r\n"
        self.normalized = b"AAA\nBBB\nCCC\nDDD\nEEE\n".decode("ascii")
2245
        support.unlink(support.TESTFN)
2246

Guido van Rossum's avatar
Guido van Rossum committed
2247
    def tearDown(self):
2248
        support.unlink(support.TESTFN)
2249

2250 2251 2252 2253
    def test_constructor(self):
        r = self.BytesIO(b"\xc3\xa9\n\n")
        b = self.BufferedReader(r, 1000)
        t = self.TextIOWrapper(b)
2254 2255
        t.__init__(b, encoding="latin-1", newline="\r\n")
        self.assertEqual(t.encoding, "latin-1")
2256
        self.assertEqual(t.line_buffering, False)
2257 2258
        t.__init__(b, encoding="utf-8", line_buffering=True)
        self.assertEqual(t.encoding, "utf-8")
2259 2260
        self.assertEqual(t.line_buffering, True)
        self.assertEqual("\xe9\n", t.readline())
2261 2262 2263
        self.assertRaises(TypeError, t.__init__, b, newline=42)
        self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')

2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274
    def test_uninitialized(self):
        t = self.TextIOWrapper.__new__(self.TextIOWrapper)
        del t
        t = self.TextIOWrapper.__new__(self.TextIOWrapper)
        self.assertRaises(Exception, repr, t)
        self.assertRaisesRegex((ValueError, AttributeError),
                               'uninitialized|has no attribute',
                               t.read, 0)
        t.__init__(self.MockRawIO())
        self.assertEqual(t.read(0), '')

2275 2276 2277 2278 2279 2280 2281 2282 2283
    def test_non_text_encoding_codecs_are_rejected(self):
        # Ensure the constructor complains if passed a codec that isn't
        # marked as a text encoding
        # http://bugs.python.org/issue20404
        r = self.BytesIO()
        b = self.BufferedWriter(r)
        with self.assertRaisesRegex(LookupError, "is not a text encoding"):
            self.TextIOWrapper(b, encoding="hex")

2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296
    def test_detach(self):
        r = self.BytesIO()
        b = self.BufferedWriter(r)
        t = self.TextIOWrapper(b)
        self.assertIs(t.detach(), b)

        t = self.TextIOWrapper(b, encoding="ascii")
        t.write("howdy")
        self.assertFalse(r.getvalue())
        t.detach()
        self.assertEqual(r.getvalue(), b"howdy")
        self.assertRaises(ValueError, t.detach)

2297 2298 2299 2300 2301 2302
        # Operations independent of the detached stream should still work
        repr(t)
        self.assertEqual(t.encoding, "ascii")
        self.assertEqual(t.errors, "strict")
        self.assertFalse(t.line_buffering)

2303 2304 2305 2306
    def test_repr(self):
        raw = self.BytesIO("hello".encode("utf-8"))
        b = self.BufferedReader(raw)
        t = self.TextIOWrapper(b, encoding="utf-8")
2307 2308 2309 2310 2311 2312
        modname = self.TextIOWrapper.__module__
        self.assertEqual(repr(t),
                         "<%s.TextIOWrapper encoding='utf-8'>" % modname)
        raw.name = "dummy"
        self.assertEqual(repr(t),
                         "<%s.TextIOWrapper name='dummy' encoding='utf-8'>" % modname)
2313 2314 2315
        t.mode = "r"
        self.assertEqual(repr(t),
                         "<%s.TextIOWrapper name='dummy' mode='r' encoding='utf-8'>" % modname)
2316 2317
        raw.name = b"dummy"
        self.assertEqual(repr(t),
2318
                         "<%s.TextIOWrapper name=b'dummy' mode='r' encoding='utf-8'>" % modname)
2319

2320 2321 2322
        t.buffer.detach()
        repr(t)  # Should not raise an exception

2323 2324 2325 2326
    def test_line_buffering(self):
        r = self.BytesIO()
        b = self.BufferedWriter(r, 1000)
        t = self.TextIOWrapper(b, newline="\n", line_buffering=True)
2327
        t.write("X")
2328
        self.assertEqual(r.getvalue(), b"")  # No flush happened
2329
        t.write("Y\nZ")
2330
        self.assertEqual(r.getvalue(), b"XY\nZ")  # All got flushed
2331
        t.write("A\rB")
2332
        self.assertEqual(r.getvalue(), b"XY\nZA\rB")
2333

2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
    def test_default_encoding(self):
        old_environ = dict(os.environ)
        try:
            # try to get a user preferred encoding different than the current
            # locale encoding to check that TextIOWrapper() uses the current
            # locale encoding and not the user preferred encoding
            for key in ('LC_ALL', 'LANG', 'LC_CTYPE'):
                if key in os.environ:
                    del os.environ[key]

            current_locale_encoding = locale.getpreferredencoding(False)
            b = self.BytesIO()
            t = self.TextIOWrapper(b)
            self.assertEqual(t.encoding, current_locale_encoding)
        finally:
            os.environ.clear()
            os.environ.update(old_environ)

2352
    @support.cpython_only
2353
    def test_device_encoding(self):
2354 2355
        # Issue 15989
        import _testcapi
2356 2357 2358 2359 2360 2361
        b = self.BytesIO()
        b.fileno = lambda: _testcapi.INT_MAX + 1
        self.assertRaises(OverflowError, self.TextIOWrapper, b)
        b.fileno = lambda: _testcapi.UINT_MAX + 1
        self.assertRaises(OverflowError, self.TextIOWrapper, b)

2362 2363 2364
    def test_encoding(self):
        # Check the encoding attribute is always set, and valid
        b = self.BytesIO()
2365 2366
        t = self.TextIOWrapper(b, encoding="utf-8")
        self.assertEqual(t.encoding, "utf-8")
2367
        t = self.TextIOWrapper(b)
2368
        self.assertIsNotNone(t.encoding)
2369 2370 2371
        codecs.lookup(t.encoding)

    def test_encoding_errors_reading(self):
2372
        # (1) default
2373 2374
        b = self.BytesIO(b"abc\n\xff\n")
        t = self.TextIOWrapper(b, encoding="ascii")
2375 2376
        self.assertRaises(UnicodeError, t.read)
        # (2) explicit strict
2377 2378
        b = self.BytesIO(b"abc\n\xff\n")
        t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
2379 2380
        self.assertRaises(UnicodeError, t.read)
        # (3) ignore
2381 2382
        b = self.BytesIO(b"abc\n\xff\n")
        t = self.TextIOWrapper(b, encoding="ascii", errors="ignore")
2383
        self.assertEqual(t.read(), "abc\n\n")
2384
        # (4) replace
2385 2386
        b = self.BytesIO(b"abc\n\xff\n")
        t = self.TextIOWrapper(b, encoding="ascii", errors="replace")
2387
        self.assertEqual(t.read(), "abc\n\ufffd\n")
2388

2389
    def test_encoding_errors_writing(self):
2390
        # (1) default
2391 2392
        b = self.BytesIO()
        t = self.TextIOWrapper(b, encoding="ascii")
2393 2394
        self.assertRaises(UnicodeError, t.write, "\xff")
        # (2) explicit strict
2395 2396
        b = self.BytesIO()
        t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
2397 2398
        self.assertRaises(UnicodeError, t.write, "\xff")
        # (3) ignore
2399 2400
        b = self.BytesIO()
        t = self.TextIOWrapper(b, encoding="ascii", errors="ignore",
2401
                             newline="\n")
2402 2403
        t.write("abc\xffdef\n")
        t.flush()
2404
        self.assertEqual(b.getvalue(), b"abcdef\n")
2405
        # (4) replace
2406 2407
        b = self.BytesIO()
        t = self.TextIOWrapper(b, encoding="ascii", errors="replace",
2408
                             newline="\n")
2409 2410
        t.write("abc\xffdef\n")
        t.flush()
2411
        self.assertEqual(b.getvalue(), b"abc?def\n")
2412

2413
    def test_newlines(self):
2414 2415 2416 2417
        input_lines = [ "unix\n", "windows\r\n", "os9\r", "last\n", "nonl" ]

        tests = [
            [ None, [ 'unix\n', 'windows\n', 'os9\n', 'last\n', 'nonl' ] ],
2418 2419 2420 2421
            [ '', input_lines ],
            [ '\n', [ "unix\n", "windows\r\n", "os9\rlast\n", "nonl" ] ],
            [ '\r\n', [ "unix\nwindows\r\n", "os9\rlast\nnonl" ] ],
            [ '\r', [ "unix\nwindows\r", "\nos9\r", "last\nnonl" ] ],
2422
        ]
2423 2424 2425 2426 2427
        encodings = (
            'utf-8', 'latin-1',
            'utf-16', 'utf-16-le', 'utf-16-be',
            'utf-32', 'utf-32-le', 'utf-32-be',
        )
2428

2429
        # Try a range of buffer sizes to test the case where \r is the last
2430 2431
        # character in TextIOWrapper._pending_line.
        for encoding in encodings:
2432 2433
            # XXX: str.encode() should return bytes
            data = bytes(''.join(input_lines).encode(encoding))
2434
            for do_reads in (False, True):
2435 2436
                for bufsize in range(1, 10):
                    for newline, exp_lines in tests:
2437 2438
                        bufio = self.BufferedReader(self.BytesIO(data), bufsize)
                        textio = self.TextIOWrapper(bufio, newline=newline,
2439 2440 2441 2442
                                                  encoding=encoding)
                        if do_reads:
                            got_lines = []
                            while True:
Guido van Rossum's avatar
Guido van Rossum committed
2443
                                c2 = textio.read(2)
2444 2445
                                if c2 == '':
                                    break
2446
                                self.assertEqual(len(c2), 2)
Guido van Rossum's avatar
Guido van Rossum committed
2447
                                got_lines.append(c2 + textio.readline())
2448
                        else:
Guido van Rossum's avatar
Guido van Rossum committed
2449
                            got_lines = list(textio)
2450 2451

                        for got_line, exp_line in zip(got_lines, exp_lines):
2452 2453
                            self.assertEqual(got_line, exp_line)
                        self.assertEqual(len(got_lines), len(exp_lines))
2454

2455 2456
    def test_newlines_input(self):
        testdata = b"AAA\nBB\x00B\nCCC\rDDD\rEEE\r\nFFF\r\nGGG"
2457 2458
        normalized = testdata.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
        for newline, expected in [
2459 2460
            (None, normalized.decode("ascii").splitlines(keepends=True)),
            ("", testdata.decode("ascii").splitlines(keepends=True)),
2461 2462 2463
            ("\n", ["AAA\n", "BB\x00B\n", "CCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
            ("\r\n", ["AAA\nBB\x00B\nCCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
            ("\r",  ["AAA\nBB\x00B\nCCC\r", "DDD\r", "EEE\r", "\nFFF\r", "\nGGG"]),
2464
            ]:
2465 2466
            buf = self.BytesIO(testdata)
            txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
2467
            self.assertEqual(txt.readlines(), expected)
2468
            txt.seek(0)
2469
            self.assertEqual(txt.read(), "".join(expected))
2470

2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485
    def test_newlines_output(self):
        testdict = {
            "": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
            "\n": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
            "\r": b"AAA\rBBB\rCCC\rX\rY\r\rZ",
            "\r\n": b"AAA\r\nBBB\r\nCCC\r\nX\rY\r\r\nZ",
            }
        tests = [(None, testdict[os.linesep])] + sorted(testdict.items())
        for newline, expected in tests:
            buf = self.BytesIO()
            txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
            txt.write("AAA\nB")
            txt.write("BB\nCCC\n")
            txt.write("X\rY\r\nZ")
            txt.flush()
2486 2487
            self.assertEqual(buf.closed, False)
            self.assertEqual(buf.getvalue(), expected)
2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499

    def test_destructor(self):
        l = []
        base = self.BytesIO
        class MyBytesIO(base):
            def close(self):
                l.append(self.getvalue())
                base.close(self)
        b = MyBytesIO()
        t = self.TextIOWrapper(b, encoding="ascii")
        t.write("abc")
        del t
2500
        support.gc_collect()
2501
        self.assertEqual([b"abc"], l)
2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522

    def test_override_destructor(self):
        record = []
        class MyTextIO(self.TextIOWrapper):
            def __del__(self):
                record.append(1)
                try:
                    f = super().__del__
                except AttributeError:
                    pass
                else:
                    f()
            def close(self):
                record.append(2)
                super().close()
            def flush(self):
                record.append(3)
                super().flush()
        b = self.BytesIO()
        t = MyTextIO(b, encoding="ascii")
        del t
2523
        support.gc_collect()
2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
        self.assertEqual(record, [1, 2, 3])

    def test_error_through_destructor(self):
        # Test that the exception state is not modified by a destructor,
        # even if close() fails.
        rawio = self.CloseFailureIO()
        def f():
            self.TextIOWrapper(rawio).xyzzy
        with support.captured_output("stderr") as s:
            self.assertRaises(AttributeError, f)
        s = s.getvalue().strip()
        if s:
            # The destructor *may* have printed an unraisable error, check it
            self.assertEqual(len(s.splitlines()), 1)
2538
            self.assertTrue(s.startswith("Exception OSError: "), s)
2539
            self.assertTrue(s.endswith(" ignored"), s)
2540

2541 2542
    # Systematic tests of the text I/O API

2543
    def test_basic_io(self):
2544
        for chunksize in (1, 2, 3, 4, 5, 15, 16, 17, 31, 32, 33, 63, 64, 65):
2545
            for enc in "ascii", "latin-1", "utf-8" :# , "utf-16-be", "utf-16-le":
2546
                f = self.open(support.TESTFN, "w+", encoding=enc)
2547
                f._CHUNK_SIZE = chunksize
2548
                self.assertEqual(f.write("abc"), 3)
2549
                f.close()
2550
                f = self.open(support.TESTFN, "r+", encoding=enc)
2551
                f._CHUNK_SIZE = chunksize
2552 2553
                self.assertEqual(f.tell(), 0)
                self.assertEqual(f.read(), "abc")
2554
                cookie = f.tell()
2555 2556
                self.assertEqual(f.seek(0), 0)
                self.assertEqual(f.read(None), "abc")
2557
                f.seek(0)
2558 2559 2560 2561 2562 2563 2564 2565 2566 2567
                self.assertEqual(f.read(2), "ab")
                self.assertEqual(f.read(1), "c")
                self.assertEqual(f.read(1), "")
                self.assertEqual(f.read(), "")
                self.assertEqual(f.tell(), cookie)
                self.assertEqual(f.seek(0), 0)
                self.assertEqual(f.seek(0, 2), cookie)
                self.assertEqual(f.write("def"), 3)
                self.assertEqual(f.seek(cookie), cookie)
                self.assertEqual(f.read(), "def")
2568 2569 2570 2571 2572 2573 2574
                if enc.startswith("utf"):
                    self.multi_line_test(f, enc)
                f.close()

    def multi_line_test(self, f, enc):
        f.seek(0)
        f.truncate()
2575
        sample = "s\xff\u0fff\uffff"
2576
        wlines = []
2577
        for size in (0, 1, 2, 3, 4, 5, 30, 31, 32, 33, 62, 63, 64, 65, 1000):
2578
            chars = []
2579
            for i in range(size):
2580
                chars.append(sample[i % len(sample)])
2581
            line = "".join(chars) + "\n"
2582 2583 2584 2585 2586 2587 2588 2589 2590 2591
            wlines.append((f.tell(), line))
            f.write(line)
        f.seek(0)
        rlines = []
        while True:
            pos = f.tell()
            line = f.readline()
            if not line:
                break
            rlines.append((pos, line))
2592
        self.assertEqual(rlines, wlines)
2593

2594
    def test_telling(self):
2595
        f = self.open(support.TESTFN, "w+", encoding="utf-8")
2596
        p0 = f.tell()
2597
        f.write("\xff\n")
2598
        p1 = f.tell()
2599
        f.write("\xff\n")
2600 2601
        p2 = f.tell()
        f.seek(0)
2602 2603 2604 2605 2606
        self.assertEqual(f.tell(), p0)
        self.assertEqual(f.readline(), "\xff\n")
        self.assertEqual(f.tell(), p1)
        self.assertEqual(f.readline(), "\xff\n")
        self.assertEqual(f.tell(), p2)
2607 2608
        f.seek(0)
        for line in f:
2609
            self.assertEqual(line, "\xff\n")
2610
            self.assertRaises(OSError, f.tell)
2611
        self.assertEqual(f.tell(), p2)
2612 2613
        f.close()

2614 2615
    def test_seeking(self):
        chunk_size = _default_chunk_size()
2616
        prefix_size = chunk_size - 2
2617
        u_prefix = "a" * prefix_size
2618
        prefix = bytes(u_prefix.encode("utf-8"))
2619
        self.assertEqual(len(u_prefix), len(prefix))
2620
        u_suffix = "\u8888\n"
2621 2622
        suffix = bytes(u_suffix.encode("utf-8"))
        line = prefix + suffix
Benjamin Peterson's avatar
Benjamin Peterson committed
2623 2624 2625 2626
        with self.open(support.TESTFN, "wb") as f:
            f.write(line*2)
        with self.open(support.TESTFN, "r", encoding="utf-8") as f:
            s = f.read(prefix_size)
2627 2628 2629
            self.assertEqual(s, str(prefix, "ascii"))
            self.assertEqual(f.tell(), prefix_size)
            self.assertEqual(f.readline(), u_suffix)
2630

2631
    def test_seeking_too(self):
2632 2633
        # Regression test for a specific bug
        data = b'\xe0\xbf\xbf\n'
Benjamin Peterson's avatar
Benjamin Peterson committed
2634 2635 2636 2637 2638 2639 2640
        with self.open(support.TESTFN, "wb") as f:
            f.write(data)
        with self.open(support.TESTFN, "r", encoding="utf-8") as f:
            f._CHUNK_SIZE  # Just test that it exists
            f._CHUNK_SIZE = 2
            f.readline()
            f.tell()
2641

2642 2643 2644 2645
    def test_seek_and_tell(self):
        #Test seek/tell using the StatefulIncrementalDecoder.
        # Make test faster by doing smaller seeks
        CHUNK_SIZE = 128
2646

Benjamin Peterson's avatar
Benjamin Peterson committed
2647
        def test_seek_and_tell_with_data(data, min_pos=0):
2648 2649
            """Tell/seek to various points within a data stream and ensure
            that the decoded data returned by read() is consistent."""
2650
            f = self.open(support.TESTFN, 'wb')
2651 2652
            f.write(data)
            f.close()
2653 2654
            f = self.open(support.TESTFN, encoding='test_decoder')
            f._CHUNK_SIZE = CHUNK_SIZE
2655 2656 2657
            decoded = f.read()
            f.close()

2658 2659
            for i in range(min_pos, len(decoded) + 1): # seek positions
                for j in [1, 5, len(decoded) - i]: # read lengths
2660
                    f = self.open(support.TESTFN, encoding='test_decoder')
2661
                    self.assertEqual(f.read(i), decoded[:i])
2662
                    cookie = f.tell()
2663
                    self.assertEqual(f.read(j), decoded[i:i + j])
2664
                    f.seek(cookie)
2665
                    self.assertEqual(f.read(), decoded[i:])
2666 2667
                    f.close()

2668 2669
        # Enable the test decoder.
        StatefulIncrementalDecoder.codecEnabled = 1
2670 2671 2672 2673 2674

        # Run the tests.
        try:
            # Try each test case.
            for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
Benjamin Peterson's avatar
Benjamin Peterson committed
2675
                test_seek_and_tell_with_data(input)
2676 2677 2678 2679 2680 2681 2682

            # Position each test case so that it crosses a chunk boundary.
            for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
                offset = CHUNK_SIZE - len(input)//2
                prefix = b'.'*offset
                # Don't bother seeking into the prefix (takes too long).
                min_pos = offset*2
Benjamin Peterson's avatar
Benjamin Peterson committed
2683
                test_seek_and_tell_with_data(prefix + input, min_pos)
2684 2685 2686

        # Ensure our test decoder won't interfere with subsequent tests.
        finally:
2687
            StatefulIncrementalDecoder.codecEnabled = 0
2688

2689
    def test_encoded_writes(self):
2690 2691 2692 2693 2694 2695 2696 2697
        data = "1234567890"
        tests = ("utf-16",
                 "utf-16-le",
                 "utf-16-be",
                 "utf-32",
                 "utf-32-le",
                 "utf-32-be")
        for encoding in tests:
2698 2699
            buf = self.BytesIO()
            f = self.TextIOWrapper(buf, encoding=encoding)
2700 2701 2702 2703
            # Check if the BOM is written only once (see issue1753).
            f.write(data)
            f.write(data)
            f.seek(0)
2704
            self.assertEqual(f.read(), data * 2)
2705
            f.seek(0)
2706 2707
            self.assertEqual(f.read(), data * 2)
            self.assertEqual(buf.getvalue(), (data * 2).encode(encoding))
2708

2709 2710 2711 2712 2713
    def test_unreadable(self):
        class UnReadable(self.BytesIO):
            def readable(self):
                return False
        txt = self.TextIOWrapper(UnReadable())
2714
        self.assertRaises(OSError, txt.read)
2715

2716 2717
    def test_read_one_by_one(self):
        txt = self.TextIOWrapper(self.BytesIO(b"AA\r\nBB"))
2718 2719 2720 2721 2722 2723
        reads = ""
        while True:
            c = txt.read(1)
            if not c:
                break
            reads += c
2724
        self.assertEqual(reads, "AA\nBB")
2725

2726 2727 2728 2729 2730 2731 2732 2733
    def test_readlines(self):
        txt = self.TextIOWrapper(self.BytesIO(b"AA\nBB\nCC"))
        self.assertEqual(txt.readlines(), ["AA\n", "BB\n", "CC"])
        txt.seek(0)
        self.assertEqual(txt.readlines(None), ["AA\n", "BB\n", "CC"])
        txt.seek(0)
        self.assertEqual(txt.readlines(5), ["AA\n", "BB\n"])

2734
    # read in amounts equal to TextIOWrapper._CHUNK_SIZE which is 128.
2735
    def test_read_by_chunk(self):
2736
        # make sure "\r\n" straddles 128 char boundary.
2737
        txt = self.TextIOWrapper(self.BytesIO(b"A" * 127 + b"\r\nB"))
2738 2739 2740 2741 2742 2743
        reads = ""
        while True:
            c = txt.read(128)
            if not c:
                break
            reads += c
2744
        self.assertEqual(reads, "A"*127+"\nB")
2745

2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767
    def test_writelines(self):
        l = ['ab', 'cd', 'ef']
        buf = self.BytesIO()
        txt = self.TextIOWrapper(buf)
        txt.writelines(l)
        txt.flush()
        self.assertEqual(buf.getvalue(), b'abcdef')

    def test_writelines_userlist(self):
        l = UserList(['ab', 'cd', 'ef'])
        buf = self.BytesIO()
        txt = self.TextIOWrapper(buf)
        txt.writelines(l)
        txt.flush()
        self.assertEqual(buf.getvalue(), b'abcdef')

    def test_writelines_error(self):
        txt = self.TextIOWrapper(self.BytesIO())
        self.assertRaises(TypeError, txt.writelines, [1, 2, 3])
        self.assertRaises(TypeError, txt.writelines, None)
        self.assertRaises(TypeError, txt.writelines, b'abc')

2768
    def test_issue1395_1(self):
2769
        txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2770 2771 2772 2773 2774 2775 2776 2777

        # read one char at a time
        reads = ""
        while True:
            c = txt.read(1)
            if not c:
                break
            reads += c
2778
        self.assertEqual(reads, self.normalized)
2779 2780

    def test_issue1395_2(self):
2781
        txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2782 2783 2784 2785 2786 2787 2788 2789
        txt._CHUNK_SIZE = 4

        reads = ""
        while True:
            c = txt.read(4)
            if not c:
                break
            reads += c
2790
        self.assertEqual(reads, self.normalized)
2791 2792

    def test_issue1395_3(self):
2793
        txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2794 2795 2796 2797 2798 2799 2800
        txt._CHUNK_SIZE = 4

        reads = txt.read(4)
        reads += txt.read(4)
        reads += txt.readline()
        reads += txt.readline()
        reads += txt.readline()
2801
        self.assertEqual(reads, self.normalized)
2802 2803

    def test_issue1395_4(self):
2804
        txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2805 2806 2807 2808
        txt._CHUNK_SIZE = 4

        reads = txt.read(4)
        reads += txt.read()
2809
        self.assertEqual(reads, self.normalized)
2810 2811

    def test_issue1395_5(self):
2812
        txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2813 2814 2815 2816 2817 2818
        txt._CHUNK_SIZE = 4

        reads = txt.read(4)
        pos = txt.tell()
        txt.seek(0)
        txt.seek(pos)
2819
        self.assertEqual(txt.read(4), "BBB\n")
2820

2821
    def test_issue2282(self):
2822 2823
        buffer = self.BytesIO(self.testdata)
        txt = self.TextIOWrapper(buffer, encoding="ascii")
2824 2825 2826

        self.assertEqual(buffer.seekable(), txt.seekable())

2827 2828 2829 2830 2831 2832 2833 2834
    def test_append_bom(self):
        # The BOM is not written again when appending to a non-empty file
        filename = support.TESTFN
        for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
            with self.open(filename, 'w', encoding=charset) as f:
                f.write('aaa')
                pos = f.tell()
            with self.open(filename, 'rb') as f:
2835
                self.assertEqual(f.read(), 'aaa'.encode(charset))
2836 2837 2838 2839

            with self.open(filename, 'a', encoding=charset) as f:
                f.write('xxx')
            with self.open(filename, 'rb') as f:
2840
                self.assertEqual(f.read(), 'aaaxxx'.encode(charset))
2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854

    def test_seek_bom(self):
        # Same test, but when seeking manually
        filename = support.TESTFN
        for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
            with self.open(filename, 'w', encoding=charset) as f:
                f.write('aaa')
                pos = f.tell()
            with self.open(filename, 'r+', encoding=charset) as f:
                f.seek(pos)
                f.write('zzz')
                f.seek(0)
                f.write('bbb')
            with self.open(filename, 'rb') as f:
2855
                self.assertEqual(f.read(), 'bbbzzz'.encode(charset))
2856

2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869
    def test_seek_append_bom(self):
        # Same test, but first seek to the start and then to the end
        filename = support.TESTFN
        for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
            with self.open(filename, 'w', encoding=charset) as f:
                f.write('aaa')
            with self.open(filename, 'a', encoding=charset) as f:
                f.seek(0)
                f.seek(0, self.SEEK_END)
                f.write('xxx')
            with self.open(filename, 'rb') as f:
                self.assertEqual(f.read(), 'aaaxxx'.encode(charset))

2870 2871 2872 2873 2874 2875
    def test_errors_property(self):
        with self.open(support.TESTFN, "w") as f:
            self.assertEqual(f.errors, "strict")
        with self.open(support.TESTFN, "w", errors="replace") as f:
            self.assertEqual(f.errors, "replace")

2876
    @support.no_tracing
2877
    @unittest.skipUnless(threading, 'Threading required for this test.')
2878 2879 2880 2881 2882 2883 2884 2885
    def test_threads_write(self):
        # Issue6750: concurrent writes could duplicate data
        event = threading.Event()
        with self.open(support.TESTFN, "w", buffering=1) as f:
            def run(n):
                text = "Thread%03d\n" % n
                event.wait()
                f.write(text)
2886
            threads = [threading.Thread(target=run, args=(x,))
2887
                       for x in range(20)]
2888 2889
            with support.start_threads(threads, event.set):
                time.sleep(0.02)
2890 2891 2892
        with self.open(support.TESTFN) as f:
            content = f.read()
            for n in range(20):
2893
                self.assertEqual(content.count("Thread%03d\n" % n), 1)
2894

2895
    def test_flush_error_on_close(self):
2896 2897
        # Test that text file is closed despite failed flush
        # and that flush() is called before file closed.
2898
        txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2899
        closed = []
2900
        def bad_flush():
2901
            closed[:] = [txt.closed, txt.buffer.closed]
2902
            raise OSError()
2903
        txt.flush = bad_flush
2904
        self.assertRaises(OSError, txt.close) # exception not swallowed
2905
        self.assertTrue(txt.closed)
2906 2907 2908 2909
        self.assertTrue(txt.buffer.closed)
        self.assertTrue(closed)      # flush() called
        self.assertFalse(closed[0])  # flush() called before file closed
        self.assertFalse(closed[1])
2910
        txt.flush = lambda: None  # break reference loop
2911

2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944
    def test_close_error_on_close(self):
        buffer = self.BytesIO(self.testdata)
        def bad_flush():
            raise OSError('flush')
        def bad_close():
            raise OSError('close')
        buffer.close = bad_close
        txt = self.TextIOWrapper(buffer, encoding="ascii")
        txt.flush = bad_flush
        with self.assertRaises(OSError) as err: # exception not swallowed
            txt.close()
        self.assertEqual(err.exception.args, ('close',))
        self.assertIsInstance(err.exception.__context__, OSError)
        self.assertEqual(err.exception.__context__.args, ('flush',))
        self.assertFalse(txt.closed)

    def test_nonnormalized_close_error_on_close(self):
        # Issue #21677
        buffer = self.BytesIO(self.testdata)
        def bad_flush():
            raise non_existing_flush
        def bad_close():
            raise non_existing_close
        buffer.close = bad_close
        txt = self.TextIOWrapper(buffer, encoding="ascii")
        txt.flush = bad_flush
        with self.assertRaises(NameError) as err: # exception not swallowed
            txt.close()
        self.assertIn('non_existing_close', str(err.exception))
        self.assertIsInstance(err.exception.__context__, NameError)
        self.assertIn('non_existing_flush', str(err.exception.__context__))
        self.assertFalse(txt.closed)

2945 2946 2947 2948 2949 2950 2951
    def test_multi_close(self):
        txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
        txt.close()
        txt.close()
        txt.close()
        self.assertRaises(ValueError, txt.flush)

2952 2953 2954 2955 2956
    def test_unseekable(self):
        txt = self.TextIOWrapper(self.MockUnseekableIO(self.testdata))
        self.assertRaises(self.UnsupportedOperation, txt.tell)
        self.assertRaises(self.UnsupportedOperation, txt.seek, 0)

2957 2958 2959 2960 2961 2962
    def test_readonly_attributes(self):
        txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
        buf = self.BytesIO(self.testdata)
        with self.assertRaises(AttributeError):
            txt.buffer = buf

2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983
    def test_rawio(self):
        # Issue #12591: TextIOWrapper must work with raw I/O objects, so
        # that subprocess.Popen() can have the required unbuffered
        # semantics with universal_newlines=True.
        raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n'])
        txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n')
        # Reads
        self.assertEqual(txt.read(4), 'abcd')
        self.assertEqual(txt.readline(), 'efghi\n')
        self.assertEqual(list(txt), ['jkl\n', 'opq\n'])

    def test_rawio_write_through(self):
        # Issue #12591: with write_through=True, writes don't need a flush
        raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n'])
        txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n',
                                 write_through=True)
        txt.write('1')
        txt.write('23\n4')
        txt.write('5')
        self.assertEqual(b''.join(raw._write_stack), b'123\n45')

2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015
    def test_bufio_write_through(self):
        # Issue #21396: write_through=True doesn't force a flush()
        # on the underlying binary buffered object.
        flush_called, write_called = [], []
        class BufferedWriter(self.BufferedWriter):
            def flush(self, *args, **kwargs):
                flush_called.append(True)
                return super().flush(*args, **kwargs)
            def write(self, *args, **kwargs):
                write_called.append(True)
                return super().write(*args, **kwargs)

        rawio = self.BytesIO()
        data = b"a"
        bufio = BufferedWriter(rawio, len(data)*2)
        textio = self.TextIOWrapper(bufio, encoding='ascii',
                                    write_through=True)
        # write to the buffered io but don't overflow the buffer
        text = data.decode('ascii')
        textio.write(text)

        # buffer.flush is not called with write_through=True
        self.assertFalse(flush_called)
        # buffer.write *is* called with write_through=True
        self.assertTrue(write_called)
        self.assertEqual(rawio.getvalue(), b"") # no flush

        write_called = [] # reset
        textio.write(text * 10) # total content is larger than bufio buffer
        self.assertTrue(write_called)
        self.assertEqual(rawio.getvalue(), data * 11) # all flushed

3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027
    def test_read_nonbytes(self):
        # Issue #17106
        # Crash when underlying read() returns non-bytes
        t = self.TextIOWrapper(self.StringIO('a'))
        self.assertRaises(TypeError, t.read, 1)
        t = self.TextIOWrapper(self.StringIO('a'))
        self.assertRaises(TypeError, t.readline)
        t = self.TextIOWrapper(self.StringIO('a'))
        self.assertRaises(TypeError, t.read)

    def test_illegal_decoder(self):
        # Issue #17106
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037
        # Bypass the early encoding check added in issue 20404
        def _make_illegal_wrapper():
            quopri = codecs.lookup("quopri")
            quopri._is_text_encoding = True
            try:
                t = self.TextIOWrapper(self.BytesIO(b'aaaaaa'),
                                       newline='\n', encoding="quopri")
            finally:
                quopri._is_text_encoding = False
            return t
3038
        # Crash when decoder returns non-string
3039
        t = _make_illegal_wrapper()
3040
        self.assertRaises(TypeError, t.read, 1)
3041
        t = _make_illegal_wrapper()
3042
        self.assertRaises(TypeError, t.readline)
3043
        t = _make_illegal_wrapper()
3044 3045
        self.assertRaises(TypeError, t.read)

3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071
    def _check_create_at_shutdown(self, **kwargs):
        # Issue #20037: creating a TextIOWrapper at shutdown
        # shouldn't crash the interpreter.
        iomod = self.io.__name__
        code = """if 1:
            import codecs
            import {iomod} as io

            # Avoid looking up codecs at shutdown
            codecs.lookup('utf-8')

            class C:
                def __init__(self):
                    self.buf = io.BytesIO()
                def __del__(self):
                    io.TextIOWrapper(self.buf, **{kwargs})
                    print("ok")
            c = C()
            """.format(iomod=iomod, kwargs=kwargs)
        return assert_python_ok("-c", code)

    def test_create_at_shutdown_without_encoding(self):
        rc, out, err = self._check_create_at_shutdown()
        if err:
            # Can error out with a RuntimeError if the module state
            # isn't found.
3072
            self.assertIn(self.shutdown_error, err.decode())
3073 3074 3075 3076 3077 3078 3079 3080 3081
        else:
            self.assertEqual("ok", out.decode().strip())

    def test_create_at_shutdown_with_encoding(self):
        rc, out, err = self._check_create_at_shutdown(encoding='utf-8',
                                                      errors='strict')
        self.assertFalse(err)
        self.assertEqual("ok", out.decode().strip())

3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092
    def test_read_byteslike(self):
        r = MemviewBytesIO(b'Just some random string\n')
        t = self.TextIOWrapper(r, 'utf-8')

        # TextIOwrapper will not read the full string, because
        # we truncate it to a multiple of the native int size
        # so that we can construct a more complex memoryview.
        bytes_val =  _to_memoryview(r.getvalue()).tobytes()

        self.assertEqual(t.read(200), bytes_val.decode('utf-8'))

3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107
    def test_issue22849(self):
        class F(object):
            def readable(self): return True
            def writable(self): return True
            def seekable(self): return True

        for i in range(10):
            try:
                self.TextIOWrapper(F(), encoding='utf-8')
            except Exception:
                pass

        F.tell = lambda x: 0
        t = self.TextIOWrapper(F(), encoding='utf-8')

3108

3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125
class MemviewBytesIO(io.BytesIO):
    '''A BytesIO object whose read method returns memoryviews
       rather than bytes'''

    def read1(self, len_):
        return _to_memoryview(super().read1(len_))

    def read(self, len_):
        return _to_memoryview(super().read(len_))

def _to_memoryview(buf):
    '''Convert bytes-object *buf* to a non-trivial memoryview'''

    arr = array.array('i')
    idx = len(buf) - len(buf) % arr.itemsize
    arr.frombytes(buf[:idx])
    return memoryview(arr)
3126

Benjamin Peterson's avatar
Benjamin Peterson committed
3127

3128
class CTextIOWrapperTest(TextIOWrapperTest):
3129
    io = io
3130
    shutdown_error = "RuntimeError: could not find io module state"
3131 3132 3133 3134 3135 3136 3137 3138

    def test_initialization(self):
        r = self.BytesIO(b"\xc3\xa9\n\n")
        b = self.BufferedReader(r, 1000)
        t = self.TextIOWrapper(b)
        self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
        self.assertRaises(ValueError, t.read)

3139 3140 3141
        t = self.TextIOWrapper.__new__(self.TextIOWrapper)
        self.assertRaises(Exception, repr, t)

3142 3143 3144 3145
    def test_garbage_collection(self):
        # C TextIOWrapper objects are collected, and collecting them flushes
        # all data to disk.
        # The Python version has __del__, so it ends in gc.garbage instead.
3146 3147 3148 3149 3150 3151 3152 3153 3154
        with support.check_warnings(('', ResourceWarning)):
            rawio = io.FileIO(support.TESTFN, "wb")
            b = self.BufferedWriter(rawio)
            t = self.TextIOWrapper(b, encoding="ascii")
            t.write("456def")
            t.x = t
            wr = weakref.ref(t)
            del t
            support.gc_collect()
3155
        self.assertIsNone(wr(), wr)
3156
        with self.open(support.TESTFN, "rb") as f:
3157 3158
            self.assertEqual(f.read(), b"456def")

3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173
    def test_rwpair_cleared_before_textio(self):
        # Issue 13070: TextIOWrapper's finalization would crash when called
        # after the reference to the underlying BufferedRWPair's writer got
        # cleared by the GC.
        for i in range(1000):
            b1 = self.BufferedRWPair(self.MockRawIO(), self.MockRawIO())
            t1 = self.TextIOWrapper(b1, encoding="ascii")
            b2 = self.BufferedRWPair(self.MockRawIO(), self.MockRawIO())
            t2 = self.TextIOWrapper(b2, encoding="ascii")
            # circular references
            t1.buddy = t2
            t2.buddy = t1
        support.gc_collect()


3174
class PyTextIOWrapperTest(TextIOWrapperTest):
3175
    io = pyio
3176 3177
    #shutdown_error = "LookupError: unknown encoding: ascii"
    shutdown_error = "TypeError: 'NoneType' object is not iterable"
3178 3179 3180 3181 3182


class IncrementalNewlineDecoderTest(unittest.TestCase):

    def check_newline_decoding_utf8(self, decoder):
3183 3184 3185 3186
        # UTF-8 specific tests for a newline decoder
        def _check_decode(b, s, **kwargs):
            # We exercise getstate() / setstate() as well as decode()
            state = decoder.getstate()
3187
            self.assertEqual(decoder.decode(b, **kwargs), s)
3188
            decoder.setstate(state)
3189
            self.assertEqual(decoder.decode(b, **kwargs), s)
3190

3191
        _check_decode(b'\xe8\xa2\x88', "\u8888")
3192

3193 3194 3195
        _check_decode(b'\xe8', "")
        _check_decode(b'\xa2', "")
        _check_decode(b'\x88', "\u8888")
3196

3197 3198 3199
        _check_decode(b'\xe8', "")
        _check_decode(b'\xa2', "")
        _check_decode(b'\x88', "\u8888")
3200

3201 3202
        _check_decode(b'\xe8', "")
        self.assertRaises(UnicodeDecodeError, decoder.decode, b'', final=True)
3203

3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223
        decoder.reset()
        _check_decode(b'\n', "\n")
        _check_decode(b'\r', "")
        _check_decode(b'', "\n", final=True)
        _check_decode(b'\r', "\n", final=True)

        _check_decode(b'\r', "")
        _check_decode(b'a', "\na")

        _check_decode(b'\r\r\n', "\n\n")
        _check_decode(b'\r', "")
        _check_decode(b'\r', "\n")
        _check_decode(b'\na', "\na")

        _check_decode(b'\xe8\xa2\x88\r\n', "\u8888\n")
        _check_decode(b'\xe8\xa2\x88', "\u8888")
        _check_decode(b'\n', "\n")
        _check_decode(b'\xe8\xa2\x88\r', "\u8888")
        _check_decode(b'\n', "\n")

3224
    def check_newline_decoding(self, decoder, encoding):
3225
        result = []
3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237
        if encoding is not None:
            encoder = codecs.getincrementalencoder(encoding)()
            def _decode_bytewise(s):
                # Decode one byte at a time
                for b in encoder.encode(s):
                    result.append(decoder.decode(bytes([b])))
        else:
            encoder = None
            def _decode_bytewise(s):
                # Decode one char at a time
                for c in s:
                    result.append(decoder.decode(c))
3238
        self.assertEqual(decoder.newlines, None)
3239
        _decode_bytewise("abc\n\r")
3240
        self.assertEqual(decoder.newlines, '\n')
3241
        _decode_bytewise("\nabc")
3242
        self.assertEqual(decoder.newlines, ('\n', '\r\n'))
3243
        _decode_bytewise("abc\r")
3244
        self.assertEqual(decoder.newlines, ('\n', '\r\n'))
3245
        _decode_bytewise("abc")
3246
        self.assertEqual(decoder.newlines, ('\r', '\n', '\r\n'))
3247
        _decode_bytewise("abc\r")
3248
        self.assertEqual("".join(result), "abc\n\nabcabc\nabcabc")
3249
        decoder.reset()
3250 3251 3252 3253
        input = "abc"
        if encoder is not None:
            encoder.reset()
            input = encoder.encode(input)
3254 3255
        self.assertEqual(decoder.decode(input), "abc")
        self.assertEqual(decoder.newlines, None)
3256

3257 3258
    def test_newline_decoder(self):
        encodings = (
3259 3260 3261
            # None meaning the IncrementalNewlineDecoder takes unicode input
            # rather than bytes input
            None, 'utf-8', 'latin-1',
3262 3263 3264 3265
            'utf-16', 'utf-16-le', 'utf-16-be',
            'utf-32', 'utf-32-le', 'utf-32-be',
        )
        for enc in encodings:
3266 3267 3268
            decoder = enc and codecs.getincrementaldecoder(enc)()
            decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
            self.check_newline_decoding(decoder, enc)
3269
        decoder = codecs.getincrementaldecoder("utf-8")()
3270 3271 3272
        decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
        self.check_newline_decoding_utf8(decoder)

3273 3274 3275
    def test_newline_bytes(self):
        # Issue 5433: Excessive optimization in IncrementalNewlineDecoder
        def _check(dec):
3276 3277 3278 3279 3280
            self.assertEqual(dec.newlines, None)
            self.assertEqual(dec.decode("\u0D00"), "\u0D00")
            self.assertEqual(dec.newlines, None)
            self.assertEqual(dec.decode("\u0A00"), "\u0A00")
            self.assertEqual(dec.newlines, None)
3281 3282 3283 3284 3285
        dec = self.IncrementalNewlineDecoder(None, translate=False)
        _check(dec)
        dec = self.IncrementalNewlineDecoder(None, translate=True)
        _check(dec)

3286 3287 3288 3289 3290
class CIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
    pass

class PyIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
    pass
3291 3292


3293
# XXX Tests for open()
3294

3295 3296
class MiscIOTest(unittest.TestCase):

3297 3298 3299
    def tearDown(self):
        support.unlink(support.TESTFN)

3300 3301 3302
    def test___all__(self):
        for name in self.io.__all__:
            obj = getattr(self.io, name, None)
3303
            self.assertIsNotNone(obj, name)
3304 3305
            if name == "open":
                continue
Benjamin Peterson's avatar
Benjamin Peterson committed
3306
            elif "error" in name.lower() or name == "UnsupportedOperation":
3307 3308 3309
                self.assertTrue(issubclass(obj, Exception), name)
            elif not name.startswith("SEEK_"):
                self.assertTrue(issubclass(obj, self.IOBase))
3310

3311
    def test_attributes(self):
3312
        f = self.open(support.TESTFN, "wb", buffering=0)
3313
        self.assertEqual(f.mode, "wb")
3314 3315
        f.close()

3316 3317
        with support.check_warnings(('', DeprecationWarning)):
            f = self.open(support.TESTFN, "U")
3318 3319 3320 3321 3322 3323
        self.assertEqual(f.name,            support.TESTFN)
        self.assertEqual(f.buffer.name,     support.TESTFN)
        self.assertEqual(f.buffer.raw.name, support.TESTFN)
        self.assertEqual(f.mode,            "U")
        self.assertEqual(f.buffer.mode,     "rb")
        self.assertEqual(f.buffer.raw.mode, "rb")
3324 3325
        f.close()

3326
        f = self.open(support.TESTFN, "w+")
3327 3328 3329
        self.assertEqual(f.mode,            "w+")
        self.assertEqual(f.buffer.mode,     "rb+") # Does it really matter?
        self.assertEqual(f.buffer.raw.mode, "rb+")
3330

3331
        g = self.open(f.fileno(), "wb", closefd=False)
3332 3333 3334 3335
        self.assertEqual(g.mode,     "wb")
        self.assertEqual(g.raw.mode, "wb")
        self.assertEqual(g.name,     f.fileno())
        self.assertEqual(g.raw.name, f.fileno())
3336 3337 3338
        f.close()
        g.close()

3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356
    def test_io_after_close(self):
        for kwargs in [
                {"mode": "w"},
                {"mode": "wb"},
                {"mode": "w", "buffering": 1},
                {"mode": "w", "buffering": 2},
                {"mode": "wb", "buffering": 0},
                {"mode": "r"},
                {"mode": "rb"},
                {"mode": "r", "buffering": 1},
                {"mode": "r", "buffering": 2},
                {"mode": "rb", "buffering": 0},
                {"mode": "w+"},
                {"mode": "w+b"},
                {"mode": "w+", "buffering": 1},
                {"mode": "w+", "buffering": 2},
                {"mode": "w+b", "buffering": 0},
            ]:
3357
            f = self.open(support.TESTFN, **kwargs)
3358 3359 3360 3361 3362 3363 3364 3365 3366 3367
            f.close()
            self.assertRaises(ValueError, f.flush)
            self.assertRaises(ValueError, f.fileno)
            self.assertRaises(ValueError, f.isatty)
            self.assertRaises(ValueError, f.__iter__)
            if hasattr(f, "peek"):
                self.assertRaises(ValueError, f.peek, 1)
            self.assertRaises(ValueError, f.read)
            if hasattr(f, "read1"):
                self.assertRaises(ValueError, f.read1, 1024)
3368 3369
            if hasattr(f, "readall"):
                self.assertRaises(ValueError, f.readall)
3370 3371
            if hasattr(f, "readinto"):
                self.assertRaises(ValueError, f.readinto, bytearray(1024))
3372 3373
            if hasattr(f, "readinto1"):
                self.assertRaises(ValueError, f.readinto1, bytearray(1024))
3374 3375 3376 3377 3378
            self.assertRaises(ValueError, f.readline)
            self.assertRaises(ValueError, f.readlines)
            self.assertRaises(ValueError, f.seek, 0)
            self.assertRaises(ValueError, f.tell)
            self.assertRaises(ValueError, f.truncate)
3379 3380
            self.assertRaises(ValueError, f.write,
                              b"" if "b" in kwargs['mode'] else "")
3381
            self.assertRaises(ValueError, f.writelines, [])
3382
            self.assertRaises(ValueError, next, f)
3383

3384 3385 3386 3387 3388 3389 3390 3391 3392 3393
    def test_blockingioerror(self):
        # Various BlockingIOError issues
        class C(str):
            pass
        c = C("")
        b = self.BlockingIOError(1, c)
        c.b = b
        b.c = c
        wr = weakref.ref(c)
        del c, b
3394
        support.gc_collect()
3395
        self.assertIsNone(wr(), wr)
3396 3397 3398

    def test_abcs(self):
        # Test the visible base classes are ABCs.
3399 3400 3401 3402
        self.assertIsInstance(self.IOBase, abc.ABCMeta)
        self.assertIsInstance(self.RawIOBase, abc.ABCMeta)
        self.assertIsInstance(self.BufferedIOBase, abc.ABCMeta)
        self.assertIsInstance(self.TextIOBase, abc.ABCMeta)
3403 3404 3405

    def _check_abc_inheritance(self, abcmodule):
        with self.open(support.TESTFN, "wb", buffering=0) as f:
3406 3407 3408 3409
            self.assertIsInstance(f, abcmodule.IOBase)
            self.assertIsInstance(f, abcmodule.RawIOBase)
            self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
            self.assertNotIsInstance(f, abcmodule.TextIOBase)
3410
        with self.open(support.TESTFN, "wb") as f:
3411 3412 3413 3414
            self.assertIsInstance(f, abcmodule.IOBase)
            self.assertNotIsInstance(f, abcmodule.RawIOBase)
            self.assertIsInstance(f, abcmodule.BufferedIOBase)
            self.assertNotIsInstance(f, abcmodule.TextIOBase)
3415
        with self.open(support.TESTFN, "w") as f:
3416 3417 3418 3419
            self.assertIsInstance(f, abcmodule.IOBase)
            self.assertNotIsInstance(f, abcmodule.RawIOBase)
            self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
            self.assertIsInstance(f, abcmodule.TextIOBase)
3420 3421 3422 3423 3424 3425 3426 3427 3428 3429

    def test_abc_inheritance(self):
        # Test implementations inherit from their respective ABCs
        self._check_abc_inheritance(self)

    def test_abc_inheritance_official(self):
        # Test implementations inherit from the official ABCs of the
        # baseline "io" module.
        self._check_abc_inheritance(io)

3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444
    def _check_warn_on_dealloc(self, *args, **kwargs):
        f = open(*args, **kwargs)
        r = repr(f)
        with self.assertWarns(ResourceWarning) as cm:
            f = None
            support.gc_collect()
        self.assertIn(r, str(cm.warning.args[0]))

    def test_warn_on_dealloc(self):
        self._check_warn_on_dealloc(support.TESTFN, "wb", buffering=0)
        self._check_warn_on_dealloc(support.TESTFN, "wb")
        self._check_warn_on_dealloc(support.TESTFN, "w")

    def _check_warn_on_dealloc_fd(self, *args, **kwargs):
        fds = []
Benjamin Peterson's avatar
Benjamin Peterson committed
3445
        def cleanup_fds():
3446 3447 3448
            for fd in fds:
                try:
                    os.close(fd)
3449
                except OSError as e:
3450 3451
                    if e.errno != errno.EBADF:
                        raise
Benjamin Peterson's avatar
Benjamin Peterson committed
3452 3453 3454 3455 3456 3457 3458
        self.addCleanup(cleanup_fds)
        r, w = os.pipe()
        fds += r, w
        self._check_warn_on_dealloc(r, *args, **kwargs)
        # When using closefd=False, there's no warning
        r, w = os.pipe()
        fds += r, w
3459
        with support.check_no_resource_warning(self):
Benjamin Peterson's avatar
Benjamin Peterson committed
3460
            open(r, *args, closefd=False, **kwargs)
3461 3462 3463 3464 3465 3466 3467

    def test_warn_on_dealloc_fd(self):
        self._check_warn_on_dealloc_fd("rb", buffering=0)
        self._check_warn_on_dealloc_fd("rb")
        self._check_warn_on_dealloc_fd("r")


3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484
    def test_pickling(self):
        # Pickling file objects is forbidden
        for kwargs in [
                {"mode": "w"},
                {"mode": "wb"},
                {"mode": "wb", "buffering": 0},
                {"mode": "r"},
                {"mode": "rb"},
                {"mode": "rb", "buffering": 0},
                {"mode": "w+"},
                {"mode": "w+b"},
                {"mode": "w+b", "buffering": 0},
            ]:
            for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
                with self.open(support.TESTFN, **kwargs) as f:
                    self.assertRaises(TypeError, pickle.dumps, f, protocol)

3485 3486 3487 3488 3489 3490
    def test_nonblock_pipe_write_bigbuf(self):
        self._test_nonblock_pipe_write(16*1024)

    def test_nonblock_pipe_write_smallbuf(self):
        self._test_nonblock_pipe_write(1024)

3491 3492
    @unittest.skipUnless(hasattr(os, 'set_blocking'),
                         'os.set_blocking() required for this test')
3493 3494 3495 3496
    def _test_nonblock_pipe_write(self, bufsize):
        sent = []
        received = []
        r, w = os.pipe()
3497 3498
        os.set_blocking(r, False)
        os.set_blocking(w, False)
3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518

        # To exercise all code paths in the C implementation we need
        # to play with buffer sizes.  For instance, if we choose a
        # buffer size less than or equal to _PIPE_BUF (4096 on Linux)
        # then we will never get a partial write of the buffer.
        rf = self.open(r, mode='rb', closefd=True, buffering=bufsize)
        wf = self.open(w, mode='wb', closefd=True, buffering=bufsize)

        with rf, wf:
            for N in 9999, 73, 7574:
                try:
                    i = 0
                    while True:
                        msg = bytes([i % 26 + 97]) * N
                        sent.append(msg)
                        wf.write(msg)
                        i += 1

                except self.BlockingIOError as e:
                    self.assertEqual(e.args[0], errno.EAGAIN)
3519
                    self.assertEqual(e.args[2], e.characters_written)
3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531
                    sent[-1] = sent[-1][:e.characters_written]
                    received.append(rf.read())
                    msg = b'BLOCKED'
                    wf.write(msg)
                    sent.append(msg)

            while True:
                try:
                    wf.flush()
                    break
                except self.BlockingIOError as e:
                    self.assertEqual(e.args[0], errno.EAGAIN)
3532
                    self.assertEqual(e.args[2], e.characters_written)
3533 3534 3535 3536 3537 3538
                    self.assertEqual(e.characters_written, 0)
                    received.append(rf.read())

            received += iter(rf.read, None)

        sent, received = b''.join(sent), b''.join(received)
3539
        self.assertEqual(sent, received)
3540 3541 3542
        self.assertTrue(wf.closed)
        self.assertTrue(rf.closed)

3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555
    def test_create_fail(self):
        # 'x' mode fails if file is existing
        with self.open(support.TESTFN, 'w'):
            pass
        self.assertRaises(FileExistsError, self.open, support.TESTFN, 'x')

    def test_create_writes(self):
        # 'x' mode opens for writing
        with self.open(support.TESTFN, 'xb') as f:
            f.write(b"spam")
        with self.open(support.TESTFN, 'rb') as f:
            self.assertEqual(b"spam", f.read())

3556 3557 3558 3559 3560
    def test_open_allargs(self):
        # there used to be a buffer overflow in the parser for rawmode
        self.assertRaises(ValueError, self.open, support.TESTFN, 'rwax+')


3561 3562 3563
class CMiscIOTest(MiscIOTest):
    io = io

3564 3565 3566 3567 3568 3569 3570 3571 3572
    def test_readinto_buffer_overflow(self):
        # Issue #18025
        class BadReader(self.io.BufferedIOBase):
            def read(self, n=-1):
                return b'x' * 10**6
        bufio = BadReader()
        b = bytearray(2)
        self.assertRaises(ValueError, bufio.readinto, b)

3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615
    @unittest.skipUnless(threading, 'Threading required for this test.')
    def check_daemon_threads_shutdown_deadlock(self, stream_name):
        # Issue #23309: deadlocks at shutdown should be avoided when a
        # daemon thread and the main thread both write to a file.
        code = """if 1:
            import sys
            import time
            import threading

            file = sys.{stream_name}

            def run():
                while True:
                    file.write('.')
                    file.flush()

            thread = threading.Thread(target=run)
            thread.daemon = True
            thread.start()

            time.sleep(0.5)
            file.write('!')
            file.flush()
            """.format_map(locals())
        res, _ = run_python_until_end("-c", code)
        err = res.err.decode()
        if res.rc != 0:
            # Failure: should be a fatal error
            self.assertIn("Fatal Python error: could not acquire lock "
                          "for <_io.BufferedWriter name='<{stream_name}>'> "
                          "at interpreter shutdown, possibly due to "
                          "daemon threads".format_map(locals()),
                          err)
        else:
            self.assertFalse(err.strip('.!'))

    def test_daemon_threads_shutdown_stdout_deadlock(self):
        self.check_daemon_threads_shutdown_deadlock('stdout')

    def test_daemon_threads_shutdown_stderr_deadlock(self):
        self.check_daemon_threads_shutdown_deadlock('stderr')


3616 3617
class PyMiscIOTest(MiscIOTest):
    io = pyio
3618

3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634

@unittest.skipIf(os.name == 'nt', 'POSIX signals required for this test.')
class SignalsTest(unittest.TestCase):

    def setUp(self):
        self.oldalrm = signal.signal(signal.SIGALRM, self.alarm_interrupt)

    def tearDown(self):
        signal.signal(signal.SIGALRM, self.oldalrm)

    def alarm_interrupt(self, sig, frame):
        1/0

    @unittest.skipUnless(threading, 'Threading required for this test.')
    def check_interrupted_write(self, item, bytes, **fdopen_kwargs):
        """Check that a partial write, when it gets interrupted, properly
3635 3636
        invokes the signal handler, and bubbles up the exception raised
        in the latter."""
3637 3638
        read_results = []
        def _read():
3639 3640
            if hasattr(signal, 'pthread_sigmask'):
                signal.pthread_sigmask(signal.SIG_BLOCK, [signal.SIGALRM])
3641 3642 3643 3644 3645
            s = os.read(r, 1)
            read_results.append(s)
        t = threading.Thread(target=_read)
        t.daemon = True
        r, w = os.pipe()
3646
        fdopen_kwargs["closefd"] = False
3647
        large_data = item * (support.PIPE_MAX_SIZE // len(item) + 1)
3648 3649 3650 3651 3652 3653 3654 3655 3656
        try:
            wio = self.io.open(w, **fdopen_kwargs)
            t.start()
            # Fill the pipe enough that the write will be blocking.
            # It will be interrupted by the timer armed above.  Since the
            # other thread has read one byte, the low-level write will
            # return with a successful (partial) result rather than an EINTR.
            # The buffered IO layer must check for pending signal
            # handlers, which in this case will invoke alarm_interrupt().
3657 3658
            signal.alarm(1)
            try:
3659
                self.assertRaises(ZeroDivisionError, wio.write, large_data)
3660 3661
            finally:
                signal.alarm(0)
3662
                t.join()
3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674
            # We got one byte, get another one and check that it isn't a
            # repeat of the first one.
            read_results.append(os.read(r, 1))
            self.assertEqual(read_results, [bytes[0:1], bytes[1:2]])
        finally:
            os.close(w)
            os.close(r)
            # This is deliberate. If we didn't close the file descriptor
            # before closing wio, wio would try to flush its internal
            # buffer, and block again.
            try:
                wio.close()
3675
            except OSError as e:
3676 3677 3678 3679 3680 3681 3682 3683 3684
                if e.errno != errno.EBADF:
                    raise

    def test_interrupted_write_unbuffered(self):
        self.check_interrupted_write(b"xy", b"xy", mode="wb", buffering=0)

    def test_interrupted_write_buffered(self):
        self.check_interrupted_write(b"xy", b"xy", mode="wb")

3685 3686
    # Issue #22331: The test hangs on FreeBSD 7.2
    @support.requires_freebsd_version(8)
3687 3688 3689
    def test_interrupted_write_text(self):
        self.check_interrupted_write("xy", b"xy", mode="w", encoding="ascii")

3690
    @support.no_tracing
3691 3692 3693 3694 3695 3696 3697 3698 3699
    def check_reentrant_write(self, data, **fdopen_kwargs):
        def on_alarm(*args):
            # Will be called reentrantly from the same thread
            wio.write(data)
            1/0
        signal.signal(signal.SIGALRM, on_alarm)
        r, w = os.pipe()
        wio = self.io.open(w, **fdopen_kwargs)
        try:
3700
            signal.alarm(1)
3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722
            # Either the reentrant call to wio.write() fails with RuntimeError,
            # or the signal handler raises ZeroDivisionError.
            with self.assertRaises((ZeroDivisionError, RuntimeError)) as cm:
                while 1:
                    for i in range(100):
                        wio.write(data)
                        wio.flush()
                    # Make sure the buffer doesn't fill up and block further writes
                    os.read(r, len(data) * 100)
            exc = cm.exception
            if isinstance(exc, RuntimeError):
                self.assertTrue(str(exc).startswith("reentrant call"), str(exc))
        finally:
            wio.close()
            os.close(r)

    def test_reentrant_write_buffered(self):
        self.check_reentrant_write(b"xy", mode="wb")

    def test_reentrant_write_text(self):
        self.check_reentrant_write("xy", mode="w", encoding="ascii")

3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734
    def check_interrupted_read_retry(self, decode, **fdopen_kwargs):
        """Check that a buffered read, when it gets interrupted (either
        returning a partial result or EINTR), properly invokes the signal
        handler and retries if the latter returned successfully."""
        r, w = os.pipe()
        fdopen_kwargs["closefd"] = False
        def alarm_handler(sig, frame):
            os.write(w, b"bar")
        signal.signal(signal.SIGALRM, alarm_handler)
        try:
            rio = self.io.open(r, **fdopen_kwargs)
            os.write(w, b"foo")
3735
            signal.alarm(1)
3736 3737 3738 3739 3740 3741 3742 3743 3744 3745
            # Expected behaviour:
            # - first raw read() returns partial b"foo"
            # - second raw read() returns EINTR
            # - third raw read() returns b"bar"
            self.assertEqual(decode(rio.read(6)), "foobar")
        finally:
            rio.close()
            os.close(w)
            os.close(r)

Antoine Pitrou's avatar
Antoine Pitrou committed
3746
    def test_interrupted_read_retry_buffered(self):
3747 3748 3749
        self.check_interrupted_read_retry(lambda x: x.decode('latin1'),
                                          mode="rb")

Antoine Pitrou's avatar
Antoine Pitrou committed
3750
    def test_interrupted_read_retry_text(self):
3751 3752 3753 3754 3755 3756 3757 3758 3759
        self.check_interrupted_read_retry(lambda x: x,
                                          mode="r")

    @unittest.skipUnless(threading, 'Threading required for this test.')
    def check_interrupted_write_retry(self, item, **fdopen_kwargs):
        """Check that a buffered write, when it gets interrupted (either
        returning a partial result or EINTR), properly invokes the signal
        handler and retries if the latter returned successfully."""
        select = support.import_module("select")
3760

3761 3762
        # A quantity that exceeds the buffer size of an anonymous pipe's
        # write end.
3763
        N = support.PIPE_MAX_SIZE
3764 3765
        r, w = os.pipe()
        fdopen_kwargs["closefd"] = False
3766

3767 3768 3769 3770 3771
        # We need a separate thread to read from the pipe and allow the
        # write() to finish.  This thread is started after the SIGALRM is
        # received (forcing a first EINTR in write()).
        read_results = []
        write_finished = False
3772
        error = None
3773
        def _read():
3774 3775 3776 3777 3778 3779 3780 3781
            try:
                while not write_finished:
                    while r in select.select([r], [], [], 1.0)[0]:
                        s = os.read(r, 1024)
                        read_results.append(s)
            except BaseException as exc:
                nonlocal error
                error = exc
3782 3783 3784 3785
        t = threading.Thread(target=_read)
        t.daemon = True
        def alarm1(sig, frame):
            signal.signal(signal.SIGALRM, alarm2)
3786
            signal.alarm(1)
3787 3788
        def alarm2(sig, frame):
            t.start()
3789 3790

        large_data = item * N
3791 3792 3793
        signal.signal(signal.SIGALRM, alarm1)
        try:
            wio = self.io.open(w, **fdopen_kwargs)
3794
            signal.alarm(1)
3795 3796 3797 3798 3799
            # Expected behaviour:
            # - first raw write() is partial (because of the limited pipe buffer
            #   and the first alarm)
            # - second raw write() returns EINTR (because of the second alarm)
            # - subsequent write()s are successful (either partial or complete)
3800 3801 3802
            written = wio.write(large_data)
            self.assertEqual(N, written)

3803 3804 3805
            wio.flush()
            write_finished = True
            t.join()
3806

3807
            self.assertIsNone(error)
3808 3809 3810 3811 3812 3813 3814 3815 3816 3817
            self.assertEqual(N, sum(len(x) for x in read_results))
        finally:
            write_finished = True
            os.close(w)
            os.close(r)
            # This is deliberate. If we didn't close the file descriptor
            # before closing wio, wio would try to flush its internal
            # buffer, and could block (in case of failure).
            try:
                wio.close()
3818
            except OSError as e:
3819 3820 3821
                if e.errno != errno.EBADF:
                    raise

Antoine Pitrou's avatar
Antoine Pitrou committed
3822
    def test_interrupted_write_retry_buffered(self):
3823 3824
        self.check_interrupted_write_retry(b"x", mode="wb")

Antoine Pitrou's avatar
Antoine Pitrou committed
3825
    def test_interrupted_write_retry_text(self):
3826 3827
        self.check_interrupted_write_retry("x", mode="w", encoding="latin1")

3828

3829 3830 3831 3832 3833 3834
class CSignalsTest(SignalsTest):
    io = io

class PySignalsTest(SignalsTest):
    io = pyio

3835 3836 3837 3838 3839
    # Handling reentrancy issues would slow down _pyio even more, so the
    # tests are disabled.
    test_reentrant_write_buffered = None
    test_reentrant_write_text = None

3840

3841
def load_tests(*args):
3842
    tests = (CIOTest, PyIOTest, APIMismatchTest,
3843 3844 3845 3846 3847 3848 3849
             CBufferedReaderTest, PyBufferedReaderTest,
             CBufferedWriterTest, PyBufferedWriterTest,
             CBufferedRWPairTest, PyBufferedRWPairTest,
             CBufferedRandomTest, PyBufferedRandomTest,
             StatefulIncrementalDecoderTest,
             CIncrementalNewlineDecoderTest, PyIncrementalNewlineDecoderTest,
             CTextIOWrapperTest, PyTextIOWrapperTest,
3850 3851 3852
             CMiscIOTest, PyMiscIOTest,
             CSignalsTest, PySignalsTest,
             )
3853 3854 3855 3856

    # Put the namespaces of the IO module we are testing and some useful mock
    # classes in the __dict__ of each test.
    mocks = (MockRawIO, MisbehavedRawIO, MockFileIO, CloseFailureIO,
3857
             MockNonBlockWriterIO, MockUnseekableIO, MockRawIOWithoutRead)
3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873
    all_members = io.__all__ + ["IncrementalNewlineDecoder"]
    c_io_ns = {name : getattr(io, name) for name in all_members}
    py_io_ns = {name : getattr(pyio, name) for name in all_members}
    globs = globals()
    c_io_ns.update((x.__name__, globs["C" + x.__name__]) for x in mocks)
    py_io_ns.update((x.__name__, globs["Py" + x.__name__]) for x in mocks)
    # Avoid turning open into a bound method.
    py_io_ns["open"] = pyio.OpenWrapper
    for test in tests:
        if test.__name__.startswith("C"):
            for name, obj in c_io_ns.items():
                setattr(test, name, obj)
        elif test.__name__.startswith("Py"):
            for name, obj in py_io_ns.items():
                setattr(test, name, obj)

3874 3875
    suite = unittest.TestSuite([unittest.makeSuite(test) for test in tests])
    return suite
3876 3877

if __name__ == "__main__":
3878
    unittest.main()