blob: 39fda2beea109e8045c2e8af44b6b5ac10a5a110 [file] [log] [blame]
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001"""Unit tests for the io module."""
2
3# Tests of io are scattered over the test suite:
4# * test_bufio - tests file buffering
5# * test_memoryio - tests BytesIO and StringIO
6# * test_fileio - tests FileIO
7# * test_file - tests the file interface
8# * test_io - tests everything else in the io module
9# * test_univnewlines - tests universal newline support
10# * test_largefile - tests operations on a file greater than 2**32 bytes
11# (only enabled with -ulargefile)
12
13################################################################################
14# ATTENTION TEST WRITERS!!!
15################################################################################
16# When writing tests for io, it's important to test both the C and Python
17# implementations. This is usually done by writing a base test that refers to
18# the type it is testing as a attribute. Then it provides custom subclasses to
19# test both implementations. This file has lots of examples.
20################################################################################
Guido van Rossum68bbcd22007-02-27 17:19:33 +000021
Guido van Rossum8358db22007-08-18 21:39:55 +000022import os
Guido van Rossum34d69e52007-04-10 20:08:41 +000023import sys
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +000024import time
Guido van Rossumd4103952007-04-12 05:44:49 +000025import array
Antoine Pitrou87695762008-08-14 22:44:29 +000026import random
Guido van Rossum28524c72007-02-27 05:47:44 +000027import unittest
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000028import weakref
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000029import abc
Antoine Pitroub46b9d52010-08-21 19:09:32 +000030import signal
31import errno
Antoine Pitroue033e062010-10-29 10:38:18 +000032import warnings
Antoine Pitrou243757e2010-11-05 21:15:39 +000033import pickle
Georg Brandl1b37e872010-03-14 10:45:50 +000034from itertools import cycle, count
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000035from collections import deque
Benjamin Petersonee8712c2008-05-20 21:35:26 +000036from test import support
Guido van Rossum76c5d4d2007-04-06 19:10:29 +000037
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +000038import codecs
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000039import io # C implementation of io
40import _pyio as pyio # Python implementation of io
Victor Stinner45df8202010-04-28 22:31:17 +000041try:
42 import threading
43except ImportError:
44 threading = None
Guido van Rossum28524c72007-02-27 05:47:44 +000045
Guido van Rossuma9e20242007-03-08 00:43:48 +000046
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000047def _default_chunk_size():
48 """Get the default TextIOWrapper chunk size"""
49 with open(__file__, "r", encoding="latin1") as f:
50 return f._CHUNK_SIZE
51
52
Antoine Pitrou328ec742010-09-14 18:37:24 +000053class MockRawIOWithoutRead:
54 """A RawIO implementation without read(), so as to exercise the default
55 RawIO.read() which calls readinto()."""
Guido van Rossuma9e20242007-03-08 00:43:48 +000056
Guido van Rossum76c5d4d2007-04-06 19:10:29 +000057 def __init__(self, read_stack=()):
58 self._read_stack = list(read_stack)
59 self._write_stack = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000060 self._reads = 0
Antoine Pitrou32cfede2010-08-11 13:31:33 +000061 self._extraneous_reads = 0
Guido van Rossum68bbcd22007-02-27 17:19:33 +000062
Guido van Rossum01a27522007-03-07 01:00:12 +000063 def write(self, b):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000064 self._write_stack.append(bytes(b))
Guido van Rossum01a27522007-03-07 01:00:12 +000065 return len(b)
66
67 def writable(self):
68 return True
69
Guido van Rossum68bbcd22007-02-27 17:19:33 +000070 def fileno(self):
71 return 42
72
73 def readable(self):
74 return True
75
Guido van Rossum01a27522007-03-07 01:00:12 +000076 def seekable(self):
Guido van Rossum68bbcd22007-02-27 17:19:33 +000077 return True
78
Guido van Rossum01a27522007-03-07 01:00:12 +000079 def seek(self, pos, whence):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000080 return 0 # wrong but we gotta return something
Guido van Rossum01a27522007-03-07 01:00:12 +000081
82 def tell(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000083 return 0 # same comment as above
84
85 def readinto(self, buf):
86 self._reads += 1
87 max_len = len(buf)
88 try:
89 data = self._read_stack[0]
90 except IndexError:
Antoine Pitrou32cfede2010-08-11 13:31:33 +000091 self._extraneous_reads += 1
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000092 return 0
93 if data is None:
94 del self._read_stack[0]
95 return None
96 n = len(data)
97 if len(data) <= max_len:
98 del self._read_stack[0]
99 buf[:n] = data
100 return n
101 else:
102 buf[:] = data[:max_len]
103 self._read_stack[0] = data[max_len:]
104 return max_len
105
106 def truncate(self, pos=None):
107 return pos
108
Antoine Pitrou328ec742010-09-14 18:37:24 +0000109class CMockRawIOWithoutRead(MockRawIOWithoutRead, io.RawIOBase):
110 pass
111
112class PyMockRawIOWithoutRead(MockRawIOWithoutRead, pyio.RawIOBase):
113 pass
114
115
116class MockRawIO(MockRawIOWithoutRead):
117
118 def read(self, n=None):
119 self._reads += 1
120 try:
121 return self._read_stack.pop(0)
122 except:
123 self._extraneous_reads += 1
124 return b""
125
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000126class CMockRawIO(MockRawIO, io.RawIOBase):
127 pass
128
129class PyMockRawIO(MockRawIO, pyio.RawIOBase):
130 pass
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000131
Guido van Rossuma9e20242007-03-08 00:43:48 +0000132
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000133class MisbehavedRawIO(MockRawIO):
134 def write(self, b):
135 return super().write(b) * 2
136
137 def read(self, n=None):
138 return super().read(n) * 2
139
140 def seek(self, pos, whence):
141 return -123
142
143 def tell(self):
144 return -456
145
146 def readinto(self, buf):
147 super().readinto(buf)
148 return len(buf) * 5
149
150class CMisbehavedRawIO(MisbehavedRawIO, io.RawIOBase):
151 pass
152
153class PyMisbehavedRawIO(MisbehavedRawIO, pyio.RawIOBase):
154 pass
155
156
157class CloseFailureIO(MockRawIO):
158 closed = 0
159
160 def close(self):
161 if not self.closed:
162 self.closed = 1
163 raise IOError
164
165class CCloseFailureIO(CloseFailureIO, io.RawIOBase):
166 pass
167
168class PyCloseFailureIO(CloseFailureIO, pyio.RawIOBase):
169 pass
170
171
172class MockFileIO:
Guido van Rossum78892e42007-04-06 17:31:18 +0000173
174 def __init__(self, data):
175 self.read_history = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000176 super().__init__(data)
Guido van Rossum78892e42007-04-06 17:31:18 +0000177
178 def read(self, n=None):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000179 res = super().read(n)
Guido van Rossum78892e42007-04-06 17:31:18 +0000180 self.read_history.append(None if res is None else len(res))
181 return res
182
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000183 def readinto(self, b):
184 res = super().readinto(b)
185 self.read_history.append(res)
186 return res
Guido van Rossum78892e42007-04-06 17:31:18 +0000187
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000188class CMockFileIO(MockFileIO, io.BytesIO):
189 pass
Guido van Rossuma9e20242007-03-08 00:43:48 +0000190
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000191class PyMockFileIO(MockFileIO, pyio.BytesIO):
192 pass
193
194
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000195class MockUnseekableIO:
196 def seekable(self):
197 return False
198
199 def seek(self, *args):
200 raise self.UnsupportedOperation("not seekable")
201
202 def tell(self, *args):
203 raise self.UnsupportedOperation("not seekable")
204
205class CMockUnseekableIO(MockUnseekableIO, io.BytesIO):
206 UnsupportedOperation = io.UnsupportedOperation
207
208class PyMockUnseekableIO(MockUnseekableIO, pyio.BytesIO):
209 UnsupportedOperation = pyio.UnsupportedOperation
210
211
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000212class MockNonBlockWriterIO:
213
214 def __init__(self):
Guido van Rossum01a27522007-03-07 01:00:12 +0000215 self._write_stack = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000216 self._blocker_char = None
Guido van Rossuma9e20242007-03-08 00:43:48 +0000217
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000218 def pop_written(self):
219 s = b"".join(self._write_stack)
220 self._write_stack[:] = []
221 return s
222
223 def block_on(self, char):
224 """Block when a given char is encountered."""
225 self._blocker_char = char
226
227 def readable(self):
228 return True
229
230 def seekable(self):
231 return True
Guido van Rossuma9e20242007-03-08 00:43:48 +0000232
Guido van Rossum01a27522007-03-07 01:00:12 +0000233 def writable(self):
234 return True
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000235
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000236 def write(self, b):
237 b = bytes(b)
238 n = -1
239 if self._blocker_char:
240 try:
241 n = b.index(self._blocker_char)
242 except ValueError:
243 pass
244 else:
245 self._blocker_char = None
246 self._write_stack.append(b[:n])
247 raise self.BlockingIOError(0, "test blocking", n)
248 self._write_stack.append(b)
249 return len(b)
250
251class CMockNonBlockWriterIO(MockNonBlockWriterIO, io.RawIOBase):
252 BlockingIOError = io.BlockingIOError
253
254class PyMockNonBlockWriterIO(MockNonBlockWriterIO, pyio.RawIOBase):
255 BlockingIOError = pyio.BlockingIOError
256
Guido van Rossuma9e20242007-03-08 00:43:48 +0000257
Guido van Rossum28524c72007-02-27 05:47:44 +0000258class IOTest(unittest.TestCase):
259
Neal Norwitze7789b12008-03-24 06:18:09 +0000260 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000261 support.unlink(support.TESTFN)
Neal Norwitze7789b12008-03-24 06:18:09 +0000262
Guido van Rossum4d0f5a42007-03-07 22:59:39 +0000263 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000264 support.unlink(support.TESTFN)
Guido van Rossum4d0f5a42007-03-07 22:59:39 +0000265
Guido van Rossum28524c72007-02-27 05:47:44 +0000266 def write_ops(self, f):
Guido van Rossum87429772007-04-10 21:06:59 +0000267 self.assertEqual(f.write(b"blah."), 5)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000268 f.truncate(0)
269 self.assertEqual(f.tell(), 5)
270 f.seek(0)
271
272 self.assertEqual(f.write(b"blah."), 5)
Guido van Rossum87429772007-04-10 21:06:59 +0000273 self.assertEqual(f.seek(0), 0)
274 self.assertEqual(f.write(b"Hello."), 6)
Guido van Rossum28524c72007-02-27 05:47:44 +0000275 self.assertEqual(f.tell(), 6)
Guido van Rossum87429772007-04-10 21:06:59 +0000276 self.assertEqual(f.seek(-1, 1), 5)
Guido van Rossum28524c72007-02-27 05:47:44 +0000277 self.assertEqual(f.tell(), 5)
Guido van Rossum254348e2007-11-21 19:29:53 +0000278 self.assertEqual(f.write(bytearray(b" world\n\n\n")), 9)
Guido van Rossum87429772007-04-10 21:06:59 +0000279 self.assertEqual(f.seek(0), 0)
Guido van Rossum2b08b382007-05-08 20:18:39 +0000280 self.assertEqual(f.write(b"h"), 1)
Guido van Rossum87429772007-04-10 21:06:59 +0000281 self.assertEqual(f.seek(-1, 2), 13)
282 self.assertEqual(f.tell(), 13)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000283
Guido van Rossum87429772007-04-10 21:06:59 +0000284 self.assertEqual(f.truncate(12), 12)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000285 self.assertEqual(f.tell(), 13)
Christian Heimes8e42a0a2007-11-08 18:04:45 +0000286 self.assertRaises(TypeError, f.seek, 0.0)
Guido van Rossum28524c72007-02-27 05:47:44 +0000287
Guido van Rossum9b76da62007-04-11 01:09:03 +0000288 def read_ops(self, f, buffered=False):
289 data = f.read(5)
290 self.assertEqual(data, b"hello")
Guido van Rossum254348e2007-11-21 19:29:53 +0000291 data = bytearray(data)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000292 self.assertEqual(f.readinto(data), 5)
293 self.assertEqual(data, b" worl")
294 self.assertEqual(f.readinto(data), 2)
295 self.assertEqual(len(data), 5)
296 self.assertEqual(data[:2], b"d\n")
297 self.assertEqual(f.seek(0), 0)
298 self.assertEqual(f.read(20), b"hello world\n")
299 self.assertEqual(f.read(1), b"")
Guido van Rossum254348e2007-11-21 19:29:53 +0000300 self.assertEqual(f.readinto(bytearray(b"x")), 0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000301 self.assertEqual(f.seek(-6, 2), 6)
302 self.assertEqual(f.read(5), b"world")
303 self.assertEqual(f.read(0), b"")
Guido van Rossum254348e2007-11-21 19:29:53 +0000304 self.assertEqual(f.readinto(bytearray()), 0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000305 self.assertEqual(f.seek(-6, 1), 5)
306 self.assertEqual(f.read(5), b" worl")
307 self.assertEqual(f.tell(), 10)
Christian Heimes8e42a0a2007-11-08 18:04:45 +0000308 self.assertRaises(TypeError, f.seek, 0.0)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000309 if buffered:
310 f.seek(0)
311 self.assertEqual(f.read(), b"hello world\n")
312 f.seek(6)
313 self.assertEqual(f.read(), b"world\n")
314 self.assertEqual(f.read(), b"")
315
Guido van Rossum34d69e52007-04-10 20:08:41 +0000316 LARGE = 2**31
317
Guido van Rossum53807da2007-04-10 19:01:47 +0000318 def large_file_ops(self, f):
319 assert f.readable()
320 assert f.writable()
Guido van Rossum34d69e52007-04-10 20:08:41 +0000321 self.assertEqual(f.seek(self.LARGE), self.LARGE)
322 self.assertEqual(f.tell(), self.LARGE)
Guido van Rossum53807da2007-04-10 19:01:47 +0000323 self.assertEqual(f.write(b"xxx"), 3)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000324 self.assertEqual(f.tell(), self.LARGE + 3)
325 self.assertEqual(f.seek(-1, 1), self.LARGE + 2)
Guido van Rossum87429772007-04-10 21:06:59 +0000326 self.assertEqual(f.truncate(), self.LARGE + 2)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000327 self.assertEqual(f.tell(), self.LARGE + 2)
328 self.assertEqual(f.seek(0, 2), self.LARGE + 2)
Guido van Rossum87429772007-04-10 21:06:59 +0000329 self.assertEqual(f.truncate(self.LARGE + 1), self.LARGE + 1)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +0000330 self.assertEqual(f.tell(), self.LARGE + 2)
Guido van Rossum34d69e52007-04-10 20:08:41 +0000331 self.assertEqual(f.seek(0, 2), self.LARGE + 1)
332 self.assertEqual(f.seek(-1, 2), self.LARGE)
Guido van Rossum53807da2007-04-10 19:01:47 +0000333 self.assertEqual(f.read(2), b"x")
334
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000335 def test_invalid_operations(self):
336 # Try writing on a file opened in read mode and vice-versa.
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000337 exc = self.UnsupportedOperation
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000338 for mode in ("w", "wb"):
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000339 with self.open(support.TESTFN, mode) as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000340 self.assertRaises(exc, fp.read)
341 self.assertRaises(exc, fp.readline)
342 with self.open(support.TESTFN, "wb", buffering=0) as fp:
343 self.assertRaises(exc, fp.read)
344 self.assertRaises(exc, fp.readline)
345 with self.open(support.TESTFN, "rb", buffering=0) as fp:
346 self.assertRaises(exc, fp.write, b"blah")
347 self.assertRaises(exc, fp.writelines, [b"blah\n"])
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000348 with self.open(support.TESTFN, "rb") as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000349 self.assertRaises(exc, fp.write, b"blah")
350 self.assertRaises(exc, fp.writelines, [b"blah\n"])
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000351 with self.open(support.TESTFN, "r") as fp:
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000352 self.assertRaises(exc, fp.write, "blah")
353 self.assertRaises(exc, fp.writelines, ["blah\n"])
354 # Non-zero seeking from current or end pos
355 self.assertRaises(exc, fp.seek, 1, self.SEEK_CUR)
356 self.assertRaises(exc, fp.seek, -1, self.SEEK_END)
Benjamin Peterson81971ea2009-05-14 22:01:31 +0000357
Guido van Rossum28524c72007-02-27 05:47:44 +0000358 def test_raw_file_io(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000359 with self.open(support.TESTFN, "wb", buffering=0) as f:
360 self.assertEqual(f.readable(), False)
361 self.assertEqual(f.writable(), True)
362 self.assertEqual(f.seekable(), True)
363 self.write_ops(f)
364 with self.open(support.TESTFN, "rb", buffering=0) as f:
365 self.assertEqual(f.readable(), True)
366 self.assertEqual(f.writable(), False)
367 self.assertEqual(f.seekable(), True)
368 self.read_ops(f)
Guido van Rossum28524c72007-02-27 05:47:44 +0000369
Guido van Rossum87429772007-04-10 21:06:59 +0000370 def test_buffered_file_io(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000371 with self.open(support.TESTFN, "wb") as f:
372 self.assertEqual(f.readable(), False)
373 self.assertEqual(f.writable(), True)
374 self.assertEqual(f.seekable(), True)
375 self.write_ops(f)
376 with self.open(support.TESTFN, "rb") as f:
377 self.assertEqual(f.readable(), True)
378 self.assertEqual(f.writable(), False)
379 self.assertEqual(f.seekable(), True)
380 self.read_ops(f, True)
Guido van Rossum87429772007-04-10 21:06:59 +0000381
Guido van Rossum48fc58a2007-06-07 23:45:37 +0000382 def test_readline(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000383 with self.open(support.TESTFN, "wb") as f:
384 f.write(b"abc\ndef\nxyzzy\nfoo\x00bar\nanother line")
385 with self.open(support.TESTFN, "rb") as f:
386 self.assertEqual(f.readline(), b"abc\n")
387 self.assertEqual(f.readline(10), b"def\n")
388 self.assertEqual(f.readline(2), b"xy")
389 self.assertEqual(f.readline(4), b"zzy\n")
390 self.assertEqual(f.readline(), b"foo\x00bar\n")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000391 self.assertEqual(f.readline(None), b"another line")
Benjamin Peterson45cec322009-04-24 23:14:50 +0000392 self.assertRaises(TypeError, f.readline, 5.3)
393 with self.open(support.TESTFN, "r") as f:
394 self.assertRaises(TypeError, f.readline, 5.3)
Guido van Rossum48fc58a2007-06-07 23:45:37 +0000395
Guido van Rossum28524c72007-02-27 05:47:44 +0000396 def test_raw_bytes_io(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000397 f = self.BytesIO()
Guido van Rossum28524c72007-02-27 05:47:44 +0000398 self.write_ops(f)
399 data = f.getvalue()
400 self.assertEqual(data, b"hello world\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000401 f = self.BytesIO(data)
Guido van Rossum9b76da62007-04-11 01:09:03 +0000402 self.read_ops(f, True)
Guido van Rossum28524c72007-02-27 05:47:44 +0000403
Guido van Rossum53807da2007-04-10 19:01:47 +0000404 def test_large_file_ops(self):
Guido van Rossum34d69e52007-04-10 20:08:41 +0000405 # On Windows and Mac OSX this test comsumes large resources; It takes
406 # a long time to build the >2GB file and takes >2GB of disk space
407 # therefore the resource must be enabled to run this test.
408 if sys.platform[:3] == 'win' or sys.platform == 'darwin':
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000409 if not support.is_resource_enabled("largefile"):
Guido van Rossum34d69e52007-04-10 20:08:41 +0000410 print("\nTesting large file ops skipped on %s." % sys.platform,
411 file=sys.stderr)
412 print("It requires %d bytes and a long time." % self.LARGE,
413 file=sys.stderr)
414 print("Use 'regrtest.py -u largefile test_io' to run it.",
415 file=sys.stderr)
416 return
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000417 with self.open(support.TESTFN, "w+b", 0) as f:
418 self.large_file_ops(f)
419 with self.open(support.TESTFN, "w+b") as f:
420 self.large_file_ops(f)
Guido van Rossum87429772007-04-10 21:06:59 +0000421
422 def test_with_open(self):
423 for bufsize in (0, 1, 100):
424 f = None
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000425 with self.open(support.TESTFN, "wb", bufsize) as f:
Guido van Rossum1f2ca562007-08-27 20:44:15 +0000426 f.write(b"xxx")
Guido van Rossum87429772007-04-10 21:06:59 +0000427 self.assertEqual(f.closed, True)
428 f = None
429 try:
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000430 with self.open(support.TESTFN, "wb", bufsize) as f:
Guido van Rossum87429772007-04-10 21:06:59 +0000431 1/0
432 except ZeroDivisionError:
433 self.assertEqual(f.closed, True)
434 else:
435 self.fail("1/0 didn't raise an exception")
436
Antoine Pitrou08838b62009-01-21 00:55:13 +0000437 # issue 5008
438 def test_append_mode_tell(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000439 with self.open(support.TESTFN, "wb") as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000440 f.write(b"xxx")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000441 with self.open(support.TESTFN, "ab", buffering=0) as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000442 self.assertEqual(f.tell(), 3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000443 with self.open(support.TESTFN, "ab") as f:
Antoine Pitrou08838b62009-01-21 00:55:13 +0000444 self.assertEqual(f.tell(), 3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000445 with self.open(support.TESTFN, "a") as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000446 self.assertTrue(f.tell() > 0)
Antoine Pitrou08838b62009-01-21 00:55:13 +0000447
Guido van Rossum87429772007-04-10 21:06:59 +0000448 def test_destructor(self):
449 record = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000450 class MyFileIO(self.FileIO):
Guido van Rossum87429772007-04-10 21:06:59 +0000451 def __del__(self):
452 record.append(1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000453 try:
454 f = super().__del__
455 except AttributeError:
456 pass
457 else:
458 f()
Guido van Rossum87429772007-04-10 21:06:59 +0000459 def close(self):
460 record.append(2)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000461 super().close()
Guido van Rossum87429772007-04-10 21:06:59 +0000462 def flush(self):
463 record.append(3)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000464 super().flush()
Brett Cannon5a9e91b2010-10-29 23:53:03 +0000465 with support.check_warnings(('', ResourceWarning)):
466 f = MyFileIO(support.TESTFN, "wb")
467 f.write(b"xxx")
468 del f
469 support.gc_collect()
470 self.assertEqual(record, [1, 2, 3])
471 with self.open(support.TESTFN, "rb") as f:
472 self.assertEqual(f.read(), b"xxx")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000473
474 def _check_base_destructor(self, base):
475 record = []
476 class MyIO(base):
477 def __init__(self):
478 # This exercises the availability of attributes on object
479 # destruction.
480 # (in the C version, close() is called by the tp_dealloc
481 # function, not by __del__)
482 self.on_del = 1
483 self.on_close = 2
484 self.on_flush = 3
485 def __del__(self):
486 record.append(self.on_del)
487 try:
488 f = super().__del__
489 except AttributeError:
490 pass
491 else:
492 f()
493 def close(self):
494 record.append(self.on_close)
495 super().close()
496 def flush(self):
497 record.append(self.on_flush)
498 super().flush()
499 f = MyIO()
Guido van Rossum87429772007-04-10 21:06:59 +0000500 del f
Benjamin Peterson24fb1d02009-04-24 23:26:21 +0000501 support.gc_collect()
Guido van Rossum87429772007-04-10 21:06:59 +0000502 self.assertEqual(record, [1, 2, 3])
503
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000504 def test_IOBase_destructor(self):
505 self._check_base_destructor(self.IOBase)
506
507 def test_RawIOBase_destructor(self):
508 self._check_base_destructor(self.RawIOBase)
509
510 def test_BufferedIOBase_destructor(self):
511 self._check_base_destructor(self.BufferedIOBase)
512
513 def test_TextIOBase_destructor(self):
514 self._check_base_destructor(self.TextIOBase)
515
Guido van Rossum87429772007-04-10 21:06:59 +0000516 def test_close_flushes(self):
Benjamin Peterson45cec322009-04-24 23:14:50 +0000517 with self.open(support.TESTFN, "wb") as f:
518 f.write(b"xxx")
519 with self.open(support.TESTFN, "rb") as f:
520 self.assertEqual(f.read(), b"xxx")
Guido van Rossuma9e20242007-03-08 00:43:48 +0000521
Guido van Rossumd4103952007-04-12 05:44:49 +0000522 def test_array_writes(self):
523 a = array.array('i', range(10))
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +0000524 n = len(a.tobytes())
Benjamin Peterson45cec322009-04-24 23:14:50 +0000525 with self.open(support.TESTFN, "wb", 0) as f:
526 self.assertEqual(f.write(a), n)
527 with self.open(support.TESTFN, "wb") as f:
528 self.assertEqual(f.write(a), n)
Guido van Rossumd4103952007-04-12 05:44:49 +0000529
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000530 def test_closefd(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000531 self.assertRaises(ValueError, self.open, support.TESTFN, 'w',
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000532 closefd=False)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000533
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000534 def test_read_closed(self):
535 with self.open(support.TESTFN, "w") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000536 f.write("egg\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000537 with self.open(support.TESTFN, "r") as f:
538 file = self.open(f.fileno(), "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000539 self.assertEqual(file.read(), "egg\n")
540 file.seek(0)
541 file.close()
542 self.assertRaises(ValueError, file.read)
543
544 def test_no_closefd_with_filename(self):
545 # can't use closefd in combination with a file name
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000546 self.assertRaises(ValueError, self.open, support.TESTFN, "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000547
548 def test_closefd_attr(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000549 with self.open(support.TESTFN, "wb") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000550 f.write(b"egg\n")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000551 with self.open(support.TESTFN, "r") as f:
Christian Heimesecc42a22008-11-05 19:30:32 +0000552 self.assertEqual(f.buffer.raw.closefd, True)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000553 file = self.open(f.fileno(), "r", closefd=False)
Christian Heimesecc42a22008-11-05 19:30:32 +0000554 self.assertEqual(file.buffer.raw.closefd, False)
555
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000556 def test_garbage_collection(self):
557 # FileIO objects are collected, and collecting them flushes
558 # all data to disk.
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +0000559 with support.check_warnings(('', ResourceWarning)):
560 f = self.FileIO(support.TESTFN, "wb")
561 f.write(b"abcxxx")
562 f.f = f
563 wr = weakref.ref(f)
564 del f
565 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000566 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000567 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000568 self.assertEqual(f.read(), b"abcxxx")
Christian Heimesecc42a22008-11-05 19:30:32 +0000569
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000570 def test_unbounded_file(self):
571 # Issue #1174606: reading from an unbounded stream such as /dev/zero.
572 zero = "/dev/zero"
573 if not os.path.exists(zero):
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000574 self.skipTest("{0} does not exist".format(zero))
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000575 if sys.maxsize > 0x7FFFFFFF:
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000576 self.skipTest("test can only run in a 32-bit address space")
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000577 if support.real_max_memuse < support._2G:
Antoine Pitrouc50cb8e2009-04-19 00:10:36 +0000578 self.skipTest("test requires at least 2GB of memory")
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000579 with self.open(zero, "rb", buffering=0) as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000580 self.assertRaises(OverflowError, f.read)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000581 with self.open(zero, "rb") as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000582 self.assertRaises(OverflowError, f.read)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000583 with self.open(zero, "r") as f:
Antoine Pitrou7d037a72009-03-29 18:55:12 +0000584 self.assertRaises(OverflowError, f.read)
585
Antoine Pitrou6be88762010-05-03 16:48:20 +0000586 def test_flush_error_on_close(self):
587 f = self.open(support.TESTFN, "wb", buffering=0)
588 def bad_flush():
589 raise IOError()
590 f.flush = bad_flush
591 self.assertRaises(IOError, f.close) # exception not swallowed
592
593 def test_multi_close(self):
594 f = self.open(support.TESTFN, "wb", buffering=0)
595 f.close()
596 f.close()
597 f.close()
598 self.assertRaises(ValueError, f.flush)
599
Antoine Pitrou328ec742010-09-14 18:37:24 +0000600 def test_RawIOBase_read(self):
601 # Exercise the default RawIOBase.read() implementation (which calls
602 # readinto() internally).
603 rawio = self.MockRawIOWithoutRead((b"abc", b"d", None, b"efg", None))
604 self.assertEqual(rawio.read(2), b"ab")
605 self.assertEqual(rawio.read(2), b"c")
606 self.assertEqual(rawio.read(2), b"d")
607 self.assertEqual(rawio.read(2), None)
608 self.assertEqual(rawio.read(2), b"ef")
609 self.assertEqual(rawio.read(2), b"g")
610 self.assertEqual(rawio.read(2), None)
611 self.assertEqual(rawio.read(2), b"")
612
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000613class CIOTest(IOTest):
Antoine Pitrou84f1b172011-07-12 21:57:15 +0200614
615 def test_IOBase_finalize(self):
616 # Issue #12149: segmentation fault on _PyIOBase_finalize when both a
617 # class which inherits IOBase and an object of this class are caught
618 # in a reference cycle and close() is already in the method cache.
619 class MyIO(self.IOBase):
620 def close(self):
621 pass
622
623 # create an instance to populate the method cache
624 MyIO()
625 obj = MyIO()
626 obj.obj = obj
627 wr = weakref.ref(obj)
628 del MyIO
629 del obj
630 support.gc_collect()
631 self.assertTrue(wr() is None, wr)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000632
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000633class PyIOTest(IOTest):
634 pass
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000635
Guido van Rossuma9e20242007-03-08 00:43:48 +0000636
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000637class CommonBufferedTests:
638 # Tests common to BufferedReader, BufferedWriter and BufferedRandom
639
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000640 def test_detach(self):
641 raw = self.MockRawIO()
642 buf = self.tp(raw)
643 self.assertIs(buf.detach(), raw)
644 self.assertRaises(ValueError, buf.detach)
645
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000646 def test_fileno(self):
647 rawio = self.MockRawIO()
648 bufio = self.tp(rawio)
649
Ezio Melottib3aedd42010-11-20 19:04:17 +0000650 self.assertEqual(42, bufio.fileno())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000651
652 def test_no_fileno(self):
653 # XXX will we always have fileno() function? If so, kill
654 # this test. Else, write it.
655 pass
656
657 def test_invalid_args(self):
658 rawio = self.MockRawIO()
659 bufio = self.tp(rawio)
660 # Invalid whence
661 self.assertRaises(ValueError, bufio.seek, 0, -1)
662 self.assertRaises(ValueError, bufio.seek, 0, 3)
663
664 def test_override_destructor(self):
665 tp = self.tp
666 record = []
667 class MyBufferedIO(tp):
668 def __del__(self):
669 record.append(1)
670 try:
671 f = super().__del__
672 except AttributeError:
673 pass
674 else:
675 f()
676 def close(self):
677 record.append(2)
678 super().close()
679 def flush(self):
680 record.append(3)
681 super().flush()
682 rawio = self.MockRawIO()
683 bufio = MyBufferedIO(rawio)
684 writable = bufio.writable()
685 del bufio
Benjamin Peterson24fb1d02009-04-24 23:26:21 +0000686 support.gc_collect()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000687 if writable:
688 self.assertEqual(record, [1, 2, 3])
689 else:
690 self.assertEqual(record, [1, 2])
691
692 def test_context_manager(self):
693 # Test usability as a context manager
694 rawio = self.MockRawIO()
695 bufio = self.tp(rawio)
696 def _with():
697 with bufio:
698 pass
699 _with()
700 # bufio should now be closed, and using it a second time should raise
701 # a ValueError.
702 self.assertRaises(ValueError, _with)
703
704 def test_error_through_destructor(self):
705 # Test that the exception state is not modified by a destructor,
706 # even if close() fails.
707 rawio = self.CloseFailureIO()
708 def f():
709 self.tp(rawio).xyzzy
710 with support.captured_output("stderr") as s:
711 self.assertRaises(AttributeError, f)
712 s = s.getvalue().strip()
713 if s:
714 # The destructor *may* have printed an unraisable error, check it
715 self.assertEqual(len(s.splitlines()), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000716 self.assertTrue(s.startswith("Exception IOError: "), s)
717 self.assertTrue(s.endswith(" ignored"), s)
Guido van Rossum78892e42007-04-06 17:31:18 +0000718
Antoine Pitrou716c4442009-05-23 19:04:03 +0000719 def test_repr(self):
720 raw = self.MockRawIO()
721 b = self.tp(raw)
722 clsname = "%s.%s" % (self.tp.__module__, self.tp.__name__)
723 self.assertEqual(repr(b), "<%s>" % clsname)
724 raw.name = "dummy"
725 self.assertEqual(repr(b), "<%s name='dummy'>" % clsname)
726 raw.name = b"dummy"
727 self.assertEqual(repr(b), "<%s name=b'dummy'>" % clsname)
728
Antoine Pitrou6be88762010-05-03 16:48:20 +0000729 def test_flush_error_on_close(self):
730 raw = self.MockRawIO()
731 def bad_flush():
732 raise IOError()
733 raw.flush = bad_flush
734 b = self.tp(raw)
735 self.assertRaises(IOError, b.close) # exception not swallowed
736
737 def test_multi_close(self):
738 raw = self.MockRawIO()
739 b = self.tp(raw)
740 b.close()
741 b.close()
742 b.close()
743 self.assertRaises(ValueError, b.flush)
744
Antoine Pitrou0d739d72010-09-05 23:01:12 +0000745 def test_unseekable(self):
746 bufio = self.tp(self.MockUnseekableIO(b"A" * 10))
747 self.assertRaises(self.UnsupportedOperation, bufio.tell)
748 self.assertRaises(self.UnsupportedOperation, bufio.seek, 0)
749
Antoine Pitrou7f8f4182010-12-21 21:20:59 +0000750 def test_readonly_attributes(self):
751 raw = self.MockRawIO()
752 buf = self.tp(raw)
753 x = self.MockRawIO()
754 with self.assertRaises(AttributeError):
755 buf.raw = x
756
Guido van Rossum78892e42007-04-06 17:31:18 +0000757
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000758class BufferedReaderTest(unittest.TestCase, CommonBufferedTests):
759 read_mode = "rb"
Guido van Rossum78892e42007-04-06 17:31:18 +0000760
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000761 def test_constructor(self):
762 rawio = self.MockRawIO([b"abc"])
763 bufio = self.tp(rawio)
764 bufio.__init__(rawio)
765 bufio.__init__(rawio, buffer_size=1024)
766 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000767 self.assertEqual(b"abc", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000768 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
769 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
770 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
771 rawio = self.MockRawIO([b"abc"])
772 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000773 self.assertEqual(b"abc", bufio.read())
Guido van Rossum78892e42007-04-06 17:31:18 +0000774
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000775 def test_read(self):
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000776 for arg in (None, 7):
777 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
778 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000779 self.assertEqual(b"abcdefg", bufio.read(arg))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000780 # Invalid args
781 self.assertRaises(ValueError, bufio.read, -2)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000782
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000783 def test_read1(self):
784 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
785 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000786 self.assertEqual(b"a", bufio.read(1))
787 self.assertEqual(b"b", bufio.read1(1))
788 self.assertEqual(rawio._reads, 1)
789 self.assertEqual(b"c", bufio.read1(100))
790 self.assertEqual(rawio._reads, 1)
791 self.assertEqual(b"d", bufio.read1(100))
792 self.assertEqual(rawio._reads, 2)
793 self.assertEqual(b"efg", bufio.read1(100))
794 self.assertEqual(rawio._reads, 3)
795 self.assertEqual(b"", bufio.read1(100))
796 self.assertEqual(rawio._reads, 4)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000797 # Invalid args
798 self.assertRaises(ValueError, bufio.read1, -1)
799
800 def test_readinto(self):
801 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
802 bufio = self.tp(rawio)
803 b = bytearray(2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000804 self.assertEqual(bufio.readinto(b), 2)
805 self.assertEqual(b, b"ab")
806 self.assertEqual(bufio.readinto(b), 2)
807 self.assertEqual(b, b"cd")
808 self.assertEqual(bufio.readinto(b), 2)
809 self.assertEqual(b, b"ef")
810 self.assertEqual(bufio.readinto(b), 1)
811 self.assertEqual(b, b"gf")
812 self.assertEqual(bufio.readinto(b), 0)
813 self.assertEqual(b, b"gf")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000814
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000815 def test_readlines(self):
816 def bufio():
817 rawio = self.MockRawIO((b"abc\n", b"d\n", b"ef"))
818 return self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000819 self.assertEqual(bufio().readlines(), [b"abc\n", b"d\n", b"ef"])
820 self.assertEqual(bufio().readlines(5), [b"abc\n", b"d\n"])
821 self.assertEqual(bufio().readlines(None), [b"abc\n", b"d\n", b"ef"])
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000822
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000823 def test_buffering(self):
Guido van Rossum78892e42007-04-06 17:31:18 +0000824 data = b"abcdefghi"
825 dlen = len(data)
826
827 tests = [
828 [ 100, [ 3, 1, 4, 8 ], [ dlen, 0 ] ],
829 [ 100, [ 3, 3, 3], [ dlen ] ],
830 [ 4, [ 1, 2, 4, 2 ], [ 4, 4, 1 ] ],
831 ]
832
833 for bufsize, buf_read_sizes, raw_read_sizes in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000834 rawio = self.MockFileIO(data)
835 bufio = self.tp(rawio, buffer_size=bufsize)
Guido van Rossum78892e42007-04-06 17:31:18 +0000836 pos = 0
837 for nbytes in buf_read_sizes:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000838 self.assertEqual(bufio.read(nbytes), data[pos:pos+nbytes])
Guido van Rossum78892e42007-04-06 17:31:18 +0000839 pos += nbytes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000840 # this is mildly implementation-dependent
Ezio Melottib3aedd42010-11-20 19:04:17 +0000841 self.assertEqual(rawio.read_history, raw_read_sizes)
Guido van Rossum78892e42007-04-06 17:31:18 +0000842
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000843 def test_read_non_blocking(self):
Guido van Rossum01a27522007-03-07 01:00:12 +0000844 # Inject some None's in there to simulate EWOULDBLOCK
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000845 rawio = self.MockRawIO((b"abc", b"d", None, b"efg", None, None, None))
846 bufio = self.tp(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000847 self.assertEqual(b"abcd", bufio.read(6))
848 self.assertEqual(b"e", bufio.read(1))
849 self.assertEqual(b"fg", bufio.read())
850 self.assertEqual(b"", bufio.peek(1))
Victor Stinnera80987f2011-05-25 22:47:16 +0200851 self.assertIsNone(bufio.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +0000852 self.assertEqual(b"", bufio.read())
Guido van Rossum01a27522007-03-07 01:00:12 +0000853
Victor Stinnera80987f2011-05-25 22:47:16 +0200854 rawio = self.MockRawIO((b"a", None, None))
855 self.assertEqual(b"a", rawio.readall())
856 self.assertIsNone(rawio.readall())
857
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000858 def test_read_past_eof(self):
859 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
860 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000861
Ezio Melottib3aedd42010-11-20 19:04:17 +0000862 self.assertEqual(b"abcdefg", bufio.read(9000))
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000863
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000864 def test_read_all(self):
865 rawio = self.MockRawIO((b"abc", b"d", b"efg"))
866 bufio = self.tp(rawio)
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000867
Ezio Melottib3aedd42010-11-20 19:04:17 +0000868 self.assertEqual(b"abcdefg", bufio.read())
Guido van Rossum68bbcd22007-02-27 17:19:33 +0000869
Victor Stinner45df8202010-04-28 22:31:17 +0000870 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +0000871 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000872 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +0000873 try:
874 # Write out many bytes with exactly the same number of 0's,
875 # 1's... 255's. This will help us check that concurrent reading
876 # doesn't duplicate or forget contents.
877 N = 1000
878 l = list(range(256)) * N
879 random.shuffle(l)
880 s = bytes(bytearray(l))
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000881 with self.open(support.TESTFN, "wb") as f:
Antoine Pitrou87695762008-08-14 22:44:29 +0000882 f.write(s)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +0000883 with self.open(support.TESTFN, self.read_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000884 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +0000885 errors = []
886 results = []
887 def f():
888 try:
889 # Intra-buffer read then buffer-flushing read
890 for n in cycle([1, 19]):
891 s = bufio.read(n)
892 if not s:
893 break
894 # list.append() is atomic
895 results.append(s)
896 except Exception as e:
897 errors.append(e)
898 raise
899 threads = [threading.Thread(target=f) for x in range(20)]
900 for t in threads:
901 t.start()
902 time.sleep(0.02) # yield
903 for t in threads:
904 t.join()
905 self.assertFalse(errors,
906 "the following exceptions were caught: %r" % errors)
907 s = b''.join(results)
908 for i in range(256):
909 c = bytes(bytearray([i]))
910 self.assertEqual(s.count(c), N)
911 finally:
912 support.unlink(support.TESTFN)
913
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000914 def test_misbehaved_io(self):
915 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
916 bufio = self.tp(rawio)
917 self.assertRaises(IOError, bufio.seek, 0)
918 self.assertRaises(IOError, bufio.tell)
919
Antoine Pitrou32cfede2010-08-11 13:31:33 +0000920 def test_no_extraneous_read(self):
921 # Issue #9550; when the raw IO object has satisfied the read request,
922 # we should not issue any additional reads, otherwise it may block
923 # (e.g. socket).
924 bufsize = 16
925 for n in (2, bufsize - 1, bufsize, bufsize + 1, bufsize * 2):
926 rawio = self.MockRawIO([b"x" * n])
927 bufio = self.tp(rawio, bufsize)
928 self.assertEqual(bufio.read(n), b"x" * n)
929 # Simple case: one raw read is enough to satisfy the request.
930 self.assertEqual(rawio._extraneous_reads, 0,
931 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
932 # A more complex case where two raw reads are needed to satisfy
933 # the request.
934 rawio = self.MockRawIO([b"x" * (n - 1), b"x"])
935 bufio = self.tp(rawio, bufsize)
936 self.assertEqual(bufio.read(n), b"x" * n)
937 self.assertEqual(rawio._extraneous_reads, 0,
938 "failed for {}: {} != 0".format(n, rawio._extraneous_reads))
939
940
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000941class CBufferedReaderTest(BufferedReaderTest):
942 tp = io.BufferedReader
943
944 def test_constructor(self):
945 BufferedReaderTest.test_constructor(self)
946 # The allocation can succeed on 32-bit builds, e.g. with more
947 # than 2GB RAM and a 64-bit kernel.
948 if sys.maxsize > 0x7FFFFFFF:
949 rawio = self.MockRawIO()
950 bufio = self.tp(rawio)
951 self.assertRaises((OverflowError, MemoryError, ValueError),
952 bufio.__init__, rawio, sys.maxsize)
953
954 def test_initialization(self):
955 rawio = self.MockRawIO([b"abc"])
956 bufio = self.tp(rawio)
957 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
958 self.assertRaises(ValueError, bufio.read)
959 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
960 self.assertRaises(ValueError, bufio.read)
961 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
962 self.assertRaises(ValueError, bufio.read)
963
964 def test_misbehaved_io_read(self):
965 rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg"))
966 bufio = self.tp(rawio)
967 # _pyio.BufferedReader seems to implement reading different, so that
968 # checking this is not so easy.
969 self.assertRaises(IOError, bufio.read, 10)
970
971 def test_garbage_collection(self):
972 # C BufferedReader objects are collected.
973 # The Python version has __del__, so it ends into gc.garbage instead
974 rawio = self.FileIO(support.TESTFN, "w+b")
975 f = self.tp(rawio)
976 f.f = f
977 wr = weakref.ref(f)
978 del f
Benjamin Peterson45cec322009-04-24 23:14:50 +0000979 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000980 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000981
982class PyBufferedReaderTest(BufferedReaderTest):
983 tp = pyio.BufferedReader
Antoine Pitrou87695762008-08-14 22:44:29 +0000984
Guido van Rossuma9e20242007-03-08 00:43:48 +0000985
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000986class BufferedWriterTest(unittest.TestCase, CommonBufferedTests):
987 write_mode = "wb"
Guido van Rossuma9e20242007-03-08 00:43:48 +0000988
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000989 def test_constructor(self):
990 rawio = self.MockRawIO()
991 bufio = self.tp(rawio)
992 bufio.__init__(rawio)
993 bufio.__init__(rawio, buffer_size=1024)
994 bufio.__init__(rawio, buffer_size=16)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000995 self.assertEqual(3, bufio.write(b"abc"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000996 bufio.flush()
997 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
998 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
999 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1000 bufio.__init__(rawio)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001001 self.assertEqual(3, bufio.write(b"ghi"))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001002 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001003 self.assertEqual(b"".join(rawio._write_stack), b"abcghi")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001004
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001005 def test_detach_flush(self):
1006 raw = self.MockRawIO()
1007 buf = self.tp(raw)
1008 buf.write(b"howdy!")
1009 self.assertFalse(raw._write_stack)
1010 buf.detach()
1011 self.assertEqual(raw._write_stack, [b"howdy!"])
1012
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001013 def test_write(self):
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001014 # Write to the buffered IO but don't overflow the buffer.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001015 writer = self.MockRawIO()
1016 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001017 bufio.write(b"abc")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001018 self.assertFalse(writer._write_stack)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001019
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001020 def test_write_overflow(self):
1021 writer = self.MockRawIO()
1022 bufio = self.tp(writer, 8)
1023 contents = b"abcdefghijklmnop"
1024 for n in range(0, len(contents), 3):
1025 bufio.write(contents[n:n+3])
1026 flushed = b"".join(writer._write_stack)
1027 # At least (total - 8) bytes were implicitly flushed, perhaps more
1028 # depending on the implementation.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001029 self.assertTrue(flushed.startswith(contents[:-8]), flushed)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001030
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001031 def check_writes(self, intermediate_func):
1032 # Lots of writes, test the flushed output is as expected.
1033 contents = bytes(range(256)) * 1000
1034 n = 0
1035 writer = self.MockRawIO()
1036 bufio = self.tp(writer, 13)
1037 # Generator of write sizes: repeat each N 15 times then proceed to N+1
1038 def gen_sizes():
1039 for size in count(1):
1040 for i in range(15):
1041 yield size
1042 sizes = gen_sizes()
1043 while n < len(contents):
1044 size = min(next(sizes), len(contents) - n)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001045 self.assertEqual(bufio.write(contents[n:n+size]), size)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001046 intermediate_func(bufio)
1047 n += size
1048 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001049 self.assertEqual(contents, b"".join(writer._write_stack))
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001050
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001051 def test_writes(self):
1052 self.check_writes(lambda bufio: None)
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001053
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001054 def test_writes_and_flushes(self):
1055 self.check_writes(lambda bufio: bufio.flush())
Guido van Rossum01a27522007-03-07 01:00:12 +00001056
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001057 def test_writes_and_seeks(self):
1058 def _seekabs(bufio):
1059 pos = bufio.tell()
1060 bufio.seek(pos + 1, 0)
1061 bufio.seek(pos - 1, 0)
1062 bufio.seek(pos, 0)
1063 self.check_writes(_seekabs)
1064 def _seekrel(bufio):
1065 pos = bufio.seek(0, 1)
1066 bufio.seek(+1, 1)
1067 bufio.seek(-1, 1)
1068 bufio.seek(pos, 0)
1069 self.check_writes(_seekrel)
Guido van Rossum01a27522007-03-07 01:00:12 +00001070
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001071 def test_writes_and_truncates(self):
1072 self.check_writes(lambda bufio: bufio.truncate(bufio.tell()))
Guido van Rossum01a27522007-03-07 01:00:12 +00001073
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001074 def test_write_non_blocking(self):
1075 raw = self.MockNonBlockWriterIO()
Benjamin Peterson59406a92009-03-26 17:10:29 +00001076 bufio = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001077
Ezio Melottib3aedd42010-11-20 19:04:17 +00001078 self.assertEqual(bufio.write(b"abcd"), 4)
1079 self.assertEqual(bufio.write(b"efghi"), 5)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001080 # 1 byte will be written, the rest will be buffered
1081 raw.block_on(b"k")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001082 self.assertEqual(bufio.write(b"jklmn"), 5)
Guido van Rossum01a27522007-03-07 01:00:12 +00001083
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001084 # 8 bytes will be written, 8 will be buffered and the rest will be lost
1085 raw.block_on(b"0")
1086 try:
1087 bufio.write(b"opqrwxyz0123456789")
1088 except self.BlockingIOError as e:
1089 written = e.characters_written
1090 else:
1091 self.fail("BlockingIOError should have been raised")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001092 self.assertEqual(written, 16)
1093 self.assertEqual(raw.pop_written(),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001094 b"abcdefghijklmnopqrwxyz")
Guido van Rossum01a27522007-03-07 01:00:12 +00001095
Ezio Melottib3aedd42010-11-20 19:04:17 +00001096 self.assertEqual(bufio.write(b"ABCDEFGHI"), 9)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001097 s = raw.pop_written()
1098 # Previously buffered bytes were flushed
1099 self.assertTrue(s.startswith(b"01234567A"), s)
Guido van Rossum01a27522007-03-07 01:00:12 +00001100
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001101 def test_write_and_rewind(self):
1102 raw = io.BytesIO()
1103 bufio = self.tp(raw, 4)
1104 self.assertEqual(bufio.write(b"abcdef"), 6)
1105 self.assertEqual(bufio.tell(), 6)
1106 bufio.seek(0, 0)
1107 self.assertEqual(bufio.write(b"XY"), 2)
1108 bufio.seek(6, 0)
1109 self.assertEqual(raw.getvalue(), b"XYcdef")
1110 self.assertEqual(bufio.write(b"123456"), 6)
1111 bufio.flush()
1112 self.assertEqual(raw.getvalue(), b"XYcdef123456")
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001113
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001114 def test_flush(self):
1115 writer = self.MockRawIO()
1116 bufio = self.tp(writer, 8)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001117 bufio.write(b"abc")
1118 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001119 self.assertEqual(b"abc", writer._write_stack[0])
Guido van Rossum68bbcd22007-02-27 17:19:33 +00001120
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001121 def test_destructor(self):
1122 writer = self.MockRawIO()
1123 bufio = self.tp(writer, 8)
1124 bufio.write(b"abc")
1125 del bufio
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001126 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001127 self.assertEqual(b"abc", writer._write_stack[0])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001128
1129 def test_truncate(self):
1130 # Truncate implicitly flushes the buffer.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001131 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001132 bufio = self.tp(raw, 8)
1133 bufio.write(b"abcdef")
1134 self.assertEqual(bufio.truncate(3), 3)
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001135 self.assertEqual(bufio.tell(), 6)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001136 with self.open(support.TESTFN, "rb", buffering=0) as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001137 self.assertEqual(f.read(), b"abc")
1138
Victor Stinner45df8202010-04-28 22:31:17 +00001139 @unittest.skipUnless(threading, 'Threading required for this test.')
Antoine Pitrou5bc4fa72010-10-14 15:34:31 +00001140 @support.requires_resource('cpu')
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001141 def test_threads(self):
Antoine Pitrou87695762008-08-14 22:44:29 +00001142 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001143 # Write out many bytes from many threads and test they were
1144 # all flushed.
1145 N = 1000
1146 contents = bytes(range(256)) * N
1147 sizes = cycle([1, 19])
1148 n = 0
1149 queue = deque()
1150 while n < len(contents):
1151 size = next(sizes)
1152 queue.append(contents[n:n+size])
1153 n += size
1154 del contents
Antoine Pitrou87695762008-08-14 22:44:29 +00001155 # We use a real file object because it allows us to
1156 # exercise situations where the GIL is released before
1157 # writing the buffer to the raw streams. This is in addition
1158 # to concurrency issues due to switching threads in the middle
1159 # of Python code.
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001160 with self.open(support.TESTFN, self.write_mode, buffering=0) as raw:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001161 bufio = self.tp(raw, 8)
Antoine Pitrou87695762008-08-14 22:44:29 +00001162 errors = []
1163 def f():
1164 try:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001165 while True:
1166 try:
1167 s = queue.popleft()
1168 except IndexError:
1169 return
Antoine Pitrou87695762008-08-14 22:44:29 +00001170 bufio.write(s)
1171 except Exception as e:
1172 errors.append(e)
1173 raise
1174 threads = [threading.Thread(target=f) for x in range(20)]
1175 for t in threads:
1176 t.start()
1177 time.sleep(0.02) # yield
1178 for t in threads:
1179 t.join()
1180 self.assertFalse(errors,
1181 "the following exceptions were caught: %r" % errors)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001182 bufio.close()
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001183 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001184 s = f.read()
1185 for i in range(256):
Ezio Melottib3aedd42010-11-20 19:04:17 +00001186 self.assertEqual(s.count(bytes([i])), N)
Antoine Pitrou87695762008-08-14 22:44:29 +00001187 finally:
1188 support.unlink(support.TESTFN)
1189
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001190 def test_misbehaved_io(self):
1191 rawio = self.MisbehavedRawIO()
1192 bufio = self.tp(rawio, 5)
1193 self.assertRaises(IOError, bufio.seek, 0)
1194 self.assertRaises(IOError, bufio.tell)
1195 self.assertRaises(IOError, bufio.write, b"abcdef")
1196
Benjamin Peterson59406a92009-03-26 17:10:29 +00001197 def test_max_buffer_size_deprecation(self):
Florent Xicluna8fbddf12010-03-17 20:29:51 +00001198 with support.check_warnings(("max_buffer_size is deprecated",
1199 DeprecationWarning)):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001200 self.tp(self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001201
1202
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001203class CBufferedWriterTest(BufferedWriterTest):
1204 tp = io.BufferedWriter
1205
1206 def test_constructor(self):
1207 BufferedWriterTest.test_constructor(self)
1208 # The allocation can succeed on 32-bit builds, e.g. with more
1209 # than 2GB RAM and a 64-bit kernel.
1210 if sys.maxsize > 0x7FFFFFFF:
1211 rawio = self.MockRawIO()
1212 bufio = self.tp(rawio)
1213 self.assertRaises((OverflowError, MemoryError, ValueError),
1214 bufio.__init__, rawio, sys.maxsize)
1215
1216 def test_initialization(self):
1217 rawio = self.MockRawIO()
1218 bufio = self.tp(rawio)
1219 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0)
1220 self.assertRaises(ValueError, bufio.write, b"def")
1221 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16)
1222 self.assertRaises(ValueError, bufio.write, b"def")
1223 self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1)
1224 self.assertRaises(ValueError, bufio.write, b"def")
1225
1226 def test_garbage_collection(self):
1227 # C BufferedWriter objects are collected, and collecting them flushes
1228 # all data to disk.
1229 # The Python version has __del__, so it ends into gc.garbage instead
1230 rawio = self.FileIO(support.TESTFN, "w+b")
1231 f = self.tp(rawio)
1232 f.write(b"123xxx")
1233 f.x = f
1234 wr = weakref.ref(f)
1235 del f
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001236 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001237 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00001238 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001239 self.assertEqual(f.read(), b"123xxx")
1240
1241
1242class PyBufferedWriterTest(BufferedWriterTest):
1243 tp = pyio.BufferedWriter
Guido van Rossuma9e20242007-03-08 00:43:48 +00001244
Guido van Rossum01a27522007-03-07 01:00:12 +00001245class BufferedRWPairTest(unittest.TestCase):
Guido van Rossuma9e20242007-03-08 00:43:48 +00001246
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001247 def test_constructor(self):
1248 pair = self.tp(self.MockRawIO(), self.MockRawIO())
Benjamin Peterson92035012008-12-27 16:00:54 +00001249 self.assertFalse(pair.closed)
Guido van Rossum01a27522007-03-07 01:00:12 +00001250
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001251 def test_detach(self):
1252 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1253 self.assertRaises(self.UnsupportedOperation, pair.detach)
1254
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001255 def test_constructor_max_buffer_size_deprecation(self):
Florent Xicluna8fbddf12010-03-17 20:29:51 +00001256 with support.check_warnings(("max_buffer_size is deprecated",
1257 DeprecationWarning)):
Benjamin Peterson59406a92009-03-26 17:10:29 +00001258 self.tp(self.MockRawIO(), self.MockRawIO(), 8, 12)
Benjamin Peterson59406a92009-03-26 17:10:29 +00001259
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001260 def test_constructor_with_not_readable(self):
1261 class NotReadable(MockRawIO):
1262 def readable(self):
1263 return False
1264
1265 self.assertRaises(IOError, self.tp, NotReadable(), self.MockRawIO())
1266
1267 def test_constructor_with_not_writeable(self):
1268 class NotWriteable(MockRawIO):
1269 def writable(self):
1270 return False
1271
1272 self.assertRaises(IOError, self.tp, self.MockRawIO(), NotWriteable())
1273
1274 def test_read(self):
1275 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1276
1277 self.assertEqual(pair.read(3), b"abc")
1278 self.assertEqual(pair.read(1), b"d")
1279 self.assertEqual(pair.read(), b"ef")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00001280 pair = self.tp(self.BytesIO(b"abc"), self.MockRawIO())
1281 self.assertEqual(pair.read(None), b"abc")
1282
1283 def test_readlines(self):
1284 pair = lambda: self.tp(self.BytesIO(b"abc\ndef\nh"), self.MockRawIO())
1285 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1286 self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"])
1287 self.assertEqual(pair().readlines(5), [b"abc\n", b"def\n"])
Antoine Pitroucf4c7492009-04-19 00:09:36 +00001288
1289 def test_read1(self):
1290 # .read1() is delegated to the underlying reader object, so this test
1291 # can be shallow.
1292 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1293
1294 self.assertEqual(pair.read1(3), b"abc")
1295
1296 def test_readinto(self):
1297 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1298
1299 data = bytearray(5)
1300 self.assertEqual(pair.readinto(data), 5)
1301 self.assertEqual(data, b"abcde")
1302
1303 def test_write(self):
1304 w = self.MockRawIO()
1305 pair = self.tp(self.MockRawIO(), w)
1306
1307 pair.write(b"abc")
1308 pair.flush()
1309 pair.write(b"def")
1310 pair.flush()
1311 self.assertEqual(w._write_stack, [b"abc", b"def"])
1312
1313 def test_peek(self):
1314 pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO())
1315
1316 self.assertTrue(pair.peek(3).startswith(b"abc"))
1317 self.assertEqual(pair.read(3), b"abc")
1318
1319 def test_readable(self):
1320 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1321 self.assertTrue(pair.readable())
1322
1323 def test_writeable(self):
1324 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1325 self.assertTrue(pair.writable())
1326
1327 def test_seekable(self):
1328 # BufferedRWPairs are never seekable, even if their readers and writers
1329 # are.
1330 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1331 self.assertFalse(pair.seekable())
1332
1333 # .flush() is delegated to the underlying writer object and has been
1334 # tested in the test_write method.
1335
1336 def test_close_and_closed(self):
1337 pair = self.tp(self.MockRawIO(), self.MockRawIO())
1338 self.assertFalse(pair.closed)
1339 pair.close()
1340 self.assertTrue(pair.closed)
1341
1342 def test_isatty(self):
1343 class SelectableIsAtty(MockRawIO):
1344 def __init__(self, isatty):
1345 MockRawIO.__init__(self)
1346 self._isatty = isatty
1347
1348 def isatty(self):
1349 return self._isatty
1350
1351 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(False))
1352 self.assertFalse(pair.isatty())
1353
1354 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(False))
1355 self.assertTrue(pair.isatty())
1356
1357 pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(True))
1358 self.assertTrue(pair.isatty())
1359
1360 pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(True))
1361 self.assertTrue(pair.isatty())
Guido van Rossum01a27522007-03-07 01:00:12 +00001362
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001363class CBufferedRWPairTest(BufferedRWPairTest):
1364 tp = io.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001365
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001366class PyBufferedRWPairTest(BufferedRWPairTest):
1367 tp = pyio.BufferedRWPair
Guido van Rossuma9e20242007-03-08 00:43:48 +00001368
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001369
1370class BufferedRandomTest(BufferedReaderTest, BufferedWriterTest):
1371 read_mode = "rb+"
1372 write_mode = "wb+"
1373
1374 def test_constructor(self):
1375 BufferedReaderTest.test_constructor(self)
1376 BufferedWriterTest.test_constructor(self)
1377
1378 def test_read_and_write(self):
1379 raw = self.MockRawIO((b"asdf", b"ghjk"))
Benjamin Peterson59406a92009-03-26 17:10:29 +00001380 rw = self.tp(raw, 8)
Guido van Rossum01a27522007-03-07 01:00:12 +00001381
1382 self.assertEqual(b"as", rw.read(2))
1383 rw.write(b"ddd")
1384 rw.write(b"eee")
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001385 self.assertFalse(raw._write_stack) # Buffer writes
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001386 self.assertEqual(b"ghjk", rw.read())
Ezio Melottib3aedd42010-11-20 19:04:17 +00001387 self.assertEqual(b"dddeee", raw._write_stack[0])
Guido van Rossum01a27522007-03-07 01:00:12 +00001388
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001389 def test_seek_and_tell(self):
1390 raw = self.BytesIO(b"asdfghjkl")
1391 rw = self.tp(raw)
Guido van Rossum01a27522007-03-07 01:00:12 +00001392
Ezio Melottib3aedd42010-11-20 19:04:17 +00001393 self.assertEqual(b"as", rw.read(2))
1394 self.assertEqual(2, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001395 rw.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001396 self.assertEqual(b"asdf", rw.read(4))
Guido van Rossum01a27522007-03-07 01:00:12 +00001397
1398 rw.write(b"asdf")
1399 rw.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001400 self.assertEqual(b"asdfasdfl", rw.read())
1401 self.assertEqual(9, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001402 rw.seek(-4, 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001403 self.assertEqual(5, rw.tell())
Guido van Rossum01a27522007-03-07 01:00:12 +00001404 rw.seek(2, 1)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001405 self.assertEqual(7, rw.tell())
1406 self.assertEqual(b"fl", rw.read(11))
Christian Heimes8e42a0a2007-11-08 18:04:45 +00001407 self.assertRaises(TypeError, rw.seek, 0.0)
Guido van Rossum01a27522007-03-07 01:00:12 +00001408
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001409 def check_flush_and_read(self, read_func):
1410 raw = self.BytesIO(b"abcdefghi")
1411 bufio = self.tp(raw)
1412
Ezio Melottib3aedd42010-11-20 19:04:17 +00001413 self.assertEqual(b"ab", read_func(bufio, 2))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001414 bufio.write(b"12")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001415 self.assertEqual(b"ef", read_func(bufio, 2))
1416 self.assertEqual(6, bufio.tell())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001417 bufio.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001418 self.assertEqual(6, bufio.tell())
1419 self.assertEqual(b"ghi", read_func(bufio))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001420 raw.seek(0, 0)
1421 raw.write(b"XYZ")
1422 # flush() resets the read buffer
1423 bufio.flush()
1424 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001425 self.assertEqual(b"XYZ", read_func(bufio, 3))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001426
1427 def test_flush_and_read(self):
1428 self.check_flush_and_read(lambda bufio, *args: bufio.read(*args))
1429
1430 def test_flush_and_readinto(self):
1431 def _readinto(bufio, n=-1):
1432 b = bytearray(n if n >= 0 else 9999)
1433 n = bufio.readinto(b)
1434 return bytes(b[:n])
1435 self.check_flush_and_read(_readinto)
1436
1437 def test_flush_and_peek(self):
1438 def _peek(bufio, n=-1):
1439 # This relies on the fact that the buffer can contain the whole
1440 # raw stream, otherwise peek() can return less.
1441 b = bufio.peek(n)
1442 if n != -1:
1443 b = b[:n]
1444 bufio.seek(len(b), 1)
1445 return b
1446 self.check_flush_and_read(_peek)
1447
1448 def test_flush_and_write(self):
1449 raw = self.BytesIO(b"abcdefghi")
1450 bufio = self.tp(raw)
1451
1452 bufio.write(b"123")
1453 bufio.flush()
1454 bufio.write(b"45")
1455 bufio.flush()
1456 bufio.seek(0, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001457 self.assertEqual(b"12345fghi", raw.getvalue())
1458 self.assertEqual(b"12345fghi", bufio.read())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001459
1460 def test_threads(self):
1461 BufferedReaderTest.test_threads(self)
1462 BufferedWriterTest.test_threads(self)
1463
1464 def test_writes_and_peek(self):
1465 def _peek(bufio):
1466 bufio.peek(1)
1467 self.check_writes(_peek)
1468 def _peek(bufio):
1469 pos = bufio.tell()
1470 bufio.seek(-1, 1)
1471 bufio.peek(1)
1472 bufio.seek(pos, 0)
1473 self.check_writes(_peek)
1474
1475 def test_writes_and_reads(self):
1476 def _read(bufio):
1477 bufio.seek(-1, 1)
1478 bufio.read(1)
1479 self.check_writes(_read)
1480
1481 def test_writes_and_read1s(self):
1482 def _read1(bufio):
1483 bufio.seek(-1, 1)
1484 bufio.read1(1)
1485 self.check_writes(_read1)
1486
1487 def test_writes_and_readintos(self):
1488 def _read(bufio):
1489 bufio.seek(-1, 1)
1490 bufio.readinto(bytearray(1))
1491 self.check_writes(_read)
1492
Antoine Pitroua0ceb732009-08-06 20:29:56 +00001493 def test_write_after_readahead(self):
1494 # Issue #6629: writing after the buffer was filled by readahead should
1495 # first rewind the raw stream.
1496 for overwrite_size in [1, 5]:
1497 raw = self.BytesIO(b"A" * 10)
1498 bufio = self.tp(raw, 4)
1499 # Trigger readahead
1500 self.assertEqual(bufio.read(1), b"A")
1501 self.assertEqual(bufio.tell(), 1)
1502 # Overwriting should rewind the raw stream if it needs so
1503 bufio.write(b"B" * overwrite_size)
1504 self.assertEqual(bufio.tell(), overwrite_size + 1)
1505 # If the write size was smaller than the buffer size, flush() and
1506 # check that rewind happens.
1507 bufio.flush()
1508 self.assertEqual(bufio.tell(), overwrite_size + 1)
1509 s = raw.getvalue()
1510 self.assertEqual(s,
1511 b"A" + b"B" * overwrite_size + b"A" * (9 - overwrite_size))
1512
Antoine Pitrou7c404892011-05-13 00:13:33 +02001513 def test_write_rewind_write(self):
1514 # Various combinations of reading / writing / seeking backwards / writing again
1515 def mutate(bufio, pos1, pos2):
1516 assert pos2 >= pos1
1517 # Fill the buffer
1518 bufio.seek(pos1)
1519 bufio.read(pos2 - pos1)
1520 bufio.write(b'\x02')
1521 # This writes earlier than the previous write, but still inside
1522 # the buffer.
1523 bufio.seek(pos1)
1524 bufio.write(b'\x01')
1525
1526 b = b"\x80\x81\x82\x83\x84"
1527 for i in range(0, len(b)):
1528 for j in range(i, len(b)):
1529 raw = self.BytesIO(b)
1530 bufio = self.tp(raw, 100)
1531 mutate(bufio, i, j)
1532 bufio.flush()
1533 expected = bytearray(b)
1534 expected[j] = 2
1535 expected[i] = 1
1536 self.assertEqual(raw.getvalue(), expected,
1537 "failed result for i=%d, j=%d" % (i, j))
1538
Antoine Pitrou905a2ff2010-01-31 22:47:27 +00001539 def test_truncate_after_read_or_write(self):
1540 raw = self.BytesIO(b"A" * 10)
1541 bufio = self.tp(raw, 100)
1542 self.assertEqual(bufio.read(2), b"AA") # the read buffer gets filled
1543 self.assertEqual(bufio.truncate(), 2)
1544 self.assertEqual(bufio.write(b"BB"), 2) # the write buffer increases
1545 self.assertEqual(bufio.truncate(), 4)
1546
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001547 def test_misbehaved_io(self):
1548 BufferedReaderTest.test_misbehaved_io(self)
1549 BufferedWriterTest.test_misbehaved_io(self)
1550
Antoine Pitrou0d739d72010-09-05 23:01:12 +00001551 # You can't construct a BufferedRandom over a non-seekable stream.
1552 test_unseekable = None
1553
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001554class CBufferedRandomTest(BufferedRandomTest):
1555 tp = io.BufferedRandom
1556
1557 def test_constructor(self):
1558 BufferedRandomTest.test_constructor(self)
1559 # The allocation can succeed on 32-bit builds, e.g. with more
1560 # than 2GB RAM and a 64-bit kernel.
1561 if sys.maxsize > 0x7FFFFFFF:
1562 rawio = self.MockRawIO()
1563 bufio = self.tp(rawio)
1564 self.assertRaises((OverflowError, MemoryError, ValueError),
1565 bufio.__init__, rawio, sys.maxsize)
1566
1567 def test_garbage_collection(self):
1568 CBufferedReaderTest.test_garbage_collection(self)
1569 CBufferedWriterTest.test_garbage_collection(self)
1570
1571class PyBufferedRandomTest(BufferedRandomTest):
1572 tp = pyio.BufferedRandom
1573
1574
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001575# To fully exercise seek/tell, the StatefulIncrementalDecoder has these
1576# properties:
1577# - A single output character can correspond to many bytes of input.
1578# - The number of input bytes to complete the character can be
1579# undetermined until the last input byte is received.
1580# - The number of input bytes can vary depending on previous input.
1581# - A single input byte can correspond to many characters of output.
1582# - The number of output characters can be undetermined until the
1583# last input byte is received.
1584# - The number of output characters can vary depending on previous input.
1585
1586class StatefulIncrementalDecoder(codecs.IncrementalDecoder):
1587 """
1588 For testing seek/tell behavior with a stateful, buffering decoder.
1589
1590 Input is a sequence of words. Words may be fixed-length (length set
1591 by input) or variable-length (period-terminated). In variable-length
1592 mode, extra periods are ignored. Possible words are:
1593 - 'i' followed by a number sets the input length, I (maximum 99).
1594 When I is set to 0, words are space-terminated.
1595 - 'o' followed by a number sets the output length, O (maximum 99).
1596 - Any other word is converted into a word followed by a period on
1597 the output. The output word consists of the input word truncated
1598 or padded out with hyphens to make its length equal to O. If O
1599 is 0, the word is output verbatim without truncating or padding.
1600 I and O are initially set to 1. When I changes, any buffered input is
1601 re-scanned according to the new I. EOF also terminates the last word.
1602 """
1603
1604 def __init__(self, errors='strict'):
Christian Heimesab568872008-03-23 02:11:13 +00001605 codecs.IncrementalDecoder.__init__(self, errors)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001606 self.reset()
1607
1608 def __repr__(self):
1609 return '<SID %x>' % id(self)
1610
1611 def reset(self):
1612 self.i = 1
1613 self.o = 1
1614 self.buffer = bytearray()
1615
1616 def getstate(self):
1617 i, o = self.i ^ 1, self.o ^ 1 # so that flags = 0 after reset()
1618 return bytes(self.buffer), i*100 + o
1619
1620 def setstate(self, state):
1621 buffer, io = state
1622 self.buffer = bytearray(buffer)
1623 i, o = divmod(io, 100)
1624 self.i, self.o = i ^ 1, o ^ 1
1625
1626 def decode(self, input, final=False):
1627 output = ''
1628 for b in input:
1629 if self.i == 0: # variable-length, terminated with period
1630 if b == ord('.'):
1631 if self.buffer:
1632 output += self.process_word()
1633 else:
1634 self.buffer.append(b)
1635 else: # fixed-length, terminate after self.i bytes
1636 self.buffer.append(b)
1637 if len(self.buffer) == self.i:
1638 output += self.process_word()
1639 if final and self.buffer: # EOF terminates the last word
1640 output += self.process_word()
1641 return output
1642
1643 def process_word(self):
1644 output = ''
1645 if self.buffer[0] == ord('i'):
1646 self.i = min(99, int(self.buffer[1:] or 0)) # set input length
1647 elif self.buffer[0] == ord('o'):
1648 self.o = min(99, int(self.buffer[1:] or 0)) # set output length
1649 else:
1650 output = self.buffer.decode('ascii')
1651 if len(output) < self.o:
1652 output += '-'*self.o # pad out with hyphens
1653 if self.o:
1654 output = output[:self.o] # truncate to output length
1655 output += '.'
1656 self.buffer = bytearray()
1657 return output
1658
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001659 codecEnabled = False
1660
1661 @classmethod
1662 def lookupTestDecoder(cls, name):
1663 if cls.codecEnabled and name == 'test_decoder':
Antoine Pitrou180a3362008-12-14 16:36:46 +00001664 latin1 = codecs.lookup('latin-1')
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001665 return codecs.CodecInfo(
Antoine Pitrou180a3362008-12-14 16:36:46 +00001666 name='test_decoder', encode=latin1.encode, decode=None,
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00001667 incrementalencoder=None,
1668 streamreader=None, streamwriter=None,
1669 incrementaldecoder=cls)
1670
1671# Register the previous decoder for testing.
1672# Disabled by default, tests will enable it.
1673codecs.register(StatefulIncrementalDecoder.lookupTestDecoder)
1674
1675
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001676class StatefulIncrementalDecoderTest(unittest.TestCase):
1677 """
1678 Make sure the StatefulIncrementalDecoder actually works.
1679 """
1680
1681 test_cases = [
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001682 # I=1, O=1 (fixed-length input == fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001683 (b'abcd', False, 'a.b.c.d.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001684 # I=0, O=0 (variable-length input, variable-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001685 (b'oiabcd', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001686 # I=0, O=0 (should ignore extra periods)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001687 (b'oi...abcd...', True, 'abcd.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001688 # I=0, O=6 (variable-length input, fixed-length output)
1689 (b'i.o6.x.xyz.toolongtofit.', False, 'x-----.xyz---.toolon.'),
1690 # I=2, O=6 (fixed-length input < fixed-length output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001691 (b'i.i2.o6xyz', True, 'xy----.z-----.'),
Ka-Ping Yeed24a5b62008-03-20 10:51:27 +00001692 # I=6, O=3 (fixed-length input > fixed-length output)
1693 (b'i.o3.i6.abcdefghijklmnop', True, 'abc.ghi.mno.'),
1694 # I=0, then 3; O=29, then 15 (with longer output)
1695 (b'i.o29.a.b.cde.o15.abcdefghijabcdefghij.i3.a.b.c.d.ei00k.l.m', True,
1696 'a----------------------------.' +
1697 'b----------------------------.' +
1698 'cde--------------------------.' +
1699 'abcdefghijabcde.' +
1700 'a.b------------.' +
1701 '.c.------------.' +
1702 'd.e------------.' +
1703 'k--------------.' +
1704 'l--------------.' +
1705 'm--------------.')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001706 ]
1707
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001708 def test_decoder(self):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001709 # Try a few one-shot test cases.
1710 for input, eof, output in self.test_cases:
1711 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001712 self.assertEqual(d.decode(input, eof), output)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00001713
1714 # Also test an unfinished decode, followed by forcing EOF.
1715 d = StatefulIncrementalDecoder()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001716 self.assertEqual(d.decode(b'oiabcd'), '')
1717 self.assertEqual(d.decode(b'', 1), 'abcd.')
Guido van Rossum78892e42007-04-06 17:31:18 +00001718
1719class TextIOWrapperTest(unittest.TestCase):
Guido van Rossum9b76da62007-04-11 01:09:03 +00001720
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001721 def setUp(self):
1722 self.testdata = b"AAA\r\nBBB\rCCC\r\nDDD\nEEE\r\n"
1723 self.normalized = b"AAA\nBBB\nCCC\nDDD\nEEE\n".decode("ascii")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001724 support.unlink(support.TESTFN)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001725
Guido van Rossumd0712812007-04-11 16:32:43 +00001726 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001727 support.unlink(support.TESTFN)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001728
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001729 def test_constructor(self):
1730 r = self.BytesIO(b"\xc3\xa9\n\n")
1731 b = self.BufferedReader(r, 1000)
1732 t = self.TextIOWrapper(b)
1733 t.__init__(b, encoding="latin1", newline="\r\n")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001734 self.assertEqual(t.encoding, "latin1")
1735 self.assertEqual(t.line_buffering, False)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001736 t.__init__(b, encoding="utf8", line_buffering=True)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001737 self.assertEqual(t.encoding, "utf8")
1738 self.assertEqual(t.line_buffering, True)
1739 self.assertEqual("\xe9\n", t.readline())
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001740 self.assertRaises(TypeError, t.__init__, b, newline=42)
1741 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
1742
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001743 def test_detach(self):
1744 r = self.BytesIO()
1745 b = self.BufferedWriter(r)
1746 t = self.TextIOWrapper(b)
1747 self.assertIs(t.detach(), b)
1748
1749 t = self.TextIOWrapper(b, encoding="ascii")
1750 t.write("howdy")
1751 self.assertFalse(r.getvalue())
1752 t.detach()
1753 self.assertEqual(r.getvalue(), b"howdy")
1754 self.assertRaises(ValueError, t.detach)
1755
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001756 def test_repr(self):
1757 raw = self.BytesIO("hello".encode("utf-8"))
1758 b = self.BufferedReader(raw)
1759 t = self.TextIOWrapper(b, encoding="utf-8")
Antoine Pitrou716c4442009-05-23 19:04:03 +00001760 modname = self.TextIOWrapper.__module__
1761 self.assertEqual(repr(t),
1762 "<%s.TextIOWrapper encoding='utf-8'>" % modname)
1763 raw.name = "dummy"
1764 self.assertEqual(repr(t),
1765 "<%s.TextIOWrapper name='dummy' encoding='utf-8'>" % modname)
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001766 t.mode = "r"
1767 self.assertEqual(repr(t),
1768 "<%s.TextIOWrapper name='dummy' mode='r' encoding='utf-8'>" % modname)
Antoine Pitrou716c4442009-05-23 19:04:03 +00001769 raw.name = b"dummy"
1770 self.assertEqual(repr(t),
Antoine Pitroua4815ca2011-01-09 20:38:15 +00001771 "<%s.TextIOWrapper name=b'dummy' mode='r' encoding='utf-8'>" % modname)
Benjamin Petersonc4c0eae2009-03-09 00:07:03 +00001772
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001773 def test_line_buffering(self):
1774 r = self.BytesIO()
1775 b = self.BufferedWriter(r, 1000)
1776 t = self.TextIOWrapper(b, newline="\n", line_buffering=True)
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001777 t.write("X")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001778 self.assertEqual(r.getvalue(), b"") # No flush happened
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001779 t.write("Y\nZ")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001780 self.assertEqual(r.getvalue(), b"XY\nZ") # All got flushed
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001781 t.write("A\rB")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001782 self.assertEqual(r.getvalue(), b"XY\nZA\rB")
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001783
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001784 def test_encoding(self):
1785 # Check the encoding attribute is always set, and valid
1786 b = self.BytesIO()
1787 t = self.TextIOWrapper(b, encoding="utf8")
1788 self.assertEqual(t.encoding, "utf8")
1789 t = self.TextIOWrapper(b)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001790 self.assertTrue(t.encoding is not None)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001791 codecs.lookup(t.encoding)
1792
1793 def test_encoding_errors_reading(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001794 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001795 b = self.BytesIO(b"abc\n\xff\n")
1796 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001797 self.assertRaises(UnicodeError, t.read)
1798 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001799 b = self.BytesIO(b"abc\n\xff\n")
1800 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001801 self.assertRaises(UnicodeError, t.read)
1802 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001803 b = self.BytesIO(b"abc\n\xff\n")
1804 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001805 self.assertEqual(t.read(), "abc\n\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001806 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001807 b = self.BytesIO(b"abc\n\xff\n")
1808 t = self.TextIOWrapper(b, encoding="ascii", errors="replace")
Ezio Melottib3aedd42010-11-20 19:04:17 +00001809 self.assertEqual(t.read(), "abc\n\ufffd\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001810
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001811 def test_encoding_errors_writing(self):
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001812 # (1) default
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001813 b = self.BytesIO()
1814 t = self.TextIOWrapper(b, encoding="ascii")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001815 self.assertRaises(UnicodeError, t.write, "\xff")
1816 # (2) explicit strict
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001817 b = self.BytesIO()
1818 t = self.TextIOWrapper(b, encoding="ascii", errors="strict")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001819 self.assertRaises(UnicodeError, t.write, "\xff")
1820 # (3) ignore
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001821 b = self.BytesIO()
1822 t = self.TextIOWrapper(b, encoding="ascii", errors="ignore",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001823 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001824 t.write("abc\xffdef\n")
1825 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001826 self.assertEqual(b.getvalue(), b"abcdef\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001827 # (4) replace
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001828 b = self.BytesIO()
1829 t = self.TextIOWrapper(b, encoding="ascii", errors="replace",
Guido van Rossumf64db9f2007-12-06 01:04:26 +00001830 newline="\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001831 t.write("abc\xffdef\n")
1832 t.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001833 self.assertEqual(b.getvalue(), b"abc?def\n")
Guido van Rossume7fc50f2007-12-03 22:54:21 +00001834
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001835 def test_newlines(self):
Guido van Rossum78892e42007-04-06 17:31:18 +00001836 input_lines = [ "unix\n", "windows\r\n", "os9\r", "last\n", "nonl" ]
1837
1838 tests = [
1839 [ None, [ 'unix\n', 'windows\n', 'os9\n', 'last\n', 'nonl' ] ],
Guido van Rossum8358db22007-08-18 21:39:55 +00001840 [ '', input_lines ],
1841 [ '\n', [ "unix\n", "windows\r\n", "os9\rlast\n", "nonl" ] ],
1842 [ '\r\n', [ "unix\nwindows\r\n", "os9\rlast\nnonl" ] ],
1843 [ '\r', [ "unix\nwindows\r", "\nos9\r", "last\nnonl" ] ],
Guido van Rossum78892e42007-04-06 17:31:18 +00001844 ]
Antoine Pitrou180a3362008-12-14 16:36:46 +00001845 encodings = (
1846 'utf-8', 'latin-1',
1847 'utf-16', 'utf-16-le', 'utf-16-be',
1848 'utf-32', 'utf-32-le', 'utf-32-be',
1849 )
Guido van Rossum78892e42007-04-06 17:31:18 +00001850
Guido van Rossum8358db22007-08-18 21:39:55 +00001851 # Try a range of buffer sizes to test the case where \r is the last
Guido van Rossum78892e42007-04-06 17:31:18 +00001852 # character in TextIOWrapper._pending_line.
1853 for encoding in encodings:
Guido van Rossum8358db22007-08-18 21:39:55 +00001854 # XXX: str.encode() should return bytes
1855 data = bytes(''.join(input_lines).encode(encoding))
Guido van Rossum78892e42007-04-06 17:31:18 +00001856 for do_reads in (False, True):
Guido van Rossum8358db22007-08-18 21:39:55 +00001857 for bufsize in range(1, 10):
1858 for newline, exp_lines in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001859 bufio = self.BufferedReader(self.BytesIO(data), bufsize)
1860 textio = self.TextIOWrapper(bufio, newline=newline,
Guido van Rossum78892e42007-04-06 17:31:18 +00001861 encoding=encoding)
1862 if do_reads:
1863 got_lines = []
1864 while True:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001865 c2 = textio.read(2)
Guido van Rossum78892e42007-04-06 17:31:18 +00001866 if c2 == '':
1867 break
Ezio Melottib3aedd42010-11-20 19:04:17 +00001868 self.assertEqual(len(c2), 2)
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001869 got_lines.append(c2 + textio.readline())
Guido van Rossum78892e42007-04-06 17:31:18 +00001870 else:
Guido van Rossum76c5d4d2007-04-06 19:10:29 +00001871 got_lines = list(textio)
Guido van Rossum78892e42007-04-06 17:31:18 +00001872
1873 for got_line, exp_line in zip(got_lines, exp_lines):
Ezio Melottib3aedd42010-11-20 19:04:17 +00001874 self.assertEqual(got_line, exp_line)
1875 self.assertEqual(len(got_lines), len(exp_lines))
Guido van Rossum78892e42007-04-06 17:31:18 +00001876
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001877 def test_newlines_input(self):
1878 testdata = b"AAA\nBB\x00B\nCCC\rDDD\rEEE\r\nFFF\r\nGGG"
Guido van Rossum8358db22007-08-18 21:39:55 +00001879 normalized = testdata.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
1880 for newline, expected in [
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00001881 (None, normalized.decode("ascii").splitlines(True)),
1882 ("", testdata.decode("ascii").splitlines(True)),
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001883 ("\n", ["AAA\n", "BB\x00B\n", "CCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
1884 ("\r\n", ["AAA\nBB\x00B\nCCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]),
1885 ("\r", ["AAA\nBB\x00B\nCCC\r", "DDD\r", "EEE\r", "\nFFF\r", "\nGGG"]),
Guido van Rossum8358db22007-08-18 21:39:55 +00001886 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001887 buf = self.BytesIO(testdata)
1888 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001889 self.assertEqual(txt.readlines(), expected)
Guido van Rossum8358db22007-08-18 21:39:55 +00001890 txt.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001891 self.assertEqual(txt.read(), "".join(expected))
Guido van Rossum8358db22007-08-18 21:39:55 +00001892
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001893 def test_newlines_output(self):
1894 testdict = {
1895 "": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
1896 "\n": b"AAA\nBBB\nCCC\nX\rY\r\nZ",
1897 "\r": b"AAA\rBBB\rCCC\rX\rY\r\rZ",
1898 "\r\n": b"AAA\r\nBBB\r\nCCC\r\nX\rY\r\r\nZ",
1899 }
1900 tests = [(None, testdict[os.linesep])] + sorted(testdict.items())
1901 for newline, expected in tests:
1902 buf = self.BytesIO()
1903 txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline)
1904 txt.write("AAA\nB")
1905 txt.write("BB\nCCC\n")
1906 txt.write("X\rY\r\nZ")
1907 txt.flush()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001908 self.assertEqual(buf.closed, False)
1909 self.assertEqual(buf.getvalue(), expected)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001910
1911 def test_destructor(self):
1912 l = []
1913 base = self.BytesIO
1914 class MyBytesIO(base):
1915 def close(self):
1916 l.append(self.getvalue())
1917 base.close(self)
1918 b = MyBytesIO()
1919 t = self.TextIOWrapper(b, encoding="ascii")
1920 t.write("abc")
1921 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001922 support.gc_collect()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001923 self.assertEqual([b"abc"], l)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001924
1925 def test_override_destructor(self):
1926 record = []
1927 class MyTextIO(self.TextIOWrapper):
1928 def __del__(self):
1929 record.append(1)
1930 try:
1931 f = super().__del__
1932 except AttributeError:
1933 pass
1934 else:
1935 f()
1936 def close(self):
1937 record.append(2)
1938 super().close()
1939 def flush(self):
1940 record.append(3)
1941 super().flush()
1942 b = self.BytesIO()
1943 t = MyTextIO(b, encoding="ascii")
1944 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00001945 support.gc_collect()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001946 self.assertEqual(record, [1, 2, 3])
1947
1948 def test_error_through_destructor(self):
1949 # Test that the exception state is not modified by a destructor,
1950 # even if close() fails.
1951 rawio = self.CloseFailureIO()
1952 def f():
1953 self.TextIOWrapper(rawio).xyzzy
1954 with support.captured_output("stderr") as s:
1955 self.assertRaises(AttributeError, f)
1956 s = s.getvalue().strip()
1957 if s:
1958 # The destructor *may* have printed an unraisable error, check it
1959 self.assertEqual(len(s.splitlines()), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001960 self.assertTrue(s.startswith("Exception IOError: "), s)
1961 self.assertTrue(s.endswith(" ignored"), s)
Guido van Rossum8358db22007-08-18 21:39:55 +00001962
Guido van Rossum9b76da62007-04-11 01:09:03 +00001963 # Systematic tests of the text I/O API
1964
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001965 def test_basic_io(self):
Guido van Rossum9b76da62007-04-11 01:09:03 +00001966 for chunksize in (1, 2, 3, 4, 5, 15, 16, 17, 31, 32, 33, 63, 64, 65):
1967 for enc in "ascii", "latin1", "utf8" :# , "utf-16-be", "utf-16-le":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001968 f = self.open(support.TESTFN, "w+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001969 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00001970 self.assertEqual(f.write("abc"), 3)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001971 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001972 f = self.open(support.TESTFN, "r+", encoding=enc)
Guido van Rossum9b76da62007-04-11 01:09:03 +00001973 f._CHUNK_SIZE = chunksize
Ezio Melottib3aedd42010-11-20 19:04:17 +00001974 self.assertEqual(f.tell(), 0)
1975 self.assertEqual(f.read(), "abc")
Guido van Rossum9b76da62007-04-11 01:09:03 +00001976 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00001977 self.assertEqual(f.seek(0), 0)
1978 self.assertEqual(f.read(None), "abc")
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00001979 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001980 self.assertEqual(f.read(2), "ab")
1981 self.assertEqual(f.read(1), "c")
1982 self.assertEqual(f.read(1), "")
1983 self.assertEqual(f.read(), "")
1984 self.assertEqual(f.tell(), cookie)
1985 self.assertEqual(f.seek(0), 0)
1986 self.assertEqual(f.seek(0, 2), cookie)
1987 self.assertEqual(f.write("def"), 3)
1988 self.assertEqual(f.seek(cookie), cookie)
1989 self.assertEqual(f.read(), "def")
Guido van Rossum9b76da62007-04-11 01:09:03 +00001990 if enc.startswith("utf"):
1991 self.multi_line_test(f, enc)
1992 f.close()
1993
1994 def multi_line_test(self, f, enc):
1995 f.seek(0)
1996 f.truncate()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00001997 sample = "s\xff\u0fff\uffff"
Guido van Rossum9b76da62007-04-11 01:09:03 +00001998 wlines = []
Guido van Rossumcba608c2007-04-11 14:19:59 +00001999 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 +00002000 chars = []
Guido van Rossum805365e2007-05-07 22:24:25 +00002001 for i in range(size):
Guido van Rossum9b76da62007-04-11 01:09:03 +00002002 chars.append(sample[i % len(sample)])
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002003 line = "".join(chars) + "\n"
Guido van Rossum9b76da62007-04-11 01:09:03 +00002004 wlines.append((f.tell(), line))
2005 f.write(line)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002006 f.seek(0)
2007 rlines = []
2008 while True:
2009 pos = f.tell()
2010 line = f.readline()
2011 if not line:
Guido van Rossum9b76da62007-04-11 01:09:03 +00002012 break
2013 rlines.append((pos, line))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002014 self.assertEqual(rlines, wlines)
Guido van Rossum9b76da62007-04-11 01:09:03 +00002015
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002016 def test_telling(self):
2017 f = self.open(support.TESTFN, "w+", encoding="utf8")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002018 p0 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002019 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002020 p1 = f.tell()
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002021 f.write("\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002022 p2 = f.tell()
2023 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002024 self.assertEqual(f.tell(), p0)
2025 self.assertEqual(f.readline(), "\xff\n")
2026 self.assertEqual(f.tell(), p1)
2027 self.assertEqual(f.readline(), "\xff\n")
2028 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002029 f.seek(0)
2030 for line in f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002031 self.assertEqual(line, "\xff\n")
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002032 self.assertRaises(IOError, f.tell)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002033 self.assertEqual(f.tell(), p2)
Guido van Rossumb9c4c3e2007-04-11 16:07:50 +00002034 f.close()
2035
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002036 def test_seeking(self):
2037 chunk_size = _default_chunk_size()
Guido van Rossumd76e7792007-04-17 02:38:04 +00002038 prefix_size = chunk_size - 2
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002039 u_prefix = "a" * prefix_size
Guido van Rossumd76e7792007-04-17 02:38:04 +00002040 prefix = bytes(u_prefix.encode("utf-8"))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002041 self.assertEqual(len(u_prefix), len(prefix))
Guido van Rossumef87d6e2007-05-02 19:09:54 +00002042 u_suffix = "\u8888\n"
Guido van Rossumd76e7792007-04-17 02:38:04 +00002043 suffix = bytes(u_suffix.encode("utf-8"))
2044 line = prefix + suffix
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002045 with self.open(support.TESTFN, "wb") as f:
2046 f.write(line*2)
2047 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2048 s = f.read(prefix_size)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002049 self.assertEqual(s, str(prefix, "ascii"))
2050 self.assertEqual(f.tell(), prefix_size)
2051 self.assertEqual(f.readline(), u_suffix)
Guido van Rossumd76e7792007-04-17 02:38:04 +00002052
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002053 def test_seeking_too(self):
Guido van Rossumd76e7792007-04-17 02:38:04 +00002054 # Regression test for a specific bug
2055 data = b'\xe0\xbf\xbf\n'
Benjamin Petersonebe5d8a2010-10-31 01:30:11 +00002056 with self.open(support.TESTFN, "wb") as f:
2057 f.write(data)
2058 with self.open(support.TESTFN, "r", encoding="utf-8") as f:
2059 f._CHUNK_SIZE # Just test that it exists
2060 f._CHUNK_SIZE = 2
2061 f.readline()
2062 f.tell()
Guido van Rossumd76e7792007-04-17 02:38:04 +00002063
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002064 def test_seek_and_tell(self):
2065 #Test seek/tell using the StatefulIncrementalDecoder.
2066 # Make test faster by doing smaller seeks
2067 CHUNK_SIZE = 128
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002068
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002069 def test_seek_and_tell_with_data(data, min_pos=0):
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002070 """Tell/seek to various points within a data stream and ensure
2071 that the decoded data returned by read() is consistent."""
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002072 f = self.open(support.TESTFN, 'wb')
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002073 f.write(data)
2074 f.close()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002075 f = self.open(support.TESTFN, encoding='test_decoder')
2076 f._CHUNK_SIZE = CHUNK_SIZE
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002077 decoded = f.read()
2078 f.close()
2079
Neal Norwitze2b07052008-03-18 19:52:05 +00002080 for i in range(min_pos, len(decoded) + 1): # seek positions
2081 for j in [1, 5, len(decoded) - i]: # read lengths
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002082 f = self.open(support.TESTFN, encoding='test_decoder')
Ezio Melottib3aedd42010-11-20 19:04:17 +00002083 self.assertEqual(f.read(i), decoded[:i])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002084 cookie = f.tell()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002085 self.assertEqual(f.read(j), decoded[i:i + j])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002086 f.seek(cookie)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002087 self.assertEqual(f.read(), decoded[i:])
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002088 f.close()
2089
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002090 # Enable the test decoder.
2091 StatefulIncrementalDecoder.codecEnabled = 1
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002092
2093 # Run the tests.
2094 try:
2095 # Try each test case.
2096 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002097 test_seek_and_tell_with_data(input)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002098
2099 # Position each test case so that it crosses a chunk boundary.
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002100 for input, _, _ in StatefulIncrementalDecoderTest.test_cases:
2101 offset = CHUNK_SIZE - len(input)//2
2102 prefix = b'.'*offset
2103 # Don't bother seeking into the prefix (takes too long).
2104 min_pos = offset*2
Benjamin Peterson5fd871d2009-03-05 00:49:53 +00002105 test_seek_and_tell_with_data(prefix + input, min_pos)
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002106
2107 # Ensure our test decoder won't interfere with subsequent tests.
2108 finally:
Benjamin Petersonad9d48d2008-04-02 21:49:44 +00002109 StatefulIncrementalDecoder.codecEnabled = 0
Ka-Ping Yeef44c7e82008-03-18 04:51:32 +00002110
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002111 def test_encoded_writes(self):
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002112 data = "1234567890"
2113 tests = ("utf-16",
2114 "utf-16-le",
2115 "utf-16-be",
2116 "utf-32",
2117 "utf-32-le",
2118 "utf-32-be")
2119 for encoding in tests:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002120 buf = self.BytesIO()
2121 f = self.TextIOWrapper(buf, encoding=encoding)
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002122 # Check if the BOM is written only once (see issue1753).
2123 f.write(data)
2124 f.write(data)
2125 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002126 self.assertEqual(f.read(), data * 2)
Benjamin Peterson9363a652009-03-05 00:42:09 +00002127 f.seek(0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002128 self.assertEqual(f.read(), data * 2)
2129 self.assertEqual(buf.getvalue(), (data * 2).encode(encoding))
Alexandre Vassalottia38f73b2008-01-07 18:30:48 +00002130
Benjamin Petersona1b49012009-03-31 23:11:32 +00002131 def test_unreadable(self):
2132 class UnReadable(self.BytesIO):
2133 def readable(self):
2134 return False
2135 txt = self.TextIOWrapper(UnReadable())
2136 self.assertRaises(IOError, txt.read)
2137
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002138 def test_read_one_by_one(self):
2139 txt = self.TextIOWrapper(self.BytesIO(b"AA\r\nBB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002140 reads = ""
2141 while True:
2142 c = txt.read(1)
2143 if not c:
2144 break
2145 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002146 self.assertEqual(reads, "AA\nBB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002147
Benjamin Petersonbf5ff762009-12-13 19:25:34 +00002148 def test_readlines(self):
2149 txt = self.TextIOWrapper(self.BytesIO(b"AA\nBB\nCC"))
2150 self.assertEqual(txt.readlines(), ["AA\n", "BB\n", "CC"])
2151 txt.seek(0)
2152 self.assertEqual(txt.readlines(None), ["AA\n", "BB\n", "CC"])
2153 txt.seek(0)
2154 self.assertEqual(txt.readlines(5), ["AA\n", "BB\n"])
2155
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002156 # read in amounts equal to TextIOWrapper._CHUNK_SIZE which is 128.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002157 def test_read_by_chunk(self):
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002158 # make sure "\r\n" straddles 128 char boundary.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002159 txt = self.TextIOWrapper(self.BytesIO(b"A" * 127 + b"\r\nB"))
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002160 reads = ""
2161 while True:
2162 c = txt.read(128)
2163 if not c:
2164 break
2165 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002166 self.assertEqual(reads, "A"*127+"\nB")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002167
2168 def test_issue1395_1(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002169 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002170
2171 # read one char at a time
2172 reads = ""
2173 while True:
2174 c = txt.read(1)
2175 if not c:
2176 break
2177 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002178 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002179
2180 def test_issue1395_2(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002181 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002182 txt._CHUNK_SIZE = 4
2183
2184 reads = ""
2185 while True:
2186 c = txt.read(4)
2187 if not c:
2188 break
2189 reads += c
Ezio Melottib3aedd42010-11-20 19:04:17 +00002190 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002191
2192 def test_issue1395_3(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002193 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002194 txt._CHUNK_SIZE = 4
2195
2196 reads = txt.read(4)
2197 reads += txt.read(4)
2198 reads += txt.readline()
2199 reads += txt.readline()
2200 reads += txt.readline()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002201 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002202
2203 def test_issue1395_4(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002204 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002205 txt._CHUNK_SIZE = 4
2206
2207 reads = txt.read(4)
2208 reads += txt.read()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002209 self.assertEqual(reads, self.normalized)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002210
2211 def test_issue1395_5(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002212 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002213 txt._CHUNK_SIZE = 4
2214
2215 reads = txt.read(4)
2216 pos = txt.tell()
2217 txt.seek(0)
2218 txt.seek(pos)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002219 self.assertEqual(txt.read(4), "BBB\n")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002220
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002221 def test_issue2282(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002222 buffer = self.BytesIO(self.testdata)
2223 txt = self.TextIOWrapper(buffer, encoding="ascii")
Ka-Ping Yeeddaa7062008-03-17 20:35:15 +00002224
2225 self.assertEqual(buffer.seekable(), txt.seekable())
2226
Antoine Pitroue4501852009-05-14 18:55:55 +00002227 def test_append_bom(self):
2228 # The BOM is not written again when appending to a non-empty file
2229 filename = support.TESTFN
2230 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2231 with self.open(filename, 'w', encoding=charset) as f:
2232 f.write('aaa')
2233 pos = f.tell()
2234 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002235 self.assertEqual(f.read(), 'aaa'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002236
2237 with self.open(filename, 'a', encoding=charset) as f:
2238 f.write('xxx')
2239 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002240 self.assertEqual(f.read(), 'aaaxxx'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002241
2242 def test_seek_bom(self):
2243 # Same test, but when seeking manually
2244 filename = support.TESTFN
2245 for charset in ('utf-8-sig', 'utf-16', 'utf-32'):
2246 with self.open(filename, 'w', encoding=charset) as f:
2247 f.write('aaa')
2248 pos = f.tell()
2249 with self.open(filename, 'r+', encoding=charset) as f:
2250 f.seek(pos)
2251 f.write('zzz')
2252 f.seek(0)
2253 f.write('bbb')
2254 with self.open(filename, 'rb') as f:
Ezio Melottib3aedd42010-11-20 19:04:17 +00002255 self.assertEqual(f.read(), 'bbbzzz'.encode(charset))
Antoine Pitroue4501852009-05-14 18:55:55 +00002256
Benjamin Peterson0926ad12009-06-06 18:02:12 +00002257 def test_errors_property(self):
2258 with self.open(support.TESTFN, "w") as f:
2259 self.assertEqual(f.errors, "strict")
2260 with self.open(support.TESTFN, "w", errors="replace") as f:
2261 self.assertEqual(f.errors, "replace")
2262
Victor Stinner45df8202010-04-28 22:31:17 +00002263 @unittest.skipUnless(threading, 'Threading required for this test.')
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002264 def test_threads_write(self):
2265 # Issue6750: concurrent writes could duplicate data
2266 event = threading.Event()
2267 with self.open(support.TESTFN, "w", buffering=1) as f:
2268 def run(n):
2269 text = "Thread%03d\n" % n
2270 event.wait()
2271 f.write(text)
2272 threads = [threading.Thread(target=lambda n=x: run(n))
2273 for x in range(20)]
2274 for t in threads:
2275 t.start()
2276 time.sleep(0.02)
2277 event.set()
2278 for t in threads:
2279 t.join()
2280 with self.open(support.TESTFN) as f:
2281 content = f.read()
2282 for n in range(20):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002283 self.assertEqual(content.count("Thread%03d\n" % n), 1)
Amaury Forgeot d'Arcccd686a2009-08-29 23:00:38 +00002284
Antoine Pitrou6be88762010-05-03 16:48:20 +00002285 def test_flush_error_on_close(self):
2286 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2287 def bad_flush():
2288 raise IOError()
2289 txt.flush = bad_flush
2290 self.assertRaises(IOError, txt.close) # exception not swallowed
2291
2292 def test_multi_close(self):
2293 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2294 txt.close()
2295 txt.close()
2296 txt.close()
2297 self.assertRaises(ValueError, txt.flush)
2298
Antoine Pitrou0d739d72010-09-05 23:01:12 +00002299 def test_unseekable(self):
2300 txt = self.TextIOWrapper(self.MockUnseekableIO(self.testdata))
2301 self.assertRaises(self.UnsupportedOperation, txt.tell)
2302 self.assertRaises(self.UnsupportedOperation, txt.seek, 0)
2303
Antoine Pitrou7f8f4182010-12-21 21:20:59 +00002304 def test_readonly_attributes(self):
2305 txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii")
2306 buf = self.BytesIO(self.testdata)
2307 with self.assertRaises(AttributeError):
2308 txt.buffer = buf
2309
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002310class CTextIOWrapperTest(TextIOWrapperTest):
2311
2312 def test_initialization(self):
2313 r = self.BytesIO(b"\xc3\xa9\n\n")
2314 b = self.BufferedReader(r, 1000)
2315 t = self.TextIOWrapper(b)
2316 self.assertRaises(TypeError, t.__init__, b, newline=42)
2317 self.assertRaises(ValueError, t.read)
2318 self.assertRaises(ValueError, t.__init__, b, newline='xyzzy')
2319 self.assertRaises(ValueError, t.read)
2320
2321 def test_garbage_collection(self):
2322 # C TextIOWrapper objects are collected, and collecting them flushes
2323 # all data to disk.
2324 # The Python version has __del__, so it ends in gc.garbage instead.
2325 rawio = io.FileIO(support.TESTFN, "wb")
2326 b = self.BufferedWriter(rawio)
2327 t = self.TextIOWrapper(b, encoding="ascii")
2328 t.write("456def")
2329 t.x = t
2330 wr = weakref.ref(t)
2331 del t
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002332 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002333 self.assertTrue(wr() is None, wr)
Hirokazu Yamamotoc7d6aa42009-06-18 00:07:14 +00002334 with self.open(support.TESTFN, "rb") as f:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002335 self.assertEqual(f.read(), b"456def")
2336
2337class PyTextIOWrapperTest(TextIOWrapperTest):
2338 pass
2339
2340
2341class IncrementalNewlineDecoderTest(unittest.TestCase):
2342
2343 def check_newline_decoding_utf8(self, decoder):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002344 # UTF-8 specific tests for a newline decoder
2345 def _check_decode(b, s, **kwargs):
2346 # We exercise getstate() / setstate() as well as decode()
2347 state = decoder.getstate()
Ezio Melottib3aedd42010-11-20 19:04:17 +00002348 self.assertEqual(decoder.decode(b, **kwargs), s)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002349 decoder.setstate(state)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002350 self.assertEqual(decoder.decode(b, **kwargs), s)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002351
Antoine Pitrou180a3362008-12-14 16:36:46 +00002352 _check_decode(b'\xe8\xa2\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002353
Antoine Pitrou180a3362008-12-14 16:36:46 +00002354 _check_decode(b'\xe8', "")
2355 _check_decode(b'\xa2', "")
2356 _check_decode(b'\x88', "\u8888")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002357
Antoine Pitrou180a3362008-12-14 16:36:46 +00002358 _check_decode(b'\xe8', "")
2359 _check_decode(b'\xa2', "")
2360 _check_decode(b'\x88', "\u8888")
2361
2362 _check_decode(b'\xe8', "")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002363 self.assertRaises(UnicodeDecodeError, decoder.decode, b'', final=True)
2364
Antoine Pitrou180a3362008-12-14 16:36:46 +00002365 decoder.reset()
2366 _check_decode(b'\n', "\n")
2367 _check_decode(b'\r', "")
2368 _check_decode(b'', "\n", final=True)
2369 _check_decode(b'\r', "\n", final=True)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002370
Antoine Pitrou180a3362008-12-14 16:36:46 +00002371 _check_decode(b'\r', "")
2372 _check_decode(b'a', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002373
Antoine Pitrou180a3362008-12-14 16:36:46 +00002374 _check_decode(b'\r\r\n', "\n\n")
2375 _check_decode(b'\r', "")
2376 _check_decode(b'\r', "\n")
2377 _check_decode(b'\na', "\na")
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +00002378
Antoine Pitrou180a3362008-12-14 16:36:46 +00002379 _check_decode(b'\xe8\xa2\x88\r\n', "\u8888\n")
2380 _check_decode(b'\xe8\xa2\x88', "\u8888")
2381 _check_decode(b'\n', "\n")
2382 _check_decode(b'\xe8\xa2\x88\r', "\u8888")
2383 _check_decode(b'\n', "\n")
Guido van Rossum9b76da62007-04-11 01:09:03 +00002384
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002385 def check_newline_decoding(self, decoder, encoding):
Antoine Pitrou180a3362008-12-14 16:36:46 +00002386 result = []
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002387 if encoding is not None:
2388 encoder = codecs.getincrementalencoder(encoding)()
2389 def _decode_bytewise(s):
2390 # Decode one byte at a time
2391 for b in encoder.encode(s):
2392 result.append(decoder.decode(bytes([b])))
2393 else:
2394 encoder = None
2395 def _decode_bytewise(s):
2396 # Decode one char at a time
2397 for c in s:
2398 result.append(decoder.decode(c))
Ezio Melottib3aedd42010-11-20 19:04:17 +00002399 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002400 _decode_bytewise("abc\n\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002401 self.assertEqual(decoder.newlines, '\n')
Antoine Pitrou180a3362008-12-14 16:36:46 +00002402 _decode_bytewise("\nabc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002403 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002404 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002405 self.assertEqual(decoder.newlines, ('\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002406 _decode_bytewise("abc")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002407 self.assertEqual(decoder.newlines, ('\r', '\n', '\r\n'))
Antoine Pitrou180a3362008-12-14 16:36:46 +00002408 _decode_bytewise("abc\r")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002409 self.assertEqual("".join(result), "abc\n\nabcabc\nabcabc")
Antoine Pitrou180a3362008-12-14 16:36:46 +00002410 decoder.reset()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002411 input = "abc"
2412 if encoder is not None:
2413 encoder.reset()
2414 input = encoder.encode(input)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002415 self.assertEqual(decoder.decode(input), "abc")
2416 self.assertEqual(decoder.newlines, None)
Antoine Pitrou180a3362008-12-14 16:36:46 +00002417
2418 def test_newline_decoder(self):
2419 encodings = (
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002420 # None meaning the IncrementalNewlineDecoder takes unicode input
2421 # rather than bytes input
2422 None, 'utf-8', 'latin-1',
Antoine Pitrou180a3362008-12-14 16:36:46 +00002423 'utf-16', 'utf-16-le', 'utf-16-be',
2424 'utf-32', 'utf-32-le', 'utf-32-be',
2425 )
2426 for enc in encodings:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002427 decoder = enc and codecs.getincrementaldecoder(enc)()
2428 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2429 self.check_newline_decoding(decoder, enc)
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002430 decoder = codecs.getincrementaldecoder("utf-8")()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002431 decoder = self.IncrementalNewlineDecoder(decoder, translate=True)
2432 self.check_newline_decoding_utf8(decoder)
2433
Antoine Pitrou66913e22009-03-06 23:40:56 +00002434 def test_newline_bytes(self):
2435 # Issue 5433: Excessive optimization in IncrementalNewlineDecoder
2436 def _check(dec):
Ezio Melottib3aedd42010-11-20 19:04:17 +00002437 self.assertEqual(dec.newlines, None)
2438 self.assertEqual(dec.decode("\u0D00"), "\u0D00")
2439 self.assertEqual(dec.newlines, None)
2440 self.assertEqual(dec.decode("\u0A00"), "\u0A00")
2441 self.assertEqual(dec.newlines, None)
Antoine Pitrou66913e22009-03-06 23:40:56 +00002442 dec = self.IncrementalNewlineDecoder(None, translate=False)
2443 _check(dec)
2444 dec = self.IncrementalNewlineDecoder(None, translate=True)
2445 _check(dec)
2446
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002447class CIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2448 pass
2449
2450class PyIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest):
2451 pass
Antoine Pitrou180a3362008-12-14 16:36:46 +00002452
Alexandre Vassalotti472f07d2008-01-06 00:34:32 +00002453
Guido van Rossum01a27522007-03-07 01:00:12 +00002454# XXX Tests for open()
Guido van Rossum68bbcd22007-02-27 17:19:33 +00002455
Guido van Rossum5abbf752007-08-27 17:39:33 +00002456class MiscIOTest(unittest.TestCase):
2457
Barry Warsaw40e82462008-11-20 20:14:50 +00002458 def tearDown(self):
2459 support.unlink(support.TESTFN)
2460
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002461 def test___all__(self):
2462 for name in self.io.__all__:
2463 obj = getattr(self.io, name, None)
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002464 self.assertTrue(obj is not None, name)
Guido van Rossum5abbf752007-08-27 17:39:33 +00002465 if name == "open":
2466 continue
Benjamin Peterson6a52a9c2009-04-29 22:00:44 +00002467 elif "error" in name.lower() or name == "UnsupportedOperation":
Benjamin Petersonbfb95942009-04-02 01:13:40 +00002468 self.assertTrue(issubclass(obj, Exception), name)
2469 elif not name.startswith("SEEK_"):
2470 self.assertTrue(issubclass(obj, self.IOBase))
Benjamin Peterson65676e42008-11-05 21:42:45 +00002471
Barry Warsaw40e82462008-11-20 20:14:50 +00002472 def test_attributes(self):
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002473 f = self.open(support.TESTFN, "wb", buffering=0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002474 self.assertEqual(f.mode, "wb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002475 f.close()
2476
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002477 f = self.open(support.TESTFN, "U")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002478 self.assertEqual(f.name, support.TESTFN)
2479 self.assertEqual(f.buffer.name, support.TESTFN)
2480 self.assertEqual(f.buffer.raw.name, support.TESTFN)
2481 self.assertEqual(f.mode, "U")
2482 self.assertEqual(f.buffer.mode, "rb")
2483 self.assertEqual(f.buffer.raw.mode, "rb")
Barry Warsaw40e82462008-11-20 20:14:50 +00002484 f.close()
2485
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002486 f = self.open(support.TESTFN, "w+")
Ezio Melottib3aedd42010-11-20 19:04:17 +00002487 self.assertEqual(f.mode, "w+")
2488 self.assertEqual(f.buffer.mode, "rb+") # Does it really matter?
2489 self.assertEqual(f.buffer.raw.mode, "rb+")
Barry Warsaw40e82462008-11-20 20:14:50 +00002490
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002491 g = self.open(f.fileno(), "wb", closefd=False)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002492 self.assertEqual(g.mode, "wb")
2493 self.assertEqual(g.raw.mode, "wb")
2494 self.assertEqual(g.name, f.fileno())
2495 self.assertEqual(g.raw.name, f.fileno())
Barry Warsaw40e82462008-11-20 20:14:50 +00002496 f.close()
2497 g.close()
2498
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002499 def test_io_after_close(self):
2500 for kwargs in [
2501 {"mode": "w"},
2502 {"mode": "wb"},
2503 {"mode": "w", "buffering": 1},
2504 {"mode": "w", "buffering": 2},
2505 {"mode": "wb", "buffering": 0},
2506 {"mode": "r"},
2507 {"mode": "rb"},
2508 {"mode": "r", "buffering": 1},
2509 {"mode": "r", "buffering": 2},
2510 {"mode": "rb", "buffering": 0},
2511 {"mode": "w+"},
2512 {"mode": "w+b"},
2513 {"mode": "w+", "buffering": 1},
2514 {"mode": "w+", "buffering": 2},
2515 {"mode": "w+b", "buffering": 0},
2516 ]:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002517 f = self.open(support.TESTFN, **kwargs)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002518 f.close()
2519 self.assertRaises(ValueError, f.flush)
2520 self.assertRaises(ValueError, f.fileno)
2521 self.assertRaises(ValueError, f.isatty)
2522 self.assertRaises(ValueError, f.__iter__)
2523 if hasattr(f, "peek"):
2524 self.assertRaises(ValueError, f.peek, 1)
2525 self.assertRaises(ValueError, f.read)
2526 if hasattr(f, "read1"):
2527 self.assertRaises(ValueError, f.read1, 1024)
Victor Stinnerb79f28c2011-05-25 22:09:03 +02002528 if hasattr(f, "readall"):
2529 self.assertRaises(ValueError, f.readall)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002530 if hasattr(f, "readinto"):
2531 self.assertRaises(ValueError, f.readinto, bytearray(1024))
2532 self.assertRaises(ValueError, f.readline)
2533 self.assertRaises(ValueError, f.readlines)
2534 self.assertRaises(ValueError, f.seek, 0)
2535 self.assertRaises(ValueError, f.tell)
2536 self.assertRaises(ValueError, f.truncate)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002537 self.assertRaises(ValueError, f.write,
2538 b"" if "b" in kwargs['mode'] else "")
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002539 self.assertRaises(ValueError, f.writelines, [])
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002540 self.assertRaises(ValueError, next, f)
Antoine Pitrou8043cf82009-01-09 19:54:29 +00002541
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002542 def test_blockingioerror(self):
2543 # Various BlockingIOError issues
2544 self.assertRaises(TypeError, self.BlockingIOError)
2545 self.assertRaises(TypeError, self.BlockingIOError, 1)
2546 self.assertRaises(TypeError, self.BlockingIOError, 1, 2, 3, 4)
2547 self.assertRaises(TypeError, self.BlockingIOError, 1, "", None)
2548 b = self.BlockingIOError(1, "")
2549 self.assertEqual(b.characters_written, 0)
2550 class C(str):
2551 pass
2552 c = C("")
2553 b = self.BlockingIOError(1, c)
2554 c.b = b
2555 b.c = c
2556 wr = weakref.ref(c)
2557 del c, b
Benjamin Peterson24fb1d02009-04-24 23:26:21 +00002558 support.gc_collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00002559 self.assertTrue(wr() is None, wr)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002560
2561 def test_abcs(self):
2562 # Test the visible base classes are ABCs.
Ezio Melottie9615932010-01-24 19:26:24 +00002563 self.assertIsInstance(self.IOBase, abc.ABCMeta)
2564 self.assertIsInstance(self.RawIOBase, abc.ABCMeta)
2565 self.assertIsInstance(self.BufferedIOBase, abc.ABCMeta)
2566 self.assertIsInstance(self.TextIOBase, abc.ABCMeta)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002567
2568 def _check_abc_inheritance(self, abcmodule):
2569 with self.open(support.TESTFN, "wb", buffering=0) as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002570 self.assertIsInstance(f, abcmodule.IOBase)
2571 self.assertIsInstance(f, abcmodule.RawIOBase)
2572 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2573 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002574 with self.open(support.TESTFN, "wb") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002575 self.assertIsInstance(f, abcmodule.IOBase)
2576 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2577 self.assertIsInstance(f, abcmodule.BufferedIOBase)
2578 self.assertNotIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002579 with self.open(support.TESTFN, "w") as f:
Ezio Melottie9615932010-01-24 19:26:24 +00002580 self.assertIsInstance(f, abcmodule.IOBase)
2581 self.assertNotIsInstance(f, abcmodule.RawIOBase)
2582 self.assertNotIsInstance(f, abcmodule.BufferedIOBase)
2583 self.assertIsInstance(f, abcmodule.TextIOBase)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002584
2585 def test_abc_inheritance(self):
2586 # Test implementations inherit from their respective ABCs
2587 self._check_abc_inheritance(self)
2588
2589 def test_abc_inheritance_official(self):
2590 # Test implementations inherit from the official ABCs of the
2591 # baseline "io" module.
2592 self._check_abc_inheritance(io)
2593
Antoine Pitroue033e062010-10-29 10:38:18 +00002594 def _check_warn_on_dealloc(self, *args, **kwargs):
2595 f = open(*args, **kwargs)
2596 r = repr(f)
2597 with self.assertWarns(ResourceWarning) as cm:
2598 f = None
2599 support.gc_collect()
2600 self.assertIn(r, str(cm.warning.args[0]))
2601
2602 def test_warn_on_dealloc(self):
2603 self._check_warn_on_dealloc(support.TESTFN, "wb", buffering=0)
2604 self._check_warn_on_dealloc(support.TESTFN, "wb")
2605 self._check_warn_on_dealloc(support.TESTFN, "w")
2606
2607 def _check_warn_on_dealloc_fd(self, *args, **kwargs):
2608 fds = []
Benjamin Peterson556c7352010-10-31 01:35:43 +00002609 def cleanup_fds():
Antoine Pitroue033e062010-10-29 10:38:18 +00002610 for fd in fds:
2611 try:
2612 os.close(fd)
2613 except EnvironmentError as e:
2614 if e.errno != errno.EBADF:
2615 raise
Benjamin Peterson556c7352010-10-31 01:35:43 +00002616 self.addCleanup(cleanup_fds)
2617 r, w = os.pipe()
2618 fds += r, w
2619 self._check_warn_on_dealloc(r, *args, **kwargs)
2620 # When using closefd=False, there's no warning
2621 r, w = os.pipe()
2622 fds += r, w
2623 with warnings.catch_warnings(record=True) as recorded:
2624 open(r, *args, closefd=False, **kwargs)
2625 support.gc_collect()
2626 self.assertEqual(recorded, [])
Antoine Pitroue033e062010-10-29 10:38:18 +00002627
2628 def test_warn_on_dealloc_fd(self):
2629 self._check_warn_on_dealloc_fd("rb", buffering=0)
2630 self._check_warn_on_dealloc_fd("rb")
2631 self._check_warn_on_dealloc_fd("r")
2632
2633
Antoine Pitrou243757e2010-11-05 21:15:39 +00002634 def test_pickling(self):
2635 # Pickling file objects is forbidden
2636 for kwargs in [
2637 {"mode": "w"},
2638 {"mode": "wb"},
2639 {"mode": "wb", "buffering": 0},
2640 {"mode": "r"},
2641 {"mode": "rb"},
2642 {"mode": "rb", "buffering": 0},
2643 {"mode": "w+"},
2644 {"mode": "w+b"},
2645 {"mode": "w+b", "buffering": 0},
2646 ]:
2647 for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
2648 with self.open(support.TESTFN, **kwargs) as f:
2649 self.assertRaises(TypeError, pickle.dumps, f, protocol)
2650
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002651class CMiscIOTest(MiscIOTest):
2652 io = io
2653
2654class PyMiscIOTest(MiscIOTest):
2655 io = pyio
Barry Warsaw40e82462008-11-20 20:14:50 +00002656
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002657
2658@unittest.skipIf(os.name == 'nt', 'POSIX signals required for this test.')
2659class SignalsTest(unittest.TestCase):
2660
2661 def setUp(self):
2662 self.oldalrm = signal.signal(signal.SIGALRM, self.alarm_interrupt)
2663
2664 def tearDown(self):
2665 signal.signal(signal.SIGALRM, self.oldalrm)
2666
2667 def alarm_interrupt(self, sig, frame):
2668 1/0
2669
2670 @unittest.skipUnless(threading, 'Threading required for this test.')
Victor Stinnercd1aa0d2011-07-04 11:48:17 +02002671 @unittest.skipIf(sys.platform in ('freebsd5', 'freebsd6', 'freebsd7'),
2672 'issue #12429: skip test on FreeBSD <= 7')
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002673 def check_interrupted_write(self, item, bytes, **fdopen_kwargs):
2674 """Check that a partial write, when it gets interrupted, properly
Antoine Pitroud843c2d2011-02-25 21:34:39 +00002675 invokes the signal handler, and bubbles up the exception raised
2676 in the latter."""
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002677 read_results = []
2678 def _read():
2679 s = os.read(r, 1)
2680 read_results.append(s)
2681 t = threading.Thread(target=_read)
2682 t.daemon = True
2683 r, w = os.pipe()
Benjamin Petersond8fc2e12010-10-31 01:19:53 +00002684 fdopen_kwargs["closefd"] = False
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002685 try:
2686 wio = self.io.open(w, **fdopen_kwargs)
2687 t.start()
2688 signal.alarm(1)
2689 # Fill the pipe enough that the write will be blocking.
2690 # It will be interrupted by the timer armed above. Since the
2691 # other thread has read one byte, the low-level write will
2692 # return with a successful (partial) result rather than an EINTR.
2693 # The buffered IO layer must check for pending signal
2694 # handlers, which in this case will invoke alarm_interrupt().
2695 self.assertRaises(ZeroDivisionError,
2696 wio.write, item * (1024 * 1024))
2697 t.join()
2698 # We got one byte, get another one and check that it isn't a
2699 # repeat of the first one.
2700 read_results.append(os.read(r, 1))
2701 self.assertEqual(read_results, [bytes[0:1], bytes[1:2]])
2702 finally:
2703 os.close(w)
2704 os.close(r)
2705 # This is deliberate. If we didn't close the file descriptor
2706 # before closing wio, wio would try to flush its internal
2707 # buffer, and block again.
2708 try:
2709 wio.close()
2710 except IOError as e:
2711 if e.errno != errno.EBADF:
2712 raise
2713
2714 def test_interrupted_write_unbuffered(self):
2715 self.check_interrupted_write(b"xy", b"xy", mode="wb", buffering=0)
2716
2717 def test_interrupted_write_buffered(self):
2718 self.check_interrupted_write(b"xy", b"xy", mode="wb")
2719
2720 def test_interrupted_write_text(self):
2721 self.check_interrupted_write("xy", b"xy", mode="w", encoding="ascii")
2722
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002723 def check_reentrant_write(self, data, **fdopen_kwargs):
2724 def on_alarm(*args):
2725 # Will be called reentrantly from the same thread
2726 wio.write(data)
2727 1/0
2728 signal.signal(signal.SIGALRM, on_alarm)
2729 r, w = os.pipe()
2730 wio = self.io.open(w, **fdopen_kwargs)
2731 try:
2732 signal.alarm(1)
2733 # Either the reentrant call to wio.write() fails with RuntimeError,
2734 # or the signal handler raises ZeroDivisionError.
2735 with self.assertRaises((ZeroDivisionError, RuntimeError)) as cm:
2736 while 1:
2737 for i in range(100):
2738 wio.write(data)
2739 wio.flush()
2740 # Make sure the buffer doesn't fill up and block further writes
2741 os.read(r, len(data) * 100)
2742 exc = cm.exception
2743 if isinstance(exc, RuntimeError):
2744 self.assertTrue(str(exc).startswith("reentrant call"), str(exc))
2745 finally:
2746 wio.close()
2747 os.close(r)
2748
2749 def test_reentrant_write_buffered(self):
2750 self.check_reentrant_write(b"xy", mode="wb")
2751
2752 def test_reentrant_write_text(self):
2753 self.check_reentrant_write("xy", mode="w", encoding="ascii")
2754
Antoine Pitroud843c2d2011-02-25 21:34:39 +00002755 def check_interrupted_read_retry(self, decode, **fdopen_kwargs):
2756 """Check that a buffered read, when it gets interrupted (either
2757 returning a partial result or EINTR), properly invokes the signal
2758 handler and retries if the latter returned successfully."""
2759 r, w = os.pipe()
2760 fdopen_kwargs["closefd"] = False
2761 def alarm_handler(sig, frame):
2762 os.write(w, b"bar")
2763 signal.signal(signal.SIGALRM, alarm_handler)
2764 try:
2765 rio = self.io.open(r, **fdopen_kwargs)
2766 os.write(w, b"foo")
2767 signal.alarm(1)
2768 # Expected behaviour:
2769 # - first raw read() returns partial b"foo"
2770 # - second raw read() returns EINTR
2771 # - third raw read() returns b"bar"
2772 self.assertEqual(decode(rio.read(6)), "foobar")
2773 finally:
2774 rio.close()
2775 os.close(w)
2776 os.close(r)
2777
2778 def test_interrupterd_read_retry_buffered(self):
2779 self.check_interrupted_read_retry(lambda x: x.decode('latin1'),
2780 mode="rb")
2781
2782 def test_interrupterd_read_retry_text(self):
2783 self.check_interrupted_read_retry(lambda x: x,
2784 mode="r")
2785
2786 @unittest.skipUnless(threading, 'Threading required for this test.')
2787 def check_interrupted_write_retry(self, item, **fdopen_kwargs):
2788 """Check that a buffered write, when it gets interrupted (either
2789 returning a partial result or EINTR), properly invokes the signal
2790 handler and retries if the latter returned successfully."""
2791 select = support.import_module("select")
2792 # A quantity that exceeds the buffer size of an anonymous pipe's
2793 # write end.
2794 N = 1024 * 1024
2795 r, w = os.pipe()
2796 fdopen_kwargs["closefd"] = False
2797 # We need a separate thread to read from the pipe and allow the
2798 # write() to finish. This thread is started after the SIGALRM is
2799 # received (forcing a first EINTR in write()).
2800 read_results = []
2801 write_finished = False
2802 def _read():
2803 while not write_finished:
2804 while r in select.select([r], [], [], 1.0)[0]:
2805 s = os.read(r, 1024)
2806 read_results.append(s)
2807 t = threading.Thread(target=_read)
2808 t.daemon = True
2809 def alarm1(sig, frame):
2810 signal.signal(signal.SIGALRM, alarm2)
2811 signal.alarm(1)
2812 def alarm2(sig, frame):
2813 t.start()
2814 signal.signal(signal.SIGALRM, alarm1)
2815 try:
2816 wio = self.io.open(w, **fdopen_kwargs)
2817 signal.alarm(1)
2818 # Expected behaviour:
2819 # - first raw write() is partial (because of the limited pipe buffer
2820 # and the first alarm)
2821 # - second raw write() returns EINTR (because of the second alarm)
2822 # - subsequent write()s are successful (either partial or complete)
2823 self.assertEqual(N, wio.write(item * N))
2824 wio.flush()
2825 write_finished = True
2826 t.join()
2827 self.assertEqual(N, sum(len(x) for x in read_results))
2828 finally:
2829 write_finished = True
2830 os.close(w)
2831 os.close(r)
2832 # This is deliberate. If we didn't close the file descriptor
2833 # before closing wio, wio would try to flush its internal
2834 # buffer, and could block (in case of failure).
2835 try:
2836 wio.close()
2837 except IOError as e:
2838 if e.errno != errno.EBADF:
2839 raise
2840
2841 def test_interrupterd_write_retry_buffered(self):
2842 self.check_interrupted_write_retry(b"x", mode="wb")
2843
2844 def test_interrupterd_write_retry_text(self):
2845 self.check_interrupted_write_retry("x", mode="w", encoding="latin1")
2846
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002847
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002848class CSignalsTest(SignalsTest):
2849 io = io
2850
2851class PySignalsTest(SignalsTest):
2852 io = pyio
2853
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00002854 # Handling reentrancy issues would slow down _pyio even more, so the
2855 # tests are disabled.
2856 test_reentrant_write_buffered = None
2857 test_reentrant_write_text = None
2858
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002859
Guido van Rossum28524c72007-02-27 05:47:44 +00002860def test_main():
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002861 tests = (CIOTest, PyIOTest,
2862 CBufferedReaderTest, PyBufferedReaderTest,
2863 CBufferedWriterTest, PyBufferedWriterTest,
2864 CBufferedRWPairTest, PyBufferedRWPairTest,
2865 CBufferedRandomTest, PyBufferedRandomTest,
2866 StatefulIncrementalDecoderTest,
2867 CIncrementalNewlineDecoderTest, PyIncrementalNewlineDecoderTest,
2868 CTextIOWrapperTest, PyTextIOWrapperTest,
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002869 CMiscIOTest, PyMiscIOTest,
2870 CSignalsTest, PySignalsTest,
2871 )
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002872
2873 # Put the namespaces of the IO module we are testing and some useful mock
2874 # classes in the __dict__ of each test.
2875 mocks = (MockRawIO, MisbehavedRawIO, MockFileIO, CloseFailureIO,
Antoine Pitrou328ec742010-09-14 18:37:24 +00002876 MockNonBlockWriterIO, MockUnseekableIO, MockRawIOWithoutRead)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002877 all_members = io.__all__ + ["IncrementalNewlineDecoder"]
2878 c_io_ns = {name : getattr(io, name) for name in all_members}
2879 py_io_ns = {name : getattr(pyio, name) for name in all_members}
2880 globs = globals()
2881 c_io_ns.update((x.__name__, globs["C" + x.__name__]) for x in mocks)
2882 py_io_ns.update((x.__name__, globs["Py" + x.__name__]) for x in mocks)
2883 # Avoid turning open into a bound method.
2884 py_io_ns["open"] = pyio.OpenWrapper
2885 for test in tests:
2886 if test.__name__.startswith("C"):
2887 for name, obj in c_io_ns.items():
2888 setattr(test, name, obj)
2889 elif test.__name__.startswith("Py"):
2890 for name, obj in py_io_ns.items():
2891 setattr(test, name, obj)
2892
2893 support.run_unittest(*tests)
Guido van Rossum28524c72007-02-27 05:47:44 +00002894
2895if __name__ == "__main__":
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002896 test_main()