blob: 54ba179f1d8e6fbeb62e884acc26279f39a14e59 [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
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000805class BufferedReaderTest(unittest.TestCase, CommonBufferedTests):
806 read_mode = "rb"
Guido van Rossum78892e42007-04-06 17:31:18 +0000807
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000808 def test_constructor(self):
809 rawio = self.MockRawIO([b"abc"])
810 bufio = self.tp(rawio)
811 bufio.__init__(rawio)
812 bufio.__init__(rawio, buffer_size=1024)
813 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000814 self.assertEqual(b"abc", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000815 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
816 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
817 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
818 rawio = self.MockRawIO([b"abc"])
819 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000820 self.assertEqual(b"abc", bufio.read())
Guido van Rossum78892e42007-04-06 17:31:18 +0000821
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000822 def test_read(self):
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000823 for arg in (None, 7):
824 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
825 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000826 self.assertEqual(b"abcdefg", bufio.read(arg))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000827 # Invalid args
828 self.assertRaises(ValueError, bufio.read, -2)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000829
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000830 def test_read1(self):
831 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
832 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000833 self.assertEqual(b"a", bufio.read(1))
834 self.assertEqual(b"b", bufio.read1(1))
835 self.assertEqual(rawio._reads, 1)
836 self.assertEqual(b"c", bufio.read1(100))
837 self.assertEqual(rawio._reads, 1)
838 self.assertEqual(b"d", bufio.read1(100))
839 self.assertEqual(rawio._reads, 2)
840 self.assertEqual(b"efg", bufio.read1(100))
841 self.assertEqual(rawio._reads, 3)
842 self.assertEqual(b"", bufio.read1(100))
843 self.assertEqual(rawio._reads, 4)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000844 # Invalid args
845 self.assertRaises(ValueError, bufio.read1, -1)
846
847 def test_readinto(self):
848 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
849 bufio = self.tp(rawio)
850 b = bytearray(2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000851 self.assertEqual(bufio.readinto(b), 2)
852 self.assertEqual(b, b"ab")
853 self.assertEqual(bufio.readinto(b), 2)
854 self.assertEqual(b, b"cd")
855 self.assertEqual(bufio.readinto(b), 2)
856 self.assertEqual(b, b"ef")
857 self.assertEqual(bufio.readinto(b), 1)
858 self.assertEqual(b, b"gf")
859 self.assertEqual(bufio.readinto(b), 0)
860 self.assertEqual(b, b"gf")
Antoine Pitrou3486a982011-05-12 01:57:53 +0200861 rawio = self.MockRawIO((b"abc", None))
862 bufio = self.tp(rawio)
863 self.assertEqual(bufio.readinto(b), 2)
864 self.assertEqual(b, b"ab")
865 self.assertEqual(bufio.readinto(b), 1)
866 self.assertEqual(b, b"cb")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000867
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000868 def test_readlines(self):
869 def bufio():
870 rawio = self.MockRawIO((b"abc\n", b"d\n", b"ef"))
871 return self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000872 self.assertEqual(bufio().readlines(), [b"abc\n", b"d\n", b"ef"])
873 self.assertEqual(bufio().readlines(5), [b"abc\n", b"d\n"])
874 self.assertEqual(bufio().readlines(None), [b"abc\n", b"d\n", b"ef"])
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000875
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000876 def test_buffering(self):
Guido van Rossum78892e42007-04-06 17:31:18 +0000877 data = b"abcdefghi"
878 dlen = len(data)
879
880 tests = [
881 [ 100, [ 3, 1, 4, 8 ], [ dlen, 0 ] ],
882 [ 100, [ 3, 3, 3], [ dlen ] ],
883 [ 4, [ 1, 2, 4, 2 ], [ 4, 4, 1 ] ],
884 ]
885
886 for bufsize, buf_read_sizes, raw_read_sizes in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000887 rawio = self.MockFileIO(data)
888 bufio = self.tp(rawio, buffer_size=bufsize)
Guido van Rossum78892e42007-04-06 17:31:18 +0000889 pos = 0
890 for nbytes in buf_read_sizes:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000891 self.assertEqual(bufio.read(nbytes), data[pos:pos+nbytes])
Guido van Rossum78892e42007-04-06 17:31:18 +0000892 pos += nbytes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000893 # this is mildly implementation-dependent
Ezio Melottib3aedd42010-11-20 19:04:17 +0000894 self.assertEqual(rawio.read_history, raw_read_sizes)
Guido van Rossum78892e42007-04-06 17:31:18 +0000895
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000896 def test_read_non_blocking(self):
Guido van Rossum01a27522007-03-07 01:00:12 +0000897 # Inject some None's in there to simulate EWOULDBLOCK
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000898 rawio = self.MockRawIO((b"abc", b"d", None, b"efg", None, None, None))
899 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000900 self.assertEqual(b"abcd", bufio.read(6))
901 self.assertEqual(b"e", bufio.read(1))
902 self.assertEqual(b"fg", bufio.read())
903 self.assertEqual(b"", bufio.peek(1))
Victor Stinnera80987f2011-05-25 22:47:16 +0200904 self.assertIsNone(bufio.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +0000905 self.assertEqual(b"", bufio.read())
Guido van Rossum01a27522007-03-07 01:00:12 +0000906
Victor Stinnera80987f2011-05-25 22:47:16 +0200907 rawio = self.MockRawIO((b"a", None, None))
908 self.assertEqual(b"a", rawio.readall())
909 self.assertIsNone(rawio.readall())
910
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000911 def test_read_past_eof(self):
912 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
913 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000914
Ezio Melottib3aedd42010-11-20 19:04:17 +0000915 self.assertEqual(b"abcdefg", bufio.read(9000))
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000916
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000917 def test_read_all(self):
918 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
919 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000920
Ezio Melottib3aedd42010-11-20 19:04:17 +0000921 self.assertEqual(b"abcdefg", bufio.read())
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000922
Victor Stinner45df8202010-04-28 22:31:17 +0000923 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000924 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000925 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +0000926 try:
927 # Write out many bytes with exactly the same number of 0's,
928 # 1's... 255's. This will help us check that concurrent reading
929 # doesn't duplicate or forget contents.
930 N = 1000
931 l = list(range(256)) * N
932 random.shuffle(l)
933 s = bytes(bytearray(l))
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000934 with self.open(support.TESTFN, "wb") as f:
Antoine Pitrou87695762008-08-14 22:44:29 +0000935 f.write(s)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000936 with self.open(support.TESTFN, self.read_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000937 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +0000938 errors = []
939 results = []
940 def f():
941 try:
942 # Intra-buffer read then buffer-flushing read
943 for n in cycle([1, 19]):
944 s = bufio.read(n)
945 if not s:
946 break
947 # list.append() is atomic
948 results.append(s)
949 except Exception as e:
950 errors.append(e)
951 raise
952 threads = [threading.Thread(target=f) for x in range(20)]
953 for t in threads:
954 t.start()
955 time.sleep(0.02) # yield
956 for t in threads:
957 t.join()
958 self.assertFalse(errors,
959 "the following exceptions were caught: %r" % errors)
960 s = b''.join(results)
961 for i in range(256):
962 c = bytes(bytearray([i]))
963 self.assertEqual(s.count(c), N)
964 finally:
965 support.unlink(support.TESTFN)
966
Antoine Pitrou1e44fec2011-10-04 12:26:20 +0200967 def test_unseekable(self):
968 bufio = self.tp(self.MockUnseekableIO(b"A" * 10))
969 self.assertRaises(self.UnsupportedOperation, bufio.tell)
970 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
971 bufio.read(1)
972 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
973 self.assertRaises(self.UnsupportedOperation, bufio.tell)
974
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000975 def test_misbehaved_io(self):
976 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
977 bufio = self.tp(rawio)
978 self.assertRaises(IOError, bufio.seek, 0)
979 self.assertRaises(IOError, bufio.tell)
980
Antoine Pitrou32cfede2010-08-11 13:31:33 +0000981 def test_no_extraneous_read(self):
982 # Issue #9550; when the raw IO object has satisfied the read request,
983 # we should not issue any additional reads, otherwise it may block
984 # (e.g. socket).
985 bufsize = 16
986 for n in (2, bufsize - 1, bufsize, bufsize + 1, bufsize * 2):
987 rawio = self.MockRawIO([b"x" * n])
988 bufio = self.tp(rawio, bufsize)
989 self.assertEqual(bufio.read(n), b"x" * n)
990 # Simple case: one raw read is enough to satisfy the request.
991 self.assertEqual(rawio._extraneous_reads, 0,
992 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
993 # A more complex case where two raw reads are needed to satisfy
994 # the request.
995 rawio = self.MockRawIO([b"x" * (n - 1), b"x"])
996 bufio = self.tp(rawio, bufsize)
997 self.assertEqual(bufio.read(n), b"x" * n)
998 self.assertEqual(rawio._extraneous_reads, 0,
999 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
1000
1001
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001002class CBufferedReaderTest(BufferedReaderTest):
1003 tp = io.BufferedReader
1004
1005 def test_constructor(self):
1006 BufferedReaderTest.test_constructor(self)
1007 # The allocation can succeed on 32-bit builds, e.g. with more
1008 # than 2GB RAM and a 64-bit kernel.
1009 if sys.maxsize > 0x7FFFFFFF:
1010 rawio = self.MockRawIO()
1011 bufio = self.tp(rawio)
1012 self.assertRaises((OverflowError, MemoryError, ValueError),
1013 bufio.__init__, rawio, sys.maxsize)
1014
1015 def test_initialization(self):
1016 rawio = self.MockRawIO([b"abc"])
1017 bufio = self.tp(rawio)
1018 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1019 self.assertRaises(ValueError, bufio.read)
1020 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1021 self.assertRaises(ValueError, bufio.read)
1022 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1023 self.assertRaises(ValueError, bufio.read)
1024
1025 def test_misbehaved_io_read(self):
1026 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
1027 bufio = self.tp(rawio)
1028 # _pyio.BufferedReader seems to implement reading different, so that
1029 # checking this is not so easy.
1030 self.assertRaises(IOError, bufio.read, 10)
1031
1032 def test_garbage_collection(self):
1033 # C BufferedReader objects are collected.
1034 # The Python version has __del__, so it ends into gc.garbage instead
1035 rawio = self.FileIO(support.TESTFN, "w+b")
1036 f = self.tp(rawio)
1037 f.f = f
1038 wr = weakref.ref(f)
1039 del f
Benjamin Peterson45cec322009-04-24 23:14:50 +00001040 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001041 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001042
1043class PyBufferedReaderTest(BufferedReaderTest):
1044 tp = pyio.BufferedReader
Antoine Pitrou87695762008-08-14 22:44:29 +00001045
Guido van Rossuma9e20242007-03-08 00:43:48 +00001046
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001047class BufferedWriterTest(unittest.TestCase, CommonBufferedTests):
1048 write_mode = "wb"
Guido van Rossuma9e20242007-03-08 00:43:48 +00001049
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001050 def test_constructor(self):
1051 rawio = self.MockRawIO()
1052 bufio = self.tp(rawio)
1053 bufio.__init__(rawio)
1054 bufio.__init__(rawio, buffer_size=1024)
1055 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001056 self.assertEqual(3, bufio.write(b"abc"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001057 bufio.flush()
1058 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1059 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1060 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1061 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001062 self.assertEqual(3, bufio.write(b"ghi"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001063 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001064 self.assertEqual(b"".join(rawio._write_stack), b"abcghi")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001065
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001066 def test_detach_flush(self):
1067 raw = self.MockRawIO()
1068 buf = self.tp(raw)
1069 buf.write(b"howdy!")
1070 self.assertFalse(raw._write_stack)
1071 buf.detach()
1072 self.assertEqual(raw._write_stack, [b"howdy!"])
1073
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001074 def test_write(self):
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001075 # Write to the buffered IO but don't overflow the buffer.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001076 writer = self.MockRawIO()
1077 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001078 bufio.write(b"abc")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001079 self.assertFalse(writer._write_stack)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001080
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001081 def test_write_overflow(self):
1082 writer = self.MockRawIO()
1083 bufio = self.tp(writer, 8)
1084 contents = b"abcdefghijklmnop"
1085 for n in range(0, len(contents), 3):
1086 bufio.write(contents[n:n+3])
1087 flushed = b"".join(writer._write_stack)
1088 # At least (total - 8) bytes were implicitly flushed, perhaps more
1089 # depending on the implementation.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001090 self.assertTrue(flushed.startswith(contents[:-8]), flushed)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001091
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001092 def check_writes(self, intermediate_func):
1093 # Lots of writes, test the flushed output is as expected.
1094 contents = bytes(range(256)) * 1000
1095 n = 0
1096 writer = self.MockRawIO()
1097 bufio = self.tp(writer, 13)
1098 # Generator of write sizes: repeat each N 15 times then proceed to N+1
1099 def gen_sizes():
1100 for size in count(1):
1101 for i in range(15):
1102 yield size
1103 sizes = gen_sizes()
1104 while n < len(contents):
1105 size = min(next(sizes), len(contents) - n)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001106 self.assertEqual(bufio.write(contents[n:n+size]), size)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001107 intermediate_func(bufio)
1108 n += size
1109 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001110 self.assertEqual(contents, b"".join(writer._write_stack))
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001111
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001112 def test_writes(self):
1113 self.check_writes(lambda bufio: None)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001114
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001115 def test_writes_and_flushes(self):
1116 self.check_writes(lambda bufio: bufio.flush())
Guido van Rossum01a27522007-03-07 01:00:12 +00001117
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001118 def test_writes_and_seeks(self):
1119 def _seekabs(bufio):
1120 pos = bufio.tell()
1121 bufio.seek(pos + 1, 0)
1122 bufio.seek(pos - 1, 0)
1123 bufio.seek(pos, 0)
1124 self.check_writes(_seekabs)
1125 def _seekrel(bufio):
1126 pos = bufio.seek(0, 1)
1127 bufio.seek(+1, 1)
1128 bufio.seek(-1, 1)
1129 bufio.seek(pos, 0)
1130 self.check_writes(_seekrel)
Guido van Rossum01a27522007-03-07 01:00:12 +00001131
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001132 def test_writes_and_truncates(self):
1133 self.check_writes(lambda bufio: bufio.truncate(bufio.tell()))
Guido van Rossum01a27522007-03-07 01:00:12 +00001134
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001135 def test_write_non_blocking(self):
1136 raw = self.MockNonBlockWriterIO()
Benjamin Peterson59406a92009-03-26 17:10:29 +00001137 bufio = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001138
Ezio Melottib3aedd42010-11-20 19:04:17 +00001139 self.assertEqual(bufio.write(b"abcd"), 4)
1140 self.assertEqual(bufio.write(b"efghi"), 5)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001141 # 1 byte will be written, the rest will be buffered
1142 raw.block_on(b"k")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001143 self.assertEqual(bufio.write(b"jklmn"), 5)
Guido van Rossum01a27522007-03-07 01:00:12 +00001144
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001145 # 8 bytes will be written, 8 will be buffered and the rest will be lost
1146 raw.block_on(b"0")
1147 try:
1148 bufio.write(b"opqrwxyz0123456789")
1149 except self.BlockingIOError as e:
1150 written = e.characters_written
1151 else:
1152 self.fail("BlockingIOError should have been raised")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001153 self.assertEqual(written, 16)
1154 self.assertEqual(raw.pop_written(),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001155 b"abcdefghijklmnopqrwxyz")
Guido van Rossum01a27522007-03-07 01:00:12 +00001156
Ezio Melottib3aedd42010-11-20 19:04:17 +00001157 self.assertEqual(bufio.write(b"ABCDEFGHI"), 9)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001158 s = raw.pop_written()
1159 # Previously buffered bytes were flushed
1160 self.assertTrue(s.startswith(b"01234567A"), s)
Guido van Rossum01a27522007-03-07 01:00:12 +00001161
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001162 def test_write_and_rewind(self):
1163 raw = io.BytesIO()
1164 bufio = self.tp(raw, 4)
1165 self.assertEqual(bufio.write(b"abcdef"), 6)
1166 self.assertEqual(bufio.tell(), 6)
1167 bufio.seek(0, 0)
1168 self.assertEqual(bufio.write(b"XY"), 2)
1169 bufio.seek(6, 0)
1170 self.assertEqual(raw.getvalue(), b"XYcdef")
1171 self.assertEqual(bufio.write(b"123456"), 6)
1172 bufio.flush()
1173 self.assertEqual(raw.getvalue(), b"XYcdef123456")
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001174
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001175 def test_flush(self):
1176 writer = self.MockRawIO()
1177 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001178 bufio.write(b"abc")
1179 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001180 self.assertEqual(b"abc", writer._write_stack[0])
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001181
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001182 def test_destructor(self):
1183 writer = self.MockRawIO()
1184 bufio = self.tp(writer, 8)
1185 bufio.write(b"abc")
1186 del bufio
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001187 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001188 self.assertEqual(b"abc", writer._write_stack[0])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001189
1190 def test_truncate(self):
1191 # Truncate implicitly flushes the buffer.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001192 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001193 bufio = self.tp(raw, 8)
1194 bufio.write(b"abcdef")
1195 self.assertEqual(bufio.truncate(3), 3)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001196 self.assertEqual(bufio.tell(), 6)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001197 with self.open(support.TESTFN, "rb", buffering=0) as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001198 self.assertEqual(f.read(), b"abc")
1199
Victor Stinner45df8202010-04-28 22:31:17 +00001200 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +00001201 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001202 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +00001203 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001204 # Write out many bytes from many threads and test they were
1205 # all flushed.
1206 N = 1000
1207 contents = bytes(range(256)) * N
1208 sizes = cycle([1, 19])
1209 n = 0
1210 queue = deque()
1211 while n < len(contents):
1212 size = next(sizes)
1213 queue.append(contents[n:n+size])
1214 n += size
1215 del contents
Antoine Pitrou87695762008-08-14 22:44:29 +00001216 # We use a real file object because it allows us to
1217 # exercise situations where the GIL is released before
1218 # writing the buffer to the raw streams. This is in addition
1219 # to concurrency issues due to switching threads in the middle
1220 # of Python code.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001221 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001222 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +00001223 errors = []
1224 def f():
1225 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001226 while True:
1227 try:
1228 s = queue.popleft()
1229 except IndexError:
1230 return
Antoine Pitrou87695762008-08-14 22:44:29 +00001231 bufio.write(s)
1232 except Exception as e:
1233 errors.append(e)
1234 raise
1235 threads = [threading.Thread(target=f) for x in range(20)]
1236 for t in threads:
1237 t.start()
1238 time.sleep(0.02) # yield
1239 for t in threads:
1240 t.join()
1241 self.assertFalse(errors,
1242 "the following exceptions were caught: %r" % errors)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001243 bufio.close()
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001244 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001245 s = f.read()
1246 for i in range(256):
Ezio Melottib3aedd42010-11-20 19:04:17 +00001247 self.assertEqual(s.count(bytes([i])), N)
Antoine Pitrou87695762008-08-14 22:44:29 +00001248 finally:
1249 support.unlink(support.TESTFN)
1250
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001251 def test_misbehaved_io(self):
1252 rawio = self.MisbehavedRawIO()
1253 bufio = self.tp(rawio, 5)
1254 self.assertRaises(IOError, bufio.seek, 0)
1255 self.assertRaises(IOError, bufio.tell)
1256 self.assertRaises(IOError, bufio.write, b"abcdef")
1257
Benjamin Peterson59406a92009-03-26 17:10:29 +00001258 def test_max_buffer_size_deprecation(self):
Florent Xicluna8fbddf12010-03-17 20:29:51 +00001259 with support.check_warnings(("max_buffer_size is deprecated",
1260 DeprecationWarning)):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001261 self.tp(self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001262
1263
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001264class CBufferedWriterTest(BufferedWriterTest):
1265 tp = io.BufferedWriter
1266
1267 def test_constructor(self):
1268 BufferedWriterTest.test_constructor(self)
1269 # The allocation can succeed on 32-bit builds, e.g. with more
1270 # than 2GB RAM and a 64-bit kernel.
1271 if sys.maxsize > 0x7FFFFFFF:
1272 rawio = self.MockRawIO()
1273 bufio = self.tp(rawio)
1274 self.assertRaises((OverflowError, MemoryError, ValueError),
1275 bufio.__init__, rawio, sys.maxsize)
1276
1277 def test_initialization(self):
1278 rawio = self.MockRawIO()
1279 bufio = self.tp(rawio)
1280 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1281 self.assertRaises(ValueError, bufio.write, b"def")
1282 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1283 self.assertRaises(ValueError, bufio.write, b"def")
1284 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1285 self.assertRaises(ValueError, bufio.write, b"def")
1286
1287 def test_garbage_collection(self):
1288 # C BufferedWriter objects are collected, and collecting them flushes
1289 # all data to disk.
1290 # The Python version has __del__, so it ends into gc.garbage instead
1291 rawio = self.FileIO(support.TESTFN, "w+b")
1292 f = self.tp(rawio)
1293 f.write(b"123xxx")
1294 f.x = f
1295 wr = weakref.ref(f)
1296 del f
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001297 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001298 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001299 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001300 self.assertEqual(f.read(), b"123xxx")
1301
1302
1303class PyBufferedWriterTest(BufferedWriterTest):
1304 tp = pyio.BufferedWriter
Guido van Rossuma9e20242007-03-08 00:43:48 +00001305
Guido van Rossum01a27522007-03-07 01:00:12 +00001306class BufferedRWPairTest(unittest.TestCase):
Guido van Rossuma9e20242007-03-08 00:43:48 +00001307
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001308 def test_constructor(self):
1309 pair = self.tp(self.MockRawIO(), self.MockRawIO())
Benjamin Peterson92035012008-12-27 16:00:54 +00001310 self.assertFalse(pair.closed)
Guido van Rossum01a27522007-03-07 01:00:12 +00001311
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001312 def test_detach(self):
1313 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1314 self.assertRaises(self.UnsupportedOperation, pair.detach)
1315
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001316 def test_constructor_max_buffer_size_deprecation(self):
Florent Xicluna8fbddf12010-03-17 20:29:51 +00001317 with support.check_warnings(("max_buffer_size is deprecated",
1318 DeprecationWarning)):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001319 self.tp(self.MockRawIO(), self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001320
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001321 def test_constructor_with_not_readable(self):
1322 class NotReadable(MockRawIO):
1323 def readable(self):
1324 return False
1325
1326 self.assertRaises(IOError, self.tp, NotReadable(), self.MockRawIO())
1327
1328 def test_constructor_with_not_writeable(self):
1329 class NotWriteable(MockRawIO):
1330 def writable(self):
1331 return False
1332
1333 self.assertRaises(IOError, self.tp, self.MockRawIO(), NotWriteable())
1334
1335 def test_read(self):
1336 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1337
1338 self.assertEqual(pair.read(3), b"abc")
1339 self.assertEqual(pair.read(1), b"d")
1340 self.assertEqual(pair.read(), b"ef")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00001341 pair = self.tp(self.BytesIO(b"abc"), self.MockRawIO())
1342 self.assertEqual(pair.read(None), b"abc")
1343
1344 def test_readlines(self):
1345 pair = lambda: self.tp(self.BytesIO(b"abc\ndef\nh"), self.MockRawIO())
1346 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1347 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1348 self.assertEqual(pair().readlines(5), [b"abc\n", b"def\n"])
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001349
1350 def test_read1(self):
1351 # .read1() is delegated to the underlying reader object, so this test
1352 # can be shallow.
1353 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1354
1355 self.assertEqual(pair.read1(3), b"abc")
1356
1357 def test_readinto(self):
1358 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1359
1360 data = bytearray(5)
1361 self.assertEqual(pair.readinto(data), 5)
1362 self.assertEqual(data, b"abcde")
1363
1364 def test_write(self):
1365 w = self.MockRawIO()
1366 pair = self.tp(self.MockRawIO(), w)
1367
1368 pair.write(b"abc")
1369 pair.flush()
1370 pair.write(b"def")
1371 pair.flush()
1372 self.assertEqual(w._write_stack, [b"abc", b"def"])
1373
1374 def test_peek(self):
1375 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1376
1377 self.assertTrue(pair.peek(3).startswith(b"abc"))
1378 self.assertEqual(pair.read(3), b"abc")
1379
1380 def test_readable(self):
1381 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1382 self.assertTrue(pair.readable())
1383
1384 def test_writeable(self):
1385 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1386 self.assertTrue(pair.writable())
1387
1388 def test_seekable(self):
1389 # BufferedRWPairs are never seekable, even if their readers and writers
1390 # are.
1391 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1392 self.assertFalse(pair.seekable())
1393
1394 # .flush() is delegated to the underlying writer object and has been
1395 # tested in the test_write method.
1396
1397 def test_close_and_closed(self):
1398 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1399 self.assertFalse(pair.closed)
1400 pair.close()
1401 self.assertTrue(pair.closed)
1402
1403 def test_isatty(self):
1404 class SelectableIsAtty(MockRawIO):
1405 def __init__(self, isatty):
1406 MockRawIO.__init__(self)
1407 self._isatty = isatty
1408
1409 def isatty(self):
1410 return self._isatty
1411
1412 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(False))
1413 self.assertFalse(pair.isatty())
1414
1415 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(False))
1416 self.assertTrue(pair.isatty())
1417
1418 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(True))
1419 self.assertTrue(pair.isatty())
1420
1421 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(True))
1422 self.assertTrue(pair.isatty())
Guido van Rossum01a27522007-03-07 01:00:12 +00001423
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001424class CBufferedRWPairTest(BufferedRWPairTest):
1425 tp = io.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001426
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001427class PyBufferedRWPairTest(BufferedRWPairTest):
1428 tp = pyio.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001429
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001430
1431class BufferedRandomTest(BufferedReaderTest, BufferedWriterTest):
1432 read_mode = "rb+"
1433 write_mode = "wb+"
1434
1435 def test_constructor(self):
1436 BufferedReaderTest.test_constructor(self)
1437 BufferedWriterTest.test_constructor(self)
1438
1439 def test_read_and_write(self):
1440 raw = self.MockRawIO((b"asdf", b"ghjk"))
Benjamin Peterson59406a92009-03-26 17:10:29 +00001441 rw = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001442
1443 self.assertEqual(b"as", rw.read(2))
1444 rw.write(b"ddd")
1445 rw.write(b"eee")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001446 self.assertFalse(raw._write_stack) # Buffer writes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001447 self.assertEqual(b"ghjk", rw.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +00001448 self.assertEqual(b"dddeee", raw._write_stack[0])
Guido van Rossum01a27522007-03-07 01:00:12 +00001449
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001450 def test_seek_and_tell(self):
1451 raw = self.BytesIO(b"asdfghjkl")
1452 rw = self.tp(raw)
Guido van Rossum01a27522007-03-07 01:00:12 +00001453
Ezio Melottib3aedd42010-11-20 19:04:17 +00001454 self.assertEqual(b"as", rw.read(2))
1455 self.assertEqual(2, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001456 rw.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001457 self.assertEqual(b"asdf", rw.read(4))
Guido van Rossum01a27522007-03-07 01:00:12 +00001458
Antoine Pitroue05565e2011-08-20 14:39:23 +02001459 rw.write(b"123f")
Guido van Rossum01a27522007-03-07 01:00:12 +00001460 rw.seek(0, 0)
Antoine Pitroue05565e2011-08-20 14:39:23 +02001461 self.assertEqual(b"asdf123fl", rw.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +00001462 self.assertEqual(9, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001463 rw.seek(-4, 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001464 self.assertEqual(5, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001465 rw.seek(2, 1)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001466 self.assertEqual(7, rw.tell())
1467 self.assertEqual(b"fl", rw.read(11))
Antoine Pitroue05565e2011-08-20 14:39:23 +02001468 rw.flush()
1469 self.assertEqual(b"asdf123fl", raw.getvalue())
1470
Christian Heimes8e42a0a2007-11-08 18:04:45 +00001471 self.assertRaises(TypeError, rw.seek, 0.0)
Guido van Rossum01a27522007-03-07 01:00:12 +00001472
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001473 def check_flush_and_read(self, read_func):
1474 raw = self.BytesIO(b"abcdefghi")
1475 bufio = self.tp(raw)
1476
Ezio Melottib3aedd42010-11-20 19:04:17 +00001477 self.assertEqual(b"ab", read_func(bufio, 2))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001478 bufio.write(b"12")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001479 self.assertEqual(b"ef", read_func(bufio, 2))
1480 self.assertEqual(6, bufio.tell())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001481 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001482 self.assertEqual(6, bufio.tell())
1483 self.assertEqual(b"ghi", read_func(bufio))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001484 raw.seek(0, 0)
1485 raw.write(b"XYZ")
1486 # flush() resets the read buffer
1487 bufio.flush()
1488 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001489 self.assertEqual(b"XYZ", read_func(bufio, 3))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001490
1491 def test_flush_and_read(self):
1492 self.check_flush_and_read(lambda bufio, *args: bufio.read(*args))
1493
1494 def test_flush_and_readinto(self):
1495 def _readinto(bufio, n=-1):
1496 b = bytearray(n if n >= 0 else 9999)
1497 n = bufio.readinto(b)
1498 return bytes(b[:n])
1499 self.check_flush_and_read(_readinto)
1500
1501 def test_flush_and_peek(self):
1502 def _peek(bufio, n=-1):
1503 # This relies on the fact that the buffer can contain the whole
1504 # raw stream, otherwise peek() can return less.
1505 b = bufio.peek(n)
1506 if n != -1:
1507 b = b[:n]
1508 bufio.seek(len(b), 1)
1509 return b
1510 self.check_flush_and_read(_peek)
1511
1512 def test_flush_and_write(self):
1513 raw = self.BytesIO(b"abcdefghi")
1514 bufio = self.tp(raw)
1515
1516 bufio.write(b"123")
1517 bufio.flush()
1518 bufio.write(b"45")
1519 bufio.flush()
1520 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001521 self.assertEqual(b"12345fghi", raw.getvalue())
1522 self.assertEqual(b"12345fghi", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001523
1524 def test_threads(self):
1525 BufferedReaderTest.test_threads(self)
1526 BufferedWriterTest.test_threads(self)
1527
1528 def test_writes_and_peek(self):
1529 def _peek(bufio):
1530 bufio.peek(1)
1531 self.check_writes(_peek)
1532 def _peek(bufio):
1533 pos = bufio.tell()
1534 bufio.seek(-1, 1)
1535 bufio.peek(1)
1536 bufio.seek(pos, 0)
1537 self.check_writes(_peek)
1538
1539 def test_writes_and_reads(self):
1540 def _read(bufio):
1541 bufio.seek(-1, 1)
1542 bufio.read(1)
1543 self.check_writes(_read)
1544
1545 def test_writes_and_read1s(self):
1546 def _read1(bufio):
1547 bufio.seek(-1, 1)
1548 bufio.read1(1)
1549 self.check_writes(_read1)
1550
1551 def test_writes_and_readintos(self):
1552 def _read(bufio):
1553 bufio.seek(-1, 1)
1554 bufio.readinto(bytearray(1))
1555 self.check_writes(_read)
1556
Antoine Pitroua0ceb732009-08-06 20:29:56 +00001557 def test_write_after_readahead(self):
1558 # Issue #6629: writing after the buffer was filled by readahead should
1559 # first rewind the raw stream.
1560 for overwrite_size in [1, 5]:
1561 raw = self.BytesIO(b"A" * 10)
1562 bufio = self.tp(raw, 4)
1563 # Trigger readahead
1564 self.assertEqual(bufio.read(1), b"A")
1565 self.assertEqual(bufio.tell(), 1)
1566 # Overwriting should rewind the raw stream if it needs so
1567 bufio.write(b"B" * overwrite_size)
1568 self.assertEqual(bufio.tell(), overwrite_size + 1)
1569 # If the write size was smaller than the buffer size, flush() and
1570 # check that rewind happens.
1571 bufio.flush()
1572 self.assertEqual(bufio.tell(), overwrite_size + 1)
1573 s = raw.getvalue()
1574 self.assertEqual(s,
1575 b"A" + b"B" * overwrite_size + b"A" * (9 - overwrite_size))
1576
Antoine Pitrou7c404892011-05-13 00:13:33 +02001577 def test_write_rewind_write(self):
1578 # Various combinations of reading / writing / seeking backwards / writing again
1579 def mutate(bufio, pos1, pos2):
1580 assert pos2 >= pos1
1581 # Fill the buffer
1582 bufio.seek(pos1)
1583 bufio.read(pos2 - pos1)
1584 bufio.write(b'\x02')
1585 # This writes earlier than the previous write, but still inside
1586 # the buffer.
1587 bufio.seek(pos1)
1588 bufio.write(b'\x01')
1589
1590 b = b"\x80\x81\x82\x83\x84"
1591 for i in range(0, len(b)):
1592 for j in range(i, len(b)):
1593 raw = self.BytesIO(b)
1594 bufio = self.tp(raw, 100)
1595 mutate(bufio, i, j)
1596 bufio.flush()
1597 expected = bytearray(b)
1598 expected[j] = 2
1599 expected[i] = 1
1600 self.assertEqual(raw.getvalue(), expected,
1601 "failed result for i=%d, j=%d" % (i, j))
1602
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001603 def test_truncate_after_read_or_write(self):
1604 raw = self.BytesIO(b"A" * 10)
1605 bufio = self.tp(raw, 100)
1606 self.assertEqual(bufio.read(2), b"AA") # the read buffer gets filled
1607 self.assertEqual(bufio.truncate(), 2)
1608 self.assertEqual(bufio.write(b"BB"), 2) # the write buffer increases
1609 self.assertEqual(bufio.truncate(), 4)
1610
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001611 def test_misbehaved_io(self):
1612 BufferedReaderTest.test_misbehaved_io(self)
1613 BufferedWriterTest.test_misbehaved_io(self)
1614
Antoine Pitroue05565e2011-08-20 14:39:23 +02001615 def test_interleaved_read_write(self):
1616 # Test for issue #12213
1617 with self.BytesIO(b'abcdefgh') as raw:
1618 with self.tp(raw, 100) as f:
1619 f.write(b"1")
1620 self.assertEqual(f.read(1), b'b')
1621 f.write(b'2')
1622 self.assertEqual(f.read1(1), b'd')
1623 f.write(b'3')
1624 buf = bytearray(1)
1625 f.readinto(buf)
1626 self.assertEqual(buf, b'f')
1627 f.write(b'4')
1628 self.assertEqual(f.peek(1), b'h')
1629 f.flush()
1630 self.assertEqual(raw.getvalue(), b'1b2d3f4h')
1631
1632 with self.BytesIO(b'abc') as raw:
1633 with self.tp(raw, 100) as f:
1634 self.assertEqual(f.read(1), b'a')
1635 f.write(b"2")
1636 self.assertEqual(f.read(1), b'c')
1637 f.flush()
1638 self.assertEqual(raw.getvalue(), b'a2c')
1639
1640 def test_interleaved_readline_write(self):
1641 with self.BytesIO(b'ab\ncdef\ng\n') as raw:
1642 with self.tp(raw) as f:
1643 f.write(b'1')
1644 self.assertEqual(f.readline(), b'b\n')
1645 f.write(b'2')
1646 self.assertEqual(f.readline(), b'def\n')
1647 f.write(b'3')
1648 self.assertEqual(f.readline(), b'\n')
1649 f.flush()
1650 self.assertEqual(raw.getvalue(), b'1b\n2def\n3\n')
1651
Antoine Pitrou0d739d72010-09-05 23:01:12 +00001652 # You can't construct a BufferedRandom over a non-seekable stream.
1653 test_unseekable = None
1654
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001655class CBufferedRandomTest(BufferedRandomTest):
1656 tp = io.BufferedRandom
1657
1658 def test_constructor(self):
1659 BufferedRandomTest.test_constructor(self)
1660 # The allocation can succeed on 32-bit builds, e.g. with more
1661 # than 2GB RAM and a 64-bit kernel.
1662 if sys.maxsize > 0x7FFFFFFF:
1663 rawio = self.MockRawIO()
1664 bufio = self.tp(rawio)
1665 self.assertRaises((OverflowError, MemoryError, ValueError),
1666 bufio.__init__, rawio, sys.maxsize)
1667
1668 def test_garbage_collection(self):
1669 CBufferedReaderTest.test_garbage_collection(self)
1670 CBufferedWriterTest.test_garbage_collection(self)
1671
1672class PyBufferedRandomTest(BufferedRandomTest):
1673 tp = pyio.BufferedRandom
1674
1675
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001676# To fully exercise seek/tell, the StatefulIncrementalDecoder has these
1677# properties:
1678# - A single output character can correspond to many bytes of input.
1679# - The number of input bytes to complete the character can be
1680# undetermined until the last input byte is received.
1681# - The number of input bytes can vary depending on previous input.
1682# - A single input byte can correspond to many characters of output.
1683# - The number of output characters can be undetermined until the
1684# last input byte is received.
1685# - The number of output characters can vary depending on previous input.
1686
1687class StatefulIncrementalDecoder(codecs.IncrementalDecoder):
1688 """
1689 For testing seek/tell behavior with a stateful, buffering decoder.
1690
1691 Input is a sequence of words. Words may be fixed-length (length set
1692 by input) or variable-length (period-terminated). In variable-length
1693 mode, extra periods are ignored. Possible words are:
1694 - 'i' followed by a number sets the input length, I (maximum 99).
1695 When I is set to 0, words are space-terminated.
1696 - 'o' followed by a number sets the output length, O (maximum 99).
1697 - Any other word is converted into a word followed by a period on
1698 the output. The output word consists of the input word truncated
1699 or padded out with hyphens to make its length equal to O. If O
1700 is 0, the word is output verbatim without truncating or padding.
1701 I and O are initially set to 1. When I changes, any buffered input is
1702 re-scanned according to the new I. EOF also terminates the last word.
1703 """
1704
1705 def __init__(self, errors='strict'):
Christian Heimesab568872008-03-23 02:11:13 +00001706 codecs.IncrementalDecoder.__init__(self, errors)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001707 self.reset()
1708
1709 def __repr__(self):
1710 return '<SID %x>' % id(self)
1711
1712 def reset(self):
1713 self.i = 1
1714 self.o = 1
1715 self.buffer = bytearray()
1716
1717 def getstate(self):
1718 i, o = self.i ^ 1, self.o ^ 1 # so that flags = 0 after reset()
1719 return bytes(self.buffer), i*100 + o
1720
1721 def setstate(self, state):
1722 buffer, io = state
1723 self.buffer = bytearray(buffer)
1724 i, o = divmod(io, 100)
1725 self.i, self.o = i ^ 1, o ^ 1
1726
1727 def decode(self, input, final=False):
1728 output = ''
1729 for b in input:
1730 if self.i == 0: # variable-length, terminated with period
1731 if b == ord('.'):
1732 if self.buffer:
1733 output += self.process_word()
1734 else:
1735 self.buffer.append(b)
1736 else: # fixed-length, terminate after self.i bytes
1737 self.buffer.append(b)
1738 if len(self.buffer) == self.i:
1739 output += self.process_word()
1740 if final and self.buffer: # EOF terminates the last word
1741 output += self.process_word()
1742 return output
1743
1744 def process_word(self):
1745 output = ''
1746 if self.buffer[0] == ord('i'):
1747 self.i = min(99, int(self.buffer[1:] or 0)) # set input length
1748 elif self.buffer[0] == ord('o'):
1749 self.o = min(99, int(self.buffer[1:] or 0)) # set output length
1750 else:
1751 output = self.buffer.decode('ascii')
1752 if len(output) < self.o:
1753 output += '-'*self.o # pad out with hyphens
1754 if self.o:
1755 output = output[:self.o] # truncate to output length
1756 output += '.'
1757 self.buffer = bytearray()
1758 return output
1759
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001760 codecEnabled = False
1761
1762 @classmethod
1763 def lookupTestDecoder(cls, name):
1764 if cls.codecEnabled and name == 'test_decoder':
Antoine Pitrou180a3362008-12-14 16:36:46 +00001765 latin1 = codecs.lookup('latin-1')
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001766 return codecs.CodecInfo(
Antoine Pitrou180a3362008-12-14 16:36:46 +00001767 name='test_decoder', encode=latin1.encode, decode=None,
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001768 incrementalencoder=None,
1769 streamreader=None, streamwriter=None,
1770 incrementaldecoder=cls)
1771
1772# Register the previous decoder for testing.
1773# Disabled by default, tests will enable it.
1774codecs.register(StatefulIncrementalDecoder.lookupTestDecoder)
1775
1776
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001777class StatefulIncrementalDecoderTest(unittest.TestCase):
1778 """
1779 Make sure the StatefulIncrementalDecoder actually works.
1780 """
1781
1782 test_cases = [
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001783 # I=1, O=1 (fixed-length input == fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001784 (b'abcd', False, 'a.b.c.d.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001785 # I=0, O=0 (variable-length input, variable-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001786 (b'oiabcd', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001787 # I=0, O=0 (should ignore extra periods)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001788 (b'oi...abcd...', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001789 # I=0, O=6 (variable-length input, fixed-length output)
1790 (b'i.o6.x.xyz.toolongtofit.', False, 'x-----.xyz---.toolon.'),
1791 # I=2, O=6 (fixed-length input < fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001792 (b'i.i2.o6xyz', True, 'xy----.z-----.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001793 # I=6, O=3 (fixed-length input > fixed-length output)
1794 (b'i.o3.i6.abcdefghijklmnop', True, 'abc.ghi.mno.'),
1795 # I=0, then 3; O=29, then 15 (with longer output)
1796 (b'i.o29.a.b.cde.o15.abcdefghijabcdefghij.i3.a.b.c.d.ei00k.l.m', True,
1797 'a----------------------------.' +
1798 'b----------------------------.' +
1799 'cde--------------------------.' +
1800 'abcdefghijabcde.' +
1801 'a.b------------.' +
1802 '.c.------------.' +
1803 'd.e------------.' +
1804 'k--------------.' +
1805 'l--------------.' +
1806 'm--------------.')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001807 ]
1808
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001809 def test_decoder(self):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001810 # Try a few one-shot test cases.
1811 for input, eof, output in self.test_cases:
1812 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001813 self.assertEqual(d.decode(input, eof), output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001814
1815 # Also test an unfinished decode, followed by forcing EOF.
1816 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001817 self.assertEqual(d.decode(b'oiabcd'), '')
1818 self.assertEqual(d.decode(b'', 1), 'abcd.')
Guido van Rossum78892e42007-04-06 17:31:18 +00001819
1820class TextIOWrapperTest(unittest.TestCase):
Guido van Rossum9b76da62007-04-11 01:09:03 +00001821
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001822 def setUp(self):
1823 self.testdata = b"AAA\r\nBBB\rCCC\r\nDDD\nEEE\r\n"
1824 self.normalized = b"AAA\nBBB\nCCC\nDDD\nEEE\n".decode("ascii")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001825 support.unlink(support.TESTFN)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001826
Guido van Rossumd0712812007-04-11 16:32:43 +00001827 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001828 support.unlink(support.TESTFN)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001829
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001830 def test_constructor(self):
1831 r = self.BytesIO(b"\xc3\xa9\n\n")
1832 b = self.BufferedReader(r, 1000)
1833 t = self.TextIOWrapper(b)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001834 t.__init__(b, encoding="latin-1", newline="\r\n")
1835 self.assertEqual(t.encoding, "latin-1")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001836 self.assertEqual(t.line_buffering, False)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001837 t.__init__(b, encoding="utf-8", line_buffering=True)
1838 self.assertEqual(t.encoding, "utf-8")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001839 self.assertEqual(t.line_buffering, True)
1840 self.assertEqual("\xe9\n", t.readline())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001841 self.assertRaises(TypeError, t.__init__, b, newline=42)
1842 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
1843
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001844 def test_detach(self):
1845 r = self.BytesIO()
1846 b = self.BufferedWriter(r)
1847 t = self.TextIOWrapper(b)
1848 self.assertIs(t.detach(), b)
1849
1850 t = self.TextIOWrapper(b, encoding="ascii")
1851 t.write("howdy")
1852 self.assertFalse(r.getvalue())
1853 t.detach()
1854 self.assertEqual(r.getvalue(), b"howdy")
1855 self.assertRaises(ValueError, t.detach)
1856
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001857 def test_repr(self):
1858 raw = self.BytesIO("hello".encode("utf-8"))
1859 b = self.BufferedReader(raw)
1860 t = self.TextIOWrapper(b, encoding="utf-8")
Antoine Pitrou716c4442009-05-23 19:04:03 +00001861 modname = self.TextIOWrapper.__module__
1862 self.assertEqual(repr(t),
1863 "<%s.TextIOWrapper encoding='utf-8'>" % modname)
1864 raw.name = "dummy"
1865 self.assertEqual(repr(t),
1866 "<%s.TextIOWrapper name='dummy' encoding='utf-8'>" % modname)
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001867 t.mode = "r"
1868 self.assertEqual(repr(t),
1869 "<%s.TextIOWrapper name='dummy' mode='r' encoding='utf-8'>" % modname)
Antoine Pitrou716c4442009-05-23 19:04:03 +00001870 raw.name = b"dummy"
1871 self.assertEqual(repr(t),
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001872 "<%s.TextIOWrapper name=b'dummy' mode='r' encoding='utf-8'>" % modname)
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001873
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001874 def test_line_buffering(self):
1875 r = self.BytesIO()
1876 b = self.BufferedWriter(r, 1000)
1877 t = self.TextIOWrapper(b, newline="\n", line_buffering=True)
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001878 t.write("X")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001879 self.assertEqual(r.getvalue(), b"") # No flush happened
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001880 t.write("Y\nZ")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001881 self.assertEqual(r.getvalue(), b"XY\nZ") # All got flushed
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001882 t.write("A\rB")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001883 self.assertEqual(r.getvalue(), b"XY\nZA\rB")
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001884
Victor Stinnerf86a5e82012-06-05 13:43:22 +02001885 def test_default_encoding(self):
1886 old_environ = dict(os.environ)
1887 try:
1888 # try to get a user preferred encoding different than the current
1889 # locale encoding to check that TextIOWrapper() uses the current
1890 # locale encoding and not the user preferred encoding
1891 for key in ('LC_ALL', 'LANG', 'LC_CTYPE'):
1892 if key in os.environ:
1893 del os.environ[key]
1894
1895 current_locale_encoding = locale.getpreferredencoding(False)
1896 b = self.BytesIO()
1897 t = self.TextIOWrapper(b)
1898 self.assertEqual(t.encoding, current_locale_encoding)
1899 finally:
1900 os.environ.clear()
1901 os.environ.update(old_environ)
1902
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001903 def test_encoding(self):
1904 # Check the encoding attribute is always set, and valid
1905 b = self.BytesIO()
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001906 t = self.TextIOWrapper(b, encoding="utf-8")
1907 self.assertEqual(t.encoding, "utf-8")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001908 t = self.TextIOWrapper(b)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001909 self.assertTrue(t.encoding is not None)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001910 codecs.lookup(t.encoding)
1911
1912 def test_encoding_errors_reading(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001913 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001914 b = self.BytesIO(b"abc\n\xff\n")
1915 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001916 self.assertRaises(UnicodeError, t.read)
1917 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001918 b = self.BytesIO(b"abc\n\xff\n")
1919 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001920 self.assertRaises(UnicodeError, t.read)
1921 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001922 b = self.BytesIO(b"abc\n\xff\n")
1923 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001924 self.assertEqual(t.read(), "abc\n\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001925 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001926 b = self.BytesIO(b"abc\n\xff\n")
1927 t = self.TextIOWrapper(b, encoding="ascii", errors="replace")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001928 self.assertEqual(t.read(), "abc\n\ufffd\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001929
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001930 def test_encoding_errors_writing(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001931 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001932 b = self.BytesIO()
1933 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001934 self.assertRaises(UnicodeError, t.write, "\xff")
1935 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001936 b = self.BytesIO()
1937 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001938 self.assertRaises(UnicodeError, t.write, "\xff")
1939 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001940 b = self.BytesIO()
1941 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001942 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001943 t.write("abc\xffdef\n")
1944 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001945 self.assertEqual(b.getvalue(), b"abcdef\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001946 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001947 b = self.BytesIO()
1948 t = self.TextIOWrapper(b, encoding="ascii", errors="replace",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001949 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001950 t.write("abc\xffdef\n")
1951 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001952 self.assertEqual(b.getvalue(), b"abc?def\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001953
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001954 def test_newlines(self):
Guido van Rossum78892e42007-04-06 17:31:18 +00001955 input_lines = [ "unix\n", "windows\r\n", "os9\r", "last\n", "nonl" ]
1956
1957 tests = [
1958 [ None, [ 'unix\n', 'windows\n', 'os9\n', 'last\n', 'nonl' ] ],
Guido van Rossum8358db22007-08-18 21:39:55 +00001959 [ '', input_lines ],
1960 [ '\n', [ "unix\n", "windows\r\n", "os9\rlast\n", "nonl" ] ],
1961 [ '\r\n', [ "unix\nwindows\r\n", "os9\rlast\nnonl" ] ],
1962 [ '\r', [ "unix\nwindows\r", "\nos9\r", "last\nnonl" ] ],
Guido van Rossum78892e42007-04-06 17:31:18 +00001963 ]
Antoine Pitrou180a3362008-12-14 16:36:46 +00001964 encodings = (
1965 'utf-8', 'latin-1',
1966 'utf-16', 'utf-16-le', 'utf-16-be',
1967 'utf-32', 'utf-32-le', 'utf-32-be',
1968 )
Guido van Rossum78892e42007-04-06 17:31:18 +00001969
Guido van Rossum8358db22007-08-18 21:39:55 +00001970 # Try a range of buffer sizes to test the case where \r is the last
Guido van Rossum78892e42007-04-06 17:31:18 +00001971 # character in TextIOWrapper._pending_line.
1972 for encoding in encodings:
Guido van Rossum8358db22007-08-18 21:39:55 +00001973 # XXX: str.encode() should return bytes
1974 data = bytes(''.join(input_lines).encode(encoding))
Guido van Rossum78892e42007-04-06 17:31:18 +00001975 for do_reads in (False, True):
Guido van Rossum8358db22007-08-18 21:39:55 +00001976 for bufsize in range(1, 10):
1977 for newline, exp_lines in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001978 bufio = self.BufferedReader(self.BytesIO(data), bufsize)
1979 textio = self.TextIOWrapper(bufio, newline=newline,
Guido van Rossum78892e42007-04-06 17:31:18 +00001980 encoding=encoding)
1981 if do_reads:
1982 got_lines = []
1983 while True:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001984 c2 = textio.read(2)
Guido van Rossum78892e42007-04-06 17:31:18 +00001985 if c2 == '':
1986 break
Ezio Melottib3aedd42010-11-20 19:04:17 +00001987 self.assertEqual(len(c2), 2)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001988 got_lines.append(c2 + textio.readline())
Guido van Rossum78892e42007-04-06 17:31:18 +00001989 else:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001990 got_lines = list(textio)
Guido van Rossum78892e42007-04-06 17:31:18 +00001991
1992 for got_line, exp_line in zip(got_lines, exp_lines):
Ezio Melottib3aedd42010-11-20 19:04:17 +00001993 self.assertEqual(got_line, exp_line)
1994 self.assertEqual(len(got_lines), len(exp_lines))
Guido van Rossum78892e42007-04-06 17:31:18 +00001995
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001996 def test_newlines_input(self):
1997 testdata = b"AAA\nBB\x00B\nCCC\rDDD\rEEE\r\nFFF\r\nGGG"
Guido van Rossum8358db22007-08-18 21:39:55 +00001998 normalized = testdata.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
1999 for newline, expected in [
Ezio Melottid8b509b2011-09-28 17:37:55 +03002000 (None, normalized.decode("ascii").splitlines(keepends=True)),
2001 ("", testdata.decode("ascii").splitlines(keepends=True)),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002002 ("\n", ["AAA\n", "BB\x00B\n", "CCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
2003 ("\r\n", ["AAA\nBB\x00B\nCCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
2004 ("\r", ["AAA\nBB\x00B\nCCC\r", "DDD\r", "EEE\r", "\nFFF\r", "\nGGG"]),
Guido van Rossum8358db22007-08-18 21:39:55 +00002005 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002006 buf = self.BytesIO(testdata)
2007 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002008 self.assertEqual(txt.readlines(), expected)
Guido van Rossum8358db22007-08-18 21:39:55 +00002009 txt.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002010 self.assertEqual(txt.read(), "".join(expected))
Guido van Rossum8358db22007-08-18 21:39:55 +00002011
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002012 def test_newlines_output(self):
2013 testdict = {
2014 "": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
2015 "\n": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
2016 "\r": b"AAA\rBBB\rCCC\rX\rY\r\rZ",
2017 "\r\n": b"AAA\r\nBBB\r\nCCC\r\nX\rY\r\r\nZ",
2018 }
2019 tests = [(None, testdict[os.linesep])] + sorted(testdict.items())
2020 for newline, expected in tests:
2021 buf = self.BytesIO()
2022 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
2023 txt.write("AAA\nB")
2024 txt.write("BB\nCCC\n")
2025 txt.write("X\rY\r\nZ")
2026 txt.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002027 self.assertEqual(buf.closed, False)
2028 self.assertEqual(buf.getvalue(), expected)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002029
2030 def test_destructor(self):
2031 l = []
2032 base = self.BytesIO
2033 class MyBytesIO(base):
2034 def close(self):
2035 l.append(self.getvalue())
2036 base.close(self)
2037 b = MyBytesIO()
2038 t = self.TextIOWrapper(b, encoding="ascii")
2039 t.write("abc")
2040 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002041 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002042 self.assertEqual([b"abc"], l)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002043
2044 def test_override_destructor(self):
2045 record = []
2046 class MyTextIO(self.TextIOWrapper):
2047 def __del__(self):
2048 record.append(1)
2049 try:
2050 f = super().__del__
2051 except AttributeError:
2052 pass
2053 else:
2054 f()
2055 def close(self):
2056 record.append(2)
2057 super().close()
2058 def flush(self):
2059 record.append(3)
2060 super().flush()
2061 b = self.BytesIO()
2062 t = MyTextIO(b, encoding="ascii")
2063 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002064 support.gc_collect()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002065 self.assertEqual(record, [1, 2, 3])
2066
2067 def test_error_through_destructor(self):
2068 # Test that the exception state is not modified by a destructor,
2069 # even if close() fails.
2070 rawio = self.CloseFailureIO()
2071 def f():
2072 self.TextIOWrapper(rawio).xyzzy
2073 with support.captured_output("stderr") as s:
2074 self.assertRaises(AttributeError, f)
2075 s = s.getvalue().strip()
2076 if s:
2077 # The destructor *may* have printed an unraisable error, check it
2078 self.assertEqual(len(s.splitlines()), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002079 self.assertTrue(s.startswith("Exception IOError: "), s)
2080 self.assertTrue(s.endswith(" ignored"), s)
Guido van Rossum8358db22007-08-18 21:39:55 +00002081
Guido van Rossum9b76da62007-04-11 01:09:03 +00002082 # Systematic tests of the text I/O API
2083
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002084 def test_basic_io(self):
Guido van Rossum9b76da62007-04-11 01:09:03 +00002085 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 +00002086 for enc in "ascii", "latin-1", "utf-8" :# , "utf-16-be", "utf-16-le":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002087 f = self.open(support.TESTFN, "w+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002088 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00002089 self.assertEqual(f.write("abc"), 3)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002090 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002091 f = self.open(support.TESTFN, "r+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002092 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00002093 self.assertEqual(f.tell(), 0)
2094 self.assertEqual(f.read(), "abc")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002095 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002096 self.assertEqual(f.seek(0), 0)
2097 self.assertEqual(f.read(None), "abc")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00002098 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002099 self.assertEqual(f.read(2), "ab")
2100 self.assertEqual(f.read(1), "c")
2101 self.assertEqual(f.read(1), "")
2102 self.assertEqual(f.read(), "")
2103 self.assertEqual(f.tell(), cookie)
2104 self.assertEqual(f.seek(0), 0)
2105 self.assertEqual(f.seek(0, 2), cookie)
2106 self.assertEqual(f.write("def"), 3)
2107 self.assertEqual(f.seek(cookie), cookie)
2108 self.assertEqual(f.read(), "def")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002109 if enc.startswith("utf"):
2110 self.multi_line_test(f, enc)
2111 f.close()
2112
2113 def multi_line_test(self, f, enc):
2114 f.seek(0)
2115 f.truncate()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002116 sample = "s\xff\u0fff\uffff"
Guido van Rossum9b76da62007-04-11 01:09:03 +00002117 wlines = []
Guido van Rossumcba608c2007-04-11 14:19:59 +00002118 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 +00002119 chars = []
Guido van Rossum805365e2007-05-07 22:24:25 +00002120 for i in range(size):
Guido van Rossum9b76da62007-04-11 01:09:03 +00002121 chars.append(sample[i % len(sample)])
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002122 line = "".join(chars) + "\n"
Guido van Rossum9b76da62007-04-11 01:09:03 +00002123 wlines.append((f.tell(), line))
2124 f.write(line)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002125 f.seek(0)
2126 rlines = []
2127 while True:
2128 pos = f.tell()
2129 line = f.readline()
2130 if not line:
Guido van Rossum9b76da62007-04-11 01:09:03 +00002131 break
2132 rlines.append((pos, line))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002133 self.assertEqual(rlines, wlines)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002134
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002135 def test_telling(self):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00002136 f = self.open(support.TESTFN, "w+", encoding="utf-8")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002137 p0 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002138 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002139 p1 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002140 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002141 p2 = f.tell()
2142 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002143 self.assertEqual(f.tell(), p0)
2144 self.assertEqual(f.readline(), "\xff\n")
2145 self.assertEqual(f.tell(), p1)
2146 self.assertEqual(f.readline(), "\xff\n")
2147 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002148 f.seek(0)
2149 for line in f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002150 self.assertEqual(line, "\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002151 self.assertRaises(IOError, f.tell)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002152 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002153 f.close()
2154
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002155 def test_seeking(self):
2156 chunk_size = _default_chunk_size()
Guido van Rossumd76e7792007-04-17 02:38:04 +00002157 prefix_size = chunk_size - 2
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002158 u_prefix = "a" * prefix_size
Guido van Rossumd76e7792007-04-17 02:38:04 +00002159 prefix = bytes(u_prefix.encode("utf-8"))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002160 self.assertEqual(len(u_prefix), len(prefix))
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002161 u_suffix = "\u8888\n"
Guido van Rossumd76e7792007-04-17 02:38:04 +00002162 suffix = bytes(u_suffix.encode("utf-8"))
2163 line = prefix + suffix
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002164 with self.open(support.TESTFN, "wb") as f:
2165 f.write(line*2)
2166 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2167 s = f.read(prefix_size)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002168 self.assertEqual(s, str(prefix, "ascii"))
2169 self.assertEqual(f.tell(), prefix_size)
2170 self.assertEqual(f.readline(), u_suffix)
Guido van Rossumd76e7792007-04-17 02:38:04 +00002171
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002172 def test_seeking_too(self):
Guido van Rossumd76e7792007-04-17 02:38:04 +00002173 # Regression test for a specific bug
2174 data = b'\xe0\xbf\xbf\n'
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002175 with self.open(support.TESTFN, "wb") as f:
2176 f.write(data)
2177 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2178 f._CHUNK_SIZE # Just test that it exists
2179 f._CHUNK_SIZE = 2
2180 f.readline()
2181 f.tell()
Guido van Rossumd76e7792007-04-17 02:38:04 +00002182
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002183 def test_seek_and_tell(self):
2184 #Test seek/tell using the StatefulIncrementalDecoder.
2185 # Make test faster by doing smaller seeks
2186 CHUNK_SIZE = 128
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002187
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002188 def test_seek_and_tell_with_data(data, min_pos=0):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002189 """Tell/seek to various points within a data stream and ensure
2190 that the decoded data returned by read() is consistent."""
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002191 f = self.open(support.TESTFN, 'wb')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002192 f.write(data)
2193 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002194 f = self.open(support.TESTFN, encoding='test_decoder')
2195 f._CHUNK_SIZE = CHUNK_SIZE
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002196 decoded = f.read()
2197 f.close()
2198
Neal Norwitze2b07052008-03-18 19:52:05 +00002199 for i in range(min_pos, len(decoded) + 1): # seek positions
2200 for j in [1, 5, len(decoded) - i]: # read lengths
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002201 f = self.open(support.TESTFN, encoding='test_decoder')
Ezio Melottib3aedd42010-11-20 19:04:17 +00002202 self.assertEqual(f.read(i), decoded[:i])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002203 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002204 self.assertEqual(f.read(j), decoded[i:i + j])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002205 f.seek(cookie)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002206 self.assertEqual(f.read(), decoded[i:])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002207 f.close()
2208
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002209 # Enable the test decoder.
2210 StatefulIncrementalDecoder.codecEnabled = 1
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002211
2212 # Run the tests.
2213 try:
2214 # Try each test case.
2215 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002216 test_seek_and_tell_with_data(input)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002217
2218 # Position each test case so that it crosses a chunk boundary.
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002219 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
2220 offset = CHUNK_SIZE - len(input)//2
2221 prefix = b'.'*offset
2222 # Don't bother seeking into the prefix (takes too long).
2223 min_pos = offset*2
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002224 test_seek_and_tell_with_data(prefix + input, min_pos)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002225
2226 # Ensure our test decoder won't interfere with subsequent tests.
2227 finally:
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002228 StatefulIncrementalDecoder.codecEnabled = 0
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002229
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002230 def test_encoded_writes(self):
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002231 data = "1234567890"
2232 tests = ("utf-16",
2233 "utf-16-le",
2234 "utf-16-be",
2235 "utf-32",
2236 "utf-32-le",
2237 "utf-32-be")
2238 for encoding in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002239 buf = self.BytesIO()
2240 f = self.TextIOWrapper(buf, encoding=encoding)
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002241 # Check if the BOM is written only once (see issue1753).
2242 f.write(data)
2243 f.write(data)
2244 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002245 self.assertEqual(f.read(), data * 2)
Benjamin Peterson9363a652009-03-05 00:42:09 +00002246 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002247 self.assertEqual(f.read(), data * 2)
2248 self.assertEqual(buf.getvalue(), (data * 2).encode(encoding))
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002249
Benjamin Petersona1b49012009-03-31 23:11:32 +00002250 def test_unreadable(self):
2251 class UnReadable(self.BytesIO):
2252 def readable(self):
2253 return False
2254 txt = self.TextIOWrapper(UnReadable())
2255 self.assertRaises(IOError, txt.read)
2256
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002257 def test_read_one_by_one(self):
2258 txt = self.TextIOWrapper(self.BytesIO(b"AA\r\nBB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002259 reads = ""
2260 while True:
2261 c = txt.read(1)
2262 if not c:
2263 break
2264 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002265 self.assertEqual(reads, "AA\nBB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002266
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00002267 def test_readlines(self):
2268 txt = self.TextIOWrapper(self.BytesIO(b"AA\nBB\nCC"))
2269 self.assertEqual(txt.readlines(), ["AA\n", "BB\n", "CC"])
2270 txt.seek(0)
2271 self.assertEqual(txt.readlines(None), ["AA\n", "BB\n", "CC"])
2272 txt.seek(0)
2273 self.assertEqual(txt.readlines(5), ["AA\n", "BB\n"])
2274
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002275 # read in amounts equal to TextIOWrapper._CHUNK_SIZE which is 128.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002276 def test_read_by_chunk(self):
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002277 # make sure "\r\n" straddles 128 char boundary.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002278 txt = self.TextIOWrapper(self.BytesIO(b"A" * 127 + b"\r\nB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002279 reads = ""
2280 while True:
2281 c = txt.read(128)
2282 if not c:
2283 break
2284 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002285 self.assertEqual(reads, "A"*127+"\nB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002286
2287 def test_issue1395_1(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002288 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002289
2290 # read one char at a time
2291 reads = ""
2292 while True:
2293 c = txt.read(1)
2294 if not c:
2295 break
2296 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002297 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002298
2299 def test_issue1395_2(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 txt._CHUNK_SIZE = 4
2302
2303 reads = ""
2304 while True:
2305 c = txt.read(4)
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_3(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 = txt.read(4)
2316 reads += txt.read(4)
2317 reads += txt.readline()
2318 reads += txt.readline()
2319 reads += txt.readline()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002320 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002321
2322 def test_issue1395_4(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002323 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002324 txt._CHUNK_SIZE = 4
2325
2326 reads = txt.read(4)
2327 reads += txt.read()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002328 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002329
2330 def test_issue1395_5(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002331 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002332 txt._CHUNK_SIZE = 4
2333
2334 reads = txt.read(4)
2335 pos = txt.tell()
2336 txt.seek(0)
2337 txt.seek(pos)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002338 self.assertEqual(txt.read(4), "BBB\n")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002339
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002340 def test_issue2282(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002341 buffer = self.BytesIO(self.testdata)
2342 txt = self.TextIOWrapper(buffer, encoding="ascii")
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002343
2344 self.assertEqual(buffer.seekable(), txt.seekable())
2345
Antoine Pitroue4501852009-05-14 18:55:55 +00002346 def test_append_bom(self):
2347 # The BOM is not written again when appending to a non-empty file
2348 filename = support.TESTFN
2349 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2350 with self.open(filename, 'w', encoding=charset) as f:
2351 f.write('aaa')
2352 pos = f.tell()
2353 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002354 self.assertEqual(f.read(), 'aaa'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002355
2356 with self.open(filename, 'a', encoding=charset) as f:
2357 f.write('xxx')
2358 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002359 self.assertEqual(f.read(), 'aaaxxx'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002360
2361 def test_seek_bom(self):
2362 # Same test, but when seeking manually
2363 filename = support.TESTFN
2364 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2365 with self.open(filename, 'w', encoding=charset) as f:
2366 f.write('aaa')
2367 pos = f.tell()
2368 with self.open(filename, 'r+', encoding=charset) as f:
2369 f.seek(pos)
2370 f.write('zzz')
2371 f.seek(0)
2372 f.write('bbb')
2373 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002374 self.assertEqual(f.read(), 'bbbzzz'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002375
Benjamin Peterson0926ad12009-06-06 18:02:12 +00002376 def test_errors_property(self):
2377 with self.open(support.TESTFN, "w") as f:
2378 self.assertEqual(f.errors, "strict")
2379 with self.open(support.TESTFN, "w", errors="replace") as f:
2380 self.assertEqual(f.errors, "replace")
2381
Brett Cannon31f59292011-02-21 19:29:56 +00002382 @support.no_tracing
Victor Stinner45df8202010-04-28 22:31:17 +00002383 @unittest.skipUnless(threading, 'Threading required for this test.')
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002384 def test_threads_write(self):
2385 # Issue6750: concurrent writes could duplicate data
2386 event = threading.Event()
2387 with self.open(support.TESTFN, "w", buffering=1) as f:
2388 def run(n):
2389 text = "Thread%03d\n" % n
2390 event.wait()
2391 f.write(text)
2392 threads = [threading.Thread(target=lambda n=x: run(n))
2393 for x in range(20)]
2394 for t in threads:
2395 t.start()
2396 time.sleep(0.02)
2397 event.set()
2398 for t in threads:
2399 t.join()
2400 with self.open(support.TESTFN) as f:
2401 content = f.read()
2402 for n in range(20):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002403 self.assertEqual(content.count("Thread%03d\n" % n), 1)
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002404
Antoine Pitrou6be88762010-05-03 16:48:20 +00002405 def test_flush_error_on_close(self):
2406 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2407 def bad_flush():
2408 raise IOError()
2409 txt.flush = bad_flush
2410 self.assertRaises(IOError, txt.close) # exception not swallowed
2411
2412 def test_multi_close(self):
2413 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2414 txt.close()
2415 txt.close()
2416 txt.close()
2417 self.assertRaises(ValueError, txt.flush)
2418
Antoine Pitrou0d739d72010-09-05 23:01:12 +00002419 def test_unseekable(self):
2420 txt = self.TextIOWrapper(self.MockUnseekableIO(self.testdata))
2421 self.assertRaises(self.UnsupportedOperation, txt.tell)
2422 self.assertRaises(self.UnsupportedOperation, txt.seek, 0)
2423
Antoine Pitrou7f8f4182010-12-21 21:20:59 +00002424 def test_readonly_attributes(self):
2425 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2426 buf = self.BytesIO(self.testdata)
2427 with self.assertRaises(AttributeError):
2428 txt.buffer = buf
2429
Antoine Pitroue96ec682011-07-23 21:46:35 +02002430 def test_rawio(self):
2431 # Issue #12591: TextIOWrapper must work with raw I/O objects, so
2432 # that subprocess.Popen() can have the required unbuffered
2433 # semantics with universal_newlines=True.
2434 raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n'])
2435 txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n')
2436 # Reads
2437 self.assertEqual(txt.read(4), 'abcd')
2438 self.assertEqual(txt.readline(), 'efghi\n')
2439 self.assertEqual(list(txt), ['jkl\n', 'opq\n'])
2440
2441 def test_rawio_write_through(self):
2442 # Issue #12591: with write_through=True, writes don't need a flush
2443 raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n'])
2444 txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n',
2445 write_through=True)
2446 txt.write('1')
2447 txt.write('23\n4')
2448 txt.write('5')
2449 self.assertEqual(b''.join(raw._write_stack), b'123\n45')
2450
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002451class CTextIOWrapperTest(TextIOWrapperTest):
2452
2453 def test_initialization(self):
2454 r = self.BytesIO(b"\xc3\xa9\n\n")
2455 b = self.BufferedReader(r, 1000)
2456 t = self.TextIOWrapper(b)
2457 self.assertRaises(TypeError, t.__init__, b, newline=42)
2458 self.assertRaises(ValueError, t.read)
2459 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
2460 self.assertRaises(ValueError, t.read)
2461
2462 def test_garbage_collection(self):
2463 # C TextIOWrapper objects are collected, and collecting them flushes
2464 # all data to disk.
2465 # The Python version has __del__, so it ends in gc.garbage instead.
2466 rawio = io.FileIO(support.TESTFN, "wb")
2467 b = self.BufferedWriter(rawio)
2468 t = self.TextIOWrapper(b, encoding="ascii")
2469 t.write("456def")
2470 t.x = t
2471 wr = weakref.ref(t)
2472 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002473 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002474 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00002475 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002476 self.assertEqual(f.read(), b"456def")
2477
Charles-François Natali42c28cd2011-10-05 19:53:43 +02002478 def test_rwpair_cleared_before_textio(self):
2479 # Issue 13070: TextIOWrapper's finalization would crash when called
2480 # after the reference to the underlying BufferedRWPair's writer got
2481 # cleared by the GC.
2482 for i in range(1000):
2483 b1 = self.BufferedRWPair(self.MockRawIO(), self.MockRawIO())
2484 t1 = self.TextIOWrapper(b1, encoding="ascii")
2485 b2 = self.BufferedRWPair(self.MockRawIO(), self.MockRawIO())
2486 t2 = self.TextIOWrapper(b2, encoding="ascii")
2487 # circular references
2488 t1.buddy = t2
2489 t2.buddy = t1
2490 support.gc_collect()
2491
2492
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002493class PyTextIOWrapperTest(TextIOWrapperTest):
2494 pass
2495
2496
2497class IncrementalNewlineDecoderTest(unittest.TestCase):
2498
2499 def check_newline_decoding_utf8(self, decoder):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002500 # UTF-8 specific tests for a newline decoder
2501 def _check_decode(b, s, **kwargs):
2502 # We exercise getstate() / setstate() as well as decode()
2503 state = decoder.getstate()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002504 self.assertEqual(decoder.decode(b, **kwargs), s)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002505 decoder.setstate(state)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002506 self.assertEqual(decoder.decode(b, **kwargs), s)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002507
Antoine Pitrou180a3362008-12-14 16:36:46 +00002508 _check_decode(b'\xe8\xa2\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002509
Antoine Pitrou180a3362008-12-14 16:36:46 +00002510 _check_decode(b'\xe8', "")
2511 _check_decode(b'\xa2', "")
2512 _check_decode(b'\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002513
Antoine Pitrou180a3362008-12-14 16:36:46 +00002514 _check_decode(b'\xe8', "")
2515 _check_decode(b'\xa2', "")
2516 _check_decode(b'\x88', "\u8888")
2517
2518 _check_decode(b'\xe8', "")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002519 self.assertRaises(UnicodeDecodeError, decoder.decode, b'', final=True)
2520
Antoine Pitrou180a3362008-12-14 16:36:46 +00002521 decoder.reset()
2522 _check_decode(b'\n', "\n")
2523 _check_decode(b'\r', "")
2524 _check_decode(b'', "\n", final=True)
2525 _check_decode(b'\r', "\n", final=True)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002526
Antoine Pitrou180a3362008-12-14 16:36:46 +00002527 _check_decode(b'\r', "")
2528 _check_decode(b'a', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002529
Antoine Pitrou180a3362008-12-14 16:36:46 +00002530 _check_decode(b'\r\r\n', "\n\n")
2531 _check_decode(b'\r', "")
2532 _check_decode(b'\r', "\n")
2533 _check_decode(b'\na', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002534
Antoine Pitrou180a3362008-12-14 16:36:46 +00002535 _check_decode(b'\xe8\xa2\x88\r\n', "\u8888\n")
2536 _check_decode(b'\xe8\xa2\x88', "\u8888")
2537 _check_decode(b'\n', "\n")
2538 _check_decode(b'\xe8\xa2\x88\r', "\u8888")
2539 _check_decode(b'\n', "\n")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002540
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002541 def check_newline_decoding(self, decoder, encoding):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002542 result = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002543 if encoding is not None:
2544 encoder = codecs.getincrementalencoder(encoding)()
2545 def _decode_bytewise(s):
2546 # Decode one byte at a time
2547 for b in encoder.encode(s):
2548 result.append(decoder.decode(bytes([b])))
2549 else:
2550 encoder = None
2551 def _decode_bytewise(s):
2552 # Decode one char at a time
2553 for c in s:
2554 result.append(decoder.decode(c))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002555 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002556 _decode_bytewise("abc\n\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002557 self.assertEqual(decoder.newlines, '\n')
Antoine Pitrou180a3362008-12-14 16:36:46 +00002558 _decode_bytewise("\nabc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002559 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002560 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002561 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002562 _decode_bytewise("abc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002563 self.assertEqual(decoder.newlines, ('\r', '\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002564 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002565 self.assertEqual("".join(result), "abc\n\nabcabc\nabcabc")
Antoine Pitrou180a3362008-12-14 16:36:46 +00002566 decoder.reset()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002567 input = "abc"
2568 if encoder is not None:
2569 encoder.reset()
2570 input = encoder.encode(input)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002571 self.assertEqual(decoder.decode(input), "abc")
2572 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002573
2574 def test_newline_decoder(self):
2575 encodings = (
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002576 # None meaning the IncrementalNewlineDecoder takes unicode input
2577 # rather than bytes input
2578 None, 'utf-8', 'latin-1',
Antoine Pitrou180a3362008-12-14 16:36:46 +00002579 'utf-16', 'utf-16-le', 'utf-16-be',
2580 'utf-32', 'utf-32-le', 'utf-32-be',
2581 )
2582 for enc in encodings:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002583 decoder = enc and codecs.getincrementaldecoder(enc)()
2584 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2585 self.check_newline_decoding(decoder, enc)
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002586 decoder = codecs.getincrementaldecoder("utf-8")()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002587 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2588 self.check_newline_decoding_utf8(decoder)
2589
Antoine Pitrou66913e22009-03-06 23:40:56 +00002590 def test_newline_bytes(self):
2591 # Issue 5433: Excessive optimization in IncrementalNewlineDecoder
2592 def _check(dec):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002593 self.assertEqual(dec.newlines, None)
2594 self.assertEqual(dec.decode("\u0D00"), "\u0D00")
2595 self.assertEqual(dec.newlines, None)
2596 self.assertEqual(dec.decode("\u0A00"), "\u0A00")
2597 self.assertEqual(dec.newlines, None)
Antoine Pitrou66913e22009-03-06 23:40:56 +00002598 dec = self.IncrementalNewlineDecoder(None, translate=False)
2599 _check(dec)
2600 dec = self.IncrementalNewlineDecoder(None, translate=True)
2601 _check(dec)
2602
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002603class CIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2604 pass
2605
2606class PyIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2607 pass
Antoine Pitrou180a3362008-12-14 16:36:46 +00002608
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002609
Guido van Rossum01a27522007-03-07 01:00:12 +00002610# XXX Tests for open()
Guido van Rossum68bbcd22007-02-27 17:19:33 +00002611
Guido van Rossum5abbf752007-08-27 17:39:33 +00002612class MiscIOTest(unittest.TestCase):
2613
Barry Warsaw40e82462008-11-20 20:14:50 +00002614 def tearDown(self):
2615 support.unlink(support.TESTFN)
2616
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002617 def test___all__(self):
2618 for name in self.io.__all__:
2619 obj = getattr(self.io, name, None)
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002620 self.assertTrue(obj is not None, name)
Guido van Rossum5abbf752007-08-27 17:39:33 +00002621 if name == "open":
2622 continue
Benjamin Peterson6a52a9c2009-04-29 22:00:44 +00002623 elif "error" in name.lower() or name == "UnsupportedOperation":
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002624 self.assertTrue(issubclass(obj, Exception), name)
2625 elif not name.startswith("SEEK_"):
2626 self.assertTrue(issubclass(obj, self.IOBase))
Benjamin Peterson65676e42008-11-05 21:42:45 +00002627
Barry Warsaw40e82462008-11-20 20:14:50 +00002628 def test_attributes(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002629 f = self.open(support.TESTFN, "wb", buffering=0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002630 self.assertEqual(f.mode, "wb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002631 f.close()
2632
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002633 f = self.open(support.TESTFN, "U")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002634 self.assertEqual(f.name, support.TESTFN)
2635 self.assertEqual(f.buffer.name, support.TESTFN)
2636 self.assertEqual(f.buffer.raw.name, support.TESTFN)
2637 self.assertEqual(f.mode, "U")
2638 self.assertEqual(f.buffer.mode, "rb")
2639 self.assertEqual(f.buffer.raw.mode, "rb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002640 f.close()
2641
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002642 f = self.open(support.TESTFN, "w+")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002643 self.assertEqual(f.mode, "w+")
2644 self.assertEqual(f.buffer.mode, "rb+") # Does it really matter?
2645 self.assertEqual(f.buffer.raw.mode, "rb+")
Barry Warsaw40e82462008-11-20 20:14:50 +00002646
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002647 g = self.open(f.fileno(), "wb", closefd=False)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002648 self.assertEqual(g.mode, "wb")
2649 self.assertEqual(g.raw.mode, "wb")
2650 self.assertEqual(g.name, f.fileno())
2651 self.assertEqual(g.raw.name, f.fileno())
Barry Warsaw40e82462008-11-20 20:14:50 +00002652 f.close()
2653 g.close()
2654
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002655 def test_io_after_close(self):
2656 for kwargs in [
2657 {"mode": "w"},
2658 {"mode": "wb"},
2659 {"mode": "w", "buffering": 1},
2660 {"mode": "w", "buffering": 2},
2661 {"mode": "wb", "buffering": 0},
2662 {"mode": "r"},
2663 {"mode": "rb"},
2664 {"mode": "r", "buffering": 1},
2665 {"mode": "r", "buffering": 2},
2666 {"mode": "rb", "buffering": 0},
2667 {"mode": "w+"},
2668 {"mode": "w+b"},
2669 {"mode": "w+", "buffering": 1},
2670 {"mode": "w+", "buffering": 2},
2671 {"mode": "w+b", "buffering": 0},
2672 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002673 f = self.open(support.TESTFN, **kwargs)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002674 f.close()
2675 self.assertRaises(ValueError, f.flush)
2676 self.assertRaises(ValueError, f.fileno)
2677 self.assertRaises(ValueError, f.isatty)
2678 self.assertRaises(ValueError, f.__iter__)
2679 if hasattr(f, "peek"):
2680 self.assertRaises(ValueError, f.peek, 1)
2681 self.assertRaises(ValueError, f.read)
2682 if hasattr(f, "read1"):
2683 self.assertRaises(ValueError, f.read1, 1024)
Victor Stinnerb79f28c2011-05-25 22:09:03 +02002684 if hasattr(f, "readall"):
2685 self.assertRaises(ValueError, f.readall)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002686 if hasattr(f, "readinto"):
2687 self.assertRaises(ValueError, f.readinto, bytearray(1024))
2688 self.assertRaises(ValueError, f.readline)
2689 self.assertRaises(ValueError, f.readlines)
2690 self.assertRaises(ValueError, f.seek, 0)
2691 self.assertRaises(ValueError, f.tell)
2692 self.assertRaises(ValueError, f.truncate)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002693 self.assertRaises(ValueError, f.write,
2694 b"" if "b" in kwargs['mode'] else "")
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002695 self.assertRaises(ValueError, f.writelines, [])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002696 self.assertRaises(ValueError, next, f)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002697
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002698 def test_blockingioerror(self):
2699 # Various BlockingIOError issues
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002700 class C(str):
2701 pass
2702 c = C("")
2703 b = self.BlockingIOError(1, c)
2704 c.b = b
2705 b.c = c
2706 wr = weakref.ref(c)
2707 del c, b
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002708 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002709 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002710
2711 def test_abcs(self):
2712 # Test the visible base classes are ABCs.
Ezio Melottie9615932010-01-24 19:26:24 +00002713 self.assertIsInstance(self.IOBase, abc.ABCMeta)
2714 self.assertIsInstance(self.RawIOBase, abc.ABCMeta)
2715 self.assertIsInstance(self.BufferedIOBase, abc.ABCMeta)
2716 self.assertIsInstance(self.TextIOBase, abc.ABCMeta)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002717
2718 def _check_abc_inheritance(self, abcmodule):
2719 with self.open(support.TESTFN, "wb", buffering=0) as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002720 self.assertIsInstance(f, abcmodule.IOBase)
2721 self.assertIsInstance(f, abcmodule.RawIOBase)
2722 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2723 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002724 with self.open(support.TESTFN, "wb") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002725 self.assertIsInstance(f, abcmodule.IOBase)
2726 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2727 self.assertIsInstance(f, abcmodule.BufferedIOBase)
2728 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002729 with self.open(support.TESTFN, "w") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002730 self.assertIsInstance(f, abcmodule.IOBase)
2731 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2732 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2733 self.assertIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002734
2735 def test_abc_inheritance(self):
2736 # Test implementations inherit from their respective ABCs
2737 self._check_abc_inheritance(self)
2738
2739 def test_abc_inheritance_official(self):
2740 # Test implementations inherit from the official ABCs of the
2741 # baseline "io" module.
2742 self._check_abc_inheritance(io)
2743
Antoine Pitroue033e062010-10-29 10:38:18 +00002744 def _check_warn_on_dealloc(self, *args, **kwargs):
2745 f = open(*args, **kwargs)
2746 r = repr(f)
2747 with self.assertWarns(ResourceWarning) as cm:
2748 f = None
2749 support.gc_collect()
2750 self.assertIn(r, str(cm.warning.args[0]))
2751
2752 def test_warn_on_dealloc(self):
2753 self._check_warn_on_dealloc(support.TESTFN, "wb", buffering=0)
2754 self._check_warn_on_dealloc(support.TESTFN, "wb")
2755 self._check_warn_on_dealloc(support.TESTFN, "w")
2756
2757 def _check_warn_on_dealloc_fd(self, *args, **kwargs):
2758 fds = []
Benjamin Peterson556c7352010-10-31 01:35:43 +00002759 def cleanup_fds():
Antoine Pitroue033e062010-10-29 10:38:18 +00002760 for fd in fds:
2761 try:
2762 os.close(fd)
2763 except EnvironmentError as e:
2764 if e.errno != errno.EBADF:
2765 raise
Benjamin Peterson556c7352010-10-31 01:35:43 +00002766 self.addCleanup(cleanup_fds)
2767 r, w = os.pipe()
2768 fds += r, w
2769 self._check_warn_on_dealloc(r, *args, **kwargs)
2770 # When using closefd=False, there's no warning
2771 r, w = os.pipe()
2772 fds += r, w
2773 with warnings.catch_warnings(record=True) as recorded:
2774 open(r, *args, closefd=False, **kwargs)
2775 support.gc_collect()
2776 self.assertEqual(recorded, [])
Antoine Pitroue033e062010-10-29 10:38:18 +00002777
2778 def test_warn_on_dealloc_fd(self):
2779 self._check_warn_on_dealloc_fd("rb", buffering=0)
2780 self._check_warn_on_dealloc_fd("rb")
2781 self._check_warn_on_dealloc_fd("r")
2782
2783
Antoine Pitrou243757e2010-11-05 21:15:39 +00002784 def test_pickling(self):
2785 # Pickling file objects is forbidden
2786 for kwargs in [
2787 {"mode": "w"},
2788 {"mode": "wb"},
2789 {"mode": "wb", "buffering": 0},
2790 {"mode": "r"},
2791 {"mode": "rb"},
2792 {"mode": "rb", "buffering": 0},
2793 {"mode": "w+"},
2794 {"mode": "w+b"},
2795 {"mode": "w+b", "buffering": 0},
2796 ]:
2797 for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
2798 with self.open(support.TESTFN, **kwargs) as f:
2799 self.assertRaises(TypeError, pickle.dumps, f, protocol)
2800
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002801 @unittest.skipUnless(fcntl, 'fcntl required for this test')
2802 def test_nonblock_pipe_write_bigbuf(self):
2803 self._test_nonblock_pipe_write(16*1024)
2804
2805 @unittest.skipUnless(fcntl, 'fcntl required for this test')
2806 def test_nonblock_pipe_write_smallbuf(self):
2807 self._test_nonblock_pipe_write(1024)
2808
2809 def _set_non_blocking(self, fd):
2810 flags = fcntl.fcntl(fd, fcntl.F_GETFL)
2811 self.assertNotEqual(flags, -1)
2812 res = fcntl.fcntl(fd, fcntl.F_SETFL, flags | os.O_NONBLOCK)
2813 self.assertEqual(res, 0)
2814
2815 def _test_nonblock_pipe_write(self, bufsize):
2816 sent = []
2817 received = []
2818 r, w = os.pipe()
2819 self._set_non_blocking(r)
2820 self._set_non_blocking(w)
2821
2822 # To exercise all code paths in the C implementation we need
2823 # to play with buffer sizes. For instance, if we choose a
2824 # buffer size less than or equal to _PIPE_BUF (4096 on Linux)
2825 # then we will never get a partial write of the buffer.
2826 rf = self.open(r, mode='rb', closefd=True, buffering=bufsize)
2827 wf = self.open(w, mode='wb', closefd=True, buffering=bufsize)
2828
2829 with rf, wf:
2830 for N in 9999, 73, 7574:
2831 try:
2832 i = 0
2833 while True:
2834 msg = bytes([i % 26 + 97]) * N
2835 sent.append(msg)
2836 wf.write(msg)
2837 i += 1
2838
2839 except self.BlockingIOError as e:
2840 self.assertEqual(e.args[0], errno.EAGAIN)
Antoine Pitrou7fe601c2011-11-21 20:22:01 +01002841 self.assertEqual(e.args[2], e.characters_written)
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002842 sent[-1] = sent[-1][:e.characters_written]
2843 received.append(rf.read())
2844 msg = b'BLOCKED'
2845 wf.write(msg)
2846 sent.append(msg)
2847
2848 while True:
2849 try:
2850 wf.flush()
2851 break
2852 except self.BlockingIOError as e:
2853 self.assertEqual(e.args[0], errno.EAGAIN)
Antoine Pitrou7fe601c2011-11-21 20:22:01 +01002854 self.assertEqual(e.args[2], e.characters_written)
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002855 self.assertEqual(e.characters_written, 0)
2856 received.append(rf.read())
2857
2858 received += iter(rf.read, None)
2859
2860 sent, received = b''.join(sent), b''.join(received)
2861 self.assertTrue(sent == received)
2862 self.assertTrue(wf.closed)
2863 self.assertTrue(rf.closed)
2864
Charles-François Natalidc3044c2012-01-09 22:40:02 +01002865 def test_create_fail(self):
2866 # 'x' mode fails if file is existing
2867 with self.open(support.TESTFN, 'w'):
2868 pass
2869 self.assertRaises(FileExistsError, self.open, support.TESTFN, 'x')
2870
2871 def test_create_writes(self):
2872 # 'x' mode opens for writing
2873 with self.open(support.TESTFN, 'xb') as f:
2874 f.write(b"spam")
2875 with self.open(support.TESTFN, 'rb') as f:
2876 self.assertEqual(b"spam", f.read())
2877
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002878class CMiscIOTest(MiscIOTest):
2879 io = io
2880
2881class PyMiscIOTest(MiscIOTest):
2882 io = pyio
Barry Warsaw40e82462008-11-20 20:14:50 +00002883
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002884
2885@unittest.skipIf(os.name == 'nt', 'POSIX signals required for this test.')
2886class SignalsTest(unittest.TestCase):
2887
2888 def setUp(self):
2889 self.oldalrm = signal.signal(signal.SIGALRM, self.alarm_interrupt)
2890
2891 def tearDown(self):
2892 signal.signal(signal.SIGALRM, self.oldalrm)
2893
2894 def alarm_interrupt(self, sig, frame):
2895 1/0
2896
2897 @unittest.skipUnless(threading, 'Threading required for this test.')
2898 def check_interrupted_write(self, item, bytes, **fdopen_kwargs):
2899 """Check that a partial write, when it gets interrupted, properly
Antoine Pitrou707ce822011-02-25 21:24:11 +00002900 invokes the signal handler, and bubbles up the exception raised
2901 in the latter."""
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002902 read_results = []
2903 def _read():
Victor Stinnera9293352011-04-30 15:21:58 +02002904 if hasattr(signal, 'pthread_sigmask'):
2905 signal.pthread_sigmask(signal.SIG_BLOCK, [signal.SIGALRM])
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002906 s = os.read(r, 1)
2907 read_results.append(s)
2908 t = threading.Thread(target=_read)
2909 t.daemon = True
2910 r, w = os.pipe()
Benjamin Petersond8fc2e12010-10-31 01:19:53 +00002911 fdopen_kwargs["closefd"] = False
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002912 try:
2913 wio = self.io.open(w, **fdopen_kwargs)
2914 t.start()
2915 signal.alarm(1)
2916 # Fill the pipe enough that the write will be blocking.
2917 # It will be interrupted by the timer armed above. Since the
2918 # other thread has read one byte, the low-level write will
2919 # return with a successful (partial) result rather than an EINTR.
2920 # The buffered IO layer must check for pending signal
2921 # handlers, which in this case will invoke alarm_interrupt().
2922 self.assertRaises(ZeroDivisionError,
Charles-François Natali2d517212011-05-29 16:36:44 +02002923 wio.write, item * (support.PIPE_MAX_SIZE // len(item)))
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002924 t.join()
2925 # We got one byte, get another one and check that it isn't a
2926 # repeat of the first one.
2927 read_results.append(os.read(r, 1))
2928 self.assertEqual(read_results, [bytes[0:1], bytes[1:2]])
2929 finally:
2930 os.close(w)
2931 os.close(r)
2932 # This is deliberate. If we didn't close the file descriptor
2933 # before closing wio, wio would try to flush its internal
2934 # buffer, and block again.
2935 try:
2936 wio.close()
2937 except IOError as e:
2938 if e.errno != errno.EBADF:
2939 raise
2940
2941 def test_interrupted_write_unbuffered(self):
2942 self.check_interrupted_write(b"xy", b"xy", mode="wb", buffering=0)
2943
2944 def test_interrupted_write_buffered(self):
2945 self.check_interrupted_write(b"xy", b"xy", mode="wb")
2946
2947 def test_interrupted_write_text(self):
2948 self.check_interrupted_write("xy", b"xy", mode="w", encoding="ascii")
2949
Brett Cannon31f59292011-02-21 19:29:56 +00002950 @support.no_tracing
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002951 def check_reentrant_write(self, data, **fdopen_kwargs):
2952 def on_alarm(*args):
2953 # Will be called reentrantly from the same thread
2954 wio.write(data)
2955 1/0
2956 signal.signal(signal.SIGALRM, on_alarm)
2957 r, w = os.pipe()
2958 wio = self.io.open(w, **fdopen_kwargs)
2959 try:
2960 signal.alarm(1)
2961 # Either the reentrant call to wio.write() fails with RuntimeError,
2962 # or the signal handler raises ZeroDivisionError.
2963 with self.assertRaises((ZeroDivisionError, RuntimeError)) as cm:
2964 while 1:
2965 for i in range(100):
2966 wio.write(data)
2967 wio.flush()
2968 # Make sure the buffer doesn't fill up and block further writes
2969 os.read(r, len(data) * 100)
2970 exc = cm.exception
2971 if isinstance(exc, RuntimeError):
2972 self.assertTrue(str(exc).startswith("reentrant call"), str(exc))
2973 finally:
2974 wio.close()
2975 os.close(r)
2976
2977 def test_reentrant_write_buffered(self):
2978 self.check_reentrant_write(b"xy", mode="wb")
2979
2980 def test_reentrant_write_text(self):
2981 self.check_reentrant_write("xy", mode="w", encoding="ascii")
2982
Antoine Pitrou707ce822011-02-25 21:24:11 +00002983 def check_interrupted_read_retry(self, decode, **fdopen_kwargs):
2984 """Check that a buffered read, when it gets interrupted (either
2985 returning a partial result or EINTR), properly invokes the signal
2986 handler and retries if the latter returned successfully."""
2987 r, w = os.pipe()
2988 fdopen_kwargs["closefd"] = False
2989 def alarm_handler(sig, frame):
2990 os.write(w, b"bar")
2991 signal.signal(signal.SIGALRM, alarm_handler)
2992 try:
2993 rio = self.io.open(r, **fdopen_kwargs)
2994 os.write(w, b"foo")
2995 signal.alarm(1)
2996 # Expected behaviour:
2997 # - first raw read() returns partial b"foo"
2998 # - second raw read() returns EINTR
2999 # - third raw read() returns b"bar"
3000 self.assertEqual(decode(rio.read(6)), "foobar")
3001 finally:
3002 rio.close()
3003 os.close(w)
3004 os.close(r)
3005
Antoine Pitrou20db5112011-08-19 20:32:34 +02003006 def test_interrupted_read_retry_buffered(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003007 self.check_interrupted_read_retry(lambda x: x.decode('latin1'),
3008 mode="rb")
3009
Antoine Pitrou20db5112011-08-19 20:32:34 +02003010 def test_interrupted_read_retry_text(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003011 self.check_interrupted_read_retry(lambda x: x,
3012 mode="r")
3013
3014 @unittest.skipUnless(threading, 'Threading required for this test.')
3015 def check_interrupted_write_retry(self, item, **fdopen_kwargs):
3016 """Check that a buffered write, when it gets interrupted (either
3017 returning a partial result or EINTR), properly invokes the signal
3018 handler and retries if the latter returned successfully."""
3019 select = support.import_module("select")
3020 # A quantity that exceeds the buffer size of an anonymous pipe's
3021 # write end.
3022 N = 1024 * 1024
3023 r, w = os.pipe()
3024 fdopen_kwargs["closefd"] = False
3025 # We need a separate thread to read from the pipe and allow the
3026 # write() to finish. This thread is started after the SIGALRM is
3027 # received (forcing a first EINTR in write()).
3028 read_results = []
3029 write_finished = False
3030 def _read():
3031 while not write_finished:
3032 while r in select.select([r], [], [], 1.0)[0]:
3033 s = os.read(r, 1024)
3034 read_results.append(s)
3035 t = threading.Thread(target=_read)
3036 t.daemon = True
3037 def alarm1(sig, frame):
3038 signal.signal(signal.SIGALRM, alarm2)
3039 signal.alarm(1)
3040 def alarm2(sig, frame):
3041 t.start()
3042 signal.signal(signal.SIGALRM, alarm1)
3043 try:
3044 wio = self.io.open(w, **fdopen_kwargs)
3045 signal.alarm(1)
3046 # Expected behaviour:
3047 # - first raw write() is partial (because of the limited pipe buffer
3048 # and the first alarm)
3049 # - second raw write() returns EINTR (because of the second alarm)
3050 # - subsequent write()s are successful (either partial or complete)
3051 self.assertEqual(N, wio.write(item * N))
3052 wio.flush()
3053 write_finished = True
3054 t.join()
3055 self.assertEqual(N, sum(len(x) for x in read_results))
3056 finally:
3057 write_finished = True
3058 os.close(w)
3059 os.close(r)
3060 # This is deliberate. If we didn't close the file descriptor
3061 # before closing wio, wio would try to flush its internal
3062 # buffer, and could block (in case of failure).
3063 try:
3064 wio.close()
3065 except IOError as e:
3066 if e.errno != errno.EBADF:
3067 raise
3068
Antoine Pitrou20db5112011-08-19 20:32:34 +02003069 def test_interrupted_write_retry_buffered(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003070 self.check_interrupted_write_retry(b"x", mode="wb")
3071
Antoine Pitrou20db5112011-08-19 20:32:34 +02003072 def test_interrupted_write_retry_text(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003073 self.check_interrupted_write_retry("x", mode="w", encoding="latin1")
3074
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00003075
Antoine Pitroub46b9d52010-08-21 19:09:32 +00003076class CSignalsTest(SignalsTest):
3077 io = io
3078
3079class PySignalsTest(SignalsTest):
3080 io = pyio
3081
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00003082 # Handling reentrancy issues would slow down _pyio even more, so the
3083 # tests are disabled.
3084 test_reentrant_write_buffered = None
3085 test_reentrant_write_text = None
3086
Antoine Pitroub46b9d52010-08-21 19:09:32 +00003087
Guido van Rossum28524c72007-02-27 05:47:44 +00003088def test_main():
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003089 tests = (CIOTest, PyIOTest,
3090 CBufferedReaderTest, PyBufferedReaderTest,
3091 CBufferedWriterTest, PyBufferedWriterTest,
3092 CBufferedRWPairTest, PyBufferedRWPairTest,
3093 CBufferedRandomTest, PyBufferedRandomTest,
3094 StatefulIncrementalDecoderTest,
3095 CIncrementalNewlineDecoderTest, PyIncrementalNewlineDecoderTest,
3096 CTextIOWrapperTest, PyTextIOWrapperTest,
Antoine Pitroub46b9d52010-08-21 19:09:32 +00003097 CMiscIOTest, PyMiscIOTest,
3098 CSignalsTest, PySignalsTest,
3099 )
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003100
3101 # Put the namespaces of the IO module we are testing and some useful mock
3102 # classes in the __dict__ of each test.
3103 mocks = (MockRawIO, MisbehavedRawIO, MockFileIO, CloseFailureIO,
Antoine Pitrou328ec742010-09-14 18:37:24 +00003104 MockNonBlockWriterIO, MockUnseekableIO, MockRawIOWithoutRead)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003105 all_members = io.__all__ + ["IncrementalNewlineDecoder"]
3106 c_io_ns = {name : getattr(io, name) for name in all_members}
3107 py_io_ns = {name : getattr(pyio, name) for name in all_members}
3108 globs = globals()
3109 c_io_ns.update((x.__name__, globs["C" + x.__name__]) for x in mocks)
3110 py_io_ns.update((x.__name__, globs["Py" + x.__name__]) for x in mocks)
3111 # Avoid turning open into a bound method.
3112 py_io_ns["open"] = pyio.OpenWrapper
3113 for test in tests:
3114 if test.__name__.startswith("C"):
3115 for name, obj in c_io_ns.items():
3116 setattr(test, name, obj)
3117 elif test.__name__.startswith("Py"):
3118 for name, obj in py_io_ns.items():
3119 setattr(test, name, obj)
3120
3121 support.run_unittest(*tests)
Guido van Rossum28524c72007-02-27 05:47:44 +00003122
3123if __name__ == "__main__":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003124 test_main()