Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1 | """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 Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 21 | |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 22 | import os |
Guido van Rossum | 34d69e5 | 2007-04-10 20:08:41 +0000 | [diff] [blame] | 23 | import sys |
Guido van Rossum | b9c4c3e | 2007-04-11 16:07:50 +0000 | [diff] [blame] | 24 | import time |
Guido van Rossum | d410395 | 2007-04-12 05:44:49 +0000 | [diff] [blame] | 25 | import array |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 26 | import random |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 27 | import unittest |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 28 | import weakref |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 29 | import abc |
Antoine Pitrou | b46b9d5 | 2010-08-21 19:09:32 +0000 | [diff] [blame] | 30 | import signal |
| 31 | import errno |
Antoine Pitrou | e033e06 | 2010-10-29 10:38:18 +0000 | [diff] [blame] | 32 | import warnings |
Antoine Pitrou | 243757e | 2010-11-05 21:15:39 +0000 | [diff] [blame] | 33 | import pickle |
Georg Brandl | 1b37e87 | 2010-03-14 10:45:50 +0000 | [diff] [blame] | 34 | from itertools import cycle, count |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 35 | from collections import deque |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 36 | from test import support |
Guido van Rossum | 76c5d4d | 2007-04-06 19:10:29 +0000 | [diff] [blame] | 37 | |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 38 | import codecs |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 39 | import io # C implementation of io |
| 40 | import _pyio as pyio # Python implementation of io |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 41 | try: |
| 42 | import threading |
| 43 | except ImportError: |
| 44 | threading = None |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 45 | |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 46 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 47 | def _default_chunk_size(): |
| 48 | """Get the default TextIOWrapper chunk size""" |
Marc-André Lemburg | 8f36af7 | 2011-02-25 15:42:01 +0000 | [diff] [blame] | 49 | with open(__file__, "r", encoding="latin-1") as f: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 50 | return f._CHUNK_SIZE |
| 51 | |
| 52 | |
Antoine Pitrou | 328ec74 | 2010-09-14 18:37:24 +0000 | [diff] [blame] | 53 | class MockRawIOWithoutRead: |
| 54 | """A RawIO implementation without read(), so as to exercise the default |
| 55 | RawIO.read() which calls readinto().""" |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 56 | |
Guido van Rossum | 76c5d4d | 2007-04-06 19:10:29 +0000 | [diff] [blame] | 57 | def __init__(self, read_stack=()): |
| 58 | self._read_stack = list(read_stack) |
| 59 | self._write_stack = [] |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 60 | self._reads = 0 |
Antoine Pitrou | 32cfede | 2010-08-11 13:31:33 +0000 | [diff] [blame] | 61 | self._extraneous_reads = 0 |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 62 | |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 63 | def write(self, b): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 64 | self._write_stack.append(bytes(b)) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 65 | return len(b) |
| 66 | |
| 67 | def writable(self): |
| 68 | return True |
| 69 | |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 70 | def fileno(self): |
| 71 | return 42 |
| 72 | |
| 73 | def readable(self): |
| 74 | return True |
| 75 | |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 76 | def seekable(self): |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 77 | return True |
| 78 | |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 79 | def seek(self, pos, whence): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 80 | return 0 # wrong but we gotta return something |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 81 | |
| 82 | def tell(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 83 | 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 Pitrou | 32cfede | 2010-08-11 13:31:33 +0000 | [diff] [blame] | 91 | self._extraneous_reads += 1 |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 92 | 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 Pitrou | 328ec74 | 2010-09-14 18:37:24 +0000 | [diff] [blame] | 109 | class CMockRawIOWithoutRead(MockRawIOWithoutRead, io.RawIOBase): |
| 110 | pass |
| 111 | |
| 112 | class PyMockRawIOWithoutRead(MockRawIOWithoutRead, pyio.RawIOBase): |
| 113 | pass |
| 114 | |
| 115 | |
| 116 | class 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 Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 126 | class CMockRawIO(MockRawIO, io.RawIOBase): |
| 127 | pass |
| 128 | |
| 129 | class PyMockRawIO(MockRawIO, pyio.RawIOBase): |
| 130 | pass |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 131 | |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 132 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 133 | class 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 | |
| 150 | class CMisbehavedRawIO(MisbehavedRawIO, io.RawIOBase): |
| 151 | pass |
| 152 | |
| 153 | class PyMisbehavedRawIO(MisbehavedRawIO, pyio.RawIOBase): |
| 154 | pass |
| 155 | |
| 156 | |
| 157 | class CloseFailureIO(MockRawIO): |
| 158 | closed = 0 |
| 159 | |
| 160 | def close(self): |
| 161 | if not self.closed: |
| 162 | self.closed = 1 |
| 163 | raise IOError |
| 164 | |
| 165 | class CCloseFailureIO(CloseFailureIO, io.RawIOBase): |
| 166 | pass |
| 167 | |
| 168 | class PyCloseFailureIO(CloseFailureIO, pyio.RawIOBase): |
| 169 | pass |
| 170 | |
| 171 | |
| 172 | class MockFileIO: |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 173 | |
| 174 | def __init__(self, data): |
| 175 | self.read_history = [] |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 176 | super().__init__(data) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 177 | |
| 178 | def read(self, n=None): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 179 | res = super().read(n) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 180 | self.read_history.append(None if res is None else len(res)) |
| 181 | return res |
| 182 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 183 | def readinto(self, b): |
| 184 | res = super().readinto(b) |
| 185 | self.read_history.append(res) |
| 186 | return res |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 187 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 188 | class CMockFileIO(MockFileIO, io.BytesIO): |
| 189 | pass |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 190 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 191 | class PyMockFileIO(MockFileIO, pyio.BytesIO): |
| 192 | pass |
| 193 | |
| 194 | |
Antoine Pitrou | 0d739d7 | 2010-09-05 23:01:12 +0000 | [diff] [blame] | 195 | class 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 | |
| 205 | class CMockUnseekableIO(MockUnseekableIO, io.BytesIO): |
| 206 | UnsupportedOperation = io.UnsupportedOperation |
| 207 | |
| 208 | class PyMockUnseekableIO(MockUnseekableIO, pyio.BytesIO): |
| 209 | UnsupportedOperation = pyio.UnsupportedOperation |
| 210 | |
| 211 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 212 | class MockNonBlockWriterIO: |
| 213 | |
| 214 | def __init__(self): |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 215 | self._write_stack = [] |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 216 | self._blocker_char = None |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 217 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 218 | 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 Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 232 | |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 233 | def writable(self): |
| 234 | return True |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 235 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 236 | 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 | |
| 251 | class CMockNonBlockWriterIO(MockNonBlockWriterIO, io.RawIOBase): |
| 252 | BlockingIOError = io.BlockingIOError |
| 253 | |
| 254 | class PyMockNonBlockWriterIO(MockNonBlockWriterIO, pyio.RawIOBase): |
| 255 | BlockingIOError = pyio.BlockingIOError |
| 256 | |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 257 | |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 258 | class IOTest(unittest.TestCase): |
| 259 | |
Neal Norwitz | e7789b1 | 2008-03-24 06:18:09 +0000 | [diff] [blame] | 260 | def setUp(self): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 261 | support.unlink(support.TESTFN) |
Neal Norwitz | e7789b1 | 2008-03-24 06:18:09 +0000 | [diff] [blame] | 262 | |
Guido van Rossum | 4d0f5a4 | 2007-03-07 22:59:39 +0000 | [diff] [blame] | 263 | def tearDown(self): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 264 | support.unlink(support.TESTFN) |
Guido van Rossum | 4d0f5a4 | 2007-03-07 22:59:39 +0000 | [diff] [blame] | 265 | |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 266 | def write_ops(self, f): |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 267 | self.assertEqual(f.write(b"blah."), 5) |
Antoine Pitrou | 905a2ff | 2010-01-31 22:47:27 +0000 | [diff] [blame] | 268 | f.truncate(0) |
| 269 | self.assertEqual(f.tell(), 5) |
| 270 | f.seek(0) |
| 271 | |
| 272 | self.assertEqual(f.write(b"blah."), 5) |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 273 | self.assertEqual(f.seek(0), 0) |
| 274 | self.assertEqual(f.write(b"Hello."), 6) |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 275 | self.assertEqual(f.tell(), 6) |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 276 | self.assertEqual(f.seek(-1, 1), 5) |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 277 | self.assertEqual(f.tell(), 5) |
Guido van Rossum | 254348e | 2007-11-21 19:29:53 +0000 | [diff] [blame] | 278 | self.assertEqual(f.write(bytearray(b" world\n\n\n")), 9) |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 279 | self.assertEqual(f.seek(0), 0) |
Guido van Rossum | 2b08b38 | 2007-05-08 20:18:39 +0000 | [diff] [blame] | 280 | self.assertEqual(f.write(b"h"), 1) |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 281 | self.assertEqual(f.seek(-1, 2), 13) |
| 282 | self.assertEqual(f.tell(), 13) |
Antoine Pitrou | 905a2ff | 2010-01-31 22:47:27 +0000 | [diff] [blame] | 283 | |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 284 | self.assertEqual(f.truncate(12), 12) |
Antoine Pitrou | 905a2ff | 2010-01-31 22:47:27 +0000 | [diff] [blame] | 285 | self.assertEqual(f.tell(), 13) |
Christian Heimes | 8e42a0a | 2007-11-08 18:04:45 +0000 | [diff] [blame] | 286 | self.assertRaises(TypeError, f.seek, 0.0) |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 287 | |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 288 | def read_ops(self, f, buffered=False): |
| 289 | data = f.read(5) |
| 290 | self.assertEqual(data, b"hello") |
Guido van Rossum | 254348e | 2007-11-21 19:29:53 +0000 | [diff] [blame] | 291 | data = bytearray(data) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 292 | 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 Rossum | 254348e | 2007-11-21 19:29:53 +0000 | [diff] [blame] | 300 | self.assertEqual(f.readinto(bytearray(b"x")), 0) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 301 | self.assertEqual(f.seek(-6, 2), 6) |
| 302 | self.assertEqual(f.read(5), b"world") |
| 303 | self.assertEqual(f.read(0), b"") |
Guido van Rossum | 254348e | 2007-11-21 19:29:53 +0000 | [diff] [blame] | 304 | self.assertEqual(f.readinto(bytearray()), 0) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 305 | self.assertEqual(f.seek(-6, 1), 5) |
| 306 | self.assertEqual(f.read(5), b" worl") |
| 307 | self.assertEqual(f.tell(), 10) |
Christian Heimes | 8e42a0a | 2007-11-08 18:04:45 +0000 | [diff] [blame] | 308 | self.assertRaises(TypeError, f.seek, 0.0) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 309 | 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 Rossum | 34d69e5 | 2007-04-10 20:08:41 +0000 | [diff] [blame] | 316 | LARGE = 2**31 |
| 317 | |
Guido van Rossum | 53807da | 2007-04-10 19:01:47 +0000 | [diff] [blame] | 318 | def large_file_ops(self, f): |
| 319 | assert f.readable() |
| 320 | assert f.writable() |
Guido van Rossum | 34d69e5 | 2007-04-10 20:08:41 +0000 | [diff] [blame] | 321 | self.assertEqual(f.seek(self.LARGE), self.LARGE) |
| 322 | self.assertEqual(f.tell(), self.LARGE) |
Guido van Rossum | 53807da | 2007-04-10 19:01:47 +0000 | [diff] [blame] | 323 | self.assertEqual(f.write(b"xxx"), 3) |
Guido van Rossum | 34d69e5 | 2007-04-10 20:08:41 +0000 | [diff] [blame] | 324 | self.assertEqual(f.tell(), self.LARGE + 3) |
| 325 | self.assertEqual(f.seek(-1, 1), self.LARGE + 2) |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 326 | self.assertEqual(f.truncate(), self.LARGE + 2) |
Guido van Rossum | 34d69e5 | 2007-04-10 20:08:41 +0000 | [diff] [blame] | 327 | self.assertEqual(f.tell(), self.LARGE + 2) |
| 328 | self.assertEqual(f.seek(0, 2), self.LARGE + 2) |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 329 | self.assertEqual(f.truncate(self.LARGE + 1), self.LARGE + 1) |
Antoine Pitrou | 905a2ff | 2010-01-31 22:47:27 +0000 | [diff] [blame] | 330 | self.assertEqual(f.tell(), self.LARGE + 2) |
Guido van Rossum | 34d69e5 | 2007-04-10 20:08:41 +0000 | [diff] [blame] | 331 | self.assertEqual(f.seek(0, 2), self.LARGE + 1) |
| 332 | self.assertEqual(f.seek(-1, 2), self.LARGE) |
Guido van Rossum | 53807da | 2007-04-10 19:01:47 +0000 | [diff] [blame] | 333 | self.assertEqual(f.read(2), b"x") |
| 334 | |
Benjamin Peterson | 81971ea | 2009-05-14 22:01:31 +0000 | [diff] [blame] | 335 | def test_invalid_operations(self): |
| 336 | # Try writing on a file opened in read mode and vice-versa. |
Antoine Pitrou | 0d739d7 | 2010-09-05 23:01:12 +0000 | [diff] [blame] | 337 | exc = self.UnsupportedOperation |
Benjamin Peterson | 81971ea | 2009-05-14 22:01:31 +0000 | [diff] [blame] | 338 | for mode in ("w", "wb"): |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 339 | with self.open(support.TESTFN, mode) as fp: |
Antoine Pitrou | 0d739d7 | 2010-09-05 23:01:12 +0000 | [diff] [blame] | 340 | 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 Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 348 | with self.open(support.TESTFN, "rb") as fp: |
Antoine Pitrou | 0d739d7 | 2010-09-05 23:01:12 +0000 | [diff] [blame] | 349 | self.assertRaises(exc, fp.write, b"blah") |
| 350 | self.assertRaises(exc, fp.writelines, [b"blah\n"]) |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 351 | with self.open(support.TESTFN, "r") as fp: |
Antoine Pitrou | 0d739d7 | 2010-09-05 23:01:12 +0000 | [diff] [blame] | 352 | 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 Peterson | 81971ea | 2009-05-14 22:01:31 +0000 | [diff] [blame] | 357 | |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 358 | def test_raw_file_io(self): |
Benjamin Peterson | 45cec32 | 2009-04-24 23:14:50 +0000 | [diff] [blame] | 359 | 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 Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 369 | |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 370 | def test_buffered_file_io(self): |
Benjamin Peterson | 45cec32 | 2009-04-24 23:14:50 +0000 | [diff] [blame] | 371 | 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 Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 381 | |
Guido van Rossum | 48fc58a | 2007-06-07 23:45:37 +0000 | [diff] [blame] | 382 | def test_readline(self): |
Benjamin Peterson | 45cec32 | 2009-04-24 23:14:50 +0000 | [diff] [blame] | 383 | 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 Peterson | bf5ff76 | 2009-12-13 19:25:34 +0000 | [diff] [blame] | 391 | self.assertEqual(f.readline(None), b"another line") |
Benjamin Peterson | 45cec32 | 2009-04-24 23:14:50 +0000 | [diff] [blame] | 392 | 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 Rossum | 48fc58a | 2007-06-07 23:45:37 +0000 | [diff] [blame] | 395 | |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 396 | def test_raw_bytes_io(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 397 | f = self.BytesIO() |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 398 | self.write_ops(f) |
| 399 | data = f.getvalue() |
| 400 | self.assertEqual(data, b"hello world\n") |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 401 | f = self.BytesIO(data) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 402 | self.read_ops(f, True) |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 403 | |
Guido van Rossum | 53807da | 2007-04-10 19:01:47 +0000 | [diff] [blame] | 404 | def test_large_file_ops(self): |
Guido van Rossum | 34d69e5 | 2007-04-10 20:08:41 +0000 | [diff] [blame] | 405 | # 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 Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 409 | if not support.is_resource_enabled("largefile"): |
Guido van Rossum | 34d69e5 | 2007-04-10 20:08:41 +0000 | [diff] [blame] | 410 | 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 Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 417 | 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 Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 421 | |
| 422 | def test_with_open(self): |
| 423 | for bufsize in (0, 1, 100): |
| 424 | f = None |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 425 | with self.open(support.TESTFN, "wb", bufsize) as f: |
Guido van Rossum | 1f2ca56 | 2007-08-27 20:44:15 +0000 | [diff] [blame] | 426 | f.write(b"xxx") |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 427 | self.assertEqual(f.closed, True) |
| 428 | f = None |
| 429 | try: |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 430 | with self.open(support.TESTFN, "wb", bufsize) as f: |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 431 | 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 Pitrou | 08838b6 | 2009-01-21 00:55:13 +0000 | [diff] [blame] | 437 | # issue 5008 |
| 438 | def test_append_mode_tell(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 439 | with self.open(support.TESTFN, "wb") as f: |
Antoine Pitrou | 08838b6 | 2009-01-21 00:55:13 +0000 | [diff] [blame] | 440 | f.write(b"xxx") |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 441 | with self.open(support.TESTFN, "ab", buffering=0) as f: |
Antoine Pitrou | 08838b6 | 2009-01-21 00:55:13 +0000 | [diff] [blame] | 442 | self.assertEqual(f.tell(), 3) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 443 | with self.open(support.TESTFN, "ab") as f: |
Antoine Pitrou | 08838b6 | 2009-01-21 00:55:13 +0000 | [diff] [blame] | 444 | self.assertEqual(f.tell(), 3) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 445 | with self.open(support.TESTFN, "a") as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 446 | self.assertTrue(f.tell() > 0) |
Antoine Pitrou | 08838b6 | 2009-01-21 00:55:13 +0000 | [diff] [blame] | 447 | |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 448 | def test_destructor(self): |
| 449 | record = [] |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 450 | class MyFileIO(self.FileIO): |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 451 | def __del__(self): |
| 452 | record.append(1) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 453 | try: |
| 454 | f = super().__del__ |
| 455 | except AttributeError: |
| 456 | pass |
| 457 | else: |
| 458 | f() |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 459 | def close(self): |
| 460 | record.append(2) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 461 | super().close() |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 462 | def flush(self): |
| 463 | record.append(3) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 464 | super().flush() |
Brett Cannon | 5a9e91b | 2010-10-29 23:53:03 +0000 | [diff] [blame] | 465 | 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 Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 473 | |
| 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 Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 500 | del f |
Benjamin Peterson | 24fb1d0 | 2009-04-24 23:26:21 +0000 | [diff] [blame] | 501 | support.gc_collect() |
Guido van Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 502 | self.assertEqual(record, [1, 2, 3]) |
| 503 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 504 | 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 Rossum | 8742977 | 2007-04-10 21:06:59 +0000 | [diff] [blame] | 516 | def test_close_flushes(self): |
Benjamin Peterson | 45cec32 | 2009-04-24 23:14:50 +0000 | [diff] [blame] | 517 | 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 Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 521 | |
Guido van Rossum | d410395 | 2007-04-12 05:44:49 +0000 | [diff] [blame] | 522 | def test_array_writes(self): |
| 523 | a = array.array('i', range(10)) |
Antoine Pitrou | 1ce3eb5 | 2010-09-01 20:29:34 +0000 | [diff] [blame] | 524 | n = len(a.tobytes()) |
Benjamin Peterson | 45cec32 | 2009-04-24 23:14:50 +0000 | [diff] [blame] | 525 | 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 Rossum | d410395 | 2007-04-12 05:44:49 +0000 | [diff] [blame] | 529 | |
Guido van Rossum | 2dced8b | 2007-10-30 17:27:30 +0000 | [diff] [blame] | 530 | def test_closefd(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 531 | self.assertRaises(ValueError, self.open, support.TESTFN, 'w', |
Guido van Rossum | 2dced8b | 2007-10-30 17:27:30 +0000 | [diff] [blame] | 532 | closefd=False) |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 533 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 534 | def test_read_closed(self): |
| 535 | with self.open(support.TESTFN, "w") as f: |
Christian Heimes | ecc42a2 | 2008-11-05 19:30:32 +0000 | [diff] [blame] | 536 | f.write("egg\n") |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 537 | with self.open(support.TESTFN, "r") as f: |
| 538 | file = self.open(f.fileno(), "r", closefd=False) |
Christian Heimes | ecc42a2 | 2008-11-05 19:30:32 +0000 | [diff] [blame] | 539 | 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 Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 546 | self.assertRaises(ValueError, self.open, support.TESTFN, "r", closefd=False) |
Christian Heimes | ecc42a2 | 2008-11-05 19:30:32 +0000 | [diff] [blame] | 547 | |
| 548 | def test_closefd_attr(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 549 | with self.open(support.TESTFN, "wb") as f: |
Christian Heimes | ecc42a2 | 2008-11-05 19:30:32 +0000 | [diff] [blame] | 550 | f.write(b"egg\n") |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 551 | with self.open(support.TESTFN, "r") as f: |
Christian Heimes | ecc42a2 | 2008-11-05 19:30:32 +0000 | [diff] [blame] | 552 | self.assertEqual(f.buffer.raw.closefd, True) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 553 | file = self.open(f.fileno(), "r", closefd=False) |
Christian Heimes | ecc42a2 | 2008-11-05 19:30:32 +0000 | [diff] [blame] | 554 | self.assertEqual(file.buffer.raw.closefd, False) |
| 555 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 556 | def test_garbage_collection(self): |
| 557 | # FileIO objects are collected, and collecting them flushes |
| 558 | # all data to disk. |
Benjamin Peterson | ebe5d8a | 2010-10-31 01:30:11 +0000 | [diff] [blame] | 559 | 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 Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 566 | self.assertTrue(wr() is None, wr) |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 567 | with self.open(support.TESTFN, "rb") as f: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 568 | self.assertEqual(f.read(), b"abcxxx") |
Christian Heimes | ecc42a2 | 2008-11-05 19:30:32 +0000 | [diff] [blame] | 569 | |
Antoine Pitrou | 7d037a7 | 2009-03-29 18:55:12 +0000 | [diff] [blame] | 570 | 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 Pitrou | c50cb8e | 2009-04-19 00:10:36 +0000 | [diff] [blame] | 574 | self.skipTest("{0} does not exist".format(zero)) |
Antoine Pitrou | 7d037a7 | 2009-03-29 18:55:12 +0000 | [diff] [blame] | 575 | if sys.maxsize > 0x7FFFFFFF: |
Antoine Pitrou | c50cb8e | 2009-04-19 00:10:36 +0000 | [diff] [blame] | 576 | self.skipTest("test can only run in a 32-bit address space") |
Antoine Pitrou | 7d037a7 | 2009-03-29 18:55:12 +0000 | [diff] [blame] | 577 | if support.real_max_memuse < support._2G: |
Antoine Pitrou | c50cb8e | 2009-04-19 00:10:36 +0000 | [diff] [blame] | 578 | self.skipTest("test requires at least 2GB of memory") |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 579 | with self.open(zero, "rb", buffering=0) as f: |
Antoine Pitrou | 7d037a7 | 2009-03-29 18:55:12 +0000 | [diff] [blame] | 580 | self.assertRaises(OverflowError, f.read) |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 581 | with self.open(zero, "rb") as f: |
Antoine Pitrou | 7d037a7 | 2009-03-29 18:55:12 +0000 | [diff] [blame] | 582 | self.assertRaises(OverflowError, f.read) |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 583 | with self.open(zero, "r") as f: |
Antoine Pitrou | 7d037a7 | 2009-03-29 18:55:12 +0000 | [diff] [blame] | 584 | self.assertRaises(OverflowError, f.read) |
| 585 | |
Antoine Pitrou | 6be8876 | 2010-05-03 16:48:20 +0000 | [diff] [blame] | 586 | 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 Pitrou | 328ec74 | 2010-09-14 18:37:24 +0000 | [diff] [blame] | 600 | 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 Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 613 | class CIOTest(IOTest): |
Antoine Pitrou | 84f1b17 | 2011-07-12 21:57:15 +0200 | [diff] [blame] | 614 | |
| 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 Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 632 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 633 | class PyIOTest(IOTest): |
| 634 | pass |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 635 | |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 636 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 637 | class CommonBufferedTests: |
| 638 | # Tests common to BufferedReader, BufferedWriter and BufferedRandom |
| 639 | |
Benjamin Peterson | d2e0c79 | 2009-05-01 20:40:59 +0000 | [diff] [blame] | 640 | 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 Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 646 | def test_fileno(self): |
| 647 | rawio = self.MockRawIO() |
| 648 | bufio = self.tp(rawio) |
| 649 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 650 | self.assertEqual(42, bufio.fileno()) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 651 | |
| 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 Peterson | 24fb1d0 | 2009-04-24 23:26:21 +0000 | [diff] [blame] | 686 | support.gc_collect() |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 687 | 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 Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 716 | self.assertTrue(s.startswith("Exception IOError: "), s) |
| 717 | self.assertTrue(s.endswith(" ignored"), s) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 718 | |
Antoine Pitrou | 716c444 | 2009-05-23 19:04:03 +0000 | [diff] [blame] | 719 | 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 Pitrou | 6be8876 | 2010-05-03 16:48:20 +0000 | [diff] [blame] | 729 | 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 Pitrou | 0d739d7 | 2010-09-05 23:01:12 +0000 | [diff] [blame] | 745 | 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 Pitrou | 7f8f418 | 2010-12-21 21:20:59 +0000 | [diff] [blame] | 750 | 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 Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 757 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 758 | class BufferedReaderTest(unittest.TestCase, CommonBufferedTests): |
| 759 | read_mode = "rb" |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 760 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 761 | 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 Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 767 | self.assertEqual(b"abc", bufio.read()) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 768 | 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 Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 773 | self.assertEqual(b"abc", bufio.read()) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 774 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 775 | def test_read(self): |
Benjamin Peterson | bf5ff76 | 2009-12-13 19:25:34 +0000 | [diff] [blame] | 776 | for arg in (None, 7): |
| 777 | rawio = self.MockRawIO((b"abc", b"d", b"efg")) |
| 778 | bufio = self.tp(rawio) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 779 | self.assertEqual(b"abcdefg", bufio.read(arg)) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 780 | # Invalid args |
| 781 | self.assertRaises(ValueError, bufio.read, -2) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 782 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 783 | def test_read1(self): |
| 784 | rawio = self.MockRawIO((b"abc", b"d", b"efg")) |
| 785 | bufio = self.tp(rawio) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 786 | 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 Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 797 | # 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 Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 804 | 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") |
Antoine Pitrou | 3486a98 | 2011-05-12 01:57:53 +0200 | [diff] [blame] | 814 | rawio = self.MockRawIO((b"abc", None)) |
| 815 | bufio = self.tp(rawio) |
| 816 | self.assertEqual(bufio.readinto(b), 2) |
| 817 | self.assertEqual(b, b"ab") |
| 818 | self.assertEqual(bufio.readinto(b), 1) |
| 819 | self.assertEqual(b, b"cb") |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 820 | |
Benjamin Peterson | bf5ff76 | 2009-12-13 19:25:34 +0000 | [diff] [blame] | 821 | def test_readlines(self): |
| 822 | def bufio(): |
| 823 | rawio = self.MockRawIO((b"abc\n", b"d\n", b"ef")) |
| 824 | return self.tp(rawio) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 825 | self.assertEqual(bufio().readlines(), [b"abc\n", b"d\n", b"ef"]) |
| 826 | self.assertEqual(bufio().readlines(5), [b"abc\n", b"d\n"]) |
| 827 | self.assertEqual(bufio().readlines(None), [b"abc\n", b"d\n", b"ef"]) |
Benjamin Peterson | bf5ff76 | 2009-12-13 19:25:34 +0000 | [diff] [blame] | 828 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 829 | def test_buffering(self): |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 830 | data = b"abcdefghi" |
| 831 | dlen = len(data) |
| 832 | |
| 833 | tests = [ |
| 834 | [ 100, [ 3, 1, 4, 8 ], [ dlen, 0 ] ], |
| 835 | [ 100, [ 3, 3, 3], [ dlen ] ], |
| 836 | [ 4, [ 1, 2, 4, 2 ], [ 4, 4, 1 ] ], |
| 837 | ] |
| 838 | |
| 839 | for bufsize, buf_read_sizes, raw_read_sizes in tests: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 840 | rawio = self.MockFileIO(data) |
| 841 | bufio = self.tp(rawio, buffer_size=bufsize) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 842 | pos = 0 |
| 843 | for nbytes in buf_read_sizes: |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 844 | self.assertEqual(bufio.read(nbytes), data[pos:pos+nbytes]) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 845 | pos += nbytes |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 846 | # this is mildly implementation-dependent |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 847 | self.assertEqual(rawio.read_history, raw_read_sizes) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 848 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 849 | def test_read_non_blocking(self): |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 850 | # Inject some None's in there to simulate EWOULDBLOCK |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 851 | rawio = self.MockRawIO((b"abc", b"d", None, b"efg", None, None, None)) |
| 852 | bufio = self.tp(rawio) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 853 | self.assertEqual(b"abcd", bufio.read(6)) |
| 854 | self.assertEqual(b"e", bufio.read(1)) |
| 855 | self.assertEqual(b"fg", bufio.read()) |
| 856 | self.assertEqual(b"", bufio.peek(1)) |
Victor Stinner | a80987f | 2011-05-25 22:47:16 +0200 | [diff] [blame] | 857 | self.assertIsNone(bufio.read()) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 858 | self.assertEqual(b"", bufio.read()) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 859 | |
Victor Stinner | a80987f | 2011-05-25 22:47:16 +0200 | [diff] [blame] | 860 | rawio = self.MockRawIO((b"a", None, None)) |
| 861 | self.assertEqual(b"a", rawio.readall()) |
| 862 | self.assertIsNone(rawio.readall()) |
| 863 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 864 | def test_read_past_eof(self): |
| 865 | rawio = self.MockRawIO((b"abc", b"d", b"efg")) |
| 866 | bufio = self.tp(rawio) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 867 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 868 | self.assertEqual(b"abcdefg", bufio.read(9000)) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 869 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 870 | def test_read_all(self): |
| 871 | rawio = self.MockRawIO((b"abc", b"d", b"efg")) |
| 872 | bufio = self.tp(rawio) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 873 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 874 | self.assertEqual(b"abcdefg", bufio.read()) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 875 | |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 876 | @unittest.skipUnless(threading, 'Threading required for this test.') |
Antoine Pitrou | 5bc4fa7 | 2010-10-14 15:34:31 +0000 | [diff] [blame] | 877 | @support.requires_resource('cpu') |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 878 | def test_threads(self): |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 879 | try: |
| 880 | # Write out many bytes with exactly the same number of 0's, |
| 881 | # 1's... 255's. This will help us check that concurrent reading |
| 882 | # doesn't duplicate or forget contents. |
| 883 | N = 1000 |
| 884 | l = list(range(256)) * N |
| 885 | random.shuffle(l) |
| 886 | s = bytes(bytearray(l)) |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 887 | with self.open(support.TESTFN, "wb") as f: |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 888 | f.write(s) |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 889 | with self.open(support.TESTFN, self.read_mode, buffering=0) as raw: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 890 | bufio = self.tp(raw, 8) |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 891 | errors = [] |
| 892 | results = [] |
| 893 | def f(): |
| 894 | try: |
| 895 | # Intra-buffer read then buffer-flushing read |
| 896 | for n in cycle([1, 19]): |
| 897 | s = bufio.read(n) |
| 898 | if not s: |
| 899 | break |
| 900 | # list.append() is atomic |
| 901 | results.append(s) |
| 902 | except Exception as e: |
| 903 | errors.append(e) |
| 904 | raise |
| 905 | threads = [threading.Thread(target=f) for x in range(20)] |
| 906 | for t in threads: |
| 907 | t.start() |
| 908 | time.sleep(0.02) # yield |
| 909 | for t in threads: |
| 910 | t.join() |
| 911 | self.assertFalse(errors, |
| 912 | "the following exceptions were caught: %r" % errors) |
| 913 | s = b''.join(results) |
| 914 | for i in range(256): |
| 915 | c = bytes(bytearray([i])) |
| 916 | self.assertEqual(s.count(c), N) |
| 917 | finally: |
| 918 | support.unlink(support.TESTFN) |
| 919 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 920 | def test_misbehaved_io(self): |
| 921 | rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg")) |
| 922 | bufio = self.tp(rawio) |
| 923 | self.assertRaises(IOError, bufio.seek, 0) |
| 924 | self.assertRaises(IOError, bufio.tell) |
| 925 | |
Antoine Pitrou | 32cfede | 2010-08-11 13:31:33 +0000 | [diff] [blame] | 926 | def test_no_extraneous_read(self): |
| 927 | # Issue #9550; when the raw IO object has satisfied the read request, |
| 928 | # we should not issue any additional reads, otherwise it may block |
| 929 | # (e.g. socket). |
| 930 | bufsize = 16 |
| 931 | for n in (2, bufsize - 1, bufsize, bufsize + 1, bufsize * 2): |
| 932 | rawio = self.MockRawIO([b"x" * n]) |
| 933 | bufio = self.tp(rawio, bufsize) |
| 934 | self.assertEqual(bufio.read(n), b"x" * n) |
| 935 | # Simple case: one raw read is enough to satisfy the request. |
| 936 | self.assertEqual(rawio._extraneous_reads, 0, |
| 937 | "failed for {}: {} != 0".format(n, rawio._extraneous_reads)) |
| 938 | # A more complex case where two raw reads are needed to satisfy |
| 939 | # the request. |
| 940 | rawio = self.MockRawIO([b"x" * (n - 1), b"x"]) |
| 941 | bufio = self.tp(rawio, bufsize) |
| 942 | self.assertEqual(bufio.read(n), b"x" * n) |
| 943 | self.assertEqual(rawio._extraneous_reads, 0, |
| 944 | "failed for {}: {} != 0".format(n, rawio._extraneous_reads)) |
| 945 | |
| 946 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 947 | class CBufferedReaderTest(BufferedReaderTest): |
| 948 | tp = io.BufferedReader |
| 949 | |
| 950 | def test_constructor(self): |
| 951 | BufferedReaderTest.test_constructor(self) |
| 952 | # The allocation can succeed on 32-bit builds, e.g. with more |
| 953 | # than 2GB RAM and a 64-bit kernel. |
| 954 | if sys.maxsize > 0x7FFFFFFF: |
| 955 | rawio = self.MockRawIO() |
| 956 | bufio = self.tp(rawio) |
| 957 | self.assertRaises((OverflowError, MemoryError, ValueError), |
| 958 | bufio.__init__, rawio, sys.maxsize) |
| 959 | |
| 960 | def test_initialization(self): |
| 961 | rawio = self.MockRawIO([b"abc"]) |
| 962 | bufio = self.tp(rawio) |
| 963 | self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0) |
| 964 | self.assertRaises(ValueError, bufio.read) |
| 965 | self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16) |
| 966 | self.assertRaises(ValueError, bufio.read) |
| 967 | self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1) |
| 968 | self.assertRaises(ValueError, bufio.read) |
| 969 | |
| 970 | def test_misbehaved_io_read(self): |
| 971 | rawio = self.MisbehavedRawIO((b"abc", b"d", b"efg")) |
| 972 | bufio = self.tp(rawio) |
| 973 | # _pyio.BufferedReader seems to implement reading different, so that |
| 974 | # checking this is not so easy. |
| 975 | self.assertRaises(IOError, bufio.read, 10) |
| 976 | |
| 977 | def test_garbage_collection(self): |
| 978 | # C BufferedReader objects are collected. |
| 979 | # The Python version has __del__, so it ends into gc.garbage instead |
| 980 | rawio = self.FileIO(support.TESTFN, "w+b") |
| 981 | f = self.tp(rawio) |
| 982 | f.f = f |
| 983 | wr = weakref.ref(f) |
| 984 | del f |
Benjamin Peterson | 45cec32 | 2009-04-24 23:14:50 +0000 | [diff] [blame] | 985 | support.gc_collect() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 986 | self.assertTrue(wr() is None, wr) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 987 | |
| 988 | class PyBufferedReaderTest(BufferedReaderTest): |
| 989 | tp = pyio.BufferedReader |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 990 | |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 991 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 992 | class BufferedWriterTest(unittest.TestCase, CommonBufferedTests): |
| 993 | write_mode = "wb" |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 994 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 995 | def test_constructor(self): |
| 996 | rawio = self.MockRawIO() |
| 997 | bufio = self.tp(rawio) |
| 998 | bufio.__init__(rawio) |
| 999 | bufio.__init__(rawio, buffer_size=1024) |
| 1000 | bufio.__init__(rawio, buffer_size=16) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1001 | self.assertEqual(3, bufio.write(b"abc")) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1002 | bufio.flush() |
| 1003 | self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0) |
| 1004 | self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16) |
| 1005 | self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1) |
| 1006 | bufio.__init__(rawio) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1007 | self.assertEqual(3, bufio.write(b"ghi")) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1008 | bufio.flush() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1009 | self.assertEqual(b"".join(rawio._write_stack), b"abcghi") |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1010 | |
Benjamin Peterson | d2e0c79 | 2009-05-01 20:40:59 +0000 | [diff] [blame] | 1011 | def test_detach_flush(self): |
| 1012 | raw = self.MockRawIO() |
| 1013 | buf = self.tp(raw) |
| 1014 | buf.write(b"howdy!") |
| 1015 | self.assertFalse(raw._write_stack) |
| 1016 | buf.detach() |
| 1017 | self.assertEqual(raw._write_stack, [b"howdy!"]) |
| 1018 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1019 | def test_write(self): |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 1020 | # Write to the buffered IO but don't overflow the buffer. |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1021 | writer = self.MockRawIO() |
| 1022 | bufio = self.tp(writer, 8) |
Guido van Rossum | 76c5d4d | 2007-04-06 19:10:29 +0000 | [diff] [blame] | 1023 | bufio.write(b"abc") |
Guido van Rossum | 76c5d4d | 2007-04-06 19:10:29 +0000 | [diff] [blame] | 1024 | self.assertFalse(writer._write_stack) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 1025 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1026 | def test_write_overflow(self): |
| 1027 | writer = self.MockRawIO() |
| 1028 | bufio = self.tp(writer, 8) |
| 1029 | contents = b"abcdefghijklmnop" |
| 1030 | for n in range(0, len(contents), 3): |
| 1031 | bufio.write(contents[n:n+3]) |
| 1032 | flushed = b"".join(writer._write_stack) |
| 1033 | # At least (total - 8) bytes were implicitly flushed, perhaps more |
| 1034 | # depending on the implementation. |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1035 | self.assertTrue(flushed.startswith(contents[:-8]), flushed) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 1036 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1037 | def check_writes(self, intermediate_func): |
| 1038 | # Lots of writes, test the flushed output is as expected. |
| 1039 | contents = bytes(range(256)) * 1000 |
| 1040 | n = 0 |
| 1041 | writer = self.MockRawIO() |
| 1042 | bufio = self.tp(writer, 13) |
| 1043 | # Generator of write sizes: repeat each N 15 times then proceed to N+1 |
| 1044 | def gen_sizes(): |
| 1045 | for size in count(1): |
| 1046 | for i in range(15): |
| 1047 | yield size |
| 1048 | sizes = gen_sizes() |
| 1049 | while n < len(contents): |
| 1050 | size = min(next(sizes), len(contents) - n) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1051 | self.assertEqual(bufio.write(contents[n:n+size]), size) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1052 | intermediate_func(bufio) |
| 1053 | n += size |
| 1054 | bufio.flush() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1055 | self.assertEqual(contents, b"".join(writer._write_stack)) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 1056 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1057 | def test_writes(self): |
| 1058 | self.check_writes(lambda bufio: None) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 1059 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1060 | def test_writes_and_flushes(self): |
| 1061 | self.check_writes(lambda bufio: bufio.flush()) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1062 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1063 | def test_writes_and_seeks(self): |
| 1064 | def _seekabs(bufio): |
| 1065 | pos = bufio.tell() |
| 1066 | bufio.seek(pos + 1, 0) |
| 1067 | bufio.seek(pos - 1, 0) |
| 1068 | bufio.seek(pos, 0) |
| 1069 | self.check_writes(_seekabs) |
| 1070 | def _seekrel(bufio): |
| 1071 | pos = bufio.seek(0, 1) |
| 1072 | bufio.seek(+1, 1) |
| 1073 | bufio.seek(-1, 1) |
| 1074 | bufio.seek(pos, 0) |
| 1075 | self.check_writes(_seekrel) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1076 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1077 | def test_writes_and_truncates(self): |
| 1078 | self.check_writes(lambda bufio: bufio.truncate(bufio.tell())) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1079 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1080 | def test_write_non_blocking(self): |
| 1081 | raw = self.MockNonBlockWriterIO() |
Benjamin Peterson | 59406a9 | 2009-03-26 17:10:29 +0000 | [diff] [blame] | 1082 | bufio = self.tp(raw, 8) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1083 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1084 | self.assertEqual(bufio.write(b"abcd"), 4) |
| 1085 | self.assertEqual(bufio.write(b"efghi"), 5) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1086 | # 1 byte will be written, the rest will be buffered |
| 1087 | raw.block_on(b"k") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1088 | self.assertEqual(bufio.write(b"jklmn"), 5) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1089 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1090 | # 8 bytes will be written, 8 will be buffered and the rest will be lost |
| 1091 | raw.block_on(b"0") |
| 1092 | try: |
| 1093 | bufio.write(b"opqrwxyz0123456789") |
| 1094 | except self.BlockingIOError as e: |
| 1095 | written = e.characters_written |
| 1096 | else: |
| 1097 | self.fail("BlockingIOError should have been raised") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1098 | self.assertEqual(written, 16) |
| 1099 | self.assertEqual(raw.pop_written(), |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1100 | b"abcdefghijklmnopqrwxyz") |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1101 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1102 | self.assertEqual(bufio.write(b"ABCDEFGHI"), 9) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1103 | s = raw.pop_written() |
| 1104 | # Previously buffered bytes were flushed |
| 1105 | self.assertTrue(s.startswith(b"01234567A"), s) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1106 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1107 | def test_write_and_rewind(self): |
| 1108 | raw = io.BytesIO() |
| 1109 | bufio = self.tp(raw, 4) |
| 1110 | self.assertEqual(bufio.write(b"abcdef"), 6) |
| 1111 | self.assertEqual(bufio.tell(), 6) |
| 1112 | bufio.seek(0, 0) |
| 1113 | self.assertEqual(bufio.write(b"XY"), 2) |
| 1114 | bufio.seek(6, 0) |
| 1115 | self.assertEqual(raw.getvalue(), b"XYcdef") |
| 1116 | self.assertEqual(bufio.write(b"123456"), 6) |
| 1117 | bufio.flush() |
| 1118 | self.assertEqual(raw.getvalue(), b"XYcdef123456") |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 1119 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1120 | def test_flush(self): |
| 1121 | writer = self.MockRawIO() |
| 1122 | bufio = self.tp(writer, 8) |
Guido van Rossum | 76c5d4d | 2007-04-06 19:10:29 +0000 | [diff] [blame] | 1123 | bufio.write(b"abc") |
| 1124 | bufio.flush() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1125 | self.assertEqual(b"abc", writer._write_stack[0]) |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 1126 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1127 | def test_destructor(self): |
| 1128 | writer = self.MockRawIO() |
| 1129 | bufio = self.tp(writer, 8) |
| 1130 | bufio.write(b"abc") |
| 1131 | del bufio |
Benjamin Peterson | 24fb1d0 | 2009-04-24 23:26:21 +0000 | [diff] [blame] | 1132 | support.gc_collect() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1133 | self.assertEqual(b"abc", writer._write_stack[0]) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1134 | |
| 1135 | def test_truncate(self): |
| 1136 | # Truncate implicitly flushes the buffer. |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 1137 | with self.open(support.TESTFN, self.write_mode, buffering=0) as raw: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1138 | bufio = self.tp(raw, 8) |
| 1139 | bufio.write(b"abcdef") |
| 1140 | self.assertEqual(bufio.truncate(3), 3) |
Antoine Pitrou | 905a2ff | 2010-01-31 22:47:27 +0000 | [diff] [blame] | 1141 | self.assertEqual(bufio.tell(), 6) |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 1142 | with self.open(support.TESTFN, "rb", buffering=0) as f: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1143 | self.assertEqual(f.read(), b"abc") |
| 1144 | |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 1145 | @unittest.skipUnless(threading, 'Threading required for this test.') |
Antoine Pitrou | 5bc4fa7 | 2010-10-14 15:34:31 +0000 | [diff] [blame] | 1146 | @support.requires_resource('cpu') |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1147 | def test_threads(self): |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 1148 | try: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1149 | # Write out many bytes from many threads and test they were |
| 1150 | # all flushed. |
| 1151 | N = 1000 |
| 1152 | contents = bytes(range(256)) * N |
| 1153 | sizes = cycle([1, 19]) |
| 1154 | n = 0 |
| 1155 | queue = deque() |
| 1156 | while n < len(contents): |
| 1157 | size = next(sizes) |
| 1158 | queue.append(contents[n:n+size]) |
| 1159 | n += size |
| 1160 | del contents |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 1161 | # We use a real file object because it allows us to |
| 1162 | # exercise situations where the GIL is released before |
| 1163 | # writing the buffer to the raw streams. This is in addition |
| 1164 | # to concurrency issues due to switching threads in the middle |
| 1165 | # of Python code. |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 1166 | with self.open(support.TESTFN, self.write_mode, buffering=0) as raw: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1167 | bufio = self.tp(raw, 8) |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 1168 | errors = [] |
| 1169 | def f(): |
| 1170 | try: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1171 | while True: |
| 1172 | try: |
| 1173 | s = queue.popleft() |
| 1174 | except IndexError: |
| 1175 | return |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 1176 | bufio.write(s) |
| 1177 | except Exception as e: |
| 1178 | errors.append(e) |
| 1179 | raise |
| 1180 | threads = [threading.Thread(target=f) for x in range(20)] |
| 1181 | for t in threads: |
| 1182 | t.start() |
| 1183 | time.sleep(0.02) # yield |
| 1184 | for t in threads: |
| 1185 | t.join() |
| 1186 | self.assertFalse(errors, |
| 1187 | "the following exceptions were caught: %r" % errors) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1188 | bufio.close() |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 1189 | with self.open(support.TESTFN, "rb") as f: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1190 | s = f.read() |
| 1191 | for i in range(256): |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1192 | self.assertEqual(s.count(bytes([i])), N) |
Antoine Pitrou | 8769576 | 2008-08-14 22:44:29 +0000 | [diff] [blame] | 1193 | finally: |
| 1194 | support.unlink(support.TESTFN) |
| 1195 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1196 | def test_misbehaved_io(self): |
| 1197 | rawio = self.MisbehavedRawIO() |
| 1198 | bufio = self.tp(rawio, 5) |
| 1199 | self.assertRaises(IOError, bufio.seek, 0) |
| 1200 | self.assertRaises(IOError, bufio.tell) |
| 1201 | self.assertRaises(IOError, bufio.write, b"abcdef") |
| 1202 | |
Benjamin Peterson | 59406a9 | 2009-03-26 17:10:29 +0000 | [diff] [blame] | 1203 | def test_max_buffer_size_deprecation(self): |
Florent Xicluna | 8fbddf1 | 2010-03-17 20:29:51 +0000 | [diff] [blame] | 1204 | with support.check_warnings(("max_buffer_size is deprecated", |
| 1205 | DeprecationWarning)): |
Benjamin Peterson | 59406a9 | 2009-03-26 17:10:29 +0000 | [diff] [blame] | 1206 | self.tp(self.MockRawIO(), 8, 12) |
Benjamin Peterson | 59406a9 | 2009-03-26 17:10:29 +0000 | [diff] [blame] | 1207 | |
| 1208 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1209 | class CBufferedWriterTest(BufferedWriterTest): |
| 1210 | tp = io.BufferedWriter |
| 1211 | |
| 1212 | def test_constructor(self): |
| 1213 | BufferedWriterTest.test_constructor(self) |
| 1214 | # The allocation can succeed on 32-bit builds, e.g. with more |
| 1215 | # than 2GB RAM and a 64-bit kernel. |
| 1216 | if sys.maxsize > 0x7FFFFFFF: |
| 1217 | rawio = self.MockRawIO() |
| 1218 | bufio = self.tp(rawio) |
| 1219 | self.assertRaises((OverflowError, MemoryError, ValueError), |
| 1220 | bufio.__init__, rawio, sys.maxsize) |
| 1221 | |
| 1222 | def test_initialization(self): |
| 1223 | rawio = self.MockRawIO() |
| 1224 | bufio = self.tp(rawio) |
| 1225 | self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=0) |
| 1226 | self.assertRaises(ValueError, bufio.write, b"def") |
| 1227 | self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-16) |
| 1228 | self.assertRaises(ValueError, bufio.write, b"def") |
| 1229 | self.assertRaises(ValueError, bufio.__init__, rawio, buffer_size=-1) |
| 1230 | self.assertRaises(ValueError, bufio.write, b"def") |
| 1231 | |
| 1232 | def test_garbage_collection(self): |
| 1233 | # C BufferedWriter objects are collected, and collecting them flushes |
| 1234 | # all data to disk. |
| 1235 | # The Python version has __del__, so it ends into gc.garbage instead |
| 1236 | rawio = self.FileIO(support.TESTFN, "w+b") |
| 1237 | f = self.tp(rawio) |
| 1238 | f.write(b"123xxx") |
| 1239 | f.x = f |
| 1240 | wr = weakref.ref(f) |
| 1241 | del f |
Benjamin Peterson | 24fb1d0 | 2009-04-24 23:26:21 +0000 | [diff] [blame] | 1242 | support.gc_collect() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1243 | self.assertTrue(wr() is None, wr) |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 1244 | with self.open(support.TESTFN, "rb") as f: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1245 | self.assertEqual(f.read(), b"123xxx") |
| 1246 | |
| 1247 | |
| 1248 | class PyBufferedWriterTest(BufferedWriterTest): |
| 1249 | tp = pyio.BufferedWriter |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 1250 | |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1251 | class BufferedRWPairTest(unittest.TestCase): |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 1252 | |
Antoine Pitrou | cf4c749 | 2009-04-19 00:09:36 +0000 | [diff] [blame] | 1253 | def test_constructor(self): |
| 1254 | pair = self.tp(self.MockRawIO(), self.MockRawIO()) |
Benjamin Peterson | 9203501 | 2008-12-27 16:00:54 +0000 | [diff] [blame] | 1255 | self.assertFalse(pair.closed) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1256 | |
Benjamin Peterson | d2e0c79 | 2009-05-01 20:40:59 +0000 | [diff] [blame] | 1257 | def test_detach(self): |
| 1258 | pair = self.tp(self.MockRawIO(), self.MockRawIO()) |
| 1259 | self.assertRaises(self.UnsupportedOperation, pair.detach) |
| 1260 | |
Antoine Pitrou | cf4c749 | 2009-04-19 00:09:36 +0000 | [diff] [blame] | 1261 | def test_constructor_max_buffer_size_deprecation(self): |
Florent Xicluna | 8fbddf1 | 2010-03-17 20:29:51 +0000 | [diff] [blame] | 1262 | with support.check_warnings(("max_buffer_size is deprecated", |
| 1263 | DeprecationWarning)): |
Benjamin Peterson | 59406a9 | 2009-03-26 17:10:29 +0000 | [diff] [blame] | 1264 | self.tp(self.MockRawIO(), self.MockRawIO(), 8, 12) |
Benjamin Peterson | 59406a9 | 2009-03-26 17:10:29 +0000 | [diff] [blame] | 1265 | |
Antoine Pitrou | cf4c749 | 2009-04-19 00:09:36 +0000 | [diff] [blame] | 1266 | def test_constructor_with_not_readable(self): |
| 1267 | class NotReadable(MockRawIO): |
| 1268 | def readable(self): |
| 1269 | return False |
| 1270 | |
| 1271 | self.assertRaises(IOError, self.tp, NotReadable(), self.MockRawIO()) |
| 1272 | |
| 1273 | def test_constructor_with_not_writeable(self): |
| 1274 | class NotWriteable(MockRawIO): |
| 1275 | def writable(self): |
| 1276 | return False |
| 1277 | |
| 1278 | self.assertRaises(IOError, self.tp, self.MockRawIO(), NotWriteable()) |
| 1279 | |
| 1280 | def test_read(self): |
| 1281 | pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO()) |
| 1282 | |
| 1283 | self.assertEqual(pair.read(3), b"abc") |
| 1284 | self.assertEqual(pair.read(1), b"d") |
| 1285 | self.assertEqual(pair.read(), b"ef") |
Benjamin Peterson | bf5ff76 | 2009-12-13 19:25:34 +0000 | [diff] [blame] | 1286 | pair = self.tp(self.BytesIO(b"abc"), self.MockRawIO()) |
| 1287 | self.assertEqual(pair.read(None), b"abc") |
| 1288 | |
| 1289 | def test_readlines(self): |
| 1290 | pair = lambda: self.tp(self.BytesIO(b"abc\ndef\nh"), self.MockRawIO()) |
| 1291 | self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"]) |
| 1292 | self.assertEqual(pair().readlines(), [b"abc\n", b"def\n", b"h"]) |
| 1293 | self.assertEqual(pair().readlines(5), [b"abc\n", b"def\n"]) |
Antoine Pitrou | cf4c749 | 2009-04-19 00:09:36 +0000 | [diff] [blame] | 1294 | |
| 1295 | def test_read1(self): |
| 1296 | # .read1() is delegated to the underlying reader object, so this test |
| 1297 | # can be shallow. |
| 1298 | pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO()) |
| 1299 | |
| 1300 | self.assertEqual(pair.read1(3), b"abc") |
| 1301 | |
| 1302 | def test_readinto(self): |
| 1303 | pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO()) |
| 1304 | |
| 1305 | data = bytearray(5) |
| 1306 | self.assertEqual(pair.readinto(data), 5) |
| 1307 | self.assertEqual(data, b"abcde") |
| 1308 | |
| 1309 | def test_write(self): |
| 1310 | w = self.MockRawIO() |
| 1311 | pair = self.tp(self.MockRawIO(), w) |
| 1312 | |
| 1313 | pair.write(b"abc") |
| 1314 | pair.flush() |
| 1315 | pair.write(b"def") |
| 1316 | pair.flush() |
| 1317 | self.assertEqual(w._write_stack, [b"abc", b"def"]) |
| 1318 | |
| 1319 | def test_peek(self): |
| 1320 | pair = self.tp(self.BytesIO(b"abcdef"), self.MockRawIO()) |
| 1321 | |
| 1322 | self.assertTrue(pair.peek(3).startswith(b"abc")) |
| 1323 | self.assertEqual(pair.read(3), b"abc") |
| 1324 | |
| 1325 | def test_readable(self): |
| 1326 | pair = self.tp(self.MockRawIO(), self.MockRawIO()) |
| 1327 | self.assertTrue(pair.readable()) |
| 1328 | |
| 1329 | def test_writeable(self): |
| 1330 | pair = self.tp(self.MockRawIO(), self.MockRawIO()) |
| 1331 | self.assertTrue(pair.writable()) |
| 1332 | |
| 1333 | def test_seekable(self): |
| 1334 | # BufferedRWPairs are never seekable, even if their readers and writers |
| 1335 | # are. |
| 1336 | pair = self.tp(self.MockRawIO(), self.MockRawIO()) |
| 1337 | self.assertFalse(pair.seekable()) |
| 1338 | |
| 1339 | # .flush() is delegated to the underlying writer object and has been |
| 1340 | # tested in the test_write method. |
| 1341 | |
| 1342 | def test_close_and_closed(self): |
| 1343 | pair = self.tp(self.MockRawIO(), self.MockRawIO()) |
| 1344 | self.assertFalse(pair.closed) |
| 1345 | pair.close() |
| 1346 | self.assertTrue(pair.closed) |
| 1347 | |
| 1348 | def test_isatty(self): |
| 1349 | class SelectableIsAtty(MockRawIO): |
| 1350 | def __init__(self, isatty): |
| 1351 | MockRawIO.__init__(self) |
| 1352 | self._isatty = isatty |
| 1353 | |
| 1354 | def isatty(self): |
| 1355 | return self._isatty |
| 1356 | |
| 1357 | pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(False)) |
| 1358 | self.assertFalse(pair.isatty()) |
| 1359 | |
| 1360 | pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(False)) |
| 1361 | self.assertTrue(pair.isatty()) |
| 1362 | |
| 1363 | pair = self.tp(SelectableIsAtty(False), SelectableIsAtty(True)) |
| 1364 | self.assertTrue(pair.isatty()) |
| 1365 | |
| 1366 | pair = self.tp(SelectableIsAtty(True), SelectableIsAtty(True)) |
| 1367 | self.assertTrue(pair.isatty()) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1368 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1369 | class CBufferedRWPairTest(BufferedRWPairTest): |
| 1370 | tp = io.BufferedRWPair |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 1371 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1372 | class PyBufferedRWPairTest(BufferedRWPairTest): |
| 1373 | tp = pyio.BufferedRWPair |
Guido van Rossum | a9e2024 | 2007-03-08 00:43:48 +0000 | [diff] [blame] | 1374 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1375 | |
| 1376 | class BufferedRandomTest(BufferedReaderTest, BufferedWriterTest): |
| 1377 | read_mode = "rb+" |
| 1378 | write_mode = "wb+" |
| 1379 | |
| 1380 | def test_constructor(self): |
| 1381 | BufferedReaderTest.test_constructor(self) |
| 1382 | BufferedWriterTest.test_constructor(self) |
| 1383 | |
| 1384 | def test_read_and_write(self): |
| 1385 | raw = self.MockRawIO((b"asdf", b"ghjk")) |
Benjamin Peterson | 59406a9 | 2009-03-26 17:10:29 +0000 | [diff] [blame] | 1386 | rw = self.tp(raw, 8) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1387 | |
| 1388 | self.assertEqual(b"as", rw.read(2)) |
| 1389 | rw.write(b"ddd") |
| 1390 | rw.write(b"eee") |
Guido van Rossum | 76c5d4d | 2007-04-06 19:10:29 +0000 | [diff] [blame] | 1391 | self.assertFalse(raw._write_stack) # Buffer writes |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1392 | self.assertEqual(b"ghjk", rw.read()) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1393 | self.assertEqual(b"dddeee", raw._write_stack[0]) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1394 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1395 | def test_seek_and_tell(self): |
| 1396 | raw = self.BytesIO(b"asdfghjkl") |
| 1397 | rw = self.tp(raw) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1398 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1399 | self.assertEqual(b"as", rw.read(2)) |
| 1400 | self.assertEqual(2, rw.tell()) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1401 | rw.seek(0, 0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1402 | self.assertEqual(b"asdf", rw.read(4)) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1403 | |
| 1404 | rw.write(b"asdf") |
| 1405 | rw.seek(0, 0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1406 | self.assertEqual(b"asdfasdfl", rw.read()) |
| 1407 | self.assertEqual(9, rw.tell()) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1408 | rw.seek(-4, 2) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1409 | self.assertEqual(5, rw.tell()) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1410 | rw.seek(2, 1) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1411 | self.assertEqual(7, rw.tell()) |
| 1412 | self.assertEqual(b"fl", rw.read(11)) |
Christian Heimes | 8e42a0a | 2007-11-08 18:04:45 +0000 | [diff] [blame] | 1413 | self.assertRaises(TypeError, rw.seek, 0.0) |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 1414 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1415 | def check_flush_and_read(self, read_func): |
| 1416 | raw = self.BytesIO(b"abcdefghi") |
| 1417 | bufio = self.tp(raw) |
| 1418 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1419 | self.assertEqual(b"ab", read_func(bufio, 2)) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1420 | bufio.write(b"12") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1421 | self.assertEqual(b"ef", read_func(bufio, 2)) |
| 1422 | self.assertEqual(6, bufio.tell()) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1423 | bufio.flush() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1424 | self.assertEqual(6, bufio.tell()) |
| 1425 | self.assertEqual(b"ghi", read_func(bufio)) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1426 | raw.seek(0, 0) |
| 1427 | raw.write(b"XYZ") |
| 1428 | # flush() resets the read buffer |
| 1429 | bufio.flush() |
| 1430 | bufio.seek(0, 0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1431 | self.assertEqual(b"XYZ", read_func(bufio, 3)) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1432 | |
| 1433 | def test_flush_and_read(self): |
| 1434 | self.check_flush_and_read(lambda bufio, *args: bufio.read(*args)) |
| 1435 | |
| 1436 | def test_flush_and_readinto(self): |
| 1437 | def _readinto(bufio, n=-1): |
| 1438 | b = bytearray(n if n >= 0 else 9999) |
| 1439 | n = bufio.readinto(b) |
| 1440 | return bytes(b[:n]) |
| 1441 | self.check_flush_and_read(_readinto) |
| 1442 | |
| 1443 | def test_flush_and_peek(self): |
| 1444 | def _peek(bufio, n=-1): |
| 1445 | # This relies on the fact that the buffer can contain the whole |
| 1446 | # raw stream, otherwise peek() can return less. |
| 1447 | b = bufio.peek(n) |
| 1448 | if n != -1: |
| 1449 | b = b[:n] |
| 1450 | bufio.seek(len(b), 1) |
| 1451 | return b |
| 1452 | self.check_flush_and_read(_peek) |
| 1453 | |
| 1454 | def test_flush_and_write(self): |
| 1455 | raw = self.BytesIO(b"abcdefghi") |
| 1456 | bufio = self.tp(raw) |
| 1457 | |
| 1458 | bufio.write(b"123") |
| 1459 | bufio.flush() |
| 1460 | bufio.write(b"45") |
| 1461 | bufio.flush() |
| 1462 | bufio.seek(0, 0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1463 | self.assertEqual(b"12345fghi", raw.getvalue()) |
| 1464 | self.assertEqual(b"12345fghi", bufio.read()) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1465 | |
| 1466 | def test_threads(self): |
| 1467 | BufferedReaderTest.test_threads(self) |
| 1468 | BufferedWriterTest.test_threads(self) |
| 1469 | |
| 1470 | def test_writes_and_peek(self): |
| 1471 | def _peek(bufio): |
| 1472 | bufio.peek(1) |
| 1473 | self.check_writes(_peek) |
| 1474 | def _peek(bufio): |
| 1475 | pos = bufio.tell() |
| 1476 | bufio.seek(-1, 1) |
| 1477 | bufio.peek(1) |
| 1478 | bufio.seek(pos, 0) |
| 1479 | self.check_writes(_peek) |
| 1480 | |
| 1481 | def test_writes_and_reads(self): |
| 1482 | def _read(bufio): |
| 1483 | bufio.seek(-1, 1) |
| 1484 | bufio.read(1) |
| 1485 | self.check_writes(_read) |
| 1486 | |
| 1487 | def test_writes_and_read1s(self): |
| 1488 | def _read1(bufio): |
| 1489 | bufio.seek(-1, 1) |
| 1490 | bufio.read1(1) |
| 1491 | self.check_writes(_read1) |
| 1492 | |
| 1493 | def test_writes_and_readintos(self): |
| 1494 | def _read(bufio): |
| 1495 | bufio.seek(-1, 1) |
| 1496 | bufio.readinto(bytearray(1)) |
| 1497 | self.check_writes(_read) |
| 1498 | |
Antoine Pitrou | a0ceb73 | 2009-08-06 20:29:56 +0000 | [diff] [blame] | 1499 | def test_write_after_readahead(self): |
| 1500 | # Issue #6629: writing after the buffer was filled by readahead should |
| 1501 | # first rewind the raw stream. |
| 1502 | for overwrite_size in [1, 5]: |
| 1503 | raw = self.BytesIO(b"A" * 10) |
| 1504 | bufio = self.tp(raw, 4) |
| 1505 | # Trigger readahead |
| 1506 | self.assertEqual(bufio.read(1), b"A") |
| 1507 | self.assertEqual(bufio.tell(), 1) |
| 1508 | # Overwriting should rewind the raw stream if it needs so |
| 1509 | bufio.write(b"B" * overwrite_size) |
| 1510 | self.assertEqual(bufio.tell(), overwrite_size + 1) |
| 1511 | # If the write size was smaller than the buffer size, flush() and |
| 1512 | # check that rewind happens. |
| 1513 | bufio.flush() |
| 1514 | self.assertEqual(bufio.tell(), overwrite_size + 1) |
| 1515 | s = raw.getvalue() |
| 1516 | self.assertEqual(s, |
| 1517 | b"A" + b"B" * overwrite_size + b"A" * (9 - overwrite_size)) |
| 1518 | |
Antoine Pitrou | 7c40489 | 2011-05-13 00:13:33 +0200 | [diff] [blame] | 1519 | def test_write_rewind_write(self): |
| 1520 | # Various combinations of reading / writing / seeking backwards / writing again |
| 1521 | def mutate(bufio, pos1, pos2): |
| 1522 | assert pos2 >= pos1 |
| 1523 | # Fill the buffer |
| 1524 | bufio.seek(pos1) |
| 1525 | bufio.read(pos2 - pos1) |
| 1526 | bufio.write(b'\x02') |
| 1527 | # This writes earlier than the previous write, but still inside |
| 1528 | # the buffer. |
| 1529 | bufio.seek(pos1) |
| 1530 | bufio.write(b'\x01') |
| 1531 | |
| 1532 | b = b"\x80\x81\x82\x83\x84" |
| 1533 | for i in range(0, len(b)): |
| 1534 | for j in range(i, len(b)): |
| 1535 | raw = self.BytesIO(b) |
| 1536 | bufio = self.tp(raw, 100) |
| 1537 | mutate(bufio, i, j) |
| 1538 | bufio.flush() |
| 1539 | expected = bytearray(b) |
| 1540 | expected[j] = 2 |
| 1541 | expected[i] = 1 |
| 1542 | self.assertEqual(raw.getvalue(), expected, |
| 1543 | "failed result for i=%d, j=%d" % (i, j)) |
| 1544 | |
Antoine Pitrou | 905a2ff | 2010-01-31 22:47:27 +0000 | [diff] [blame] | 1545 | def test_truncate_after_read_or_write(self): |
| 1546 | raw = self.BytesIO(b"A" * 10) |
| 1547 | bufio = self.tp(raw, 100) |
| 1548 | self.assertEqual(bufio.read(2), b"AA") # the read buffer gets filled |
| 1549 | self.assertEqual(bufio.truncate(), 2) |
| 1550 | self.assertEqual(bufio.write(b"BB"), 2) # the write buffer increases |
| 1551 | self.assertEqual(bufio.truncate(), 4) |
| 1552 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1553 | def test_misbehaved_io(self): |
| 1554 | BufferedReaderTest.test_misbehaved_io(self) |
| 1555 | BufferedWriterTest.test_misbehaved_io(self) |
| 1556 | |
Antoine Pitrou | 0d739d7 | 2010-09-05 23:01:12 +0000 | [diff] [blame] | 1557 | # You can't construct a BufferedRandom over a non-seekable stream. |
| 1558 | test_unseekable = None |
| 1559 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1560 | class CBufferedRandomTest(BufferedRandomTest): |
| 1561 | tp = io.BufferedRandom |
| 1562 | |
| 1563 | def test_constructor(self): |
| 1564 | BufferedRandomTest.test_constructor(self) |
| 1565 | # The allocation can succeed on 32-bit builds, e.g. with more |
| 1566 | # than 2GB RAM and a 64-bit kernel. |
| 1567 | if sys.maxsize > 0x7FFFFFFF: |
| 1568 | rawio = self.MockRawIO() |
| 1569 | bufio = self.tp(rawio) |
| 1570 | self.assertRaises((OverflowError, MemoryError, ValueError), |
| 1571 | bufio.__init__, rawio, sys.maxsize) |
| 1572 | |
| 1573 | def test_garbage_collection(self): |
| 1574 | CBufferedReaderTest.test_garbage_collection(self) |
| 1575 | CBufferedWriterTest.test_garbage_collection(self) |
| 1576 | |
| 1577 | class PyBufferedRandomTest(BufferedRandomTest): |
| 1578 | tp = pyio.BufferedRandom |
| 1579 | |
| 1580 | |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1581 | # To fully exercise seek/tell, the StatefulIncrementalDecoder has these |
| 1582 | # properties: |
| 1583 | # - A single output character can correspond to many bytes of input. |
| 1584 | # - The number of input bytes to complete the character can be |
| 1585 | # undetermined until the last input byte is received. |
| 1586 | # - The number of input bytes can vary depending on previous input. |
| 1587 | # - A single input byte can correspond to many characters of output. |
| 1588 | # - The number of output characters can be undetermined until the |
| 1589 | # last input byte is received. |
| 1590 | # - The number of output characters can vary depending on previous input. |
| 1591 | |
| 1592 | class StatefulIncrementalDecoder(codecs.IncrementalDecoder): |
| 1593 | """ |
| 1594 | For testing seek/tell behavior with a stateful, buffering decoder. |
| 1595 | |
| 1596 | Input is a sequence of words. Words may be fixed-length (length set |
| 1597 | by input) or variable-length (period-terminated). In variable-length |
| 1598 | mode, extra periods are ignored. Possible words are: |
| 1599 | - 'i' followed by a number sets the input length, I (maximum 99). |
| 1600 | When I is set to 0, words are space-terminated. |
| 1601 | - 'o' followed by a number sets the output length, O (maximum 99). |
| 1602 | - Any other word is converted into a word followed by a period on |
| 1603 | the output. The output word consists of the input word truncated |
| 1604 | or padded out with hyphens to make its length equal to O. If O |
| 1605 | is 0, the word is output verbatim without truncating or padding. |
| 1606 | I and O are initially set to 1. When I changes, any buffered input is |
| 1607 | re-scanned according to the new I. EOF also terminates the last word. |
| 1608 | """ |
| 1609 | |
| 1610 | def __init__(self, errors='strict'): |
Christian Heimes | ab56887 | 2008-03-23 02:11:13 +0000 | [diff] [blame] | 1611 | codecs.IncrementalDecoder.__init__(self, errors) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1612 | self.reset() |
| 1613 | |
| 1614 | def __repr__(self): |
| 1615 | return '<SID %x>' % id(self) |
| 1616 | |
| 1617 | def reset(self): |
| 1618 | self.i = 1 |
| 1619 | self.o = 1 |
| 1620 | self.buffer = bytearray() |
| 1621 | |
| 1622 | def getstate(self): |
| 1623 | i, o = self.i ^ 1, self.o ^ 1 # so that flags = 0 after reset() |
| 1624 | return bytes(self.buffer), i*100 + o |
| 1625 | |
| 1626 | def setstate(self, state): |
| 1627 | buffer, io = state |
| 1628 | self.buffer = bytearray(buffer) |
| 1629 | i, o = divmod(io, 100) |
| 1630 | self.i, self.o = i ^ 1, o ^ 1 |
| 1631 | |
| 1632 | def decode(self, input, final=False): |
| 1633 | output = '' |
| 1634 | for b in input: |
| 1635 | if self.i == 0: # variable-length, terminated with period |
| 1636 | if b == ord('.'): |
| 1637 | if self.buffer: |
| 1638 | output += self.process_word() |
| 1639 | else: |
| 1640 | self.buffer.append(b) |
| 1641 | else: # fixed-length, terminate after self.i bytes |
| 1642 | self.buffer.append(b) |
| 1643 | if len(self.buffer) == self.i: |
| 1644 | output += self.process_word() |
| 1645 | if final and self.buffer: # EOF terminates the last word |
| 1646 | output += self.process_word() |
| 1647 | return output |
| 1648 | |
| 1649 | def process_word(self): |
| 1650 | output = '' |
| 1651 | if self.buffer[0] == ord('i'): |
| 1652 | self.i = min(99, int(self.buffer[1:] or 0)) # set input length |
| 1653 | elif self.buffer[0] == ord('o'): |
| 1654 | self.o = min(99, int(self.buffer[1:] or 0)) # set output length |
| 1655 | else: |
| 1656 | output = self.buffer.decode('ascii') |
| 1657 | if len(output) < self.o: |
| 1658 | output += '-'*self.o # pad out with hyphens |
| 1659 | if self.o: |
| 1660 | output = output[:self.o] # truncate to output length |
| 1661 | output += '.' |
| 1662 | self.buffer = bytearray() |
| 1663 | return output |
| 1664 | |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 1665 | codecEnabled = False |
| 1666 | |
| 1667 | @classmethod |
| 1668 | def lookupTestDecoder(cls, name): |
| 1669 | if cls.codecEnabled and name == 'test_decoder': |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 1670 | latin1 = codecs.lookup('latin-1') |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 1671 | return codecs.CodecInfo( |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 1672 | name='test_decoder', encode=latin1.encode, decode=None, |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 1673 | incrementalencoder=None, |
| 1674 | streamreader=None, streamwriter=None, |
| 1675 | incrementaldecoder=cls) |
| 1676 | |
| 1677 | # Register the previous decoder for testing. |
| 1678 | # Disabled by default, tests will enable it. |
| 1679 | codecs.register(StatefulIncrementalDecoder.lookupTestDecoder) |
| 1680 | |
| 1681 | |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1682 | class StatefulIncrementalDecoderTest(unittest.TestCase): |
| 1683 | """ |
| 1684 | Make sure the StatefulIncrementalDecoder actually works. |
| 1685 | """ |
| 1686 | |
| 1687 | test_cases = [ |
Ka-Ping Yee | d24a5b6 | 2008-03-20 10:51:27 +0000 | [diff] [blame] | 1688 | # I=1, O=1 (fixed-length input == fixed-length output) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1689 | (b'abcd', False, 'a.b.c.d.'), |
Ka-Ping Yee | d24a5b6 | 2008-03-20 10:51:27 +0000 | [diff] [blame] | 1690 | # I=0, O=0 (variable-length input, variable-length output) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1691 | (b'oiabcd', True, 'abcd.'), |
Ka-Ping Yee | d24a5b6 | 2008-03-20 10:51:27 +0000 | [diff] [blame] | 1692 | # I=0, O=0 (should ignore extra periods) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1693 | (b'oi...abcd...', True, 'abcd.'), |
Ka-Ping Yee | d24a5b6 | 2008-03-20 10:51:27 +0000 | [diff] [blame] | 1694 | # I=0, O=6 (variable-length input, fixed-length output) |
| 1695 | (b'i.o6.x.xyz.toolongtofit.', False, 'x-----.xyz---.toolon.'), |
| 1696 | # I=2, O=6 (fixed-length input < fixed-length output) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1697 | (b'i.i2.o6xyz', True, 'xy----.z-----.'), |
Ka-Ping Yee | d24a5b6 | 2008-03-20 10:51:27 +0000 | [diff] [blame] | 1698 | # I=6, O=3 (fixed-length input > fixed-length output) |
| 1699 | (b'i.o3.i6.abcdefghijklmnop', True, 'abc.ghi.mno.'), |
| 1700 | # I=0, then 3; O=29, then 15 (with longer output) |
| 1701 | (b'i.o29.a.b.cde.o15.abcdefghijabcdefghij.i3.a.b.c.d.ei00k.l.m', True, |
| 1702 | 'a----------------------------.' + |
| 1703 | 'b----------------------------.' + |
| 1704 | 'cde--------------------------.' + |
| 1705 | 'abcdefghijabcde.' + |
| 1706 | 'a.b------------.' + |
| 1707 | '.c.------------.' + |
| 1708 | 'd.e------------.' + |
| 1709 | 'k--------------.' + |
| 1710 | 'l--------------.' + |
| 1711 | 'm--------------.') |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1712 | ] |
| 1713 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1714 | def test_decoder(self): |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1715 | # Try a few one-shot test cases. |
| 1716 | for input, eof, output in self.test_cases: |
| 1717 | d = StatefulIncrementalDecoder() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1718 | self.assertEqual(d.decode(input, eof), output) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 1719 | |
| 1720 | # Also test an unfinished decode, followed by forcing EOF. |
| 1721 | d = StatefulIncrementalDecoder() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1722 | self.assertEqual(d.decode(b'oiabcd'), '') |
| 1723 | self.assertEqual(d.decode(b'', 1), 'abcd.') |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1724 | |
| 1725 | class TextIOWrapperTest(unittest.TestCase): |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 1726 | |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 1727 | def setUp(self): |
| 1728 | self.testdata = b"AAA\r\nBBB\rCCC\r\nDDD\nEEE\r\n" |
| 1729 | self.normalized = b"AAA\nBBB\nCCC\nDDD\nEEE\n".decode("ascii") |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 1730 | support.unlink(support.TESTFN) |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 1731 | |
Guido van Rossum | d071281 | 2007-04-11 16:32:43 +0000 | [diff] [blame] | 1732 | def tearDown(self): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 1733 | support.unlink(support.TESTFN) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 1734 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1735 | def test_constructor(self): |
| 1736 | r = self.BytesIO(b"\xc3\xa9\n\n") |
| 1737 | b = self.BufferedReader(r, 1000) |
| 1738 | t = self.TextIOWrapper(b) |
Marc-André Lemburg | 8f36af7 | 2011-02-25 15:42:01 +0000 | [diff] [blame] | 1739 | t.__init__(b, encoding="latin-1", newline="\r\n") |
| 1740 | self.assertEqual(t.encoding, "latin-1") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1741 | self.assertEqual(t.line_buffering, False) |
Marc-André Lemburg | 8f36af7 | 2011-02-25 15:42:01 +0000 | [diff] [blame] | 1742 | t.__init__(b, encoding="utf-8", line_buffering=True) |
| 1743 | self.assertEqual(t.encoding, "utf-8") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1744 | self.assertEqual(t.line_buffering, True) |
| 1745 | self.assertEqual("\xe9\n", t.readline()) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1746 | self.assertRaises(TypeError, t.__init__, b, newline=42) |
| 1747 | self.assertRaises(ValueError, t.__init__, b, newline='xyzzy') |
| 1748 | |
Benjamin Peterson | d2e0c79 | 2009-05-01 20:40:59 +0000 | [diff] [blame] | 1749 | def test_detach(self): |
| 1750 | r = self.BytesIO() |
| 1751 | b = self.BufferedWriter(r) |
| 1752 | t = self.TextIOWrapper(b) |
| 1753 | self.assertIs(t.detach(), b) |
| 1754 | |
| 1755 | t = self.TextIOWrapper(b, encoding="ascii") |
| 1756 | t.write("howdy") |
| 1757 | self.assertFalse(r.getvalue()) |
| 1758 | t.detach() |
| 1759 | self.assertEqual(r.getvalue(), b"howdy") |
| 1760 | self.assertRaises(ValueError, t.detach) |
| 1761 | |
Benjamin Peterson | c4c0eae | 2009-03-09 00:07:03 +0000 | [diff] [blame] | 1762 | def test_repr(self): |
| 1763 | raw = self.BytesIO("hello".encode("utf-8")) |
| 1764 | b = self.BufferedReader(raw) |
| 1765 | t = self.TextIOWrapper(b, encoding="utf-8") |
Antoine Pitrou | 716c444 | 2009-05-23 19:04:03 +0000 | [diff] [blame] | 1766 | modname = self.TextIOWrapper.__module__ |
| 1767 | self.assertEqual(repr(t), |
| 1768 | "<%s.TextIOWrapper encoding='utf-8'>" % modname) |
| 1769 | raw.name = "dummy" |
| 1770 | self.assertEqual(repr(t), |
| 1771 | "<%s.TextIOWrapper name='dummy' encoding='utf-8'>" % modname) |
Antoine Pitrou | a4815ca | 2011-01-09 20:38:15 +0000 | [diff] [blame] | 1772 | t.mode = "r" |
| 1773 | self.assertEqual(repr(t), |
| 1774 | "<%s.TextIOWrapper name='dummy' mode='r' encoding='utf-8'>" % modname) |
Antoine Pitrou | 716c444 | 2009-05-23 19:04:03 +0000 | [diff] [blame] | 1775 | raw.name = b"dummy" |
| 1776 | self.assertEqual(repr(t), |
Antoine Pitrou | a4815ca | 2011-01-09 20:38:15 +0000 | [diff] [blame] | 1777 | "<%s.TextIOWrapper name=b'dummy' mode='r' encoding='utf-8'>" % modname) |
Benjamin Peterson | c4c0eae | 2009-03-09 00:07:03 +0000 | [diff] [blame] | 1778 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1779 | def test_line_buffering(self): |
| 1780 | r = self.BytesIO() |
| 1781 | b = self.BufferedWriter(r, 1000) |
| 1782 | t = self.TextIOWrapper(b, newline="\n", line_buffering=True) |
Guido van Rossum | f64db9f | 2007-12-06 01:04:26 +0000 | [diff] [blame] | 1783 | t.write("X") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1784 | self.assertEqual(r.getvalue(), b"") # No flush happened |
Guido van Rossum | f64db9f | 2007-12-06 01:04:26 +0000 | [diff] [blame] | 1785 | t.write("Y\nZ") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1786 | self.assertEqual(r.getvalue(), b"XY\nZ") # All got flushed |
Guido van Rossum | f64db9f | 2007-12-06 01:04:26 +0000 | [diff] [blame] | 1787 | t.write("A\rB") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1788 | self.assertEqual(r.getvalue(), b"XY\nZA\rB") |
Guido van Rossum | f64db9f | 2007-12-06 01:04:26 +0000 | [diff] [blame] | 1789 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1790 | def test_encoding(self): |
| 1791 | # Check the encoding attribute is always set, and valid |
| 1792 | b = self.BytesIO() |
Marc-André Lemburg | 8f36af7 | 2011-02-25 15:42:01 +0000 | [diff] [blame] | 1793 | t = self.TextIOWrapper(b, encoding="utf-8") |
| 1794 | self.assertEqual(t.encoding, "utf-8") |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1795 | t = self.TextIOWrapper(b) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1796 | self.assertTrue(t.encoding is not None) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1797 | codecs.lookup(t.encoding) |
| 1798 | |
| 1799 | def test_encoding_errors_reading(self): |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1800 | # (1) default |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1801 | b = self.BytesIO(b"abc\n\xff\n") |
| 1802 | t = self.TextIOWrapper(b, encoding="ascii") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1803 | self.assertRaises(UnicodeError, t.read) |
| 1804 | # (2) explicit strict |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1805 | b = self.BytesIO(b"abc\n\xff\n") |
| 1806 | t = self.TextIOWrapper(b, encoding="ascii", errors="strict") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1807 | self.assertRaises(UnicodeError, t.read) |
| 1808 | # (3) ignore |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1809 | b = self.BytesIO(b"abc\n\xff\n") |
| 1810 | t = self.TextIOWrapper(b, encoding="ascii", errors="ignore") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1811 | self.assertEqual(t.read(), "abc\n\n") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1812 | # (4) replace |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1813 | b = self.BytesIO(b"abc\n\xff\n") |
| 1814 | t = self.TextIOWrapper(b, encoding="ascii", errors="replace") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1815 | self.assertEqual(t.read(), "abc\n\ufffd\n") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1816 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1817 | def test_encoding_errors_writing(self): |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1818 | # (1) default |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1819 | b = self.BytesIO() |
| 1820 | t = self.TextIOWrapper(b, encoding="ascii") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1821 | self.assertRaises(UnicodeError, t.write, "\xff") |
| 1822 | # (2) explicit strict |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1823 | b = self.BytesIO() |
| 1824 | t = self.TextIOWrapper(b, encoding="ascii", errors="strict") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1825 | self.assertRaises(UnicodeError, t.write, "\xff") |
| 1826 | # (3) ignore |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1827 | b = self.BytesIO() |
| 1828 | t = self.TextIOWrapper(b, encoding="ascii", errors="ignore", |
Guido van Rossum | f64db9f | 2007-12-06 01:04:26 +0000 | [diff] [blame] | 1829 | newline="\n") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1830 | t.write("abc\xffdef\n") |
| 1831 | t.flush() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1832 | self.assertEqual(b.getvalue(), b"abcdef\n") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1833 | # (4) replace |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1834 | b = self.BytesIO() |
| 1835 | t = self.TextIOWrapper(b, encoding="ascii", errors="replace", |
Guido van Rossum | f64db9f | 2007-12-06 01:04:26 +0000 | [diff] [blame] | 1836 | newline="\n") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1837 | t.write("abc\xffdef\n") |
| 1838 | t.flush() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1839 | self.assertEqual(b.getvalue(), b"abc?def\n") |
Guido van Rossum | e7fc50f | 2007-12-03 22:54:21 +0000 | [diff] [blame] | 1840 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1841 | def test_newlines(self): |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1842 | input_lines = [ "unix\n", "windows\r\n", "os9\r", "last\n", "nonl" ] |
| 1843 | |
| 1844 | tests = [ |
| 1845 | [ None, [ 'unix\n', 'windows\n', 'os9\n', 'last\n', 'nonl' ] ], |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 1846 | [ '', input_lines ], |
| 1847 | [ '\n', [ "unix\n", "windows\r\n", "os9\rlast\n", "nonl" ] ], |
| 1848 | [ '\r\n', [ "unix\nwindows\r\n", "os9\rlast\nnonl" ] ], |
| 1849 | [ '\r', [ "unix\nwindows\r", "\nos9\r", "last\nnonl" ] ], |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1850 | ] |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 1851 | encodings = ( |
| 1852 | 'utf-8', 'latin-1', |
| 1853 | 'utf-16', 'utf-16-le', 'utf-16-be', |
| 1854 | 'utf-32', 'utf-32-le', 'utf-32-be', |
| 1855 | ) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1856 | |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 1857 | # Try a range of buffer sizes to test the case where \r is the last |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1858 | # character in TextIOWrapper._pending_line. |
| 1859 | for encoding in encodings: |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 1860 | # XXX: str.encode() should return bytes |
| 1861 | data = bytes(''.join(input_lines).encode(encoding)) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1862 | for do_reads in (False, True): |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 1863 | for bufsize in range(1, 10): |
| 1864 | for newline, exp_lines in tests: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1865 | bufio = self.BufferedReader(self.BytesIO(data), bufsize) |
| 1866 | textio = self.TextIOWrapper(bufio, newline=newline, |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1867 | encoding=encoding) |
| 1868 | if do_reads: |
| 1869 | got_lines = [] |
| 1870 | while True: |
Guido van Rossum | 76c5d4d | 2007-04-06 19:10:29 +0000 | [diff] [blame] | 1871 | c2 = textio.read(2) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1872 | if c2 == '': |
| 1873 | break |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1874 | self.assertEqual(len(c2), 2) |
Guido van Rossum | 76c5d4d | 2007-04-06 19:10:29 +0000 | [diff] [blame] | 1875 | got_lines.append(c2 + textio.readline()) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1876 | else: |
Guido van Rossum | 76c5d4d | 2007-04-06 19:10:29 +0000 | [diff] [blame] | 1877 | got_lines = list(textio) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1878 | |
| 1879 | for got_line, exp_line in zip(got_lines, exp_lines): |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1880 | self.assertEqual(got_line, exp_line) |
| 1881 | self.assertEqual(len(got_lines), len(exp_lines)) |
Guido van Rossum | 78892e4 | 2007-04-06 17:31:18 +0000 | [diff] [blame] | 1882 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1883 | def test_newlines_input(self): |
| 1884 | testdata = b"AAA\nBB\x00B\nCCC\rDDD\rEEE\r\nFFF\r\nGGG" |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 1885 | normalized = testdata.replace(b"\r\n", b"\n").replace(b"\r", b"\n") |
| 1886 | for newline, expected in [ |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 1887 | (None, normalized.decode("ascii").splitlines(True)), |
| 1888 | ("", testdata.decode("ascii").splitlines(True)), |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1889 | ("\n", ["AAA\n", "BB\x00B\n", "CCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]), |
| 1890 | ("\r\n", ["AAA\nBB\x00B\nCCC\rDDD\rEEE\r\n", "FFF\r\n", "GGG"]), |
| 1891 | ("\r", ["AAA\nBB\x00B\nCCC\r", "DDD\r", "EEE\r", "\nFFF\r", "\nGGG"]), |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 1892 | ]: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1893 | buf = self.BytesIO(testdata) |
| 1894 | txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1895 | self.assertEqual(txt.readlines(), expected) |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 1896 | txt.seek(0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1897 | self.assertEqual(txt.read(), "".join(expected)) |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 1898 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1899 | def test_newlines_output(self): |
| 1900 | testdict = { |
| 1901 | "": b"AAA\nBBB\nCCC\nX\rY\r\nZ", |
| 1902 | "\n": b"AAA\nBBB\nCCC\nX\rY\r\nZ", |
| 1903 | "\r": b"AAA\rBBB\rCCC\rX\rY\r\rZ", |
| 1904 | "\r\n": b"AAA\r\nBBB\r\nCCC\r\nX\rY\r\r\nZ", |
| 1905 | } |
| 1906 | tests = [(None, testdict[os.linesep])] + sorted(testdict.items()) |
| 1907 | for newline, expected in tests: |
| 1908 | buf = self.BytesIO() |
| 1909 | txt = self.TextIOWrapper(buf, encoding="ascii", newline=newline) |
| 1910 | txt.write("AAA\nB") |
| 1911 | txt.write("BB\nCCC\n") |
| 1912 | txt.write("X\rY\r\nZ") |
| 1913 | txt.flush() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1914 | self.assertEqual(buf.closed, False) |
| 1915 | self.assertEqual(buf.getvalue(), expected) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1916 | |
| 1917 | def test_destructor(self): |
| 1918 | l = [] |
| 1919 | base = self.BytesIO |
| 1920 | class MyBytesIO(base): |
| 1921 | def close(self): |
| 1922 | l.append(self.getvalue()) |
| 1923 | base.close(self) |
| 1924 | b = MyBytesIO() |
| 1925 | t = self.TextIOWrapper(b, encoding="ascii") |
| 1926 | t.write("abc") |
| 1927 | del t |
Benjamin Peterson | 24fb1d0 | 2009-04-24 23:26:21 +0000 | [diff] [blame] | 1928 | support.gc_collect() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1929 | self.assertEqual([b"abc"], l) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1930 | |
| 1931 | def test_override_destructor(self): |
| 1932 | record = [] |
| 1933 | class MyTextIO(self.TextIOWrapper): |
| 1934 | def __del__(self): |
| 1935 | record.append(1) |
| 1936 | try: |
| 1937 | f = super().__del__ |
| 1938 | except AttributeError: |
| 1939 | pass |
| 1940 | else: |
| 1941 | f() |
| 1942 | def close(self): |
| 1943 | record.append(2) |
| 1944 | super().close() |
| 1945 | def flush(self): |
| 1946 | record.append(3) |
| 1947 | super().flush() |
| 1948 | b = self.BytesIO() |
| 1949 | t = MyTextIO(b, encoding="ascii") |
| 1950 | del t |
Benjamin Peterson | 24fb1d0 | 2009-04-24 23:26:21 +0000 | [diff] [blame] | 1951 | support.gc_collect() |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1952 | self.assertEqual(record, [1, 2, 3]) |
| 1953 | |
| 1954 | def test_error_through_destructor(self): |
| 1955 | # Test that the exception state is not modified by a destructor, |
| 1956 | # even if close() fails. |
| 1957 | rawio = self.CloseFailureIO() |
| 1958 | def f(): |
| 1959 | self.TextIOWrapper(rawio).xyzzy |
| 1960 | with support.captured_output("stderr") as s: |
| 1961 | self.assertRaises(AttributeError, f) |
| 1962 | s = s.getvalue().strip() |
| 1963 | if s: |
| 1964 | # The destructor *may* have printed an unraisable error, check it |
| 1965 | self.assertEqual(len(s.splitlines()), 1) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1966 | self.assertTrue(s.startswith("Exception IOError: "), s) |
| 1967 | self.assertTrue(s.endswith(" ignored"), s) |
Guido van Rossum | 8358db2 | 2007-08-18 21:39:55 +0000 | [diff] [blame] | 1968 | |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 1969 | # Systematic tests of the text I/O API |
| 1970 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1971 | def test_basic_io(self): |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 1972 | for chunksize in (1, 2, 3, 4, 5, 15, 16, 17, 31, 32, 33, 63, 64, 65): |
Marc-André Lemburg | 8f36af7 | 2011-02-25 15:42:01 +0000 | [diff] [blame] | 1973 | for enc in "ascii", "latin-1", "utf-8" :# , "utf-16-be", "utf-16-le": |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1974 | f = self.open(support.TESTFN, "w+", encoding=enc) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 1975 | f._CHUNK_SIZE = chunksize |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1976 | self.assertEqual(f.write("abc"), 3) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 1977 | f.close() |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 1978 | f = self.open(support.TESTFN, "r+", encoding=enc) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 1979 | f._CHUNK_SIZE = chunksize |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1980 | self.assertEqual(f.tell(), 0) |
| 1981 | self.assertEqual(f.read(), "abc") |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 1982 | cookie = f.tell() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1983 | self.assertEqual(f.seek(0), 0) |
| 1984 | self.assertEqual(f.read(None), "abc") |
Benjamin Peterson | bf5ff76 | 2009-12-13 19:25:34 +0000 | [diff] [blame] | 1985 | f.seek(0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1986 | self.assertEqual(f.read(2), "ab") |
| 1987 | self.assertEqual(f.read(1), "c") |
| 1988 | self.assertEqual(f.read(1), "") |
| 1989 | self.assertEqual(f.read(), "") |
| 1990 | self.assertEqual(f.tell(), cookie) |
| 1991 | self.assertEqual(f.seek(0), 0) |
| 1992 | self.assertEqual(f.seek(0, 2), cookie) |
| 1993 | self.assertEqual(f.write("def"), 3) |
| 1994 | self.assertEqual(f.seek(cookie), cookie) |
| 1995 | self.assertEqual(f.read(), "def") |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 1996 | if enc.startswith("utf"): |
| 1997 | self.multi_line_test(f, enc) |
| 1998 | f.close() |
| 1999 | |
| 2000 | def multi_line_test(self, f, enc): |
| 2001 | f.seek(0) |
| 2002 | f.truncate() |
Guido van Rossum | ef87d6e | 2007-05-02 19:09:54 +0000 | [diff] [blame] | 2003 | sample = "s\xff\u0fff\uffff" |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 2004 | wlines = [] |
Guido van Rossum | cba608c | 2007-04-11 14:19:59 +0000 | [diff] [blame] | 2005 | for size in (0, 1, 2, 3, 4, 5, 30, 31, 32, 33, 62, 63, 64, 65, 1000): |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 2006 | chars = [] |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 2007 | for i in range(size): |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 2008 | chars.append(sample[i % len(sample)]) |
Guido van Rossum | ef87d6e | 2007-05-02 19:09:54 +0000 | [diff] [blame] | 2009 | line = "".join(chars) + "\n" |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 2010 | wlines.append((f.tell(), line)) |
| 2011 | f.write(line) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 2012 | f.seek(0) |
| 2013 | rlines = [] |
| 2014 | while True: |
| 2015 | pos = f.tell() |
| 2016 | line = f.readline() |
| 2017 | if not line: |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 2018 | break |
| 2019 | rlines.append((pos, line)) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2020 | self.assertEqual(rlines, wlines) |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 2021 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2022 | def test_telling(self): |
Marc-André Lemburg | 8f36af7 | 2011-02-25 15:42:01 +0000 | [diff] [blame] | 2023 | f = self.open(support.TESTFN, "w+", encoding="utf-8") |
Guido van Rossum | b9c4c3e | 2007-04-11 16:07:50 +0000 | [diff] [blame] | 2024 | p0 = f.tell() |
Guido van Rossum | ef87d6e | 2007-05-02 19:09:54 +0000 | [diff] [blame] | 2025 | f.write("\xff\n") |
Guido van Rossum | b9c4c3e | 2007-04-11 16:07:50 +0000 | [diff] [blame] | 2026 | p1 = f.tell() |
Guido van Rossum | ef87d6e | 2007-05-02 19:09:54 +0000 | [diff] [blame] | 2027 | f.write("\xff\n") |
Guido van Rossum | b9c4c3e | 2007-04-11 16:07:50 +0000 | [diff] [blame] | 2028 | p2 = f.tell() |
| 2029 | f.seek(0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2030 | self.assertEqual(f.tell(), p0) |
| 2031 | self.assertEqual(f.readline(), "\xff\n") |
| 2032 | self.assertEqual(f.tell(), p1) |
| 2033 | self.assertEqual(f.readline(), "\xff\n") |
| 2034 | self.assertEqual(f.tell(), p2) |
Guido van Rossum | b9c4c3e | 2007-04-11 16:07:50 +0000 | [diff] [blame] | 2035 | f.seek(0) |
| 2036 | for line in f: |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2037 | self.assertEqual(line, "\xff\n") |
Guido van Rossum | b9c4c3e | 2007-04-11 16:07:50 +0000 | [diff] [blame] | 2038 | self.assertRaises(IOError, f.tell) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2039 | self.assertEqual(f.tell(), p2) |
Guido van Rossum | b9c4c3e | 2007-04-11 16:07:50 +0000 | [diff] [blame] | 2040 | f.close() |
| 2041 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2042 | def test_seeking(self): |
| 2043 | chunk_size = _default_chunk_size() |
Guido van Rossum | d76e779 | 2007-04-17 02:38:04 +0000 | [diff] [blame] | 2044 | prefix_size = chunk_size - 2 |
Guido van Rossum | ef87d6e | 2007-05-02 19:09:54 +0000 | [diff] [blame] | 2045 | u_prefix = "a" * prefix_size |
Guido van Rossum | d76e779 | 2007-04-17 02:38:04 +0000 | [diff] [blame] | 2046 | prefix = bytes(u_prefix.encode("utf-8")) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2047 | self.assertEqual(len(u_prefix), len(prefix)) |
Guido van Rossum | ef87d6e | 2007-05-02 19:09:54 +0000 | [diff] [blame] | 2048 | u_suffix = "\u8888\n" |
Guido van Rossum | d76e779 | 2007-04-17 02:38:04 +0000 | [diff] [blame] | 2049 | suffix = bytes(u_suffix.encode("utf-8")) |
| 2050 | line = prefix + suffix |
Benjamin Peterson | ebe5d8a | 2010-10-31 01:30:11 +0000 | [diff] [blame] | 2051 | with self.open(support.TESTFN, "wb") as f: |
| 2052 | f.write(line*2) |
| 2053 | with self.open(support.TESTFN, "r", encoding="utf-8") as f: |
| 2054 | s = f.read(prefix_size) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2055 | self.assertEqual(s, str(prefix, "ascii")) |
| 2056 | self.assertEqual(f.tell(), prefix_size) |
| 2057 | self.assertEqual(f.readline(), u_suffix) |
Guido van Rossum | d76e779 | 2007-04-17 02:38:04 +0000 | [diff] [blame] | 2058 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2059 | def test_seeking_too(self): |
Guido van Rossum | d76e779 | 2007-04-17 02:38:04 +0000 | [diff] [blame] | 2060 | # Regression test for a specific bug |
| 2061 | data = b'\xe0\xbf\xbf\n' |
Benjamin Peterson | ebe5d8a | 2010-10-31 01:30:11 +0000 | [diff] [blame] | 2062 | with self.open(support.TESTFN, "wb") as f: |
| 2063 | f.write(data) |
| 2064 | with self.open(support.TESTFN, "r", encoding="utf-8") as f: |
| 2065 | f._CHUNK_SIZE # Just test that it exists |
| 2066 | f._CHUNK_SIZE = 2 |
| 2067 | f.readline() |
| 2068 | f.tell() |
Guido van Rossum | d76e779 | 2007-04-17 02:38:04 +0000 | [diff] [blame] | 2069 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2070 | def test_seek_and_tell(self): |
| 2071 | #Test seek/tell using the StatefulIncrementalDecoder. |
| 2072 | # Make test faster by doing smaller seeks |
| 2073 | CHUNK_SIZE = 128 |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2074 | |
Benjamin Peterson | 5fd871d | 2009-03-05 00:49:53 +0000 | [diff] [blame] | 2075 | def test_seek_and_tell_with_data(data, min_pos=0): |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2076 | """Tell/seek to various points within a data stream and ensure |
| 2077 | that the decoded data returned by read() is consistent.""" |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2078 | f = self.open(support.TESTFN, 'wb') |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2079 | f.write(data) |
| 2080 | f.close() |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2081 | f = self.open(support.TESTFN, encoding='test_decoder') |
| 2082 | f._CHUNK_SIZE = CHUNK_SIZE |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2083 | decoded = f.read() |
| 2084 | f.close() |
| 2085 | |
Neal Norwitz | e2b0705 | 2008-03-18 19:52:05 +0000 | [diff] [blame] | 2086 | for i in range(min_pos, len(decoded) + 1): # seek positions |
| 2087 | for j in [1, 5, len(decoded) - i]: # read lengths |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2088 | f = self.open(support.TESTFN, encoding='test_decoder') |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2089 | self.assertEqual(f.read(i), decoded[:i]) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2090 | cookie = f.tell() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2091 | self.assertEqual(f.read(j), decoded[i:i + j]) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2092 | f.seek(cookie) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2093 | self.assertEqual(f.read(), decoded[i:]) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2094 | f.close() |
| 2095 | |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 2096 | # Enable the test decoder. |
| 2097 | StatefulIncrementalDecoder.codecEnabled = 1 |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2098 | |
| 2099 | # Run the tests. |
| 2100 | try: |
| 2101 | # Try each test case. |
| 2102 | for input, _, _ in StatefulIncrementalDecoderTest.test_cases: |
Benjamin Peterson | 5fd871d | 2009-03-05 00:49:53 +0000 | [diff] [blame] | 2103 | test_seek_and_tell_with_data(input) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2104 | |
| 2105 | # Position each test case so that it crosses a chunk boundary. |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2106 | for input, _, _ in StatefulIncrementalDecoderTest.test_cases: |
| 2107 | offset = CHUNK_SIZE - len(input)//2 |
| 2108 | prefix = b'.'*offset |
| 2109 | # Don't bother seeking into the prefix (takes too long). |
| 2110 | min_pos = offset*2 |
Benjamin Peterson | 5fd871d | 2009-03-05 00:49:53 +0000 | [diff] [blame] | 2111 | test_seek_and_tell_with_data(prefix + input, min_pos) |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2112 | |
| 2113 | # Ensure our test decoder won't interfere with subsequent tests. |
| 2114 | finally: |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 2115 | StatefulIncrementalDecoder.codecEnabled = 0 |
Ka-Ping Yee | f44c7e8 | 2008-03-18 04:51:32 +0000 | [diff] [blame] | 2116 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2117 | def test_encoded_writes(self): |
Alexandre Vassalotti | a38f73b | 2008-01-07 18:30:48 +0000 | [diff] [blame] | 2118 | data = "1234567890" |
| 2119 | tests = ("utf-16", |
| 2120 | "utf-16-le", |
| 2121 | "utf-16-be", |
| 2122 | "utf-32", |
| 2123 | "utf-32-le", |
| 2124 | "utf-32-be") |
| 2125 | for encoding in tests: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2126 | buf = self.BytesIO() |
| 2127 | f = self.TextIOWrapper(buf, encoding=encoding) |
Alexandre Vassalotti | a38f73b | 2008-01-07 18:30:48 +0000 | [diff] [blame] | 2128 | # Check if the BOM is written only once (see issue1753). |
| 2129 | f.write(data) |
| 2130 | f.write(data) |
| 2131 | f.seek(0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2132 | self.assertEqual(f.read(), data * 2) |
Benjamin Peterson | 9363a65 | 2009-03-05 00:42:09 +0000 | [diff] [blame] | 2133 | f.seek(0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2134 | self.assertEqual(f.read(), data * 2) |
| 2135 | self.assertEqual(buf.getvalue(), (data * 2).encode(encoding)) |
Alexandre Vassalotti | a38f73b | 2008-01-07 18:30:48 +0000 | [diff] [blame] | 2136 | |
Benjamin Peterson | a1b4901 | 2009-03-31 23:11:32 +0000 | [diff] [blame] | 2137 | def test_unreadable(self): |
| 2138 | class UnReadable(self.BytesIO): |
| 2139 | def readable(self): |
| 2140 | return False |
| 2141 | txt = self.TextIOWrapper(UnReadable()) |
| 2142 | self.assertRaises(IOError, txt.read) |
| 2143 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2144 | def test_read_one_by_one(self): |
| 2145 | txt = self.TextIOWrapper(self.BytesIO(b"AA\r\nBB")) |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2146 | reads = "" |
| 2147 | while True: |
| 2148 | c = txt.read(1) |
| 2149 | if not c: |
| 2150 | break |
| 2151 | reads += c |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2152 | self.assertEqual(reads, "AA\nBB") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2153 | |
Benjamin Peterson | bf5ff76 | 2009-12-13 19:25:34 +0000 | [diff] [blame] | 2154 | def test_readlines(self): |
| 2155 | txt = self.TextIOWrapper(self.BytesIO(b"AA\nBB\nCC")) |
| 2156 | self.assertEqual(txt.readlines(), ["AA\n", "BB\n", "CC"]) |
| 2157 | txt.seek(0) |
| 2158 | self.assertEqual(txt.readlines(None), ["AA\n", "BB\n", "CC"]) |
| 2159 | txt.seek(0) |
| 2160 | self.assertEqual(txt.readlines(5), ["AA\n", "BB\n"]) |
| 2161 | |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2162 | # read in amounts equal to TextIOWrapper._CHUNK_SIZE which is 128. |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2163 | def test_read_by_chunk(self): |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2164 | # make sure "\r\n" straddles 128 char boundary. |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2165 | txt = self.TextIOWrapper(self.BytesIO(b"A" * 127 + b"\r\nB")) |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2166 | reads = "" |
| 2167 | while True: |
| 2168 | c = txt.read(128) |
| 2169 | if not c: |
| 2170 | break |
| 2171 | reads += c |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2172 | self.assertEqual(reads, "A"*127+"\nB") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2173 | |
| 2174 | def test_issue1395_1(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2175 | txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2176 | |
| 2177 | # read one char at a time |
| 2178 | reads = "" |
| 2179 | while True: |
| 2180 | c = txt.read(1) |
| 2181 | if not c: |
| 2182 | break |
| 2183 | reads += c |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2184 | self.assertEqual(reads, self.normalized) |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2185 | |
| 2186 | def test_issue1395_2(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2187 | txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2188 | txt._CHUNK_SIZE = 4 |
| 2189 | |
| 2190 | reads = "" |
| 2191 | while True: |
| 2192 | c = txt.read(4) |
| 2193 | if not c: |
| 2194 | break |
| 2195 | reads += c |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2196 | self.assertEqual(reads, self.normalized) |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2197 | |
| 2198 | def test_issue1395_3(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2199 | txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2200 | txt._CHUNK_SIZE = 4 |
| 2201 | |
| 2202 | reads = txt.read(4) |
| 2203 | reads += txt.read(4) |
| 2204 | reads += txt.readline() |
| 2205 | reads += txt.readline() |
| 2206 | reads += txt.readline() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2207 | self.assertEqual(reads, self.normalized) |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2208 | |
| 2209 | def test_issue1395_4(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2210 | txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2211 | txt._CHUNK_SIZE = 4 |
| 2212 | |
| 2213 | reads = txt.read(4) |
| 2214 | reads += txt.read() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2215 | self.assertEqual(reads, self.normalized) |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2216 | |
| 2217 | def test_issue1395_5(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2218 | txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2219 | txt._CHUNK_SIZE = 4 |
| 2220 | |
| 2221 | reads = txt.read(4) |
| 2222 | pos = txt.tell() |
| 2223 | txt.seek(0) |
| 2224 | txt.seek(pos) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2225 | self.assertEqual(txt.read(4), "BBB\n") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2226 | |
Ka-Ping Yee | ddaa706 | 2008-03-17 20:35:15 +0000 | [diff] [blame] | 2227 | def test_issue2282(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2228 | buffer = self.BytesIO(self.testdata) |
| 2229 | txt = self.TextIOWrapper(buffer, encoding="ascii") |
Ka-Ping Yee | ddaa706 | 2008-03-17 20:35:15 +0000 | [diff] [blame] | 2230 | |
| 2231 | self.assertEqual(buffer.seekable(), txt.seekable()) |
| 2232 | |
Antoine Pitrou | e450185 | 2009-05-14 18:55:55 +0000 | [diff] [blame] | 2233 | def test_append_bom(self): |
| 2234 | # The BOM is not written again when appending to a non-empty file |
| 2235 | filename = support.TESTFN |
| 2236 | for charset in ('utf-8-sig', 'utf-16', 'utf-32'): |
| 2237 | with self.open(filename, 'w', encoding=charset) as f: |
| 2238 | f.write('aaa') |
| 2239 | pos = f.tell() |
| 2240 | with self.open(filename, 'rb') as f: |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2241 | self.assertEqual(f.read(), 'aaa'.encode(charset)) |
Antoine Pitrou | e450185 | 2009-05-14 18:55:55 +0000 | [diff] [blame] | 2242 | |
| 2243 | with self.open(filename, 'a', encoding=charset) as f: |
| 2244 | f.write('xxx') |
| 2245 | with self.open(filename, 'rb') as f: |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2246 | self.assertEqual(f.read(), 'aaaxxx'.encode(charset)) |
Antoine Pitrou | e450185 | 2009-05-14 18:55:55 +0000 | [diff] [blame] | 2247 | |
| 2248 | def test_seek_bom(self): |
| 2249 | # Same test, but when seeking manually |
| 2250 | filename = support.TESTFN |
| 2251 | for charset in ('utf-8-sig', 'utf-16', 'utf-32'): |
| 2252 | with self.open(filename, 'w', encoding=charset) as f: |
| 2253 | f.write('aaa') |
| 2254 | pos = f.tell() |
| 2255 | with self.open(filename, 'r+', encoding=charset) as f: |
| 2256 | f.seek(pos) |
| 2257 | f.write('zzz') |
| 2258 | f.seek(0) |
| 2259 | f.write('bbb') |
| 2260 | with self.open(filename, 'rb') as f: |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2261 | self.assertEqual(f.read(), 'bbbzzz'.encode(charset)) |
Antoine Pitrou | e450185 | 2009-05-14 18:55:55 +0000 | [diff] [blame] | 2262 | |
Benjamin Peterson | 0926ad1 | 2009-06-06 18:02:12 +0000 | [diff] [blame] | 2263 | def test_errors_property(self): |
| 2264 | with self.open(support.TESTFN, "w") as f: |
| 2265 | self.assertEqual(f.errors, "strict") |
| 2266 | with self.open(support.TESTFN, "w", errors="replace") as f: |
| 2267 | self.assertEqual(f.errors, "replace") |
| 2268 | |
Brett Cannon | 31f5929 | 2011-02-21 19:29:56 +0000 | [diff] [blame] | 2269 | @support.no_tracing |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 2270 | @unittest.skipUnless(threading, 'Threading required for this test.') |
Amaury Forgeot d'Arc | ccd686a | 2009-08-29 23:00:38 +0000 | [diff] [blame] | 2271 | def test_threads_write(self): |
| 2272 | # Issue6750: concurrent writes could duplicate data |
| 2273 | event = threading.Event() |
| 2274 | with self.open(support.TESTFN, "w", buffering=1) as f: |
| 2275 | def run(n): |
| 2276 | text = "Thread%03d\n" % n |
| 2277 | event.wait() |
| 2278 | f.write(text) |
| 2279 | threads = [threading.Thread(target=lambda n=x: run(n)) |
| 2280 | for x in range(20)] |
| 2281 | for t in threads: |
| 2282 | t.start() |
| 2283 | time.sleep(0.02) |
| 2284 | event.set() |
| 2285 | for t in threads: |
| 2286 | t.join() |
| 2287 | with self.open(support.TESTFN) as f: |
| 2288 | content = f.read() |
| 2289 | for n in range(20): |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2290 | self.assertEqual(content.count("Thread%03d\n" % n), 1) |
Amaury Forgeot d'Arc | ccd686a | 2009-08-29 23:00:38 +0000 | [diff] [blame] | 2291 | |
Antoine Pitrou | 6be8876 | 2010-05-03 16:48:20 +0000 | [diff] [blame] | 2292 | def test_flush_error_on_close(self): |
| 2293 | txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii") |
| 2294 | def bad_flush(): |
| 2295 | raise IOError() |
| 2296 | txt.flush = bad_flush |
| 2297 | self.assertRaises(IOError, txt.close) # exception not swallowed |
| 2298 | |
| 2299 | def test_multi_close(self): |
| 2300 | txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii") |
| 2301 | txt.close() |
| 2302 | txt.close() |
| 2303 | txt.close() |
| 2304 | self.assertRaises(ValueError, txt.flush) |
| 2305 | |
Antoine Pitrou | 0d739d7 | 2010-09-05 23:01:12 +0000 | [diff] [blame] | 2306 | def test_unseekable(self): |
| 2307 | txt = self.TextIOWrapper(self.MockUnseekableIO(self.testdata)) |
| 2308 | self.assertRaises(self.UnsupportedOperation, txt.tell) |
| 2309 | self.assertRaises(self.UnsupportedOperation, txt.seek, 0) |
| 2310 | |
Antoine Pitrou | 7f8f418 | 2010-12-21 21:20:59 +0000 | [diff] [blame] | 2311 | def test_readonly_attributes(self): |
| 2312 | txt = self.TextIOWrapper(self.BytesIO(self.testdata), encoding="ascii") |
| 2313 | buf = self.BytesIO(self.testdata) |
| 2314 | with self.assertRaises(AttributeError): |
| 2315 | txt.buffer = buf |
| 2316 | |
Antoine Pitrou | e96ec68 | 2011-07-23 21:46:35 +0200 | [diff] [blame] | 2317 | def test_rawio(self): |
| 2318 | # Issue #12591: TextIOWrapper must work with raw I/O objects, so |
| 2319 | # that subprocess.Popen() can have the required unbuffered |
| 2320 | # semantics with universal_newlines=True. |
| 2321 | raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n']) |
| 2322 | txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n') |
| 2323 | # Reads |
| 2324 | self.assertEqual(txt.read(4), 'abcd') |
| 2325 | self.assertEqual(txt.readline(), 'efghi\n') |
| 2326 | self.assertEqual(list(txt), ['jkl\n', 'opq\n']) |
| 2327 | |
| 2328 | def test_rawio_write_through(self): |
| 2329 | # Issue #12591: with write_through=True, writes don't need a flush |
| 2330 | raw = self.MockRawIO([b'abc', b'def', b'ghi\njkl\nopq\n']) |
| 2331 | txt = self.TextIOWrapper(raw, encoding='ascii', newline='\n', |
| 2332 | write_through=True) |
| 2333 | txt.write('1') |
| 2334 | txt.write('23\n4') |
| 2335 | txt.write('5') |
| 2336 | self.assertEqual(b''.join(raw._write_stack), b'123\n45') |
| 2337 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2338 | class CTextIOWrapperTest(TextIOWrapperTest): |
| 2339 | |
| 2340 | def test_initialization(self): |
| 2341 | r = self.BytesIO(b"\xc3\xa9\n\n") |
| 2342 | b = self.BufferedReader(r, 1000) |
| 2343 | t = self.TextIOWrapper(b) |
| 2344 | self.assertRaises(TypeError, t.__init__, b, newline=42) |
| 2345 | self.assertRaises(ValueError, t.read) |
| 2346 | self.assertRaises(ValueError, t.__init__, b, newline='xyzzy') |
| 2347 | self.assertRaises(ValueError, t.read) |
| 2348 | |
| 2349 | def test_garbage_collection(self): |
| 2350 | # C TextIOWrapper objects are collected, and collecting them flushes |
| 2351 | # all data to disk. |
| 2352 | # The Python version has __del__, so it ends in gc.garbage instead. |
| 2353 | rawio = io.FileIO(support.TESTFN, "wb") |
| 2354 | b = self.BufferedWriter(rawio) |
| 2355 | t = self.TextIOWrapper(b, encoding="ascii") |
| 2356 | t.write("456def") |
| 2357 | t.x = t |
| 2358 | wr = weakref.ref(t) |
| 2359 | del t |
Benjamin Peterson | 24fb1d0 | 2009-04-24 23:26:21 +0000 | [diff] [blame] | 2360 | support.gc_collect() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 2361 | self.assertTrue(wr() is None, wr) |
Hirokazu Yamamoto | c7d6aa4 | 2009-06-18 00:07:14 +0000 | [diff] [blame] | 2362 | with self.open(support.TESTFN, "rb") as f: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2363 | self.assertEqual(f.read(), b"456def") |
| 2364 | |
| 2365 | class PyTextIOWrapperTest(TextIOWrapperTest): |
| 2366 | pass |
| 2367 | |
| 2368 | |
| 2369 | class IncrementalNewlineDecoderTest(unittest.TestCase): |
| 2370 | |
| 2371 | def check_newline_decoding_utf8(self, decoder): |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2372 | # UTF-8 specific tests for a newline decoder |
| 2373 | def _check_decode(b, s, **kwargs): |
| 2374 | # We exercise getstate() / setstate() as well as decode() |
| 2375 | state = decoder.getstate() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2376 | self.assertEqual(decoder.decode(b, **kwargs), s) |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2377 | decoder.setstate(state) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2378 | self.assertEqual(decoder.decode(b, **kwargs), s) |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2379 | |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2380 | _check_decode(b'\xe8\xa2\x88', "\u8888") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2381 | |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2382 | _check_decode(b'\xe8', "") |
| 2383 | _check_decode(b'\xa2', "") |
| 2384 | _check_decode(b'\x88', "\u8888") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2385 | |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2386 | _check_decode(b'\xe8', "") |
| 2387 | _check_decode(b'\xa2', "") |
| 2388 | _check_decode(b'\x88', "\u8888") |
| 2389 | |
| 2390 | _check_decode(b'\xe8', "") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2391 | self.assertRaises(UnicodeDecodeError, decoder.decode, b'', final=True) |
| 2392 | |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2393 | decoder.reset() |
| 2394 | _check_decode(b'\n', "\n") |
| 2395 | _check_decode(b'\r', "") |
| 2396 | _check_decode(b'', "\n", final=True) |
| 2397 | _check_decode(b'\r', "\n", final=True) |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2398 | |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2399 | _check_decode(b'\r', "") |
| 2400 | _check_decode(b'a', "\na") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2401 | |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2402 | _check_decode(b'\r\r\n', "\n\n") |
| 2403 | _check_decode(b'\r', "") |
| 2404 | _check_decode(b'\r', "\n") |
| 2405 | _check_decode(b'\na', "\na") |
Amaury Forgeot d'Arc | 1ff9910 | 2007-11-19 20:34:10 +0000 | [diff] [blame] | 2406 | |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2407 | _check_decode(b'\xe8\xa2\x88\r\n', "\u8888\n") |
| 2408 | _check_decode(b'\xe8\xa2\x88', "\u8888") |
| 2409 | _check_decode(b'\n', "\n") |
| 2410 | _check_decode(b'\xe8\xa2\x88\r', "\u8888") |
| 2411 | _check_decode(b'\n', "\n") |
Guido van Rossum | 9b76da6 | 2007-04-11 01:09:03 +0000 | [diff] [blame] | 2412 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2413 | def check_newline_decoding(self, decoder, encoding): |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2414 | result = [] |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2415 | if encoding is not None: |
| 2416 | encoder = codecs.getincrementalencoder(encoding)() |
| 2417 | def _decode_bytewise(s): |
| 2418 | # Decode one byte at a time |
| 2419 | for b in encoder.encode(s): |
| 2420 | result.append(decoder.decode(bytes([b]))) |
| 2421 | else: |
| 2422 | encoder = None |
| 2423 | def _decode_bytewise(s): |
| 2424 | # Decode one char at a time |
| 2425 | for c in s: |
| 2426 | result.append(decoder.decode(c)) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2427 | self.assertEqual(decoder.newlines, None) |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2428 | _decode_bytewise("abc\n\r") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2429 | self.assertEqual(decoder.newlines, '\n') |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2430 | _decode_bytewise("\nabc") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2431 | self.assertEqual(decoder.newlines, ('\n', '\r\n')) |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2432 | _decode_bytewise("abc\r") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2433 | self.assertEqual(decoder.newlines, ('\n', '\r\n')) |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2434 | _decode_bytewise("abc") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2435 | self.assertEqual(decoder.newlines, ('\r', '\n', '\r\n')) |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2436 | _decode_bytewise("abc\r") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2437 | self.assertEqual("".join(result), "abc\n\nabcabc\nabcabc") |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2438 | decoder.reset() |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2439 | input = "abc" |
| 2440 | if encoder is not None: |
| 2441 | encoder.reset() |
| 2442 | input = encoder.encode(input) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2443 | self.assertEqual(decoder.decode(input), "abc") |
| 2444 | self.assertEqual(decoder.newlines, None) |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2445 | |
| 2446 | def test_newline_decoder(self): |
| 2447 | encodings = ( |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2448 | # None meaning the IncrementalNewlineDecoder takes unicode input |
| 2449 | # rather than bytes input |
| 2450 | None, 'utf-8', 'latin-1', |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2451 | 'utf-16', 'utf-16-le', 'utf-16-be', |
| 2452 | 'utf-32', 'utf-32-le', 'utf-32-be', |
| 2453 | ) |
| 2454 | for enc in encodings: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2455 | decoder = enc and codecs.getincrementaldecoder(enc)() |
| 2456 | decoder = self.IncrementalNewlineDecoder(decoder, translate=True) |
| 2457 | self.check_newline_decoding(decoder, enc) |
Alexandre Vassalotti | 472f07d | 2008-01-06 00:34:32 +0000 | [diff] [blame] | 2458 | decoder = codecs.getincrementaldecoder("utf-8")() |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2459 | decoder = self.IncrementalNewlineDecoder(decoder, translate=True) |
| 2460 | self.check_newline_decoding_utf8(decoder) |
| 2461 | |
Antoine Pitrou | 66913e2 | 2009-03-06 23:40:56 +0000 | [diff] [blame] | 2462 | def test_newline_bytes(self): |
| 2463 | # Issue 5433: Excessive optimization in IncrementalNewlineDecoder |
| 2464 | def _check(dec): |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2465 | self.assertEqual(dec.newlines, None) |
| 2466 | self.assertEqual(dec.decode("\u0D00"), "\u0D00") |
| 2467 | self.assertEqual(dec.newlines, None) |
| 2468 | self.assertEqual(dec.decode("\u0A00"), "\u0A00") |
| 2469 | self.assertEqual(dec.newlines, None) |
Antoine Pitrou | 66913e2 | 2009-03-06 23:40:56 +0000 | [diff] [blame] | 2470 | dec = self.IncrementalNewlineDecoder(None, translate=False) |
| 2471 | _check(dec) |
| 2472 | dec = self.IncrementalNewlineDecoder(None, translate=True) |
| 2473 | _check(dec) |
| 2474 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2475 | class CIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest): |
| 2476 | pass |
| 2477 | |
| 2478 | class PyIncrementalNewlineDecoderTest(IncrementalNewlineDecoderTest): |
| 2479 | pass |
Antoine Pitrou | 180a336 | 2008-12-14 16:36:46 +0000 | [diff] [blame] | 2480 | |
Alexandre Vassalotti | 472f07d | 2008-01-06 00:34:32 +0000 | [diff] [blame] | 2481 | |
Guido van Rossum | 01a2752 | 2007-03-07 01:00:12 +0000 | [diff] [blame] | 2482 | # XXX Tests for open() |
Guido van Rossum | 68bbcd2 | 2007-02-27 17:19:33 +0000 | [diff] [blame] | 2483 | |
Guido van Rossum | 5abbf75 | 2007-08-27 17:39:33 +0000 | [diff] [blame] | 2484 | class MiscIOTest(unittest.TestCase): |
| 2485 | |
Barry Warsaw | 40e8246 | 2008-11-20 20:14:50 +0000 | [diff] [blame] | 2486 | def tearDown(self): |
| 2487 | support.unlink(support.TESTFN) |
| 2488 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2489 | def test___all__(self): |
| 2490 | for name in self.io.__all__: |
| 2491 | obj = getattr(self.io, name, None) |
Benjamin Peterson | bfb9594 | 2009-04-02 01:13:40 +0000 | [diff] [blame] | 2492 | self.assertTrue(obj is not None, name) |
Guido van Rossum | 5abbf75 | 2007-08-27 17:39:33 +0000 | [diff] [blame] | 2493 | if name == "open": |
| 2494 | continue |
Benjamin Peterson | 6a52a9c | 2009-04-29 22:00:44 +0000 | [diff] [blame] | 2495 | elif "error" in name.lower() or name == "UnsupportedOperation": |
Benjamin Peterson | bfb9594 | 2009-04-02 01:13:40 +0000 | [diff] [blame] | 2496 | self.assertTrue(issubclass(obj, Exception), name) |
| 2497 | elif not name.startswith("SEEK_"): |
| 2498 | self.assertTrue(issubclass(obj, self.IOBase)) |
Benjamin Peterson | 65676e4 | 2008-11-05 21:42:45 +0000 | [diff] [blame] | 2499 | |
Barry Warsaw | 40e8246 | 2008-11-20 20:14:50 +0000 | [diff] [blame] | 2500 | def test_attributes(self): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2501 | f = self.open(support.TESTFN, "wb", buffering=0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2502 | self.assertEqual(f.mode, "wb") |
Barry Warsaw | 40e8246 | 2008-11-20 20:14:50 +0000 | [diff] [blame] | 2503 | f.close() |
| 2504 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2505 | f = self.open(support.TESTFN, "U") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2506 | self.assertEqual(f.name, support.TESTFN) |
| 2507 | self.assertEqual(f.buffer.name, support.TESTFN) |
| 2508 | self.assertEqual(f.buffer.raw.name, support.TESTFN) |
| 2509 | self.assertEqual(f.mode, "U") |
| 2510 | self.assertEqual(f.buffer.mode, "rb") |
| 2511 | self.assertEqual(f.buffer.raw.mode, "rb") |
Barry Warsaw | 40e8246 | 2008-11-20 20:14:50 +0000 | [diff] [blame] | 2512 | f.close() |
| 2513 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2514 | f = self.open(support.TESTFN, "w+") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2515 | self.assertEqual(f.mode, "w+") |
| 2516 | self.assertEqual(f.buffer.mode, "rb+") # Does it really matter? |
| 2517 | self.assertEqual(f.buffer.raw.mode, "rb+") |
Barry Warsaw | 40e8246 | 2008-11-20 20:14:50 +0000 | [diff] [blame] | 2518 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2519 | g = self.open(f.fileno(), "wb", closefd=False) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2520 | self.assertEqual(g.mode, "wb") |
| 2521 | self.assertEqual(g.raw.mode, "wb") |
| 2522 | self.assertEqual(g.name, f.fileno()) |
| 2523 | self.assertEqual(g.raw.name, f.fileno()) |
Barry Warsaw | 40e8246 | 2008-11-20 20:14:50 +0000 | [diff] [blame] | 2524 | f.close() |
| 2525 | g.close() |
| 2526 | |
Antoine Pitrou | 8043cf8 | 2009-01-09 19:54:29 +0000 | [diff] [blame] | 2527 | def test_io_after_close(self): |
| 2528 | for kwargs in [ |
| 2529 | {"mode": "w"}, |
| 2530 | {"mode": "wb"}, |
| 2531 | {"mode": "w", "buffering": 1}, |
| 2532 | {"mode": "w", "buffering": 2}, |
| 2533 | {"mode": "wb", "buffering": 0}, |
| 2534 | {"mode": "r"}, |
| 2535 | {"mode": "rb"}, |
| 2536 | {"mode": "r", "buffering": 1}, |
| 2537 | {"mode": "r", "buffering": 2}, |
| 2538 | {"mode": "rb", "buffering": 0}, |
| 2539 | {"mode": "w+"}, |
| 2540 | {"mode": "w+b"}, |
| 2541 | {"mode": "w+", "buffering": 1}, |
| 2542 | {"mode": "w+", "buffering": 2}, |
| 2543 | {"mode": "w+b", "buffering": 0}, |
| 2544 | ]: |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2545 | f = self.open(support.TESTFN, **kwargs) |
Antoine Pitrou | 8043cf8 | 2009-01-09 19:54:29 +0000 | [diff] [blame] | 2546 | f.close() |
| 2547 | self.assertRaises(ValueError, f.flush) |
| 2548 | self.assertRaises(ValueError, f.fileno) |
| 2549 | self.assertRaises(ValueError, f.isatty) |
| 2550 | self.assertRaises(ValueError, f.__iter__) |
| 2551 | if hasattr(f, "peek"): |
| 2552 | self.assertRaises(ValueError, f.peek, 1) |
| 2553 | self.assertRaises(ValueError, f.read) |
| 2554 | if hasattr(f, "read1"): |
| 2555 | self.assertRaises(ValueError, f.read1, 1024) |
Victor Stinner | b79f28c | 2011-05-25 22:09:03 +0200 | [diff] [blame] | 2556 | if hasattr(f, "readall"): |
| 2557 | self.assertRaises(ValueError, f.readall) |
Antoine Pitrou | 8043cf8 | 2009-01-09 19:54:29 +0000 | [diff] [blame] | 2558 | if hasattr(f, "readinto"): |
| 2559 | self.assertRaises(ValueError, f.readinto, bytearray(1024)) |
| 2560 | self.assertRaises(ValueError, f.readline) |
| 2561 | self.assertRaises(ValueError, f.readlines) |
| 2562 | self.assertRaises(ValueError, f.seek, 0) |
| 2563 | self.assertRaises(ValueError, f.tell) |
| 2564 | self.assertRaises(ValueError, f.truncate) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2565 | self.assertRaises(ValueError, f.write, |
| 2566 | b"" if "b" in kwargs['mode'] else "") |
Antoine Pitrou | 8043cf8 | 2009-01-09 19:54:29 +0000 | [diff] [blame] | 2567 | self.assertRaises(ValueError, f.writelines, []) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2568 | self.assertRaises(ValueError, next, f) |
Antoine Pitrou | 8043cf8 | 2009-01-09 19:54:29 +0000 | [diff] [blame] | 2569 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2570 | def test_blockingioerror(self): |
| 2571 | # Various BlockingIOError issues |
| 2572 | self.assertRaises(TypeError, self.BlockingIOError) |
| 2573 | self.assertRaises(TypeError, self.BlockingIOError, 1) |
| 2574 | self.assertRaises(TypeError, self.BlockingIOError, 1, 2, 3, 4) |
| 2575 | self.assertRaises(TypeError, self.BlockingIOError, 1, "", None) |
| 2576 | b = self.BlockingIOError(1, "") |
| 2577 | self.assertEqual(b.characters_written, 0) |
| 2578 | class C(str): |
| 2579 | pass |
| 2580 | c = C("") |
| 2581 | b = self.BlockingIOError(1, c) |
| 2582 | c.b = b |
| 2583 | b.c = c |
| 2584 | wr = weakref.ref(c) |
| 2585 | del c, b |
Benjamin Peterson | 24fb1d0 | 2009-04-24 23:26:21 +0000 | [diff] [blame] | 2586 | support.gc_collect() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 2587 | self.assertTrue(wr() is None, wr) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2588 | |
| 2589 | def test_abcs(self): |
| 2590 | # Test the visible base classes are ABCs. |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 2591 | self.assertIsInstance(self.IOBase, abc.ABCMeta) |
| 2592 | self.assertIsInstance(self.RawIOBase, abc.ABCMeta) |
| 2593 | self.assertIsInstance(self.BufferedIOBase, abc.ABCMeta) |
| 2594 | self.assertIsInstance(self.TextIOBase, abc.ABCMeta) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2595 | |
| 2596 | def _check_abc_inheritance(self, abcmodule): |
| 2597 | with self.open(support.TESTFN, "wb", buffering=0) as f: |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 2598 | self.assertIsInstance(f, abcmodule.IOBase) |
| 2599 | self.assertIsInstance(f, abcmodule.RawIOBase) |
| 2600 | self.assertNotIsInstance(f, abcmodule.BufferedIOBase) |
| 2601 | self.assertNotIsInstance(f, abcmodule.TextIOBase) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2602 | with self.open(support.TESTFN, "wb") as f: |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 2603 | self.assertIsInstance(f, abcmodule.IOBase) |
| 2604 | self.assertNotIsInstance(f, abcmodule.RawIOBase) |
| 2605 | self.assertIsInstance(f, abcmodule.BufferedIOBase) |
| 2606 | self.assertNotIsInstance(f, abcmodule.TextIOBase) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2607 | with self.open(support.TESTFN, "w") as f: |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 2608 | self.assertIsInstance(f, abcmodule.IOBase) |
| 2609 | self.assertNotIsInstance(f, abcmodule.RawIOBase) |
| 2610 | self.assertNotIsInstance(f, abcmodule.BufferedIOBase) |
| 2611 | self.assertIsInstance(f, abcmodule.TextIOBase) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2612 | |
| 2613 | def test_abc_inheritance(self): |
| 2614 | # Test implementations inherit from their respective ABCs |
| 2615 | self._check_abc_inheritance(self) |
| 2616 | |
| 2617 | def test_abc_inheritance_official(self): |
| 2618 | # Test implementations inherit from the official ABCs of the |
| 2619 | # baseline "io" module. |
| 2620 | self._check_abc_inheritance(io) |
| 2621 | |
Antoine Pitrou | e033e06 | 2010-10-29 10:38:18 +0000 | [diff] [blame] | 2622 | def _check_warn_on_dealloc(self, *args, **kwargs): |
| 2623 | f = open(*args, **kwargs) |
| 2624 | r = repr(f) |
| 2625 | with self.assertWarns(ResourceWarning) as cm: |
| 2626 | f = None |
| 2627 | support.gc_collect() |
| 2628 | self.assertIn(r, str(cm.warning.args[0])) |
| 2629 | |
| 2630 | def test_warn_on_dealloc(self): |
| 2631 | self._check_warn_on_dealloc(support.TESTFN, "wb", buffering=0) |
| 2632 | self._check_warn_on_dealloc(support.TESTFN, "wb") |
| 2633 | self._check_warn_on_dealloc(support.TESTFN, "w") |
| 2634 | |
| 2635 | def _check_warn_on_dealloc_fd(self, *args, **kwargs): |
| 2636 | fds = [] |
Benjamin Peterson | 556c735 | 2010-10-31 01:35:43 +0000 | [diff] [blame] | 2637 | def cleanup_fds(): |
Antoine Pitrou | e033e06 | 2010-10-29 10:38:18 +0000 | [diff] [blame] | 2638 | for fd in fds: |
| 2639 | try: |
| 2640 | os.close(fd) |
| 2641 | except EnvironmentError as e: |
| 2642 | if e.errno != errno.EBADF: |
| 2643 | raise |
Benjamin Peterson | 556c735 | 2010-10-31 01:35:43 +0000 | [diff] [blame] | 2644 | self.addCleanup(cleanup_fds) |
| 2645 | r, w = os.pipe() |
| 2646 | fds += r, w |
| 2647 | self._check_warn_on_dealloc(r, *args, **kwargs) |
| 2648 | # When using closefd=False, there's no warning |
| 2649 | r, w = os.pipe() |
| 2650 | fds += r, w |
| 2651 | with warnings.catch_warnings(record=True) as recorded: |
| 2652 | open(r, *args, closefd=False, **kwargs) |
| 2653 | support.gc_collect() |
| 2654 | self.assertEqual(recorded, []) |
Antoine Pitrou | e033e06 | 2010-10-29 10:38:18 +0000 | [diff] [blame] | 2655 | |
| 2656 | def test_warn_on_dealloc_fd(self): |
| 2657 | self._check_warn_on_dealloc_fd("rb", buffering=0) |
| 2658 | self._check_warn_on_dealloc_fd("rb") |
| 2659 | self._check_warn_on_dealloc_fd("r") |
| 2660 | |
| 2661 | |
Antoine Pitrou | 243757e | 2010-11-05 21:15:39 +0000 | [diff] [blame] | 2662 | def test_pickling(self): |
| 2663 | # Pickling file objects is forbidden |
| 2664 | for kwargs in [ |
| 2665 | {"mode": "w"}, |
| 2666 | {"mode": "wb"}, |
| 2667 | {"mode": "wb", "buffering": 0}, |
| 2668 | {"mode": "r"}, |
| 2669 | {"mode": "rb"}, |
| 2670 | {"mode": "rb", "buffering": 0}, |
| 2671 | {"mode": "w+"}, |
| 2672 | {"mode": "w+b"}, |
| 2673 | {"mode": "w+b", "buffering": 0}, |
| 2674 | ]: |
| 2675 | for protocol in range(pickle.HIGHEST_PROTOCOL + 1): |
| 2676 | with self.open(support.TESTFN, **kwargs) as f: |
| 2677 | self.assertRaises(TypeError, pickle.dumps, f, protocol) |
| 2678 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2679 | class CMiscIOTest(MiscIOTest): |
| 2680 | io = io |
| 2681 | |
| 2682 | class PyMiscIOTest(MiscIOTest): |
| 2683 | io = pyio |
Barry Warsaw | 40e8246 | 2008-11-20 20:14:50 +0000 | [diff] [blame] | 2684 | |
Antoine Pitrou | b46b9d5 | 2010-08-21 19:09:32 +0000 | [diff] [blame] | 2685 | |
| 2686 | @unittest.skipIf(os.name == 'nt', 'POSIX signals required for this test.') |
| 2687 | class SignalsTest(unittest.TestCase): |
| 2688 | |
| 2689 | def setUp(self): |
| 2690 | self.oldalrm = signal.signal(signal.SIGALRM, self.alarm_interrupt) |
| 2691 | |
| 2692 | def tearDown(self): |
| 2693 | signal.signal(signal.SIGALRM, self.oldalrm) |
| 2694 | |
| 2695 | def alarm_interrupt(self, sig, frame): |
| 2696 | 1/0 |
| 2697 | |
| 2698 | @unittest.skipUnless(threading, 'Threading required for this test.') |
| 2699 | def check_interrupted_write(self, item, bytes, **fdopen_kwargs): |
| 2700 | """Check that a partial write, when it gets interrupted, properly |
Antoine Pitrou | 707ce82 | 2011-02-25 21:24:11 +0000 | [diff] [blame] | 2701 | invokes the signal handler, and bubbles up the exception raised |
| 2702 | in the latter.""" |
Antoine Pitrou | b46b9d5 | 2010-08-21 19:09:32 +0000 | [diff] [blame] | 2703 | read_results = [] |
| 2704 | def _read(): |
Victor Stinner | a929335 | 2011-04-30 15:21:58 +0200 | [diff] [blame] | 2705 | if hasattr(signal, 'pthread_sigmask'): |
| 2706 | signal.pthread_sigmask(signal.SIG_BLOCK, [signal.SIGALRM]) |
Antoine Pitrou | b46b9d5 | 2010-08-21 19:09:32 +0000 | [diff] [blame] | 2707 | s = os.read(r, 1) |
| 2708 | read_results.append(s) |
| 2709 | t = threading.Thread(target=_read) |
| 2710 | t.daemon = True |
| 2711 | r, w = os.pipe() |
Benjamin Peterson | d8fc2e1 | 2010-10-31 01:19:53 +0000 | [diff] [blame] | 2712 | fdopen_kwargs["closefd"] = False |
Antoine Pitrou | b46b9d5 | 2010-08-21 19:09:32 +0000 | [diff] [blame] | 2713 | try: |
| 2714 | wio = self.io.open(w, **fdopen_kwargs) |
| 2715 | t.start() |
| 2716 | signal.alarm(1) |
| 2717 | # Fill the pipe enough that the write will be blocking. |
| 2718 | # It will be interrupted by the timer armed above. Since the |
| 2719 | # other thread has read one byte, the low-level write will |
| 2720 | # return with a successful (partial) result rather than an EINTR. |
| 2721 | # The buffered IO layer must check for pending signal |
| 2722 | # handlers, which in this case will invoke alarm_interrupt(). |
| 2723 | self.assertRaises(ZeroDivisionError, |
Charles-François Natali | 2d51721 | 2011-05-29 16:36:44 +0200 | [diff] [blame] | 2724 | wio.write, item * (support.PIPE_MAX_SIZE // len(item))) |
Antoine Pitrou | b46b9d5 | 2010-08-21 19:09:32 +0000 | [diff] [blame] | 2725 | t.join() |
| 2726 | # We got one byte, get another one and check that it isn't a |
| 2727 | # repeat of the first one. |
| 2728 | read_results.append(os.read(r, 1)) |
| 2729 | self.assertEqual(read_results, [bytes[0:1], bytes[1:2]]) |
| 2730 | finally: |
| 2731 | os.close(w) |
| 2732 | os.close(r) |
| 2733 | # This is deliberate. If we didn't close the file descriptor |
| 2734 | # before closing wio, wio would try to flush its internal |
| 2735 | # buffer, and block again. |
| 2736 | try: |
| 2737 | wio.close() |
| 2738 | except IOError as e: |
| 2739 | if e.errno != errno.EBADF: |
| 2740 | raise |
| 2741 | |
| 2742 | def test_interrupted_write_unbuffered(self): |
| 2743 | self.check_interrupted_write(b"xy", b"xy", mode="wb", buffering=0) |
| 2744 | |
| 2745 | def test_interrupted_write_buffered(self): |
| 2746 | self.check_interrupted_write(b"xy", b"xy", mode="wb") |
| 2747 | |
| 2748 | def test_interrupted_write_text(self): |
| 2749 | self.check_interrupted_write("xy", b"xy", mode="w", encoding="ascii") |
| 2750 | |
Brett Cannon | 31f5929 | 2011-02-21 19:29:56 +0000 | [diff] [blame] | 2751 | @support.no_tracing |
Antoine Pitrou | f3b68b3 | 2010-12-03 18:41:39 +0000 | [diff] [blame] | 2752 | def check_reentrant_write(self, data, **fdopen_kwargs): |
| 2753 | def on_alarm(*args): |
| 2754 | # Will be called reentrantly from the same thread |
| 2755 | wio.write(data) |
| 2756 | 1/0 |
| 2757 | signal.signal(signal.SIGALRM, on_alarm) |
| 2758 | r, w = os.pipe() |
| 2759 | wio = self.io.open(w, **fdopen_kwargs) |
| 2760 | try: |
| 2761 | signal.alarm(1) |
| 2762 | # Either the reentrant call to wio.write() fails with RuntimeError, |
| 2763 | # or the signal handler raises ZeroDivisionError. |
| 2764 | with self.assertRaises((ZeroDivisionError, RuntimeError)) as cm: |
| 2765 | while 1: |
| 2766 | for i in range(100): |
| 2767 | wio.write(data) |
| 2768 | wio.flush() |
| 2769 | # Make sure the buffer doesn't fill up and block further writes |
| 2770 | os.read(r, len(data) * 100) |
| 2771 | exc = cm.exception |
| 2772 | if isinstance(exc, RuntimeError): |
| 2773 | self.assertTrue(str(exc).startswith("reentrant call"), str(exc)) |
| 2774 | finally: |
| 2775 | wio.close() |
| 2776 | os.close(r) |
| 2777 | |
| 2778 | def test_reentrant_write_buffered(self): |
| 2779 | self.check_reentrant_write(b"xy", mode="wb") |
| 2780 | |
| 2781 | def test_reentrant_write_text(self): |
| 2782 | self.check_reentrant_write("xy", mode="w", encoding="ascii") |
| 2783 | |
Antoine Pitrou | 707ce82 | 2011-02-25 21:24:11 +0000 | [diff] [blame] | 2784 | def check_interrupted_read_retry(self, decode, **fdopen_kwargs): |
| 2785 | """Check that a buffered read, when it gets interrupted (either |
| 2786 | returning a partial result or EINTR), properly invokes the signal |
| 2787 | handler and retries if the latter returned successfully.""" |
| 2788 | r, w = os.pipe() |
| 2789 | fdopen_kwargs["closefd"] = False |
| 2790 | def alarm_handler(sig, frame): |
| 2791 | os.write(w, b"bar") |
| 2792 | signal.signal(signal.SIGALRM, alarm_handler) |
| 2793 | try: |
| 2794 | rio = self.io.open(r, **fdopen_kwargs) |
| 2795 | os.write(w, b"foo") |
| 2796 | signal.alarm(1) |
| 2797 | # Expected behaviour: |
| 2798 | # - first raw read() returns partial b"foo" |
| 2799 | # - second raw read() returns EINTR |
| 2800 | # - third raw read() returns b"bar" |
| 2801 | self.assertEqual(decode(rio.read(6)), "foobar") |
| 2802 | finally: |
| 2803 | rio.close() |
| 2804 | os.close(w) |
| 2805 | os.close(r) |
| 2806 | |
| 2807 | def test_interrupterd_read_retry_buffered(self): |
| 2808 | self.check_interrupted_read_retry(lambda x: x.decode('latin1'), |
| 2809 | mode="rb") |
| 2810 | |
| 2811 | def test_interrupterd_read_retry_text(self): |
| 2812 | self.check_interrupted_read_retry(lambda x: x, |
| 2813 | mode="r") |
| 2814 | |
| 2815 | @unittest.skipUnless(threading, 'Threading required for this test.') |
| 2816 | def check_interrupted_write_retry(self, item, **fdopen_kwargs): |
| 2817 | """Check that a buffered write, when it gets interrupted (either |
| 2818 | returning a partial result or EINTR), properly invokes the signal |
| 2819 | handler and retries if the latter returned successfully.""" |
| 2820 | select = support.import_module("select") |
| 2821 | # A quantity that exceeds the buffer size of an anonymous pipe's |
| 2822 | # write end. |
| 2823 | N = 1024 * 1024 |
| 2824 | r, w = os.pipe() |
| 2825 | fdopen_kwargs["closefd"] = False |
| 2826 | # We need a separate thread to read from the pipe and allow the |
| 2827 | # write() to finish. This thread is started after the SIGALRM is |
| 2828 | # received (forcing a first EINTR in write()). |
| 2829 | read_results = [] |
| 2830 | write_finished = False |
| 2831 | def _read(): |
| 2832 | while not write_finished: |
| 2833 | while r in select.select([r], [], [], 1.0)[0]: |
| 2834 | s = os.read(r, 1024) |
| 2835 | read_results.append(s) |
| 2836 | t = threading.Thread(target=_read) |
| 2837 | t.daemon = True |
| 2838 | def alarm1(sig, frame): |
| 2839 | signal.signal(signal.SIGALRM, alarm2) |
| 2840 | signal.alarm(1) |
| 2841 | def alarm2(sig, frame): |
| 2842 | t.start() |
| 2843 | signal.signal(signal.SIGALRM, alarm1) |
| 2844 | try: |
| 2845 | wio = self.io.open(w, **fdopen_kwargs) |
| 2846 | signal.alarm(1) |
| 2847 | # Expected behaviour: |
| 2848 | # - first raw write() is partial (because of the limited pipe buffer |
| 2849 | # and the first alarm) |
| 2850 | # - second raw write() returns EINTR (because of the second alarm) |
| 2851 | # - subsequent write()s are successful (either partial or complete) |
| 2852 | self.assertEqual(N, wio.write(item * N)) |
| 2853 | wio.flush() |
| 2854 | write_finished = True |
| 2855 | t.join() |
| 2856 | self.assertEqual(N, sum(len(x) for x in read_results)) |
| 2857 | finally: |
| 2858 | write_finished = True |
| 2859 | os.close(w) |
| 2860 | os.close(r) |
| 2861 | # This is deliberate. If we didn't close the file descriptor |
| 2862 | # before closing wio, wio would try to flush its internal |
| 2863 | # buffer, and could block (in case of failure). |
| 2864 | try: |
| 2865 | wio.close() |
| 2866 | except IOError as e: |
| 2867 | if e.errno != errno.EBADF: |
| 2868 | raise |
| 2869 | |
| 2870 | def test_interrupterd_write_retry_buffered(self): |
| 2871 | self.check_interrupted_write_retry(b"x", mode="wb") |
| 2872 | |
| 2873 | def test_interrupterd_write_retry_text(self): |
| 2874 | self.check_interrupted_write_retry("x", mode="w", encoding="latin1") |
| 2875 | |
Antoine Pitrou | f3b68b3 | 2010-12-03 18:41:39 +0000 | [diff] [blame] | 2876 | |
Antoine Pitrou | b46b9d5 | 2010-08-21 19:09:32 +0000 | [diff] [blame] | 2877 | class CSignalsTest(SignalsTest): |
| 2878 | io = io |
| 2879 | |
| 2880 | class PySignalsTest(SignalsTest): |
| 2881 | io = pyio |
| 2882 | |
Antoine Pitrou | f3b68b3 | 2010-12-03 18:41:39 +0000 | [diff] [blame] | 2883 | # Handling reentrancy issues would slow down _pyio even more, so the |
| 2884 | # tests are disabled. |
| 2885 | test_reentrant_write_buffered = None |
| 2886 | test_reentrant_write_text = None |
| 2887 | |
Antoine Pitrou | b46b9d5 | 2010-08-21 19:09:32 +0000 | [diff] [blame] | 2888 | |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 2889 | def test_main(): |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2890 | tests = (CIOTest, PyIOTest, |
| 2891 | CBufferedReaderTest, PyBufferedReaderTest, |
| 2892 | CBufferedWriterTest, PyBufferedWriterTest, |
| 2893 | CBufferedRWPairTest, PyBufferedRWPairTest, |
| 2894 | CBufferedRandomTest, PyBufferedRandomTest, |
| 2895 | StatefulIncrementalDecoderTest, |
| 2896 | CIncrementalNewlineDecoderTest, PyIncrementalNewlineDecoderTest, |
| 2897 | CTextIOWrapperTest, PyTextIOWrapperTest, |
Antoine Pitrou | b46b9d5 | 2010-08-21 19:09:32 +0000 | [diff] [blame] | 2898 | CMiscIOTest, PyMiscIOTest, |
| 2899 | CSignalsTest, PySignalsTest, |
| 2900 | ) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2901 | |
| 2902 | # Put the namespaces of the IO module we are testing and some useful mock |
| 2903 | # classes in the __dict__ of each test. |
| 2904 | mocks = (MockRawIO, MisbehavedRawIO, MockFileIO, CloseFailureIO, |
Antoine Pitrou | 328ec74 | 2010-09-14 18:37:24 +0000 | [diff] [blame] | 2905 | MockNonBlockWriterIO, MockUnseekableIO, MockRawIOWithoutRead) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2906 | all_members = io.__all__ + ["IncrementalNewlineDecoder"] |
| 2907 | c_io_ns = {name : getattr(io, name) for name in all_members} |
| 2908 | py_io_ns = {name : getattr(pyio, name) for name in all_members} |
| 2909 | globs = globals() |
| 2910 | c_io_ns.update((x.__name__, globs["C" + x.__name__]) for x in mocks) |
| 2911 | py_io_ns.update((x.__name__, globs["Py" + x.__name__]) for x in mocks) |
| 2912 | # Avoid turning open into a bound method. |
| 2913 | py_io_ns["open"] = pyio.OpenWrapper |
| 2914 | for test in tests: |
| 2915 | if test.__name__.startswith("C"): |
| 2916 | for name, obj in c_io_ns.items(): |
| 2917 | setattr(test, name, obj) |
| 2918 | elif test.__name__.startswith("Py"): |
| 2919 | for name, obj in py_io_ns.items(): |
| 2920 | setattr(test, name, obj) |
| 2921 | |
| 2922 | support.run_unittest(*tests) |
Guido van Rossum | 28524c7 | 2007-02-27 05:47:44 +0000 | [diff] [blame] | 2923 | |
| 2924 | if __name__ == "__main__": |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2925 | test_main() |