blob: d5eec7c2215f7b835628643bb4de9e0f7d7715de [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
Victor Stinnerf86a5e82012-06-05 13:43:22 +020022import abc
23import array
24import errno
25import locale
Guido van Rossum8358db22007-08-18 21:39:55 +000026import os
Victor Stinnerf86a5e82012-06-05 13:43:22 +020027import pickle
28import random
29import signal
Guido van Rossum34d69e52007-04-10 20:08:41 +000030import sys
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +000031import time
Guido van Rossum28524c72007-02-27 05:47:44 +000032import unittest
Antoine Pitroue033e062010-10-29 10:38:18 +000033import warnings
Victor Stinnerf86a5e82012-06-05 13:43:22 +020034import weakref
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000035from collections import deque
Victor Stinnerf86a5e82012-06-05 13:43:22 +020036from itertools import cycle, count
Benjamin Petersonee8712c2008-05-20 21:35:26 +000037from test import support
Guido van Rossum76c5d4d2007-04-06 19:10:29 +000038
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +000039import codecs
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000040import io # C implementation of io
41import _pyio as pyio # Python implementation of io
Victor Stinner45df8202010-04-28 22:31:17 +000042try:
43 import threading
44except ImportError:
45 threading = None
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +010046try:
47 import fcntl
48except ImportError:
49 fcntl = None
Guido van Rossuma9e20242007-03-08 00:43:48 +000050
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000051def _default_chunk_size():
52 """Get the default TextIOWrapper chunk size"""
Marc-André Lemburg8f36af72011-02-25 15:42:01 +000053 with open(__file__, "r", encoding="latin-1") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000054 return f._CHUNK_SIZE
55
56
Antoine Pitrou328ec742010-09-14 18:37:24 +000057class MockRawIOWithoutRead:
58 """A RawIO implementation without read(), so as to exercise the default
59 RawIO.read() which calls readinto()."""
Guido van Rossuma9e20242007-03-08 00:43:48 +000060
Guido van Rossum76c5d4d2007-04-06 19:10:29 +000061 def __init__(self, read_stack=()):
62 self._read_stack = list(read_stack)
63 self._write_stack = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000064 self._reads = 0
Antoine Pitrou32cfede2010-08-11 13:31:33 +000065 self._extraneous_reads = 0
Guido van Rossum68bbcd22007-02-27 17:19:33 +000066
Guido van Rossum01a27522007-03-07 01:00:12 +000067 def write(self, b):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000068 self._write_stack.append(bytes(b))
Guido van Rossum01a27522007-03-07 01:00:12 +000069 return len(b)
70
71 def writable(self):
72 return True
73
Guido van Rossum68bbcd22007-02-27 17:19:33 +000074 def fileno(self):
75 return 42
76
77 def readable(self):
78 return True
79
Guido van Rossum01a27522007-03-07 01:00:12 +000080 def seekable(self):
Guido van Rossum68bbcd22007-02-27 17:19:33 +000081 return True
82
Guido van Rossum01a27522007-03-07 01:00:12 +000083 def seek(self, pos, whence):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000084 return 0 # wrong but we gotta return something
Guido van Rossum01a27522007-03-07 01:00:12 +000085
86 def tell(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000087 return 0 # same comment as above
88
89 def readinto(self, buf):
90 self._reads += 1
91 max_len = len(buf)
92 try:
93 data = self._read_stack[0]
94 except IndexError:
Antoine Pitrou32cfede2010-08-11 13:31:33 +000095 self._extraneous_reads += 1
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000096 return 0
97 if data is None:
98 del self._read_stack[0]
99 return None
100 n = len(data)
101 if len(data) <= max_len:
102 del self._read_stack[0]
103 buf[:n] = data
104 return n
105 else:
106 buf[:] = data[:max_len]
107 self._read_stack[0] = data[max_len:]
108 return max_len
109
110 def truncate(self, pos=None):
111 return pos
112
Antoine Pitrou328ec742010-09-14 18:37:24 +0000113class CMockRawIOWithoutRead(MockRawIOWithoutRead, io.RawIOBase):
114 pass
115
116class PyMockRawIOWithoutRead(MockRawIOWithoutRead, pyio.RawIOBase):
117 pass
118
119
120class MockRawIO(MockRawIOWithoutRead):
121
122 def read(self, n=None):
123 self._reads += 1
124 try:
125 return self._read_stack.pop(0)
126 except:
127 self._extraneous_reads += 1
128 return b""
129
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000130class CMockRawIO(MockRawIO, io.RawIOBase):
131 pass
132
133class PyMockRawIO(MockRawIO, pyio.RawIOBase):
134 pass
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000135
Guido van Rossuma9e20242007-03-08 00:43:48 +0000136
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000137class MisbehavedRawIO(MockRawIO):
138 def write(self, b):
139 return super().write(b) * 2
140
141 def read(self, n=None):
142 return super().read(n) * 2
143
144 def seek(self, pos, whence):
145 return -123
146
147 def tell(self):
148 return -456
149
150 def readinto(self, buf):
151 super().readinto(buf)
152 return len(buf) * 5
153
154class CMisbehavedRawIO(MisbehavedRawIO, io.RawIOBase):
155 pass
156
157class PyMisbehavedRawIO(MisbehavedRawIO, pyio.RawIOBase):
158 pass
159
160
161class CloseFailureIO(MockRawIO):
162 closed = 0
163
164 def close(self):
165 if not self.closed:
166 self.closed = 1
167 raise IOError
168
169class CCloseFailureIO(CloseFailureIO, io.RawIOBase):
170 pass
171
172class PyCloseFailureIO(CloseFailureIO, pyio.RawIOBase):
173 pass
174
175
176class MockFileIO:
Guido van Rossum78892e42007-04-06 17:31:18 +0000177
178 def __init__(self, data):
179 self.read_history = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000180 super().__init__(data)
Guido van Rossum78892e42007-04-06 17:31:18 +0000181
182 def read(self, n=None):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000183 res = super().read(n)
Guido van Rossum78892e42007-04-06 17:31:18 +0000184 self.read_history.append(None if res is None else len(res))
185 return res
186
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000187 def readinto(self, b):
188 res = super().readinto(b)
189 self.read_history.append(res)
190 return res
Guido van Rossum78892e42007-04-06 17:31:18 +0000191
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000192class CMockFileIO(MockFileIO, io.BytesIO):
193 pass
Guido van Rossuma9e20242007-03-08 00:43:48 +0000194
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000195class PyMockFileIO(MockFileIO, pyio.BytesIO):
196 pass
197
198
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000199class MockUnseekableIO:
200 def seekable(self):
201 return False
202
203 def seek(self, *args):
204 raise self.UnsupportedOperation("not seekable")
205
206 def tell(self, *args):
207 raise self.UnsupportedOperation("not seekable")
208
209class CMockUnseekableIO(MockUnseekableIO, io.BytesIO):
210 UnsupportedOperation = io.UnsupportedOperation
211
212class PyMockUnseekableIO(MockUnseekableIO, pyio.BytesIO):
213 UnsupportedOperation = pyio.UnsupportedOperation
214
215
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000216class MockNonBlockWriterIO:
217
218 def __init__(self):
Guido van Rossum01a27522007-03-07 01:00:12 +0000219 self._write_stack = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000220 self._blocker_char = None
Guido van Rossuma9e20242007-03-08 00:43:48 +0000221
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000222 def pop_written(self):
223 s = b"".join(self._write_stack)
224 self._write_stack[:] = []
225 return s
226
227 def block_on(self, char):
228 """Block when a given char is encountered."""
229 self._blocker_char = char
230
231 def readable(self):
232 return True
233
234 def seekable(self):
235 return True
Guido van Rossuma9e20242007-03-08 00:43:48 +0000236
Guido van Rossum01a27522007-03-07 01:00:12 +0000237 def writable(self):
238 return True
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000239
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000240 def write(self, b):
241 b = bytes(b)
242 n = -1
243 if self._blocker_char:
244 try:
245 n = b.index(self._blocker_char)
246 except ValueError:
247 pass
248 else:
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100249 if n > 0:
250 # write data up to the first blocker
251 self._write_stack.append(b[:n])
252 return n
253 else:
254 # cancel blocker and indicate would block
255 self._blocker_char = None
256 return None
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000257 self._write_stack.append(b)
258 return len(b)
259
260class CMockNonBlockWriterIO(MockNonBlockWriterIO, io.RawIOBase):
261 BlockingIOError = io.BlockingIOError
262
263class PyMockNonBlockWriterIO(MockNonBlockWriterIO, pyio.RawIOBase):
264 BlockingIOError = pyio.BlockingIOError
265
Guido van Rossuma9e20242007-03-08 00:43:48 +0000266
Guido van Rossum28524c72007-02-27 05:47:44 +0000267class IOTest(unittest.TestCase):
268
Neal Norwitze7789b12008-03-24 06:18:09 +0000269 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000270 support.unlink(support.TESTFN)
Neal Norwitze7789b12008-03-24 06:18:09 +0000271
Guido van Rossum4d0f5a42007-03-07 22:59:39 +0000272 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000273 support.unlink(support.TESTFN)
Guido van Rossum4d0f5a42007-03-07 22:59:39 +0000274
Guido van Rossum28524c72007-02-27 05:47:44 +0000275 def write_ops(self, f):
Guido van Rossum87429772007-04-10 21:06:59 +0000276 self.assertEqual(f.write(b"blah."), 5)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000277 f.truncate(0)
278 self.assertEqual(f.tell(), 5)
279 f.seek(0)
280
281 self.assertEqual(f.write(b"blah."), 5)
Guido van Rossum87429772007-04-10 21:06:59 +0000282 self.assertEqual(f.seek(0), 0)
283 self.assertEqual(f.write(b"Hello."), 6)
Guido van Rossum28524c72007-02-27 05:47:44 +0000284 self.assertEqual(f.tell(), 6)
Guido van Rossum87429772007-04-10 21:06:59 +0000285 self.assertEqual(f.seek(-1, 1), 5)
Guido van Rossum28524c72007-02-27 05:47:44 +0000286 self.assertEqual(f.tell(), 5)
Guido van Rossum254348e2007-11-21 19:29:53 +0000287 self.assertEqual(f.write(bytearray(b" world\n\n\n")), 9)
Guido van Rossum87429772007-04-10 21:06:59 +0000288 self.assertEqual(f.seek(0), 0)
Guido van Rossum2b08b382007-05-08 20:18:39 +0000289 self.assertEqual(f.write(b"h"), 1)
Guido van Rossum87429772007-04-10 21:06:59 +0000290 self.assertEqual(f.seek(-1, 2), 13)
291 self.assertEqual(f.tell(), 13)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000292
Guido van Rossum87429772007-04-10 21:06:59 +0000293 self.assertEqual(f.truncate(12), 12)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000294 self.assertEqual(f.tell(), 13)
Christian Heimes8e42a0a2007-11-08 18:04:45 +0000295 self.assertRaises(TypeError, f.seek, 0.0)
Guido van Rossum28524c72007-02-27 05:47:44 +0000296
Guido van Rossum9b76da62007-04-11 01:09:03 +0000297 def read_ops(self, f, buffered=False):
298 data = f.read(5)
299 self.assertEqual(data, b"hello")
Guido van Rossum254348e2007-11-21 19:29:53 +0000300 data = bytearray(data)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000301 self.assertEqual(f.readinto(data), 5)
302 self.assertEqual(data, b" worl")
303 self.assertEqual(f.readinto(data), 2)
304 self.assertEqual(len(data), 5)
305 self.assertEqual(data[:2], b"d\n")
306 self.assertEqual(f.seek(0), 0)
307 self.assertEqual(f.read(20), b"hello world\n")
308 self.assertEqual(f.read(1), b"")
Guido van Rossum254348e2007-11-21 19:29:53 +0000309 self.assertEqual(f.readinto(bytearray(b"x")), 0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000310 self.assertEqual(f.seek(-6, 2), 6)
311 self.assertEqual(f.read(5), b"world")
312 self.assertEqual(f.read(0), b"")
Guido van Rossum254348e2007-11-21 19:29:53 +0000313 self.assertEqual(f.readinto(bytearray()), 0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000314 self.assertEqual(f.seek(-6, 1), 5)
315 self.assertEqual(f.read(5), b" worl")
316 self.assertEqual(f.tell(), 10)
Christian Heimes8e42a0a2007-11-08 18:04:45 +0000317 self.assertRaises(TypeError, f.seek, 0.0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000318 if buffered:
319 f.seek(0)
320 self.assertEqual(f.read(), b"hello world\n")
321 f.seek(6)
322 self.assertEqual(f.read(), b"world\n")
323 self.assertEqual(f.read(), b"")
324
Guido van Rossum34d69e52007-04-10 20:08:41 +0000325 LARGE = 2**31
326
Guido van Rossum53807da2007-04-10 19:01:47 +0000327 def large_file_ops(self, f):
328 assert f.readable()
329 assert f.writable()
Guido van Rossum34d69e52007-04-10 20:08:41 +0000330 self.assertEqual(f.seek(self.LARGE), self.LARGE)
331 self.assertEqual(f.tell(), self.LARGE)
Guido van Rossum53807da2007-04-10 19:01:47 +0000332 self.assertEqual(f.write(b"xxx"), 3)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000333 self.assertEqual(f.tell(), self.LARGE + 3)
334 self.assertEqual(f.seek(-1, 1), self.LARGE + 2)
Guido van Rossum87429772007-04-10 21:06:59 +0000335 self.assertEqual(f.truncate(), self.LARGE + 2)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000336 self.assertEqual(f.tell(), self.LARGE + 2)
337 self.assertEqual(f.seek(0, 2), self.LARGE + 2)
Guido van Rossum87429772007-04-10 21:06:59 +0000338 self.assertEqual(f.truncate(self.LARGE + 1), self.LARGE + 1)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000339 self.assertEqual(f.tell(), self.LARGE + 2)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000340 self.assertEqual(f.seek(0, 2), self.LARGE + 1)
341 self.assertEqual(f.seek(-1, 2), self.LARGE)
Guido van Rossum53807da2007-04-10 19:01:47 +0000342 self.assertEqual(f.read(2), b"x")
343
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000344 def test_invalid_operations(self):
345 # Try writing on a file opened in read mode and vice-versa.
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000346 exc = self.UnsupportedOperation
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000347 for mode in ("w", "wb"):
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000348 with self.open(support.TESTFN, mode) as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000349 self.assertRaises(exc, fp.read)
350 self.assertRaises(exc, fp.readline)
351 with self.open(support.TESTFN, "wb", buffering=0) as fp:
352 self.assertRaises(exc, fp.read)
353 self.assertRaises(exc, fp.readline)
354 with self.open(support.TESTFN, "rb", buffering=0) as fp:
355 self.assertRaises(exc, fp.write, b"blah")
356 self.assertRaises(exc, fp.writelines, [b"blah\n"])
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000357 with self.open(support.TESTFN, "rb") as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000358 self.assertRaises(exc, fp.write, b"blah")
359 self.assertRaises(exc, fp.writelines, [b"blah\n"])
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000360 with self.open(support.TESTFN, "r") as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000361 self.assertRaises(exc, fp.write, "blah")
362 self.assertRaises(exc, fp.writelines, ["blah\n"])
363 # Non-zero seeking from current or end pos
364 self.assertRaises(exc, fp.seek, 1, self.SEEK_CUR)
365 self.assertRaises(exc, fp.seek, -1, self.SEEK_END)
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000366
Antoine Pitrou13348842012-01-29 18:36:34 +0100367 def test_open_handles_NUL_chars(self):
368 fn_with_NUL = 'foo\0bar'
369 self.assertRaises(TypeError, self.open, fn_with_NUL, 'w')
370 self.assertRaises(TypeError, self.open, bytes(fn_with_NUL, 'ascii'), 'w')
371
Guido van Rossum28524c72007-02-27 05:47:44 +0000372 def test_raw_file_io(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000373 with self.open(support.TESTFN, "wb", buffering=0) as f:
374 self.assertEqual(f.readable(), False)
375 self.assertEqual(f.writable(), True)
376 self.assertEqual(f.seekable(), True)
377 self.write_ops(f)
378 with self.open(support.TESTFN, "rb", buffering=0) as f:
379 self.assertEqual(f.readable(), True)
380 self.assertEqual(f.writable(), False)
381 self.assertEqual(f.seekable(), True)
382 self.read_ops(f)
Guido van Rossum28524c72007-02-27 05:47:44 +0000383
Guido van Rossum87429772007-04-10 21:06:59 +0000384 def test_buffered_file_io(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000385 with self.open(support.TESTFN, "wb") as f:
386 self.assertEqual(f.readable(), False)
387 self.assertEqual(f.writable(), True)
388 self.assertEqual(f.seekable(), True)
389 self.write_ops(f)
390 with self.open(support.TESTFN, "rb") as f:
391 self.assertEqual(f.readable(), True)
392 self.assertEqual(f.writable(), False)
393 self.assertEqual(f.seekable(), True)
394 self.read_ops(f, True)
Guido van Rossum87429772007-04-10 21:06:59 +0000395
Guido van Rossum48fc58a2007-06-07 23:45:37 +0000396 def test_readline(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000397 with self.open(support.TESTFN, "wb") as f:
398 f.write(b"abc\ndef\nxyzzy\nfoo\x00bar\nanother line")
399 with self.open(support.TESTFN, "rb") as f:
400 self.assertEqual(f.readline(), b"abc\n")
401 self.assertEqual(f.readline(10), b"def\n")
402 self.assertEqual(f.readline(2), b"xy")
403 self.assertEqual(f.readline(4), b"zzy\n")
404 self.assertEqual(f.readline(), b"foo\x00bar\n")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000405 self.assertEqual(f.readline(None), b"another line")
Benjamin Peterson45cec322009-04-24 23:14:50 +0000406 self.assertRaises(TypeError, f.readline, 5.3)
407 with self.open(support.TESTFN, "r") as f:
408 self.assertRaises(TypeError, f.readline, 5.3)
Guido van Rossum48fc58a2007-06-07 23:45:37 +0000409
Guido van Rossum28524c72007-02-27 05:47:44 +0000410 def test_raw_bytes_io(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000411 f = self.BytesIO()
Guido van Rossum28524c72007-02-27 05:47:44 +0000412 self.write_ops(f)
413 data = f.getvalue()
414 self.assertEqual(data, b"hello world\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000415 f = self.BytesIO(data)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000416 self.read_ops(f, True)
Guido van Rossum28524c72007-02-27 05:47:44 +0000417
Guido van Rossum53807da2007-04-10 19:01:47 +0000418 def test_large_file_ops(self):
Guido van Rossum34d69e52007-04-10 20:08:41 +0000419 # On Windows and Mac OSX this test comsumes large resources; It takes
420 # a long time to build the >2GB file and takes >2GB of disk space
421 # therefore the resource must be enabled to run this test.
422 if sys.platform[:3] == 'win' or sys.platform == 'darwin':
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000423 if not support.is_resource_enabled("largefile"):
Guido van Rossum34d69e52007-04-10 20:08:41 +0000424 print("\nTesting large file ops skipped on %s." % sys.platform,
425 file=sys.stderr)
426 print("It requires %d bytes and a long time." % self.LARGE,
427 file=sys.stderr)
428 print("Use 'regrtest.py -u largefile test_io' to run it.",
429 file=sys.stderr)
430 return
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000431 with self.open(support.TESTFN, "w+b", 0) as f:
432 self.large_file_ops(f)
433 with self.open(support.TESTFN, "w+b") as f:
434 self.large_file_ops(f)
Guido van Rossum87429772007-04-10 21:06:59 +0000435
436 def test_with_open(self):
437 for bufsize in (0, 1, 100):
438 f = None
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000439 with self.open(support.TESTFN, "wb", bufsize) as f:
Guido van Rossum1f2ca562007-08-27 20:44:15 +0000440 f.write(b"xxx")
Guido van Rossum87429772007-04-10 21:06:59 +0000441 self.assertEqual(f.closed, True)
442 f = None
443 try:
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000444 with self.open(support.TESTFN, "wb", bufsize) as f:
Guido van Rossum87429772007-04-10 21:06:59 +0000445 1/0
446 except ZeroDivisionError:
447 self.assertEqual(f.closed, True)
448 else:
449 self.fail("1/0 didn't raise an exception")
450
Antoine Pitrou08838b62009-01-21 00:55:13 +0000451 # issue 5008
452 def test_append_mode_tell(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000453 with self.open(support.TESTFN, "wb") as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000454 f.write(b"xxx")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000455 with self.open(support.TESTFN, "ab", buffering=0) as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000456 self.assertEqual(f.tell(), 3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000457 with self.open(support.TESTFN, "ab") as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000458 self.assertEqual(f.tell(), 3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000459 with self.open(support.TESTFN, "a") as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000460 self.assertTrue(f.tell() > 0)
Antoine Pitrou08838b62009-01-21 00:55:13 +0000461
Guido van Rossum87429772007-04-10 21:06:59 +0000462 def test_destructor(self):
463 record = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000464 class MyFileIO(self.FileIO):
Guido van Rossum87429772007-04-10 21:06:59 +0000465 def __del__(self):
466 record.append(1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000467 try:
468 f = super().__del__
469 except AttributeError:
470 pass
471 else:
472 f()
Guido van Rossum87429772007-04-10 21:06:59 +0000473 def close(self):
474 record.append(2)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000475 super().close()
Guido van Rossum87429772007-04-10 21:06:59 +0000476 def flush(self):
477 record.append(3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000478 super().flush()
Brett Cannon5a9e91b2010-10-29 23:53:03 +0000479 with support.check_warnings(('', ResourceWarning)):
480 f = MyFileIO(support.TESTFN, "wb")
481 f.write(b"xxx")
482 del f
483 support.gc_collect()
484 self.assertEqual(record, [1, 2, 3])
485 with self.open(support.TESTFN, "rb") as f:
486 self.assertEqual(f.read(), b"xxx")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000487
488 def _check_base_destructor(self, base):
489 record = []
490 class MyIO(base):
491 def __init__(self):
492 # This exercises the availability of attributes on object
493 # destruction.
494 # (in the C version, close() is called by the tp_dealloc
495 # function, not by __del__)
496 self.on_del = 1
497 self.on_close = 2
498 self.on_flush = 3
499 def __del__(self):
500 record.append(self.on_del)
501 try:
502 f = super().__del__
503 except AttributeError:
504 pass
505 else:
506 f()
507 def close(self):
508 record.append(self.on_close)
509 super().close()
510 def flush(self):
511 record.append(self.on_flush)
512 super().flush()
513 f = MyIO()
Guido van Rossum87429772007-04-10 21:06:59 +0000514 del f
Benjamin Peterson24fb1d02009-04-24 23:26:21 +0000515 support.gc_collect()
Guido van Rossum87429772007-04-10 21:06:59 +0000516 self.assertEqual(record, [1, 2, 3])
517
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000518 def test_IOBase_destructor(self):
519 self._check_base_destructor(self.IOBase)
520
521 def test_RawIOBase_destructor(self):
522 self._check_base_destructor(self.RawIOBase)
523
524 def test_BufferedIOBase_destructor(self):
525 self._check_base_destructor(self.BufferedIOBase)
526
527 def test_TextIOBase_destructor(self):
528 self._check_base_destructor(self.TextIOBase)
529
Guido van Rossum87429772007-04-10 21:06:59 +0000530 def test_close_flushes(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000531 with self.open(support.TESTFN, "wb") as f:
532 f.write(b"xxx")
533 with self.open(support.TESTFN, "rb") as f:
534 self.assertEqual(f.read(), b"xxx")
Guido van Rossuma9e20242007-03-08 00:43:48 +0000535
Guido van Rossumd4103952007-04-12 05:44:49 +0000536 def test_array_writes(self):
537 a = array.array('i', range(10))
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +0000538 n = len(a.tobytes())
Benjamin Peterson45cec322009-04-24 23:14:50 +0000539 with self.open(support.TESTFN, "wb", 0) as f:
540 self.assertEqual(f.write(a), n)
541 with self.open(support.TESTFN, "wb") as f:
542 self.assertEqual(f.write(a), n)
Guido van Rossumd4103952007-04-12 05:44:49 +0000543
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000544 def test_closefd(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000545 self.assertRaises(ValueError, self.open, support.TESTFN, 'w',
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000546 closefd=False)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000547
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000548 def test_read_closed(self):
549 with self.open(support.TESTFN, "w") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000550 f.write("egg\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000551 with self.open(support.TESTFN, "r") as f:
552 file = self.open(f.fileno(), "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000553 self.assertEqual(file.read(), "egg\n")
554 file.seek(0)
555 file.close()
556 self.assertRaises(ValueError, file.read)
557
558 def test_no_closefd_with_filename(self):
559 # can't use closefd in combination with a file name
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000560 self.assertRaises(ValueError, self.open, support.TESTFN, "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000561
562 def test_closefd_attr(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000563 with self.open(support.TESTFN, "wb") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000564 f.write(b"egg\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000565 with self.open(support.TESTFN, "r") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000566 self.assertEqual(f.buffer.raw.closefd, True)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000567 file = self.open(f.fileno(), "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000568 self.assertEqual(file.buffer.raw.closefd, False)
569
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000570 def test_garbage_collection(self):
571 # FileIO objects are collected, and collecting them flushes
572 # all data to disk.
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +0000573 with support.check_warnings(('', ResourceWarning)):
574 f = self.FileIO(support.TESTFN, "wb")
575 f.write(b"abcxxx")
576 f.f = f
577 wr = weakref.ref(f)
578 del f
579 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000580 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000581 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000582 self.assertEqual(f.read(), b"abcxxx")
Christian Heimesecc42a22008-11-05 19:30:32 +0000583
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000584 def test_unbounded_file(self):
585 # Issue #1174606: reading from an unbounded stream such as /dev/zero.
586 zero = "/dev/zero"
587 if not os.path.exists(zero):
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000588 self.skipTest("{0} does not exist".format(zero))
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000589 if sys.maxsize > 0x7FFFFFFF:
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000590 self.skipTest("test can only run in a 32-bit address space")
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000591 if support.real_max_memuse < support._2G:
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000592 self.skipTest("test requires at least 2GB of memory")
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000593 with self.open(zero, "rb", buffering=0) as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000594 self.assertRaises(OverflowError, f.read)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000595 with self.open(zero, "rb") as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000596 self.assertRaises(OverflowError, f.read)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000597 with self.open(zero, "r") as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000598 self.assertRaises(OverflowError, f.read)
599
Antoine Pitrou6be88762010-05-03 16:48:20 +0000600 def test_flush_error_on_close(self):
601 f = self.open(support.TESTFN, "wb", buffering=0)
602 def bad_flush():
603 raise IOError()
604 f.flush = bad_flush
605 self.assertRaises(IOError, f.close) # exception not swallowed
606
607 def test_multi_close(self):
608 f = self.open(support.TESTFN, "wb", buffering=0)
609 f.close()
610 f.close()
611 f.close()
612 self.assertRaises(ValueError, f.flush)
613
Antoine Pitrou328ec742010-09-14 18:37:24 +0000614 def test_RawIOBase_read(self):
615 # Exercise the default RawIOBase.read() implementation (which calls
616 # readinto() internally).
617 rawio = self.MockRawIOWithoutRead((b"abc", b"d", None, b"efg", None))
618 self.assertEqual(rawio.read(2), b"ab")
619 self.assertEqual(rawio.read(2), b"c")
620 self.assertEqual(rawio.read(2), b"d")
621 self.assertEqual(rawio.read(2), None)
622 self.assertEqual(rawio.read(2), b"ef")
623 self.assertEqual(rawio.read(2), b"g")
624 self.assertEqual(rawio.read(2), None)
625 self.assertEqual(rawio.read(2), b"")
626
Benjamin Petersonf6f3a352011-09-03 09:26:20 -0400627 def test_types_have_dict(self):
628 test = (
629 self.IOBase(),
630 self.RawIOBase(),
631 self.TextIOBase(),
632 self.StringIO(),
633 self.BytesIO()
634 )
635 for obj in test:
636 self.assertTrue(hasattr(obj, "__dict__"))
637
Ross Lagerwall59142db2011-10-31 20:34:46 +0200638 def test_opener(self):
639 with self.open(support.TESTFN, "w") as f:
640 f.write("egg\n")
641 fd = os.open(support.TESTFN, os.O_RDONLY)
642 def opener(path, flags):
643 return fd
644 with self.open("non-existent", "r", opener=opener) as f:
645 self.assertEqual(f.read(), "egg\n")
646
Hynek Schlawack2cc71562012-05-25 10:05:53 +0200647 def test_fileio_closefd(self):
648 # Issue #4841
649 with self.open(__file__, 'rb') as f1, \
650 self.open(__file__, 'rb') as f2:
651 fileio = self.FileIO(f1.fileno(), closefd=False)
652 # .__init__() must not close f1
653 fileio.__init__(f2.fileno(), closefd=False)
654 f1.readline()
655 # .close() must not close f2
656 fileio.close()
657 f2.readline()
658
659
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000660class CIOTest(IOTest):
Antoine Pitrou84f1b172011-07-12 21:57:15 +0200661
662 def test_IOBase_finalize(self):
663 # Issue #12149: segmentation fault on _PyIOBase_finalize when both a
664 # class which inherits IOBase and an object of this class are caught
665 # in a reference cycle and close() is already in the method cache.
666 class MyIO(self.IOBase):
667 def close(self):
668 pass
669
670 # create an instance to populate the method cache
671 MyIO()
672 obj = MyIO()
673 obj.obj = obj
674 wr = weakref.ref(obj)
675 del MyIO
676 del obj
677 support.gc_collect()
678 self.assertTrue(wr() is None, wr)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000679
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000680class PyIOTest(IOTest):
681 pass
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000682
Guido van Rossuma9e20242007-03-08 00:43:48 +0000683
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000684class CommonBufferedTests:
685 # Tests common to BufferedReader, BufferedWriter and BufferedRandom
686
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000687 def test_detach(self):
688 raw = self.MockRawIO()
689 buf = self.tp(raw)
690 self.assertIs(buf.detach(), raw)
691 self.assertRaises(ValueError, buf.detach)
692
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000693 def test_fileno(self):
694 rawio = self.MockRawIO()
695 bufio = self.tp(rawio)
696
Ezio Melottib3aedd42010-11-20 19:04:17 +0000697 self.assertEqual(42, bufio.fileno())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000698
699 def test_no_fileno(self):
700 # XXX will we always have fileno() function? If so, kill
701 # this test. Else, write it.
702 pass
703
704 def test_invalid_args(self):
705 rawio = self.MockRawIO()
706 bufio = self.tp(rawio)
707 # Invalid whence
708 self.assertRaises(ValueError, bufio.seek, 0, -1)
Jesus Cea94363612012-06-22 18:32:07 +0200709 self.assertRaises(ValueError, bufio.seek, 0, 9)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000710
711 def test_override_destructor(self):
712 tp = self.tp
713 record = []
714 class MyBufferedIO(tp):
715 def __del__(self):
716 record.append(1)
717 try:
718 f = super().__del__
719 except AttributeError:
720 pass
721 else:
722 f()
723 def close(self):
724 record.append(2)
725 super().close()
726 def flush(self):
727 record.append(3)
728 super().flush()
729 rawio = self.MockRawIO()
730 bufio = MyBufferedIO(rawio)
731 writable = bufio.writable()
732 del bufio
Benjamin Peterson24fb1d02009-04-24 23:26:21 +0000733 support.gc_collect()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000734 if writable:
735 self.assertEqual(record, [1, 2, 3])
736 else:
737 self.assertEqual(record, [1, 2])
738
739 def test_context_manager(self):
740 # Test usability as a context manager
741 rawio = self.MockRawIO()
742 bufio = self.tp(rawio)
743 def _with():
744 with bufio:
745 pass
746 _with()
747 # bufio should now be closed, and using it a second time should raise
748 # a ValueError.
749 self.assertRaises(ValueError, _with)
750
751 def test_error_through_destructor(self):
752 # Test that the exception state is not modified by a destructor,
753 # even if close() fails.
754 rawio = self.CloseFailureIO()
755 def f():
756 self.tp(rawio).xyzzy
757 with support.captured_output("stderr") as s:
758 self.assertRaises(AttributeError, f)
759 s = s.getvalue().strip()
760 if s:
761 # The destructor *may* have printed an unraisable error, check it
762 self.assertEqual(len(s.splitlines()), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000763 self.assertTrue(s.startswith("Exception IOError: "), s)
764 self.assertTrue(s.endswith(" ignored"), s)
Guido van Rossum78892e42007-04-06 17:31:18 +0000765
Antoine Pitrou716c4442009-05-23 19:04:03 +0000766 def test_repr(self):
767 raw = self.MockRawIO()
768 b = self.tp(raw)
769 clsname = "%s.%s" % (self.tp.__module__, self.tp.__name__)
770 self.assertEqual(repr(b), "<%s>" % clsname)
771 raw.name = "dummy"
772 self.assertEqual(repr(b), "<%s name='dummy'>" % clsname)
773 raw.name = b"dummy"
774 self.assertEqual(repr(b), "<%s name=b'dummy'>" % clsname)
775
Antoine Pitrou6be88762010-05-03 16:48:20 +0000776 def test_flush_error_on_close(self):
777 raw = self.MockRawIO()
778 def bad_flush():
779 raise IOError()
780 raw.flush = bad_flush
781 b = self.tp(raw)
782 self.assertRaises(IOError, b.close) # exception not swallowed
783
784 def test_multi_close(self):
785 raw = self.MockRawIO()
786 b = self.tp(raw)
787 b.close()
788 b.close()
789 b.close()
790 self.assertRaises(ValueError, b.flush)
791
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000792 def test_unseekable(self):
793 bufio = self.tp(self.MockUnseekableIO(b"A" * 10))
794 self.assertRaises(self.UnsupportedOperation, bufio.tell)
795 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
796
Antoine Pitrou7f8f4182010-12-21 21:20:59 +0000797 def test_readonly_attributes(self):
798 raw = self.MockRawIO()
799 buf = self.tp(raw)
800 x = self.MockRawIO()
801 with self.assertRaises(AttributeError):
802 buf.raw = x
803
Guido van Rossum78892e42007-04-06 17:31:18 +0000804
Antoine Pitrou10f0c502012-07-29 19:02:46 +0200805class SizeofTest:
806
807 @support.cpython_only
808 def test_sizeof(self):
809 bufsize1 = 4096
810 bufsize2 = 8192
811 rawio = self.MockRawIO()
812 bufio = self.tp(rawio, buffer_size=bufsize1)
813 size = sys.getsizeof(bufio) - bufsize1
814 rawio = self.MockRawIO()
815 bufio = self.tp(rawio, buffer_size=bufsize2)
816 self.assertEqual(sys.getsizeof(bufio), size + bufsize2)
817
818
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000819class BufferedReaderTest(unittest.TestCase, CommonBufferedTests):
820 read_mode = "rb"
Guido van Rossum78892e42007-04-06 17:31:18 +0000821
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000822 def test_constructor(self):
823 rawio = self.MockRawIO([b"abc"])
824 bufio = self.tp(rawio)
825 bufio.__init__(rawio)
826 bufio.__init__(rawio, buffer_size=1024)
827 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000828 self.assertEqual(b"abc", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000829 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
830 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
831 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
832 rawio = self.MockRawIO([b"abc"])
833 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000834 self.assertEqual(b"abc", bufio.read())
Guido van Rossum78892e42007-04-06 17:31:18 +0000835
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000836 def test_read(self):
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000837 for arg in (None, 7):
838 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
839 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000840 self.assertEqual(b"abcdefg", bufio.read(arg))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000841 # Invalid args
842 self.assertRaises(ValueError, bufio.read, -2)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000843
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000844 def test_read1(self):
845 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
846 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000847 self.assertEqual(b"a", bufio.read(1))
848 self.assertEqual(b"b", bufio.read1(1))
849 self.assertEqual(rawio._reads, 1)
850 self.assertEqual(b"c", bufio.read1(100))
851 self.assertEqual(rawio._reads, 1)
852 self.assertEqual(b"d", bufio.read1(100))
853 self.assertEqual(rawio._reads, 2)
854 self.assertEqual(b"efg", bufio.read1(100))
855 self.assertEqual(rawio._reads, 3)
856 self.assertEqual(b"", bufio.read1(100))
857 self.assertEqual(rawio._reads, 4)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000858 # Invalid args
859 self.assertRaises(ValueError, bufio.read1, -1)
860
861 def test_readinto(self):
862 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
863 bufio = self.tp(rawio)
864 b = bytearray(2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000865 self.assertEqual(bufio.readinto(b), 2)
866 self.assertEqual(b, b"ab")
867 self.assertEqual(bufio.readinto(b), 2)
868 self.assertEqual(b, b"cd")
869 self.assertEqual(bufio.readinto(b), 2)
870 self.assertEqual(b, b"ef")
871 self.assertEqual(bufio.readinto(b), 1)
872 self.assertEqual(b, b"gf")
873 self.assertEqual(bufio.readinto(b), 0)
874 self.assertEqual(b, b"gf")
Antoine Pitrou3486a982011-05-12 01:57:53 +0200875 rawio = self.MockRawIO((b"abc", None))
876 bufio = self.tp(rawio)
877 self.assertEqual(bufio.readinto(b), 2)
878 self.assertEqual(b, b"ab")
879 self.assertEqual(bufio.readinto(b), 1)
880 self.assertEqual(b, b"cb")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000881
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000882 def test_readlines(self):
883 def bufio():
884 rawio = self.MockRawIO((b"abc\n", b"d\n", b"ef"))
885 return self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000886 self.assertEqual(bufio().readlines(), [b"abc\n", b"d\n", b"ef"])
887 self.assertEqual(bufio().readlines(5), [b"abc\n", b"d\n"])
888 self.assertEqual(bufio().readlines(None), [b"abc\n", b"d\n", b"ef"])
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000889
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000890 def test_buffering(self):
Guido van Rossum78892e42007-04-06 17:31:18 +0000891 data = b"abcdefghi"
892 dlen = len(data)
893
894 tests = [
895 [ 100, [ 3, 1, 4, 8 ], [ dlen, 0 ] ],
896 [ 100, [ 3, 3, 3], [ dlen ] ],
897 [ 4, [ 1, 2, 4, 2 ], [ 4, 4, 1 ] ],
898 ]
899
900 for bufsize, buf_read_sizes, raw_read_sizes in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000901 rawio = self.MockFileIO(data)
902 bufio = self.tp(rawio, buffer_size=bufsize)
Guido van Rossum78892e42007-04-06 17:31:18 +0000903 pos = 0
904 for nbytes in buf_read_sizes:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000905 self.assertEqual(bufio.read(nbytes), data[pos:pos+nbytes])
Guido van Rossum78892e42007-04-06 17:31:18 +0000906 pos += nbytes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000907 # this is mildly implementation-dependent
Ezio Melottib3aedd42010-11-20 19:04:17 +0000908 self.assertEqual(rawio.read_history, raw_read_sizes)
Guido van Rossum78892e42007-04-06 17:31:18 +0000909
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000910 def test_read_non_blocking(self):
Guido van Rossum01a27522007-03-07 01:00:12 +0000911 # Inject some None's in there to simulate EWOULDBLOCK
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000912 rawio = self.MockRawIO((b"abc", b"d", None, b"efg", None, None, None))
913 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000914 self.assertEqual(b"abcd", bufio.read(6))
915 self.assertEqual(b"e", bufio.read(1))
916 self.assertEqual(b"fg", bufio.read())
917 self.assertEqual(b"", bufio.peek(1))
Victor Stinnera80987f2011-05-25 22:47:16 +0200918 self.assertIsNone(bufio.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +0000919 self.assertEqual(b"", bufio.read())
Guido van Rossum01a27522007-03-07 01:00:12 +0000920
Victor Stinnera80987f2011-05-25 22:47:16 +0200921 rawio = self.MockRawIO((b"a", None, None))
922 self.assertEqual(b"a", rawio.readall())
923 self.assertIsNone(rawio.readall())
924
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000925 def test_read_past_eof(self):
926 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
927 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000928
Ezio Melottib3aedd42010-11-20 19:04:17 +0000929 self.assertEqual(b"abcdefg", bufio.read(9000))
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000930
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000931 def test_read_all(self):
932 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
933 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000934
Ezio Melottib3aedd42010-11-20 19:04:17 +0000935 self.assertEqual(b"abcdefg", bufio.read())
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000936
Victor Stinner45df8202010-04-28 22:31:17 +0000937 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000938 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000939 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +0000940 try:
941 # Write out many bytes with exactly the same number of 0's,
942 # 1's... 255's. This will help us check that concurrent reading
943 # doesn't duplicate or forget contents.
944 N = 1000
945 l = list(range(256)) * N
946 random.shuffle(l)
947 s = bytes(bytearray(l))
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000948 with self.open(support.TESTFN, "wb") as f:
Antoine Pitrou87695762008-08-14 22:44:29 +0000949 f.write(s)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000950 with self.open(support.TESTFN, self.read_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000951 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +0000952 errors = []
953 results = []
954 def f():
955 try:
956 # Intra-buffer read then buffer-flushing read
957 for n in cycle([1, 19]):
958 s = bufio.read(n)
959 if not s:
960 break
961 # list.append() is atomic
962 results.append(s)
963 except Exception as e:
964 errors.append(e)
965 raise
966 threads = [threading.Thread(target=f) for x in range(20)]
967 for t in threads:
968 t.start()
969 time.sleep(0.02) # yield
970 for t in threads:
971 t.join()
972 self.assertFalse(errors,
973 "the following exceptions were caught: %r" % errors)
974 s = b''.join(results)
975 for i in range(256):
976 c = bytes(bytearray([i]))
977 self.assertEqual(s.count(c), N)
978 finally:
979 support.unlink(support.TESTFN)
980
Antoine Pitrou1e44fec2011-10-04 12:26:20 +0200981 def test_unseekable(self):
982 bufio = self.tp(self.MockUnseekableIO(b"A" * 10))
983 self.assertRaises(self.UnsupportedOperation, bufio.tell)
984 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
985 bufio.read(1)
986 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
987 self.assertRaises(self.UnsupportedOperation, bufio.tell)
988
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000989 def test_misbehaved_io(self):
990 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
991 bufio = self.tp(rawio)
992 self.assertRaises(IOError, bufio.seek, 0)
993 self.assertRaises(IOError, bufio.tell)
994
Antoine Pitrou32cfede2010-08-11 13:31:33 +0000995 def test_no_extraneous_read(self):
996 # Issue #9550; when the raw IO object has satisfied the read request,
997 # we should not issue any additional reads, otherwise it may block
998 # (e.g. socket).
999 bufsize = 16
1000 for n in (2, bufsize - 1, bufsize, bufsize + 1, bufsize * 2):
1001 rawio = self.MockRawIO([b"x" * n])
1002 bufio = self.tp(rawio, bufsize)
1003 self.assertEqual(bufio.read(n), b"x" * n)
1004 # Simple case: one raw read is enough to satisfy the request.
1005 self.assertEqual(rawio._extraneous_reads, 0,
1006 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
1007 # A more complex case where two raw reads are needed to satisfy
1008 # the request.
1009 rawio = self.MockRawIO([b"x" * (n - 1), b"x"])
1010 bufio = self.tp(rawio, bufsize)
1011 self.assertEqual(bufio.read(n), b"x" * n)
1012 self.assertEqual(rawio._extraneous_reads, 0,
1013 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
1014
1015
Antoine Pitrou10f0c502012-07-29 19:02:46 +02001016class CBufferedReaderTest(BufferedReaderTest, SizeofTest):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001017 tp = io.BufferedReader
1018
1019 def test_constructor(self):
1020 BufferedReaderTest.test_constructor(self)
1021 # The allocation can succeed on 32-bit builds, e.g. with more
1022 # than 2GB RAM and a 64-bit kernel.
1023 if sys.maxsize > 0x7FFFFFFF:
1024 rawio = self.MockRawIO()
1025 bufio = self.tp(rawio)
1026 self.assertRaises((OverflowError, MemoryError, ValueError),
1027 bufio.__init__, rawio, sys.maxsize)
1028
1029 def test_initialization(self):
1030 rawio = self.MockRawIO([b"abc"])
1031 bufio = self.tp(rawio)
1032 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1033 self.assertRaises(ValueError, bufio.read)
1034 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1035 self.assertRaises(ValueError, bufio.read)
1036 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1037 self.assertRaises(ValueError, bufio.read)
1038
1039 def test_misbehaved_io_read(self):
1040 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
1041 bufio = self.tp(rawio)
1042 # _pyio.BufferedReader seems to implement reading different, so that
1043 # checking this is not so easy.
1044 self.assertRaises(IOError, bufio.read, 10)
1045
1046 def test_garbage_collection(self):
1047 # C BufferedReader objects are collected.
1048 # The Python version has __del__, so it ends into gc.garbage instead
1049 rawio = self.FileIO(support.TESTFN, "w+b")
1050 f = self.tp(rawio)
1051 f.f = f
1052 wr = weakref.ref(f)
1053 del f
Benjamin Peterson45cec322009-04-24 23:14:50 +00001054 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001055 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001056
1057class PyBufferedReaderTest(BufferedReaderTest):
1058 tp = pyio.BufferedReader
Antoine Pitrou87695762008-08-14 22:44:29 +00001059
Guido van Rossuma9e20242007-03-08 00:43:48 +00001060
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001061class BufferedWriterTest(unittest.TestCase, CommonBufferedTests):
1062 write_mode = "wb"
Guido van Rossuma9e20242007-03-08 00:43:48 +00001063
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001064 def test_constructor(self):
1065 rawio = self.MockRawIO()
1066 bufio = self.tp(rawio)
1067 bufio.__init__(rawio)
1068 bufio.__init__(rawio, buffer_size=1024)
1069 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001070 self.assertEqual(3, bufio.write(b"abc"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001071 bufio.flush()
1072 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1073 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1074 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1075 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001076 self.assertEqual(3, bufio.write(b"ghi"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001077 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001078 self.assertEqual(b"".join(rawio._write_stack), b"abcghi")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001079
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001080 def test_detach_flush(self):
1081 raw = self.MockRawIO()
1082 buf = self.tp(raw)
1083 buf.write(b"howdy!")
1084 self.assertFalse(raw._write_stack)
1085 buf.detach()
1086 self.assertEqual(raw._write_stack, [b"howdy!"])
1087
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001088 def test_write(self):
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001089 # Write to the buffered IO but don't overflow the buffer.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001090 writer = self.MockRawIO()
1091 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001092 bufio.write(b"abc")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001093 self.assertFalse(writer._write_stack)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001094
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001095 def test_write_overflow(self):
1096 writer = self.MockRawIO()
1097 bufio = self.tp(writer, 8)
1098 contents = b"abcdefghijklmnop"
1099 for n in range(0, len(contents), 3):
1100 bufio.write(contents[n:n+3])
1101 flushed = b"".join(writer._write_stack)
1102 # At least (total - 8) bytes were implicitly flushed, perhaps more
1103 # depending on the implementation.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001104 self.assertTrue(flushed.startswith(contents[:-8]), flushed)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001105
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001106 def check_writes(self, intermediate_func):
1107 # Lots of writes, test the flushed output is as expected.
1108 contents = bytes(range(256)) * 1000
1109 n = 0
1110 writer = self.MockRawIO()
1111 bufio = self.tp(writer, 13)
1112 # Generator of write sizes: repeat each N 15 times then proceed to N+1
1113 def gen_sizes():
1114 for size in count(1):
1115 for i in range(15):
1116 yield size
1117 sizes = gen_sizes()
1118 while n < len(contents):
1119 size = min(next(sizes), len(contents) - n)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001120 self.assertEqual(bufio.write(contents[n:n+size]), size)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001121 intermediate_func(bufio)
1122 n += size
1123 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001124 self.assertEqual(contents, b"".join(writer._write_stack))
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001125
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001126 def test_writes(self):
1127 self.check_writes(lambda bufio: None)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001128
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001129 def test_writes_and_flushes(self):
1130 self.check_writes(lambda bufio: bufio.flush())
Guido van Rossum01a27522007-03-07 01:00:12 +00001131
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001132 def test_writes_and_seeks(self):
1133 def _seekabs(bufio):
1134 pos = bufio.tell()
1135 bufio.seek(pos + 1, 0)
1136 bufio.seek(pos - 1, 0)
1137 bufio.seek(pos, 0)
1138 self.check_writes(_seekabs)
1139 def _seekrel(bufio):
1140 pos = bufio.seek(0, 1)
1141 bufio.seek(+1, 1)
1142 bufio.seek(-1, 1)
1143 bufio.seek(pos, 0)
1144 self.check_writes(_seekrel)
Guido van Rossum01a27522007-03-07 01:00:12 +00001145
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001146 def test_writes_and_truncates(self):
1147 self.check_writes(lambda bufio: bufio.truncate(bufio.tell()))
Guido van Rossum01a27522007-03-07 01:00:12 +00001148
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001149 def test_write_non_blocking(self):
1150 raw = self.MockNonBlockWriterIO()
Benjamin Peterson59406a92009-03-26 17:10:29 +00001151 bufio = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001152
Ezio Melottib3aedd42010-11-20 19:04:17 +00001153 self.assertEqual(bufio.write(b"abcd"), 4)
1154 self.assertEqual(bufio.write(b"efghi"), 5)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001155 # 1 byte will be written, the rest will be buffered
1156 raw.block_on(b"k")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001157 self.assertEqual(bufio.write(b"jklmn"), 5)
Guido van Rossum01a27522007-03-07 01:00:12 +00001158
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001159 # 8 bytes will be written, 8 will be buffered and the rest will be lost
1160 raw.block_on(b"0")
1161 try:
1162 bufio.write(b"opqrwxyz0123456789")
1163 except self.BlockingIOError as e:
1164 written = e.characters_written
1165 else:
1166 self.fail("BlockingIOError should have been raised")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001167 self.assertEqual(written, 16)
1168 self.assertEqual(raw.pop_written(),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001169 b"abcdefghijklmnopqrwxyz")
Guido van Rossum01a27522007-03-07 01:00:12 +00001170
Ezio Melottib3aedd42010-11-20 19:04:17 +00001171 self.assertEqual(bufio.write(b"ABCDEFGHI"), 9)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001172 s = raw.pop_written()
1173 # Previously buffered bytes were flushed
1174 self.assertTrue(s.startswith(b"01234567A"), s)
Guido van Rossum01a27522007-03-07 01:00:12 +00001175
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001176 def test_write_and_rewind(self):
1177 raw = io.BytesIO()
1178 bufio = self.tp(raw, 4)
1179 self.assertEqual(bufio.write(b"abcdef"), 6)
1180 self.assertEqual(bufio.tell(), 6)
1181 bufio.seek(0, 0)
1182 self.assertEqual(bufio.write(b"XY"), 2)
1183 bufio.seek(6, 0)
1184 self.assertEqual(raw.getvalue(), b"XYcdef")
1185 self.assertEqual(bufio.write(b"123456"), 6)
1186 bufio.flush()
1187 self.assertEqual(raw.getvalue(), b"XYcdef123456")
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001188
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001189 def test_flush(self):
1190 writer = self.MockRawIO()
1191 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001192 bufio.write(b"abc")
1193 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001194 self.assertEqual(b"abc", writer._write_stack[0])
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001195
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001196 def test_destructor(self):
1197 writer = self.MockRawIO()
1198 bufio = self.tp(writer, 8)
1199 bufio.write(b"abc")
1200 del bufio
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001201 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001202 self.assertEqual(b"abc", writer._write_stack[0])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001203
1204 def test_truncate(self):
1205 # Truncate implicitly flushes the buffer.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001206 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001207 bufio = self.tp(raw, 8)
1208 bufio.write(b"abcdef")
1209 self.assertEqual(bufio.truncate(3), 3)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001210 self.assertEqual(bufio.tell(), 6)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001211 with self.open(support.TESTFN, "rb", buffering=0) as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001212 self.assertEqual(f.read(), b"abc")
1213
Victor Stinner45df8202010-04-28 22:31:17 +00001214 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +00001215 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001216 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +00001217 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001218 # Write out many bytes from many threads and test they were
1219 # all flushed.
1220 N = 1000
1221 contents = bytes(range(256)) * N
1222 sizes = cycle([1, 19])
1223 n = 0
1224 queue = deque()
1225 while n < len(contents):
1226 size = next(sizes)
1227 queue.append(contents[n:n+size])
1228 n += size
1229 del contents
Antoine Pitrou87695762008-08-14 22:44:29 +00001230 # We use a real file object because it allows us to
1231 # exercise situations where the GIL is released before
1232 # writing the buffer to the raw streams. This is in addition
1233 # to concurrency issues due to switching threads in the middle
1234 # of Python code.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001235 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001236 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +00001237 errors = []
1238 def f():
1239 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001240 while True:
1241 try:
1242 s = queue.popleft()
1243 except IndexError:
1244 return
Antoine Pitrou87695762008-08-14 22:44:29 +00001245 bufio.write(s)
1246 except Exception as e:
1247 errors.append(e)
1248 raise
1249 threads = [threading.Thread(target=f) for x in range(20)]
1250 for t in threads:
1251 t.start()
1252 time.sleep(0.02) # yield
1253 for t in threads:
1254 t.join()
1255 self.assertFalse(errors,
1256 "the following exceptions were caught: %r" % errors)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001257 bufio.close()
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001258 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001259 s = f.read()
1260 for i in range(256):
Ezio Melottib3aedd42010-11-20 19:04:17 +00001261 self.assertEqual(s.count(bytes([i])), N)
Antoine Pitrou87695762008-08-14 22:44:29 +00001262 finally:
1263 support.unlink(support.TESTFN)
1264
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001265 def test_misbehaved_io(self):
1266 rawio = self.MisbehavedRawIO()
1267 bufio = self.tp(rawio, 5)
1268 self.assertRaises(IOError, bufio.seek, 0)
1269 self.assertRaises(IOError, bufio.tell)
1270 self.assertRaises(IOError, bufio.write, b"abcdef")
1271
Florent Xicluna109d5732012-07-07 17:03:22 +02001272 def test_max_buffer_size_removal(self):
1273 with self.assertRaises(TypeError):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001274 self.tp(self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001275
1276
Antoine Pitrou10f0c502012-07-29 19:02:46 +02001277class CBufferedWriterTest(BufferedWriterTest, SizeofTest):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001278 tp = io.BufferedWriter
1279
1280 def test_constructor(self):
1281 BufferedWriterTest.test_constructor(self)
1282 # The allocation can succeed on 32-bit builds, e.g. with more
1283 # than 2GB RAM and a 64-bit kernel.
1284 if sys.maxsize > 0x7FFFFFFF:
1285 rawio = self.MockRawIO()
1286 bufio = self.tp(rawio)
1287 self.assertRaises((OverflowError, MemoryError, ValueError),
1288 bufio.__init__, rawio, sys.maxsize)
1289
1290 def test_initialization(self):
1291 rawio = self.MockRawIO()
1292 bufio = self.tp(rawio)
1293 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1294 self.assertRaises(ValueError, bufio.write, b"def")
1295 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1296 self.assertRaises(ValueError, bufio.write, b"def")
1297 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1298 self.assertRaises(ValueError, bufio.write, b"def")
1299
1300 def test_garbage_collection(self):
1301 # C BufferedWriter objects are collected, and collecting them flushes
1302 # all data to disk.
1303 # The Python version has __del__, so it ends into gc.garbage instead
1304 rawio = self.FileIO(support.TESTFN, "w+b")
1305 f = self.tp(rawio)
1306 f.write(b"123xxx")
1307 f.x = f
1308 wr = weakref.ref(f)
1309 del f
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001310 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001311 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001312 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001313 self.assertEqual(f.read(), b"123xxx")
1314
1315
1316class PyBufferedWriterTest(BufferedWriterTest):
1317 tp = pyio.BufferedWriter
Guido van Rossuma9e20242007-03-08 00:43:48 +00001318
Guido van Rossum01a27522007-03-07 01:00:12 +00001319class BufferedRWPairTest(unittest.TestCase):
Guido van Rossuma9e20242007-03-08 00:43:48 +00001320
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001321 def test_constructor(self):
1322 pair = self.tp(self.MockRawIO(), self.MockRawIO())
Benjamin Peterson92035012008-12-27 16:00:54 +00001323 self.assertFalse(pair.closed)
Guido van Rossum01a27522007-03-07 01:00:12 +00001324
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001325 def test_detach(self):
1326 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1327 self.assertRaises(self.UnsupportedOperation, pair.detach)
1328
Florent Xicluna109d5732012-07-07 17:03:22 +02001329 def test_constructor_max_buffer_size_removal(self):
1330 with self.assertRaises(TypeError):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001331 self.tp(self.MockRawIO(), self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001332
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001333 def test_constructor_with_not_readable(self):
1334 class NotReadable(MockRawIO):
1335 def readable(self):
1336 return False
1337
1338 self.assertRaises(IOError, self.tp, NotReadable(), self.MockRawIO())
1339
1340 def test_constructor_with_not_writeable(self):
1341 class NotWriteable(MockRawIO):
1342 def writable(self):
1343 return False
1344
1345 self.assertRaises(IOError, self.tp, self.MockRawIO(), NotWriteable())
1346
1347 def test_read(self):
1348 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1349
1350 self.assertEqual(pair.read(3), b"abc")
1351 self.assertEqual(pair.read(1), b"d")
1352 self.assertEqual(pair.read(), b"ef")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00001353 pair = self.tp(self.BytesIO(b"abc"), self.MockRawIO())
1354 self.assertEqual(pair.read(None), b"abc")
1355
1356 def test_readlines(self):
1357 pair = lambda: self.tp(self.BytesIO(b"abc\ndef\nh"), self.MockRawIO())
1358 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1359 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1360 self.assertEqual(pair().readlines(5), [b"abc\n", b"def\n"])
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001361
1362 def test_read1(self):
1363 # .read1() is delegated to the underlying reader object, so this test
1364 # can be shallow.
1365 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1366
1367 self.assertEqual(pair.read1(3), b"abc")
1368
1369 def test_readinto(self):
1370 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1371
1372 data = bytearray(5)
1373 self.assertEqual(pair.readinto(data), 5)
1374 self.assertEqual(data, b"abcde")
1375
1376 def test_write(self):
1377 w = self.MockRawIO()
1378 pair = self.tp(self.MockRawIO(), w)
1379
1380 pair.write(b"abc")
1381 pair.flush()
1382 pair.write(b"def")
1383 pair.flush()
1384 self.assertEqual(w._write_stack, [b"abc", b"def"])
1385
1386 def test_peek(self):
1387 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1388
1389 self.assertTrue(pair.peek(3).startswith(b"abc"))
1390 self.assertEqual(pair.read(3), b"abc")
1391
1392 def test_readable(self):
1393 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1394 self.assertTrue(pair.readable())
1395
1396 def test_writeable(self):
1397 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1398 self.assertTrue(pair.writable())
1399
1400 def test_seekable(self):
1401 # BufferedRWPairs are never seekable, even if their readers and writers
1402 # are.
1403 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1404 self.assertFalse(pair.seekable())
1405
1406 # .flush() is delegated to the underlying writer object and has been
1407 # tested in the test_write method.
1408
1409 def test_close_and_closed(self):
1410 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1411 self.assertFalse(pair.closed)
1412 pair.close()
1413 self.assertTrue(pair.closed)
1414
1415 def test_isatty(self):
1416 class SelectableIsAtty(MockRawIO):
1417 def __init__(self, isatty):
1418 MockRawIO.__init__(self)
1419 self._isatty = isatty
1420
1421 def isatty(self):
1422 return self._isatty
1423
1424 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(False))
1425 self.assertFalse(pair.isatty())
1426
1427 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(False))
1428 self.assertTrue(pair.isatty())
1429
1430 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(True))
1431 self.assertTrue(pair.isatty())
1432
1433 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(True))
1434 self.assertTrue(pair.isatty())
Guido van Rossum01a27522007-03-07 01:00:12 +00001435
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001436class CBufferedRWPairTest(BufferedRWPairTest):
1437 tp = io.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001438
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001439class PyBufferedRWPairTest(BufferedRWPairTest):
1440 tp = pyio.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001441
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001442
1443class BufferedRandomTest(BufferedReaderTest, BufferedWriterTest):
1444 read_mode = "rb+"
1445 write_mode = "wb+"
1446
1447 def test_constructor(self):
1448 BufferedReaderTest.test_constructor(self)
1449 BufferedWriterTest.test_constructor(self)
1450
1451 def test_read_and_write(self):
1452 raw = self.MockRawIO((b"asdf", b"ghjk"))
Benjamin Peterson59406a92009-03-26 17:10:29 +00001453 rw = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001454
1455 self.assertEqual(b"as", rw.read(2))
1456 rw.write(b"ddd")
1457 rw.write(b"eee")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001458 self.assertFalse(raw._write_stack) # Buffer writes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001459 self.assertEqual(b"ghjk", rw.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +00001460 self.assertEqual(b"dddeee", raw._write_stack[0])
Guido van Rossum01a27522007-03-07 01:00:12 +00001461
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001462 def test_seek_and_tell(self):
1463 raw = self.BytesIO(b"asdfghjkl")
1464 rw = self.tp(raw)
Guido van Rossum01a27522007-03-07 01:00:12 +00001465
Ezio Melottib3aedd42010-11-20 19:04:17 +00001466 self.assertEqual(b"as", rw.read(2))
1467 self.assertEqual(2, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001468 rw.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001469 self.assertEqual(b"asdf", rw.read(4))
Guido van Rossum01a27522007-03-07 01:00:12 +00001470
Antoine Pitroue05565e2011-08-20 14:39:23 +02001471 rw.write(b"123f")
Guido van Rossum01a27522007-03-07 01:00:12 +00001472 rw.seek(0, 0)
Antoine Pitroue05565e2011-08-20 14:39:23 +02001473 self.assertEqual(b"asdf123fl", rw.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +00001474 self.assertEqual(9, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001475 rw.seek(-4, 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001476 self.assertEqual(5, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001477 rw.seek(2, 1)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001478 self.assertEqual(7, rw.tell())
1479 self.assertEqual(b"fl", rw.read(11))
Antoine Pitroue05565e2011-08-20 14:39:23 +02001480 rw.flush()
1481 self.assertEqual(b"asdf123fl", raw.getvalue())
1482
Christian Heimes8e42a0a2007-11-08 18:04:45 +00001483 self.assertRaises(TypeError, rw.seek, 0.0)
Guido van Rossum01a27522007-03-07 01:00:12 +00001484
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001485 def check_flush_and_read(self, read_func):
1486 raw = self.BytesIO(b"abcdefghi")
1487 bufio = self.tp(raw)
1488
Ezio Melottib3aedd42010-11-20 19:04:17 +00001489 self.assertEqual(b"ab", read_func(bufio, 2))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001490 bufio.write(b"12")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001491 self.assertEqual(b"ef", read_func(bufio, 2))
1492 self.assertEqual(6, bufio.tell())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001493 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001494 self.assertEqual(6, bufio.tell())
1495 self.assertEqual(b"ghi", read_func(bufio))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001496 raw.seek(0, 0)
1497 raw.write(b"XYZ")
1498 # flush() resets the read buffer
1499 bufio.flush()
1500 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001501 self.assertEqual(b"XYZ", read_func(bufio, 3))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001502
1503 def test_flush_and_read(self):
1504 self.check_flush_and_read(lambda bufio, *args: bufio.read(*args))
1505
1506 def test_flush_and_readinto(self):
1507 def _readinto(bufio, n=-1):
1508 b = bytearray(n if n >= 0 else 9999)
1509 n = bufio.readinto(b)
1510 return bytes(b[:n])
1511 self.check_flush_and_read(_readinto)
1512
1513 def test_flush_and_peek(self):
1514 def _peek(bufio, n=-1):
1515 # This relies on the fact that the buffer can contain the whole
1516 # raw stream, otherwise peek() can return less.
1517 b = bufio.peek(n)
1518 if n != -1:
1519 b = b[:n]
1520 bufio.seek(len(b), 1)
1521 return b
1522 self.check_flush_and_read(_peek)
1523
1524 def test_flush_and_write(self):
1525 raw = self.BytesIO(b"abcdefghi")
1526 bufio = self.tp(raw)
1527
1528 bufio.write(b"123")
1529 bufio.flush()
1530 bufio.write(b"45")
1531 bufio.flush()
1532 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001533 self.assertEqual(b"12345fghi", raw.getvalue())
1534 self.assertEqual(b"12345fghi", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001535
1536 def test_threads(self):
1537 BufferedReaderTest.test_threads(self)
1538 BufferedWriterTest.test_threads(self)
1539
1540 def test_writes_and_peek(self):
1541 def _peek(bufio):
1542 bufio.peek(1)
1543 self.check_writes(_peek)
1544 def _peek(bufio):
1545 pos = bufio.tell()
1546 bufio.seek(-1, 1)
1547 bufio.peek(1)
1548 bufio.seek(pos, 0)
1549 self.check_writes(_peek)
1550
1551 def test_writes_and_reads(self):
1552 def _read(bufio):
1553 bufio.seek(-1, 1)
1554 bufio.read(1)
1555 self.check_writes(_read)
1556
1557 def test_writes_and_read1s(self):
1558 def _read1(bufio):
1559 bufio.seek(-1, 1)
1560 bufio.read1(1)
1561 self.check_writes(_read1)
1562
1563 def test_writes_and_readintos(self):
1564 def _read(bufio):
1565 bufio.seek(-1, 1)
1566 bufio.readinto(bytearray(1))
1567 self.check_writes(_read)
1568
Antoine Pitroua0ceb732009-08-06 20:29:56 +00001569 def test_write_after_readahead(self):
1570 # Issue #6629: writing after the buffer was filled by readahead should
1571 # first rewind the raw stream.
1572 for overwrite_size in [1, 5]:
1573 raw = self.BytesIO(b"A" * 10)
1574 bufio = self.tp(raw, 4)
1575 # Trigger readahead
1576 self.assertEqual(bufio.read(1), b"A")
1577 self.assertEqual(bufio.tell(), 1)
1578 # Overwriting should rewind the raw stream if it needs so
1579 bufio.write(b"B" * overwrite_size)
1580 self.assertEqual(bufio.tell(), overwrite_size + 1)
1581 # If the write size was smaller than the buffer size, flush() and
1582 # check that rewind happens.
1583 bufio.flush()
1584 self.assertEqual(bufio.tell(), overwrite_size + 1)
1585 s = raw.getvalue()
1586 self.assertEqual(s,
1587 b"A" + b"B" * overwrite_size + b"A" * (9 - overwrite_size))
1588
Antoine Pitrou7c404892011-05-13 00:13:33 +02001589 def test_write_rewind_write(self):
1590 # Various combinations of reading / writing / seeking backwards / writing again
1591 def mutate(bufio, pos1, pos2):
1592 assert pos2 >= pos1
1593 # Fill the buffer
1594 bufio.seek(pos1)
1595 bufio.read(pos2 - pos1)
1596 bufio.write(b'\x02')
1597 # This writes earlier than the previous write, but still inside
1598 # the buffer.
1599 bufio.seek(pos1)
1600 bufio.write(b'\x01')
1601
1602 b = b"\x80\x81\x82\x83\x84"
1603 for i in range(0, len(b)):
1604 for j in range(i, len(b)):
1605 raw = self.BytesIO(b)
1606 bufio = self.tp(raw, 100)
1607 mutate(bufio, i, j)
1608 bufio.flush()
1609 expected = bytearray(b)
1610 expected[j] = 2
1611 expected[i] = 1
1612 self.assertEqual(raw.getvalue(), expected,
1613 "failed result for i=%d, j=%d" % (i, j))
1614
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001615 def test_truncate_after_read_or_write(self):
1616 raw = self.BytesIO(b"A" * 10)
1617 bufio = self.tp(raw, 100)
1618 self.assertEqual(bufio.read(2), b"AA") # the read buffer gets filled
1619 self.assertEqual(bufio.truncate(), 2)
1620 self.assertEqual(bufio.write(b"BB"), 2) # the write buffer increases
1621 self.assertEqual(bufio.truncate(), 4)
1622
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001623 def test_misbehaved_io(self):
1624 BufferedReaderTest.test_misbehaved_io(self)
1625 BufferedWriterTest.test_misbehaved_io(self)
1626
Antoine Pitroue05565e2011-08-20 14:39:23 +02001627 def test_interleaved_read_write(self):
1628 # Test for issue #12213
1629 with self.BytesIO(b'abcdefgh') as raw:
1630 with self.tp(raw, 100) as f:
1631 f.write(b"1")
1632 self.assertEqual(f.read(1), b'b')
1633 f.write(b'2')
1634 self.assertEqual(f.read1(1), b'd')
1635 f.write(b'3')
1636 buf = bytearray(1)
1637 f.readinto(buf)
1638 self.assertEqual(buf, b'f')
1639 f.write(b'4')
1640 self.assertEqual(f.peek(1), b'h')
1641 f.flush()
1642 self.assertEqual(raw.getvalue(), b'1b2d3f4h')
1643
1644 with self.BytesIO(b'abc') as raw:
1645 with self.tp(raw, 100) as f:
1646 self.assertEqual(f.read(1), b'a')
1647 f.write(b"2")
1648 self.assertEqual(f.read(1), b'c')
1649 f.flush()
1650 self.assertEqual(raw.getvalue(), b'a2c')
1651
1652 def test_interleaved_readline_write(self):
1653 with self.BytesIO(b'ab\ncdef\ng\n') as raw:
1654 with self.tp(raw) as f:
1655 f.write(b'1')
1656 self.assertEqual(f.readline(), b'b\n')
1657 f.write(b'2')
1658 self.assertEqual(f.readline(), b'def\n')
1659 f.write(b'3')
1660 self.assertEqual(f.readline(), b'\n')
1661 f.flush()
1662 self.assertEqual(raw.getvalue(), b'1b\n2def\n3\n')
1663
Antoine Pitrou0d739d72010-09-05 23:01:12 +00001664 # You can't construct a BufferedRandom over a non-seekable stream.
1665 test_unseekable = None
1666
Antoine Pitrou10f0c502012-07-29 19:02:46 +02001667class CBufferedRandomTest(BufferedRandomTest, SizeofTest):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001668 tp = io.BufferedRandom
1669
1670 def test_constructor(self):
1671 BufferedRandomTest.test_constructor(self)
1672 # The allocation can succeed on 32-bit builds, e.g. with more
1673 # than 2GB RAM and a 64-bit kernel.
1674 if sys.maxsize > 0x7FFFFFFF:
1675 rawio = self.MockRawIO()
1676 bufio = self.tp(rawio)
1677 self.assertRaises((OverflowError, MemoryError, ValueError),
1678 bufio.__init__, rawio, sys.maxsize)
1679
1680 def test_garbage_collection(self):
1681 CBufferedReaderTest.test_garbage_collection(self)
1682 CBufferedWriterTest.test_garbage_collection(self)
1683
1684class PyBufferedRandomTest(BufferedRandomTest):
1685 tp = pyio.BufferedRandom
1686
1687
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001688# To fully exercise seek/tell, the StatefulIncrementalDecoder has these
1689# properties:
1690# - A single output character can correspond to many bytes of input.
1691# - The number of input bytes to complete the character can be
1692# undetermined until the last input byte is received.
1693# - The number of input bytes can vary depending on previous input.
1694# - A single input byte can correspond to many characters of output.
1695# - The number of output characters can be undetermined until the
1696# last input byte is received.
1697# - The number of output characters can vary depending on previous input.
1698
1699class StatefulIncrementalDecoder(codecs.IncrementalDecoder):
1700 """
1701 For testing seek/tell behavior with a stateful, buffering decoder.
1702
1703 Input is a sequence of words. Words may be fixed-length (length set
1704 by input) or variable-length (period-terminated). In variable-length
1705 mode, extra periods are ignored. Possible words are:
1706 - 'i' followed by a number sets the input length, I (maximum 99).
1707 When I is set to 0, words are space-terminated.
1708 - 'o' followed by a number sets the output length, O (maximum 99).
1709 - Any other word is converted into a word followed by a period on
1710 the output. The output word consists of the input word truncated
1711 or padded out with hyphens to make its length equal to O. If O
1712 is 0, the word is output verbatim without truncating or padding.
1713 I and O are initially set to 1. When I changes, any buffered input is
1714 re-scanned according to the new I. EOF also terminates the last word.
1715 """
1716
1717 def __init__(self, errors='strict'):
Christian Heimesab568872008-03-23 02:11:13 +00001718 codecs.IncrementalDecoder.__init__(self, errors)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001719 self.reset()
1720
1721 def __repr__(self):
1722 return '<SID %x>' % id(self)
1723
1724 def reset(self):
1725 self.i = 1
1726 self.o = 1
1727 self.buffer = bytearray()
1728
1729 def getstate(self):
1730 i, o = self.i ^ 1, self.o ^ 1 # so that flags = 0 after reset()
1731 return bytes(self.buffer), i*100 + o
1732
1733 def setstate(self, state):
1734 buffer, io = state
1735 self.buffer = bytearray(buffer)
1736 i, o = divmod(io, 100)
1737 self.i, self.o = i ^ 1, o ^ 1
1738
1739 def decode(self, input, final=False):
1740 output = ''
1741 for b in input:
1742 if self.i == 0: # variable-length, terminated with period
1743 if b == ord('.'):
1744 if self.buffer:
1745 output += self.process_word()
1746 else:
1747 self.buffer.append(b)
1748 else: # fixed-length, terminate after self.i bytes
1749 self.buffer.append(b)
1750 if len(self.buffer) == self.i:
1751 output += self.process_word()
1752 if final and self.buffer: # EOF terminates the last word
1753 output += self.process_word()
1754 return output
1755
1756 def process_word(self):
1757 output = ''
1758 if self.buffer[0] == ord('i'):
1759 self.i = min(99, int(self.buffer[1:] or 0)) # set input length
1760 elif self.buffer[0] == ord('o'):
1761 self.o = min(99, int(self.buffer[1:] or 0)) # set output length
1762 else:
1763 output = self.buffer.decode('ascii')
1764 if len(output) < self.o:
1765 output += '-'*self.o # pad out with hyphens
1766 if self.o:
1767 output = output[:self.o] # truncate to output length
1768 output += '.'
1769 self.buffer = bytearray()
1770 return output
1771
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001772 codecEnabled = False
1773
1774 @classmethod
1775 def lookupTestDecoder(cls, name):
1776 if cls.codecEnabled and name == 'test_decoder':
Antoine Pitrou180a3362008-12-14 16:36:46 +00001777 latin1 = codecs.lookup('latin-1')
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001778 return codecs.CodecInfo(
Antoine Pitrou180a3362008-12-14 16:36:46 +00001779 name='test_decoder', encode=latin1.encode, decode=None,
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001780 incrementalencoder=None,
1781 streamreader=None, streamwriter=None,
1782 incrementaldecoder=cls)
1783
1784# Register the previous decoder for testing.
1785# Disabled by default, tests will enable it.
1786codecs.register(StatefulIncrementalDecoder.lookupTestDecoder)
1787
1788
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001789class StatefulIncrementalDecoderTest(unittest.TestCase):
1790 """
1791 Make sure the StatefulIncrementalDecoder actually works.
1792 """
1793
1794 test_cases = [
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001795 # I=1, O=1 (fixed-length input == fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001796 (b'abcd', False, 'a.b.c.d.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001797 # I=0, O=0 (variable-length input, variable-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001798 (b'oiabcd', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001799 # I=0, O=0 (should ignore extra periods)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001800 (b'oi...abcd...', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001801 # I=0, O=6 (variable-length input, fixed-length output)
1802 (b'i.o6.x.xyz.toolongtofit.', False, 'x-----.xyz---.toolon.'),
1803 # I=2, O=6 (fixed-length input < fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001804 (b'i.i2.o6xyz', True, 'xy----.z-----.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001805 # I=6, O=3 (fixed-length input > fixed-length output)
1806 (b'i.o3.i6.abcdefghijklmnop', True, 'abc.ghi.mno.'),
1807 # I=0, then 3; O=29, then 15 (with longer output)
1808 (b'i.o29.a.b.cde.o15.abcdefghijabcdefghij.i3.a.b.c.d.ei00k.l.m', True,
1809 'a----------------------------.' +
1810 'b----------------------------.' +
1811 'cde--------------------------.' +
1812 'abcdefghijabcde.' +
1813 'a.b------------.' +
1814 '.c.------------.' +
1815 'd.e------------.' +
1816 'k--------------.' +
1817 'l--------------.' +
1818 'm--------------.')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001819 ]
1820
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001821 def test_decoder(self):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001822 # Try a few one-shot test cases.
1823 for input, eof, output in self.test_cases:
1824 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001825 self.assertEqual(d.decode(input, eof), output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001826
1827 # Also test an unfinished decode, followed by forcing EOF.
1828 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001829 self.assertEqual(d.decode(b'oiabcd'), '')
1830 self.assertEqual(d.decode(b'', 1), 'abcd.')
Guido van Rossum78892e42007-04-06 17:31:18 +00001831
1832class TextIOWrapperTest(unittest.TestCase):
Guido van Rossum9b76da62007-04-11 01:09:03 +00001833
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001834 def setUp(self):
1835 self.testdata = b"AAA\r\nBBB\rCCC\r\nDDD\nEEE\r\n"
1836 self.normalized = b"AAA\nBBB\nCCC\nDDD\nEEE\n".decode("ascii")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001837 support.unlink(support.TESTFN)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001838
Guido van Rossumd0712812007-04-11 16:32:43 +00001839 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001840 support.unlink(support.TESTFN)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001841
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001842 def test_constructor(self):
1843 r = self.BytesIO(b"\xc3\xa9\n\n")
1844 b = self.BufferedReader(r, 1000)
1845 t = self.TextIOWrapper(b)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001846 t.__init__(b, encoding="latin-1", newline="\r\n")
1847 self.assertEqual(t.encoding, "latin-1")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001848 self.assertEqual(t.line_buffering, False)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001849 t.__init__(b, encoding="utf-8", line_buffering=True)
1850 self.assertEqual(t.encoding, "utf-8")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001851 self.assertEqual(t.line_buffering, True)
1852 self.assertEqual("\xe9\n", t.readline())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001853 self.assertRaises(TypeError, t.__init__, b, newline=42)
1854 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
1855
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001856 def test_detach(self):
1857 r = self.BytesIO()
1858 b = self.BufferedWriter(r)
1859 t = self.TextIOWrapper(b)
1860 self.assertIs(t.detach(), b)
1861
1862 t = self.TextIOWrapper(b, encoding="ascii")
1863 t.write("howdy")
1864 self.assertFalse(r.getvalue())
1865 t.detach()
1866 self.assertEqual(r.getvalue(), b"howdy")
1867 self.assertRaises(ValueError, t.detach)
1868
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001869 def test_repr(self):
1870 raw = self.BytesIO("hello".encode("utf-8"))
1871 b = self.BufferedReader(raw)
1872 t = self.TextIOWrapper(b, encoding="utf-8")
Antoine Pitrou716c4442009-05-23 19:04:03 +00001873 modname = self.TextIOWrapper.__module__
1874 self.assertEqual(repr(t),
1875 "<%s.TextIOWrapper encoding='utf-8'>" % modname)
1876 raw.name = "dummy"
1877 self.assertEqual(repr(t),
1878 "<%s.TextIOWrapper name='dummy' encoding='utf-8'>" % modname)
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001879 t.mode = "r"
1880 self.assertEqual(repr(t),
1881 "<%s.TextIOWrapper name='dummy' mode='r' encoding='utf-8'>" % modname)
Antoine Pitrou716c4442009-05-23 19:04:03 +00001882 raw.name = b"dummy"
1883 self.assertEqual(repr(t),
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001884 "<%s.TextIOWrapper name=b'dummy' mode='r' encoding='utf-8'>" % modname)
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001885
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001886 def test_line_buffering(self):
1887 r = self.BytesIO()
1888 b = self.BufferedWriter(r, 1000)
1889 t = self.TextIOWrapper(b, newline="\n", line_buffering=True)
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001890 t.write("X")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001891 self.assertEqual(r.getvalue(), b"") # No flush happened
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001892 t.write("Y\nZ")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001893 self.assertEqual(r.getvalue(), b"XY\nZ") # All got flushed
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001894 t.write("A\rB")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001895 self.assertEqual(r.getvalue(), b"XY\nZA\rB")
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001896
Victor Stinnerf86a5e82012-06-05 13:43:22 +02001897 def test_default_encoding(self):
1898 old_environ = dict(os.environ)
1899 try:
1900 # try to get a user preferred encoding different than the current
1901 # locale encoding to check that TextIOWrapper() uses the current
1902 # locale encoding and not the user preferred encoding
1903 for key in ('LC_ALL', 'LANG', 'LC_CTYPE'):
1904 if key in os.environ:
1905 del os.environ[key]
1906
1907 current_locale_encoding = locale.getpreferredencoding(False)
1908 b = self.BytesIO()
1909 t = self.TextIOWrapper(b)
1910 self.assertEqual(t.encoding, current_locale_encoding)
1911 finally:
1912 os.environ.clear()
1913 os.environ.update(old_environ)
1914
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001915 def test_encoding(self):
1916 # Check the encoding attribute is always set, and valid
1917 b = self.BytesIO()
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001918 t = self.TextIOWrapper(b, encoding="utf-8")
1919 self.assertEqual(t.encoding, "utf-8")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001920 t = self.TextIOWrapper(b)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001921 self.assertTrue(t.encoding is not None)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001922 codecs.lookup(t.encoding)
1923
1924 def test_encoding_errors_reading(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001925 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001926 b = self.BytesIO(b"abc\n\xff\n")
1927 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001928 self.assertRaises(UnicodeError, t.read)
1929 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001930 b = self.BytesIO(b"abc\n\xff\n")
1931 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001932 self.assertRaises(UnicodeError, t.read)
1933 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001934 b = self.BytesIO(b"abc\n\xff\n")
1935 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001936 self.assertEqual(t.read(), "abc\n\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001937 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001938 b = self.BytesIO(b"abc\n\xff\n")
1939 t = self.TextIOWrapper(b, encoding="ascii", errors="replace")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001940 self.assertEqual(t.read(), "abc\n\ufffd\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001941
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001942 def test_encoding_errors_writing(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001943 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001944 b = self.BytesIO()
1945 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001946 self.assertRaises(UnicodeError, t.write, "\xff")
1947 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001948 b = self.BytesIO()
1949 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001950 self.assertRaises(UnicodeError, t.write, "\xff")
1951 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001952 b = self.BytesIO()
1953 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001954 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001955 t.write("abc\xffdef\n")
1956 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001957 self.assertEqual(b.getvalue(), b"abcdef\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001958 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001959 b = self.BytesIO()
1960 t = self.TextIOWrapper(b, encoding="ascii", errors="replace",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001961 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001962 t.write("abc\xffdef\n")
1963 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001964 self.assertEqual(b.getvalue(), b"abc?def\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001965
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001966 def test_newlines(self):
Guido van Rossum78892e42007-04-06 17:31:18 +00001967 input_lines = [ "unix\n", "windows\r\n", "os9\r", "last\n", "nonl" ]
1968
1969 tests = [
1970 [ None, [ 'unix\n', 'windows\n', 'os9\n', 'last\n', 'nonl' ] ],
Guido van Rossum8358db22007-08-18 21:39:55 +00001971 [ '', input_lines ],
1972 [ '\n', [ "unix\n", "windows\r\n", "os9\rlast\n", "nonl" ] ],
1973 [ '\r\n', [ "unix\nwindows\r\n", "os9\rlast\nnonl" ] ],
1974 [ '\r', [ "unix\nwindows\r", "\nos9\r", "last\nnonl" ] ],
Guido van Rossum78892e42007-04-06 17:31:18 +00001975 ]
Antoine Pitrou180a3362008-12-14 16:36:46 +00001976 encodings = (
1977 'utf-8', 'latin-1',
1978 'utf-16', 'utf-16-le', 'utf-16-be',
1979 'utf-32', 'utf-32-le', 'utf-32-be',
1980 )
Guido van Rossum78892e42007-04-06 17:31:18 +00001981
Guido van Rossum8358db22007-08-18 21:39:55 +00001982 # Try a range of buffer sizes to test the case where \r is the last
Guido van Rossum78892e42007-04-06 17:31:18 +00001983 # character in TextIOWrapper._pending_line.
1984 for encoding in encodings:
Guido van Rossum8358db22007-08-18 21:39:55 +00001985 # XXX: str.encode() should return bytes
1986 data = bytes(''.join(input_lines).encode(encoding))
Guido van Rossum78892e42007-04-06 17:31:18 +00001987 for do_reads in (False, True):
Guido van Rossum8358db22007-08-18 21:39:55 +00001988 for bufsize in range(1, 10):
1989 for newline, exp_lines in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001990 bufio = self.BufferedReader(self.BytesIO(data), bufsize)
1991 textio = self.TextIOWrapper(bufio, newline=newline,
Guido van Rossum78892e42007-04-06 17:31:18 +00001992 encoding=encoding)
1993 if do_reads:
1994 got_lines = []
1995 while True:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001996 c2 = textio.read(2)
Guido van Rossum78892e42007-04-06 17:31:18 +00001997 if c2 == '':
1998 break
Ezio Melottib3aedd42010-11-20 19:04:17 +00001999 self.assertEqual(len(c2), 2)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00002000 got_lines.append(c2 + textio.readline())
Guido van Rossum78892e42007-04-06 17:31:18 +00002001 else:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00002002 got_lines = list(textio)
Guido van Rossum78892e42007-04-06 17:31:18 +00002003
2004 for got_line, exp_line in zip(got_lines, exp_lines):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002005 self.assertEqual(got_line, exp_line)
2006 self.assertEqual(len(got_lines), len(exp_lines))
Guido van Rossum78892e42007-04-06 17:31:18 +00002007
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002008 def test_newlines_input(self):
2009 testdata = b"AAA\nBB\x00B\nCCC\rDDD\rEEE\r\nFFF\r\nGGG"
Guido van Rossum8358db22007-08-18 21:39:55 +00002010 normalized = testdata.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
2011 for newline, expected in [
Ezio Melottid8b509b2011-09-28 17:37:55 +03002012 (None, normalized.decode("ascii").splitlines(keepends=True)),
2013 ("", testdata.decode("ascii").splitlines(keepends=True)),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002014 ("\n", ["AAA\n", "BB\x00B\n", "CCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
2015 ("\r\n", ["AAA\nBB\x00B\nCCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
2016 ("\r", ["AAA\nBB\x00B\nCCC\r", "DDD\r", "EEE\r", "\nFFF\r", "\nGGG"]),
Guido van Rossum8358db22007-08-18 21:39:55 +00002017 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002018 buf = self.BytesIO(testdata)
2019 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002020 self.assertEqual(txt.readlines(), expected)
Guido van Rossum8358db22007-08-18 21:39:55 +00002021 txt.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002022 self.assertEqual(txt.read(), "".join(expected))
Guido van Rossum8358db22007-08-18 21:39:55 +00002023
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002024 def test_newlines_output(self):
2025 testdict = {
2026 "": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
2027 "\n": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
2028 "\r": b"AAA\rBBB\rCCC\rX\rY\r\rZ",
2029 "\r\n": b"AAA\r\nBBB\r\nCCC\r\nX\rY\r\r\nZ",
2030 }
2031 tests = [(None, testdict[os.linesep])] + sorted(testdict.items())
2032 for newline, expected in tests:
2033 buf = self.BytesIO()
2034 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
2035 txt.write("AAA\nB")
2036 txt.write("BB\nCCC\n")
2037 txt.write("X\rY\r\nZ")
2038 txt.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002039 self.assertEqual(buf.closed, False)
2040 self.assertEqual(buf.getvalue(), expected)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002041
2042 def test_destructor(self):
2043 l = []
2044 base = self.BytesIO
2045 class MyBytesIO(base):
2046 def close(self):
2047 l.append(self.getvalue())
2048 base.close(self)
2049 b = MyBytesIO()
2050 t = self.TextIOWrapper(b, encoding="ascii")
2051 t.write("abc")
2052 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002053 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002054 self.assertEqual([b"abc"], l)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002055
2056 def test_override_destructor(self):
2057 record = []
2058 class MyTextIO(self.TextIOWrapper):
2059 def __del__(self):
2060 record.append(1)
2061 try:
2062 f = super().__del__
2063 except AttributeError:
2064 pass
2065 else:
2066 f()
2067 def close(self):
2068 record.append(2)
2069 super().close()
2070 def flush(self):
2071 record.append(3)
2072 super().flush()
2073 b = self.BytesIO()
2074 t = MyTextIO(b, encoding="ascii")
2075 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002076 support.gc_collect()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002077 self.assertEqual(record, [1, 2, 3])
2078
2079 def test_error_through_destructor(self):
2080 # Test that the exception state is not modified by a destructor,
2081 # even if close() fails.
2082 rawio = self.CloseFailureIO()
2083 def f():
2084 self.TextIOWrapper(rawio).xyzzy
2085 with support.captured_output("stderr") as s:
2086 self.assertRaises(AttributeError, f)
2087 s = s.getvalue().strip()
2088 if s:
2089 # The destructor *may* have printed an unraisable error, check it
2090 self.assertEqual(len(s.splitlines()), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002091 self.assertTrue(s.startswith("Exception IOError: "), s)
2092 self.assertTrue(s.endswith(" ignored"), s)
Guido van Rossum8358db22007-08-18 21:39:55 +00002093
Guido van Rossum9b76da62007-04-11 01:09:03 +00002094 # Systematic tests of the text I/O API
2095
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002096 def test_basic_io(self):
Guido van Rossum9b76da62007-04-11 01:09:03 +00002097 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 +00002098 for enc in "ascii", "latin-1", "utf-8" :# , "utf-16-be", "utf-16-le":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002099 f = self.open(support.TESTFN, "w+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002100 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00002101 self.assertEqual(f.write("abc"), 3)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002102 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002103 f = self.open(support.TESTFN, "r+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002104 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00002105 self.assertEqual(f.tell(), 0)
2106 self.assertEqual(f.read(), "abc")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002107 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002108 self.assertEqual(f.seek(0), 0)
2109 self.assertEqual(f.read(None), "abc")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00002110 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002111 self.assertEqual(f.read(2), "ab")
2112 self.assertEqual(f.read(1), "c")
2113 self.assertEqual(f.read(1), "")
2114 self.assertEqual(f.read(), "")
2115 self.assertEqual(f.tell(), cookie)
2116 self.assertEqual(f.seek(0), 0)
2117 self.assertEqual(f.seek(0, 2), cookie)
2118 self.assertEqual(f.write("def"), 3)
2119 self.assertEqual(f.seek(cookie), cookie)
2120 self.assertEqual(f.read(), "def")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002121 if enc.startswith("utf"):
2122 self.multi_line_test(f, enc)
2123 f.close()
2124
2125 def multi_line_test(self, f, enc):
2126 f.seek(0)
2127 f.truncate()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002128 sample = "s\xff\u0fff\uffff"
Guido van Rossum9b76da62007-04-11 01:09:03 +00002129 wlines = []
Guido van Rossumcba608c2007-04-11 14:19:59 +00002130 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 +00002131 chars = []
Guido van Rossum805365e2007-05-07 22:24:25 +00002132 for i in range(size):
Guido van Rossum9b76da62007-04-11 01:09:03 +00002133 chars.append(sample[i % len(sample)])
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002134 line = "".join(chars) + "\n"
Guido van Rossum9b76da62007-04-11 01:09:03 +00002135 wlines.append((f.tell(), line))
2136 f.write(line)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002137 f.seek(0)
2138 rlines = []
2139 while True:
2140 pos = f.tell()
2141 line = f.readline()
2142 if not line:
Guido van Rossum9b76da62007-04-11 01:09:03 +00002143 break
2144 rlines.append((pos, line))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002145 self.assertEqual(rlines, wlines)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002146
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002147 def test_telling(self):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00002148 f = self.open(support.TESTFN, "w+", encoding="utf-8")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002149 p0 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002150 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002151 p1 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002152 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002153 p2 = f.tell()
2154 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002155 self.assertEqual(f.tell(), p0)
2156 self.assertEqual(f.readline(), "\xff\n")
2157 self.assertEqual(f.tell(), p1)
2158 self.assertEqual(f.readline(), "\xff\n")
2159 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002160 f.seek(0)
2161 for line in f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002162 self.assertEqual(line, "\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002163 self.assertRaises(IOError, f.tell)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002164 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002165 f.close()
2166
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002167 def test_seeking(self):
2168 chunk_size = _default_chunk_size()
Guido van Rossumd76e7792007-04-17 02:38:04 +00002169 prefix_size = chunk_size - 2
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002170 u_prefix = "a" * prefix_size
Guido van Rossumd76e7792007-04-17 02:38:04 +00002171 prefix = bytes(u_prefix.encode("utf-8"))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002172 self.assertEqual(len(u_prefix), len(prefix))
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002173 u_suffix = "\u8888\n"
Guido van Rossumd76e7792007-04-17 02:38:04 +00002174 suffix = bytes(u_suffix.encode("utf-8"))
2175 line = prefix + suffix
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002176 with self.open(support.TESTFN, "wb") as f:
2177 f.write(line*2)
2178 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2179 s = f.read(prefix_size)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002180 self.assertEqual(s, str(prefix, "ascii"))
2181 self.assertEqual(f.tell(), prefix_size)
2182 self.assertEqual(f.readline(), u_suffix)
Guido van Rossumd76e7792007-04-17 02:38:04 +00002183
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002184 def test_seeking_too(self):
Guido van Rossumd76e7792007-04-17 02:38:04 +00002185 # Regression test for a specific bug
2186 data = b'\xe0\xbf\xbf\n'
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002187 with self.open(support.TESTFN, "wb") as f:
2188 f.write(data)
2189 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2190 f._CHUNK_SIZE # Just test that it exists
2191 f._CHUNK_SIZE = 2
2192 f.readline()
2193 f.tell()
Guido van Rossumd76e7792007-04-17 02:38:04 +00002194
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002195 def test_seek_and_tell(self):
2196 #Test seek/tell using the StatefulIncrementalDecoder.
2197 # Make test faster by doing smaller seeks
2198 CHUNK_SIZE = 128
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002199
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002200 def test_seek_and_tell_with_data(data, min_pos=0):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002201 """Tell/seek to various points within a data stream and ensure
2202 that the decoded data returned by read() is consistent."""
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002203 f = self.open(support.TESTFN, 'wb')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002204 f.write(data)
2205 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002206 f = self.open(support.TESTFN, encoding='test_decoder')
2207 f._CHUNK_SIZE = CHUNK_SIZE
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002208 decoded = f.read()
2209 f.close()
2210
Neal Norwitze2b07052008-03-18 19:52:05 +00002211 for i in range(min_pos, len(decoded) + 1): # seek positions
2212 for j in [1, 5, len(decoded) - i]: # read lengths
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002213 f = self.open(support.TESTFN, encoding='test_decoder')
Ezio Melottib3aedd42010-11-20 19:04:17 +00002214 self.assertEqual(f.read(i), decoded[:i])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002215 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002216 self.assertEqual(f.read(j), decoded[i:i + j])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002217 f.seek(cookie)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002218 self.assertEqual(f.read(), decoded[i:])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002219 f.close()
2220
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002221 # Enable the test decoder.
2222 StatefulIncrementalDecoder.codecEnabled = 1
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002223
2224 # Run the tests.
2225 try:
2226 # Try each test case.
2227 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002228 test_seek_and_tell_with_data(input)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002229
2230 # Position each test case so that it crosses a chunk boundary.
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002231 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
2232 offset = CHUNK_SIZE - len(input)//2
2233 prefix = b'.'*offset
2234 # Don't bother seeking into the prefix (takes too long).
2235 min_pos = offset*2
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002236 test_seek_and_tell_with_data(prefix + input, min_pos)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002237
2238 # Ensure our test decoder won't interfere with subsequent tests.
2239 finally:
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002240 StatefulIncrementalDecoder.codecEnabled = 0
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002241
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002242 def test_encoded_writes(self):
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002243 data = "1234567890"
2244 tests = ("utf-16",
2245 "utf-16-le",
2246 "utf-16-be",
2247 "utf-32",
2248 "utf-32-le",
2249 "utf-32-be")
2250 for encoding in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002251 buf = self.BytesIO()
2252 f = self.TextIOWrapper(buf, encoding=encoding)
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002253 # Check if the BOM is written only once (see issue1753).
2254 f.write(data)
2255 f.write(data)
2256 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002257 self.assertEqual(f.read(), data * 2)
Benjamin Peterson9363a652009-03-05 00:42:09 +00002258 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002259 self.assertEqual(f.read(), data * 2)
2260 self.assertEqual(buf.getvalue(), (data * 2).encode(encoding))
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002261
Benjamin Petersona1b49012009-03-31 23:11:32 +00002262 def test_unreadable(self):
2263 class UnReadable(self.BytesIO):
2264 def readable(self):
2265 return False
2266 txt = self.TextIOWrapper(UnReadable())
2267 self.assertRaises(IOError, txt.read)
2268
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002269 def test_read_one_by_one(self):
2270 txt = self.TextIOWrapper(self.BytesIO(b"AA\r\nBB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002271 reads = ""
2272 while True:
2273 c = txt.read(1)
2274 if not c:
2275 break
2276 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002277 self.assertEqual(reads, "AA\nBB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002278
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00002279 def test_readlines(self):
2280 txt = self.TextIOWrapper(self.BytesIO(b"AA\nBB\nCC"))
2281 self.assertEqual(txt.readlines(), ["AA\n", "BB\n", "CC"])
2282 txt.seek(0)
2283 self.assertEqual(txt.readlines(None), ["AA\n", "BB\n", "CC"])
2284 txt.seek(0)
2285 self.assertEqual(txt.readlines(5), ["AA\n", "BB\n"])
2286
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002287 # read in amounts equal to TextIOWrapper._CHUNK_SIZE which is 128.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002288 def test_read_by_chunk(self):
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002289 # make sure "\r\n" straddles 128 char boundary.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002290 txt = self.TextIOWrapper(self.BytesIO(b"A" * 127 + b"\r\nB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002291 reads = ""
2292 while True:
2293 c = txt.read(128)
2294 if not c:
2295 break
2296 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002297 self.assertEqual(reads, "A"*127+"\nB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002298
2299 def test_issue1395_1(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002300 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002301
2302 # read one char at a time
2303 reads = ""
2304 while True:
2305 c = txt.read(1)
2306 if not c:
2307 break
2308 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002309 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002310
2311 def test_issue1395_2(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002312 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002313 txt._CHUNK_SIZE = 4
2314
2315 reads = ""
2316 while True:
2317 c = txt.read(4)
2318 if not c:
2319 break
2320 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002321 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002322
2323 def test_issue1395_3(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002324 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002325 txt._CHUNK_SIZE = 4
2326
2327 reads = txt.read(4)
2328 reads += txt.read(4)
2329 reads += txt.readline()
2330 reads += txt.readline()
2331 reads += txt.readline()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002332 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002333
2334 def test_issue1395_4(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002335 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002336 txt._CHUNK_SIZE = 4
2337
2338 reads = txt.read(4)
2339 reads += txt.read()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002340 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002341
2342 def test_issue1395_5(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002343 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002344 txt._CHUNK_SIZE = 4
2345
2346 reads = txt.read(4)
2347 pos = txt.tell()
2348 txt.seek(0)
2349 txt.seek(pos)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002350 self.assertEqual(txt.read(4), "BBB\n")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002351
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002352 def test_issue2282(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002353 buffer = self.BytesIO(self.testdata)
2354 txt = self.TextIOWrapper(buffer, encoding="ascii")
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002355
2356 self.assertEqual(buffer.seekable(), txt.seekable())
2357
Antoine Pitroue4501852009-05-14 18:55:55 +00002358 def test_append_bom(self):
2359 # The BOM is not written again when appending to a non-empty file
2360 filename = support.TESTFN
2361 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2362 with self.open(filename, 'w', encoding=charset) as f:
2363 f.write('aaa')
2364 pos = f.tell()
2365 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002366 self.assertEqual(f.read(), 'aaa'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002367
2368 with self.open(filename, 'a', encoding=charset) as f:
2369 f.write('xxx')
2370 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002371 self.assertEqual(f.read(), 'aaaxxx'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002372
2373 def test_seek_bom(self):
2374 # Same test, but when seeking manually
2375 filename = support.TESTFN
2376 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2377 with self.open(filename, 'w', encoding=charset) as f:
2378 f.write('aaa')
2379 pos = f.tell()
2380 with self.open(filename, 'r+', encoding=charset) as f:
2381 f.seek(pos)
2382 f.write('zzz')
2383 f.seek(0)
2384 f.write('bbb')
2385 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002386 self.assertEqual(f.read(), 'bbbzzz'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002387
Benjamin Peterson0926ad12009-06-06 18:02:12 +00002388 def test_errors_property(self):
2389 with self.open(support.TESTFN, "w") as f:
2390 self.assertEqual(f.errors, "strict")
2391 with self.open(support.TESTFN, "w", errors="replace") as f:
2392 self.assertEqual(f.errors, "replace")
2393
Brett Cannon31f59292011-02-21 19:29:56 +00002394 @support.no_tracing
Victor Stinner45df8202010-04-28 22:31:17 +00002395 @unittest.skipUnless(threading, 'Threading required for this test.')
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002396 def test_threads_write(self):
2397 # Issue6750: concurrent writes could duplicate data
2398 event = threading.Event()
2399 with self.open(support.TESTFN, "w", buffering=1) as f:
2400 def run(n):
2401 text = "Thread%03d\n" % n
2402 event.wait()
2403 f.write(text)
2404 threads = [threading.Thread(target=lambda n=x: run(n))
2405 for x in range(20)]
2406 for t in threads:
2407 t.start()
2408 time.sleep(0.02)
2409 event.set()
2410 for t in threads:
2411 t.join()
2412 with self.open(support.TESTFN) as f:
2413 content = f.read()
2414 for n in range(20):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002415 self.assertEqual(content.count("Thread%03d\n" % n), 1)
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002416
Antoine Pitrou6be88762010-05-03 16:48:20 +00002417 def test_flush_error_on_close(self):
2418 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2419 def bad_flush():
2420 raise IOError()
2421 txt.flush = bad_flush
2422 self.assertRaises(IOError, txt.close) # exception not swallowed
2423
2424 def test_multi_close(self):
2425 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2426 txt.close()
2427 txt.close()
2428 txt.close()
2429 self.assertRaises(ValueError, txt.flush)
2430
Antoine Pitrou0d739d72010-09-05 23:01:12 +00002431 def test_unseekable(self):
2432 txt = self.TextIOWrapper(self.MockUnseekableIO(self.testdata))
2433 self.assertRaises(self.UnsupportedOperation, txt.tell)
2434 self.assertRaises(self.UnsupportedOperation, txt.seek, 0)
2435
Antoine Pitrou7f8f4182010-12-21 21:20:59 +00002436 def test_readonly_attributes(self):
2437 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2438 buf = self.BytesIO(self.testdata)
2439 with self.assertRaises(AttributeError):
2440 txt.buffer = buf
2441
Antoine Pitroue96ec682011-07-23 21:46:35 +02002442 def test_rawio(self):
2443 # Issue #12591: TextIOWrapper must work with raw I/O objects, so
2444 # that subprocess.Popen() can have the required unbuffered
2445 # semantics with universal_newlines=True.
2446 raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n'])
2447 txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n')
2448 # Reads
2449 self.assertEqual(txt.read(4), 'abcd')
2450 self.assertEqual(txt.readline(), 'efghi\n')
2451 self.assertEqual(list(txt), ['jkl\n', 'opq\n'])
2452
2453 def test_rawio_write_through(self):
2454 # Issue #12591: with write_through=True, writes don't need a flush
2455 raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n'])
2456 txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n',
2457 write_through=True)
2458 txt.write('1')
2459 txt.write('23\n4')
2460 txt.write('5')
2461 self.assertEqual(b''.join(raw._write_stack), b'123\n45')
2462
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002463class CTextIOWrapperTest(TextIOWrapperTest):
2464
2465 def test_initialization(self):
2466 r = self.BytesIO(b"\xc3\xa9\n\n")
2467 b = self.BufferedReader(r, 1000)
2468 t = self.TextIOWrapper(b)
2469 self.assertRaises(TypeError, t.__init__, b, newline=42)
2470 self.assertRaises(ValueError, t.read)
2471 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
2472 self.assertRaises(ValueError, t.read)
2473
2474 def test_garbage_collection(self):
2475 # C TextIOWrapper objects are collected, and collecting them flushes
2476 # all data to disk.
2477 # The Python version has __del__, so it ends in gc.garbage instead.
2478 rawio = io.FileIO(support.TESTFN, "wb")
2479 b = self.BufferedWriter(rawio)
2480 t = self.TextIOWrapper(b, encoding="ascii")
2481 t.write("456def")
2482 t.x = t
2483 wr = weakref.ref(t)
2484 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002485 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002486 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00002487 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002488 self.assertEqual(f.read(), b"456def")
2489
Charles-François Natali42c28cd2011-10-05 19:53:43 +02002490 def test_rwpair_cleared_before_textio(self):
2491 # Issue 13070: TextIOWrapper's finalization would crash when called
2492 # after the reference to the underlying BufferedRWPair's writer got
2493 # cleared by the GC.
2494 for i in range(1000):
2495 b1 = self.BufferedRWPair(self.MockRawIO(), self.MockRawIO())
2496 t1 = self.TextIOWrapper(b1, encoding="ascii")
2497 b2 = self.BufferedRWPair(self.MockRawIO(), self.MockRawIO())
2498 t2 = self.TextIOWrapper(b2, encoding="ascii")
2499 # circular references
2500 t1.buddy = t2
2501 t2.buddy = t1
2502 support.gc_collect()
2503
2504
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002505class PyTextIOWrapperTest(TextIOWrapperTest):
2506 pass
2507
2508
2509class IncrementalNewlineDecoderTest(unittest.TestCase):
2510
2511 def check_newline_decoding_utf8(self, decoder):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002512 # UTF-8 specific tests for a newline decoder
2513 def _check_decode(b, s, **kwargs):
2514 # We exercise getstate() / setstate() as well as decode()
2515 state = decoder.getstate()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002516 self.assertEqual(decoder.decode(b, **kwargs), s)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002517 decoder.setstate(state)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002518 self.assertEqual(decoder.decode(b, **kwargs), s)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002519
Antoine Pitrou180a3362008-12-14 16:36:46 +00002520 _check_decode(b'\xe8\xa2\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002521
Antoine Pitrou180a3362008-12-14 16:36:46 +00002522 _check_decode(b'\xe8', "")
2523 _check_decode(b'\xa2', "")
2524 _check_decode(b'\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002525
Antoine Pitrou180a3362008-12-14 16:36:46 +00002526 _check_decode(b'\xe8', "")
2527 _check_decode(b'\xa2', "")
2528 _check_decode(b'\x88', "\u8888")
2529
2530 _check_decode(b'\xe8', "")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002531 self.assertRaises(UnicodeDecodeError, decoder.decode, b'', final=True)
2532
Antoine Pitrou180a3362008-12-14 16:36:46 +00002533 decoder.reset()
2534 _check_decode(b'\n', "\n")
2535 _check_decode(b'\r', "")
2536 _check_decode(b'', "\n", final=True)
2537 _check_decode(b'\r', "\n", final=True)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002538
Antoine Pitrou180a3362008-12-14 16:36:46 +00002539 _check_decode(b'\r', "")
2540 _check_decode(b'a', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002541
Antoine Pitrou180a3362008-12-14 16:36:46 +00002542 _check_decode(b'\r\r\n', "\n\n")
2543 _check_decode(b'\r', "")
2544 _check_decode(b'\r', "\n")
2545 _check_decode(b'\na', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002546
Antoine Pitrou180a3362008-12-14 16:36:46 +00002547 _check_decode(b'\xe8\xa2\x88\r\n', "\u8888\n")
2548 _check_decode(b'\xe8\xa2\x88', "\u8888")
2549 _check_decode(b'\n', "\n")
2550 _check_decode(b'\xe8\xa2\x88\r', "\u8888")
2551 _check_decode(b'\n', "\n")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002552
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002553 def check_newline_decoding(self, decoder, encoding):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002554 result = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002555 if encoding is not None:
2556 encoder = codecs.getincrementalencoder(encoding)()
2557 def _decode_bytewise(s):
2558 # Decode one byte at a time
2559 for b in encoder.encode(s):
2560 result.append(decoder.decode(bytes([b])))
2561 else:
2562 encoder = None
2563 def _decode_bytewise(s):
2564 # Decode one char at a time
2565 for c in s:
2566 result.append(decoder.decode(c))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002567 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002568 _decode_bytewise("abc\n\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002569 self.assertEqual(decoder.newlines, '\n')
Antoine Pitrou180a3362008-12-14 16:36:46 +00002570 _decode_bytewise("\nabc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002571 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002572 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002573 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002574 _decode_bytewise("abc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002575 self.assertEqual(decoder.newlines, ('\r', '\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002576 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002577 self.assertEqual("".join(result), "abc\n\nabcabc\nabcabc")
Antoine Pitrou180a3362008-12-14 16:36:46 +00002578 decoder.reset()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002579 input = "abc"
2580 if encoder is not None:
2581 encoder.reset()
2582 input = encoder.encode(input)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002583 self.assertEqual(decoder.decode(input), "abc")
2584 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002585
2586 def test_newline_decoder(self):
2587 encodings = (
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002588 # None meaning the IncrementalNewlineDecoder takes unicode input
2589 # rather than bytes input
2590 None, 'utf-8', 'latin-1',
Antoine Pitrou180a3362008-12-14 16:36:46 +00002591 'utf-16', 'utf-16-le', 'utf-16-be',
2592 'utf-32', 'utf-32-le', 'utf-32-be',
2593 )
2594 for enc in encodings:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002595 decoder = enc and codecs.getincrementaldecoder(enc)()
2596 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2597 self.check_newline_decoding(decoder, enc)
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002598 decoder = codecs.getincrementaldecoder("utf-8")()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002599 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2600 self.check_newline_decoding_utf8(decoder)
2601
Antoine Pitrou66913e22009-03-06 23:40:56 +00002602 def test_newline_bytes(self):
2603 # Issue 5433: Excessive optimization in IncrementalNewlineDecoder
2604 def _check(dec):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002605 self.assertEqual(dec.newlines, None)
2606 self.assertEqual(dec.decode("\u0D00"), "\u0D00")
2607 self.assertEqual(dec.newlines, None)
2608 self.assertEqual(dec.decode("\u0A00"), "\u0A00")
2609 self.assertEqual(dec.newlines, None)
Antoine Pitrou66913e22009-03-06 23:40:56 +00002610 dec = self.IncrementalNewlineDecoder(None, translate=False)
2611 _check(dec)
2612 dec = self.IncrementalNewlineDecoder(None, translate=True)
2613 _check(dec)
2614
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002615class CIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2616 pass
2617
2618class PyIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2619 pass
Antoine Pitrou180a3362008-12-14 16:36:46 +00002620
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002621
Guido van Rossum01a27522007-03-07 01:00:12 +00002622# XXX Tests for open()
Guido van Rossum68bbcd22007-02-27 17:19:33 +00002623
Guido van Rossum5abbf752007-08-27 17:39:33 +00002624class MiscIOTest(unittest.TestCase):
2625
Barry Warsaw40e82462008-11-20 20:14:50 +00002626 def tearDown(self):
2627 support.unlink(support.TESTFN)
2628
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002629 def test___all__(self):
2630 for name in self.io.__all__:
2631 obj = getattr(self.io, name, None)
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002632 self.assertTrue(obj is not None, name)
Guido van Rossum5abbf752007-08-27 17:39:33 +00002633 if name == "open":
2634 continue
Benjamin Peterson6a52a9c2009-04-29 22:00:44 +00002635 elif "error" in name.lower() or name == "UnsupportedOperation":
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002636 self.assertTrue(issubclass(obj, Exception), name)
2637 elif not name.startswith("SEEK_"):
2638 self.assertTrue(issubclass(obj, self.IOBase))
Benjamin Peterson65676e42008-11-05 21:42:45 +00002639
Barry Warsaw40e82462008-11-20 20:14:50 +00002640 def test_attributes(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002641 f = self.open(support.TESTFN, "wb", buffering=0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002642 self.assertEqual(f.mode, "wb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002643 f.close()
2644
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002645 f = self.open(support.TESTFN, "U")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002646 self.assertEqual(f.name, support.TESTFN)
2647 self.assertEqual(f.buffer.name, support.TESTFN)
2648 self.assertEqual(f.buffer.raw.name, support.TESTFN)
2649 self.assertEqual(f.mode, "U")
2650 self.assertEqual(f.buffer.mode, "rb")
2651 self.assertEqual(f.buffer.raw.mode, "rb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002652 f.close()
2653
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002654 f = self.open(support.TESTFN, "w+")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002655 self.assertEqual(f.mode, "w+")
2656 self.assertEqual(f.buffer.mode, "rb+") # Does it really matter?
2657 self.assertEqual(f.buffer.raw.mode, "rb+")
Barry Warsaw40e82462008-11-20 20:14:50 +00002658
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002659 g = self.open(f.fileno(), "wb", closefd=False)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002660 self.assertEqual(g.mode, "wb")
2661 self.assertEqual(g.raw.mode, "wb")
2662 self.assertEqual(g.name, f.fileno())
2663 self.assertEqual(g.raw.name, f.fileno())
Barry Warsaw40e82462008-11-20 20:14:50 +00002664 f.close()
2665 g.close()
2666
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002667 def test_io_after_close(self):
2668 for kwargs in [
2669 {"mode": "w"},
2670 {"mode": "wb"},
2671 {"mode": "w", "buffering": 1},
2672 {"mode": "w", "buffering": 2},
2673 {"mode": "wb", "buffering": 0},
2674 {"mode": "r"},
2675 {"mode": "rb"},
2676 {"mode": "r", "buffering": 1},
2677 {"mode": "r", "buffering": 2},
2678 {"mode": "rb", "buffering": 0},
2679 {"mode": "w+"},
2680 {"mode": "w+b"},
2681 {"mode": "w+", "buffering": 1},
2682 {"mode": "w+", "buffering": 2},
2683 {"mode": "w+b", "buffering": 0},
2684 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002685 f = self.open(support.TESTFN, **kwargs)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002686 f.close()
2687 self.assertRaises(ValueError, f.flush)
2688 self.assertRaises(ValueError, f.fileno)
2689 self.assertRaises(ValueError, f.isatty)
2690 self.assertRaises(ValueError, f.__iter__)
2691 if hasattr(f, "peek"):
2692 self.assertRaises(ValueError, f.peek, 1)
2693 self.assertRaises(ValueError, f.read)
2694 if hasattr(f, "read1"):
2695 self.assertRaises(ValueError, f.read1, 1024)
Victor Stinnerb79f28c2011-05-25 22:09:03 +02002696 if hasattr(f, "readall"):
2697 self.assertRaises(ValueError, f.readall)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002698 if hasattr(f, "readinto"):
2699 self.assertRaises(ValueError, f.readinto, bytearray(1024))
2700 self.assertRaises(ValueError, f.readline)
2701 self.assertRaises(ValueError, f.readlines)
2702 self.assertRaises(ValueError, f.seek, 0)
2703 self.assertRaises(ValueError, f.tell)
2704 self.assertRaises(ValueError, f.truncate)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002705 self.assertRaises(ValueError, f.write,
2706 b"" if "b" in kwargs['mode'] else "")
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002707 self.assertRaises(ValueError, f.writelines, [])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002708 self.assertRaises(ValueError, next, f)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002709
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002710 def test_blockingioerror(self):
2711 # Various BlockingIOError issues
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002712 class C(str):
2713 pass
2714 c = C("")
2715 b = self.BlockingIOError(1, c)
2716 c.b = b
2717 b.c = c
2718 wr = weakref.ref(c)
2719 del c, b
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002720 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002721 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002722
2723 def test_abcs(self):
2724 # Test the visible base classes are ABCs.
Ezio Melottie9615932010-01-24 19:26:24 +00002725 self.assertIsInstance(self.IOBase, abc.ABCMeta)
2726 self.assertIsInstance(self.RawIOBase, abc.ABCMeta)
2727 self.assertIsInstance(self.BufferedIOBase, abc.ABCMeta)
2728 self.assertIsInstance(self.TextIOBase, abc.ABCMeta)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002729
2730 def _check_abc_inheritance(self, abcmodule):
2731 with self.open(support.TESTFN, "wb", buffering=0) as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002732 self.assertIsInstance(f, abcmodule.IOBase)
2733 self.assertIsInstance(f, abcmodule.RawIOBase)
2734 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2735 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002736 with self.open(support.TESTFN, "wb") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002737 self.assertIsInstance(f, abcmodule.IOBase)
2738 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2739 self.assertIsInstance(f, abcmodule.BufferedIOBase)
2740 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002741 with self.open(support.TESTFN, "w") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002742 self.assertIsInstance(f, abcmodule.IOBase)
2743 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2744 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2745 self.assertIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002746
2747 def test_abc_inheritance(self):
2748 # Test implementations inherit from their respective ABCs
2749 self._check_abc_inheritance(self)
2750
2751 def test_abc_inheritance_official(self):
2752 # Test implementations inherit from the official ABCs of the
2753 # baseline "io" module.
2754 self._check_abc_inheritance(io)
2755
Antoine Pitroue033e062010-10-29 10:38:18 +00002756 def _check_warn_on_dealloc(self, *args, **kwargs):
2757 f = open(*args, **kwargs)
2758 r = repr(f)
2759 with self.assertWarns(ResourceWarning) as cm:
2760 f = None
2761 support.gc_collect()
2762 self.assertIn(r, str(cm.warning.args[0]))
2763
2764 def test_warn_on_dealloc(self):
2765 self._check_warn_on_dealloc(support.TESTFN, "wb", buffering=0)
2766 self._check_warn_on_dealloc(support.TESTFN, "wb")
2767 self._check_warn_on_dealloc(support.TESTFN, "w")
2768
2769 def _check_warn_on_dealloc_fd(self, *args, **kwargs):
2770 fds = []
Benjamin Peterson556c7352010-10-31 01:35:43 +00002771 def cleanup_fds():
Antoine Pitroue033e062010-10-29 10:38:18 +00002772 for fd in fds:
2773 try:
2774 os.close(fd)
2775 except EnvironmentError as e:
2776 if e.errno != errno.EBADF:
2777 raise
Benjamin Peterson556c7352010-10-31 01:35:43 +00002778 self.addCleanup(cleanup_fds)
2779 r, w = os.pipe()
2780 fds += r, w
2781 self._check_warn_on_dealloc(r, *args, **kwargs)
2782 # When using closefd=False, there's no warning
2783 r, w = os.pipe()
2784 fds += r, w
2785 with warnings.catch_warnings(record=True) as recorded:
2786 open(r, *args, closefd=False, **kwargs)
2787 support.gc_collect()
2788 self.assertEqual(recorded, [])
Antoine Pitroue033e062010-10-29 10:38:18 +00002789
2790 def test_warn_on_dealloc_fd(self):
2791 self._check_warn_on_dealloc_fd("rb", buffering=0)
2792 self._check_warn_on_dealloc_fd("rb")
2793 self._check_warn_on_dealloc_fd("r")
2794
2795
Antoine Pitrou243757e2010-11-05 21:15:39 +00002796 def test_pickling(self):
2797 # Pickling file objects is forbidden
2798 for kwargs in [
2799 {"mode": "w"},
2800 {"mode": "wb"},
2801 {"mode": "wb", "buffering": 0},
2802 {"mode": "r"},
2803 {"mode": "rb"},
2804 {"mode": "rb", "buffering": 0},
2805 {"mode": "w+"},
2806 {"mode": "w+b"},
2807 {"mode": "w+b", "buffering": 0},
2808 ]:
2809 for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
2810 with self.open(support.TESTFN, **kwargs) as f:
2811 self.assertRaises(TypeError, pickle.dumps, f, protocol)
2812
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002813 @unittest.skipUnless(fcntl, 'fcntl required for this test')
2814 def test_nonblock_pipe_write_bigbuf(self):
2815 self._test_nonblock_pipe_write(16*1024)
2816
2817 @unittest.skipUnless(fcntl, 'fcntl required for this test')
2818 def test_nonblock_pipe_write_smallbuf(self):
2819 self._test_nonblock_pipe_write(1024)
2820
2821 def _set_non_blocking(self, fd):
2822 flags = fcntl.fcntl(fd, fcntl.F_GETFL)
2823 self.assertNotEqual(flags, -1)
2824 res = fcntl.fcntl(fd, fcntl.F_SETFL, flags | os.O_NONBLOCK)
2825 self.assertEqual(res, 0)
2826
2827 def _test_nonblock_pipe_write(self, bufsize):
2828 sent = []
2829 received = []
2830 r, w = os.pipe()
2831 self._set_non_blocking(r)
2832 self._set_non_blocking(w)
2833
2834 # To exercise all code paths in the C implementation we need
2835 # to play with buffer sizes. For instance, if we choose a
2836 # buffer size less than or equal to _PIPE_BUF (4096 on Linux)
2837 # then we will never get a partial write of the buffer.
2838 rf = self.open(r, mode='rb', closefd=True, buffering=bufsize)
2839 wf = self.open(w, mode='wb', closefd=True, buffering=bufsize)
2840
2841 with rf, wf:
2842 for N in 9999, 73, 7574:
2843 try:
2844 i = 0
2845 while True:
2846 msg = bytes([i % 26 + 97]) * N
2847 sent.append(msg)
2848 wf.write(msg)
2849 i += 1
2850
2851 except self.BlockingIOError as e:
2852 self.assertEqual(e.args[0], errno.EAGAIN)
Antoine Pitrou7fe601c2011-11-21 20:22:01 +01002853 self.assertEqual(e.args[2], e.characters_written)
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002854 sent[-1] = sent[-1][:e.characters_written]
2855 received.append(rf.read())
2856 msg = b'BLOCKED'
2857 wf.write(msg)
2858 sent.append(msg)
2859
2860 while True:
2861 try:
2862 wf.flush()
2863 break
2864 except self.BlockingIOError as e:
2865 self.assertEqual(e.args[0], errno.EAGAIN)
Antoine Pitrou7fe601c2011-11-21 20:22:01 +01002866 self.assertEqual(e.args[2], e.characters_written)
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002867 self.assertEqual(e.characters_written, 0)
2868 received.append(rf.read())
2869
2870 received += iter(rf.read, None)
2871
2872 sent, received = b''.join(sent), b''.join(received)
2873 self.assertTrue(sent == received)
2874 self.assertTrue(wf.closed)
2875 self.assertTrue(rf.closed)
2876
Charles-François Natalidc3044c2012-01-09 22:40:02 +01002877 def test_create_fail(self):
2878 # 'x' mode fails if file is existing
2879 with self.open(support.TESTFN, 'w'):
2880 pass
2881 self.assertRaises(FileExistsError, self.open, support.TESTFN, 'x')
2882
2883 def test_create_writes(self):
2884 # 'x' mode opens for writing
2885 with self.open(support.TESTFN, 'xb') as f:
2886 f.write(b"spam")
2887 with self.open(support.TESTFN, 'rb') as f:
2888 self.assertEqual(b"spam", f.read())
2889
Christian Heimes7b648752012-09-10 14:48:43 +02002890 def test_open_allargs(self):
2891 # there used to be a buffer overflow in the parser for rawmode
2892 self.assertRaises(ValueError, self.open, support.TESTFN, 'rwax+')
2893
2894
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002895class CMiscIOTest(MiscIOTest):
2896 io = io
2897
2898class PyMiscIOTest(MiscIOTest):
2899 io = pyio
Barry Warsaw40e82462008-11-20 20:14:50 +00002900
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002901
2902@unittest.skipIf(os.name == 'nt', 'POSIX signals required for this test.')
2903class SignalsTest(unittest.TestCase):
2904
2905 def setUp(self):
2906 self.oldalrm = signal.signal(signal.SIGALRM, self.alarm_interrupt)
2907
2908 def tearDown(self):
2909 signal.signal(signal.SIGALRM, self.oldalrm)
2910
2911 def alarm_interrupt(self, sig, frame):
2912 1/0
2913
2914 @unittest.skipUnless(threading, 'Threading required for this test.')
2915 def check_interrupted_write(self, item, bytes, **fdopen_kwargs):
2916 """Check that a partial write, when it gets interrupted, properly
Antoine Pitrou707ce822011-02-25 21:24:11 +00002917 invokes the signal handler, and bubbles up the exception raised
2918 in the latter."""
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002919 read_results = []
2920 def _read():
Victor Stinnera9293352011-04-30 15:21:58 +02002921 if hasattr(signal, 'pthread_sigmask'):
2922 signal.pthread_sigmask(signal.SIG_BLOCK, [signal.SIGALRM])
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002923 s = os.read(r, 1)
2924 read_results.append(s)
2925 t = threading.Thread(target=_read)
2926 t.daemon = True
2927 r, w = os.pipe()
Benjamin Petersond8fc2e12010-10-31 01:19:53 +00002928 fdopen_kwargs["closefd"] = False
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002929 try:
2930 wio = self.io.open(w, **fdopen_kwargs)
2931 t.start()
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07002932 signal.alarm(1)
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002933 # Fill the pipe enough that the write will be blocking.
2934 # It will be interrupted by the timer armed above. Since the
2935 # other thread has read one byte, the low-level write will
2936 # return with a successful (partial) result rather than an EINTR.
2937 # The buffered IO layer must check for pending signal
2938 # handlers, which in this case will invoke alarm_interrupt().
2939 self.assertRaises(ZeroDivisionError,
Charles-François Natali2d517212011-05-29 16:36:44 +02002940 wio.write, item * (support.PIPE_MAX_SIZE // len(item)))
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002941 t.join()
2942 # We got one byte, get another one and check that it isn't a
2943 # repeat of the first one.
2944 read_results.append(os.read(r, 1))
2945 self.assertEqual(read_results, [bytes[0:1], bytes[1:2]])
2946 finally:
2947 os.close(w)
2948 os.close(r)
2949 # This is deliberate. If we didn't close the file descriptor
2950 # before closing wio, wio would try to flush its internal
2951 # buffer, and block again.
2952 try:
2953 wio.close()
2954 except IOError as e:
2955 if e.errno != errno.EBADF:
2956 raise
2957
2958 def test_interrupted_write_unbuffered(self):
2959 self.check_interrupted_write(b"xy", b"xy", mode="wb", buffering=0)
2960
2961 def test_interrupted_write_buffered(self):
2962 self.check_interrupted_write(b"xy", b"xy", mode="wb")
2963
2964 def test_interrupted_write_text(self):
2965 self.check_interrupted_write("xy", b"xy", mode="w", encoding="ascii")
2966
Brett Cannon31f59292011-02-21 19:29:56 +00002967 @support.no_tracing
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002968 def check_reentrant_write(self, data, **fdopen_kwargs):
2969 def on_alarm(*args):
2970 # Will be called reentrantly from the same thread
2971 wio.write(data)
2972 1/0
2973 signal.signal(signal.SIGALRM, on_alarm)
2974 r, w = os.pipe()
2975 wio = self.io.open(w, **fdopen_kwargs)
2976 try:
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07002977 signal.alarm(1)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002978 # Either the reentrant call to wio.write() fails with RuntimeError,
2979 # or the signal handler raises ZeroDivisionError.
2980 with self.assertRaises((ZeroDivisionError, RuntimeError)) as cm:
2981 while 1:
2982 for i in range(100):
2983 wio.write(data)
2984 wio.flush()
2985 # Make sure the buffer doesn't fill up and block further writes
2986 os.read(r, len(data) * 100)
2987 exc = cm.exception
2988 if isinstance(exc, RuntimeError):
2989 self.assertTrue(str(exc).startswith("reentrant call"), str(exc))
2990 finally:
2991 wio.close()
2992 os.close(r)
2993
2994 def test_reentrant_write_buffered(self):
2995 self.check_reentrant_write(b"xy", mode="wb")
2996
2997 def test_reentrant_write_text(self):
2998 self.check_reentrant_write("xy", mode="w", encoding="ascii")
2999
Antoine Pitrou707ce822011-02-25 21:24:11 +00003000 def check_interrupted_read_retry(self, decode, **fdopen_kwargs):
3001 """Check that a buffered read, when it gets interrupted (either
3002 returning a partial result or EINTR), properly invokes the signal
3003 handler and retries if the latter returned successfully."""
3004 r, w = os.pipe()
3005 fdopen_kwargs["closefd"] = False
3006 def alarm_handler(sig, frame):
3007 os.write(w, b"bar")
3008 signal.signal(signal.SIGALRM, alarm_handler)
3009 try:
3010 rio = self.io.open(r, **fdopen_kwargs)
3011 os.write(w, b"foo")
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07003012 signal.alarm(1)
Antoine Pitrou707ce822011-02-25 21:24:11 +00003013 # Expected behaviour:
3014 # - first raw read() returns partial b"foo"
3015 # - second raw read() returns EINTR
3016 # - third raw read() returns b"bar"
3017 self.assertEqual(decode(rio.read(6)), "foobar")
3018 finally:
3019 rio.close()
3020 os.close(w)
3021 os.close(r)
3022
Antoine Pitrou20db5112011-08-19 20:32:34 +02003023 def test_interrupted_read_retry_buffered(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003024 self.check_interrupted_read_retry(lambda x: x.decode('latin1'),
3025 mode="rb")
3026
Antoine Pitrou20db5112011-08-19 20:32:34 +02003027 def test_interrupted_read_retry_text(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003028 self.check_interrupted_read_retry(lambda x: x,
3029 mode="r")
3030
3031 @unittest.skipUnless(threading, 'Threading required for this test.')
3032 def check_interrupted_write_retry(self, item, **fdopen_kwargs):
3033 """Check that a buffered write, when it gets interrupted (either
3034 returning a partial result or EINTR), properly invokes the signal
3035 handler and retries if the latter returned successfully."""
3036 select = support.import_module("select")
3037 # A quantity that exceeds the buffer size of an anonymous pipe's
3038 # write end.
3039 N = 1024 * 1024
3040 r, w = os.pipe()
3041 fdopen_kwargs["closefd"] = False
3042 # We need a separate thread to read from the pipe and allow the
3043 # write() to finish. This thread is started after the SIGALRM is
3044 # received (forcing a first EINTR in write()).
3045 read_results = []
3046 write_finished = False
3047 def _read():
3048 while not write_finished:
3049 while r in select.select([r], [], [], 1.0)[0]:
3050 s = os.read(r, 1024)
3051 read_results.append(s)
3052 t = threading.Thread(target=_read)
3053 t.daemon = True
3054 def alarm1(sig, frame):
3055 signal.signal(signal.SIGALRM, alarm2)
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07003056 signal.alarm(1)
Antoine Pitrou707ce822011-02-25 21:24:11 +00003057 def alarm2(sig, frame):
3058 t.start()
3059 signal.signal(signal.SIGALRM, alarm1)
3060 try:
3061 wio = self.io.open(w, **fdopen_kwargs)
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07003062 signal.alarm(1)
Antoine Pitrou707ce822011-02-25 21:24:11 +00003063 # Expected behaviour:
3064 # - first raw write() is partial (because of the limited pipe buffer
3065 # and the first alarm)
3066 # - second raw write() returns EINTR (because of the second alarm)
3067 # - subsequent write()s are successful (either partial or complete)
3068 self.assertEqual(N, wio.write(item * N))
3069 wio.flush()
3070 write_finished = True
3071 t.join()
3072 self.assertEqual(N, sum(len(x) for x in read_results))
3073 finally:
3074 write_finished = True
3075 os.close(w)
3076 os.close(r)
3077 # This is deliberate. If we didn't close the file descriptor
3078 # before closing wio, wio would try to flush its internal
3079 # buffer, and could block (in case of failure).
3080 try:
3081 wio.close()
3082 except IOError as e:
3083 if e.errno != errno.EBADF:
3084 raise
3085
Antoine Pitrou20db5112011-08-19 20:32:34 +02003086 def test_interrupted_write_retry_buffered(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003087 self.check_interrupted_write_retry(b"x", mode="wb")
3088
Antoine Pitrou20db5112011-08-19 20:32:34 +02003089 def test_interrupted_write_retry_text(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003090 self.check_interrupted_write_retry("x", mode="w", encoding="latin1")
3091
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00003092
Antoine Pitroub46b9d52010-08-21 19:09:32 +00003093class CSignalsTest(SignalsTest):
3094 io = io
3095
3096class PySignalsTest(SignalsTest):
3097 io = pyio
3098
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00003099 # Handling reentrancy issues would slow down _pyio even more, so the
3100 # tests are disabled.
3101 test_reentrant_write_buffered = None
3102 test_reentrant_write_text = None
3103
Antoine Pitroub46b9d52010-08-21 19:09:32 +00003104
Guido van Rossum28524c72007-02-27 05:47:44 +00003105def test_main():
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003106 tests = (CIOTest, PyIOTest,
3107 CBufferedReaderTest, PyBufferedReaderTest,
3108 CBufferedWriterTest, PyBufferedWriterTest,
3109 CBufferedRWPairTest, PyBufferedRWPairTest,
3110 CBufferedRandomTest, PyBufferedRandomTest,
3111 StatefulIncrementalDecoderTest,
3112 CIncrementalNewlineDecoderTest, PyIncrementalNewlineDecoderTest,
3113 CTextIOWrapperTest, PyTextIOWrapperTest,
Antoine Pitroub46b9d52010-08-21 19:09:32 +00003114 CMiscIOTest, PyMiscIOTest,
3115 CSignalsTest, PySignalsTest,
3116 )
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003117
3118 # Put the namespaces of the IO module we are testing and some useful mock
3119 # classes in the __dict__ of each test.
3120 mocks = (MockRawIO, MisbehavedRawIO, MockFileIO, CloseFailureIO,
Antoine Pitrou328ec742010-09-14 18:37:24 +00003121 MockNonBlockWriterIO, MockUnseekableIO, MockRawIOWithoutRead)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003122 all_members = io.__all__ + ["IncrementalNewlineDecoder"]
3123 c_io_ns = {name : getattr(io, name) for name in all_members}
3124 py_io_ns = {name : getattr(pyio, name) for name in all_members}
3125 globs = globals()
3126 c_io_ns.update((x.__name__, globs["C" + x.__name__]) for x in mocks)
3127 py_io_ns.update((x.__name__, globs["Py" + x.__name__]) for x in mocks)
3128 # Avoid turning open into a bound method.
3129 py_io_ns["open"] = pyio.OpenWrapper
3130 for test in tests:
3131 if test.__name__.startswith("C"):
3132 for name, obj in c_io_ns.items():
3133 setattr(test, name, obj)
3134 elif test.__name__.startswith("Py"):
3135 for name, obj in py_io_ns.items():
3136 setattr(test, name, obj)
3137
3138 support.run_unittest(*tests)
Guido van Rossum28524c72007-02-27 05:47:44 +00003139
3140if __name__ == "__main__":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003141 test_main()