blob: ec0501e901368b5e4d17cf17939b61882e3a24cb [file] [log] [blame]
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001"""Unit tests for the io module."""
2
3# Tests of io are scattered over the test suite:
4# * test_bufio - tests file buffering
5# * test_memoryio - tests BytesIO and StringIO
6# * test_fileio - tests FileIO
7# * test_file - tests the file interface
8# * test_io - tests everything else in the io module
9# * test_univnewlines - tests universal newline support
10# * test_largefile - tests operations on a file greater than 2**32 bytes
11# (only enabled with -ulargefile)
12
13################################################################################
14# ATTENTION TEST WRITERS!!!
15################################################################################
16# When writing tests for io, it's important to test both the C and Python
17# implementations. This is usually done by writing a base test that refers to
18# the type it is testing as a attribute. Then it provides custom subclasses to
19# test both implementations. This file has lots of examples.
20################################################################################
Guido van Rossum68bbcd22007-02-27 17:19:33 +000021
Victor Stinnerf86a5e82012-06-05 13:43:22 +020022import abc
23import array
24import errno
25import locale
Guido van Rossum8358db22007-08-18 21:39:55 +000026import os
Victor Stinnerf86a5e82012-06-05 13:43:22 +020027import pickle
28import random
29import signal
Guido van Rossum34d69e52007-04-10 20:08:41 +000030import sys
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +000031import time
Guido van Rossum28524c72007-02-27 05:47:44 +000032import unittest
Antoine Pitroue033e062010-10-29 10:38:18 +000033import warnings
Victor Stinnerf86a5e82012-06-05 13:43:22 +020034import weakref
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000035from collections import deque
Victor Stinnerf86a5e82012-06-05 13:43:22 +020036from itertools import cycle, count
Benjamin Petersonee8712c2008-05-20 21:35:26 +000037from test import support
Guido van Rossum76c5d4d2007-04-06 19:10:29 +000038
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +000039import codecs
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000040import io # C implementation of io
41import _pyio as pyio # Python implementation of io
Victor Stinner45df8202010-04-28 22:31:17 +000042try:
43 import threading
44except ImportError:
45 threading = None
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +010046try:
47 import fcntl
48except ImportError:
49 fcntl = None
Guido van Rossuma9e20242007-03-08 00:43:48 +000050
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000051def _default_chunk_size():
52 """Get the default TextIOWrapper chunk size"""
Marc-André Lemburg8f36af72011-02-25 15:42:01 +000053 with open(__file__, "r", encoding="latin-1") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000054 return f._CHUNK_SIZE
55
56
Antoine Pitrou328ec742010-09-14 18:37:24 +000057class MockRawIOWithoutRead:
58 """A RawIO implementation without read(), so as to exercise the default
59 RawIO.read() which calls readinto()."""
Guido van Rossuma9e20242007-03-08 00:43:48 +000060
Guido van Rossum76c5d4d2007-04-06 19:10:29 +000061 def __init__(self, read_stack=()):
62 self._read_stack = list(read_stack)
63 self._write_stack = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000064 self._reads = 0
Antoine Pitrou32cfede2010-08-11 13:31:33 +000065 self._extraneous_reads = 0
Guido van Rossum68bbcd22007-02-27 17:19:33 +000066
Guido van Rossum01a27522007-03-07 01:00:12 +000067 def write(self, b):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000068 self._write_stack.append(bytes(b))
Guido van Rossum01a27522007-03-07 01:00:12 +000069 return len(b)
70
71 def writable(self):
72 return True
73
Guido van Rossum68bbcd22007-02-27 17:19:33 +000074 def fileno(self):
75 return 42
76
77 def readable(self):
78 return True
79
Guido van Rossum01a27522007-03-07 01:00:12 +000080 def seekable(self):
Guido van Rossum68bbcd22007-02-27 17:19:33 +000081 return True
82
Guido van Rossum01a27522007-03-07 01:00:12 +000083 def seek(self, pos, whence):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000084 return 0 # wrong but we gotta return something
Guido van Rossum01a27522007-03-07 01:00:12 +000085
86 def tell(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000087 return 0 # same comment as above
88
89 def readinto(self, buf):
90 self._reads += 1
91 max_len = len(buf)
92 try:
93 data = self._read_stack[0]
94 except IndexError:
Antoine Pitrou32cfede2010-08-11 13:31:33 +000095 self._extraneous_reads += 1
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000096 return 0
97 if data is None:
98 del self._read_stack[0]
99 return None
100 n = len(data)
101 if len(data) <= max_len:
102 del self._read_stack[0]
103 buf[:n] = data
104 return n
105 else:
106 buf[:] = data[:max_len]
107 self._read_stack[0] = data[max_len:]
108 return max_len
109
110 def truncate(self, pos=None):
111 return pos
112
Antoine Pitrou328ec742010-09-14 18:37:24 +0000113class CMockRawIOWithoutRead(MockRawIOWithoutRead, io.RawIOBase):
114 pass
115
116class PyMockRawIOWithoutRead(MockRawIOWithoutRead, pyio.RawIOBase):
117 pass
118
119
120class MockRawIO(MockRawIOWithoutRead):
121
122 def read(self, n=None):
123 self._reads += 1
124 try:
125 return self._read_stack.pop(0)
126 except:
127 self._extraneous_reads += 1
128 return b""
129
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000130class CMockRawIO(MockRawIO, io.RawIOBase):
131 pass
132
133class PyMockRawIO(MockRawIO, pyio.RawIOBase):
134 pass
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000135
Guido van Rossuma9e20242007-03-08 00:43:48 +0000136
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000137class MisbehavedRawIO(MockRawIO):
138 def write(self, b):
139 return super().write(b) * 2
140
141 def read(self, n=None):
142 return super().read(n) * 2
143
144 def seek(self, pos, whence):
145 return -123
146
147 def tell(self):
148 return -456
149
150 def readinto(self, buf):
151 super().readinto(buf)
152 return len(buf) * 5
153
154class CMisbehavedRawIO(MisbehavedRawIO, io.RawIOBase):
155 pass
156
157class PyMisbehavedRawIO(MisbehavedRawIO, pyio.RawIOBase):
158 pass
159
160
161class CloseFailureIO(MockRawIO):
162 closed = 0
163
164 def close(self):
165 if not self.closed:
166 self.closed = 1
167 raise IOError
168
169class CCloseFailureIO(CloseFailureIO, io.RawIOBase):
170 pass
171
172class PyCloseFailureIO(CloseFailureIO, pyio.RawIOBase):
173 pass
174
175
176class MockFileIO:
Guido van Rossum78892e42007-04-06 17:31:18 +0000177
178 def __init__(self, data):
179 self.read_history = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000180 super().__init__(data)
Guido van Rossum78892e42007-04-06 17:31:18 +0000181
182 def read(self, n=None):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000183 res = super().read(n)
Guido van Rossum78892e42007-04-06 17:31:18 +0000184 self.read_history.append(None if res is None else len(res))
185 return res
186
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000187 def readinto(self, b):
188 res = super().readinto(b)
189 self.read_history.append(res)
190 return res
Guido van Rossum78892e42007-04-06 17:31:18 +0000191
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000192class CMockFileIO(MockFileIO, io.BytesIO):
193 pass
Guido van Rossuma9e20242007-03-08 00:43:48 +0000194
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000195class PyMockFileIO(MockFileIO, pyio.BytesIO):
196 pass
197
198
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000199class MockUnseekableIO:
200 def seekable(self):
201 return False
202
203 def seek(self, *args):
204 raise self.UnsupportedOperation("not seekable")
205
206 def tell(self, *args):
207 raise self.UnsupportedOperation("not seekable")
208
209class CMockUnseekableIO(MockUnseekableIO, io.BytesIO):
210 UnsupportedOperation = io.UnsupportedOperation
211
212class PyMockUnseekableIO(MockUnseekableIO, pyio.BytesIO):
213 UnsupportedOperation = pyio.UnsupportedOperation
214
215
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000216class MockNonBlockWriterIO:
217
218 def __init__(self):
Guido van Rossum01a27522007-03-07 01:00:12 +0000219 self._write_stack = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000220 self._blocker_char = None
Guido van Rossuma9e20242007-03-08 00:43:48 +0000221
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000222 def pop_written(self):
223 s = b"".join(self._write_stack)
224 self._write_stack[:] = []
225 return s
226
227 def block_on(self, char):
228 """Block when a given char is encountered."""
229 self._blocker_char = char
230
231 def readable(self):
232 return True
233
234 def seekable(self):
235 return True
Guido van Rossuma9e20242007-03-08 00:43:48 +0000236
Guido van Rossum01a27522007-03-07 01:00:12 +0000237 def writable(self):
238 return True
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000239
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000240 def write(self, b):
241 b = bytes(b)
242 n = -1
243 if self._blocker_char:
244 try:
245 n = b.index(self._blocker_char)
246 except ValueError:
247 pass
248 else:
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100249 if n > 0:
250 # write data up to the first blocker
251 self._write_stack.append(b[:n])
252 return n
253 else:
254 # cancel blocker and indicate would block
255 self._blocker_char = None
256 return None
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000257 self._write_stack.append(b)
258 return len(b)
259
260class CMockNonBlockWriterIO(MockNonBlockWriterIO, io.RawIOBase):
261 BlockingIOError = io.BlockingIOError
262
263class PyMockNonBlockWriterIO(MockNonBlockWriterIO, pyio.RawIOBase):
264 BlockingIOError = pyio.BlockingIOError
265
Guido van Rossuma9e20242007-03-08 00:43:48 +0000266
Guido van Rossum28524c72007-02-27 05:47:44 +0000267class IOTest(unittest.TestCase):
268
Neal Norwitze7789b12008-03-24 06:18:09 +0000269 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000270 support.unlink(support.TESTFN)
Neal Norwitze7789b12008-03-24 06:18:09 +0000271
Guido van Rossum4d0f5a42007-03-07 22:59:39 +0000272 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000273 support.unlink(support.TESTFN)
Guido van Rossum4d0f5a42007-03-07 22:59:39 +0000274
Guido van Rossum28524c72007-02-27 05:47:44 +0000275 def write_ops(self, f):
Guido van Rossum87429772007-04-10 21:06:59 +0000276 self.assertEqual(f.write(b"blah."), 5)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000277 f.truncate(0)
278 self.assertEqual(f.tell(), 5)
279 f.seek(0)
280
281 self.assertEqual(f.write(b"blah."), 5)
Guido van Rossum87429772007-04-10 21:06:59 +0000282 self.assertEqual(f.seek(0), 0)
283 self.assertEqual(f.write(b"Hello."), 6)
Guido van Rossum28524c72007-02-27 05:47:44 +0000284 self.assertEqual(f.tell(), 6)
Guido van Rossum87429772007-04-10 21:06:59 +0000285 self.assertEqual(f.seek(-1, 1), 5)
Guido van Rossum28524c72007-02-27 05:47:44 +0000286 self.assertEqual(f.tell(), 5)
Guido van Rossum254348e2007-11-21 19:29:53 +0000287 self.assertEqual(f.write(bytearray(b" world\n\n\n")), 9)
Guido van Rossum87429772007-04-10 21:06:59 +0000288 self.assertEqual(f.seek(0), 0)
Guido van Rossum2b08b382007-05-08 20:18:39 +0000289 self.assertEqual(f.write(b"h"), 1)
Guido van Rossum87429772007-04-10 21:06:59 +0000290 self.assertEqual(f.seek(-1, 2), 13)
291 self.assertEqual(f.tell(), 13)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000292
Guido van Rossum87429772007-04-10 21:06:59 +0000293 self.assertEqual(f.truncate(12), 12)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000294 self.assertEqual(f.tell(), 13)
Christian Heimes8e42a0a2007-11-08 18:04:45 +0000295 self.assertRaises(TypeError, f.seek, 0.0)
Guido van Rossum28524c72007-02-27 05:47:44 +0000296
Guido van Rossum9b76da62007-04-11 01:09:03 +0000297 def read_ops(self, f, buffered=False):
298 data = f.read(5)
299 self.assertEqual(data, b"hello")
Guido van Rossum254348e2007-11-21 19:29:53 +0000300 data = bytearray(data)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000301 self.assertEqual(f.readinto(data), 5)
302 self.assertEqual(data, b" worl")
303 self.assertEqual(f.readinto(data), 2)
304 self.assertEqual(len(data), 5)
305 self.assertEqual(data[:2], b"d\n")
306 self.assertEqual(f.seek(0), 0)
307 self.assertEqual(f.read(20), b"hello world\n")
308 self.assertEqual(f.read(1), b"")
Guido van Rossum254348e2007-11-21 19:29:53 +0000309 self.assertEqual(f.readinto(bytearray(b"x")), 0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000310 self.assertEqual(f.seek(-6, 2), 6)
311 self.assertEqual(f.read(5), b"world")
312 self.assertEqual(f.read(0), b"")
Guido van Rossum254348e2007-11-21 19:29:53 +0000313 self.assertEqual(f.readinto(bytearray()), 0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000314 self.assertEqual(f.seek(-6, 1), 5)
315 self.assertEqual(f.read(5), b" worl")
316 self.assertEqual(f.tell(), 10)
Christian Heimes8e42a0a2007-11-08 18:04:45 +0000317 self.assertRaises(TypeError, f.seek, 0.0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000318 if buffered:
319 f.seek(0)
320 self.assertEqual(f.read(), b"hello world\n")
321 f.seek(6)
322 self.assertEqual(f.read(), b"world\n")
323 self.assertEqual(f.read(), b"")
324
Guido van Rossum34d69e52007-04-10 20:08:41 +0000325 LARGE = 2**31
326
Guido van Rossum53807da2007-04-10 19:01:47 +0000327 def large_file_ops(self, f):
328 assert f.readable()
329 assert f.writable()
Guido van Rossum34d69e52007-04-10 20:08:41 +0000330 self.assertEqual(f.seek(self.LARGE), self.LARGE)
331 self.assertEqual(f.tell(), self.LARGE)
Guido van Rossum53807da2007-04-10 19:01:47 +0000332 self.assertEqual(f.write(b"xxx"), 3)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000333 self.assertEqual(f.tell(), self.LARGE + 3)
334 self.assertEqual(f.seek(-1, 1), self.LARGE + 2)
Guido van Rossum87429772007-04-10 21:06:59 +0000335 self.assertEqual(f.truncate(), self.LARGE + 2)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000336 self.assertEqual(f.tell(), self.LARGE + 2)
337 self.assertEqual(f.seek(0, 2), self.LARGE + 2)
Guido van Rossum87429772007-04-10 21:06:59 +0000338 self.assertEqual(f.truncate(self.LARGE + 1), self.LARGE + 1)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000339 self.assertEqual(f.tell(), self.LARGE + 2)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000340 self.assertEqual(f.seek(0, 2), self.LARGE + 1)
341 self.assertEqual(f.seek(-1, 2), self.LARGE)
Guido van Rossum53807da2007-04-10 19:01:47 +0000342 self.assertEqual(f.read(2), b"x")
343
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000344 def test_invalid_operations(self):
345 # Try writing on a file opened in read mode and vice-versa.
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000346 exc = self.UnsupportedOperation
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000347 for mode in ("w", "wb"):
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000348 with self.open(support.TESTFN, mode) as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000349 self.assertRaises(exc, fp.read)
350 self.assertRaises(exc, fp.readline)
351 with self.open(support.TESTFN, "wb", buffering=0) as fp:
352 self.assertRaises(exc, fp.read)
353 self.assertRaises(exc, fp.readline)
354 with self.open(support.TESTFN, "rb", buffering=0) as fp:
355 self.assertRaises(exc, fp.write, b"blah")
356 self.assertRaises(exc, fp.writelines, [b"blah\n"])
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000357 with self.open(support.TESTFN, "rb") as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000358 self.assertRaises(exc, fp.write, b"blah")
359 self.assertRaises(exc, fp.writelines, [b"blah\n"])
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000360 with self.open(support.TESTFN, "r") as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000361 self.assertRaises(exc, fp.write, "blah")
362 self.assertRaises(exc, fp.writelines, ["blah\n"])
363 # Non-zero seeking from current or end pos
364 self.assertRaises(exc, fp.seek, 1, self.SEEK_CUR)
365 self.assertRaises(exc, fp.seek, -1, self.SEEK_END)
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000366
Antoine Pitrou13348842012-01-29 18:36:34 +0100367 def test_open_handles_NUL_chars(self):
368 fn_with_NUL = 'foo\0bar'
369 self.assertRaises(TypeError, self.open, fn_with_NUL, 'w')
370 self.assertRaises(TypeError, self.open, bytes(fn_with_NUL, 'ascii'), 'w')
371
Guido van Rossum28524c72007-02-27 05:47:44 +0000372 def test_raw_file_io(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000373 with self.open(support.TESTFN, "wb", buffering=0) as f:
374 self.assertEqual(f.readable(), False)
375 self.assertEqual(f.writable(), True)
376 self.assertEqual(f.seekable(), True)
377 self.write_ops(f)
378 with self.open(support.TESTFN, "rb", buffering=0) as f:
379 self.assertEqual(f.readable(), True)
380 self.assertEqual(f.writable(), False)
381 self.assertEqual(f.seekable(), True)
382 self.read_ops(f)
Guido van Rossum28524c72007-02-27 05:47:44 +0000383
Guido van Rossum87429772007-04-10 21:06:59 +0000384 def test_buffered_file_io(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000385 with self.open(support.TESTFN, "wb") as f:
386 self.assertEqual(f.readable(), False)
387 self.assertEqual(f.writable(), True)
388 self.assertEqual(f.seekable(), True)
389 self.write_ops(f)
390 with self.open(support.TESTFN, "rb") as f:
391 self.assertEqual(f.readable(), True)
392 self.assertEqual(f.writable(), False)
393 self.assertEqual(f.seekable(), True)
394 self.read_ops(f, True)
Guido van Rossum87429772007-04-10 21:06:59 +0000395
Guido van Rossum48fc58a2007-06-07 23:45:37 +0000396 def test_readline(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000397 with self.open(support.TESTFN, "wb") as f:
398 f.write(b"abc\ndef\nxyzzy\nfoo\x00bar\nanother line")
399 with self.open(support.TESTFN, "rb") as f:
400 self.assertEqual(f.readline(), b"abc\n")
401 self.assertEqual(f.readline(10), b"def\n")
402 self.assertEqual(f.readline(2), b"xy")
403 self.assertEqual(f.readline(4), b"zzy\n")
404 self.assertEqual(f.readline(), b"foo\x00bar\n")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000405 self.assertEqual(f.readline(None), b"another line")
Benjamin Peterson45cec322009-04-24 23:14:50 +0000406 self.assertRaises(TypeError, f.readline, 5.3)
407 with self.open(support.TESTFN, "r") as f:
408 self.assertRaises(TypeError, f.readline, 5.3)
Guido van Rossum48fc58a2007-06-07 23:45:37 +0000409
Guido van Rossum28524c72007-02-27 05:47:44 +0000410 def test_raw_bytes_io(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000411 f = self.BytesIO()
Guido van Rossum28524c72007-02-27 05:47:44 +0000412 self.write_ops(f)
413 data = f.getvalue()
414 self.assertEqual(data, b"hello world\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000415 f = self.BytesIO(data)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000416 self.read_ops(f, True)
Guido van Rossum28524c72007-02-27 05:47:44 +0000417
Guido van Rossum53807da2007-04-10 19:01:47 +0000418 def test_large_file_ops(self):
Guido van Rossum34d69e52007-04-10 20:08:41 +0000419 # On Windows and Mac OSX this test comsumes large resources; It takes
420 # a long time to build the >2GB file and takes >2GB of disk space
421 # therefore the resource must be enabled to run this test.
422 if sys.platform[:3] == 'win' or sys.platform == 'darwin':
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000423 if not support.is_resource_enabled("largefile"):
Guido van Rossum34d69e52007-04-10 20:08:41 +0000424 print("\nTesting large file ops skipped on %s." % sys.platform,
425 file=sys.stderr)
426 print("It requires %d bytes and a long time." % self.LARGE,
427 file=sys.stderr)
428 print("Use 'regrtest.py -u largefile test_io' to run it.",
429 file=sys.stderr)
430 return
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000431 with self.open(support.TESTFN, "w+b", 0) as f:
432 self.large_file_ops(f)
433 with self.open(support.TESTFN, "w+b") as f:
434 self.large_file_ops(f)
Guido van Rossum87429772007-04-10 21:06:59 +0000435
436 def test_with_open(self):
437 for bufsize in (0, 1, 100):
438 f = None
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000439 with self.open(support.TESTFN, "wb", bufsize) as f:
Guido van Rossum1f2ca562007-08-27 20:44:15 +0000440 f.write(b"xxx")
Guido van Rossum87429772007-04-10 21:06:59 +0000441 self.assertEqual(f.closed, True)
442 f = None
443 try:
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000444 with self.open(support.TESTFN, "wb", bufsize) as f:
Guido van Rossum87429772007-04-10 21:06:59 +0000445 1/0
446 except ZeroDivisionError:
447 self.assertEqual(f.closed, True)
448 else:
449 self.fail("1/0 didn't raise an exception")
450
Antoine Pitrou08838b62009-01-21 00:55:13 +0000451 # issue 5008
452 def test_append_mode_tell(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000453 with self.open(support.TESTFN, "wb") as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000454 f.write(b"xxx")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000455 with self.open(support.TESTFN, "ab", buffering=0) as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000456 self.assertEqual(f.tell(), 3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000457 with self.open(support.TESTFN, "ab") as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000458 self.assertEqual(f.tell(), 3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000459 with self.open(support.TESTFN, "a") as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000460 self.assertTrue(f.tell() > 0)
Antoine Pitrou08838b62009-01-21 00:55:13 +0000461
Guido van Rossum87429772007-04-10 21:06:59 +0000462 def test_destructor(self):
463 record = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000464 class MyFileIO(self.FileIO):
Guido van Rossum87429772007-04-10 21:06:59 +0000465 def __del__(self):
466 record.append(1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000467 try:
468 f = super().__del__
469 except AttributeError:
470 pass
471 else:
472 f()
Guido van Rossum87429772007-04-10 21:06:59 +0000473 def close(self):
474 record.append(2)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000475 super().close()
Guido van Rossum87429772007-04-10 21:06:59 +0000476 def flush(self):
477 record.append(3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000478 super().flush()
Brett Cannon5a9e91b2010-10-29 23:53:03 +0000479 with support.check_warnings(('', ResourceWarning)):
480 f = MyFileIO(support.TESTFN, "wb")
481 f.write(b"xxx")
482 del f
483 support.gc_collect()
484 self.assertEqual(record, [1, 2, 3])
485 with self.open(support.TESTFN, "rb") as f:
486 self.assertEqual(f.read(), b"xxx")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000487
488 def _check_base_destructor(self, base):
489 record = []
490 class MyIO(base):
491 def __init__(self):
492 # This exercises the availability of attributes on object
493 # destruction.
494 # (in the C version, close() is called by the tp_dealloc
495 # function, not by __del__)
496 self.on_del = 1
497 self.on_close = 2
498 self.on_flush = 3
499 def __del__(self):
500 record.append(self.on_del)
501 try:
502 f = super().__del__
503 except AttributeError:
504 pass
505 else:
506 f()
507 def close(self):
508 record.append(self.on_close)
509 super().close()
510 def flush(self):
511 record.append(self.on_flush)
512 super().flush()
513 f = MyIO()
Guido van Rossum87429772007-04-10 21:06:59 +0000514 del f
Benjamin Peterson24fb1d02009-04-24 23:26:21 +0000515 support.gc_collect()
Guido van Rossum87429772007-04-10 21:06:59 +0000516 self.assertEqual(record, [1, 2, 3])
517
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000518 def test_IOBase_destructor(self):
519 self._check_base_destructor(self.IOBase)
520
521 def test_RawIOBase_destructor(self):
522 self._check_base_destructor(self.RawIOBase)
523
524 def test_BufferedIOBase_destructor(self):
525 self._check_base_destructor(self.BufferedIOBase)
526
527 def test_TextIOBase_destructor(self):
528 self._check_base_destructor(self.TextIOBase)
529
Guido van Rossum87429772007-04-10 21:06:59 +0000530 def test_close_flushes(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000531 with self.open(support.TESTFN, "wb") as f:
532 f.write(b"xxx")
533 with self.open(support.TESTFN, "rb") as f:
534 self.assertEqual(f.read(), b"xxx")
Guido van Rossuma9e20242007-03-08 00:43:48 +0000535
Guido van Rossumd4103952007-04-12 05:44:49 +0000536 def test_array_writes(self):
537 a = array.array('i', range(10))
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +0000538 n = len(a.tobytes())
Benjamin Peterson45cec322009-04-24 23:14:50 +0000539 with self.open(support.TESTFN, "wb", 0) as f:
540 self.assertEqual(f.write(a), n)
541 with self.open(support.TESTFN, "wb") as f:
542 self.assertEqual(f.write(a), n)
Guido van Rossumd4103952007-04-12 05:44:49 +0000543
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000544 def test_closefd(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000545 self.assertRaises(ValueError, self.open, support.TESTFN, 'w',
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000546 closefd=False)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000547
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000548 def test_read_closed(self):
549 with self.open(support.TESTFN, "w") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000550 f.write("egg\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000551 with self.open(support.TESTFN, "r") as f:
552 file = self.open(f.fileno(), "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000553 self.assertEqual(file.read(), "egg\n")
554 file.seek(0)
555 file.close()
556 self.assertRaises(ValueError, file.read)
557
558 def test_no_closefd_with_filename(self):
559 # can't use closefd in combination with a file name
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000560 self.assertRaises(ValueError, self.open, support.TESTFN, "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000561
562 def test_closefd_attr(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000563 with self.open(support.TESTFN, "wb") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000564 f.write(b"egg\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000565 with self.open(support.TESTFN, "r") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000566 self.assertEqual(f.buffer.raw.closefd, True)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000567 file = self.open(f.fileno(), "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000568 self.assertEqual(file.buffer.raw.closefd, False)
569
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000570 def test_garbage_collection(self):
571 # FileIO objects are collected, and collecting them flushes
572 # all data to disk.
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +0000573 with support.check_warnings(('', ResourceWarning)):
574 f = self.FileIO(support.TESTFN, "wb")
575 f.write(b"abcxxx")
576 f.f = f
577 wr = weakref.ref(f)
578 del f
579 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000580 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000581 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000582 self.assertEqual(f.read(), b"abcxxx")
Christian Heimesecc42a22008-11-05 19:30:32 +0000583
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000584 def test_unbounded_file(self):
585 # Issue #1174606: reading from an unbounded stream such as /dev/zero.
586 zero = "/dev/zero"
587 if not os.path.exists(zero):
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000588 self.skipTest("{0} does not exist".format(zero))
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000589 if sys.maxsize > 0x7FFFFFFF:
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000590 self.skipTest("test can only run in a 32-bit address space")
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000591 if support.real_max_memuse < support._2G:
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000592 self.skipTest("test requires at least 2GB of memory")
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000593 with self.open(zero, "rb", buffering=0) as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000594 self.assertRaises(OverflowError, f.read)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000595 with self.open(zero, "rb") as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000596 self.assertRaises(OverflowError, f.read)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000597 with self.open(zero, "r") as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000598 self.assertRaises(OverflowError, f.read)
599
Antoine Pitrou6be88762010-05-03 16:48:20 +0000600 def test_flush_error_on_close(self):
601 f = self.open(support.TESTFN, "wb", buffering=0)
602 def bad_flush():
603 raise IOError()
604 f.flush = bad_flush
605 self.assertRaises(IOError, f.close) # exception not swallowed
606
607 def test_multi_close(self):
608 f = self.open(support.TESTFN, "wb", buffering=0)
609 f.close()
610 f.close()
611 f.close()
612 self.assertRaises(ValueError, f.flush)
613
Antoine Pitrou328ec742010-09-14 18:37:24 +0000614 def test_RawIOBase_read(self):
615 # Exercise the default RawIOBase.read() implementation (which calls
616 # readinto() internally).
617 rawio = self.MockRawIOWithoutRead((b"abc", b"d", None, b"efg", None))
618 self.assertEqual(rawio.read(2), b"ab")
619 self.assertEqual(rawio.read(2), b"c")
620 self.assertEqual(rawio.read(2), b"d")
621 self.assertEqual(rawio.read(2), None)
622 self.assertEqual(rawio.read(2), b"ef")
623 self.assertEqual(rawio.read(2), b"g")
624 self.assertEqual(rawio.read(2), None)
625 self.assertEqual(rawio.read(2), b"")
626
Benjamin Petersonf6f3a352011-09-03 09:26:20 -0400627 def test_types_have_dict(self):
628 test = (
629 self.IOBase(),
630 self.RawIOBase(),
631 self.TextIOBase(),
632 self.StringIO(),
633 self.BytesIO()
634 )
635 for obj in test:
636 self.assertTrue(hasattr(obj, "__dict__"))
637
Ross Lagerwall59142db2011-10-31 20:34:46 +0200638 def test_opener(self):
639 with self.open(support.TESTFN, "w") as f:
640 f.write("egg\n")
641 fd = os.open(support.TESTFN, os.O_RDONLY)
642 def opener(path, flags):
643 return fd
644 with self.open("non-existent", "r", opener=opener) as f:
645 self.assertEqual(f.read(), "egg\n")
646
Hynek Schlawack2cc71562012-05-25 10:05:53 +0200647 def test_fileio_closefd(self):
648 # Issue #4841
649 with self.open(__file__, 'rb') as f1, \
650 self.open(__file__, 'rb') as f2:
651 fileio = self.FileIO(f1.fileno(), closefd=False)
652 # .__init__() must not close f1
653 fileio.__init__(f2.fileno(), closefd=False)
654 f1.readline()
655 # .close() must not close f2
656 fileio.close()
657 f2.readline()
658
659
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000660class CIOTest(IOTest):
Antoine Pitrou84f1b172011-07-12 21:57:15 +0200661
662 def test_IOBase_finalize(self):
663 # Issue #12149: segmentation fault on _PyIOBase_finalize when both a
664 # class which inherits IOBase and an object of this class are caught
665 # in a reference cycle and close() is already in the method cache.
666 class MyIO(self.IOBase):
667 def close(self):
668 pass
669
670 # create an instance to populate the method cache
671 MyIO()
672 obj = MyIO()
673 obj.obj = obj
674 wr = weakref.ref(obj)
675 del MyIO
676 del obj
677 support.gc_collect()
678 self.assertTrue(wr() is None, wr)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000679
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000680class PyIOTest(IOTest):
681 pass
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000682
Guido van Rossuma9e20242007-03-08 00:43:48 +0000683
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000684class CommonBufferedTests:
685 # Tests common to BufferedReader, BufferedWriter and BufferedRandom
686
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000687 def test_detach(self):
688 raw = self.MockRawIO()
689 buf = self.tp(raw)
690 self.assertIs(buf.detach(), raw)
691 self.assertRaises(ValueError, buf.detach)
692
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000693 def test_fileno(self):
694 rawio = self.MockRawIO()
695 bufio = self.tp(rawio)
696
Ezio Melottib3aedd42010-11-20 19:04:17 +0000697 self.assertEqual(42, bufio.fileno())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000698
699 def test_no_fileno(self):
700 # XXX will we always have fileno() function? If so, kill
701 # this test. Else, write it.
702 pass
703
704 def test_invalid_args(self):
705 rawio = self.MockRawIO()
706 bufio = self.tp(rawio)
707 # Invalid whence
708 self.assertRaises(ValueError, bufio.seek, 0, -1)
Jesus Cea94363612012-06-22 18:32:07 +0200709 self.assertRaises(ValueError, bufio.seek, 0, 9)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000710
711 def test_override_destructor(self):
712 tp = self.tp
713 record = []
714 class MyBufferedIO(tp):
715 def __del__(self):
716 record.append(1)
717 try:
718 f = super().__del__
719 except AttributeError:
720 pass
721 else:
722 f()
723 def close(self):
724 record.append(2)
725 super().close()
726 def flush(self):
727 record.append(3)
728 super().flush()
729 rawio = self.MockRawIO()
730 bufio = MyBufferedIO(rawio)
731 writable = bufio.writable()
732 del bufio
Benjamin Peterson24fb1d02009-04-24 23:26:21 +0000733 support.gc_collect()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000734 if writable:
735 self.assertEqual(record, [1, 2, 3])
736 else:
737 self.assertEqual(record, [1, 2])
738
739 def test_context_manager(self):
740 # Test usability as a context manager
741 rawio = self.MockRawIO()
742 bufio = self.tp(rawio)
743 def _with():
744 with bufio:
745 pass
746 _with()
747 # bufio should now be closed, and using it a second time should raise
748 # a ValueError.
749 self.assertRaises(ValueError, _with)
750
751 def test_error_through_destructor(self):
752 # Test that the exception state is not modified by a destructor,
753 # even if close() fails.
754 rawio = self.CloseFailureIO()
755 def f():
756 self.tp(rawio).xyzzy
757 with support.captured_output("stderr") as s:
758 self.assertRaises(AttributeError, f)
759 s = s.getvalue().strip()
760 if s:
761 # The destructor *may* have printed an unraisable error, check it
762 self.assertEqual(len(s.splitlines()), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000763 self.assertTrue(s.startswith("Exception IOError: "), s)
764 self.assertTrue(s.endswith(" ignored"), s)
Guido van Rossum78892e42007-04-06 17:31:18 +0000765
Antoine Pitrou716c4442009-05-23 19:04:03 +0000766 def test_repr(self):
767 raw = self.MockRawIO()
768 b = self.tp(raw)
769 clsname = "%s.%s" % (self.tp.__module__, self.tp.__name__)
770 self.assertEqual(repr(b), "<%s>" % clsname)
771 raw.name = "dummy"
772 self.assertEqual(repr(b), "<%s name='dummy'>" % clsname)
773 raw.name = b"dummy"
774 self.assertEqual(repr(b), "<%s name=b'dummy'>" % clsname)
775
Antoine Pitrou6be88762010-05-03 16:48:20 +0000776 def test_flush_error_on_close(self):
777 raw = self.MockRawIO()
778 def bad_flush():
779 raise IOError()
780 raw.flush = bad_flush
781 b = self.tp(raw)
782 self.assertRaises(IOError, b.close) # exception not swallowed
783
784 def test_multi_close(self):
785 raw = self.MockRawIO()
786 b = self.tp(raw)
787 b.close()
788 b.close()
789 b.close()
790 self.assertRaises(ValueError, b.flush)
791
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000792 def test_unseekable(self):
793 bufio = self.tp(self.MockUnseekableIO(b"A" * 10))
794 self.assertRaises(self.UnsupportedOperation, bufio.tell)
795 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
796
Antoine Pitrou7f8f4182010-12-21 21:20:59 +0000797 def test_readonly_attributes(self):
798 raw = self.MockRawIO()
799 buf = self.tp(raw)
800 x = self.MockRawIO()
801 with self.assertRaises(AttributeError):
802 buf.raw = x
803
Guido van Rossum78892e42007-04-06 17:31:18 +0000804
Antoine Pitrou10f0c502012-07-29 19:02:46 +0200805class SizeofTest:
806
807 @support.cpython_only
808 def test_sizeof(self):
809 bufsize1 = 4096
810 bufsize2 = 8192
811 rawio = self.MockRawIO()
812 bufio = self.tp(rawio, buffer_size=bufsize1)
813 size = sys.getsizeof(bufio) - bufsize1
814 rawio = self.MockRawIO()
815 bufio = self.tp(rawio, buffer_size=bufsize2)
816 self.assertEqual(sys.getsizeof(bufio), size + bufsize2)
817
Jesus Ceadc469452012-10-04 12:37:56 +0200818 @support.cpython_only
819 def test_buffer_freeing(self) :
820 bufsize = 4096
821 rawio = self.MockRawIO()
822 bufio = self.tp(rawio, buffer_size=bufsize)
823 size = sys.getsizeof(bufio) - bufsize
824 bufio.close()
825 self.assertEqual(sys.getsizeof(bufio), size)
Antoine Pitrou10f0c502012-07-29 19:02:46 +0200826
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000827class BufferedReaderTest(unittest.TestCase, CommonBufferedTests):
828 read_mode = "rb"
Guido van Rossum78892e42007-04-06 17:31:18 +0000829
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000830 def test_constructor(self):
831 rawio = self.MockRawIO([b"abc"])
832 bufio = self.tp(rawio)
833 bufio.__init__(rawio)
834 bufio.__init__(rawio, buffer_size=1024)
835 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000836 self.assertEqual(b"abc", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000837 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
838 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
839 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
840 rawio = self.MockRawIO([b"abc"])
841 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000842 self.assertEqual(b"abc", bufio.read())
Guido van Rossum78892e42007-04-06 17:31:18 +0000843
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000844 def test_read(self):
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000845 for arg in (None, 7):
846 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
847 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000848 self.assertEqual(b"abcdefg", bufio.read(arg))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000849 # Invalid args
850 self.assertRaises(ValueError, bufio.read, -2)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000851
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000852 def test_read1(self):
853 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
854 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000855 self.assertEqual(b"a", bufio.read(1))
856 self.assertEqual(b"b", bufio.read1(1))
857 self.assertEqual(rawio._reads, 1)
858 self.assertEqual(b"c", bufio.read1(100))
859 self.assertEqual(rawio._reads, 1)
860 self.assertEqual(b"d", bufio.read1(100))
861 self.assertEqual(rawio._reads, 2)
862 self.assertEqual(b"efg", bufio.read1(100))
863 self.assertEqual(rawio._reads, 3)
864 self.assertEqual(b"", bufio.read1(100))
865 self.assertEqual(rawio._reads, 4)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000866 # Invalid args
867 self.assertRaises(ValueError, bufio.read1, -1)
868
869 def test_readinto(self):
870 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
871 bufio = self.tp(rawio)
872 b = bytearray(2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000873 self.assertEqual(bufio.readinto(b), 2)
874 self.assertEqual(b, b"ab")
875 self.assertEqual(bufio.readinto(b), 2)
876 self.assertEqual(b, b"cd")
877 self.assertEqual(bufio.readinto(b), 2)
878 self.assertEqual(b, b"ef")
879 self.assertEqual(bufio.readinto(b), 1)
880 self.assertEqual(b, b"gf")
881 self.assertEqual(bufio.readinto(b), 0)
882 self.assertEqual(b, b"gf")
Antoine Pitrou3486a982011-05-12 01:57:53 +0200883 rawio = self.MockRawIO((b"abc", None))
884 bufio = self.tp(rawio)
885 self.assertEqual(bufio.readinto(b), 2)
886 self.assertEqual(b, b"ab")
887 self.assertEqual(bufio.readinto(b), 1)
888 self.assertEqual(b, b"cb")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000889
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000890 def test_readlines(self):
891 def bufio():
892 rawio = self.MockRawIO((b"abc\n", b"d\n", b"ef"))
893 return self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000894 self.assertEqual(bufio().readlines(), [b"abc\n", b"d\n", b"ef"])
895 self.assertEqual(bufio().readlines(5), [b"abc\n", b"d\n"])
896 self.assertEqual(bufio().readlines(None), [b"abc\n", b"d\n", b"ef"])
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000897
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000898 def test_buffering(self):
Guido van Rossum78892e42007-04-06 17:31:18 +0000899 data = b"abcdefghi"
900 dlen = len(data)
901
902 tests = [
903 [ 100, [ 3, 1, 4, 8 ], [ dlen, 0 ] ],
904 [ 100, [ 3, 3, 3], [ dlen ] ],
905 [ 4, [ 1, 2, 4, 2 ], [ 4, 4, 1 ] ],
906 ]
907
908 for bufsize, buf_read_sizes, raw_read_sizes in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000909 rawio = self.MockFileIO(data)
910 bufio = self.tp(rawio, buffer_size=bufsize)
Guido van Rossum78892e42007-04-06 17:31:18 +0000911 pos = 0
912 for nbytes in buf_read_sizes:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000913 self.assertEqual(bufio.read(nbytes), data[pos:pos+nbytes])
Guido van Rossum78892e42007-04-06 17:31:18 +0000914 pos += nbytes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000915 # this is mildly implementation-dependent
Ezio Melottib3aedd42010-11-20 19:04:17 +0000916 self.assertEqual(rawio.read_history, raw_read_sizes)
Guido van Rossum78892e42007-04-06 17:31:18 +0000917
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000918 def test_read_non_blocking(self):
Guido van Rossum01a27522007-03-07 01:00:12 +0000919 # Inject some None's in there to simulate EWOULDBLOCK
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000920 rawio = self.MockRawIO((b"abc", b"d", None, b"efg", None, None, None))
921 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000922 self.assertEqual(b"abcd", bufio.read(6))
923 self.assertEqual(b"e", bufio.read(1))
924 self.assertEqual(b"fg", bufio.read())
925 self.assertEqual(b"", bufio.peek(1))
Victor Stinnera80987f2011-05-25 22:47:16 +0200926 self.assertIsNone(bufio.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +0000927 self.assertEqual(b"", bufio.read())
Guido van Rossum01a27522007-03-07 01:00:12 +0000928
Victor Stinnera80987f2011-05-25 22:47:16 +0200929 rawio = self.MockRawIO((b"a", None, None))
930 self.assertEqual(b"a", rawio.readall())
931 self.assertIsNone(rawio.readall())
932
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000933 def test_read_past_eof(self):
934 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
935 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000936
Ezio Melottib3aedd42010-11-20 19:04:17 +0000937 self.assertEqual(b"abcdefg", bufio.read(9000))
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000938
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000939 def test_read_all(self):
940 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
941 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000942
Ezio Melottib3aedd42010-11-20 19:04:17 +0000943 self.assertEqual(b"abcdefg", bufio.read())
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000944
Victor Stinner45df8202010-04-28 22:31:17 +0000945 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000946 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000947 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +0000948 try:
949 # Write out many bytes with exactly the same number of 0's,
950 # 1's... 255's. This will help us check that concurrent reading
951 # doesn't duplicate or forget contents.
952 N = 1000
953 l = list(range(256)) * N
954 random.shuffle(l)
955 s = bytes(bytearray(l))
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000956 with self.open(support.TESTFN, "wb") as f:
Antoine Pitrou87695762008-08-14 22:44:29 +0000957 f.write(s)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000958 with self.open(support.TESTFN, self.read_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000959 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +0000960 errors = []
961 results = []
962 def f():
963 try:
964 # Intra-buffer read then buffer-flushing read
965 for n in cycle([1, 19]):
966 s = bufio.read(n)
967 if not s:
968 break
969 # list.append() is atomic
970 results.append(s)
971 except Exception as e:
972 errors.append(e)
973 raise
974 threads = [threading.Thread(target=f) for x in range(20)]
975 for t in threads:
976 t.start()
977 time.sleep(0.02) # yield
978 for t in threads:
979 t.join()
980 self.assertFalse(errors,
981 "the following exceptions were caught: %r" % errors)
982 s = b''.join(results)
983 for i in range(256):
984 c = bytes(bytearray([i]))
985 self.assertEqual(s.count(c), N)
986 finally:
987 support.unlink(support.TESTFN)
988
Antoine Pitrou1e44fec2011-10-04 12:26:20 +0200989 def test_unseekable(self):
990 bufio = self.tp(self.MockUnseekableIO(b"A" * 10))
991 self.assertRaises(self.UnsupportedOperation, bufio.tell)
992 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
993 bufio.read(1)
994 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
995 self.assertRaises(self.UnsupportedOperation, bufio.tell)
996
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000997 def test_misbehaved_io(self):
998 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
999 bufio = self.tp(rawio)
1000 self.assertRaises(IOError, bufio.seek, 0)
1001 self.assertRaises(IOError, bufio.tell)
1002
Antoine Pitrou32cfede2010-08-11 13:31:33 +00001003 def test_no_extraneous_read(self):
1004 # Issue #9550; when the raw IO object has satisfied the read request,
1005 # we should not issue any additional reads, otherwise it may block
1006 # (e.g. socket).
1007 bufsize = 16
1008 for n in (2, bufsize - 1, bufsize, bufsize + 1, bufsize * 2):
1009 rawio = self.MockRawIO([b"x" * n])
1010 bufio = self.tp(rawio, bufsize)
1011 self.assertEqual(bufio.read(n), b"x" * n)
1012 # Simple case: one raw read is enough to satisfy the request.
1013 self.assertEqual(rawio._extraneous_reads, 0,
1014 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
1015 # A more complex case where two raw reads are needed to satisfy
1016 # the request.
1017 rawio = self.MockRawIO([b"x" * (n - 1), b"x"])
1018 bufio = self.tp(rawio, bufsize)
1019 self.assertEqual(bufio.read(n), b"x" * n)
1020 self.assertEqual(rawio._extraneous_reads, 0,
1021 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
1022
1023
Antoine Pitrou10f0c502012-07-29 19:02:46 +02001024class CBufferedReaderTest(BufferedReaderTest, SizeofTest):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001025 tp = io.BufferedReader
1026
1027 def test_constructor(self):
1028 BufferedReaderTest.test_constructor(self)
1029 # The allocation can succeed on 32-bit builds, e.g. with more
1030 # than 2GB RAM and a 64-bit kernel.
1031 if sys.maxsize > 0x7FFFFFFF:
1032 rawio = self.MockRawIO()
1033 bufio = self.tp(rawio)
1034 self.assertRaises((OverflowError, MemoryError, ValueError),
1035 bufio.__init__, rawio, sys.maxsize)
1036
1037 def test_initialization(self):
1038 rawio = self.MockRawIO([b"abc"])
1039 bufio = self.tp(rawio)
1040 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1041 self.assertRaises(ValueError, bufio.read)
1042 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1043 self.assertRaises(ValueError, bufio.read)
1044 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1045 self.assertRaises(ValueError, bufio.read)
1046
1047 def test_misbehaved_io_read(self):
1048 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
1049 bufio = self.tp(rawio)
1050 # _pyio.BufferedReader seems to implement reading different, so that
1051 # checking this is not so easy.
1052 self.assertRaises(IOError, bufio.read, 10)
1053
1054 def test_garbage_collection(self):
1055 # C BufferedReader objects are collected.
1056 # The Python version has __del__, so it ends into gc.garbage instead
1057 rawio = self.FileIO(support.TESTFN, "w+b")
1058 f = self.tp(rawio)
1059 f.f = f
1060 wr = weakref.ref(f)
1061 del f
Benjamin Peterson45cec322009-04-24 23:14:50 +00001062 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001063 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001064
1065class PyBufferedReaderTest(BufferedReaderTest):
1066 tp = pyio.BufferedReader
Antoine Pitrou87695762008-08-14 22:44:29 +00001067
Guido van Rossuma9e20242007-03-08 00:43:48 +00001068
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001069class BufferedWriterTest(unittest.TestCase, CommonBufferedTests):
1070 write_mode = "wb"
Guido van Rossuma9e20242007-03-08 00:43:48 +00001071
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001072 def test_constructor(self):
1073 rawio = self.MockRawIO()
1074 bufio = self.tp(rawio)
1075 bufio.__init__(rawio)
1076 bufio.__init__(rawio, buffer_size=1024)
1077 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001078 self.assertEqual(3, bufio.write(b"abc"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001079 bufio.flush()
1080 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1081 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1082 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1083 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001084 self.assertEqual(3, bufio.write(b"ghi"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001085 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001086 self.assertEqual(b"".join(rawio._write_stack), b"abcghi")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001087
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001088 def test_detach_flush(self):
1089 raw = self.MockRawIO()
1090 buf = self.tp(raw)
1091 buf.write(b"howdy!")
1092 self.assertFalse(raw._write_stack)
1093 buf.detach()
1094 self.assertEqual(raw._write_stack, [b"howdy!"])
1095
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001096 def test_write(self):
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001097 # Write to the buffered IO but don't overflow the buffer.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001098 writer = self.MockRawIO()
1099 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001100 bufio.write(b"abc")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001101 self.assertFalse(writer._write_stack)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001102
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001103 def test_write_overflow(self):
1104 writer = self.MockRawIO()
1105 bufio = self.tp(writer, 8)
1106 contents = b"abcdefghijklmnop"
1107 for n in range(0, len(contents), 3):
1108 bufio.write(contents[n:n+3])
1109 flushed = b"".join(writer._write_stack)
1110 # At least (total - 8) bytes were implicitly flushed, perhaps more
1111 # depending on the implementation.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001112 self.assertTrue(flushed.startswith(contents[:-8]), flushed)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001113
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001114 def check_writes(self, intermediate_func):
1115 # Lots of writes, test the flushed output is as expected.
1116 contents = bytes(range(256)) * 1000
1117 n = 0
1118 writer = self.MockRawIO()
1119 bufio = self.tp(writer, 13)
1120 # Generator of write sizes: repeat each N 15 times then proceed to N+1
1121 def gen_sizes():
1122 for size in count(1):
1123 for i in range(15):
1124 yield size
1125 sizes = gen_sizes()
1126 while n < len(contents):
1127 size = min(next(sizes), len(contents) - n)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001128 self.assertEqual(bufio.write(contents[n:n+size]), size)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001129 intermediate_func(bufio)
1130 n += size
1131 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001132 self.assertEqual(contents, b"".join(writer._write_stack))
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001133
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001134 def test_writes(self):
1135 self.check_writes(lambda bufio: None)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001136
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001137 def test_writes_and_flushes(self):
1138 self.check_writes(lambda bufio: bufio.flush())
Guido van Rossum01a27522007-03-07 01:00:12 +00001139
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001140 def test_writes_and_seeks(self):
1141 def _seekabs(bufio):
1142 pos = bufio.tell()
1143 bufio.seek(pos + 1, 0)
1144 bufio.seek(pos - 1, 0)
1145 bufio.seek(pos, 0)
1146 self.check_writes(_seekabs)
1147 def _seekrel(bufio):
1148 pos = bufio.seek(0, 1)
1149 bufio.seek(+1, 1)
1150 bufio.seek(-1, 1)
1151 bufio.seek(pos, 0)
1152 self.check_writes(_seekrel)
Guido van Rossum01a27522007-03-07 01:00:12 +00001153
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001154 def test_writes_and_truncates(self):
1155 self.check_writes(lambda bufio: bufio.truncate(bufio.tell()))
Guido van Rossum01a27522007-03-07 01:00:12 +00001156
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001157 def test_write_non_blocking(self):
1158 raw = self.MockNonBlockWriterIO()
Benjamin Peterson59406a92009-03-26 17:10:29 +00001159 bufio = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001160
Ezio Melottib3aedd42010-11-20 19:04:17 +00001161 self.assertEqual(bufio.write(b"abcd"), 4)
1162 self.assertEqual(bufio.write(b"efghi"), 5)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001163 # 1 byte will be written, the rest will be buffered
1164 raw.block_on(b"k")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001165 self.assertEqual(bufio.write(b"jklmn"), 5)
Guido van Rossum01a27522007-03-07 01:00:12 +00001166
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001167 # 8 bytes will be written, 8 will be buffered and the rest will be lost
1168 raw.block_on(b"0")
1169 try:
1170 bufio.write(b"opqrwxyz0123456789")
1171 except self.BlockingIOError as e:
1172 written = e.characters_written
1173 else:
1174 self.fail("BlockingIOError should have been raised")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001175 self.assertEqual(written, 16)
1176 self.assertEqual(raw.pop_written(),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001177 b"abcdefghijklmnopqrwxyz")
Guido van Rossum01a27522007-03-07 01:00:12 +00001178
Ezio Melottib3aedd42010-11-20 19:04:17 +00001179 self.assertEqual(bufio.write(b"ABCDEFGHI"), 9)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001180 s = raw.pop_written()
1181 # Previously buffered bytes were flushed
1182 self.assertTrue(s.startswith(b"01234567A"), s)
Guido van Rossum01a27522007-03-07 01:00:12 +00001183
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001184 def test_write_and_rewind(self):
1185 raw = io.BytesIO()
1186 bufio = self.tp(raw, 4)
1187 self.assertEqual(bufio.write(b"abcdef"), 6)
1188 self.assertEqual(bufio.tell(), 6)
1189 bufio.seek(0, 0)
1190 self.assertEqual(bufio.write(b"XY"), 2)
1191 bufio.seek(6, 0)
1192 self.assertEqual(raw.getvalue(), b"XYcdef")
1193 self.assertEqual(bufio.write(b"123456"), 6)
1194 bufio.flush()
1195 self.assertEqual(raw.getvalue(), b"XYcdef123456")
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001196
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001197 def test_flush(self):
1198 writer = self.MockRawIO()
1199 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001200 bufio.write(b"abc")
1201 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001202 self.assertEqual(b"abc", writer._write_stack[0])
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001203
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001204 def test_destructor(self):
1205 writer = self.MockRawIO()
1206 bufio = self.tp(writer, 8)
1207 bufio.write(b"abc")
1208 del bufio
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001209 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001210 self.assertEqual(b"abc", writer._write_stack[0])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001211
1212 def test_truncate(self):
1213 # Truncate implicitly flushes the buffer.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001214 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001215 bufio = self.tp(raw, 8)
1216 bufio.write(b"abcdef")
1217 self.assertEqual(bufio.truncate(3), 3)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001218 self.assertEqual(bufio.tell(), 6)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001219 with self.open(support.TESTFN, "rb", buffering=0) as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001220 self.assertEqual(f.read(), b"abc")
1221
Victor Stinner45df8202010-04-28 22:31:17 +00001222 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +00001223 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001224 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +00001225 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001226 # Write out many bytes from many threads and test they were
1227 # all flushed.
1228 N = 1000
1229 contents = bytes(range(256)) * N
1230 sizes = cycle([1, 19])
1231 n = 0
1232 queue = deque()
1233 while n < len(contents):
1234 size = next(sizes)
1235 queue.append(contents[n:n+size])
1236 n += size
1237 del contents
Antoine Pitrou87695762008-08-14 22:44:29 +00001238 # We use a real file object because it allows us to
1239 # exercise situations where the GIL is released before
1240 # writing the buffer to the raw streams. This is in addition
1241 # to concurrency issues due to switching threads in the middle
1242 # of Python code.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001243 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001244 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +00001245 errors = []
1246 def f():
1247 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001248 while True:
1249 try:
1250 s = queue.popleft()
1251 except IndexError:
1252 return
Antoine Pitrou87695762008-08-14 22:44:29 +00001253 bufio.write(s)
1254 except Exception as e:
1255 errors.append(e)
1256 raise
1257 threads = [threading.Thread(target=f) for x in range(20)]
1258 for t in threads:
1259 t.start()
1260 time.sleep(0.02) # yield
1261 for t in threads:
1262 t.join()
1263 self.assertFalse(errors,
1264 "the following exceptions were caught: %r" % errors)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001265 bufio.close()
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001266 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001267 s = f.read()
1268 for i in range(256):
Ezio Melottib3aedd42010-11-20 19:04:17 +00001269 self.assertEqual(s.count(bytes([i])), N)
Antoine Pitrou87695762008-08-14 22:44:29 +00001270 finally:
1271 support.unlink(support.TESTFN)
1272
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001273 def test_misbehaved_io(self):
1274 rawio = self.MisbehavedRawIO()
1275 bufio = self.tp(rawio, 5)
1276 self.assertRaises(IOError, bufio.seek, 0)
1277 self.assertRaises(IOError, bufio.tell)
1278 self.assertRaises(IOError, bufio.write, b"abcdef")
1279
Florent Xicluna109d5732012-07-07 17:03:22 +02001280 def test_max_buffer_size_removal(self):
1281 with self.assertRaises(TypeError):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001282 self.tp(self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001283
1284
Antoine Pitrou10f0c502012-07-29 19:02:46 +02001285class CBufferedWriterTest(BufferedWriterTest, SizeofTest):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001286 tp = io.BufferedWriter
1287
1288 def test_constructor(self):
1289 BufferedWriterTest.test_constructor(self)
1290 # The allocation can succeed on 32-bit builds, e.g. with more
1291 # than 2GB RAM and a 64-bit kernel.
1292 if sys.maxsize > 0x7FFFFFFF:
1293 rawio = self.MockRawIO()
1294 bufio = self.tp(rawio)
1295 self.assertRaises((OverflowError, MemoryError, ValueError),
1296 bufio.__init__, rawio, sys.maxsize)
1297
1298 def test_initialization(self):
1299 rawio = self.MockRawIO()
1300 bufio = self.tp(rawio)
1301 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1302 self.assertRaises(ValueError, bufio.write, b"def")
1303 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1304 self.assertRaises(ValueError, bufio.write, b"def")
1305 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1306 self.assertRaises(ValueError, bufio.write, b"def")
1307
1308 def test_garbage_collection(self):
1309 # C BufferedWriter objects are collected, and collecting them flushes
1310 # all data to disk.
1311 # The Python version has __del__, so it ends into gc.garbage instead
1312 rawio = self.FileIO(support.TESTFN, "w+b")
1313 f = self.tp(rawio)
1314 f.write(b"123xxx")
1315 f.x = f
1316 wr = weakref.ref(f)
1317 del f
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001318 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001319 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001320 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001321 self.assertEqual(f.read(), b"123xxx")
1322
1323
1324class PyBufferedWriterTest(BufferedWriterTest):
1325 tp = pyio.BufferedWriter
Guido van Rossuma9e20242007-03-08 00:43:48 +00001326
Guido van Rossum01a27522007-03-07 01:00:12 +00001327class BufferedRWPairTest(unittest.TestCase):
Guido van Rossuma9e20242007-03-08 00:43:48 +00001328
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001329 def test_constructor(self):
1330 pair = self.tp(self.MockRawIO(), self.MockRawIO())
Benjamin Peterson92035012008-12-27 16:00:54 +00001331 self.assertFalse(pair.closed)
Guido van Rossum01a27522007-03-07 01:00:12 +00001332
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001333 def test_detach(self):
1334 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1335 self.assertRaises(self.UnsupportedOperation, pair.detach)
1336
Florent Xicluna109d5732012-07-07 17:03:22 +02001337 def test_constructor_max_buffer_size_removal(self):
1338 with self.assertRaises(TypeError):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001339 self.tp(self.MockRawIO(), self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001340
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001341 def test_constructor_with_not_readable(self):
1342 class NotReadable(MockRawIO):
1343 def readable(self):
1344 return False
1345
1346 self.assertRaises(IOError, self.tp, NotReadable(), self.MockRawIO())
1347
1348 def test_constructor_with_not_writeable(self):
1349 class NotWriteable(MockRawIO):
1350 def writable(self):
1351 return False
1352
1353 self.assertRaises(IOError, self.tp, self.MockRawIO(), NotWriteable())
1354
1355 def test_read(self):
1356 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1357
1358 self.assertEqual(pair.read(3), b"abc")
1359 self.assertEqual(pair.read(1), b"d")
1360 self.assertEqual(pair.read(), b"ef")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00001361 pair = self.tp(self.BytesIO(b"abc"), self.MockRawIO())
1362 self.assertEqual(pair.read(None), b"abc")
1363
1364 def test_readlines(self):
1365 pair = lambda: self.tp(self.BytesIO(b"abc\ndef\nh"), self.MockRawIO())
1366 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1367 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1368 self.assertEqual(pair().readlines(5), [b"abc\n", b"def\n"])
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001369
1370 def test_read1(self):
1371 # .read1() is delegated to the underlying reader object, so this test
1372 # can be shallow.
1373 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1374
1375 self.assertEqual(pair.read1(3), b"abc")
1376
1377 def test_readinto(self):
1378 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1379
1380 data = bytearray(5)
1381 self.assertEqual(pair.readinto(data), 5)
1382 self.assertEqual(data, b"abcde")
1383
1384 def test_write(self):
1385 w = self.MockRawIO()
1386 pair = self.tp(self.MockRawIO(), w)
1387
1388 pair.write(b"abc")
1389 pair.flush()
1390 pair.write(b"def")
1391 pair.flush()
1392 self.assertEqual(w._write_stack, [b"abc", b"def"])
1393
1394 def test_peek(self):
1395 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1396
1397 self.assertTrue(pair.peek(3).startswith(b"abc"))
1398 self.assertEqual(pair.read(3), b"abc")
1399
1400 def test_readable(self):
1401 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1402 self.assertTrue(pair.readable())
1403
1404 def test_writeable(self):
1405 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1406 self.assertTrue(pair.writable())
1407
1408 def test_seekable(self):
1409 # BufferedRWPairs are never seekable, even if their readers and writers
1410 # are.
1411 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1412 self.assertFalse(pair.seekable())
1413
1414 # .flush() is delegated to the underlying writer object and has been
1415 # tested in the test_write method.
1416
1417 def test_close_and_closed(self):
1418 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1419 self.assertFalse(pair.closed)
1420 pair.close()
1421 self.assertTrue(pair.closed)
1422
1423 def test_isatty(self):
1424 class SelectableIsAtty(MockRawIO):
1425 def __init__(self, isatty):
1426 MockRawIO.__init__(self)
1427 self._isatty = isatty
1428
1429 def isatty(self):
1430 return self._isatty
1431
1432 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(False))
1433 self.assertFalse(pair.isatty())
1434
1435 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(False))
1436 self.assertTrue(pair.isatty())
1437
1438 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(True))
1439 self.assertTrue(pair.isatty())
1440
1441 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(True))
1442 self.assertTrue(pair.isatty())
Guido van Rossum01a27522007-03-07 01:00:12 +00001443
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001444class CBufferedRWPairTest(BufferedRWPairTest):
1445 tp = io.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001446
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001447class PyBufferedRWPairTest(BufferedRWPairTest):
1448 tp = pyio.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001449
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001450
1451class BufferedRandomTest(BufferedReaderTest, BufferedWriterTest):
1452 read_mode = "rb+"
1453 write_mode = "wb+"
1454
1455 def test_constructor(self):
1456 BufferedReaderTest.test_constructor(self)
1457 BufferedWriterTest.test_constructor(self)
1458
1459 def test_read_and_write(self):
1460 raw = self.MockRawIO((b"asdf", b"ghjk"))
Benjamin Peterson59406a92009-03-26 17:10:29 +00001461 rw = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001462
1463 self.assertEqual(b"as", rw.read(2))
1464 rw.write(b"ddd")
1465 rw.write(b"eee")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001466 self.assertFalse(raw._write_stack) # Buffer writes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001467 self.assertEqual(b"ghjk", rw.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +00001468 self.assertEqual(b"dddeee", raw._write_stack[0])
Guido van Rossum01a27522007-03-07 01:00:12 +00001469
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001470 def test_seek_and_tell(self):
1471 raw = self.BytesIO(b"asdfghjkl")
1472 rw = self.tp(raw)
Guido van Rossum01a27522007-03-07 01:00:12 +00001473
Ezio Melottib3aedd42010-11-20 19:04:17 +00001474 self.assertEqual(b"as", rw.read(2))
1475 self.assertEqual(2, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001476 rw.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001477 self.assertEqual(b"asdf", rw.read(4))
Guido van Rossum01a27522007-03-07 01:00:12 +00001478
Antoine Pitroue05565e2011-08-20 14:39:23 +02001479 rw.write(b"123f")
Guido van Rossum01a27522007-03-07 01:00:12 +00001480 rw.seek(0, 0)
Antoine Pitroue05565e2011-08-20 14:39:23 +02001481 self.assertEqual(b"asdf123fl", rw.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +00001482 self.assertEqual(9, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001483 rw.seek(-4, 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001484 self.assertEqual(5, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001485 rw.seek(2, 1)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001486 self.assertEqual(7, rw.tell())
1487 self.assertEqual(b"fl", rw.read(11))
Antoine Pitroue05565e2011-08-20 14:39:23 +02001488 rw.flush()
1489 self.assertEqual(b"asdf123fl", raw.getvalue())
1490
Christian Heimes8e42a0a2007-11-08 18:04:45 +00001491 self.assertRaises(TypeError, rw.seek, 0.0)
Guido van Rossum01a27522007-03-07 01:00:12 +00001492
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001493 def check_flush_and_read(self, read_func):
1494 raw = self.BytesIO(b"abcdefghi")
1495 bufio = self.tp(raw)
1496
Ezio Melottib3aedd42010-11-20 19:04:17 +00001497 self.assertEqual(b"ab", read_func(bufio, 2))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001498 bufio.write(b"12")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001499 self.assertEqual(b"ef", read_func(bufio, 2))
1500 self.assertEqual(6, bufio.tell())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001501 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001502 self.assertEqual(6, bufio.tell())
1503 self.assertEqual(b"ghi", read_func(bufio))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001504 raw.seek(0, 0)
1505 raw.write(b"XYZ")
1506 # flush() resets the read buffer
1507 bufio.flush()
1508 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001509 self.assertEqual(b"XYZ", read_func(bufio, 3))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001510
1511 def test_flush_and_read(self):
1512 self.check_flush_and_read(lambda bufio, *args: bufio.read(*args))
1513
1514 def test_flush_and_readinto(self):
1515 def _readinto(bufio, n=-1):
1516 b = bytearray(n if n >= 0 else 9999)
1517 n = bufio.readinto(b)
1518 return bytes(b[:n])
1519 self.check_flush_and_read(_readinto)
1520
1521 def test_flush_and_peek(self):
1522 def _peek(bufio, n=-1):
1523 # This relies on the fact that the buffer can contain the whole
1524 # raw stream, otherwise peek() can return less.
1525 b = bufio.peek(n)
1526 if n != -1:
1527 b = b[:n]
1528 bufio.seek(len(b), 1)
1529 return b
1530 self.check_flush_and_read(_peek)
1531
1532 def test_flush_and_write(self):
1533 raw = self.BytesIO(b"abcdefghi")
1534 bufio = self.tp(raw)
1535
1536 bufio.write(b"123")
1537 bufio.flush()
1538 bufio.write(b"45")
1539 bufio.flush()
1540 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001541 self.assertEqual(b"12345fghi", raw.getvalue())
1542 self.assertEqual(b"12345fghi", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001543
1544 def test_threads(self):
1545 BufferedReaderTest.test_threads(self)
1546 BufferedWriterTest.test_threads(self)
1547
1548 def test_writes_and_peek(self):
1549 def _peek(bufio):
1550 bufio.peek(1)
1551 self.check_writes(_peek)
1552 def _peek(bufio):
1553 pos = bufio.tell()
1554 bufio.seek(-1, 1)
1555 bufio.peek(1)
1556 bufio.seek(pos, 0)
1557 self.check_writes(_peek)
1558
1559 def test_writes_and_reads(self):
1560 def _read(bufio):
1561 bufio.seek(-1, 1)
1562 bufio.read(1)
1563 self.check_writes(_read)
1564
1565 def test_writes_and_read1s(self):
1566 def _read1(bufio):
1567 bufio.seek(-1, 1)
1568 bufio.read1(1)
1569 self.check_writes(_read1)
1570
1571 def test_writes_and_readintos(self):
1572 def _read(bufio):
1573 bufio.seek(-1, 1)
1574 bufio.readinto(bytearray(1))
1575 self.check_writes(_read)
1576
Antoine Pitroua0ceb732009-08-06 20:29:56 +00001577 def test_write_after_readahead(self):
1578 # Issue #6629: writing after the buffer was filled by readahead should
1579 # first rewind the raw stream.
1580 for overwrite_size in [1, 5]:
1581 raw = self.BytesIO(b"A" * 10)
1582 bufio = self.tp(raw, 4)
1583 # Trigger readahead
1584 self.assertEqual(bufio.read(1), b"A")
1585 self.assertEqual(bufio.tell(), 1)
1586 # Overwriting should rewind the raw stream if it needs so
1587 bufio.write(b"B" * overwrite_size)
1588 self.assertEqual(bufio.tell(), overwrite_size + 1)
1589 # If the write size was smaller than the buffer size, flush() and
1590 # check that rewind happens.
1591 bufio.flush()
1592 self.assertEqual(bufio.tell(), overwrite_size + 1)
1593 s = raw.getvalue()
1594 self.assertEqual(s,
1595 b"A" + b"B" * overwrite_size + b"A" * (9 - overwrite_size))
1596
Antoine Pitrou7c404892011-05-13 00:13:33 +02001597 def test_write_rewind_write(self):
1598 # Various combinations of reading / writing / seeking backwards / writing again
1599 def mutate(bufio, pos1, pos2):
1600 assert pos2 >= pos1
1601 # Fill the buffer
1602 bufio.seek(pos1)
1603 bufio.read(pos2 - pos1)
1604 bufio.write(b'\x02')
1605 # This writes earlier than the previous write, but still inside
1606 # the buffer.
1607 bufio.seek(pos1)
1608 bufio.write(b'\x01')
1609
1610 b = b"\x80\x81\x82\x83\x84"
1611 for i in range(0, len(b)):
1612 for j in range(i, len(b)):
1613 raw = self.BytesIO(b)
1614 bufio = self.tp(raw, 100)
1615 mutate(bufio, i, j)
1616 bufio.flush()
1617 expected = bytearray(b)
1618 expected[j] = 2
1619 expected[i] = 1
1620 self.assertEqual(raw.getvalue(), expected,
1621 "failed result for i=%d, j=%d" % (i, j))
1622
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001623 def test_truncate_after_read_or_write(self):
1624 raw = self.BytesIO(b"A" * 10)
1625 bufio = self.tp(raw, 100)
1626 self.assertEqual(bufio.read(2), b"AA") # the read buffer gets filled
1627 self.assertEqual(bufio.truncate(), 2)
1628 self.assertEqual(bufio.write(b"BB"), 2) # the write buffer increases
1629 self.assertEqual(bufio.truncate(), 4)
1630
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001631 def test_misbehaved_io(self):
1632 BufferedReaderTest.test_misbehaved_io(self)
1633 BufferedWriterTest.test_misbehaved_io(self)
1634
Antoine Pitroue05565e2011-08-20 14:39:23 +02001635 def test_interleaved_read_write(self):
1636 # Test for issue #12213
1637 with self.BytesIO(b'abcdefgh') as raw:
1638 with self.tp(raw, 100) as f:
1639 f.write(b"1")
1640 self.assertEqual(f.read(1), b'b')
1641 f.write(b'2')
1642 self.assertEqual(f.read1(1), b'd')
1643 f.write(b'3')
1644 buf = bytearray(1)
1645 f.readinto(buf)
1646 self.assertEqual(buf, b'f')
1647 f.write(b'4')
1648 self.assertEqual(f.peek(1), b'h')
1649 f.flush()
1650 self.assertEqual(raw.getvalue(), b'1b2d3f4h')
1651
1652 with self.BytesIO(b'abc') as raw:
1653 with self.tp(raw, 100) as f:
1654 self.assertEqual(f.read(1), b'a')
1655 f.write(b"2")
1656 self.assertEqual(f.read(1), b'c')
1657 f.flush()
1658 self.assertEqual(raw.getvalue(), b'a2c')
1659
1660 def test_interleaved_readline_write(self):
1661 with self.BytesIO(b'ab\ncdef\ng\n') as raw:
1662 with self.tp(raw) as f:
1663 f.write(b'1')
1664 self.assertEqual(f.readline(), b'b\n')
1665 f.write(b'2')
1666 self.assertEqual(f.readline(), b'def\n')
1667 f.write(b'3')
1668 self.assertEqual(f.readline(), b'\n')
1669 f.flush()
1670 self.assertEqual(raw.getvalue(), b'1b\n2def\n3\n')
1671
Antoine Pitrou0d739d72010-09-05 23:01:12 +00001672 # You can't construct a BufferedRandom over a non-seekable stream.
1673 test_unseekable = None
1674
Antoine Pitrou10f0c502012-07-29 19:02:46 +02001675class CBufferedRandomTest(BufferedRandomTest, SizeofTest):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001676 tp = io.BufferedRandom
1677
1678 def test_constructor(self):
1679 BufferedRandomTest.test_constructor(self)
1680 # The allocation can succeed on 32-bit builds, e.g. with more
1681 # than 2GB RAM and a 64-bit kernel.
1682 if sys.maxsize > 0x7FFFFFFF:
1683 rawio = self.MockRawIO()
1684 bufio = self.tp(rawio)
1685 self.assertRaises((OverflowError, MemoryError, ValueError),
1686 bufio.__init__, rawio, sys.maxsize)
1687
1688 def test_garbage_collection(self):
1689 CBufferedReaderTest.test_garbage_collection(self)
1690 CBufferedWriterTest.test_garbage_collection(self)
1691
1692class PyBufferedRandomTest(BufferedRandomTest):
1693 tp = pyio.BufferedRandom
1694
1695
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001696# To fully exercise seek/tell, the StatefulIncrementalDecoder has these
1697# properties:
1698# - A single output character can correspond to many bytes of input.
1699# - The number of input bytes to complete the character can be
1700# undetermined until the last input byte is received.
1701# - The number of input bytes can vary depending on previous input.
1702# - A single input byte can correspond to many characters of output.
1703# - The number of output characters can be undetermined until the
1704# last input byte is received.
1705# - The number of output characters can vary depending on previous input.
1706
1707class StatefulIncrementalDecoder(codecs.IncrementalDecoder):
1708 """
1709 For testing seek/tell behavior with a stateful, buffering decoder.
1710
1711 Input is a sequence of words. Words may be fixed-length (length set
1712 by input) or variable-length (period-terminated). In variable-length
1713 mode, extra periods are ignored. Possible words are:
1714 - 'i' followed by a number sets the input length, I (maximum 99).
1715 When I is set to 0, words are space-terminated.
1716 - 'o' followed by a number sets the output length, O (maximum 99).
1717 - Any other word is converted into a word followed by a period on
1718 the output. The output word consists of the input word truncated
1719 or padded out with hyphens to make its length equal to O. If O
1720 is 0, the word is output verbatim without truncating or padding.
1721 I and O are initially set to 1. When I changes, any buffered input is
1722 re-scanned according to the new I. EOF also terminates the last word.
1723 """
1724
1725 def __init__(self, errors='strict'):
Christian Heimesab568872008-03-23 02:11:13 +00001726 codecs.IncrementalDecoder.__init__(self, errors)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001727 self.reset()
1728
1729 def __repr__(self):
1730 return '<SID %x>' % id(self)
1731
1732 def reset(self):
1733 self.i = 1
1734 self.o = 1
1735 self.buffer = bytearray()
1736
1737 def getstate(self):
1738 i, o = self.i ^ 1, self.o ^ 1 # so that flags = 0 after reset()
1739 return bytes(self.buffer), i*100 + o
1740
1741 def setstate(self, state):
1742 buffer, io = state
1743 self.buffer = bytearray(buffer)
1744 i, o = divmod(io, 100)
1745 self.i, self.o = i ^ 1, o ^ 1
1746
1747 def decode(self, input, final=False):
1748 output = ''
1749 for b in input:
1750 if self.i == 0: # variable-length, terminated with period
1751 if b == ord('.'):
1752 if self.buffer:
1753 output += self.process_word()
1754 else:
1755 self.buffer.append(b)
1756 else: # fixed-length, terminate after self.i bytes
1757 self.buffer.append(b)
1758 if len(self.buffer) == self.i:
1759 output += self.process_word()
1760 if final and self.buffer: # EOF terminates the last word
1761 output += self.process_word()
1762 return output
1763
1764 def process_word(self):
1765 output = ''
1766 if self.buffer[0] == ord('i'):
1767 self.i = min(99, int(self.buffer[1:] or 0)) # set input length
1768 elif self.buffer[0] == ord('o'):
1769 self.o = min(99, int(self.buffer[1:] or 0)) # set output length
1770 else:
1771 output = self.buffer.decode('ascii')
1772 if len(output) < self.o:
1773 output += '-'*self.o # pad out with hyphens
1774 if self.o:
1775 output = output[:self.o] # truncate to output length
1776 output += '.'
1777 self.buffer = bytearray()
1778 return output
1779
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001780 codecEnabled = False
1781
1782 @classmethod
1783 def lookupTestDecoder(cls, name):
1784 if cls.codecEnabled and name == 'test_decoder':
Antoine Pitrou180a3362008-12-14 16:36:46 +00001785 latin1 = codecs.lookup('latin-1')
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001786 return codecs.CodecInfo(
Antoine Pitrou180a3362008-12-14 16:36:46 +00001787 name='test_decoder', encode=latin1.encode, decode=None,
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001788 incrementalencoder=None,
1789 streamreader=None, streamwriter=None,
1790 incrementaldecoder=cls)
1791
1792# Register the previous decoder for testing.
1793# Disabled by default, tests will enable it.
1794codecs.register(StatefulIncrementalDecoder.lookupTestDecoder)
1795
1796
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001797class StatefulIncrementalDecoderTest(unittest.TestCase):
1798 """
1799 Make sure the StatefulIncrementalDecoder actually works.
1800 """
1801
1802 test_cases = [
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001803 # I=1, O=1 (fixed-length input == fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001804 (b'abcd', False, 'a.b.c.d.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001805 # I=0, O=0 (variable-length input, variable-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001806 (b'oiabcd', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001807 # I=0, O=0 (should ignore extra periods)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001808 (b'oi...abcd...', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001809 # I=0, O=6 (variable-length input, fixed-length output)
1810 (b'i.o6.x.xyz.toolongtofit.', False, 'x-----.xyz---.toolon.'),
1811 # I=2, O=6 (fixed-length input < fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001812 (b'i.i2.o6xyz', True, 'xy----.z-----.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001813 # I=6, O=3 (fixed-length input > fixed-length output)
1814 (b'i.o3.i6.abcdefghijklmnop', True, 'abc.ghi.mno.'),
1815 # I=0, then 3; O=29, then 15 (with longer output)
1816 (b'i.o29.a.b.cde.o15.abcdefghijabcdefghij.i3.a.b.c.d.ei00k.l.m', True,
1817 'a----------------------------.' +
1818 'b----------------------------.' +
1819 'cde--------------------------.' +
1820 'abcdefghijabcde.' +
1821 'a.b------------.' +
1822 '.c.------------.' +
1823 'd.e------------.' +
1824 'k--------------.' +
1825 'l--------------.' +
1826 'm--------------.')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001827 ]
1828
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001829 def test_decoder(self):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001830 # Try a few one-shot test cases.
1831 for input, eof, output in self.test_cases:
1832 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001833 self.assertEqual(d.decode(input, eof), output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001834
1835 # Also test an unfinished decode, followed by forcing EOF.
1836 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001837 self.assertEqual(d.decode(b'oiabcd'), '')
1838 self.assertEqual(d.decode(b'', 1), 'abcd.')
Guido van Rossum78892e42007-04-06 17:31:18 +00001839
1840class TextIOWrapperTest(unittest.TestCase):
Guido van Rossum9b76da62007-04-11 01:09:03 +00001841
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001842 def setUp(self):
1843 self.testdata = b"AAA\r\nBBB\rCCC\r\nDDD\nEEE\r\n"
1844 self.normalized = b"AAA\nBBB\nCCC\nDDD\nEEE\n".decode("ascii")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001845 support.unlink(support.TESTFN)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001846
Guido van Rossumd0712812007-04-11 16:32:43 +00001847 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001848 support.unlink(support.TESTFN)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001849
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001850 def test_constructor(self):
1851 r = self.BytesIO(b"\xc3\xa9\n\n")
1852 b = self.BufferedReader(r, 1000)
1853 t = self.TextIOWrapper(b)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001854 t.__init__(b, encoding="latin-1", newline="\r\n")
1855 self.assertEqual(t.encoding, "latin-1")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001856 self.assertEqual(t.line_buffering, False)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001857 t.__init__(b, encoding="utf-8", line_buffering=True)
1858 self.assertEqual(t.encoding, "utf-8")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001859 self.assertEqual(t.line_buffering, True)
1860 self.assertEqual("\xe9\n", t.readline())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001861 self.assertRaises(TypeError, t.__init__, b, newline=42)
1862 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
1863
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001864 def test_detach(self):
1865 r = self.BytesIO()
1866 b = self.BufferedWriter(r)
1867 t = self.TextIOWrapper(b)
1868 self.assertIs(t.detach(), b)
1869
1870 t = self.TextIOWrapper(b, encoding="ascii")
1871 t.write("howdy")
1872 self.assertFalse(r.getvalue())
1873 t.detach()
1874 self.assertEqual(r.getvalue(), b"howdy")
1875 self.assertRaises(ValueError, t.detach)
1876
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001877 def test_repr(self):
1878 raw = self.BytesIO("hello".encode("utf-8"))
1879 b = self.BufferedReader(raw)
1880 t = self.TextIOWrapper(b, encoding="utf-8")
Antoine Pitrou716c4442009-05-23 19:04:03 +00001881 modname = self.TextIOWrapper.__module__
1882 self.assertEqual(repr(t),
1883 "<%s.TextIOWrapper encoding='utf-8'>" % modname)
1884 raw.name = "dummy"
1885 self.assertEqual(repr(t),
1886 "<%s.TextIOWrapper name='dummy' encoding='utf-8'>" % modname)
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001887 t.mode = "r"
1888 self.assertEqual(repr(t),
1889 "<%s.TextIOWrapper name='dummy' mode='r' encoding='utf-8'>" % modname)
Antoine Pitrou716c4442009-05-23 19:04:03 +00001890 raw.name = b"dummy"
1891 self.assertEqual(repr(t),
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001892 "<%s.TextIOWrapper name=b'dummy' mode='r' encoding='utf-8'>" % modname)
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001893
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001894 def test_line_buffering(self):
1895 r = self.BytesIO()
1896 b = self.BufferedWriter(r, 1000)
1897 t = self.TextIOWrapper(b, newline="\n", line_buffering=True)
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001898 t.write("X")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001899 self.assertEqual(r.getvalue(), b"") # No flush happened
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001900 t.write("Y\nZ")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001901 self.assertEqual(r.getvalue(), b"XY\nZ") # All got flushed
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001902 t.write("A\rB")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001903 self.assertEqual(r.getvalue(), b"XY\nZA\rB")
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001904
Victor Stinnerf86a5e82012-06-05 13:43:22 +02001905 def test_default_encoding(self):
1906 old_environ = dict(os.environ)
1907 try:
1908 # try to get a user preferred encoding different than the current
1909 # locale encoding to check that TextIOWrapper() uses the current
1910 # locale encoding and not the user preferred encoding
1911 for key in ('LC_ALL', 'LANG', 'LC_CTYPE'):
1912 if key in os.environ:
1913 del os.environ[key]
1914
1915 current_locale_encoding = locale.getpreferredencoding(False)
1916 b = self.BytesIO()
1917 t = self.TextIOWrapper(b)
1918 self.assertEqual(t.encoding, current_locale_encoding)
1919 finally:
1920 os.environ.clear()
1921 os.environ.update(old_environ)
1922
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001923 def test_encoding(self):
1924 # Check the encoding attribute is always set, and valid
1925 b = self.BytesIO()
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001926 t = self.TextIOWrapper(b, encoding="utf-8")
1927 self.assertEqual(t.encoding, "utf-8")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001928 t = self.TextIOWrapper(b)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001929 self.assertTrue(t.encoding is not None)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001930 codecs.lookup(t.encoding)
1931
1932 def test_encoding_errors_reading(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001933 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001934 b = self.BytesIO(b"abc\n\xff\n")
1935 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001936 self.assertRaises(UnicodeError, t.read)
1937 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001938 b = self.BytesIO(b"abc\n\xff\n")
1939 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001940 self.assertRaises(UnicodeError, t.read)
1941 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001942 b = self.BytesIO(b"abc\n\xff\n")
1943 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001944 self.assertEqual(t.read(), "abc\n\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001945 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001946 b = self.BytesIO(b"abc\n\xff\n")
1947 t = self.TextIOWrapper(b, encoding="ascii", errors="replace")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001948 self.assertEqual(t.read(), "abc\n\ufffd\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001949
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001950 def test_encoding_errors_writing(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001951 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001952 b = self.BytesIO()
1953 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001954 self.assertRaises(UnicodeError, t.write, "\xff")
1955 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001956 b = self.BytesIO()
1957 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001958 self.assertRaises(UnicodeError, t.write, "\xff")
1959 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001960 b = self.BytesIO()
1961 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001962 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001963 t.write("abc\xffdef\n")
1964 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001965 self.assertEqual(b.getvalue(), b"abcdef\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001966 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001967 b = self.BytesIO()
1968 t = self.TextIOWrapper(b, encoding="ascii", errors="replace",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001969 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001970 t.write("abc\xffdef\n")
1971 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001972 self.assertEqual(b.getvalue(), b"abc?def\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001973
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001974 def test_newlines(self):
Guido van Rossum78892e42007-04-06 17:31:18 +00001975 input_lines = [ "unix\n", "windows\r\n", "os9\r", "last\n", "nonl" ]
1976
1977 tests = [
1978 [ None, [ 'unix\n', 'windows\n', 'os9\n', 'last\n', 'nonl' ] ],
Guido van Rossum8358db22007-08-18 21:39:55 +00001979 [ '', input_lines ],
1980 [ '\n', [ "unix\n", "windows\r\n", "os9\rlast\n", "nonl" ] ],
1981 [ '\r\n', [ "unix\nwindows\r\n", "os9\rlast\nnonl" ] ],
1982 [ '\r', [ "unix\nwindows\r", "\nos9\r", "last\nnonl" ] ],
Guido van Rossum78892e42007-04-06 17:31:18 +00001983 ]
Antoine Pitrou180a3362008-12-14 16:36:46 +00001984 encodings = (
1985 'utf-8', 'latin-1',
1986 'utf-16', 'utf-16-le', 'utf-16-be',
1987 'utf-32', 'utf-32-le', 'utf-32-be',
1988 )
Guido van Rossum78892e42007-04-06 17:31:18 +00001989
Guido van Rossum8358db22007-08-18 21:39:55 +00001990 # Try a range of buffer sizes to test the case where \r is the last
Guido van Rossum78892e42007-04-06 17:31:18 +00001991 # character in TextIOWrapper._pending_line.
1992 for encoding in encodings:
Guido van Rossum8358db22007-08-18 21:39:55 +00001993 # XXX: str.encode() should return bytes
1994 data = bytes(''.join(input_lines).encode(encoding))
Guido van Rossum78892e42007-04-06 17:31:18 +00001995 for do_reads in (False, True):
Guido van Rossum8358db22007-08-18 21:39:55 +00001996 for bufsize in range(1, 10):
1997 for newline, exp_lines in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001998 bufio = self.BufferedReader(self.BytesIO(data), bufsize)
1999 textio = self.TextIOWrapper(bufio, newline=newline,
Guido van Rossum78892e42007-04-06 17:31:18 +00002000 encoding=encoding)
2001 if do_reads:
2002 got_lines = []
2003 while True:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00002004 c2 = textio.read(2)
Guido van Rossum78892e42007-04-06 17:31:18 +00002005 if c2 == '':
2006 break
Ezio Melottib3aedd42010-11-20 19:04:17 +00002007 self.assertEqual(len(c2), 2)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00002008 got_lines.append(c2 + textio.readline())
Guido van Rossum78892e42007-04-06 17:31:18 +00002009 else:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00002010 got_lines = list(textio)
Guido van Rossum78892e42007-04-06 17:31:18 +00002011
2012 for got_line, exp_line in zip(got_lines, exp_lines):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002013 self.assertEqual(got_line, exp_line)
2014 self.assertEqual(len(got_lines), len(exp_lines))
Guido van Rossum78892e42007-04-06 17:31:18 +00002015
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002016 def test_newlines_input(self):
2017 testdata = b"AAA\nBB\x00B\nCCC\rDDD\rEEE\r\nFFF\r\nGGG"
Guido van Rossum8358db22007-08-18 21:39:55 +00002018 normalized = testdata.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
2019 for newline, expected in [
Ezio Melottid8b509b2011-09-28 17:37:55 +03002020 (None, normalized.decode("ascii").splitlines(keepends=True)),
2021 ("", testdata.decode("ascii").splitlines(keepends=True)),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002022 ("\n", ["AAA\n", "BB\x00B\n", "CCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
2023 ("\r\n", ["AAA\nBB\x00B\nCCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
2024 ("\r", ["AAA\nBB\x00B\nCCC\r", "DDD\r", "EEE\r", "\nFFF\r", "\nGGG"]),
Guido van Rossum8358db22007-08-18 21:39:55 +00002025 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002026 buf = self.BytesIO(testdata)
2027 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002028 self.assertEqual(txt.readlines(), expected)
Guido van Rossum8358db22007-08-18 21:39:55 +00002029 txt.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002030 self.assertEqual(txt.read(), "".join(expected))
Guido van Rossum8358db22007-08-18 21:39:55 +00002031
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002032 def test_newlines_output(self):
2033 testdict = {
2034 "": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
2035 "\n": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
2036 "\r": b"AAA\rBBB\rCCC\rX\rY\r\rZ",
2037 "\r\n": b"AAA\r\nBBB\r\nCCC\r\nX\rY\r\r\nZ",
2038 }
2039 tests = [(None, testdict[os.linesep])] + sorted(testdict.items())
2040 for newline, expected in tests:
2041 buf = self.BytesIO()
2042 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
2043 txt.write("AAA\nB")
2044 txt.write("BB\nCCC\n")
2045 txt.write("X\rY\r\nZ")
2046 txt.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002047 self.assertEqual(buf.closed, False)
2048 self.assertEqual(buf.getvalue(), expected)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002049
2050 def test_destructor(self):
2051 l = []
2052 base = self.BytesIO
2053 class MyBytesIO(base):
2054 def close(self):
2055 l.append(self.getvalue())
2056 base.close(self)
2057 b = MyBytesIO()
2058 t = self.TextIOWrapper(b, encoding="ascii")
2059 t.write("abc")
2060 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002061 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002062 self.assertEqual([b"abc"], l)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002063
2064 def test_override_destructor(self):
2065 record = []
2066 class MyTextIO(self.TextIOWrapper):
2067 def __del__(self):
2068 record.append(1)
2069 try:
2070 f = super().__del__
2071 except AttributeError:
2072 pass
2073 else:
2074 f()
2075 def close(self):
2076 record.append(2)
2077 super().close()
2078 def flush(self):
2079 record.append(3)
2080 super().flush()
2081 b = self.BytesIO()
2082 t = MyTextIO(b, encoding="ascii")
2083 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002084 support.gc_collect()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002085 self.assertEqual(record, [1, 2, 3])
2086
2087 def test_error_through_destructor(self):
2088 # Test that the exception state is not modified by a destructor,
2089 # even if close() fails.
2090 rawio = self.CloseFailureIO()
2091 def f():
2092 self.TextIOWrapper(rawio).xyzzy
2093 with support.captured_output("stderr") as s:
2094 self.assertRaises(AttributeError, f)
2095 s = s.getvalue().strip()
2096 if s:
2097 # The destructor *may* have printed an unraisable error, check it
2098 self.assertEqual(len(s.splitlines()), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002099 self.assertTrue(s.startswith("Exception IOError: "), s)
2100 self.assertTrue(s.endswith(" ignored"), s)
Guido van Rossum8358db22007-08-18 21:39:55 +00002101
Guido van Rossum9b76da62007-04-11 01:09:03 +00002102 # Systematic tests of the text I/O API
2103
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002104 def test_basic_io(self):
Guido van Rossum9b76da62007-04-11 01:09:03 +00002105 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 +00002106 for enc in "ascii", "latin-1", "utf-8" :# , "utf-16-be", "utf-16-le":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002107 f = self.open(support.TESTFN, "w+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002108 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00002109 self.assertEqual(f.write("abc"), 3)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002110 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002111 f = self.open(support.TESTFN, "r+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002112 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00002113 self.assertEqual(f.tell(), 0)
2114 self.assertEqual(f.read(), "abc")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002115 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002116 self.assertEqual(f.seek(0), 0)
2117 self.assertEqual(f.read(None), "abc")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00002118 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002119 self.assertEqual(f.read(2), "ab")
2120 self.assertEqual(f.read(1), "c")
2121 self.assertEqual(f.read(1), "")
2122 self.assertEqual(f.read(), "")
2123 self.assertEqual(f.tell(), cookie)
2124 self.assertEqual(f.seek(0), 0)
2125 self.assertEqual(f.seek(0, 2), cookie)
2126 self.assertEqual(f.write("def"), 3)
2127 self.assertEqual(f.seek(cookie), cookie)
2128 self.assertEqual(f.read(), "def")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002129 if enc.startswith("utf"):
2130 self.multi_line_test(f, enc)
2131 f.close()
2132
2133 def multi_line_test(self, f, enc):
2134 f.seek(0)
2135 f.truncate()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002136 sample = "s\xff\u0fff\uffff"
Guido van Rossum9b76da62007-04-11 01:09:03 +00002137 wlines = []
Guido van Rossumcba608c2007-04-11 14:19:59 +00002138 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 +00002139 chars = []
Guido van Rossum805365e2007-05-07 22:24:25 +00002140 for i in range(size):
Guido van Rossum9b76da62007-04-11 01:09:03 +00002141 chars.append(sample[i % len(sample)])
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002142 line = "".join(chars) + "\n"
Guido van Rossum9b76da62007-04-11 01:09:03 +00002143 wlines.append((f.tell(), line))
2144 f.write(line)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002145 f.seek(0)
2146 rlines = []
2147 while True:
2148 pos = f.tell()
2149 line = f.readline()
2150 if not line:
Guido van Rossum9b76da62007-04-11 01:09:03 +00002151 break
2152 rlines.append((pos, line))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002153 self.assertEqual(rlines, wlines)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002154
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002155 def test_telling(self):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00002156 f = self.open(support.TESTFN, "w+", encoding="utf-8")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002157 p0 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002158 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002159 p1 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002160 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002161 p2 = f.tell()
2162 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002163 self.assertEqual(f.tell(), p0)
2164 self.assertEqual(f.readline(), "\xff\n")
2165 self.assertEqual(f.tell(), p1)
2166 self.assertEqual(f.readline(), "\xff\n")
2167 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002168 f.seek(0)
2169 for line in f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002170 self.assertEqual(line, "\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002171 self.assertRaises(IOError, f.tell)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002172 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002173 f.close()
2174
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002175 def test_seeking(self):
2176 chunk_size = _default_chunk_size()
Guido van Rossumd76e7792007-04-17 02:38:04 +00002177 prefix_size = chunk_size - 2
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002178 u_prefix = "a" * prefix_size
Guido van Rossumd76e7792007-04-17 02:38:04 +00002179 prefix = bytes(u_prefix.encode("utf-8"))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002180 self.assertEqual(len(u_prefix), len(prefix))
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002181 u_suffix = "\u8888\n"
Guido van Rossumd76e7792007-04-17 02:38:04 +00002182 suffix = bytes(u_suffix.encode("utf-8"))
2183 line = prefix + suffix
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002184 with self.open(support.TESTFN, "wb") as f:
2185 f.write(line*2)
2186 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2187 s = f.read(prefix_size)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002188 self.assertEqual(s, str(prefix, "ascii"))
2189 self.assertEqual(f.tell(), prefix_size)
2190 self.assertEqual(f.readline(), u_suffix)
Guido van Rossumd76e7792007-04-17 02:38:04 +00002191
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002192 def test_seeking_too(self):
Guido van Rossumd76e7792007-04-17 02:38:04 +00002193 # Regression test for a specific bug
2194 data = b'\xe0\xbf\xbf\n'
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002195 with self.open(support.TESTFN, "wb") as f:
2196 f.write(data)
2197 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2198 f._CHUNK_SIZE # Just test that it exists
2199 f._CHUNK_SIZE = 2
2200 f.readline()
2201 f.tell()
Guido van Rossumd76e7792007-04-17 02:38:04 +00002202
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002203 def test_seek_and_tell(self):
2204 #Test seek/tell using the StatefulIncrementalDecoder.
2205 # Make test faster by doing smaller seeks
2206 CHUNK_SIZE = 128
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002207
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002208 def test_seek_and_tell_with_data(data, min_pos=0):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002209 """Tell/seek to various points within a data stream and ensure
2210 that the decoded data returned by read() is consistent."""
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002211 f = self.open(support.TESTFN, 'wb')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002212 f.write(data)
2213 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002214 f = self.open(support.TESTFN, encoding='test_decoder')
2215 f._CHUNK_SIZE = CHUNK_SIZE
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002216 decoded = f.read()
2217 f.close()
2218
Neal Norwitze2b07052008-03-18 19:52:05 +00002219 for i in range(min_pos, len(decoded) + 1): # seek positions
2220 for j in [1, 5, len(decoded) - i]: # read lengths
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002221 f = self.open(support.TESTFN, encoding='test_decoder')
Ezio Melottib3aedd42010-11-20 19:04:17 +00002222 self.assertEqual(f.read(i), decoded[:i])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002223 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002224 self.assertEqual(f.read(j), decoded[i:i + j])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002225 f.seek(cookie)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002226 self.assertEqual(f.read(), decoded[i:])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002227 f.close()
2228
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002229 # Enable the test decoder.
2230 StatefulIncrementalDecoder.codecEnabled = 1
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002231
2232 # Run the tests.
2233 try:
2234 # Try each test case.
2235 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002236 test_seek_and_tell_with_data(input)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002237
2238 # Position each test case so that it crosses a chunk boundary.
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002239 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
2240 offset = CHUNK_SIZE - len(input)//2
2241 prefix = b'.'*offset
2242 # Don't bother seeking into the prefix (takes too long).
2243 min_pos = offset*2
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002244 test_seek_and_tell_with_data(prefix + input, min_pos)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002245
2246 # Ensure our test decoder won't interfere with subsequent tests.
2247 finally:
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002248 StatefulIncrementalDecoder.codecEnabled = 0
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002249
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002250 def test_encoded_writes(self):
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002251 data = "1234567890"
2252 tests = ("utf-16",
2253 "utf-16-le",
2254 "utf-16-be",
2255 "utf-32",
2256 "utf-32-le",
2257 "utf-32-be")
2258 for encoding in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002259 buf = self.BytesIO()
2260 f = self.TextIOWrapper(buf, encoding=encoding)
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002261 # Check if the BOM is written only once (see issue1753).
2262 f.write(data)
2263 f.write(data)
2264 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002265 self.assertEqual(f.read(), data * 2)
Benjamin Peterson9363a652009-03-05 00:42:09 +00002266 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002267 self.assertEqual(f.read(), data * 2)
2268 self.assertEqual(buf.getvalue(), (data * 2).encode(encoding))
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002269
Benjamin Petersona1b49012009-03-31 23:11:32 +00002270 def test_unreadable(self):
2271 class UnReadable(self.BytesIO):
2272 def readable(self):
2273 return False
2274 txt = self.TextIOWrapper(UnReadable())
2275 self.assertRaises(IOError, txt.read)
2276
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002277 def test_read_one_by_one(self):
2278 txt = self.TextIOWrapper(self.BytesIO(b"AA\r\nBB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002279 reads = ""
2280 while True:
2281 c = txt.read(1)
2282 if not c:
2283 break
2284 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002285 self.assertEqual(reads, "AA\nBB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002286
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00002287 def test_readlines(self):
2288 txt = self.TextIOWrapper(self.BytesIO(b"AA\nBB\nCC"))
2289 self.assertEqual(txt.readlines(), ["AA\n", "BB\n", "CC"])
2290 txt.seek(0)
2291 self.assertEqual(txt.readlines(None), ["AA\n", "BB\n", "CC"])
2292 txt.seek(0)
2293 self.assertEqual(txt.readlines(5), ["AA\n", "BB\n"])
2294
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002295 # read in amounts equal to TextIOWrapper._CHUNK_SIZE which is 128.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002296 def test_read_by_chunk(self):
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002297 # make sure "\r\n" straddles 128 char boundary.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002298 txt = self.TextIOWrapper(self.BytesIO(b"A" * 127 + b"\r\nB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002299 reads = ""
2300 while True:
2301 c = txt.read(128)
2302 if not c:
2303 break
2304 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002305 self.assertEqual(reads, "A"*127+"\nB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002306
2307 def test_issue1395_1(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002308 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002309
2310 # read one char at a time
2311 reads = ""
2312 while True:
2313 c = txt.read(1)
2314 if not c:
2315 break
2316 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002317 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002318
2319 def test_issue1395_2(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002320 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002321 txt._CHUNK_SIZE = 4
2322
2323 reads = ""
2324 while True:
2325 c = txt.read(4)
2326 if not c:
2327 break
2328 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002329 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002330
2331 def test_issue1395_3(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002332 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002333 txt._CHUNK_SIZE = 4
2334
2335 reads = txt.read(4)
2336 reads += txt.read(4)
2337 reads += txt.readline()
2338 reads += txt.readline()
2339 reads += txt.readline()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002340 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002341
2342 def test_issue1395_4(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002343 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002344 txt._CHUNK_SIZE = 4
2345
2346 reads = txt.read(4)
2347 reads += txt.read()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002348 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002349
2350 def test_issue1395_5(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002351 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002352 txt._CHUNK_SIZE = 4
2353
2354 reads = txt.read(4)
2355 pos = txt.tell()
2356 txt.seek(0)
2357 txt.seek(pos)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002358 self.assertEqual(txt.read(4), "BBB\n")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002359
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002360 def test_issue2282(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002361 buffer = self.BytesIO(self.testdata)
2362 txt = self.TextIOWrapper(buffer, encoding="ascii")
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002363
2364 self.assertEqual(buffer.seekable(), txt.seekable())
2365
Antoine Pitroue4501852009-05-14 18:55:55 +00002366 def test_append_bom(self):
2367 # The BOM is not written again when appending to a non-empty file
2368 filename = support.TESTFN
2369 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2370 with self.open(filename, 'w', encoding=charset) as f:
2371 f.write('aaa')
2372 pos = f.tell()
2373 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002374 self.assertEqual(f.read(), 'aaa'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002375
2376 with self.open(filename, 'a', encoding=charset) as f:
2377 f.write('xxx')
2378 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002379 self.assertEqual(f.read(), 'aaaxxx'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002380
2381 def test_seek_bom(self):
2382 # Same test, but when seeking manually
2383 filename = support.TESTFN
2384 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2385 with self.open(filename, 'w', encoding=charset) as f:
2386 f.write('aaa')
2387 pos = f.tell()
2388 with self.open(filename, 'r+', encoding=charset) as f:
2389 f.seek(pos)
2390 f.write('zzz')
2391 f.seek(0)
2392 f.write('bbb')
2393 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002394 self.assertEqual(f.read(), 'bbbzzz'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002395
Benjamin Peterson0926ad12009-06-06 18:02:12 +00002396 def test_errors_property(self):
2397 with self.open(support.TESTFN, "w") as f:
2398 self.assertEqual(f.errors, "strict")
2399 with self.open(support.TESTFN, "w", errors="replace") as f:
2400 self.assertEqual(f.errors, "replace")
2401
Brett Cannon31f59292011-02-21 19:29:56 +00002402 @support.no_tracing
Victor Stinner45df8202010-04-28 22:31:17 +00002403 @unittest.skipUnless(threading, 'Threading required for this test.')
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002404 def test_threads_write(self):
2405 # Issue6750: concurrent writes could duplicate data
2406 event = threading.Event()
2407 with self.open(support.TESTFN, "w", buffering=1) as f:
2408 def run(n):
2409 text = "Thread%03d\n" % n
2410 event.wait()
2411 f.write(text)
2412 threads = [threading.Thread(target=lambda n=x: run(n))
2413 for x in range(20)]
2414 for t in threads:
2415 t.start()
2416 time.sleep(0.02)
2417 event.set()
2418 for t in threads:
2419 t.join()
2420 with self.open(support.TESTFN) as f:
2421 content = f.read()
2422 for n in range(20):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002423 self.assertEqual(content.count("Thread%03d\n" % n), 1)
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002424
Antoine Pitrou6be88762010-05-03 16:48:20 +00002425 def test_flush_error_on_close(self):
2426 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2427 def bad_flush():
2428 raise IOError()
2429 txt.flush = bad_flush
2430 self.assertRaises(IOError, txt.close) # exception not swallowed
2431
2432 def test_multi_close(self):
2433 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2434 txt.close()
2435 txt.close()
2436 txt.close()
2437 self.assertRaises(ValueError, txt.flush)
2438
Antoine Pitrou0d739d72010-09-05 23:01:12 +00002439 def test_unseekable(self):
2440 txt = self.TextIOWrapper(self.MockUnseekableIO(self.testdata))
2441 self.assertRaises(self.UnsupportedOperation, txt.tell)
2442 self.assertRaises(self.UnsupportedOperation, txt.seek, 0)
2443
Antoine Pitrou7f8f4182010-12-21 21:20:59 +00002444 def test_readonly_attributes(self):
2445 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2446 buf = self.BytesIO(self.testdata)
2447 with self.assertRaises(AttributeError):
2448 txt.buffer = buf
2449
Antoine Pitroue96ec682011-07-23 21:46:35 +02002450 def test_rawio(self):
2451 # Issue #12591: TextIOWrapper must work with raw I/O objects, so
2452 # that subprocess.Popen() can have the required unbuffered
2453 # semantics with universal_newlines=True.
2454 raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n'])
2455 txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n')
2456 # Reads
2457 self.assertEqual(txt.read(4), 'abcd')
2458 self.assertEqual(txt.readline(), 'efghi\n')
2459 self.assertEqual(list(txt), ['jkl\n', 'opq\n'])
2460
2461 def test_rawio_write_through(self):
2462 # Issue #12591: with write_through=True, writes don't need a flush
2463 raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n'])
2464 txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n',
2465 write_through=True)
2466 txt.write('1')
2467 txt.write('23\n4')
2468 txt.write('5')
2469 self.assertEqual(b''.join(raw._write_stack), b'123\n45')
2470
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002471class CTextIOWrapperTest(TextIOWrapperTest):
2472
2473 def test_initialization(self):
2474 r = self.BytesIO(b"\xc3\xa9\n\n")
2475 b = self.BufferedReader(r, 1000)
2476 t = self.TextIOWrapper(b)
2477 self.assertRaises(TypeError, t.__init__, b, newline=42)
2478 self.assertRaises(ValueError, t.read)
2479 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
2480 self.assertRaises(ValueError, t.read)
2481
2482 def test_garbage_collection(self):
2483 # C TextIOWrapper objects are collected, and collecting them flushes
2484 # all data to disk.
2485 # The Python version has __del__, so it ends in gc.garbage instead.
2486 rawio = io.FileIO(support.TESTFN, "wb")
2487 b = self.BufferedWriter(rawio)
2488 t = self.TextIOWrapper(b, encoding="ascii")
2489 t.write("456def")
2490 t.x = t
2491 wr = weakref.ref(t)
2492 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002493 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002494 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00002495 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002496 self.assertEqual(f.read(), b"456def")
2497
Charles-François Natali42c28cd2011-10-05 19:53:43 +02002498 def test_rwpair_cleared_before_textio(self):
2499 # Issue 13070: TextIOWrapper's finalization would crash when called
2500 # after the reference to the underlying BufferedRWPair's writer got
2501 # cleared by the GC.
2502 for i in range(1000):
2503 b1 = self.BufferedRWPair(self.MockRawIO(), self.MockRawIO())
2504 t1 = self.TextIOWrapper(b1, encoding="ascii")
2505 b2 = self.BufferedRWPair(self.MockRawIO(), self.MockRawIO())
2506 t2 = self.TextIOWrapper(b2, encoding="ascii")
2507 # circular references
2508 t1.buddy = t2
2509 t2.buddy = t1
2510 support.gc_collect()
2511
2512
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002513class PyTextIOWrapperTest(TextIOWrapperTest):
2514 pass
2515
2516
2517class IncrementalNewlineDecoderTest(unittest.TestCase):
2518
2519 def check_newline_decoding_utf8(self, decoder):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002520 # UTF-8 specific tests for a newline decoder
2521 def _check_decode(b, s, **kwargs):
2522 # We exercise getstate() / setstate() as well as decode()
2523 state = decoder.getstate()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002524 self.assertEqual(decoder.decode(b, **kwargs), s)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002525 decoder.setstate(state)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002526 self.assertEqual(decoder.decode(b, **kwargs), s)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002527
Antoine Pitrou180a3362008-12-14 16:36:46 +00002528 _check_decode(b'\xe8\xa2\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002529
Antoine Pitrou180a3362008-12-14 16:36:46 +00002530 _check_decode(b'\xe8', "")
2531 _check_decode(b'\xa2', "")
2532 _check_decode(b'\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002533
Antoine Pitrou180a3362008-12-14 16:36:46 +00002534 _check_decode(b'\xe8', "")
2535 _check_decode(b'\xa2', "")
2536 _check_decode(b'\x88', "\u8888")
2537
2538 _check_decode(b'\xe8', "")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002539 self.assertRaises(UnicodeDecodeError, decoder.decode, b'', final=True)
2540
Antoine Pitrou180a3362008-12-14 16:36:46 +00002541 decoder.reset()
2542 _check_decode(b'\n', "\n")
2543 _check_decode(b'\r', "")
2544 _check_decode(b'', "\n", final=True)
2545 _check_decode(b'\r', "\n", final=True)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002546
Antoine Pitrou180a3362008-12-14 16:36:46 +00002547 _check_decode(b'\r', "")
2548 _check_decode(b'a', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002549
Antoine Pitrou180a3362008-12-14 16:36:46 +00002550 _check_decode(b'\r\r\n', "\n\n")
2551 _check_decode(b'\r', "")
2552 _check_decode(b'\r', "\n")
2553 _check_decode(b'\na', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002554
Antoine Pitrou180a3362008-12-14 16:36:46 +00002555 _check_decode(b'\xe8\xa2\x88\r\n', "\u8888\n")
2556 _check_decode(b'\xe8\xa2\x88', "\u8888")
2557 _check_decode(b'\n', "\n")
2558 _check_decode(b'\xe8\xa2\x88\r', "\u8888")
2559 _check_decode(b'\n', "\n")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002560
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002561 def check_newline_decoding(self, decoder, encoding):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002562 result = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002563 if encoding is not None:
2564 encoder = codecs.getincrementalencoder(encoding)()
2565 def _decode_bytewise(s):
2566 # Decode one byte at a time
2567 for b in encoder.encode(s):
2568 result.append(decoder.decode(bytes([b])))
2569 else:
2570 encoder = None
2571 def _decode_bytewise(s):
2572 # Decode one char at a time
2573 for c in s:
2574 result.append(decoder.decode(c))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002575 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002576 _decode_bytewise("abc\n\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002577 self.assertEqual(decoder.newlines, '\n')
Antoine Pitrou180a3362008-12-14 16:36:46 +00002578 _decode_bytewise("\nabc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002579 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002580 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002581 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002582 _decode_bytewise("abc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002583 self.assertEqual(decoder.newlines, ('\r', '\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002584 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002585 self.assertEqual("".join(result), "abc\n\nabcabc\nabcabc")
Antoine Pitrou180a3362008-12-14 16:36:46 +00002586 decoder.reset()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002587 input = "abc"
2588 if encoder is not None:
2589 encoder.reset()
2590 input = encoder.encode(input)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002591 self.assertEqual(decoder.decode(input), "abc")
2592 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002593
2594 def test_newline_decoder(self):
2595 encodings = (
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002596 # None meaning the IncrementalNewlineDecoder takes unicode input
2597 # rather than bytes input
2598 None, 'utf-8', 'latin-1',
Antoine Pitrou180a3362008-12-14 16:36:46 +00002599 'utf-16', 'utf-16-le', 'utf-16-be',
2600 'utf-32', 'utf-32-le', 'utf-32-be',
2601 )
2602 for enc in encodings:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002603 decoder = enc and codecs.getincrementaldecoder(enc)()
2604 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2605 self.check_newline_decoding(decoder, enc)
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002606 decoder = codecs.getincrementaldecoder("utf-8")()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002607 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2608 self.check_newline_decoding_utf8(decoder)
2609
Antoine Pitrou66913e22009-03-06 23:40:56 +00002610 def test_newline_bytes(self):
2611 # Issue 5433: Excessive optimization in IncrementalNewlineDecoder
2612 def _check(dec):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002613 self.assertEqual(dec.newlines, None)
2614 self.assertEqual(dec.decode("\u0D00"), "\u0D00")
2615 self.assertEqual(dec.newlines, None)
2616 self.assertEqual(dec.decode("\u0A00"), "\u0A00")
2617 self.assertEqual(dec.newlines, None)
Antoine Pitrou66913e22009-03-06 23:40:56 +00002618 dec = self.IncrementalNewlineDecoder(None, translate=False)
2619 _check(dec)
2620 dec = self.IncrementalNewlineDecoder(None, translate=True)
2621 _check(dec)
2622
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002623class CIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2624 pass
2625
2626class PyIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2627 pass
Antoine Pitrou180a3362008-12-14 16:36:46 +00002628
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002629
Guido van Rossum01a27522007-03-07 01:00:12 +00002630# XXX Tests for open()
Guido van Rossum68bbcd22007-02-27 17:19:33 +00002631
Guido van Rossum5abbf752007-08-27 17:39:33 +00002632class MiscIOTest(unittest.TestCase):
2633
Barry Warsaw40e82462008-11-20 20:14:50 +00002634 def tearDown(self):
2635 support.unlink(support.TESTFN)
2636
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002637 def test___all__(self):
2638 for name in self.io.__all__:
2639 obj = getattr(self.io, name, None)
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002640 self.assertTrue(obj is not None, name)
Guido van Rossum5abbf752007-08-27 17:39:33 +00002641 if name == "open":
2642 continue
Benjamin Peterson6a52a9c2009-04-29 22:00:44 +00002643 elif "error" in name.lower() or name == "UnsupportedOperation":
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002644 self.assertTrue(issubclass(obj, Exception), name)
2645 elif not name.startswith("SEEK_"):
2646 self.assertTrue(issubclass(obj, self.IOBase))
Benjamin Peterson65676e42008-11-05 21:42:45 +00002647
Barry Warsaw40e82462008-11-20 20:14:50 +00002648 def test_attributes(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002649 f = self.open(support.TESTFN, "wb", buffering=0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002650 self.assertEqual(f.mode, "wb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002651 f.close()
2652
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002653 f = self.open(support.TESTFN, "U")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002654 self.assertEqual(f.name, support.TESTFN)
2655 self.assertEqual(f.buffer.name, support.TESTFN)
2656 self.assertEqual(f.buffer.raw.name, support.TESTFN)
2657 self.assertEqual(f.mode, "U")
2658 self.assertEqual(f.buffer.mode, "rb")
2659 self.assertEqual(f.buffer.raw.mode, "rb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002660 f.close()
2661
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002662 f = self.open(support.TESTFN, "w+")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002663 self.assertEqual(f.mode, "w+")
2664 self.assertEqual(f.buffer.mode, "rb+") # Does it really matter?
2665 self.assertEqual(f.buffer.raw.mode, "rb+")
Barry Warsaw40e82462008-11-20 20:14:50 +00002666
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002667 g = self.open(f.fileno(), "wb", closefd=False)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002668 self.assertEqual(g.mode, "wb")
2669 self.assertEqual(g.raw.mode, "wb")
2670 self.assertEqual(g.name, f.fileno())
2671 self.assertEqual(g.raw.name, f.fileno())
Barry Warsaw40e82462008-11-20 20:14:50 +00002672 f.close()
2673 g.close()
2674
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002675 def test_io_after_close(self):
2676 for kwargs in [
2677 {"mode": "w"},
2678 {"mode": "wb"},
2679 {"mode": "w", "buffering": 1},
2680 {"mode": "w", "buffering": 2},
2681 {"mode": "wb", "buffering": 0},
2682 {"mode": "r"},
2683 {"mode": "rb"},
2684 {"mode": "r", "buffering": 1},
2685 {"mode": "r", "buffering": 2},
2686 {"mode": "rb", "buffering": 0},
2687 {"mode": "w+"},
2688 {"mode": "w+b"},
2689 {"mode": "w+", "buffering": 1},
2690 {"mode": "w+", "buffering": 2},
2691 {"mode": "w+b", "buffering": 0},
2692 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002693 f = self.open(support.TESTFN, **kwargs)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002694 f.close()
2695 self.assertRaises(ValueError, f.flush)
2696 self.assertRaises(ValueError, f.fileno)
2697 self.assertRaises(ValueError, f.isatty)
2698 self.assertRaises(ValueError, f.__iter__)
2699 if hasattr(f, "peek"):
2700 self.assertRaises(ValueError, f.peek, 1)
2701 self.assertRaises(ValueError, f.read)
2702 if hasattr(f, "read1"):
2703 self.assertRaises(ValueError, f.read1, 1024)
Victor Stinnerb79f28c2011-05-25 22:09:03 +02002704 if hasattr(f, "readall"):
2705 self.assertRaises(ValueError, f.readall)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002706 if hasattr(f, "readinto"):
2707 self.assertRaises(ValueError, f.readinto, bytearray(1024))
2708 self.assertRaises(ValueError, f.readline)
2709 self.assertRaises(ValueError, f.readlines)
2710 self.assertRaises(ValueError, f.seek, 0)
2711 self.assertRaises(ValueError, f.tell)
2712 self.assertRaises(ValueError, f.truncate)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002713 self.assertRaises(ValueError, f.write,
2714 b"" if "b" in kwargs['mode'] else "")
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002715 self.assertRaises(ValueError, f.writelines, [])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002716 self.assertRaises(ValueError, next, f)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002717
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002718 def test_blockingioerror(self):
2719 # Various BlockingIOError issues
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002720 class C(str):
2721 pass
2722 c = C("")
2723 b = self.BlockingIOError(1, c)
2724 c.b = b
2725 b.c = c
2726 wr = weakref.ref(c)
2727 del c, b
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002728 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002729 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002730
2731 def test_abcs(self):
2732 # Test the visible base classes are ABCs.
Ezio Melottie9615932010-01-24 19:26:24 +00002733 self.assertIsInstance(self.IOBase, abc.ABCMeta)
2734 self.assertIsInstance(self.RawIOBase, abc.ABCMeta)
2735 self.assertIsInstance(self.BufferedIOBase, abc.ABCMeta)
2736 self.assertIsInstance(self.TextIOBase, abc.ABCMeta)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002737
2738 def _check_abc_inheritance(self, abcmodule):
2739 with self.open(support.TESTFN, "wb", buffering=0) as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002740 self.assertIsInstance(f, abcmodule.IOBase)
2741 self.assertIsInstance(f, abcmodule.RawIOBase)
2742 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2743 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002744 with self.open(support.TESTFN, "wb") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002745 self.assertIsInstance(f, abcmodule.IOBase)
2746 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2747 self.assertIsInstance(f, abcmodule.BufferedIOBase)
2748 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002749 with self.open(support.TESTFN, "w") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002750 self.assertIsInstance(f, abcmodule.IOBase)
2751 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2752 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2753 self.assertIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002754
2755 def test_abc_inheritance(self):
2756 # Test implementations inherit from their respective ABCs
2757 self._check_abc_inheritance(self)
2758
2759 def test_abc_inheritance_official(self):
2760 # Test implementations inherit from the official ABCs of the
2761 # baseline "io" module.
2762 self._check_abc_inheritance(io)
2763
Antoine Pitroue033e062010-10-29 10:38:18 +00002764 def _check_warn_on_dealloc(self, *args, **kwargs):
2765 f = open(*args, **kwargs)
2766 r = repr(f)
2767 with self.assertWarns(ResourceWarning) as cm:
2768 f = None
2769 support.gc_collect()
2770 self.assertIn(r, str(cm.warning.args[0]))
2771
2772 def test_warn_on_dealloc(self):
2773 self._check_warn_on_dealloc(support.TESTFN, "wb", buffering=0)
2774 self._check_warn_on_dealloc(support.TESTFN, "wb")
2775 self._check_warn_on_dealloc(support.TESTFN, "w")
2776
2777 def _check_warn_on_dealloc_fd(self, *args, **kwargs):
2778 fds = []
Benjamin Peterson556c7352010-10-31 01:35:43 +00002779 def cleanup_fds():
Antoine Pitroue033e062010-10-29 10:38:18 +00002780 for fd in fds:
2781 try:
2782 os.close(fd)
2783 except EnvironmentError as e:
2784 if e.errno != errno.EBADF:
2785 raise
Benjamin Peterson556c7352010-10-31 01:35:43 +00002786 self.addCleanup(cleanup_fds)
2787 r, w = os.pipe()
2788 fds += r, w
2789 self._check_warn_on_dealloc(r, *args, **kwargs)
2790 # When using closefd=False, there's no warning
2791 r, w = os.pipe()
2792 fds += r, w
2793 with warnings.catch_warnings(record=True) as recorded:
2794 open(r, *args, closefd=False, **kwargs)
2795 support.gc_collect()
2796 self.assertEqual(recorded, [])
Antoine Pitroue033e062010-10-29 10:38:18 +00002797
2798 def test_warn_on_dealloc_fd(self):
2799 self._check_warn_on_dealloc_fd("rb", buffering=0)
2800 self._check_warn_on_dealloc_fd("rb")
2801 self._check_warn_on_dealloc_fd("r")
2802
2803
Antoine Pitrou243757e2010-11-05 21:15:39 +00002804 def test_pickling(self):
2805 # Pickling file objects is forbidden
2806 for kwargs in [
2807 {"mode": "w"},
2808 {"mode": "wb"},
2809 {"mode": "wb", "buffering": 0},
2810 {"mode": "r"},
2811 {"mode": "rb"},
2812 {"mode": "rb", "buffering": 0},
2813 {"mode": "w+"},
2814 {"mode": "w+b"},
2815 {"mode": "w+b", "buffering": 0},
2816 ]:
2817 for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
2818 with self.open(support.TESTFN, **kwargs) as f:
2819 self.assertRaises(TypeError, pickle.dumps, f, protocol)
2820
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002821 @unittest.skipUnless(fcntl, 'fcntl required for this test')
2822 def test_nonblock_pipe_write_bigbuf(self):
2823 self._test_nonblock_pipe_write(16*1024)
2824
2825 @unittest.skipUnless(fcntl, 'fcntl required for this test')
2826 def test_nonblock_pipe_write_smallbuf(self):
2827 self._test_nonblock_pipe_write(1024)
2828
2829 def _set_non_blocking(self, fd):
2830 flags = fcntl.fcntl(fd, fcntl.F_GETFL)
2831 self.assertNotEqual(flags, -1)
2832 res = fcntl.fcntl(fd, fcntl.F_SETFL, flags | os.O_NONBLOCK)
2833 self.assertEqual(res, 0)
2834
2835 def _test_nonblock_pipe_write(self, bufsize):
2836 sent = []
2837 received = []
2838 r, w = os.pipe()
2839 self._set_non_blocking(r)
2840 self._set_non_blocking(w)
2841
2842 # To exercise all code paths in the C implementation we need
2843 # to play with buffer sizes. For instance, if we choose a
2844 # buffer size less than or equal to _PIPE_BUF (4096 on Linux)
2845 # then we will never get a partial write of the buffer.
2846 rf = self.open(r, mode='rb', closefd=True, buffering=bufsize)
2847 wf = self.open(w, mode='wb', closefd=True, buffering=bufsize)
2848
2849 with rf, wf:
2850 for N in 9999, 73, 7574:
2851 try:
2852 i = 0
2853 while True:
2854 msg = bytes([i % 26 + 97]) * N
2855 sent.append(msg)
2856 wf.write(msg)
2857 i += 1
2858
2859 except self.BlockingIOError as e:
2860 self.assertEqual(e.args[0], errno.EAGAIN)
Antoine Pitrou7fe601c2011-11-21 20:22:01 +01002861 self.assertEqual(e.args[2], e.characters_written)
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002862 sent[-1] = sent[-1][:e.characters_written]
2863 received.append(rf.read())
2864 msg = b'BLOCKED'
2865 wf.write(msg)
2866 sent.append(msg)
2867
2868 while True:
2869 try:
2870 wf.flush()
2871 break
2872 except self.BlockingIOError as e:
2873 self.assertEqual(e.args[0], errno.EAGAIN)
Antoine Pitrou7fe601c2011-11-21 20:22:01 +01002874 self.assertEqual(e.args[2], e.characters_written)
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002875 self.assertEqual(e.characters_written, 0)
2876 received.append(rf.read())
2877
2878 received += iter(rf.read, None)
2879
2880 sent, received = b''.join(sent), b''.join(received)
2881 self.assertTrue(sent == received)
2882 self.assertTrue(wf.closed)
2883 self.assertTrue(rf.closed)
2884
Charles-François Natalidc3044c2012-01-09 22:40:02 +01002885 def test_create_fail(self):
2886 # 'x' mode fails if file is existing
2887 with self.open(support.TESTFN, 'w'):
2888 pass
2889 self.assertRaises(FileExistsError, self.open, support.TESTFN, 'x')
2890
2891 def test_create_writes(self):
2892 # 'x' mode opens for writing
2893 with self.open(support.TESTFN, 'xb') as f:
2894 f.write(b"spam")
2895 with self.open(support.TESTFN, 'rb') as f:
2896 self.assertEqual(b"spam", f.read())
2897
Christian Heimes7b648752012-09-10 14:48:43 +02002898 def test_open_allargs(self):
2899 # there used to be a buffer overflow in the parser for rawmode
2900 self.assertRaises(ValueError, self.open, support.TESTFN, 'rwax+')
2901
2902
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002903class CMiscIOTest(MiscIOTest):
2904 io = io
2905
2906class PyMiscIOTest(MiscIOTest):
2907 io = pyio
Barry Warsaw40e82462008-11-20 20:14:50 +00002908
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002909
2910@unittest.skipIf(os.name == 'nt', 'POSIX signals required for this test.')
2911class SignalsTest(unittest.TestCase):
2912
2913 def setUp(self):
2914 self.oldalrm = signal.signal(signal.SIGALRM, self.alarm_interrupt)
2915
2916 def tearDown(self):
2917 signal.signal(signal.SIGALRM, self.oldalrm)
2918
2919 def alarm_interrupt(self, sig, frame):
2920 1/0
2921
2922 @unittest.skipUnless(threading, 'Threading required for this test.')
2923 def check_interrupted_write(self, item, bytes, **fdopen_kwargs):
2924 """Check that a partial write, when it gets interrupted, properly
Antoine Pitrou707ce822011-02-25 21:24:11 +00002925 invokes the signal handler, and bubbles up the exception raised
2926 in the latter."""
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002927 read_results = []
2928 def _read():
Victor Stinnera9293352011-04-30 15:21:58 +02002929 if hasattr(signal, 'pthread_sigmask'):
2930 signal.pthread_sigmask(signal.SIG_BLOCK, [signal.SIGALRM])
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002931 s = os.read(r, 1)
2932 read_results.append(s)
2933 t = threading.Thread(target=_read)
2934 t.daemon = True
2935 r, w = os.pipe()
Benjamin Petersond8fc2e12010-10-31 01:19:53 +00002936 fdopen_kwargs["closefd"] = False
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002937 try:
2938 wio = self.io.open(w, **fdopen_kwargs)
2939 t.start()
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07002940 signal.alarm(1)
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002941 # Fill the pipe enough that the write will be blocking.
2942 # It will be interrupted by the timer armed above. Since the
2943 # other thread has read one byte, the low-level write will
2944 # return with a successful (partial) result rather than an EINTR.
2945 # The buffered IO layer must check for pending signal
2946 # handlers, which in this case will invoke alarm_interrupt().
2947 self.assertRaises(ZeroDivisionError,
Charles-François Natali2d517212011-05-29 16:36:44 +02002948 wio.write, item * (support.PIPE_MAX_SIZE // len(item)))
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002949 t.join()
2950 # We got one byte, get another one and check that it isn't a
2951 # repeat of the first one.
2952 read_results.append(os.read(r, 1))
2953 self.assertEqual(read_results, [bytes[0:1], bytes[1:2]])
2954 finally:
2955 os.close(w)
2956 os.close(r)
2957 # This is deliberate. If we didn't close the file descriptor
2958 # before closing wio, wio would try to flush its internal
2959 # buffer, and block again.
2960 try:
2961 wio.close()
2962 except IOError as e:
2963 if e.errno != errno.EBADF:
2964 raise
2965
2966 def test_interrupted_write_unbuffered(self):
2967 self.check_interrupted_write(b"xy", b"xy", mode="wb", buffering=0)
2968
2969 def test_interrupted_write_buffered(self):
2970 self.check_interrupted_write(b"xy", b"xy", mode="wb")
2971
2972 def test_interrupted_write_text(self):
2973 self.check_interrupted_write("xy", b"xy", mode="w", encoding="ascii")
2974
Brett Cannon31f59292011-02-21 19:29:56 +00002975 @support.no_tracing
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002976 def check_reentrant_write(self, data, **fdopen_kwargs):
2977 def on_alarm(*args):
2978 # Will be called reentrantly from the same thread
2979 wio.write(data)
2980 1/0
2981 signal.signal(signal.SIGALRM, on_alarm)
2982 r, w = os.pipe()
2983 wio = self.io.open(w, **fdopen_kwargs)
2984 try:
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07002985 signal.alarm(1)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002986 # Either the reentrant call to wio.write() fails with RuntimeError,
2987 # or the signal handler raises ZeroDivisionError.
2988 with self.assertRaises((ZeroDivisionError, RuntimeError)) as cm:
2989 while 1:
2990 for i in range(100):
2991 wio.write(data)
2992 wio.flush()
2993 # Make sure the buffer doesn't fill up and block further writes
2994 os.read(r, len(data) * 100)
2995 exc = cm.exception
2996 if isinstance(exc, RuntimeError):
2997 self.assertTrue(str(exc).startswith("reentrant call"), str(exc))
2998 finally:
2999 wio.close()
3000 os.close(r)
3001
3002 def test_reentrant_write_buffered(self):
3003 self.check_reentrant_write(b"xy", mode="wb")
3004
3005 def test_reentrant_write_text(self):
3006 self.check_reentrant_write("xy", mode="w", encoding="ascii")
3007
Antoine Pitrou707ce822011-02-25 21:24:11 +00003008 def check_interrupted_read_retry(self, decode, **fdopen_kwargs):
3009 """Check that a buffered read, when it gets interrupted (either
3010 returning a partial result or EINTR), properly invokes the signal
3011 handler and retries if the latter returned successfully."""
3012 r, w = os.pipe()
3013 fdopen_kwargs["closefd"] = False
3014 def alarm_handler(sig, frame):
3015 os.write(w, b"bar")
3016 signal.signal(signal.SIGALRM, alarm_handler)
3017 try:
3018 rio = self.io.open(r, **fdopen_kwargs)
3019 os.write(w, b"foo")
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07003020 signal.alarm(1)
Antoine Pitrou707ce822011-02-25 21:24:11 +00003021 # Expected behaviour:
3022 # - first raw read() returns partial b"foo"
3023 # - second raw read() returns EINTR
3024 # - third raw read() returns b"bar"
3025 self.assertEqual(decode(rio.read(6)), "foobar")
3026 finally:
3027 rio.close()
3028 os.close(w)
3029 os.close(r)
3030
Antoine Pitrou20db5112011-08-19 20:32:34 +02003031 def test_interrupted_read_retry_buffered(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003032 self.check_interrupted_read_retry(lambda x: x.decode('latin1'),
3033 mode="rb")
3034
Antoine Pitrou20db5112011-08-19 20:32:34 +02003035 def test_interrupted_read_retry_text(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003036 self.check_interrupted_read_retry(lambda x: x,
3037 mode="r")
3038
3039 @unittest.skipUnless(threading, 'Threading required for this test.')
3040 def check_interrupted_write_retry(self, item, **fdopen_kwargs):
3041 """Check that a buffered write, when it gets interrupted (either
3042 returning a partial result or EINTR), properly invokes the signal
3043 handler and retries if the latter returned successfully."""
3044 select = support.import_module("select")
3045 # A quantity that exceeds the buffer size of an anonymous pipe's
3046 # write end.
3047 N = 1024 * 1024
3048 r, w = os.pipe()
3049 fdopen_kwargs["closefd"] = False
3050 # We need a separate thread to read from the pipe and allow the
3051 # write() to finish. This thread is started after the SIGALRM is
3052 # received (forcing a first EINTR in write()).
3053 read_results = []
3054 write_finished = False
3055 def _read():
3056 while not write_finished:
3057 while r in select.select([r], [], [], 1.0)[0]:
3058 s = os.read(r, 1024)
3059 read_results.append(s)
3060 t = threading.Thread(target=_read)
3061 t.daemon = True
3062 def alarm1(sig, frame):
3063 signal.signal(signal.SIGALRM, alarm2)
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07003064 signal.alarm(1)
Antoine Pitrou707ce822011-02-25 21:24:11 +00003065 def alarm2(sig, frame):
3066 t.start()
3067 signal.signal(signal.SIGALRM, alarm1)
3068 try:
3069 wio = self.io.open(w, **fdopen_kwargs)
Gregory P. Smithb5ba2032012-06-25 01:13:32 -07003070 signal.alarm(1)
Antoine Pitrou707ce822011-02-25 21:24:11 +00003071 # Expected behaviour:
3072 # - first raw write() is partial (because of the limited pipe buffer
3073 # and the first alarm)
3074 # - second raw write() returns EINTR (because of the second alarm)
3075 # - subsequent write()s are successful (either partial or complete)
3076 self.assertEqual(N, wio.write(item * N))
3077 wio.flush()
3078 write_finished = True
3079 t.join()
3080 self.assertEqual(N, sum(len(x) for x in read_results))
3081 finally:
3082 write_finished = True
3083 os.close(w)
3084 os.close(r)
3085 # This is deliberate. If we didn't close the file descriptor
3086 # before closing wio, wio would try to flush its internal
3087 # buffer, and could block (in case of failure).
3088 try:
3089 wio.close()
3090 except IOError as e:
3091 if e.errno != errno.EBADF:
3092 raise
3093
Antoine Pitrou20db5112011-08-19 20:32:34 +02003094 def test_interrupted_write_retry_buffered(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003095 self.check_interrupted_write_retry(b"x", mode="wb")
3096
Antoine Pitrou20db5112011-08-19 20:32:34 +02003097 def test_interrupted_write_retry_text(self):
Antoine Pitrou707ce822011-02-25 21:24:11 +00003098 self.check_interrupted_write_retry("x", mode="w", encoding="latin1")
3099
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00003100
Antoine Pitroub46b9d52010-08-21 19:09:32 +00003101class CSignalsTest(SignalsTest):
3102 io = io
3103
3104class PySignalsTest(SignalsTest):
3105 io = pyio
3106
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00003107 # Handling reentrancy issues would slow down _pyio even more, so the
3108 # tests are disabled.
3109 test_reentrant_write_buffered = None
3110 test_reentrant_write_text = None
3111
Antoine Pitroub46b9d52010-08-21 19:09:32 +00003112
Guido van Rossum28524c72007-02-27 05:47:44 +00003113def test_main():
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003114 tests = (CIOTest, PyIOTest,
3115 CBufferedReaderTest, PyBufferedReaderTest,
3116 CBufferedWriterTest, PyBufferedWriterTest,
3117 CBufferedRWPairTest, PyBufferedRWPairTest,
3118 CBufferedRandomTest, PyBufferedRandomTest,
3119 StatefulIncrementalDecoderTest,
3120 CIncrementalNewlineDecoderTest, PyIncrementalNewlineDecoderTest,
3121 CTextIOWrapperTest, PyTextIOWrapperTest,
Antoine Pitroub46b9d52010-08-21 19:09:32 +00003122 CMiscIOTest, PyMiscIOTest,
3123 CSignalsTest, PySignalsTest,
3124 )
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003125
3126 # Put the namespaces of the IO module we are testing and some useful mock
3127 # classes in the __dict__ of each test.
3128 mocks = (MockRawIO, MisbehavedRawIO, MockFileIO, CloseFailureIO,
Antoine Pitrou328ec742010-09-14 18:37:24 +00003129 MockNonBlockWriterIO, MockUnseekableIO, MockRawIOWithoutRead)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003130 all_members = io.__all__ + ["IncrementalNewlineDecoder"]
3131 c_io_ns = {name : getattr(io, name) for name in all_members}
3132 py_io_ns = {name : getattr(pyio, name) for name in all_members}
3133 globs = globals()
3134 c_io_ns.update((x.__name__, globs["C" + x.__name__]) for x in mocks)
3135 py_io_ns.update((x.__name__, globs["Py" + x.__name__]) for x in mocks)
3136 # Avoid turning open into a bound method.
3137 py_io_ns["open"] = pyio.OpenWrapper
3138 for test in tests:
3139 if test.__name__.startswith("C"):
3140 for name, obj in c_io_ns.items():
3141 setattr(test, name, obj)
3142 elif test.__name__.startswith("Py"):
3143 for name, obj in py_io_ns.items():
3144 setattr(test, name, obj)
3145
3146 support.run_unittest(*tests)
Guido van Rossum28524c72007-02-27 05:47:44 +00003147
3148if __name__ == "__main__":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00003149 test_main()