mirror of
https://github.com/python/cpython.git
synced 2024-12-26 10:14:58 +08:00
8742977b33
write() returns the number of bytes/characters written/buffered. FileIO.close() calls self.flush(). Implement readinto() for buffered readers. Tests th check all these. Test proper behavior of __enter__/__exit__.
499 lines
15 KiB
Python
499 lines
15 KiB
Python
"""Unit tests for io.py."""
|
|
|
|
import sys
|
|
import unittest
|
|
from itertools import chain
|
|
from test import test_support
|
|
|
|
import io # The module under test
|
|
|
|
|
|
class MockRawIO(io.RawIOBase):
|
|
|
|
def __init__(self, read_stack=()):
|
|
self._read_stack = list(read_stack)
|
|
self._write_stack = []
|
|
|
|
def read(self, n=None):
|
|
try:
|
|
return self._read_stack.pop(0)
|
|
except:
|
|
return b""
|
|
|
|
def write(self, b):
|
|
self._write_stack.append(b[:])
|
|
return len(b)
|
|
|
|
def writable(self):
|
|
return True
|
|
|
|
def fileno(self):
|
|
return 42
|
|
|
|
def readable(self):
|
|
return True
|
|
|
|
def seekable(self):
|
|
return True
|
|
|
|
def seek(self, pos, whence):
|
|
pass
|
|
|
|
def tell(self):
|
|
return 42
|
|
|
|
|
|
class MockFileIO(io.BytesIO):
|
|
|
|
def __init__(self, data):
|
|
self.read_history = []
|
|
io.BytesIO.__init__(self, data)
|
|
|
|
def read(self, n=None):
|
|
res = io.BytesIO.read(self, n)
|
|
self.read_history.append(None if res is None else len(res))
|
|
return res
|
|
|
|
|
|
class MockNonBlockWriterIO(io.RawIOBase):
|
|
|
|
def __init__(self, blocking_script):
|
|
self._blocking_script = list(blocking_script)
|
|
self._write_stack = []
|
|
|
|
def write(self, b):
|
|
self._write_stack.append(b[:])
|
|
n = self._blocking_script.pop(0)
|
|
if (n < 0):
|
|
raise io.BlockingIOError(0, "test blocking", -n)
|
|
else:
|
|
return n
|
|
|
|
def writable(self):
|
|
return True
|
|
|
|
|
|
class IOTest(unittest.TestCase):
|
|
|
|
def tearDown(self):
|
|
test_support.unlink(test_support.TESTFN)
|
|
|
|
def write_ops(self, f):
|
|
self.assertEqual(f.write(b"blah."), 5)
|
|
self.assertEqual(f.seek(0), 0)
|
|
self.assertEqual(f.write(b"Hello."), 6)
|
|
self.assertEqual(f.tell(), 6)
|
|
self.assertEqual(f.seek(-1, 1), 5)
|
|
self.assertEqual(f.tell(), 5)
|
|
self.assertEqual(f.write(" world\n\n\n"), 9)
|
|
self.assertEqual(f.seek(0), 0)
|
|
self.assertEqual(f.write("h"), 1)
|
|
self.assertEqual(f.seek(-1, 2), 13)
|
|
self.assertEqual(f.tell(), 13)
|
|
self.assertEqual(f.truncate(12), 12)
|
|
self.assertEqual(f.tell(), 12)
|
|
|
|
LARGE = 2**31
|
|
|
|
def large_file_ops(self, f):
|
|
assert f.readable()
|
|
assert f.writable()
|
|
self.assertEqual(f.seek(self.LARGE), self.LARGE)
|
|
self.assertEqual(f.tell(), self.LARGE)
|
|
self.assertEqual(f.write(b"xxx"), 3)
|
|
self.assertEqual(f.tell(), self.LARGE + 3)
|
|
self.assertEqual(f.seek(-1, 1), self.LARGE + 2)
|
|
self.assertEqual(f.truncate(), self.LARGE + 2)
|
|
self.assertEqual(f.tell(), self.LARGE + 2)
|
|
self.assertEqual(f.seek(0, 2), self.LARGE + 2)
|
|
self.assertEqual(f.truncate(self.LARGE + 1), self.LARGE + 1)
|
|
self.assertEqual(f.tell(), self.LARGE + 1)
|
|
self.assertEqual(f.seek(0, 2), self.LARGE + 1)
|
|
self.assertEqual(f.seek(-1, 2), self.LARGE)
|
|
self.assertEqual(f.read(2), b"x")
|
|
|
|
def read_ops(self, f):
|
|
data = f.read(5)
|
|
self.assertEqual(data, b"hello")
|
|
n = f.readinto(data)
|
|
self.assertEqual(n, 5)
|
|
self.assertEqual(data, b" worl")
|
|
n = f.readinto(data)
|
|
self.assertEqual(n, 2)
|
|
self.assertEqual(len(data), 5)
|
|
self.assertEqual(data[:2], b"d\n")
|
|
f.seek(0)
|
|
self.assertEqual(f.read(20), b"hello world\n")
|
|
f.seek(-6, 2)
|
|
self.assertEqual(f.read(5), b"world")
|
|
f.seek(-6, 1)
|
|
self.assertEqual(f.read(5), b" worl")
|
|
self.assertEqual(f.tell(), 10)
|
|
|
|
def test_raw_file_io(self):
|
|
f = io.open(test_support.TESTFN, "wb", buffering=0)
|
|
self.assertEqual(f.readable(), False)
|
|
self.assertEqual(f.writable(), True)
|
|
self.assertEqual(f.seekable(), True)
|
|
self.write_ops(f)
|
|
f.close()
|
|
f = io.open(test_support.TESTFN, "rb", buffering=0)
|
|
self.assertEqual(f.readable(), True)
|
|
self.assertEqual(f.writable(), False)
|
|
self.assertEqual(f.seekable(), True)
|
|
self.read_ops(f)
|
|
f.close()
|
|
|
|
def test_buffered_file_io(self):
|
|
f = io.open(test_support.TESTFN, "wb")
|
|
self.assertEqual(f.readable(), False)
|
|
self.assertEqual(f.writable(), True)
|
|
self.assertEqual(f.seekable(), True)
|
|
self.write_ops(f)
|
|
f.close()
|
|
f = io.open(test_support.TESTFN, "rb")
|
|
self.assertEqual(f.readable(), True)
|
|
self.assertEqual(f.writable(), False)
|
|
self.assertEqual(f.seekable(), True)
|
|
self.read_ops(f)
|
|
f.close()
|
|
|
|
def test_raw_bytes_io(self):
|
|
f = io.BytesIO()
|
|
self.write_ops(f)
|
|
data = f.getvalue()
|
|
self.assertEqual(data, b"hello world\n")
|
|
f = io.BytesIO(data)
|
|
self.read_ops(f)
|
|
|
|
def test_large_file_ops(self):
|
|
# 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':
|
|
if not test_support.is_resource_enabled("largefile"):
|
|
print("\nTesting large file ops skipped on %s." % sys.platform,
|
|
file=sys.stderr)
|
|
print("It requires %d bytes and a long time." % self.LARGE,
|
|
file=sys.stderr)
|
|
print("Use 'regrtest.py -u largefile test_io' to run it.",
|
|
file=sys.stderr)
|
|
return
|
|
f = io.open(test_support.TESTFN, "w+b", 0)
|
|
self.large_file_ops(f)
|
|
f.close()
|
|
f = io.open(test_support.TESTFN, "w+b")
|
|
self.large_file_ops(f)
|
|
f.close()
|
|
|
|
def test_with_open(self):
|
|
for bufsize in (0, 1, 100):
|
|
f = None
|
|
with open(test_support.TESTFN, "wb", bufsize) as f:
|
|
f.write("xxx")
|
|
self.assertEqual(f.closed, True)
|
|
f = None
|
|
try:
|
|
with open(test_support.TESTFN, "wb", bufsize) as f:
|
|
1/0
|
|
except ZeroDivisionError:
|
|
self.assertEqual(f.closed, True)
|
|
else:
|
|
self.fail("1/0 didn't raise an exception")
|
|
|
|
def test_destructor(self):
|
|
record = []
|
|
class MyFileIO(io.FileIO):
|
|
def __del__(self):
|
|
record.append(1)
|
|
io.FileIO.__del__(self)
|
|
def close(self):
|
|
record.append(2)
|
|
io.FileIO.close(self)
|
|
def flush(self):
|
|
record.append(3)
|
|
io.FileIO.flush(self)
|
|
f = MyFileIO(test_support.TESTFN, "w")
|
|
f.write("xxx")
|
|
del f
|
|
self.assertEqual(record, [1, 2, 3])
|
|
|
|
def test_close_flushes(self):
|
|
f = io.open(test_support.TESTFN, "wb")
|
|
f.write("xxx")
|
|
f.close()
|
|
f = io.open(test_support.TESTFN, "rb")
|
|
self.assertEqual(f.read(), b"xxx")
|
|
f.close()
|
|
|
|
|
|
class MemorySeekTestMixin:
|
|
|
|
def testInit(self):
|
|
buf = self.buftype("1234567890")
|
|
bytesIo = self.ioclass(buf)
|
|
|
|
def testRead(self):
|
|
buf = self.buftype("1234567890")
|
|
bytesIo = self.ioclass(buf)
|
|
|
|
self.assertEquals(buf[:1], bytesIo.read(1))
|
|
self.assertEquals(buf[1:5], bytesIo.read(4))
|
|
self.assertEquals(buf[5:], bytesIo.read(900))
|
|
self.assertEquals(self.EOF, bytesIo.read())
|
|
|
|
def testReadNoArgs(self):
|
|
buf = self.buftype("1234567890")
|
|
bytesIo = self.ioclass(buf)
|
|
|
|
self.assertEquals(buf, bytesIo.read())
|
|
self.assertEquals(self.EOF, bytesIo.read())
|
|
|
|
def testSeek(self):
|
|
buf = self.buftype("1234567890")
|
|
bytesIo = self.ioclass(buf)
|
|
|
|
bytesIo.read(5)
|
|
bytesIo.seek(0)
|
|
self.assertEquals(buf, bytesIo.read())
|
|
|
|
bytesIo.seek(3)
|
|
self.assertEquals(buf[3:], bytesIo.read())
|
|
|
|
def testTell(self):
|
|
buf = self.buftype("1234567890")
|
|
bytesIo = self.ioclass(buf)
|
|
|
|
self.assertEquals(0, bytesIo.tell())
|
|
bytesIo.seek(5)
|
|
self.assertEquals(5, bytesIo.tell())
|
|
bytesIo.seek(10000)
|
|
self.assertEquals(10000, bytesIo.tell())
|
|
|
|
|
|
class BytesIOTest(MemorySeekTestMixin, unittest.TestCase):
|
|
buftype = bytes
|
|
ioclass = io.BytesIO
|
|
EOF = b""
|
|
|
|
|
|
class StringIOTest(MemorySeekTestMixin, unittest.TestCase):
|
|
buftype = str
|
|
ioclass = io.StringIO
|
|
EOF = ""
|
|
|
|
|
|
class BufferedReaderTest(unittest.TestCase):
|
|
|
|
def testRead(self):
|
|
rawio = MockRawIO((b"abc", b"d", b"efg"))
|
|
bufio = io.BufferedReader(rawio)
|
|
|
|
self.assertEquals(b"abcdef", bufio.read(6))
|
|
|
|
def testBuffering(self):
|
|
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:
|
|
rawio = MockFileIO(data)
|
|
bufio = io.BufferedReader(rawio, buffer_size=bufsize)
|
|
pos = 0
|
|
for nbytes in buf_read_sizes:
|
|
self.assertEquals(bufio.read(nbytes), data[pos:pos+nbytes])
|
|
pos += nbytes
|
|
self.assertEquals(rawio.read_history, raw_read_sizes)
|
|
|
|
def testReadNonBlocking(self):
|
|
# Inject some None's in there to simulate EWOULDBLOCK
|
|
rawio = MockRawIO((b"abc", b"d", None, b"efg", None, None))
|
|
bufio = io.BufferedReader(rawio)
|
|
|
|
self.assertEquals(b"abcd", bufio.read(6))
|
|
self.assertEquals(b"e", bufio.read(1))
|
|
self.assertEquals(b"fg", bufio.read())
|
|
self.assert_(None is bufio.read())
|
|
self.assertEquals(b"", bufio.read())
|
|
|
|
def testReadToEof(self):
|
|
rawio = MockRawIO((b"abc", b"d", b"efg"))
|
|
bufio = io.BufferedReader(rawio)
|
|
|
|
self.assertEquals(b"abcdefg", bufio.read(9000))
|
|
|
|
def testReadNoArgs(self):
|
|
rawio = MockRawIO((b"abc", b"d", b"efg"))
|
|
bufio = io.BufferedReader(rawio)
|
|
|
|
self.assertEquals(b"abcdefg", bufio.read())
|
|
|
|
def testFileno(self):
|
|
rawio = MockRawIO((b"abc", b"d", b"efg"))
|
|
bufio = io.BufferedReader(rawio)
|
|
|
|
self.assertEquals(42, bufio.fileno())
|
|
|
|
def testFilenoNoFileno(self):
|
|
# XXX will we always have fileno() function? If so, kill
|
|
# this test. Else, write it.
|
|
pass
|
|
|
|
|
|
class BufferedWriterTest(unittest.TestCase):
|
|
|
|
def testWrite(self):
|
|
# Write to the buffered IO but don't overflow the buffer.
|
|
writer = MockRawIO()
|
|
bufio = io.BufferedWriter(writer, 8)
|
|
|
|
bufio.write(b"abc")
|
|
|
|
self.assertFalse(writer._write_stack)
|
|
|
|
def testWriteOverflow(self):
|
|
writer = MockRawIO()
|
|
bufio = io.BufferedWriter(writer, 8)
|
|
|
|
bufio.write(b"abc")
|
|
bufio.write(b"defghijkl")
|
|
|
|
self.assertEquals(b"abcdefghijkl", writer._write_stack[0])
|
|
|
|
def testWriteNonBlocking(self):
|
|
raw = MockNonBlockWriterIO((9, 2, 22, -6, 10, 12, 12))
|
|
bufio = io.BufferedWriter(raw, 8, 16)
|
|
|
|
bufio.write(b"asdf")
|
|
bufio.write(b"asdfa")
|
|
self.assertEquals(b"asdfasdfa", raw._write_stack[0])
|
|
|
|
bufio.write(b"asdfasdfasdf")
|
|
self.assertEquals(b"asdfasdfasdf", raw._write_stack[1])
|
|
bufio.write(b"asdfasdfasdf")
|
|
self.assertEquals(b"dfasdfasdf", raw._write_stack[2])
|
|
self.assertEquals(b"asdfasdfasdf", raw._write_stack[3])
|
|
|
|
bufio.write(b"asdfasdfasdf")
|
|
|
|
# XXX I don't like this test. It relies too heavily on how the
|
|
# algorithm actually works, which we might change. Refactor
|
|
# later.
|
|
|
|
def testFileno(self):
|
|
rawio = MockRawIO((b"abc", b"d", b"efg"))
|
|
bufio = io.BufferedWriter(rawio)
|
|
|
|
self.assertEquals(42, bufio.fileno())
|
|
|
|
def testFlush(self):
|
|
writer = MockRawIO()
|
|
bufio = io.BufferedWriter(writer, 8)
|
|
|
|
bufio.write(b"abc")
|
|
bufio.flush()
|
|
|
|
self.assertEquals(b"abc", writer._write_stack[0])
|
|
|
|
|
|
class BufferedRWPairTest(unittest.TestCase):
|
|
|
|
def testRWPair(self):
|
|
r = MockRawIO(())
|
|
w = MockRawIO()
|
|
pair = io.BufferedRWPair(r, w)
|
|
|
|
# XXX need implementation
|
|
|
|
|
|
class BufferedRandomTest(unittest.TestCase):
|
|
|
|
def testReadAndWrite(self):
|
|
raw = MockRawIO((b"asdf", b"ghjk"))
|
|
rw = io.BufferedRandom(raw, 8, 12)
|
|
|
|
self.assertEqual(b"as", rw.read(2))
|
|
rw.write(b"ddd")
|
|
rw.write(b"eee")
|
|
self.assertFalse(raw._write_stack) # Buffer writes
|
|
self.assertEqual(b"ghjk", rw.read()) # This read forces write flush
|
|
self.assertEquals(b"dddeee", raw._write_stack[0])
|
|
|
|
def testSeekAndTell(self):
|
|
raw = io.BytesIO(b"asdfghjkl")
|
|
rw = io.BufferedRandom(raw)
|
|
|
|
self.assertEquals(b"as", rw.read(2))
|
|
self.assertEquals(2, rw.tell())
|
|
rw.seek(0, 0)
|
|
self.assertEquals(b"asdf", rw.read(4))
|
|
|
|
rw.write(b"asdf")
|
|
rw.seek(0, 0)
|
|
self.assertEquals(b"asdfasdfl", rw.read())
|
|
self.assertEquals(9, rw.tell())
|
|
rw.seek(-4, 2)
|
|
self.assertEquals(5, rw.tell())
|
|
rw.seek(2, 1)
|
|
self.assertEquals(7, rw.tell())
|
|
self.assertEquals(b"fl", rw.read(11))
|
|
|
|
|
|
class TextIOWrapperTest(unittest.TestCase):
|
|
def testNewlines(self):
|
|
input_lines = [ "unix\n", "windows\r\n", "os9\r", "last\n", "nonl" ]
|
|
|
|
tests = [
|
|
[ None, [ 'unix\n', 'windows\n', 'os9\n', 'last\n', 'nonl' ] ],
|
|
[ '\n', input_lines ],
|
|
[ '\r\n', input_lines ],
|
|
]
|
|
|
|
encodings = ('utf-8', 'bz2')
|
|
|
|
# Try a range of pad sizes to test the case where \r is the last
|
|
# character in TextIOWrapper._pending_line.
|
|
for encoding in encodings:
|
|
for do_reads in (False, True):
|
|
for padlen in chain(range(10), range(50, 60)):
|
|
pad = '.' * padlen
|
|
data_lines = [ pad + line for line in input_lines ]
|
|
# XXX: str.encode() should return bytes
|
|
data = bytes(''.join(data_lines).encode(encoding))
|
|
|
|
for newline, exp_line_ends in tests:
|
|
exp_lines = [ pad + line for line in exp_line_ends ]
|
|
bufio = io.BufferedReader(io.BytesIO(data))
|
|
textio = io.TextIOWrapper(bufio, newline=newline,
|
|
encoding=encoding)
|
|
if do_reads:
|
|
got_lines = []
|
|
while True:
|
|
c2 = textio.read(2)
|
|
if c2 == '':
|
|
break
|
|
self.assertEquals(len(c2), 2)
|
|
got_lines.append(c2 + textio.readline())
|
|
else:
|
|
got_lines = list(textio)
|
|
|
|
for got_line, exp_line in zip(got_lines, exp_lines):
|
|
self.assertEquals(got_line, exp_line)
|
|
self.assertEquals(len(got_lines), len(exp_lines))
|
|
|
|
# XXX Tests for open()
|
|
|
|
def test_main():
|
|
test_support.run_unittest(IOTest, BytesIOTest, StringIOTest,
|
|
BufferedReaderTest,
|
|
BufferedWriterTest, BufferedRWPairTest,
|
|
BufferedRandomTest, TextIOWrapperTest)
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|