blob: 153548e092936ef5568efb33aa9c03b2442d83af [file] [log] [blame]
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001"""Unit tests for the io module."""
2
3# Tests of io are scattered over the test suite:
4# * test_bufio - tests file buffering
5# * test_memoryio - tests BytesIO and StringIO
6# * test_fileio - tests FileIO
7# * test_file - tests the file interface
8# * test_io - tests everything else in the io module
9# * test_univnewlines - tests universal newline support
10# * test_largefile - tests operations on a file greater than 2**32 bytes
11# (only enabled with -ulargefile)
12
13################################################################################
14# ATTENTION TEST WRITERS!!!
15################################################################################
16# When writing tests for io, it's important to test both the C and Python
17# implementations. This is usually done by writing a base test that refers to
18# the type it is testing as a attribute. Then it provides custom subclasses to
19# test both implementations. This file has lots of examples.
20################################################################################
Guido van Rossum68bbcd22007-02-27 17:19:33 +000021
Guido van Rossum8358db22007-08-18 21:39:55 +000022import os
Guido van Rossum34d69e52007-04-10 20:08:41 +000023import sys
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +000024import time
Guido van Rossumd4103952007-04-12 05:44:49 +000025import array
Antoine Pitrou87695762008-08-14 22:44:29 +000026import random
Guido van Rossum28524c72007-02-27 05:47:44 +000027import unittest
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000028import weakref
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000029import abc
Antoine Pitroub46b9d52010-08-21 19:09:32 +000030import signal
31import errno
Antoine Pitroue033e062010-10-29 10:38:18 +000032import warnings
Antoine Pitrou243757e2010-11-05 21:15:39 +000033import pickle
Georg Brandl1b37e872010-03-14 10:45:50 +000034from itertools import cycle, count
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000035from collections import deque
Benjamin Petersonee8712c2008-05-20 21:35:26 +000036from test import support
Guido van Rossum76c5d4d2007-04-06 19:10:29 +000037
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +000038import codecs
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000039import io # C implementation of io
40import _pyio as pyio # Python implementation of io
Victor Stinner45df8202010-04-28 22:31:17 +000041try:
42 import threading
43except ImportError:
44 threading = None
Guido van Rossum28524c72007-02-27 05:47:44 +000045
Guido van Rossuma9e20242007-03-08 00:43:48 +000046
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000047def _default_chunk_size():
48 """Get the default TextIOWrapper chunk size"""
Marc-André Lemburg8f36af72011-02-25 15:42:01 +000049 with open(__file__, "r", encoding="latin-1") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000050 return f._CHUNK_SIZE
51
52
Antoine Pitrou328ec742010-09-14 18:37:24 +000053class MockRawIOWithoutRead:
54 """A RawIO implementation without read(), so as to exercise the default
55 RawIO.read() which calls readinto()."""
Guido van Rossuma9e20242007-03-08 00:43:48 +000056
Guido van Rossum76c5d4d2007-04-06 19:10:29 +000057 def __init__(self, read_stack=()):
58 self._read_stack = list(read_stack)
59 self._write_stack = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000060 self._reads = 0
Antoine Pitrou32cfede2010-08-11 13:31:33 +000061 self._extraneous_reads = 0
Guido van Rossum68bbcd22007-02-27 17:19:33 +000062
Guido van Rossum01a27522007-03-07 01:00:12 +000063 def write(self, b):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000064 self._write_stack.append(bytes(b))
Guido van Rossum01a27522007-03-07 01:00:12 +000065 return len(b)
66
67 def writable(self):
68 return True
69
Guido van Rossum68bbcd22007-02-27 17:19:33 +000070 def fileno(self):
71 return 42
72
73 def readable(self):
74 return True
75
Guido van Rossum01a27522007-03-07 01:00:12 +000076 def seekable(self):
Guido van Rossum68bbcd22007-02-27 17:19:33 +000077 return True
78
Guido van Rossum01a27522007-03-07 01:00:12 +000079 def seek(self, pos, whence):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000080 return 0 # wrong but we gotta return something
Guido van Rossum01a27522007-03-07 01:00:12 +000081
82 def tell(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000083 return 0 # same comment as above
84
85 def readinto(self, buf):
86 self._reads += 1
87 max_len = len(buf)
88 try:
89 data = self._read_stack[0]
90 except IndexError:
Antoine Pitrou32cfede2010-08-11 13:31:33 +000091 self._extraneous_reads += 1
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000092 return 0
93 if data is None:
94 del self._read_stack[0]
95 return None
96 n = len(data)
97 if len(data) <= max_len:
98 del self._read_stack[0]
99 buf[:n] = data
100 return n
101 else:
102 buf[:] = data[:max_len]
103 self._read_stack[0] = data[max_len:]
104 return max_len
105
106 def truncate(self, pos=None):
107 return pos
108
Antoine Pitrou328ec742010-09-14 18:37:24 +0000109class CMockRawIOWithoutRead(MockRawIOWithoutRead, io.RawIOBase):
110 pass
111
112class PyMockRawIOWithoutRead(MockRawIOWithoutRead, pyio.RawIOBase):
113 pass
114
115
116class MockRawIO(MockRawIOWithoutRead):
117
118 def read(self, n=None):
119 self._reads += 1
120 try:
121 return self._read_stack.pop(0)
122 except:
123 self._extraneous_reads += 1
124 return b""
125
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000126class CMockRawIO(MockRawIO, io.RawIOBase):
127 pass
128
129class PyMockRawIO(MockRawIO, pyio.RawIOBase):
130 pass
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000131
Guido van Rossuma9e20242007-03-08 00:43:48 +0000132
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000133class MisbehavedRawIO(MockRawIO):
134 def write(self, b):
135 return super().write(b) * 2
136
137 def read(self, n=None):
138 return super().read(n) * 2
139
140 def seek(self, pos, whence):
141 return -123
142
143 def tell(self):
144 return -456
145
146 def readinto(self, buf):
147 super().readinto(buf)
148 return len(buf) * 5
149
150class CMisbehavedRawIO(MisbehavedRawIO, io.RawIOBase):
151 pass
152
153class PyMisbehavedRawIO(MisbehavedRawIO, pyio.RawIOBase):
154 pass
155
156
157class CloseFailureIO(MockRawIO):
158 closed = 0
159
160 def close(self):
161 if not self.closed:
162 self.closed = 1
163 raise IOError
164
165class CCloseFailureIO(CloseFailureIO, io.RawIOBase):
166 pass
167
168class PyCloseFailureIO(CloseFailureIO, pyio.RawIOBase):
169 pass
170
171
172class MockFileIO:
Guido van Rossum78892e42007-04-06 17:31:18 +0000173
174 def __init__(self, data):
175 self.read_history = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000176 super().__init__(data)
Guido van Rossum78892e42007-04-06 17:31:18 +0000177
178 def read(self, n=None):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000179 res = super().read(n)
Guido van Rossum78892e42007-04-06 17:31:18 +0000180 self.read_history.append(None if res is None else len(res))
181 return res
182
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000183 def readinto(self, b):
184 res = super().readinto(b)
185 self.read_history.append(res)
186 return res
Guido van Rossum78892e42007-04-06 17:31:18 +0000187
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000188class CMockFileIO(MockFileIO, io.BytesIO):
189 pass
Guido van Rossuma9e20242007-03-08 00:43:48 +0000190
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000191class PyMockFileIO(MockFileIO, pyio.BytesIO):
192 pass
193
194
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000195class MockUnseekableIO:
196 def seekable(self):
197 return False
198
199 def seek(self, *args):
200 raise self.UnsupportedOperation("not seekable")
201
202 def tell(self, *args):
203 raise self.UnsupportedOperation("not seekable")
204
205class CMockUnseekableIO(MockUnseekableIO, io.BytesIO):
206 UnsupportedOperation = io.UnsupportedOperation
207
208class PyMockUnseekableIO(MockUnseekableIO, pyio.BytesIO):
209 UnsupportedOperation = pyio.UnsupportedOperation
210
211
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000212class MockNonBlockWriterIO:
213
214 def __init__(self):
Guido van Rossum01a27522007-03-07 01:00:12 +0000215 self._write_stack = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000216 self._blocker_char = None
Guido van Rossuma9e20242007-03-08 00:43:48 +0000217
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000218 def pop_written(self):
219 s = b"".join(self._write_stack)
220 self._write_stack[:] = []
221 return s
222
223 def block_on(self, char):
224 """Block when a given char is encountered."""
225 self._blocker_char = char
226
227 def readable(self):
228 return True
229
230 def seekable(self):
231 return True
Guido van Rossuma9e20242007-03-08 00:43:48 +0000232
Guido van Rossum01a27522007-03-07 01:00:12 +0000233 def writable(self):
234 return True
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000235
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000236 def write(self, b):
237 b = bytes(b)
238 n = -1
239 if self._blocker_char:
240 try:
241 n = b.index(self._blocker_char)
242 except ValueError:
243 pass
244 else:
245 self._blocker_char = None
246 self._write_stack.append(b[:n])
247 raise self.BlockingIOError(0, "test blocking", n)
248 self._write_stack.append(b)
249 return len(b)
250
251class CMockNonBlockWriterIO(MockNonBlockWriterIO, io.RawIOBase):
252 BlockingIOError = io.BlockingIOError
253
254class PyMockNonBlockWriterIO(MockNonBlockWriterIO, pyio.RawIOBase):
255 BlockingIOError = pyio.BlockingIOError
256
Guido van Rossuma9e20242007-03-08 00:43:48 +0000257
Guido van Rossum28524c72007-02-27 05:47:44 +0000258class IOTest(unittest.TestCase):
259
Neal Norwitze7789b12008-03-24 06:18:09 +0000260 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000261 support.unlink(support.TESTFN)
Neal Norwitze7789b12008-03-24 06:18:09 +0000262
Guido van Rossum4d0f5a42007-03-07 22:59:39 +0000263 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000264 support.unlink(support.TESTFN)
Guido van Rossum4d0f5a42007-03-07 22:59:39 +0000265
Guido van Rossum28524c72007-02-27 05:47:44 +0000266 def write_ops(self, f):
Guido van Rossum87429772007-04-10 21:06:59 +0000267 self.assertEqual(f.write(b"blah."), 5)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000268 f.truncate(0)
269 self.assertEqual(f.tell(), 5)
270 f.seek(0)
271
272 self.assertEqual(f.write(b"blah."), 5)
Guido van Rossum87429772007-04-10 21:06:59 +0000273 self.assertEqual(f.seek(0), 0)
274 self.assertEqual(f.write(b"Hello."), 6)
Guido van Rossum28524c72007-02-27 05:47:44 +0000275 self.assertEqual(f.tell(), 6)
Guido van Rossum87429772007-04-10 21:06:59 +0000276 self.assertEqual(f.seek(-1, 1), 5)
Guido van Rossum28524c72007-02-27 05:47:44 +0000277 self.assertEqual(f.tell(), 5)
Guido van Rossum254348e2007-11-21 19:29:53 +0000278 self.assertEqual(f.write(bytearray(b" world\n\n\n")), 9)
Guido van Rossum87429772007-04-10 21:06:59 +0000279 self.assertEqual(f.seek(0), 0)
Guido van Rossum2b08b382007-05-08 20:18:39 +0000280 self.assertEqual(f.write(b"h"), 1)
Guido van Rossum87429772007-04-10 21:06:59 +0000281 self.assertEqual(f.seek(-1, 2), 13)
282 self.assertEqual(f.tell(), 13)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000283
Guido van Rossum87429772007-04-10 21:06:59 +0000284 self.assertEqual(f.truncate(12), 12)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000285 self.assertEqual(f.tell(), 13)
Christian Heimes8e42a0a2007-11-08 18:04:45 +0000286 self.assertRaises(TypeError, f.seek, 0.0)
Guido van Rossum28524c72007-02-27 05:47:44 +0000287
Guido van Rossum9b76da62007-04-11 01:09:03 +0000288 def read_ops(self, f, buffered=False):
289 data = f.read(5)
290 self.assertEqual(data, b"hello")
Guido van Rossum254348e2007-11-21 19:29:53 +0000291 data = bytearray(data)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000292 self.assertEqual(f.readinto(data), 5)
293 self.assertEqual(data, b" worl")
294 self.assertEqual(f.readinto(data), 2)
295 self.assertEqual(len(data), 5)
296 self.assertEqual(data[:2], b"d\n")
297 self.assertEqual(f.seek(0), 0)
298 self.assertEqual(f.read(20), b"hello world\n")
299 self.assertEqual(f.read(1), b"")
Guido van Rossum254348e2007-11-21 19:29:53 +0000300 self.assertEqual(f.readinto(bytearray(b"x")), 0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000301 self.assertEqual(f.seek(-6, 2), 6)
302 self.assertEqual(f.read(5), b"world")
303 self.assertEqual(f.read(0), b"")
Guido van Rossum254348e2007-11-21 19:29:53 +0000304 self.assertEqual(f.readinto(bytearray()), 0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000305 self.assertEqual(f.seek(-6, 1), 5)
306 self.assertEqual(f.read(5), b" worl")
307 self.assertEqual(f.tell(), 10)
Christian Heimes8e42a0a2007-11-08 18:04:45 +0000308 self.assertRaises(TypeError, f.seek, 0.0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000309 if buffered:
310 f.seek(0)
311 self.assertEqual(f.read(), b"hello world\n")
312 f.seek(6)
313 self.assertEqual(f.read(), b"world\n")
314 self.assertEqual(f.read(), b"")
315
Guido van Rossum34d69e52007-04-10 20:08:41 +0000316 LARGE = 2**31
317
Guido van Rossum53807da2007-04-10 19:01:47 +0000318 def large_file_ops(self, f):
319 assert f.readable()
320 assert f.writable()
Guido van Rossum34d69e52007-04-10 20:08:41 +0000321 self.assertEqual(f.seek(self.LARGE), self.LARGE)
322 self.assertEqual(f.tell(), self.LARGE)
Guido van Rossum53807da2007-04-10 19:01:47 +0000323 self.assertEqual(f.write(b"xxx"), 3)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000324 self.assertEqual(f.tell(), self.LARGE + 3)
325 self.assertEqual(f.seek(-1, 1), self.LARGE + 2)
Guido van Rossum87429772007-04-10 21:06:59 +0000326 self.assertEqual(f.truncate(), self.LARGE + 2)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000327 self.assertEqual(f.tell(), self.LARGE + 2)
328 self.assertEqual(f.seek(0, 2), self.LARGE + 2)
Guido van Rossum87429772007-04-10 21:06:59 +0000329 self.assertEqual(f.truncate(self.LARGE + 1), self.LARGE + 1)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000330 self.assertEqual(f.tell(), self.LARGE + 2)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000331 self.assertEqual(f.seek(0, 2), self.LARGE + 1)
332 self.assertEqual(f.seek(-1, 2), self.LARGE)
Guido van Rossum53807da2007-04-10 19:01:47 +0000333 self.assertEqual(f.read(2), b"x")
334
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000335 def test_invalid_operations(self):
336 # Try writing on a file opened in read mode and vice-versa.
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000337 exc = self.UnsupportedOperation
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000338 for mode in ("w", "wb"):
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000339 with self.open(support.TESTFN, mode) as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000340 self.assertRaises(exc, fp.read)
341 self.assertRaises(exc, fp.readline)
342 with self.open(support.TESTFN, "wb", buffering=0) as fp:
343 self.assertRaises(exc, fp.read)
344 self.assertRaises(exc, fp.readline)
345 with self.open(support.TESTFN, "rb", buffering=0) as fp:
346 self.assertRaises(exc, fp.write, b"blah")
347 self.assertRaises(exc, fp.writelines, [b"blah\n"])
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000348 with self.open(support.TESTFN, "rb") as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000349 self.assertRaises(exc, fp.write, b"blah")
350 self.assertRaises(exc, fp.writelines, [b"blah\n"])
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000351 with self.open(support.TESTFN, "r") as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000352 self.assertRaises(exc, fp.write, "blah")
353 self.assertRaises(exc, fp.writelines, ["blah\n"])
354 # Non-zero seeking from current or end pos
355 self.assertRaises(exc, fp.seek, 1, self.SEEK_CUR)
356 self.assertRaises(exc, fp.seek, -1, self.SEEK_END)
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000357
Guido van Rossum28524c72007-02-27 05:47:44 +0000358 def test_raw_file_io(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000359 with self.open(support.TESTFN, "wb", buffering=0) as f:
360 self.assertEqual(f.readable(), False)
361 self.assertEqual(f.writable(), True)
362 self.assertEqual(f.seekable(), True)
363 self.write_ops(f)
364 with self.open(support.TESTFN, "rb", buffering=0) as f:
365 self.assertEqual(f.readable(), True)
366 self.assertEqual(f.writable(), False)
367 self.assertEqual(f.seekable(), True)
368 self.read_ops(f)
Guido van Rossum28524c72007-02-27 05:47:44 +0000369
Guido van Rossum87429772007-04-10 21:06:59 +0000370 def test_buffered_file_io(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000371 with self.open(support.TESTFN, "wb") as f:
372 self.assertEqual(f.readable(), False)
373 self.assertEqual(f.writable(), True)
374 self.assertEqual(f.seekable(), True)
375 self.write_ops(f)
376 with self.open(support.TESTFN, "rb") as f:
377 self.assertEqual(f.readable(), True)
378 self.assertEqual(f.writable(), False)
379 self.assertEqual(f.seekable(), True)
380 self.read_ops(f, True)
Guido van Rossum87429772007-04-10 21:06:59 +0000381
Guido van Rossum48fc58a2007-06-07 23:45:37 +0000382 def test_readline(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000383 with self.open(support.TESTFN, "wb") as f:
384 f.write(b"abc\ndef\nxyzzy\nfoo\x00bar\nanother line")
385 with self.open(support.TESTFN, "rb") as f:
386 self.assertEqual(f.readline(), b"abc\n")
387 self.assertEqual(f.readline(10), b"def\n")
388 self.assertEqual(f.readline(2), b"xy")
389 self.assertEqual(f.readline(4), b"zzy\n")
390 self.assertEqual(f.readline(), b"foo\x00bar\n")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000391 self.assertEqual(f.readline(None), b"another line")
Benjamin Peterson45cec322009-04-24 23:14:50 +0000392 self.assertRaises(TypeError, f.readline, 5.3)
393 with self.open(support.TESTFN, "r") as f:
394 self.assertRaises(TypeError, f.readline, 5.3)
Guido van Rossum48fc58a2007-06-07 23:45:37 +0000395
Guido van Rossum28524c72007-02-27 05:47:44 +0000396 def test_raw_bytes_io(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000397 f = self.BytesIO()
Guido van Rossum28524c72007-02-27 05:47:44 +0000398 self.write_ops(f)
399 data = f.getvalue()
400 self.assertEqual(data, b"hello world\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000401 f = self.BytesIO(data)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000402 self.read_ops(f, True)
Guido van Rossum28524c72007-02-27 05:47:44 +0000403
Guido van Rossum53807da2007-04-10 19:01:47 +0000404 def test_large_file_ops(self):
Guido van Rossum34d69e52007-04-10 20:08:41 +0000405 # On Windows and Mac OSX this test comsumes large resources; It takes
406 # a long time to build the >2GB file and takes >2GB of disk space
407 # therefore the resource must be enabled to run this test.
408 if sys.platform[:3] == 'win' or sys.platform == 'darwin':
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000409 if not support.is_resource_enabled("largefile"):
Guido van Rossum34d69e52007-04-10 20:08:41 +0000410 print("\nTesting large file ops skipped on %s." % sys.platform,
411 file=sys.stderr)
412 print("It requires %d bytes and a long time." % self.LARGE,
413 file=sys.stderr)
414 print("Use 'regrtest.py -u largefile test_io' to run it.",
415 file=sys.stderr)
416 return
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000417 with self.open(support.TESTFN, "w+b", 0) as f:
418 self.large_file_ops(f)
419 with self.open(support.TESTFN, "w+b") as f:
420 self.large_file_ops(f)
Guido van Rossum87429772007-04-10 21:06:59 +0000421
422 def test_with_open(self):
423 for bufsize in (0, 1, 100):
424 f = None
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000425 with self.open(support.TESTFN, "wb", bufsize) as f:
Guido van Rossum1f2ca562007-08-27 20:44:15 +0000426 f.write(b"xxx")
Guido van Rossum87429772007-04-10 21:06:59 +0000427 self.assertEqual(f.closed, True)
428 f = None
429 try:
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000430 with self.open(support.TESTFN, "wb", bufsize) as f:
Guido van Rossum87429772007-04-10 21:06:59 +0000431 1/0
432 except ZeroDivisionError:
433 self.assertEqual(f.closed, True)
434 else:
435 self.fail("1/0 didn't raise an exception")
436
Antoine Pitrou08838b62009-01-21 00:55:13 +0000437 # issue 5008
438 def test_append_mode_tell(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000439 with self.open(support.TESTFN, "wb") as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000440 f.write(b"xxx")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000441 with self.open(support.TESTFN, "ab", buffering=0) as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000442 self.assertEqual(f.tell(), 3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000443 with self.open(support.TESTFN, "ab") as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000444 self.assertEqual(f.tell(), 3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000445 with self.open(support.TESTFN, "a") as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000446 self.assertTrue(f.tell() > 0)
Antoine Pitrou08838b62009-01-21 00:55:13 +0000447
Guido van Rossum87429772007-04-10 21:06:59 +0000448 def test_destructor(self):
449 record = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000450 class MyFileIO(self.FileIO):
Guido van Rossum87429772007-04-10 21:06:59 +0000451 def __del__(self):
452 record.append(1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000453 try:
454 f = super().__del__
455 except AttributeError:
456 pass
457 else:
458 f()
Guido van Rossum87429772007-04-10 21:06:59 +0000459 def close(self):
460 record.append(2)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000461 super().close()
Guido van Rossum87429772007-04-10 21:06:59 +0000462 def flush(self):
463 record.append(3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000464 super().flush()
Brett Cannon5a9e91b2010-10-29 23:53:03 +0000465 with support.check_warnings(('', ResourceWarning)):
466 f = MyFileIO(support.TESTFN, "wb")
467 f.write(b"xxx")
468 del f
469 support.gc_collect()
470 self.assertEqual(record, [1, 2, 3])
471 with self.open(support.TESTFN, "rb") as f:
472 self.assertEqual(f.read(), b"xxx")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000473
474 def _check_base_destructor(self, base):
475 record = []
476 class MyIO(base):
477 def __init__(self):
478 # This exercises the availability of attributes on object
479 # destruction.
480 # (in the C version, close() is called by the tp_dealloc
481 # function, not by __del__)
482 self.on_del = 1
483 self.on_close = 2
484 self.on_flush = 3
485 def __del__(self):
486 record.append(self.on_del)
487 try:
488 f = super().__del__
489 except AttributeError:
490 pass
491 else:
492 f()
493 def close(self):
494 record.append(self.on_close)
495 super().close()
496 def flush(self):
497 record.append(self.on_flush)
498 super().flush()
499 f = MyIO()
Guido van Rossum87429772007-04-10 21:06:59 +0000500 del f
Benjamin Peterson24fb1d02009-04-24 23:26:21 +0000501 support.gc_collect()
Guido van Rossum87429772007-04-10 21:06:59 +0000502 self.assertEqual(record, [1, 2, 3])
503
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000504 def test_IOBase_destructor(self):
505 self._check_base_destructor(self.IOBase)
506
507 def test_RawIOBase_destructor(self):
508 self._check_base_destructor(self.RawIOBase)
509
510 def test_BufferedIOBase_destructor(self):
511 self._check_base_destructor(self.BufferedIOBase)
512
513 def test_TextIOBase_destructor(self):
514 self._check_base_destructor(self.TextIOBase)
515
Guido van Rossum87429772007-04-10 21:06:59 +0000516 def test_close_flushes(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000517 with self.open(support.TESTFN, "wb") as f:
518 f.write(b"xxx")
519 with self.open(support.TESTFN, "rb") as f:
520 self.assertEqual(f.read(), b"xxx")
Guido van Rossuma9e20242007-03-08 00:43:48 +0000521
Guido van Rossumd4103952007-04-12 05:44:49 +0000522 def test_array_writes(self):
523 a = array.array('i', range(10))
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +0000524 n = len(a.tobytes())
Benjamin Peterson45cec322009-04-24 23:14:50 +0000525 with self.open(support.TESTFN, "wb", 0) as f:
526 self.assertEqual(f.write(a), n)
527 with self.open(support.TESTFN, "wb") as f:
528 self.assertEqual(f.write(a), n)
Guido van Rossumd4103952007-04-12 05:44:49 +0000529
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000530 def test_closefd(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000531 self.assertRaises(ValueError, self.open, support.TESTFN, 'w',
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000532 closefd=False)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000533
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000534 def test_read_closed(self):
535 with self.open(support.TESTFN, "w") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000536 f.write("egg\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000537 with self.open(support.TESTFN, "r") as f:
538 file = self.open(f.fileno(), "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000539 self.assertEqual(file.read(), "egg\n")
540 file.seek(0)
541 file.close()
542 self.assertRaises(ValueError, file.read)
543
544 def test_no_closefd_with_filename(self):
545 # can't use closefd in combination with a file name
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000546 self.assertRaises(ValueError, self.open, support.TESTFN, "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000547
548 def test_closefd_attr(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000549 with self.open(support.TESTFN, "wb") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000550 f.write(b"egg\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000551 with self.open(support.TESTFN, "r") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000552 self.assertEqual(f.buffer.raw.closefd, True)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000553 file = self.open(f.fileno(), "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000554 self.assertEqual(file.buffer.raw.closefd, False)
555
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000556 def test_garbage_collection(self):
557 # FileIO objects are collected, and collecting them flushes
558 # all data to disk.
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +0000559 with support.check_warnings(('', ResourceWarning)):
560 f = self.FileIO(support.TESTFN, "wb")
561 f.write(b"abcxxx")
562 f.f = f
563 wr = weakref.ref(f)
564 del f
565 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000566 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000567 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000568 self.assertEqual(f.read(), b"abcxxx")
Christian Heimesecc42a22008-11-05 19:30:32 +0000569
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000570 def test_unbounded_file(self):
571 # Issue #1174606: reading from an unbounded stream such as /dev/zero.
572 zero = "/dev/zero"
573 if not os.path.exists(zero):
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000574 self.skipTest("{0} does not exist".format(zero))
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000575 if sys.maxsize > 0x7FFFFFFF:
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000576 self.skipTest("test can only run in a 32-bit address space")
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000577 if support.real_max_memuse < support._2G:
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000578 self.skipTest("test requires at least 2GB of memory")
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000579 with self.open(zero, "rb", buffering=0) as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000580 self.assertRaises(OverflowError, f.read)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000581 with self.open(zero, "rb") as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000582 self.assertRaises(OverflowError, f.read)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000583 with self.open(zero, "r") as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000584 self.assertRaises(OverflowError, f.read)
585
Antoine Pitrou6be88762010-05-03 16:48:20 +0000586 def test_flush_error_on_close(self):
587 f = self.open(support.TESTFN, "wb", buffering=0)
588 def bad_flush():
589 raise IOError()
590 f.flush = bad_flush
591 self.assertRaises(IOError, f.close) # exception not swallowed
592
593 def test_multi_close(self):
594 f = self.open(support.TESTFN, "wb", buffering=0)
595 f.close()
596 f.close()
597 f.close()
598 self.assertRaises(ValueError, f.flush)
599
Antoine Pitrou328ec742010-09-14 18:37:24 +0000600 def test_RawIOBase_read(self):
601 # Exercise the default RawIOBase.read() implementation (which calls
602 # readinto() internally).
603 rawio = self.MockRawIOWithoutRead((b"abc", b"d", None, b"efg", None))
604 self.assertEqual(rawio.read(2), b"ab")
605 self.assertEqual(rawio.read(2), b"c")
606 self.assertEqual(rawio.read(2), b"d")
607 self.assertEqual(rawio.read(2), None)
608 self.assertEqual(rawio.read(2), b"ef")
609 self.assertEqual(rawio.read(2), b"g")
610 self.assertEqual(rawio.read(2), None)
611 self.assertEqual(rawio.read(2), b"")
612
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000613class CIOTest(IOTest):
614 pass
Guido van Rossuma9e20242007-03-08 00:43:48 +0000615
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000616class PyIOTest(IOTest):
617 pass
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000618
Guido van Rossuma9e20242007-03-08 00:43:48 +0000619
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000620class CommonBufferedTests:
621 # Tests common to BufferedReader, BufferedWriter and BufferedRandom
622
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000623 def test_detach(self):
624 raw = self.MockRawIO()
625 buf = self.tp(raw)
626 self.assertIs(buf.detach(), raw)
627 self.assertRaises(ValueError, buf.detach)
628
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000629 def test_fileno(self):
630 rawio = self.MockRawIO()
631 bufio = self.tp(rawio)
632
Ezio Melottib3aedd42010-11-20 19:04:17 +0000633 self.assertEqual(42, bufio.fileno())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000634
635 def test_no_fileno(self):
636 # XXX will we always have fileno() function? If so, kill
637 # this test. Else, write it.
638 pass
639
640 def test_invalid_args(self):
641 rawio = self.MockRawIO()
642 bufio = self.tp(rawio)
643 # Invalid whence
644 self.assertRaises(ValueError, bufio.seek, 0, -1)
645 self.assertRaises(ValueError, bufio.seek, 0, 3)
646
647 def test_override_destructor(self):
648 tp = self.tp
649 record = []
650 class MyBufferedIO(tp):
651 def __del__(self):
652 record.append(1)
653 try:
654 f = super().__del__
655 except AttributeError:
656 pass
657 else:
658 f()
659 def close(self):
660 record.append(2)
661 super().close()
662 def flush(self):
663 record.append(3)
664 super().flush()
665 rawio = self.MockRawIO()
666 bufio = MyBufferedIO(rawio)
667 writable = bufio.writable()
668 del bufio
Benjamin Peterson24fb1d02009-04-24 23:26:21 +0000669 support.gc_collect()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000670 if writable:
671 self.assertEqual(record, [1, 2, 3])
672 else:
673 self.assertEqual(record, [1, 2])
674
675 def test_context_manager(self):
676 # Test usability as a context manager
677 rawio = self.MockRawIO()
678 bufio = self.tp(rawio)
679 def _with():
680 with bufio:
681 pass
682 _with()
683 # bufio should now be closed, and using it a second time should raise
684 # a ValueError.
685 self.assertRaises(ValueError, _with)
686
687 def test_error_through_destructor(self):
688 # Test that the exception state is not modified by a destructor,
689 # even if close() fails.
690 rawio = self.CloseFailureIO()
691 def f():
692 self.tp(rawio).xyzzy
693 with support.captured_output("stderr") as s:
694 self.assertRaises(AttributeError, f)
695 s = s.getvalue().strip()
696 if s:
697 # The destructor *may* have printed an unraisable error, check it
698 self.assertEqual(len(s.splitlines()), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000699 self.assertTrue(s.startswith("Exception IOError: "), s)
700 self.assertTrue(s.endswith(" ignored"), s)
Guido van Rossum78892e42007-04-06 17:31:18 +0000701
Antoine Pitrou716c4442009-05-23 19:04:03 +0000702 def test_repr(self):
703 raw = self.MockRawIO()
704 b = self.tp(raw)
705 clsname = "%s.%s" % (self.tp.__module__, self.tp.__name__)
706 self.assertEqual(repr(b), "<%s>" % clsname)
707 raw.name = "dummy"
708 self.assertEqual(repr(b), "<%s name='dummy'>" % clsname)
709 raw.name = b"dummy"
710 self.assertEqual(repr(b), "<%s name=b'dummy'>" % clsname)
711
Antoine Pitrou6be88762010-05-03 16:48:20 +0000712 def test_flush_error_on_close(self):
713 raw = self.MockRawIO()
714 def bad_flush():
715 raise IOError()
716 raw.flush = bad_flush
717 b = self.tp(raw)
718 self.assertRaises(IOError, b.close) # exception not swallowed
719
720 def test_multi_close(self):
721 raw = self.MockRawIO()
722 b = self.tp(raw)
723 b.close()
724 b.close()
725 b.close()
726 self.assertRaises(ValueError, b.flush)
727
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000728 def test_unseekable(self):
729 bufio = self.tp(self.MockUnseekableIO(b"A" * 10))
730 self.assertRaises(self.UnsupportedOperation, bufio.tell)
731 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
732
Antoine Pitrou7f8f4182010-12-21 21:20:59 +0000733 def test_readonly_attributes(self):
734 raw = self.MockRawIO()
735 buf = self.tp(raw)
736 x = self.MockRawIO()
737 with self.assertRaises(AttributeError):
738 buf.raw = x
739
Guido van Rossum78892e42007-04-06 17:31:18 +0000740
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000741class BufferedReaderTest(unittest.TestCase, CommonBufferedTests):
742 read_mode = "rb"
Guido van Rossum78892e42007-04-06 17:31:18 +0000743
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000744 def test_constructor(self):
745 rawio = self.MockRawIO([b"abc"])
746 bufio = self.tp(rawio)
747 bufio.__init__(rawio)
748 bufio.__init__(rawio, buffer_size=1024)
749 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000750 self.assertEqual(b"abc", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000751 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
752 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
753 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
754 rawio = self.MockRawIO([b"abc"])
755 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000756 self.assertEqual(b"abc", bufio.read())
Guido van Rossum78892e42007-04-06 17:31:18 +0000757
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000758 def test_read(self):
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000759 for arg in (None, 7):
760 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
761 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000762 self.assertEqual(b"abcdefg", bufio.read(arg))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000763 # Invalid args
764 self.assertRaises(ValueError, bufio.read, -2)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000765
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000766 def test_read1(self):
767 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
768 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000769 self.assertEqual(b"a", bufio.read(1))
770 self.assertEqual(b"b", bufio.read1(1))
771 self.assertEqual(rawio._reads, 1)
772 self.assertEqual(b"c", bufio.read1(100))
773 self.assertEqual(rawio._reads, 1)
774 self.assertEqual(b"d", bufio.read1(100))
775 self.assertEqual(rawio._reads, 2)
776 self.assertEqual(b"efg", bufio.read1(100))
777 self.assertEqual(rawio._reads, 3)
778 self.assertEqual(b"", bufio.read1(100))
779 self.assertEqual(rawio._reads, 4)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000780 # Invalid args
781 self.assertRaises(ValueError, bufio.read1, -1)
782
783 def test_readinto(self):
784 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
785 bufio = self.tp(rawio)
786 b = bytearray(2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000787 self.assertEqual(bufio.readinto(b), 2)
788 self.assertEqual(b, b"ab")
789 self.assertEqual(bufio.readinto(b), 2)
790 self.assertEqual(b, b"cd")
791 self.assertEqual(bufio.readinto(b), 2)
792 self.assertEqual(b, b"ef")
793 self.assertEqual(bufio.readinto(b), 1)
794 self.assertEqual(b, b"gf")
795 self.assertEqual(bufio.readinto(b), 0)
796 self.assertEqual(b, b"gf")
Antoine Pitrou3486a982011-05-12 01:57:53 +0200797 rawio = self.MockRawIO((b"abc", None))
798 bufio = self.tp(rawio)
799 self.assertEqual(bufio.readinto(b), 2)
800 self.assertEqual(b, b"ab")
801 self.assertEqual(bufio.readinto(b), 1)
802 self.assertEqual(b, b"cb")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000803
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000804 def test_readlines(self):
805 def bufio():
806 rawio = self.MockRawIO((b"abc\n", b"d\n", b"ef"))
807 return self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000808 self.assertEqual(bufio().readlines(), [b"abc\n", b"d\n", b"ef"])
809 self.assertEqual(bufio().readlines(5), [b"abc\n", b"d\n"])
810 self.assertEqual(bufio().readlines(None), [b"abc\n", b"d\n", b"ef"])
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000811
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000812 def test_buffering(self):
Guido van Rossum78892e42007-04-06 17:31:18 +0000813 data = b"abcdefghi"
814 dlen = len(data)
815
816 tests = [
817 [ 100, [ 3, 1, 4, 8 ], [ dlen, 0 ] ],
818 [ 100, [ 3, 3, 3], [ dlen ] ],
819 [ 4, [ 1, 2, 4, 2 ], [ 4, 4, 1 ] ],
820 ]
821
822 for bufsize, buf_read_sizes, raw_read_sizes in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000823 rawio = self.MockFileIO(data)
824 bufio = self.tp(rawio, buffer_size=bufsize)
Guido van Rossum78892e42007-04-06 17:31:18 +0000825 pos = 0
826 for nbytes in buf_read_sizes:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000827 self.assertEqual(bufio.read(nbytes), data[pos:pos+nbytes])
Guido van Rossum78892e42007-04-06 17:31:18 +0000828 pos += nbytes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000829 # this is mildly implementation-dependent
Ezio Melottib3aedd42010-11-20 19:04:17 +0000830 self.assertEqual(rawio.read_history, raw_read_sizes)
Guido van Rossum78892e42007-04-06 17:31:18 +0000831
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000832 def test_read_non_blocking(self):
Guido van Rossum01a27522007-03-07 01:00:12 +0000833 # Inject some None's in there to simulate EWOULDBLOCK
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000834 rawio = self.MockRawIO((b"abc", b"d", None, b"efg", None, None, None))
835 bufio = self.tp(rawio)
Guido van Rossum01a27522007-03-07 01:00:12 +0000836
Ezio Melottib3aedd42010-11-20 19:04:17 +0000837 self.assertEqual(b"abcd", bufio.read(6))
838 self.assertEqual(b"e", bufio.read(1))
839 self.assertEqual(b"fg", bufio.read())
840 self.assertEqual(b"", bufio.peek(1))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000841 self.assertTrue(None is bufio.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +0000842 self.assertEqual(b"", bufio.read())
Guido van Rossum01a27522007-03-07 01:00:12 +0000843
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000844 def test_read_past_eof(self):
845 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
846 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000847
Ezio Melottib3aedd42010-11-20 19:04:17 +0000848 self.assertEqual(b"abcdefg", bufio.read(9000))
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000849
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000850 def test_read_all(self):
851 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
852 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000853
Ezio Melottib3aedd42010-11-20 19:04:17 +0000854 self.assertEqual(b"abcdefg", bufio.read())
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000855
Victor Stinner45df8202010-04-28 22:31:17 +0000856 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000857 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000858 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +0000859 try:
860 # Write out many bytes with exactly the same number of 0's,
861 # 1's... 255's. This will help us check that concurrent reading
862 # doesn't duplicate or forget contents.
863 N = 1000
864 l = list(range(256)) * N
865 random.shuffle(l)
866 s = bytes(bytearray(l))
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000867 with self.open(support.TESTFN, "wb") as f:
Antoine Pitrou87695762008-08-14 22:44:29 +0000868 f.write(s)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000869 with self.open(support.TESTFN, self.read_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000870 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +0000871 errors = []
872 results = []
873 def f():
874 try:
875 # Intra-buffer read then buffer-flushing read
876 for n in cycle([1, 19]):
877 s = bufio.read(n)
878 if not s:
879 break
880 # list.append() is atomic
881 results.append(s)
882 except Exception as e:
883 errors.append(e)
884 raise
885 threads = [threading.Thread(target=f) for x in range(20)]
886 for t in threads:
887 t.start()
888 time.sleep(0.02) # yield
889 for t in threads:
890 t.join()
891 self.assertFalse(errors,
892 "the following exceptions were caught: %r" % errors)
893 s = b''.join(results)
894 for i in range(256):
895 c = bytes(bytearray([i]))
896 self.assertEqual(s.count(c), N)
897 finally:
898 support.unlink(support.TESTFN)
899
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000900 def test_misbehaved_io(self):
901 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
902 bufio = self.tp(rawio)
903 self.assertRaises(IOError, bufio.seek, 0)
904 self.assertRaises(IOError, bufio.tell)
905
Antoine Pitrou32cfede2010-08-11 13:31:33 +0000906 def test_no_extraneous_read(self):
907 # Issue #9550; when the raw IO object has satisfied the read request,
908 # we should not issue any additional reads, otherwise it may block
909 # (e.g. socket).
910 bufsize = 16
911 for n in (2, bufsize - 1, bufsize, bufsize + 1, bufsize * 2):
912 rawio = self.MockRawIO([b"x" * n])
913 bufio = self.tp(rawio, bufsize)
914 self.assertEqual(bufio.read(n), b"x" * n)
915 # Simple case: one raw read is enough to satisfy the request.
916 self.assertEqual(rawio._extraneous_reads, 0,
917 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
918 # A more complex case where two raw reads are needed to satisfy
919 # the request.
920 rawio = self.MockRawIO([b"x" * (n - 1), b"x"])
921 bufio = self.tp(rawio, bufsize)
922 self.assertEqual(bufio.read(n), b"x" * n)
923 self.assertEqual(rawio._extraneous_reads, 0,
924 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
925
926
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000927class CBufferedReaderTest(BufferedReaderTest):
928 tp = io.BufferedReader
929
930 def test_constructor(self):
931 BufferedReaderTest.test_constructor(self)
932 # The allocation can succeed on 32-bit builds, e.g. with more
933 # than 2GB RAM and a 64-bit kernel.
934 if sys.maxsize > 0x7FFFFFFF:
935 rawio = self.MockRawIO()
936 bufio = self.tp(rawio)
937 self.assertRaises((OverflowError, MemoryError, ValueError),
938 bufio.__init__, rawio, sys.maxsize)
939
940 def test_initialization(self):
941 rawio = self.MockRawIO([b"abc"])
942 bufio = self.tp(rawio)
943 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
944 self.assertRaises(ValueError, bufio.read)
945 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
946 self.assertRaises(ValueError, bufio.read)
947 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
948 self.assertRaises(ValueError, bufio.read)
949
950 def test_misbehaved_io_read(self):
951 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
952 bufio = self.tp(rawio)
953 # _pyio.BufferedReader seems to implement reading different, so that
954 # checking this is not so easy.
955 self.assertRaises(IOError, bufio.read, 10)
956
957 def test_garbage_collection(self):
958 # C BufferedReader objects are collected.
959 # The Python version has __del__, so it ends into gc.garbage instead
960 rawio = self.FileIO(support.TESTFN, "w+b")
961 f = self.tp(rawio)
962 f.f = f
963 wr = weakref.ref(f)
964 del f
Benjamin Peterson45cec322009-04-24 23:14:50 +0000965 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000966 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000967
968class PyBufferedReaderTest(BufferedReaderTest):
969 tp = pyio.BufferedReader
Antoine Pitrou87695762008-08-14 22:44:29 +0000970
Guido van Rossuma9e20242007-03-08 00:43:48 +0000971
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000972class BufferedWriterTest(unittest.TestCase, CommonBufferedTests):
973 write_mode = "wb"
Guido van Rossuma9e20242007-03-08 00:43:48 +0000974
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000975 def test_constructor(self):
976 rawio = self.MockRawIO()
977 bufio = self.tp(rawio)
978 bufio.__init__(rawio)
979 bufio.__init__(rawio, buffer_size=1024)
980 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000981 self.assertEqual(3, bufio.write(b"abc"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000982 bufio.flush()
983 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
984 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
985 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
986 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000987 self.assertEqual(3, bufio.write(b"ghi"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000988 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +0000989 self.assertEqual(b"".join(rawio._write_stack), b"abcghi")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000990
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000991 def test_detach_flush(self):
992 raw = self.MockRawIO()
993 buf = self.tp(raw)
994 buf.write(b"howdy!")
995 self.assertFalse(raw._write_stack)
996 buf.detach()
997 self.assertEqual(raw._write_stack, [b"howdy!"])
998
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000999 def test_write(self):
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001000 # Write to the buffered IO but don't overflow the buffer.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001001 writer = self.MockRawIO()
1002 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001003 bufio.write(b"abc")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001004 self.assertFalse(writer._write_stack)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001005
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001006 def test_write_overflow(self):
1007 writer = self.MockRawIO()
1008 bufio = self.tp(writer, 8)
1009 contents = b"abcdefghijklmnop"
1010 for n in range(0, len(contents), 3):
1011 bufio.write(contents[n:n+3])
1012 flushed = b"".join(writer._write_stack)
1013 # At least (total - 8) bytes were implicitly flushed, perhaps more
1014 # depending on the implementation.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001015 self.assertTrue(flushed.startswith(contents[:-8]), flushed)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001016
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001017 def check_writes(self, intermediate_func):
1018 # Lots of writes, test the flushed output is as expected.
1019 contents = bytes(range(256)) * 1000
1020 n = 0
1021 writer = self.MockRawIO()
1022 bufio = self.tp(writer, 13)
1023 # Generator of write sizes: repeat each N 15 times then proceed to N+1
1024 def gen_sizes():
1025 for size in count(1):
1026 for i in range(15):
1027 yield size
1028 sizes = gen_sizes()
1029 while n < len(contents):
1030 size = min(next(sizes), len(contents) - n)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001031 self.assertEqual(bufio.write(contents[n:n+size]), size)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001032 intermediate_func(bufio)
1033 n += size
1034 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001035 self.assertEqual(contents, b"".join(writer._write_stack))
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001036
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001037 def test_writes(self):
1038 self.check_writes(lambda bufio: None)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001039
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001040 def test_writes_and_flushes(self):
1041 self.check_writes(lambda bufio: bufio.flush())
Guido van Rossum01a27522007-03-07 01:00:12 +00001042
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001043 def test_writes_and_seeks(self):
1044 def _seekabs(bufio):
1045 pos = bufio.tell()
1046 bufio.seek(pos + 1, 0)
1047 bufio.seek(pos - 1, 0)
1048 bufio.seek(pos, 0)
1049 self.check_writes(_seekabs)
1050 def _seekrel(bufio):
1051 pos = bufio.seek(0, 1)
1052 bufio.seek(+1, 1)
1053 bufio.seek(-1, 1)
1054 bufio.seek(pos, 0)
1055 self.check_writes(_seekrel)
Guido van Rossum01a27522007-03-07 01:00:12 +00001056
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001057 def test_writes_and_truncates(self):
1058 self.check_writes(lambda bufio: bufio.truncate(bufio.tell()))
Guido van Rossum01a27522007-03-07 01:00:12 +00001059
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001060 def test_write_non_blocking(self):
1061 raw = self.MockNonBlockWriterIO()
Benjamin Peterson59406a92009-03-26 17:10:29 +00001062 bufio = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001063
Ezio Melottib3aedd42010-11-20 19:04:17 +00001064 self.assertEqual(bufio.write(b"abcd"), 4)
1065 self.assertEqual(bufio.write(b"efghi"), 5)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001066 # 1 byte will be written, the rest will be buffered
1067 raw.block_on(b"k")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001068 self.assertEqual(bufio.write(b"jklmn"), 5)
Guido van Rossum01a27522007-03-07 01:00:12 +00001069
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001070 # 8 bytes will be written, 8 will be buffered and the rest will be lost
1071 raw.block_on(b"0")
1072 try:
1073 bufio.write(b"opqrwxyz0123456789")
1074 except self.BlockingIOError as e:
1075 written = e.characters_written
1076 else:
1077 self.fail("BlockingIOError should have been raised")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001078 self.assertEqual(written, 16)
1079 self.assertEqual(raw.pop_written(),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001080 b"abcdefghijklmnopqrwxyz")
Guido van Rossum01a27522007-03-07 01:00:12 +00001081
Ezio Melottib3aedd42010-11-20 19:04:17 +00001082 self.assertEqual(bufio.write(b"ABCDEFGHI"), 9)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001083 s = raw.pop_written()
1084 # Previously buffered bytes were flushed
1085 self.assertTrue(s.startswith(b"01234567A"), s)
Guido van Rossum01a27522007-03-07 01:00:12 +00001086
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001087 def test_write_and_rewind(self):
1088 raw = io.BytesIO()
1089 bufio = self.tp(raw, 4)
1090 self.assertEqual(bufio.write(b"abcdef"), 6)
1091 self.assertEqual(bufio.tell(), 6)
1092 bufio.seek(0, 0)
1093 self.assertEqual(bufio.write(b"XY"), 2)
1094 bufio.seek(6, 0)
1095 self.assertEqual(raw.getvalue(), b"XYcdef")
1096 self.assertEqual(bufio.write(b"123456"), 6)
1097 bufio.flush()
1098 self.assertEqual(raw.getvalue(), b"XYcdef123456")
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001099
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001100 def test_flush(self):
1101 writer = self.MockRawIO()
1102 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001103 bufio.write(b"abc")
1104 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001105 self.assertEqual(b"abc", writer._write_stack[0])
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001106
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001107 def test_destructor(self):
1108 writer = self.MockRawIO()
1109 bufio = self.tp(writer, 8)
1110 bufio.write(b"abc")
1111 del bufio
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001112 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001113 self.assertEqual(b"abc", writer._write_stack[0])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001114
1115 def test_truncate(self):
1116 # Truncate implicitly flushes the buffer.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001117 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001118 bufio = self.tp(raw, 8)
1119 bufio.write(b"abcdef")
1120 self.assertEqual(bufio.truncate(3), 3)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001121 self.assertEqual(bufio.tell(), 6)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001122 with self.open(support.TESTFN, "rb", buffering=0) as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001123 self.assertEqual(f.read(), b"abc")
1124
Victor Stinner45df8202010-04-28 22:31:17 +00001125 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +00001126 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001127 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +00001128 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001129 # Write out many bytes from many threads and test they were
1130 # all flushed.
1131 N = 1000
1132 contents = bytes(range(256)) * N
1133 sizes = cycle([1, 19])
1134 n = 0
1135 queue = deque()
1136 while n < len(contents):
1137 size = next(sizes)
1138 queue.append(contents[n:n+size])
1139 n += size
1140 del contents
Antoine Pitrou87695762008-08-14 22:44:29 +00001141 # We use a real file object because it allows us to
1142 # exercise situations where the GIL is released before
1143 # writing the buffer to the raw streams. This is in addition
1144 # to concurrency issues due to switching threads in the middle
1145 # of Python code.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001146 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001147 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +00001148 errors = []
1149 def f():
1150 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001151 while True:
1152 try:
1153 s = queue.popleft()
1154 except IndexError:
1155 return
Antoine Pitrou87695762008-08-14 22:44:29 +00001156 bufio.write(s)
1157 except Exception as e:
1158 errors.append(e)
1159 raise
1160 threads = [threading.Thread(target=f) for x in range(20)]
1161 for t in threads:
1162 t.start()
1163 time.sleep(0.02) # yield
1164 for t in threads:
1165 t.join()
1166 self.assertFalse(errors,
1167 "the following exceptions were caught: %r" % errors)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001168 bufio.close()
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001169 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001170 s = f.read()
1171 for i in range(256):
Ezio Melottib3aedd42010-11-20 19:04:17 +00001172 self.assertEqual(s.count(bytes([i])), N)
Antoine Pitrou87695762008-08-14 22:44:29 +00001173 finally:
1174 support.unlink(support.TESTFN)
1175
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001176 def test_misbehaved_io(self):
1177 rawio = self.MisbehavedRawIO()
1178 bufio = self.tp(rawio, 5)
1179 self.assertRaises(IOError, bufio.seek, 0)
1180 self.assertRaises(IOError, bufio.tell)
1181 self.assertRaises(IOError, bufio.write, b"abcdef")
1182
Benjamin Peterson59406a92009-03-26 17:10:29 +00001183 def test_max_buffer_size_deprecation(self):
Florent Xicluna8fbddf12010-03-17 20:29:51 +00001184 with support.check_warnings(("max_buffer_size is deprecated",
1185 DeprecationWarning)):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001186 self.tp(self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001187
1188
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001189class CBufferedWriterTest(BufferedWriterTest):
1190 tp = io.BufferedWriter
1191
1192 def test_constructor(self):
1193 BufferedWriterTest.test_constructor(self)
1194 # The allocation can succeed on 32-bit builds, e.g. with more
1195 # than 2GB RAM and a 64-bit kernel.
1196 if sys.maxsize > 0x7FFFFFFF:
1197 rawio = self.MockRawIO()
1198 bufio = self.tp(rawio)
1199 self.assertRaises((OverflowError, MemoryError, ValueError),
1200 bufio.__init__, rawio, sys.maxsize)
1201
1202 def test_initialization(self):
1203 rawio = self.MockRawIO()
1204 bufio = self.tp(rawio)
1205 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1206 self.assertRaises(ValueError, bufio.write, b"def")
1207 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1208 self.assertRaises(ValueError, bufio.write, b"def")
1209 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1210 self.assertRaises(ValueError, bufio.write, b"def")
1211
1212 def test_garbage_collection(self):
1213 # C BufferedWriter objects are collected, and collecting them flushes
1214 # all data to disk.
1215 # The Python version has __del__, so it ends into gc.garbage instead
1216 rawio = self.FileIO(support.TESTFN, "w+b")
1217 f = self.tp(rawio)
1218 f.write(b"123xxx")
1219 f.x = f
1220 wr = weakref.ref(f)
1221 del f
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001222 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001223 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001224 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001225 self.assertEqual(f.read(), b"123xxx")
1226
1227
1228class PyBufferedWriterTest(BufferedWriterTest):
1229 tp = pyio.BufferedWriter
Guido van Rossuma9e20242007-03-08 00:43:48 +00001230
Guido van Rossum01a27522007-03-07 01:00:12 +00001231class BufferedRWPairTest(unittest.TestCase):
Guido van Rossuma9e20242007-03-08 00:43:48 +00001232
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001233 def test_constructor(self):
1234 pair = self.tp(self.MockRawIO(), self.MockRawIO())
Benjamin Peterson92035012008-12-27 16:00:54 +00001235 self.assertFalse(pair.closed)
Guido van Rossum01a27522007-03-07 01:00:12 +00001236
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001237 def test_detach(self):
1238 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1239 self.assertRaises(self.UnsupportedOperation, pair.detach)
1240
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001241 def test_constructor_max_buffer_size_deprecation(self):
Florent Xicluna8fbddf12010-03-17 20:29:51 +00001242 with support.check_warnings(("max_buffer_size is deprecated",
1243 DeprecationWarning)):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001244 self.tp(self.MockRawIO(), self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001245
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001246 def test_constructor_with_not_readable(self):
1247 class NotReadable(MockRawIO):
1248 def readable(self):
1249 return False
1250
1251 self.assertRaises(IOError, self.tp, NotReadable(), self.MockRawIO())
1252
1253 def test_constructor_with_not_writeable(self):
1254 class NotWriteable(MockRawIO):
1255 def writable(self):
1256 return False
1257
1258 self.assertRaises(IOError, self.tp, self.MockRawIO(), NotWriteable())
1259
1260 def test_read(self):
1261 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1262
1263 self.assertEqual(pair.read(3), b"abc")
1264 self.assertEqual(pair.read(1), b"d")
1265 self.assertEqual(pair.read(), b"ef")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00001266 pair = self.tp(self.BytesIO(b"abc"), self.MockRawIO())
1267 self.assertEqual(pair.read(None), b"abc")
1268
1269 def test_readlines(self):
1270 pair = lambda: self.tp(self.BytesIO(b"abc\ndef\nh"), self.MockRawIO())
1271 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1272 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1273 self.assertEqual(pair().readlines(5), [b"abc\n", b"def\n"])
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001274
1275 def test_read1(self):
1276 # .read1() is delegated to the underlying reader object, so this test
1277 # can be shallow.
1278 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1279
1280 self.assertEqual(pair.read1(3), b"abc")
1281
1282 def test_readinto(self):
1283 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1284
1285 data = bytearray(5)
1286 self.assertEqual(pair.readinto(data), 5)
1287 self.assertEqual(data, b"abcde")
1288
1289 def test_write(self):
1290 w = self.MockRawIO()
1291 pair = self.tp(self.MockRawIO(), w)
1292
1293 pair.write(b"abc")
1294 pair.flush()
1295 pair.write(b"def")
1296 pair.flush()
1297 self.assertEqual(w._write_stack, [b"abc", b"def"])
1298
1299 def test_peek(self):
1300 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1301
1302 self.assertTrue(pair.peek(3).startswith(b"abc"))
1303 self.assertEqual(pair.read(3), b"abc")
1304
1305 def test_readable(self):
1306 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1307 self.assertTrue(pair.readable())
1308
1309 def test_writeable(self):
1310 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1311 self.assertTrue(pair.writable())
1312
1313 def test_seekable(self):
1314 # BufferedRWPairs are never seekable, even if their readers and writers
1315 # are.
1316 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1317 self.assertFalse(pair.seekable())
1318
1319 # .flush() is delegated to the underlying writer object and has been
1320 # tested in the test_write method.
1321
1322 def test_close_and_closed(self):
1323 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1324 self.assertFalse(pair.closed)
1325 pair.close()
1326 self.assertTrue(pair.closed)
1327
1328 def test_isatty(self):
1329 class SelectableIsAtty(MockRawIO):
1330 def __init__(self, isatty):
1331 MockRawIO.__init__(self)
1332 self._isatty = isatty
1333
1334 def isatty(self):
1335 return self._isatty
1336
1337 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(False))
1338 self.assertFalse(pair.isatty())
1339
1340 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(False))
1341 self.assertTrue(pair.isatty())
1342
1343 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(True))
1344 self.assertTrue(pair.isatty())
1345
1346 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(True))
1347 self.assertTrue(pair.isatty())
Guido van Rossum01a27522007-03-07 01:00:12 +00001348
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001349class CBufferedRWPairTest(BufferedRWPairTest):
1350 tp = io.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001351
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001352class PyBufferedRWPairTest(BufferedRWPairTest):
1353 tp = pyio.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001354
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001355
1356class BufferedRandomTest(BufferedReaderTest, BufferedWriterTest):
1357 read_mode = "rb+"
1358 write_mode = "wb+"
1359
1360 def test_constructor(self):
1361 BufferedReaderTest.test_constructor(self)
1362 BufferedWriterTest.test_constructor(self)
1363
1364 def test_read_and_write(self):
1365 raw = self.MockRawIO((b"asdf", b"ghjk"))
Benjamin Peterson59406a92009-03-26 17:10:29 +00001366 rw = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001367
1368 self.assertEqual(b"as", rw.read(2))
1369 rw.write(b"ddd")
1370 rw.write(b"eee")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001371 self.assertFalse(raw._write_stack) # Buffer writes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001372 self.assertEqual(b"ghjk", rw.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +00001373 self.assertEqual(b"dddeee", raw._write_stack[0])
Guido van Rossum01a27522007-03-07 01:00:12 +00001374
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001375 def test_seek_and_tell(self):
1376 raw = self.BytesIO(b"asdfghjkl")
1377 rw = self.tp(raw)
Guido van Rossum01a27522007-03-07 01:00:12 +00001378
Ezio Melottib3aedd42010-11-20 19:04:17 +00001379 self.assertEqual(b"as", rw.read(2))
1380 self.assertEqual(2, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001381 rw.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001382 self.assertEqual(b"asdf", rw.read(4))
Guido van Rossum01a27522007-03-07 01:00:12 +00001383
1384 rw.write(b"asdf")
1385 rw.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001386 self.assertEqual(b"asdfasdfl", rw.read())
1387 self.assertEqual(9, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001388 rw.seek(-4, 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001389 self.assertEqual(5, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001390 rw.seek(2, 1)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001391 self.assertEqual(7, rw.tell())
1392 self.assertEqual(b"fl", rw.read(11))
Christian Heimes8e42a0a2007-11-08 18:04:45 +00001393 self.assertRaises(TypeError, rw.seek, 0.0)
Guido van Rossum01a27522007-03-07 01:00:12 +00001394
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001395 def check_flush_and_read(self, read_func):
1396 raw = self.BytesIO(b"abcdefghi")
1397 bufio = self.tp(raw)
1398
Ezio Melottib3aedd42010-11-20 19:04:17 +00001399 self.assertEqual(b"ab", read_func(bufio, 2))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001400 bufio.write(b"12")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001401 self.assertEqual(b"ef", read_func(bufio, 2))
1402 self.assertEqual(6, bufio.tell())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001403 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001404 self.assertEqual(6, bufio.tell())
1405 self.assertEqual(b"ghi", read_func(bufio))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001406 raw.seek(0, 0)
1407 raw.write(b"XYZ")
1408 # flush() resets the read buffer
1409 bufio.flush()
1410 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001411 self.assertEqual(b"XYZ", read_func(bufio, 3))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001412
1413 def test_flush_and_read(self):
1414 self.check_flush_and_read(lambda bufio, *args: bufio.read(*args))
1415
1416 def test_flush_and_readinto(self):
1417 def _readinto(bufio, n=-1):
1418 b = bytearray(n if n >= 0 else 9999)
1419 n = bufio.readinto(b)
1420 return bytes(b[:n])
1421 self.check_flush_and_read(_readinto)
1422
1423 def test_flush_and_peek(self):
1424 def _peek(bufio, n=-1):
1425 # This relies on the fact that the buffer can contain the whole
1426 # raw stream, otherwise peek() can return less.
1427 b = bufio.peek(n)
1428 if n != -1:
1429 b = b[:n]
1430 bufio.seek(len(b), 1)
1431 return b
1432 self.check_flush_and_read(_peek)
1433
1434 def test_flush_and_write(self):
1435 raw = self.BytesIO(b"abcdefghi")
1436 bufio = self.tp(raw)
1437
1438 bufio.write(b"123")
1439 bufio.flush()
1440 bufio.write(b"45")
1441 bufio.flush()
1442 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001443 self.assertEqual(b"12345fghi", raw.getvalue())
1444 self.assertEqual(b"12345fghi", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001445
1446 def test_threads(self):
1447 BufferedReaderTest.test_threads(self)
1448 BufferedWriterTest.test_threads(self)
1449
1450 def test_writes_and_peek(self):
1451 def _peek(bufio):
1452 bufio.peek(1)
1453 self.check_writes(_peek)
1454 def _peek(bufio):
1455 pos = bufio.tell()
1456 bufio.seek(-1, 1)
1457 bufio.peek(1)
1458 bufio.seek(pos, 0)
1459 self.check_writes(_peek)
1460
1461 def test_writes_and_reads(self):
1462 def _read(bufio):
1463 bufio.seek(-1, 1)
1464 bufio.read(1)
1465 self.check_writes(_read)
1466
1467 def test_writes_and_read1s(self):
1468 def _read1(bufio):
1469 bufio.seek(-1, 1)
1470 bufio.read1(1)
1471 self.check_writes(_read1)
1472
1473 def test_writes_and_readintos(self):
1474 def _read(bufio):
1475 bufio.seek(-1, 1)
1476 bufio.readinto(bytearray(1))
1477 self.check_writes(_read)
1478
Antoine Pitroua0ceb732009-08-06 20:29:56 +00001479 def test_write_after_readahead(self):
1480 # Issue #6629: writing after the buffer was filled by readahead should
1481 # first rewind the raw stream.
1482 for overwrite_size in [1, 5]:
1483 raw = self.BytesIO(b"A" * 10)
1484 bufio = self.tp(raw, 4)
1485 # Trigger readahead
1486 self.assertEqual(bufio.read(1), b"A")
1487 self.assertEqual(bufio.tell(), 1)
1488 # Overwriting should rewind the raw stream if it needs so
1489 bufio.write(b"B" * overwrite_size)
1490 self.assertEqual(bufio.tell(), overwrite_size + 1)
1491 # If the write size was smaller than the buffer size, flush() and
1492 # check that rewind happens.
1493 bufio.flush()
1494 self.assertEqual(bufio.tell(), overwrite_size + 1)
1495 s = raw.getvalue()
1496 self.assertEqual(s,
1497 b"A" + b"B" * overwrite_size + b"A" * (9 - overwrite_size))
1498
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001499 def test_truncate_after_read_or_write(self):
1500 raw = self.BytesIO(b"A" * 10)
1501 bufio = self.tp(raw, 100)
1502 self.assertEqual(bufio.read(2), b"AA") # the read buffer gets filled
1503 self.assertEqual(bufio.truncate(), 2)
1504 self.assertEqual(bufio.write(b"BB"), 2) # the write buffer increases
1505 self.assertEqual(bufio.truncate(), 4)
1506
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001507 def test_misbehaved_io(self):
1508 BufferedReaderTest.test_misbehaved_io(self)
1509 BufferedWriterTest.test_misbehaved_io(self)
1510
Antoine Pitrou0d739d72010-09-05 23:01:12 +00001511 # You can't construct a BufferedRandom over a non-seekable stream.
1512 test_unseekable = None
1513
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001514class CBufferedRandomTest(BufferedRandomTest):
1515 tp = io.BufferedRandom
1516
1517 def test_constructor(self):
1518 BufferedRandomTest.test_constructor(self)
1519 # The allocation can succeed on 32-bit builds, e.g. with more
1520 # than 2GB RAM and a 64-bit kernel.
1521 if sys.maxsize > 0x7FFFFFFF:
1522 rawio = self.MockRawIO()
1523 bufio = self.tp(rawio)
1524 self.assertRaises((OverflowError, MemoryError, ValueError),
1525 bufio.__init__, rawio, sys.maxsize)
1526
1527 def test_garbage_collection(self):
1528 CBufferedReaderTest.test_garbage_collection(self)
1529 CBufferedWriterTest.test_garbage_collection(self)
1530
1531class PyBufferedRandomTest(BufferedRandomTest):
1532 tp = pyio.BufferedRandom
1533
1534
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001535# To fully exercise seek/tell, the StatefulIncrementalDecoder has these
1536# properties:
1537# - A single output character can correspond to many bytes of input.
1538# - The number of input bytes to complete the character can be
1539# undetermined until the last input byte is received.
1540# - The number of input bytes can vary depending on previous input.
1541# - A single input byte can correspond to many characters of output.
1542# - The number of output characters can be undetermined until the
1543# last input byte is received.
1544# - The number of output characters can vary depending on previous input.
1545
1546class StatefulIncrementalDecoder(codecs.IncrementalDecoder):
1547 """
1548 For testing seek/tell behavior with a stateful, buffering decoder.
1549
1550 Input is a sequence of words. Words may be fixed-length (length set
1551 by input) or variable-length (period-terminated). In variable-length
1552 mode, extra periods are ignored. Possible words are:
1553 - 'i' followed by a number sets the input length, I (maximum 99).
1554 When I is set to 0, words are space-terminated.
1555 - 'o' followed by a number sets the output length, O (maximum 99).
1556 - Any other word is converted into a word followed by a period on
1557 the output. The output word consists of the input word truncated
1558 or padded out with hyphens to make its length equal to O. If O
1559 is 0, the word is output verbatim without truncating or padding.
1560 I and O are initially set to 1. When I changes, any buffered input is
1561 re-scanned according to the new I. EOF also terminates the last word.
1562 """
1563
1564 def __init__(self, errors='strict'):
Christian Heimesab568872008-03-23 02:11:13 +00001565 codecs.IncrementalDecoder.__init__(self, errors)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001566 self.reset()
1567
1568 def __repr__(self):
1569 return '<SID %x>' % id(self)
1570
1571 def reset(self):
1572 self.i = 1
1573 self.o = 1
1574 self.buffer = bytearray()
1575
1576 def getstate(self):
1577 i, o = self.i ^ 1, self.o ^ 1 # so that flags = 0 after reset()
1578 return bytes(self.buffer), i*100 + o
1579
1580 def setstate(self, state):
1581 buffer, io = state
1582 self.buffer = bytearray(buffer)
1583 i, o = divmod(io, 100)
1584 self.i, self.o = i ^ 1, o ^ 1
1585
1586 def decode(self, input, final=False):
1587 output = ''
1588 for b in input:
1589 if self.i == 0: # variable-length, terminated with period
1590 if b == ord('.'):
1591 if self.buffer:
1592 output += self.process_word()
1593 else:
1594 self.buffer.append(b)
1595 else: # fixed-length, terminate after self.i bytes
1596 self.buffer.append(b)
1597 if len(self.buffer) == self.i:
1598 output += self.process_word()
1599 if final and self.buffer: # EOF terminates the last word
1600 output += self.process_word()
1601 return output
1602
1603 def process_word(self):
1604 output = ''
1605 if self.buffer[0] == ord('i'):
1606 self.i = min(99, int(self.buffer[1:] or 0)) # set input length
1607 elif self.buffer[0] == ord('o'):
1608 self.o = min(99, int(self.buffer[1:] or 0)) # set output length
1609 else:
1610 output = self.buffer.decode('ascii')
1611 if len(output) < self.o:
1612 output += '-'*self.o # pad out with hyphens
1613 if self.o:
1614 output = output[:self.o] # truncate to output length
1615 output += '.'
1616 self.buffer = bytearray()
1617 return output
1618
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001619 codecEnabled = False
1620
1621 @classmethod
1622 def lookupTestDecoder(cls, name):
1623 if cls.codecEnabled and name == 'test_decoder':
Antoine Pitrou180a3362008-12-14 16:36:46 +00001624 latin1 = codecs.lookup('latin-1')
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001625 return codecs.CodecInfo(
Antoine Pitrou180a3362008-12-14 16:36:46 +00001626 name='test_decoder', encode=latin1.encode, decode=None,
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001627 incrementalencoder=None,
1628 streamreader=None, streamwriter=None,
1629 incrementaldecoder=cls)
1630
1631# Register the previous decoder for testing.
1632# Disabled by default, tests will enable it.
1633codecs.register(StatefulIncrementalDecoder.lookupTestDecoder)
1634
1635
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001636class StatefulIncrementalDecoderTest(unittest.TestCase):
1637 """
1638 Make sure the StatefulIncrementalDecoder actually works.
1639 """
1640
1641 test_cases = [
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001642 # I=1, O=1 (fixed-length input == fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001643 (b'abcd', False, 'a.b.c.d.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001644 # I=0, O=0 (variable-length input, variable-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001645 (b'oiabcd', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001646 # I=0, O=0 (should ignore extra periods)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001647 (b'oi...abcd...', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001648 # I=0, O=6 (variable-length input, fixed-length output)
1649 (b'i.o6.x.xyz.toolongtofit.', False, 'x-----.xyz---.toolon.'),
1650 # I=2, O=6 (fixed-length input < fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001651 (b'i.i2.o6xyz', True, 'xy----.z-----.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001652 # I=6, O=3 (fixed-length input > fixed-length output)
1653 (b'i.o3.i6.abcdefghijklmnop', True, 'abc.ghi.mno.'),
1654 # I=0, then 3; O=29, then 15 (with longer output)
1655 (b'i.o29.a.b.cde.o15.abcdefghijabcdefghij.i3.a.b.c.d.ei00k.l.m', True,
1656 'a----------------------------.' +
1657 'b----------------------------.' +
1658 'cde--------------------------.' +
1659 'abcdefghijabcde.' +
1660 'a.b------------.' +
1661 '.c.------------.' +
1662 'd.e------------.' +
1663 'k--------------.' +
1664 'l--------------.' +
1665 'm--------------.')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001666 ]
1667
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001668 def test_decoder(self):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001669 # Try a few one-shot test cases.
1670 for input, eof, output in self.test_cases:
1671 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001672 self.assertEqual(d.decode(input, eof), output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001673
1674 # Also test an unfinished decode, followed by forcing EOF.
1675 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001676 self.assertEqual(d.decode(b'oiabcd'), '')
1677 self.assertEqual(d.decode(b'', 1), 'abcd.')
Guido van Rossum78892e42007-04-06 17:31:18 +00001678
1679class TextIOWrapperTest(unittest.TestCase):
Guido van Rossum9b76da62007-04-11 01:09:03 +00001680
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001681 def setUp(self):
1682 self.testdata = b"AAA\r\nBBB\rCCC\r\nDDD\nEEE\r\n"
1683 self.normalized = b"AAA\nBBB\nCCC\nDDD\nEEE\n".decode("ascii")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001684 support.unlink(support.TESTFN)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001685
Guido van Rossumd0712812007-04-11 16:32:43 +00001686 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001687 support.unlink(support.TESTFN)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001688
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001689 def test_constructor(self):
1690 r = self.BytesIO(b"\xc3\xa9\n\n")
1691 b = self.BufferedReader(r, 1000)
1692 t = self.TextIOWrapper(b)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001693 t.__init__(b, encoding="latin-1", newline="\r\n")
1694 self.assertEqual(t.encoding, "latin-1")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001695 self.assertEqual(t.line_buffering, False)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001696 t.__init__(b, encoding="utf-8", line_buffering=True)
1697 self.assertEqual(t.encoding, "utf-8")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001698 self.assertEqual(t.line_buffering, True)
1699 self.assertEqual("\xe9\n", t.readline())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001700 self.assertRaises(TypeError, t.__init__, b, newline=42)
1701 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
1702
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001703 def test_detach(self):
1704 r = self.BytesIO()
1705 b = self.BufferedWriter(r)
1706 t = self.TextIOWrapper(b)
1707 self.assertIs(t.detach(), b)
1708
1709 t = self.TextIOWrapper(b, encoding="ascii")
1710 t.write("howdy")
1711 self.assertFalse(r.getvalue())
1712 t.detach()
1713 self.assertEqual(r.getvalue(), b"howdy")
1714 self.assertRaises(ValueError, t.detach)
1715
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001716 def test_repr(self):
1717 raw = self.BytesIO("hello".encode("utf-8"))
1718 b = self.BufferedReader(raw)
1719 t = self.TextIOWrapper(b, encoding="utf-8")
Antoine Pitrou716c4442009-05-23 19:04:03 +00001720 modname = self.TextIOWrapper.__module__
1721 self.assertEqual(repr(t),
1722 "<%s.TextIOWrapper encoding='utf-8'>" % modname)
1723 raw.name = "dummy"
1724 self.assertEqual(repr(t),
1725 "<%s.TextIOWrapper name='dummy' encoding='utf-8'>" % modname)
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001726 t.mode = "r"
1727 self.assertEqual(repr(t),
1728 "<%s.TextIOWrapper name='dummy' mode='r' encoding='utf-8'>" % modname)
Antoine Pitrou716c4442009-05-23 19:04:03 +00001729 raw.name = b"dummy"
1730 self.assertEqual(repr(t),
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001731 "<%s.TextIOWrapper name=b'dummy' mode='r' encoding='utf-8'>" % modname)
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001732
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001733 def test_line_buffering(self):
1734 r = self.BytesIO()
1735 b = self.BufferedWriter(r, 1000)
1736 t = self.TextIOWrapper(b, newline="\n", line_buffering=True)
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001737 t.write("X")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001738 self.assertEqual(r.getvalue(), b"") # No flush happened
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001739 t.write("Y\nZ")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001740 self.assertEqual(r.getvalue(), b"XY\nZ") # All got flushed
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001741 t.write("A\rB")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001742 self.assertEqual(r.getvalue(), b"XY\nZA\rB")
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001743
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001744 def test_encoding(self):
1745 # Check the encoding attribute is always set, and valid
1746 b = self.BytesIO()
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001747 t = self.TextIOWrapper(b, encoding="utf-8")
1748 self.assertEqual(t.encoding, "utf-8")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001749 t = self.TextIOWrapper(b)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001750 self.assertTrue(t.encoding is not None)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001751 codecs.lookup(t.encoding)
1752
1753 def test_encoding_errors_reading(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001754 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001755 b = self.BytesIO(b"abc\n\xff\n")
1756 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001757 self.assertRaises(UnicodeError, t.read)
1758 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001759 b = self.BytesIO(b"abc\n\xff\n")
1760 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001761 self.assertRaises(UnicodeError, t.read)
1762 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001763 b = self.BytesIO(b"abc\n\xff\n")
1764 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001765 self.assertEqual(t.read(), "abc\n\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001766 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001767 b = self.BytesIO(b"abc\n\xff\n")
1768 t = self.TextIOWrapper(b, encoding="ascii", errors="replace")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001769 self.assertEqual(t.read(), "abc\n\ufffd\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001770
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001771 def test_encoding_errors_writing(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001772 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001773 b = self.BytesIO()
1774 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001775 self.assertRaises(UnicodeError, t.write, "\xff")
1776 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001777 b = self.BytesIO()
1778 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001779 self.assertRaises(UnicodeError, t.write, "\xff")
1780 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001781 b = self.BytesIO()
1782 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001783 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001784 t.write("abc\xffdef\n")
1785 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001786 self.assertEqual(b.getvalue(), b"abcdef\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001787 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001788 b = self.BytesIO()
1789 t = self.TextIOWrapper(b, encoding="ascii", errors="replace",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001790 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001791 t.write("abc\xffdef\n")
1792 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001793 self.assertEqual(b.getvalue(), b"abc?def\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001794
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001795 def test_newlines(self):
Guido van Rossum78892e42007-04-06 17:31:18 +00001796 input_lines = [ "unix\n", "windows\r\n", "os9\r", "last\n", "nonl" ]
1797
1798 tests = [
1799 [ None, [ 'unix\n', 'windows\n', 'os9\n', 'last\n', 'nonl' ] ],
Guido van Rossum8358db22007-08-18 21:39:55 +00001800 [ '', input_lines ],
1801 [ '\n', [ "unix\n", "windows\r\n", "os9\rlast\n", "nonl" ] ],
1802 [ '\r\n', [ "unix\nwindows\r\n", "os9\rlast\nnonl" ] ],
1803 [ '\r', [ "unix\nwindows\r", "\nos9\r", "last\nnonl" ] ],
Guido van Rossum78892e42007-04-06 17:31:18 +00001804 ]
Antoine Pitrou180a3362008-12-14 16:36:46 +00001805 encodings = (
1806 'utf-8', 'latin-1',
1807 'utf-16', 'utf-16-le', 'utf-16-be',
1808 'utf-32', 'utf-32-le', 'utf-32-be',
1809 )
Guido van Rossum78892e42007-04-06 17:31:18 +00001810
Guido van Rossum8358db22007-08-18 21:39:55 +00001811 # Try a range of buffer sizes to test the case where \r is the last
Guido van Rossum78892e42007-04-06 17:31:18 +00001812 # character in TextIOWrapper._pending_line.
1813 for encoding in encodings:
Guido van Rossum8358db22007-08-18 21:39:55 +00001814 # XXX: str.encode() should return bytes
1815 data = bytes(''.join(input_lines).encode(encoding))
Guido van Rossum78892e42007-04-06 17:31:18 +00001816 for do_reads in (False, True):
Guido van Rossum8358db22007-08-18 21:39:55 +00001817 for bufsize in range(1, 10):
1818 for newline, exp_lines in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001819 bufio = self.BufferedReader(self.BytesIO(data), bufsize)
1820 textio = self.TextIOWrapper(bufio, newline=newline,
Guido van Rossum78892e42007-04-06 17:31:18 +00001821 encoding=encoding)
1822 if do_reads:
1823 got_lines = []
1824 while True:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001825 c2 = textio.read(2)
Guido van Rossum78892e42007-04-06 17:31:18 +00001826 if c2 == '':
1827 break
Ezio Melottib3aedd42010-11-20 19:04:17 +00001828 self.assertEqual(len(c2), 2)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001829 got_lines.append(c2 + textio.readline())
Guido van Rossum78892e42007-04-06 17:31:18 +00001830 else:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001831 got_lines = list(textio)
Guido van Rossum78892e42007-04-06 17:31:18 +00001832
1833 for got_line, exp_line in zip(got_lines, exp_lines):
Ezio Melottib3aedd42010-11-20 19:04:17 +00001834 self.assertEqual(got_line, exp_line)
1835 self.assertEqual(len(got_lines), len(exp_lines))
Guido van Rossum78892e42007-04-06 17:31:18 +00001836
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001837 def test_newlines_input(self):
1838 testdata = b"AAA\nBB\x00B\nCCC\rDDD\rEEE\r\nFFF\r\nGGG"
Guido van Rossum8358db22007-08-18 21:39:55 +00001839 normalized = testdata.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
1840 for newline, expected in [
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001841 (None, normalized.decode("ascii").splitlines(True)),
1842 ("", testdata.decode("ascii").splitlines(True)),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001843 ("\n", ["AAA\n", "BB\x00B\n", "CCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
1844 ("\r\n", ["AAA\nBB\x00B\nCCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
1845 ("\r", ["AAA\nBB\x00B\nCCC\r", "DDD\r", "EEE\r", "\nFFF\r", "\nGGG"]),
Guido van Rossum8358db22007-08-18 21:39:55 +00001846 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001847 buf = self.BytesIO(testdata)
1848 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001849 self.assertEqual(txt.readlines(), expected)
Guido van Rossum8358db22007-08-18 21:39:55 +00001850 txt.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001851 self.assertEqual(txt.read(), "".join(expected))
Guido van Rossum8358db22007-08-18 21:39:55 +00001852
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001853 def test_newlines_output(self):
1854 testdict = {
1855 "": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
1856 "\n": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
1857 "\r": b"AAA\rBBB\rCCC\rX\rY\r\rZ",
1858 "\r\n": b"AAA\r\nBBB\r\nCCC\r\nX\rY\r\r\nZ",
1859 }
1860 tests = [(None, testdict[os.linesep])] + sorted(testdict.items())
1861 for newline, expected in tests:
1862 buf = self.BytesIO()
1863 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
1864 txt.write("AAA\nB")
1865 txt.write("BB\nCCC\n")
1866 txt.write("X\rY\r\nZ")
1867 txt.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001868 self.assertEqual(buf.closed, False)
1869 self.assertEqual(buf.getvalue(), expected)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001870
1871 def test_destructor(self):
1872 l = []
1873 base = self.BytesIO
1874 class MyBytesIO(base):
1875 def close(self):
1876 l.append(self.getvalue())
1877 base.close(self)
1878 b = MyBytesIO()
1879 t = self.TextIOWrapper(b, encoding="ascii")
1880 t.write("abc")
1881 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001882 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001883 self.assertEqual([b"abc"], l)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001884
1885 def test_override_destructor(self):
1886 record = []
1887 class MyTextIO(self.TextIOWrapper):
1888 def __del__(self):
1889 record.append(1)
1890 try:
1891 f = super().__del__
1892 except AttributeError:
1893 pass
1894 else:
1895 f()
1896 def close(self):
1897 record.append(2)
1898 super().close()
1899 def flush(self):
1900 record.append(3)
1901 super().flush()
1902 b = self.BytesIO()
1903 t = MyTextIO(b, encoding="ascii")
1904 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001905 support.gc_collect()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001906 self.assertEqual(record, [1, 2, 3])
1907
1908 def test_error_through_destructor(self):
1909 # Test that the exception state is not modified by a destructor,
1910 # even if close() fails.
1911 rawio = self.CloseFailureIO()
1912 def f():
1913 self.TextIOWrapper(rawio).xyzzy
1914 with support.captured_output("stderr") as s:
1915 self.assertRaises(AttributeError, f)
1916 s = s.getvalue().strip()
1917 if s:
1918 # The destructor *may* have printed an unraisable error, check it
1919 self.assertEqual(len(s.splitlines()), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001920 self.assertTrue(s.startswith("Exception IOError: "), s)
1921 self.assertTrue(s.endswith(" ignored"), s)
Guido van Rossum8358db22007-08-18 21:39:55 +00001922
Guido van Rossum9b76da62007-04-11 01:09:03 +00001923 # Systematic tests of the text I/O API
1924
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001925 def test_basic_io(self):
Guido van Rossum9b76da62007-04-11 01:09:03 +00001926 for chunksize in (1, 2, 3, 4, 5, 15, 16, 17, 31, 32, 33, 63, 64, 65):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001927 for enc in "ascii", "latin-1", "utf-8" :# , "utf-16-be", "utf-16-le":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001928 f = self.open(support.TESTFN, "w+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001929 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00001930 self.assertEqual(f.write("abc"), 3)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001931 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001932 f = self.open(support.TESTFN, "r+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001933 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00001934 self.assertEqual(f.tell(), 0)
1935 self.assertEqual(f.read(), "abc")
Guido van Rossum9b76da62007-04-11 01:09:03 +00001936 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001937 self.assertEqual(f.seek(0), 0)
1938 self.assertEqual(f.read(None), "abc")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00001939 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001940 self.assertEqual(f.read(2), "ab")
1941 self.assertEqual(f.read(1), "c")
1942 self.assertEqual(f.read(1), "")
1943 self.assertEqual(f.read(), "")
1944 self.assertEqual(f.tell(), cookie)
1945 self.assertEqual(f.seek(0), 0)
1946 self.assertEqual(f.seek(0, 2), cookie)
1947 self.assertEqual(f.write("def"), 3)
1948 self.assertEqual(f.seek(cookie), cookie)
1949 self.assertEqual(f.read(), "def")
Guido van Rossum9b76da62007-04-11 01:09:03 +00001950 if enc.startswith("utf"):
1951 self.multi_line_test(f, enc)
1952 f.close()
1953
1954 def multi_line_test(self, f, enc):
1955 f.seek(0)
1956 f.truncate()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00001957 sample = "s\xff\u0fff\uffff"
Guido van Rossum9b76da62007-04-11 01:09:03 +00001958 wlines = []
Guido van Rossumcba608c2007-04-11 14:19:59 +00001959 for size in (0, 1, 2, 3, 4, 5, 30, 31, 32, 33, 62, 63, 64, 65, 1000):
Guido van Rossum9b76da62007-04-11 01:09:03 +00001960 chars = []
Guido van Rossum805365e2007-05-07 22:24:25 +00001961 for i in range(size):
Guido van Rossum9b76da62007-04-11 01:09:03 +00001962 chars.append(sample[i % len(sample)])
Guido van Rossumef87d6e2007-05-02 19:09:54 +00001963 line = "".join(chars) + "\n"
Guido van Rossum9b76da62007-04-11 01:09:03 +00001964 wlines.append((f.tell(), line))
1965 f.write(line)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001966 f.seek(0)
1967 rlines = []
1968 while True:
1969 pos = f.tell()
1970 line = f.readline()
1971 if not line:
Guido van Rossum9b76da62007-04-11 01:09:03 +00001972 break
1973 rlines.append((pos, line))
Ezio Melottib3aedd42010-11-20 19:04:17 +00001974 self.assertEqual(rlines, wlines)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001975
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001976 def test_telling(self):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001977 f = self.open(support.TESTFN, "w+", encoding="utf-8")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00001978 p0 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00001979 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00001980 p1 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00001981 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00001982 p2 = f.tell()
1983 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001984 self.assertEqual(f.tell(), p0)
1985 self.assertEqual(f.readline(), "\xff\n")
1986 self.assertEqual(f.tell(), p1)
1987 self.assertEqual(f.readline(), "\xff\n")
1988 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00001989 f.seek(0)
1990 for line in f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00001991 self.assertEqual(line, "\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00001992 self.assertRaises(IOError, f.tell)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001993 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00001994 f.close()
1995
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001996 def test_seeking(self):
1997 chunk_size = _default_chunk_size()
Guido van Rossumd76e7792007-04-17 02:38:04 +00001998 prefix_size = chunk_size - 2
Guido van Rossumef87d6e2007-05-02 19:09:54 +00001999 u_prefix = "a" * prefix_size
Guido van Rossumd76e7792007-04-17 02:38:04 +00002000 prefix = bytes(u_prefix.encode("utf-8"))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002001 self.assertEqual(len(u_prefix), len(prefix))
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002002 u_suffix = "\u8888\n"
Guido van Rossumd76e7792007-04-17 02:38:04 +00002003 suffix = bytes(u_suffix.encode("utf-8"))
2004 line = prefix + suffix
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002005 with self.open(support.TESTFN, "wb") as f:
2006 f.write(line*2)
2007 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2008 s = f.read(prefix_size)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002009 self.assertEqual(s, str(prefix, "ascii"))
2010 self.assertEqual(f.tell(), prefix_size)
2011 self.assertEqual(f.readline(), u_suffix)
Guido van Rossumd76e7792007-04-17 02:38:04 +00002012
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002013 def test_seeking_too(self):
Guido van Rossumd76e7792007-04-17 02:38:04 +00002014 # Regression test for a specific bug
2015 data = b'\xe0\xbf\xbf\n'
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002016 with self.open(support.TESTFN, "wb") as f:
2017 f.write(data)
2018 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2019 f._CHUNK_SIZE # Just test that it exists
2020 f._CHUNK_SIZE = 2
2021 f.readline()
2022 f.tell()
Guido van Rossumd76e7792007-04-17 02:38:04 +00002023
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002024 def test_seek_and_tell(self):
2025 #Test seek/tell using the StatefulIncrementalDecoder.
2026 # Make test faster by doing smaller seeks
2027 CHUNK_SIZE = 128
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002028
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002029 def test_seek_and_tell_with_data(data, min_pos=0):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002030 """Tell/seek to various points within a data stream and ensure
2031 that the decoded data returned by read() is consistent."""
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002032 f = self.open(support.TESTFN, 'wb')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002033 f.write(data)
2034 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002035 f = self.open(support.TESTFN, encoding='test_decoder')
2036 f._CHUNK_SIZE = CHUNK_SIZE
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002037 decoded = f.read()
2038 f.close()
2039
Neal Norwitze2b07052008-03-18 19:52:05 +00002040 for i in range(min_pos, len(decoded) + 1): # seek positions
2041 for j in [1, 5, len(decoded) - i]: # read lengths
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002042 f = self.open(support.TESTFN, encoding='test_decoder')
Ezio Melottib3aedd42010-11-20 19:04:17 +00002043 self.assertEqual(f.read(i), decoded[:i])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002044 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002045 self.assertEqual(f.read(j), decoded[i:i + j])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002046 f.seek(cookie)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002047 self.assertEqual(f.read(), decoded[i:])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002048 f.close()
2049
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002050 # Enable the test decoder.
2051 StatefulIncrementalDecoder.codecEnabled = 1
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002052
2053 # Run the tests.
2054 try:
2055 # Try each test case.
2056 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002057 test_seek_and_tell_with_data(input)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002058
2059 # Position each test case so that it crosses a chunk boundary.
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002060 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
2061 offset = CHUNK_SIZE - len(input)//2
2062 prefix = b'.'*offset
2063 # Don't bother seeking into the prefix (takes too long).
2064 min_pos = offset*2
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002065 test_seek_and_tell_with_data(prefix + input, min_pos)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002066
2067 # Ensure our test decoder won't interfere with subsequent tests.
2068 finally:
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002069 StatefulIncrementalDecoder.codecEnabled = 0
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002070
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002071 def test_encoded_writes(self):
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002072 data = "1234567890"
2073 tests = ("utf-16",
2074 "utf-16-le",
2075 "utf-16-be",
2076 "utf-32",
2077 "utf-32-le",
2078 "utf-32-be")
2079 for encoding in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002080 buf = self.BytesIO()
2081 f = self.TextIOWrapper(buf, encoding=encoding)
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002082 # Check if the BOM is written only once (see issue1753).
2083 f.write(data)
2084 f.write(data)
2085 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002086 self.assertEqual(f.read(), data * 2)
Benjamin Peterson9363a652009-03-05 00:42:09 +00002087 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002088 self.assertEqual(f.read(), data * 2)
2089 self.assertEqual(buf.getvalue(), (data * 2).encode(encoding))
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002090
Benjamin Petersona1b49012009-03-31 23:11:32 +00002091 def test_unreadable(self):
2092 class UnReadable(self.BytesIO):
2093 def readable(self):
2094 return False
2095 txt = self.TextIOWrapper(UnReadable())
2096 self.assertRaises(IOError, txt.read)
2097
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002098 def test_read_one_by_one(self):
2099 txt = self.TextIOWrapper(self.BytesIO(b"AA\r\nBB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002100 reads = ""
2101 while True:
2102 c = txt.read(1)
2103 if not c:
2104 break
2105 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002106 self.assertEqual(reads, "AA\nBB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002107
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00002108 def test_readlines(self):
2109 txt = self.TextIOWrapper(self.BytesIO(b"AA\nBB\nCC"))
2110 self.assertEqual(txt.readlines(), ["AA\n", "BB\n", "CC"])
2111 txt.seek(0)
2112 self.assertEqual(txt.readlines(None), ["AA\n", "BB\n", "CC"])
2113 txt.seek(0)
2114 self.assertEqual(txt.readlines(5), ["AA\n", "BB\n"])
2115
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002116 # read in amounts equal to TextIOWrapper._CHUNK_SIZE which is 128.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002117 def test_read_by_chunk(self):
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002118 # make sure "\r\n" straddles 128 char boundary.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002119 txt = self.TextIOWrapper(self.BytesIO(b"A" * 127 + b"\r\nB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002120 reads = ""
2121 while True:
2122 c = txt.read(128)
2123 if not c:
2124 break
2125 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002126 self.assertEqual(reads, "A"*127+"\nB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002127
2128 def test_issue1395_1(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002129 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002130
2131 # read one char at a time
2132 reads = ""
2133 while True:
2134 c = txt.read(1)
2135 if not c:
2136 break
2137 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002138 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002139
2140 def test_issue1395_2(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002141 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002142 txt._CHUNK_SIZE = 4
2143
2144 reads = ""
2145 while True:
2146 c = txt.read(4)
2147 if not c:
2148 break
2149 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002150 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002151
2152 def test_issue1395_3(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002153 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002154 txt._CHUNK_SIZE = 4
2155
2156 reads = txt.read(4)
2157 reads += txt.read(4)
2158 reads += txt.readline()
2159 reads += txt.readline()
2160 reads += txt.readline()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002161 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002162
2163 def test_issue1395_4(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002164 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002165 txt._CHUNK_SIZE = 4
2166
2167 reads = txt.read(4)
2168 reads += txt.read()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002169 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002170
2171 def test_issue1395_5(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002172 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002173 txt._CHUNK_SIZE = 4
2174
2175 reads = txt.read(4)
2176 pos = txt.tell()
2177 txt.seek(0)
2178 txt.seek(pos)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002179 self.assertEqual(txt.read(4), "BBB\n")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002180
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002181 def test_issue2282(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002182 buffer = self.BytesIO(self.testdata)
2183 txt = self.TextIOWrapper(buffer, encoding="ascii")
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002184
2185 self.assertEqual(buffer.seekable(), txt.seekable())
2186
Antoine Pitroue4501852009-05-14 18:55:55 +00002187 def test_append_bom(self):
2188 # The BOM is not written again when appending to a non-empty file
2189 filename = support.TESTFN
2190 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2191 with self.open(filename, 'w', encoding=charset) as f:
2192 f.write('aaa')
2193 pos = f.tell()
2194 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002195 self.assertEqual(f.read(), 'aaa'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002196
2197 with self.open(filename, 'a', encoding=charset) as f:
2198 f.write('xxx')
2199 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002200 self.assertEqual(f.read(), 'aaaxxx'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002201
2202 def test_seek_bom(self):
2203 # Same test, but when seeking manually
2204 filename = support.TESTFN
2205 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2206 with self.open(filename, 'w', encoding=charset) as f:
2207 f.write('aaa')
2208 pos = f.tell()
2209 with self.open(filename, 'r+', encoding=charset) as f:
2210 f.seek(pos)
2211 f.write('zzz')
2212 f.seek(0)
2213 f.write('bbb')
2214 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002215 self.assertEqual(f.read(), 'bbbzzz'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002216
Benjamin Peterson0926ad12009-06-06 18:02:12 +00002217 def test_errors_property(self):
2218 with self.open(support.TESTFN, "w") as f:
2219 self.assertEqual(f.errors, "strict")
2220 with self.open(support.TESTFN, "w", errors="replace") as f:
2221 self.assertEqual(f.errors, "replace")
2222
Brett Cannon31f59292011-02-21 19:29:56 +00002223 @support.no_tracing
Victor Stinner45df8202010-04-28 22:31:17 +00002224 @unittest.skipUnless(threading, 'Threading required for this test.')
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002225 def test_threads_write(self):
2226 # Issue6750: concurrent writes could duplicate data
2227 event = threading.Event()
2228 with self.open(support.TESTFN, "w", buffering=1) as f:
2229 def run(n):
2230 text = "Thread%03d\n" % n
2231 event.wait()
2232 f.write(text)
2233 threads = [threading.Thread(target=lambda n=x: run(n))
2234 for x in range(20)]
2235 for t in threads:
2236 t.start()
2237 time.sleep(0.02)
2238 event.set()
2239 for t in threads:
2240 t.join()
2241 with self.open(support.TESTFN) as f:
2242 content = f.read()
2243 for n in range(20):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002244 self.assertEqual(content.count("Thread%03d\n" % n), 1)
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002245
Antoine Pitrou6be88762010-05-03 16:48:20 +00002246 def test_flush_error_on_close(self):
2247 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2248 def bad_flush():
2249 raise IOError()
2250 txt.flush = bad_flush
2251 self.assertRaises(IOError, txt.close) # exception not swallowed
2252
2253 def test_multi_close(self):
2254 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2255 txt.close()
2256 txt.close()
2257 txt.close()
2258 self.assertRaises(ValueError, txt.flush)
2259
Antoine Pitrou0d739d72010-09-05 23:01:12 +00002260 def test_unseekable(self):
2261 txt = self.TextIOWrapper(self.MockUnseekableIO(self.testdata))
2262 self.assertRaises(self.UnsupportedOperation, txt.tell)
2263 self.assertRaises(self.UnsupportedOperation, txt.seek, 0)
2264
Antoine Pitrou7f8f4182010-12-21 21:20:59 +00002265 def test_readonly_attributes(self):
2266 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2267 buf = self.BytesIO(self.testdata)
2268 with self.assertRaises(AttributeError):
2269 txt.buffer = buf
2270
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002271class CTextIOWrapperTest(TextIOWrapperTest):
2272
2273 def test_initialization(self):
2274 r = self.BytesIO(b"\xc3\xa9\n\n")
2275 b = self.BufferedReader(r, 1000)
2276 t = self.TextIOWrapper(b)
2277 self.assertRaises(TypeError, t.__init__, b, newline=42)
2278 self.assertRaises(ValueError, t.read)
2279 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
2280 self.assertRaises(ValueError, t.read)
2281
2282 def test_garbage_collection(self):
2283 # C TextIOWrapper objects are collected, and collecting them flushes
2284 # all data to disk.
2285 # The Python version has __del__, so it ends in gc.garbage instead.
2286 rawio = io.FileIO(support.TESTFN, "wb")
2287 b = self.BufferedWriter(rawio)
2288 t = self.TextIOWrapper(b, encoding="ascii")
2289 t.write("456def")
2290 t.x = t
2291 wr = weakref.ref(t)
2292 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002293 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002294 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00002295 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002296 self.assertEqual(f.read(), b"456def")
2297
2298class PyTextIOWrapperTest(TextIOWrapperTest):
2299 pass
2300
2301
2302class IncrementalNewlineDecoderTest(unittest.TestCase):
2303
2304 def check_newline_decoding_utf8(self, decoder):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002305 # UTF-8 specific tests for a newline decoder
2306 def _check_decode(b, s, **kwargs):
2307 # We exercise getstate() / setstate() as well as decode()
2308 state = decoder.getstate()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002309 self.assertEqual(decoder.decode(b, **kwargs), s)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002310 decoder.setstate(state)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002311 self.assertEqual(decoder.decode(b, **kwargs), s)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002312
Antoine Pitrou180a3362008-12-14 16:36:46 +00002313 _check_decode(b'\xe8\xa2\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002314
Antoine Pitrou180a3362008-12-14 16:36:46 +00002315 _check_decode(b'\xe8', "")
2316 _check_decode(b'\xa2', "")
2317 _check_decode(b'\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002318
Antoine Pitrou180a3362008-12-14 16:36:46 +00002319 _check_decode(b'\xe8', "")
2320 _check_decode(b'\xa2', "")
2321 _check_decode(b'\x88', "\u8888")
2322
2323 _check_decode(b'\xe8', "")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002324 self.assertRaises(UnicodeDecodeError, decoder.decode, b'', final=True)
2325
Antoine Pitrou180a3362008-12-14 16:36:46 +00002326 decoder.reset()
2327 _check_decode(b'\n', "\n")
2328 _check_decode(b'\r', "")
2329 _check_decode(b'', "\n", final=True)
2330 _check_decode(b'\r', "\n", final=True)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002331
Antoine Pitrou180a3362008-12-14 16:36:46 +00002332 _check_decode(b'\r', "")
2333 _check_decode(b'a', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002334
Antoine Pitrou180a3362008-12-14 16:36:46 +00002335 _check_decode(b'\r\r\n', "\n\n")
2336 _check_decode(b'\r', "")
2337 _check_decode(b'\r', "\n")
2338 _check_decode(b'\na', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002339
Antoine Pitrou180a3362008-12-14 16:36:46 +00002340 _check_decode(b'\xe8\xa2\x88\r\n', "\u8888\n")
2341 _check_decode(b'\xe8\xa2\x88', "\u8888")
2342 _check_decode(b'\n', "\n")
2343 _check_decode(b'\xe8\xa2\x88\r', "\u8888")
2344 _check_decode(b'\n', "\n")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002345
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002346 def check_newline_decoding(self, decoder, encoding):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002347 result = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002348 if encoding is not None:
2349 encoder = codecs.getincrementalencoder(encoding)()
2350 def _decode_bytewise(s):
2351 # Decode one byte at a time
2352 for b in encoder.encode(s):
2353 result.append(decoder.decode(bytes([b])))
2354 else:
2355 encoder = None
2356 def _decode_bytewise(s):
2357 # Decode one char at a time
2358 for c in s:
2359 result.append(decoder.decode(c))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002360 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002361 _decode_bytewise("abc\n\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002362 self.assertEqual(decoder.newlines, '\n')
Antoine Pitrou180a3362008-12-14 16:36:46 +00002363 _decode_bytewise("\nabc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002364 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002365 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002366 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002367 _decode_bytewise("abc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002368 self.assertEqual(decoder.newlines, ('\r', '\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002369 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002370 self.assertEqual("".join(result), "abc\n\nabcabc\nabcabc")
Antoine Pitrou180a3362008-12-14 16:36:46 +00002371 decoder.reset()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002372 input = "abc"
2373 if encoder is not None:
2374 encoder.reset()
2375 input = encoder.encode(input)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002376 self.assertEqual(decoder.decode(input), "abc")
2377 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002378
2379 def test_newline_decoder(self):
2380 encodings = (
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002381 # None meaning the IncrementalNewlineDecoder takes unicode input
2382 # rather than bytes input
2383 None, 'utf-8', 'latin-1',
Antoine Pitrou180a3362008-12-14 16:36:46 +00002384 'utf-16', 'utf-16-le', 'utf-16-be',
2385 'utf-32', 'utf-32-le', 'utf-32-be',
2386 )
2387 for enc in encodings:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002388 decoder = enc and codecs.getincrementaldecoder(enc)()
2389 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2390 self.check_newline_decoding(decoder, enc)
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002391 decoder = codecs.getincrementaldecoder("utf-8")()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002392 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2393 self.check_newline_decoding_utf8(decoder)
2394
Antoine Pitrou66913e22009-03-06 23:40:56 +00002395 def test_newline_bytes(self):
2396 # Issue 5433: Excessive optimization in IncrementalNewlineDecoder
2397 def _check(dec):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002398 self.assertEqual(dec.newlines, None)
2399 self.assertEqual(dec.decode("\u0D00"), "\u0D00")
2400 self.assertEqual(dec.newlines, None)
2401 self.assertEqual(dec.decode("\u0A00"), "\u0A00")
2402 self.assertEqual(dec.newlines, None)
Antoine Pitrou66913e22009-03-06 23:40:56 +00002403 dec = self.IncrementalNewlineDecoder(None, translate=False)
2404 _check(dec)
2405 dec = self.IncrementalNewlineDecoder(None, translate=True)
2406 _check(dec)
2407
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002408class CIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2409 pass
2410
2411class PyIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2412 pass
Antoine Pitrou180a3362008-12-14 16:36:46 +00002413
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002414
Guido van Rossum01a27522007-03-07 01:00:12 +00002415# XXX Tests for open()
Guido van Rossum68bbcd22007-02-27 17:19:33 +00002416
Guido van Rossum5abbf752007-08-27 17:39:33 +00002417class MiscIOTest(unittest.TestCase):
2418
Barry Warsaw40e82462008-11-20 20:14:50 +00002419 def tearDown(self):
2420 support.unlink(support.TESTFN)
2421
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002422 def test___all__(self):
2423 for name in self.io.__all__:
2424 obj = getattr(self.io, name, None)
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002425 self.assertTrue(obj is not None, name)
Guido van Rossum5abbf752007-08-27 17:39:33 +00002426 if name == "open":
2427 continue
Benjamin Peterson6a52a9c2009-04-29 22:00:44 +00002428 elif "error" in name.lower() or name == "UnsupportedOperation":
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002429 self.assertTrue(issubclass(obj, Exception), name)
2430 elif not name.startswith("SEEK_"):
2431 self.assertTrue(issubclass(obj, self.IOBase))
Benjamin Peterson65676e42008-11-05 21:42:45 +00002432
Barry Warsaw40e82462008-11-20 20:14:50 +00002433 def test_attributes(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002434 f = self.open(support.TESTFN, "wb", buffering=0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002435 self.assertEqual(f.mode, "wb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002436 f.close()
2437
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002438 f = self.open(support.TESTFN, "U")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002439 self.assertEqual(f.name, support.TESTFN)
2440 self.assertEqual(f.buffer.name, support.TESTFN)
2441 self.assertEqual(f.buffer.raw.name, support.TESTFN)
2442 self.assertEqual(f.mode, "U")
2443 self.assertEqual(f.buffer.mode, "rb")
2444 self.assertEqual(f.buffer.raw.mode, "rb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002445 f.close()
2446
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002447 f = self.open(support.TESTFN, "w+")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002448 self.assertEqual(f.mode, "w+")
2449 self.assertEqual(f.buffer.mode, "rb+") # Does it really matter?
2450 self.assertEqual(f.buffer.raw.mode, "rb+")
Barry Warsaw40e82462008-11-20 20:14:50 +00002451
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002452 g = self.open(f.fileno(), "wb", closefd=False)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002453 self.assertEqual(g.mode, "wb")
2454 self.assertEqual(g.raw.mode, "wb")
2455 self.assertEqual(g.name, f.fileno())
2456 self.assertEqual(g.raw.name, f.fileno())
Barry Warsaw40e82462008-11-20 20:14:50 +00002457 f.close()
2458 g.close()
2459
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002460 def test_io_after_close(self):
2461 for kwargs in [
2462 {"mode": "w"},
2463 {"mode": "wb"},
2464 {"mode": "w", "buffering": 1},
2465 {"mode": "w", "buffering": 2},
2466 {"mode": "wb", "buffering": 0},
2467 {"mode": "r"},
2468 {"mode": "rb"},
2469 {"mode": "r", "buffering": 1},
2470 {"mode": "r", "buffering": 2},
2471 {"mode": "rb", "buffering": 0},
2472 {"mode": "w+"},
2473 {"mode": "w+b"},
2474 {"mode": "w+", "buffering": 1},
2475 {"mode": "w+", "buffering": 2},
2476 {"mode": "w+b", "buffering": 0},
2477 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002478 f = self.open(support.TESTFN, **kwargs)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002479 f.close()
2480 self.assertRaises(ValueError, f.flush)
2481 self.assertRaises(ValueError, f.fileno)
2482 self.assertRaises(ValueError, f.isatty)
2483 self.assertRaises(ValueError, f.__iter__)
2484 if hasattr(f, "peek"):
2485 self.assertRaises(ValueError, f.peek, 1)
2486 self.assertRaises(ValueError, f.read)
2487 if hasattr(f, "read1"):
2488 self.assertRaises(ValueError, f.read1, 1024)
2489 if hasattr(f, "readinto"):
2490 self.assertRaises(ValueError, f.readinto, bytearray(1024))
2491 self.assertRaises(ValueError, f.readline)
2492 self.assertRaises(ValueError, f.readlines)
2493 self.assertRaises(ValueError, f.seek, 0)
2494 self.assertRaises(ValueError, f.tell)
2495 self.assertRaises(ValueError, f.truncate)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002496 self.assertRaises(ValueError, f.write,
2497 b"" if "b" in kwargs['mode'] else "")
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002498 self.assertRaises(ValueError, f.writelines, [])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002499 self.assertRaises(ValueError, next, f)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002500
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002501 def test_blockingioerror(self):
2502 # Various BlockingIOError issues
2503 self.assertRaises(TypeError, self.BlockingIOError)
2504 self.assertRaises(TypeError, self.BlockingIOError, 1)
2505 self.assertRaises(TypeError, self.BlockingIOError, 1, 2, 3, 4)
2506 self.assertRaises(TypeError, self.BlockingIOError, 1, "", None)
2507 b = self.BlockingIOError(1, "")
2508 self.assertEqual(b.characters_written, 0)
2509 class C(str):
2510 pass
2511 c = C("")
2512 b = self.BlockingIOError(1, c)
2513 c.b = b
2514 b.c = c
2515 wr = weakref.ref(c)
2516 del c, b
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002517 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002518 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002519
2520 def test_abcs(self):
2521 # Test the visible base classes are ABCs.
Ezio Melottie9615932010-01-24 19:26:24 +00002522 self.assertIsInstance(self.IOBase, abc.ABCMeta)
2523 self.assertIsInstance(self.RawIOBase, abc.ABCMeta)
2524 self.assertIsInstance(self.BufferedIOBase, abc.ABCMeta)
2525 self.assertIsInstance(self.TextIOBase, abc.ABCMeta)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002526
2527 def _check_abc_inheritance(self, abcmodule):
2528 with self.open(support.TESTFN, "wb", buffering=0) as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002529 self.assertIsInstance(f, abcmodule.IOBase)
2530 self.assertIsInstance(f, abcmodule.RawIOBase)
2531 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2532 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002533 with self.open(support.TESTFN, "wb") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002534 self.assertIsInstance(f, abcmodule.IOBase)
2535 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2536 self.assertIsInstance(f, abcmodule.BufferedIOBase)
2537 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002538 with self.open(support.TESTFN, "w") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002539 self.assertIsInstance(f, abcmodule.IOBase)
2540 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2541 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2542 self.assertIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002543
2544 def test_abc_inheritance(self):
2545 # Test implementations inherit from their respective ABCs
2546 self._check_abc_inheritance(self)
2547
2548 def test_abc_inheritance_official(self):
2549 # Test implementations inherit from the official ABCs of the
2550 # baseline "io" module.
2551 self._check_abc_inheritance(io)
2552
Antoine Pitroue033e062010-10-29 10:38:18 +00002553 def _check_warn_on_dealloc(self, *args, **kwargs):
2554 f = open(*args, **kwargs)
2555 r = repr(f)
2556 with self.assertWarns(ResourceWarning) as cm:
2557 f = None
2558 support.gc_collect()
2559 self.assertIn(r, str(cm.warning.args[0]))
2560
2561 def test_warn_on_dealloc(self):
2562 self._check_warn_on_dealloc(support.TESTFN, "wb", buffering=0)
2563 self._check_warn_on_dealloc(support.TESTFN, "wb")
2564 self._check_warn_on_dealloc(support.TESTFN, "w")
2565
2566 def _check_warn_on_dealloc_fd(self, *args, **kwargs):
2567 fds = []
Benjamin Peterson556c7352010-10-31 01:35:43 +00002568 def cleanup_fds():
Antoine Pitroue033e062010-10-29 10:38:18 +00002569 for fd in fds:
2570 try:
2571 os.close(fd)
2572 except EnvironmentError as e:
2573 if e.errno != errno.EBADF:
2574 raise
Benjamin Peterson556c7352010-10-31 01:35:43 +00002575 self.addCleanup(cleanup_fds)
2576 r, w = os.pipe()
2577 fds += r, w
2578 self._check_warn_on_dealloc(r, *args, **kwargs)
2579 # When using closefd=False, there's no warning
2580 r, w = os.pipe()
2581 fds += r, w
2582 with warnings.catch_warnings(record=True) as recorded:
2583 open(r, *args, closefd=False, **kwargs)
2584 support.gc_collect()
2585 self.assertEqual(recorded, [])
Antoine Pitroue033e062010-10-29 10:38:18 +00002586
2587 def test_warn_on_dealloc_fd(self):
2588 self._check_warn_on_dealloc_fd("rb", buffering=0)
2589 self._check_warn_on_dealloc_fd("rb")
2590 self._check_warn_on_dealloc_fd("r")
2591
2592
Antoine Pitrou243757e2010-11-05 21:15:39 +00002593 def test_pickling(self):
2594 # Pickling file objects is forbidden
2595 for kwargs in [
2596 {"mode": "w"},
2597 {"mode": "wb"},
2598 {"mode": "wb", "buffering": 0},
2599 {"mode": "r"},
2600 {"mode": "rb"},
2601 {"mode": "rb", "buffering": 0},
2602 {"mode": "w+"},
2603 {"mode": "w+b"},
2604 {"mode": "w+b", "buffering": 0},
2605 ]:
2606 for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
2607 with self.open(support.TESTFN, **kwargs) as f:
2608 self.assertRaises(TypeError, pickle.dumps, f, protocol)
2609
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002610class CMiscIOTest(MiscIOTest):
2611 io = io
2612
2613class PyMiscIOTest(MiscIOTest):
2614 io = pyio
Barry Warsaw40e82462008-11-20 20:14:50 +00002615
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002616
2617@unittest.skipIf(os.name == 'nt', 'POSIX signals required for this test.')
2618class SignalsTest(unittest.TestCase):
2619
2620 def setUp(self):
2621 self.oldalrm = signal.signal(signal.SIGALRM, self.alarm_interrupt)
2622
2623 def tearDown(self):
2624 signal.signal(signal.SIGALRM, self.oldalrm)
2625
2626 def alarm_interrupt(self, sig, frame):
2627 1/0
2628
2629 @unittest.skipUnless(threading, 'Threading required for this test.')
2630 def check_interrupted_write(self, item, bytes, **fdopen_kwargs):
2631 """Check that a partial write, when it gets interrupted, properly
Antoine Pitrou707ce822011-02-25 21:24:11 +00002632 invokes the signal handler, and bubbles up the exception raised
2633 in the latter."""
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002634 read_results = []
2635 def _read():
Victor Stinnera9293352011-04-30 15:21:58 +02002636 if hasattr(signal, 'pthread_sigmask'):
2637 signal.pthread_sigmask(signal.SIG_BLOCK, [signal.SIGALRM])
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002638 s = os.read(r, 1)
2639 read_results.append(s)
2640 t = threading.Thread(target=_read)
2641 t.daemon = True
2642 r, w = os.pipe()
Benjamin Petersond8fc2e12010-10-31 01:19:53 +00002643 fdopen_kwargs["closefd"] = False
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002644 try:
2645 wio = self.io.open(w, **fdopen_kwargs)
2646 t.start()
2647 signal.alarm(1)
2648 # Fill the pipe enough that the write will be blocking.
2649 # It will be interrupted by the timer armed above. Since the
2650 # other thread has read one byte, the low-level write will
2651 # return with a successful (partial) result rather than an EINTR.
2652 # The buffered IO layer must check for pending signal
2653 # handlers, which in this case will invoke alarm_interrupt().
2654 self.assertRaises(ZeroDivisionError,
2655 wio.write, item * (1024 * 1024))
2656 t.join()
2657 # We got one byte, get another one and check that it isn't a
2658 # repeat of the first one.
2659 read_results.append(os.read(r, 1))
2660 self.assertEqual(read_results, [bytes[0:1], bytes[1:2]])
2661 finally:
2662 os.close(w)
2663 os.close(r)
2664 # This is deliberate. If we didn't close the file descriptor
2665 # before closing wio, wio would try to flush its internal
2666 # buffer, and block again.
2667 try:
2668 wio.close()
2669 except IOError as e:
2670 if e.errno != errno.EBADF:
2671 raise
2672
2673 def test_interrupted_write_unbuffered(self):
2674 self.check_interrupted_write(b"xy", b"xy", mode="wb", buffering=0)
2675
2676 def test_interrupted_write_buffered(self):
2677 self.check_interrupted_write(b"xy", b"xy", mode="wb")
2678
2679 def test_interrupted_write_text(self):
2680 self.check_interrupted_write("xy", b"xy", mode="w", encoding="ascii")
2681
Brett Cannon31f59292011-02-21 19:29:56 +00002682 @support.no_tracing
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002683 def check_reentrant_write(self, data, **fdopen_kwargs):
2684 def on_alarm(*args):
2685 # Will be called reentrantly from the same thread
2686 wio.write(data)
2687 1/0
2688 signal.signal(signal.SIGALRM, on_alarm)
2689 r, w = os.pipe()
2690 wio = self.io.open(w, **fdopen_kwargs)
2691 try:
2692 signal.alarm(1)
2693 # Either the reentrant call to wio.write() fails with RuntimeError,
2694 # or the signal handler raises ZeroDivisionError.
2695 with self.assertRaises((ZeroDivisionError, RuntimeError)) as cm:
2696 while 1:
2697 for i in range(100):
2698 wio.write(data)
2699 wio.flush()
2700 # Make sure the buffer doesn't fill up and block further writes
2701 os.read(r, len(data) * 100)
2702 exc = cm.exception
2703 if isinstance(exc, RuntimeError):
2704 self.assertTrue(str(exc).startswith("reentrant call"), str(exc))
2705 finally:
2706 wio.close()
2707 os.close(r)
2708
2709 def test_reentrant_write_buffered(self):
2710 self.check_reentrant_write(b"xy", mode="wb")
2711
2712 def test_reentrant_write_text(self):
2713 self.check_reentrant_write("xy", mode="w", encoding="ascii")
2714
Antoine Pitrou707ce822011-02-25 21:24:11 +00002715 def check_interrupted_read_retry(self, decode, **fdopen_kwargs):
2716 """Check that a buffered read, when it gets interrupted (either
2717 returning a partial result or EINTR), properly invokes the signal
2718 handler and retries if the latter returned successfully."""
2719 r, w = os.pipe()
2720 fdopen_kwargs["closefd"] = False
2721 def alarm_handler(sig, frame):
2722 os.write(w, b"bar")
2723 signal.signal(signal.SIGALRM, alarm_handler)
2724 try:
2725 rio = self.io.open(r, **fdopen_kwargs)
2726 os.write(w, b"foo")
2727 signal.alarm(1)
2728 # Expected behaviour:
2729 # - first raw read() returns partial b"foo"
2730 # - second raw read() returns EINTR
2731 # - third raw read() returns b"bar"
2732 self.assertEqual(decode(rio.read(6)), "foobar")
2733 finally:
2734 rio.close()
2735 os.close(w)
2736 os.close(r)
2737
2738 def test_interrupterd_read_retry_buffered(self):
2739 self.check_interrupted_read_retry(lambda x: x.decode('latin1'),
2740 mode="rb")
2741
2742 def test_interrupterd_read_retry_text(self):
2743 self.check_interrupted_read_retry(lambda x: x,
2744 mode="r")
2745
2746 @unittest.skipUnless(threading, 'Threading required for this test.')
2747 def check_interrupted_write_retry(self, item, **fdopen_kwargs):
2748 """Check that a buffered write, when it gets interrupted (either
2749 returning a partial result or EINTR), properly invokes the signal
2750 handler and retries if the latter returned successfully."""
2751 select = support.import_module("select")
2752 # A quantity that exceeds the buffer size of an anonymous pipe's
2753 # write end.
2754 N = 1024 * 1024
2755 r, w = os.pipe()
2756 fdopen_kwargs["closefd"] = False
2757 # We need a separate thread to read from the pipe and allow the
2758 # write() to finish. This thread is started after the SIGALRM is
2759 # received (forcing a first EINTR in write()).
2760 read_results = []
2761 write_finished = False
2762 def _read():
2763 while not write_finished:
2764 while r in select.select([r], [], [], 1.0)[0]:
2765 s = os.read(r, 1024)
2766 read_results.append(s)
2767 t = threading.Thread(target=_read)
2768 t.daemon = True
2769 def alarm1(sig, frame):
2770 signal.signal(signal.SIGALRM, alarm2)
2771 signal.alarm(1)
2772 def alarm2(sig, frame):
2773 t.start()
2774 signal.signal(signal.SIGALRM, alarm1)
2775 try:
2776 wio = self.io.open(w, **fdopen_kwargs)
2777 signal.alarm(1)
2778 # Expected behaviour:
2779 # - first raw write() is partial (because of the limited pipe buffer
2780 # and the first alarm)
2781 # - second raw write() returns EINTR (because of the second alarm)
2782 # - subsequent write()s are successful (either partial or complete)
2783 self.assertEqual(N, wio.write(item * N))
2784 wio.flush()
2785 write_finished = True
2786 t.join()
2787 self.assertEqual(N, sum(len(x) for x in read_results))
2788 finally:
2789 write_finished = True
2790 os.close(w)
2791 os.close(r)
2792 # This is deliberate. If we didn't close the file descriptor
2793 # before closing wio, wio would try to flush its internal
2794 # buffer, and could block (in case of failure).
2795 try:
2796 wio.close()
2797 except IOError as e:
2798 if e.errno != errno.EBADF:
2799 raise
2800
2801 def test_interrupterd_write_retry_buffered(self):
2802 self.check_interrupted_write_retry(b"x", mode="wb")
2803
2804 def test_interrupterd_write_retry_text(self):
2805 self.check_interrupted_write_retry("x", mode="w", encoding="latin1")
2806
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002807
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002808class CSignalsTest(SignalsTest):
2809 io = io
2810
2811class PySignalsTest(SignalsTest):
2812 io = pyio
2813
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002814 # Handling reentrancy issues would slow down _pyio even more, so the
2815 # tests are disabled.
2816 test_reentrant_write_buffered = None
2817 test_reentrant_write_text = None
2818
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002819
Guido van Rossum28524c72007-02-27 05:47:44 +00002820def test_main():
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002821 tests = (CIOTest, PyIOTest,
2822 CBufferedReaderTest, PyBufferedReaderTest,
2823 CBufferedWriterTest, PyBufferedWriterTest,
2824 CBufferedRWPairTest, PyBufferedRWPairTest,
2825 CBufferedRandomTest, PyBufferedRandomTest,
2826 StatefulIncrementalDecoderTest,
2827 CIncrementalNewlineDecoderTest, PyIncrementalNewlineDecoderTest,
2828 CTextIOWrapperTest, PyTextIOWrapperTest,
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002829 CMiscIOTest, PyMiscIOTest,
2830 CSignalsTest, PySignalsTest,
2831 )
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002832
2833 # Put the namespaces of the IO module we are testing and some useful mock
2834 # classes in the __dict__ of each test.
2835 mocks = (MockRawIO, MisbehavedRawIO, MockFileIO, CloseFailureIO,
Antoine Pitrou328ec742010-09-14 18:37:24 +00002836 MockNonBlockWriterIO, MockUnseekableIO, MockRawIOWithoutRead)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002837 all_members = io.__all__ + ["IncrementalNewlineDecoder"]
2838 c_io_ns = {name : getattr(io, name) for name in all_members}
2839 py_io_ns = {name : getattr(pyio, name) for name in all_members}
2840 globs = globals()
2841 c_io_ns.update((x.__name__, globs["C" + x.__name__]) for x in mocks)
2842 py_io_ns.update((x.__name__, globs["Py" + x.__name__]) for x in mocks)
2843 # Avoid turning open into a bound method.
2844 py_io_ns["open"] = pyio.OpenWrapper
2845 for test in tests:
2846 if test.__name__.startswith("C"):
2847 for name, obj in c_io_ns.items():
2848 setattr(test, name, obj)
2849 elif test.__name__.startswith("Py"):
2850 for name, obj in py_io_ns.items():
2851 setattr(test, name, obj)
2852
2853 support.run_unittest(*tests)
Guido van Rossum28524c72007-02-27 05:47:44 +00002854
2855if __name__ == "__main__":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002856 test_main()