blob: 8a3b8055ff7d48e7ab55b6ddc7da18de77dc1a78 [file] [log] [blame]
Guido van Rossum254348e2007-11-21 19:29:53 +00001"""Unit tests for the bytes and bytearray types.
Guido van Rossum98297ee2007-11-06 21:34:58 +00002
Martin Panter152a19c2016-04-06 06:37:17 +00003XXX This is a mess. Common tests should be unified with string_tests.py (and
4the latter should be modernized).
Guido van Rossum98297ee2007-11-06 21:34:58 +00005"""
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00006
INADA Naokia634e232017-01-06 17:32:01 +09007import array
Guido van Rossumd624f182006-04-24 13:47:05 +00008import os
9import re
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000010import sys
Guido van Rossuma6c04be2007-11-03 00:24:24 +000011import copy
Florent Xiclunaedf5f0d2010-09-03 20:00:37 +000012import functools
Guido van Rossum0ad08122007-04-11 04:37:43 +000013import pickle
Guido van Rossumd624f182006-04-24 13:47:05 +000014import tempfile
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000015import unittest
Antoine Pitroucc231542014-11-02 18:40:09 +010016
Benjamin Petersonee8712c2008-05-20 21:35:26 +000017import test.support
Georg Brandlc7885542007-03-06 19:16:20 +000018import test.string_tests
Serhiy Storchaka8dc2ec12016-03-30 21:01:26 +030019import test.list_tests
Antoine Pitroucc231542014-11-02 18:40:09 +010020from test.support import bigaddrspacetest, MAX_Py_ssize_t
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000021
Florent Xiclunaedf5f0d2010-09-03 20:00:37 +000022
23if sys.flags.bytes_warning:
24 def check_bytes_warnings(func):
25 @functools.wraps(func)
26 def wrapper(*args, **kw):
27 with test.support.check_warnings(('', BytesWarning)):
28 return func(*args, **kw)
29 return wrapper
30else:
31 # no-op
32 def check_bytes_warnings(func):
33 return func
34
35
Georg Brandl9a54d7c2008-07-16 23:15:30 +000036class Indexable:
37 def __init__(self, value=0):
38 self.value = value
39 def __index__(self):
40 return self.value
41
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000042
Ezio Melotti0dceb562013-01-10 07:43:26 +020043class BaseBytesTest:
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000044
45 def test_basics(self):
Christian Heimes510711d2008-01-30 11:57:58 +000046 b = self.type2test()
47 self.assertEqual(type(b), self.type2test)
48 self.assertEqual(b.__class__, self.type2test)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000049
Alexandre Vassalotti41f58a72010-01-12 01:23:09 +000050 def test_copy(self):
51 a = self.type2test(b"abcd")
52 for copy_method in (copy.copy, copy.deepcopy):
53 b = copy_method(a)
54 self.assertEqual(a, b)
55 self.assertEqual(type(a), type(b))
56
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000057 def test_empty_sequence(self):
Christian Heimes510711d2008-01-30 11:57:58 +000058 b = self.type2test()
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000059 self.assertEqual(len(b), 0)
60 self.assertRaises(IndexError, lambda: b[0])
61 self.assertRaises(IndexError, lambda: b[1])
Christian Heimesa37d4c62007-12-04 23:02:19 +000062 self.assertRaises(IndexError, lambda: b[sys.maxsize])
63 self.assertRaises(IndexError, lambda: b[sys.maxsize+1])
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000064 self.assertRaises(IndexError, lambda: b[10**100])
65 self.assertRaises(IndexError, lambda: b[-1])
66 self.assertRaises(IndexError, lambda: b[-2])
Christian Heimesa37d4c62007-12-04 23:02:19 +000067 self.assertRaises(IndexError, lambda: b[-sys.maxsize])
68 self.assertRaises(IndexError, lambda: b[-sys.maxsize-1])
69 self.assertRaises(IndexError, lambda: b[-sys.maxsize-2])
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000070 self.assertRaises(IndexError, lambda: b[-10**100])
71
72 def test_from_list(self):
73 ints = list(range(256))
Christian Heimes510711d2008-01-30 11:57:58 +000074 b = self.type2test(i for i in ints)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000075 self.assertEqual(len(b), 256)
76 self.assertEqual(list(b), ints)
77
78 def test_from_index(self):
Georg Brandl9a54d7c2008-07-16 23:15:30 +000079 b = self.type2test([Indexable(), Indexable(1), Indexable(254),
80 Indexable(255)])
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000081 self.assertEqual(list(b), [0, 1, 254, 255])
Benjamin Peterson4c045832010-04-16 22:35:32 +000082 self.assertRaises(ValueError, self.type2test, [Indexable(-1)])
83 self.assertRaises(ValueError, self.type2test, [Indexable(256)])
Guido van Rossum98297ee2007-11-06 21:34:58 +000084
INADA Naokia634e232017-01-06 17:32:01 +090085 def test_from_buffer(self):
86 a = self.type2test(array.array('B', [1, 2, 3]))
87 self.assertEqual(a, b"\x01\x02\x03")
88
89 # http://bugs.python.org/issue29159
90 # Fallback when __index__ raises exception other than OverflowError
91 class B(bytes):
92 def __index__(self):
93 raise TypeError
94
95 self.assertEqual(self.type2test(B(b"foobar")), b"foobar")
96
Guido van Rossum98297ee2007-11-06 21:34:58 +000097 def test_from_ssize(self):
Benjamin Peterson4c045832010-04-16 22:35:32 +000098 self.assertEqual(self.type2test(0), b'')
99 self.assertEqual(self.type2test(1), b'\x00')
100 self.assertEqual(self.type2test(5), b'\x00\x00\x00\x00\x00')
101 self.assertRaises(ValueError, self.type2test, -1)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000102
Benjamin Peterson4c045832010-04-16 22:35:32 +0000103 self.assertEqual(self.type2test('0', 'ascii'), b'0')
104 self.assertEqual(self.type2test(b'0'), b'0')
Benjamin Peterson8380dd52010-04-16 22:51:37 +0000105 self.assertRaises(OverflowError, self.type2test, sys.maxsize + 1)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000106
107 def test_constructor_type_errors(self):
Christian Heimes510711d2008-01-30 11:57:58 +0000108 self.assertRaises(TypeError, self.type2test, 0.0)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000109 class C:
110 pass
Christian Heimes510711d2008-01-30 11:57:58 +0000111 self.assertRaises(TypeError, self.type2test, ["0"])
112 self.assertRaises(TypeError, self.type2test, [0.0])
113 self.assertRaises(TypeError, self.type2test, [None])
114 self.assertRaises(TypeError, self.type2test, [C()])
Serhiy Storchaka83cf99d2014-12-02 09:24:06 +0200115 self.assertRaises(TypeError, self.type2test, 0, 'ascii')
116 self.assertRaises(TypeError, self.type2test, b'', 'ascii')
117 self.assertRaises(TypeError, self.type2test, 0, errors='ignore')
118 self.assertRaises(TypeError, self.type2test, b'', errors='ignore')
119 self.assertRaises(TypeError, self.type2test, '')
120 self.assertRaises(TypeError, self.type2test, '', errors='ignore')
121 self.assertRaises(TypeError, self.type2test, '', b'ascii')
122 self.assertRaises(TypeError, self.type2test, '', 'ascii', b'ignore')
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000123
124 def test_constructor_value_errors(self):
Christian Heimes510711d2008-01-30 11:57:58 +0000125 self.assertRaises(ValueError, self.type2test, [-1])
126 self.assertRaises(ValueError, self.type2test, [-sys.maxsize])
127 self.assertRaises(ValueError, self.type2test, [-sys.maxsize-1])
128 self.assertRaises(ValueError, self.type2test, [-sys.maxsize-2])
129 self.assertRaises(ValueError, self.type2test, [-10**100])
130 self.assertRaises(ValueError, self.type2test, [256])
131 self.assertRaises(ValueError, self.type2test, [257])
132 self.assertRaises(ValueError, self.type2test, [sys.maxsize])
133 self.assertRaises(ValueError, self.type2test, [sys.maxsize+1])
134 self.assertRaises(ValueError, self.type2test, [10**100])
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000135
Antoine Pitroucc231542014-11-02 18:40:09 +0100136 @bigaddrspacetest
137 def test_constructor_overflow(self):
138 size = MAX_Py_ssize_t
139 self.assertRaises((OverflowError, MemoryError), self.type2test, size)
140 try:
141 # Should either pass or raise an error (e.g. on debug builds with
142 # additional malloc() overhead), but shouldn't crash.
143 bytearray(size - 4)
144 except (OverflowError, MemoryError):
145 pass
146
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000147 def test_compare(self):
Christian Heimes510711d2008-01-30 11:57:58 +0000148 b1 = self.type2test([1, 2, 3])
149 b2 = self.type2test([1, 2, 3])
150 b3 = self.type2test([1, 3])
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000151
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000152 self.assertEqual(b1, b2)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000153 self.assertTrue(b2 != b3)
154 self.assertTrue(b1 <= b2)
155 self.assertTrue(b1 <= b3)
156 self.assertTrue(b1 < b3)
157 self.assertTrue(b1 >= b2)
158 self.assertTrue(b3 >= b2)
159 self.assertTrue(b3 > b2)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000160
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000161 self.assertFalse(b1 != b2)
162 self.assertFalse(b2 == b3)
163 self.assertFalse(b1 > b2)
164 self.assertFalse(b1 > b3)
165 self.assertFalse(b1 >= b3)
166 self.assertFalse(b1 < b2)
167 self.assertFalse(b3 < b2)
168 self.assertFalse(b3 <= b2)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000169
Florent Xiclunaedf5f0d2010-09-03 20:00:37 +0000170 @check_bytes_warnings
Guido van Rossum343e97f2007-04-09 00:43:24 +0000171 def test_compare_to_str(self):
Florent Xiclunaedf5f0d2010-09-03 20:00:37 +0000172 # Byte comparisons with unicode should always fail!
173 # Test this for all expected byte orders and Unicode character
174 # sizes.
175 self.assertEqual(self.type2test(b"\0a\0b\0c") == "abc", False)
176 self.assertEqual(self.type2test(b"\0\0\0a\0\0\0b\0\0\0c") == "abc",
177 False)
178 self.assertEqual(self.type2test(b"a\0b\0c\0") == "abc", False)
179 self.assertEqual(self.type2test(b"a\0\0\0b\0\0\0c\0\0\0") == "abc",
180 False)
181 self.assertEqual(self.type2test() == str(), False)
182 self.assertEqual(self.type2test() != str(), True)
Christian Heimes510711d2008-01-30 11:57:58 +0000183
184 def test_reversed(self):
185 input = list(map(ord, "Hello"))
186 b = self.type2test(input)
187 output = list(reversed(b))
188 input.reverse()
189 self.assertEqual(output, input)
190
191 def test_getslice(self):
192 def by(s):
193 return self.type2test(map(ord, s))
194 b = by("Hello, world")
195
196 self.assertEqual(b[:5], by("Hello"))
197 self.assertEqual(b[1:5], by("ello"))
198 self.assertEqual(b[5:7], by(", "))
199 self.assertEqual(b[7:], by("world"))
200 self.assertEqual(b[7:12], by("world"))
201 self.assertEqual(b[7:100], by("world"))
202
203 self.assertEqual(b[:-7], by("Hello"))
204 self.assertEqual(b[-11:-7], by("ello"))
205 self.assertEqual(b[-7:-5], by(", "))
206 self.assertEqual(b[-5:], by("world"))
207 self.assertEqual(b[-5:12], by("world"))
208 self.assertEqual(b[-5:100], by("world"))
209 self.assertEqual(b[-100:5], by("Hello"))
210
211 def test_extended_getslice(self):
212 # Test extended slicing by comparing with list slicing.
213 L = list(range(255))
214 b = self.type2test(L)
215 indices = (0, None, 1, 3, 19, 100, -1, -2, -31, -100)
216 for start in indices:
217 for stop in indices:
218 # Skip step 0 (invalid)
219 for step in indices[1:]:
220 self.assertEqual(b[start:stop:step], self.type2test(L[start:stop:step]))
221
222 def test_encoding(self):
Martin v. Löwisdb12d452009-05-02 18:52:14 +0000223 sample = "Hello world\n\u1234\u5678\u9abc"
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000224 for enc in ("utf-8", "utf-16"):
Christian Heimes510711d2008-01-30 11:57:58 +0000225 b = self.type2test(sample, enc)
226 self.assertEqual(b, self.type2test(sample.encode(enc)))
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000227 self.assertRaises(UnicodeEncodeError, self.type2test, sample, "latin-1")
228 b = self.type2test(sample, "latin-1", "ignore")
Martin v. Löwisdb12d452009-05-02 18:52:14 +0000229 self.assertEqual(b, self.type2test(sample[:-3], "utf-8"))
Christian Heimes510711d2008-01-30 11:57:58 +0000230
231 def test_decode(self):
Serhiy Storchakac49a5162016-09-08 15:47:27 +0300232 sample = "Hello world\n\u1234\u5678\u9abc"
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000233 for enc in ("utf-8", "utf-16"):
Christian Heimes510711d2008-01-30 11:57:58 +0000234 b = self.type2test(sample, enc)
235 self.assertEqual(b.decode(enc), sample)
236 sample = "Hello world\n\x80\x81\xfe\xff"
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000237 b = self.type2test(sample, "latin-1")
238 self.assertRaises(UnicodeDecodeError, b.decode, "utf-8")
239 self.assertEqual(b.decode("utf-8", "ignore"), "Hello world\n")
240 self.assertEqual(b.decode(errors="ignore", encoding="utf-8"),
Benjamin Peterson308d6372009-09-18 21:42:35 +0000241 "Hello world\n")
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000242 # Default encoding is utf-8
243 self.assertEqual(self.type2test(b'\xe2\x98\x83').decode(), '\u2603')
Christian Heimes510711d2008-01-30 11:57:58 +0000244
245 def test_from_int(self):
246 b = self.type2test(0)
247 self.assertEqual(b, self.type2test())
248 b = self.type2test(10)
249 self.assertEqual(b, self.type2test([0]*10))
250 b = self.type2test(10000)
251 self.assertEqual(b, self.type2test([0]*10000))
252
253 def test_concat(self):
254 b1 = self.type2test(b"abc")
255 b2 = self.type2test(b"def")
256 self.assertEqual(b1 + b2, b"abcdef")
257 self.assertEqual(b1 + bytes(b"def"), b"abcdef")
258 self.assertEqual(bytes(b"def") + b1, b"defabc")
259 self.assertRaises(TypeError, lambda: b1 + "def")
260 self.assertRaises(TypeError, lambda: "abc" + b2)
261
262 def test_repeat(self):
263 for b in b"abc", self.type2test(b"abc"):
264 self.assertEqual(b * 3, b"abcabcabc")
265 self.assertEqual(b * 0, b"")
266 self.assertEqual(b * -1, b"")
267 self.assertRaises(TypeError, lambda: b * 3.14)
268 self.assertRaises(TypeError, lambda: 3.14 * b)
269 # XXX Shouldn't bytes and bytearray agree on what to raise?
Mark Dickinsoncf940c72010-08-10 18:35:01 +0000270 with self.assertRaises((OverflowError, MemoryError)):
271 c = b * sys.maxsize
272 with self.assertRaises((OverflowError, MemoryError)):
273 b *= sys.maxsize
Christian Heimes510711d2008-01-30 11:57:58 +0000274
275 def test_repeat_1char(self):
276 self.assertEqual(self.type2test(b'x')*100, self.type2test([ord('x')]*100))
277
278 def test_contains(self):
279 b = self.type2test(b"abc")
Benjamin Peterson577473f2010-01-19 00:09:57 +0000280 self.assertIn(ord('a'), b)
281 self.assertIn(int(ord('a')), b)
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000282 self.assertNotIn(200, b)
Christian Heimes510711d2008-01-30 11:57:58 +0000283 self.assertRaises(ValueError, lambda: 300 in b)
284 self.assertRaises(ValueError, lambda: -1 in b)
Serhiy Storchakaf9efb8b2016-07-10 12:37:30 +0300285 self.assertRaises(ValueError, lambda: sys.maxsize+1 in b)
Christian Heimes510711d2008-01-30 11:57:58 +0000286 self.assertRaises(TypeError, lambda: None in b)
287 self.assertRaises(TypeError, lambda: float(ord('a')) in b)
288 self.assertRaises(TypeError, lambda: "a" in b)
289 for f in bytes, bytearray:
Benjamin Peterson577473f2010-01-19 00:09:57 +0000290 self.assertIn(f(b""), b)
291 self.assertIn(f(b"a"), b)
292 self.assertIn(f(b"b"), b)
293 self.assertIn(f(b"c"), b)
294 self.assertIn(f(b"ab"), b)
295 self.assertIn(f(b"bc"), b)
296 self.assertIn(f(b"abc"), b)
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000297 self.assertNotIn(f(b"ac"), b)
298 self.assertNotIn(f(b"d"), b)
299 self.assertNotIn(f(b"dab"), b)
300 self.assertNotIn(f(b"abd"), b)
Christian Heimes510711d2008-01-30 11:57:58 +0000301
302 def test_fromhex(self):
303 self.assertRaises(TypeError, self.type2test.fromhex)
304 self.assertRaises(TypeError, self.type2test.fromhex, 1)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000305 self.assertEqual(self.type2test.fromhex(''), self.type2test())
Christian Heimes510711d2008-01-30 11:57:58 +0000306 b = bytearray([0x1a, 0x2b, 0x30])
Ezio Melottib3aedd42010-11-20 19:04:17 +0000307 self.assertEqual(self.type2test.fromhex('1a2B30'), b)
308 self.assertEqual(self.type2test.fromhex(' 1A 2B 30 '), b)
Serhiy Storchakadd1da7f2016-12-19 18:51:37 +0200309
310 # check that ASCII whitespace is ignored
311 self.assertEqual(self.type2test.fromhex(' 1A\n2B\t30\v'), b)
312 for c in "\x09\x0A\x0B\x0C\x0D\x20":
313 self.assertEqual(self.type2test.fromhex(c), self.type2test())
314 for c in "\x1C\x1D\x1E\x1F\x85\xa0\u2000\u2002\u2028":
315 self.assertRaises(ValueError, self.type2test.fromhex, c)
316
Ezio Melottib3aedd42010-11-20 19:04:17 +0000317 self.assertEqual(self.type2test.fromhex('0000'), b'\0\0')
Christian Heimes510711d2008-01-30 11:57:58 +0000318 self.assertRaises(TypeError, self.type2test.fromhex, b'1B')
319 self.assertRaises(ValueError, self.type2test.fromhex, 'a')
320 self.assertRaises(ValueError, self.type2test.fromhex, 'rt')
321 self.assertRaises(ValueError, self.type2test.fromhex, '1a b cd')
322 self.assertRaises(ValueError, self.type2test.fromhex, '\x00')
323 self.assertRaises(ValueError, self.type2test.fromhex, '12 \x00 34')
324
Victor Stinner2bf89932015-10-14 11:25:33 +0200325 for data, pos in (
326 # invalid first hexadecimal character
327 ('12 x4 56', 3),
328 # invalid second hexadecimal character
329 ('12 3x 56', 4),
330 # two invalid hexadecimal characters
331 ('12 xy 56', 3),
332 # test non-ASCII string
333 ('12 3\xff 56', 4),
334 ):
335 with self.assertRaises(ValueError) as cm:
336 self.type2test.fromhex(data)
337 self.assertIn('at position %s' % pos, str(cm.exception))
338
Gregory P. Smith8cb65692015-04-25 23:22:26 +0000339 def test_hex(self):
340 self.assertRaises(TypeError, self.type2test.hex)
341 self.assertRaises(TypeError, self.type2test.hex, 1)
Gregory P. Smith32d34bc2015-04-26 05:05:53 +0000342 self.assertEqual(self.type2test(b"").hex(), "")
343 self.assertEqual(bytearray([0x1a, 0x2b, 0x30]).hex(), '1a2b30')
344 self.assertEqual(self.type2test(b"\x1a\x2b\x30").hex(), '1a2b30')
345 self.assertEqual(memoryview(b"\x1a\x2b\x30").hex(), '1a2b30')
Gregory P. Smith8cb65692015-04-25 23:22:26 +0000346
Christian Heimes510711d2008-01-30 11:57:58 +0000347 def test_join(self):
348 self.assertEqual(self.type2test(b"").join([]), b"")
349 self.assertEqual(self.type2test(b"").join([b""]), b"")
350 for lst in [[b"abc"], [b"a", b"bc"], [b"ab", b"c"], [b"a", b"b", b"c"]]:
351 lst = list(map(self.type2test, lst))
352 self.assertEqual(self.type2test(b"").join(lst), b"abc")
353 self.assertEqual(self.type2test(b"").join(tuple(lst)), b"abc")
354 self.assertEqual(self.type2test(b"").join(iter(lst)), b"abc")
Antoine Pitroucfc22b42012-10-16 21:07:23 +0200355 dot_join = self.type2test(b".:").join
356 self.assertEqual(dot_join([b"ab", b"cd"]), b"ab.:cd")
357 self.assertEqual(dot_join([memoryview(b"ab"), b"cd"]), b"ab.:cd")
358 self.assertEqual(dot_join([b"ab", memoryview(b"cd")]), b"ab.:cd")
359 self.assertEqual(dot_join([bytearray(b"ab"), b"cd"]), b"ab.:cd")
360 self.assertEqual(dot_join([b"ab", bytearray(b"cd")]), b"ab.:cd")
361 # Stress it with many items
362 seq = [b"abc"] * 1000
363 expected = b"abc" + b".:abc" * 999
364 self.assertEqual(dot_join(seq), expected)
Benjamin Petersonc31f12d2014-09-28 12:56:42 -0400365 self.assertRaises(TypeError, self.type2test(b" ").join, None)
Antoine Pitroucfc22b42012-10-16 21:07:23 +0200366 # Error handling and cleanup when some item in the middle of the
367 # sequence has the wrong type.
368 with self.assertRaises(TypeError):
369 dot_join([bytearray(b"ab"), "cd", b"ef"])
370 with self.assertRaises(TypeError):
371 dot_join([memoryview(b"ab"), "cd", b"ef"])
Christian Heimes510711d2008-01-30 11:57:58 +0000372
Christian Heimes510711d2008-01-30 11:57:58 +0000373 def test_count(self):
374 b = self.type2test(b'mississippi')
Antoine Pitrouac65d962011-10-20 23:54:17 +0200375 i = 105
376 p = 112
377 w = 119
378
Christian Heimes510711d2008-01-30 11:57:58 +0000379 self.assertEqual(b.count(b'i'), 4)
380 self.assertEqual(b.count(b'ss'), 2)
381 self.assertEqual(b.count(b'w'), 0)
382
Antoine Pitrouac65d962011-10-20 23:54:17 +0200383 self.assertEqual(b.count(i), 4)
384 self.assertEqual(b.count(w), 0)
385
386 self.assertEqual(b.count(b'i', 6), 2)
387 self.assertEqual(b.count(b'p', 6), 2)
388 self.assertEqual(b.count(b'i', 1, 3), 1)
389 self.assertEqual(b.count(b'p', 7, 9), 1)
390
391 self.assertEqual(b.count(i, 6), 2)
392 self.assertEqual(b.count(p, 6), 2)
393 self.assertEqual(b.count(i, 1, 3), 1)
394 self.assertEqual(b.count(p, 7, 9), 1)
395
Christian Heimes510711d2008-01-30 11:57:58 +0000396 def test_startswith(self):
397 b = self.type2test(b'hello')
398 self.assertFalse(self.type2test().startswith(b"anything"))
399 self.assertTrue(b.startswith(b"hello"))
400 self.assertTrue(b.startswith(b"hel"))
401 self.assertTrue(b.startswith(b"h"))
402 self.assertFalse(b.startswith(b"hellow"))
403 self.assertFalse(b.startswith(b"ha"))
Ezio Melottif2b3f782011-04-26 06:40:59 +0300404 with self.assertRaises(TypeError) as cm:
Ezio Melottiba42fd52011-04-26 06:09:45 +0300405 b.startswith([b'h'])
Ezio Melottif2b3f782011-04-26 06:40:59 +0300406 exc = str(cm.exception)
Ezio Melottiba42fd52011-04-26 06:09:45 +0300407 self.assertIn('bytes', exc)
408 self.assertIn('tuple', exc)
Christian Heimes510711d2008-01-30 11:57:58 +0000409
410 def test_endswith(self):
411 b = self.type2test(b'hello')
412 self.assertFalse(bytearray().endswith(b"anything"))
413 self.assertTrue(b.endswith(b"hello"))
414 self.assertTrue(b.endswith(b"llo"))
415 self.assertTrue(b.endswith(b"o"))
416 self.assertFalse(b.endswith(b"whello"))
417 self.assertFalse(b.endswith(b"no"))
Ezio Melottif2b3f782011-04-26 06:40:59 +0300418 with self.assertRaises(TypeError) as cm:
Ezio Melottiba42fd52011-04-26 06:09:45 +0300419 b.endswith([b'o'])
Ezio Melottif2b3f782011-04-26 06:40:59 +0300420 exc = str(cm.exception)
Ezio Melottiba42fd52011-04-26 06:09:45 +0300421 self.assertIn('bytes', exc)
422 self.assertIn('tuple', exc)
Christian Heimes510711d2008-01-30 11:57:58 +0000423
424 def test_find(self):
425 b = self.type2test(b'mississippi')
Antoine Pitrouac65d962011-10-20 23:54:17 +0200426 i = 105
427 w = 119
428
Christian Heimes510711d2008-01-30 11:57:58 +0000429 self.assertEqual(b.find(b'ss'), 2)
Christian Heimes510711d2008-01-30 11:57:58 +0000430 self.assertEqual(b.find(b'w'), -1)
431 self.assertEqual(b.find(b'mississippian'), -1)
432
Antoine Pitrouac65d962011-10-20 23:54:17 +0200433 self.assertEqual(b.find(i), 1)
434 self.assertEqual(b.find(w), -1)
435
436 self.assertEqual(b.find(b'ss', 3), 5)
437 self.assertEqual(b.find(b'ss', 1, 7), 2)
438 self.assertEqual(b.find(b'ss', 1, 3), -1)
439
440 self.assertEqual(b.find(i, 6), 7)
441 self.assertEqual(b.find(i, 1, 3), 1)
442 self.assertEqual(b.find(w, 1, 3), -1)
443
Victor Stinnerf8eac002011-12-18 01:17:41 +0100444 for index in (-1, 256, sys.maxsize + 1):
445 self.assertRaisesRegex(
446 ValueError, r'byte must be in range\(0, 256\)',
447 b.find, index)
448
Christian Heimes510711d2008-01-30 11:57:58 +0000449 def test_rfind(self):
450 b = self.type2test(b'mississippi')
Antoine Pitrouac65d962011-10-20 23:54:17 +0200451 i = 105
452 w = 119
453
Christian Heimes510711d2008-01-30 11:57:58 +0000454 self.assertEqual(b.rfind(b'ss'), 5)
Christian Heimes510711d2008-01-30 11:57:58 +0000455 self.assertEqual(b.rfind(b'w'), -1)
456 self.assertEqual(b.rfind(b'mississippian'), -1)
457
Antoine Pitrouac65d962011-10-20 23:54:17 +0200458 self.assertEqual(b.rfind(i), 10)
459 self.assertEqual(b.rfind(w), -1)
460
461 self.assertEqual(b.rfind(b'ss', 3), 5)
462 self.assertEqual(b.rfind(b'ss', 0, 6), 2)
463
464 self.assertEqual(b.rfind(i, 1, 3), 1)
465 self.assertEqual(b.rfind(i, 3, 9), 7)
466 self.assertEqual(b.rfind(w, 1, 3), -1)
467
Christian Heimes510711d2008-01-30 11:57:58 +0000468 def test_index(self):
Antoine Pitrouac65d962011-10-20 23:54:17 +0200469 b = self.type2test(b'mississippi')
470 i = 105
471 w = 119
472
473 self.assertEqual(b.index(b'ss'), 2)
474 self.assertRaises(ValueError, b.index, b'w')
475 self.assertRaises(ValueError, b.index, b'mississippian')
476
477 self.assertEqual(b.index(i), 1)
478 self.assertRaises(ValueError, b.index, w)
479
480 self.assertEqual(b.index(b'ss', 3), 5)
481 self.assertEqual(b.index(b'ss', 1, 7), 2)
482 self.assertRaises(ValueError, b.index, b'ss', 1, 3)
483
484 self.assertEqual(b.index(i, 6), 7)
485 self.assertEqual(b.index(i, 1, 3), 1)
486 self.assertRaises(ValueError, b.index, w, 1, 3)
Christian Heimes510711d2008-01-30 11:57:58 +0000487
488 def test_rindex(self):
Antoine Pitrouac65d962011-10-20 23:54:17 +0200489 b = self.type2test(b'mississippi')
490 i = 105
491 w = 119
492
493 self.assertEqual(b.rindex(b'ss'), 5)
494 self.assertRaises(ValueError, b.rindex, b'w')
495 self.assertRaises(ValueError, b.rindex, b'mississippian')
496
497 self.assertEqual(b.rindex(i), 10)
498 self.assertRaises(ValueError, b.rindex, w)
499
500 self.assertEqual(b.rindex(b'ss', 3), 5)
501 self.assertEqual(b.rindex(b'ss', 0, 6), 2)
502
503 self.assertEqual(b.rindex(i, 1, 3), 1)
504 self.assertEqual(b.rindex(i, 3, 9), 7)
505 self.assertRaises(ValueError, b.rindex, w, 1, 3)
Christian Heimes510711d2008-01-30 11:57:58 +0000506
Ethan Furmanb95b5612015-01-23 20:05:18 -0800507 def test_mod(self):
Serhiy Storchakac9a59e62016-04-15 14:11:10 +0300508 b = self.type2test(b'hello, %b!')
Ethan Furmanb95b5612015-01-23 20:05:18 -0800509 orig = b
510 b = b % b'world'
511 self.assertEqual(b, b'hello, world!')
512 self.assertEqual(orig, b'hello, %b!')
513 self.assertFalse(b is orig)
Serhiy Storchakac9a59e62016-04-15 14:11:10 +0300514 b = self.type2test(b'%s / 100 = %d%%')
Ethan Furmanb95b5612015-01-23 20:05:18 -0800515 a = b % (b'seventy-nine', 79)
Serhiy Storchaka4e1942b2015-01-26 09:28:11 +0200516 self.assertEqual(a, b'seventy-nine / 100 = 79%')
Victor Stinnere914d412016-04-15 17:52:27 +0200517 self.assertIs(type(a), self.type2test)
Xiang Zhangb76ad512017-03-06 17:17:05 +0800518 # issue 29714
519 b = self.type2test(b'hello,\x00%b!')
520 b = b % b'world'
521 self.assertEqual(b, b'hello,\x00world!')
522 self.assertIs(type(b), self.type2test)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800523
524 def test_imod(self):
Serhiy Storchakac9a59e62016-04-15 14:11:10 +0300525 b = self.type2test(b'hello, %b!')
Ethan Furmanb95b5612015-01-23 20:05:18 -0800526 orig = b
527 b %= b'world'
528 self.assertEqual(b, b'hello, world!')
529 self.assertEqual(orig, b'hello, %b!')
530 self.assertFalse(b is orig)
Serhiy Storchakac9a59e62016-04-15 14:11:10 +0300531 b = self.type2test(b'%s / 100 = %d%%')
Ethan Furmanb95b5612015-01-23 20:05:18 -0800532 b %= (b'seventy-nine', 79)
Serhiy Storchaka4e1942b2015-01-26 09:28:11 +0200533 self.assertEqual(b, b'seventy-nine / 100 = 79%')
Victor Stinnere914d412016-04-15 17:52:27 +0200534 self.assertIs(type(b), self.type2test)
Xiang Zhangb76ad512017-03-06 17:17:05 +0800535 # issue 29714
536 b = self.type2test(b'hello,\x00%b!')
537 b %= b'world'
538 self.assertEqual(b, b'hello,\x00world!')
539 self.assertIs(type(b), self.type2test)
Serhiy Storchakac9a59e62016-04-15 14:11:10 +0300540
541 def test_rmod(self):
542 with self.assertRaises(TypeError):
543 object() % self.type2test(b'abc')
544 self.assertIs(self.type2test(b'abc').__rmod__('%r'), NotImplemented)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800545
Christian Heimes510711d2008-01-30 11:57:58 +0000546 def test_replace(self):
547 b = self.type2test(b'mississippi')
548 self.assertEqual(b.replace(b'i', b'a'), b'massassappa')
549 self.assertEqual(b.replace(b'ss', b'x'), b'mixixippi')
550
Christian Heimes510711d2008-01-30 11:57:58 +0000551 def test_split_string_error(self):
552 self.assertRaises(TypeError, self.type2test(b'a b').split, ' ')
553
Antoine Pitrouf8453022010-01-12 22:05:42 +0000554 def test_split_unicodewhitespace(self):
Martin Panter0d0db6c2016-04-10 08:45:26 +0000555 for b in (b'a\x1Cb', b'a\x1Db', b'a\x1Eb', b'a\x1Fb'):
556 b = self.type2test(b)
557 self.assertEqual(b.split(), [b])
Antoine Pitrouf8453022010-01-12 22:05:42 +0000558 b = self.type2test(b"\x09\x0A\x0B\x0C\x0D\x1C\x1D\x1E\x1F")
559 self.assertEqual(b.split(), [b'\x1c\x1d\x1e\x1f'])
560
Christian Heimes510711d2008-01-30 11:57:58 +0000561 def test_rsplit_string_error(self):
562 self.assertRaises(TypeError, self.type2test(b'a b').rsplit, ' ')
563
564 def test_rsplit_unicodewhitespace(self):
565 b = self.type2test(b"\x09\x0A\x0B\x0C\x0D\x1C\x1D\x1E\x1F")
Christian Heimes510711d2008-01-30 11:57:58 +0000566 self.assertEqual(b.rsplit(), [b'\x1c\x1d\x1e\x1f'])
567
568 def test_partition(self):
569 b = self.type2test(b'mississippi')
570 self.assertEqual(b.partition(b'ss'), (b'mi', b'ss', b'issippi'))
Antoine Pitrouf8453022010-01-12 22:05:42 +0000571 self.assertEqual(b.partition(b'w'), (b'mississippi', b'', b''))
Christian Heimes510711d2008-01-30 11:57:58 +0000572
573 def test_rpartition(self):
574 b = self.type2test(b'mississippi')
575 self.assertEqual(b.rpartition(b'ss'), (b'missi', b'ss', b'ippi'))
576 self.assertEqual(b.rpartition(b'i'), (b'mississipp', b'i', b''))
Antoine Pitrouf8453022010-01-12 22:05:42 +0000577 self.assertEqual(b.rpartition(b'w'), (b'', b'', b'mississippi'))
Christian Heimes510711d2008-01-30 11:57:58 +0000578
579 def test_pickling(self):
Hirokazu Yamamotod0d0b652008-10-23 00:38:15 +0000580 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
Christian Heimes510711d2008-01-30 11:57:58 +0000581 for b in b"", b"a", b"abc", b"\xffab\x80", b"\0\0\377\0\0":
582 b = self.type2test(b)
583 ps = pickle.dumps(b, proto)
584 q = pickle.loads(ps)
585 self.assertEqual(b, q)
586
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000587 def test_iterator_pickling(self):
Serhiy Storchakabad12572014-12-15 14:03:42 +0200588 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
589 for b in b"", b"a", b"abc", b"\xffab\x80", b"\0\0\377\0\0":
590 it = itorg = iter(self.type2test(b))
591 data = list(self.type2test(b))
592 d = pickle.dumps(it, proto)
593 it = pickle.loads(d)
594 self.assertEqual(type(itorg), type(it))
595 self.assertEqual(list(it), data)
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000596
Serhiy Storchakabad12572014-12-15 14:03:42 +0200597 it = pickle.loads(d)
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200598 if not b:
Serhiy Storchakabad12572014-12-15 14:03:42 +0200599 continue
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200600 next(it)
Serhiy Storchakabad12572014-12-15 14:03:42 +0200601 d = pickle.dumps(it, proto)
602 it = pickle.loads(d)
603 self.assertEqual(list(it), data[1:])
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000604
Christian Heimes510711d2008-01-30 11:57:58 +0000605 def test_strip_bytearray(self):
606 self.assertEqual(self.type2test(b'abc').strip(memoryview(b'ac')), b'b')
607 self.assertEqual(self.type2test(b'abc').lstrip(memoryview(b'ac')), b'bc')
608 self.assertEqual(self.type2test(b'abc').rstrip(memoryview(b'ac')), b'ab')
609
610 def test_strip_string_error(self):
611 self.assertRaises(TypeError, self.type2test(b'abc').strip, 'b')
612 self.assertRaises(TypeError, self.type2test(b'abc').lstrip, 'b')
613 self.assertRaises(TypeError, self.type2test(b'abc').rstrip, 'b')
614
Eli Bendersky906b88f2011-07-29 07:05:08 +0300615 def test_center(self):
616 # Fill character can be either bytes or bytearray (issue 12380)
617 b = self.type2test(b'abc')
618 for fill_type in (bytes, bytearray):
619 self.assertEqual(b.center(7, fill_type(b'-')),
620 self.type2test(b'--abc--'))
621
622 def test_ljust(self):
623 # Fill character can be either bytes or bytearray (issue 12380)
624 b = self.type2test(b'abc')
625 for fill_type in (bytes, bytearray):
626 self.assertEqual(b.ljust(7, fill_type(b'-')),
627 self.type2test(b'abc----'))
628
629 def test_rjust(self):
630 # Fill character can be either bytes or bytearray (issue 12380)
631 b = self.type2test(b'abc')
632 for fill_type in (bytes, bytearray):
633 self.assertEqual(b.rjust(7, fill_type(b'-')),
634 self.type2test(b'----abc'))
635
Christian Heimes510711d2008-01-30 11:57:58 +0000636 def test_ord(self):
637 b = self.type2test(b'\0A\x7f\x80\xff')
638 self.assertEqual([ord(b[i:i+1]) for i in range(len(b))],
639 [0, 65, 127, 128, 255])
640
Georg Brandlabc38772009-04-12 15:51:51 +0000641 def test_maketrans(self):
642 transtable = b'\000\001\002\003\004\005\006\007\010\011\012\013\014\015\016\017\020\021\022\023\024\025\026\027\030\031\032\033\034\035\036\037 !"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`xyzdefghijklmnopqrstuvwxyz{|}~\177\200\201\202\203\204\205\206\207\210\211\212\213\214\215\216\217\220\221\222\223\224\225\226\227\230\231\232\233\234\235\236\237\240\241\242\243\244\245\246\247\250\251\252\253\254\255\256\257\260\261\262\263\264\265\266\267\270\271\272\273\274\275\276\277\300\301\302\303\304\305\306\307\310\311\312\313\314\315\316\317\320\321\322\323\324\325\326\327\330\331\332\333\334\335\336\337\340\341\342\343\344\345\346\347\350\351\352\353\354\355\356\357\360\361\362\363\364\365\366\367\370\371\372\373\374\375\376\377'
Georg Brandlabc38772009-04-12 15:51:51 +0000643 self.assertEqual(self.type2test.maketrans(b'abc', b'xyz'), transtable)
Antoine Pitrou403ce782009-10-14 17:14:16 +0000644 transtable = b'\000\001\002\003\004\005\006\007\010\011\012\013\014\015\016\017\020\021\022\023\024\025\026\027\030\031\032\033\034\035\036\037 !"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~\177\200\201\202\203\204\205\206\207\210\211\212\213\214\215\216\217\220\221\222\223\224\225\226\227\230\231\232\233\234\235\236\237\240\241\242\243\244\245\246\247\250\251\252\253\254\255\256\257\260\261\262\263\264\265\266\267\270\271\272\273\274\275\276\277\300\301\302\303\304\305\306\307\310\311\312\313\314\315\316\317\320\321\322\323\324\325\326\327\330\331\332\333\334\335\336\337\340\341\342\343\344\345\346\347\350\351\352\353\354\355\356\357\360\361\362\363\364\365\366\367\370\371\372\373\374xyz'
645 self.assertEqual(self.type2test.maketrans(b'\375\376\377', b'xyz'), transtable)
Georg Brandlabc38772009-04-12 15:51:51 +0000646 self.assertRaises(ValueError, self.type2test.maketrans, b'abc', b'xyzq')
647 self.assertRaises(TypeError, self.type2test.maketrans, 'abc', 'def')
648
Jesus Ceaac451502011-04-20 17:09:23 +0200649 def test_none_arguments(self):
650 # issue 11828
651 b = self.type2test(b'hello')
652 l = self.type2test(b'l')
653 h = self.type2test(b'h')
654 x = self.type2test(b'x')
655 o = self.type2test(b'o')
656
657 self.assertEqual(2, b.find(l, None))
658 self.assertEqual(3, b.find(l, -2, None))
659 self.assertEqual(2, b.find(l, None, -2))
660 self.assertEqual(0, b.find(h, None, None))
661
662 self.assertEqual(3, b.rfind(l, None))
663 self.assertEqual(3, b.rfind(l, -2, None))
664 self.assertEqual(2, b.rfind(l, None, -2))
665 self.assertEqual(0, b.rfind(h, None, None))
666
667 self.assertEqual(2, b.index(l, None))
668 self.assertEqual(3, b.index(l, -2, None))
669 self.assertEqual(2, b.index(l, None, -2))
670 self.assertEqual(0, b.index(h, None, None))
671
672 self.assertEqual(3, b.rindex(l, None))
673 self.assertEqual(3, b.rindex(l, -2, None))
674 self.assertEqual(2, b.rindex(l, None, -2))
675 self.assertEqual(0, b.rindex(h, None, None))
676
677 self.assertEqual(2, b.count(l, None))
678 self.assertEqual(1, b.count(l, -2, None))
679 self.assertEqual(1, b.count(l, None, -2))
680 self.assertEqual(0, b.count(x, None, None))
681
682 self.assertEqual(True, b.endswith(o, None))
683 self.assertEqual(True, b.endswith(o, -2, None))
684 self.assertEqual(True, b.endswith(l, None, -2))
685 self.assertEqual(False, b.endswith(x, None, None))
686
687 self.assertEqual(True, b.startswith(h, None))
688 self.assertEqual(True, b.startswith(l, -2, None))
689 self.assertEqual(True, b.startswith(h, None, -2))
690 self.assertEqual(False, b.startswith(x, None, None))
691
Antoine Pitrouac65d962011-10-20 23:54:17 +0200692 def test_integer_arguments_out_of_byte_range(self):
693 b = self.type2test(b'hello')
694
695 for method in (b.count, b.find, b.index, b.rfind, b.rindex):
696 self.assertRaises(ValueError, method, -1)
697 self.assertRaises(ValueError, method, 256)
698 self.assertRaises(ValueError, method, 9999)
699
Jesus Ceaac451502011-04-20 17:09:23 +0200700 def test_find_etc_raise_correct_error_messages(self):
701 # issue 11828
702 b = self.type2test(b'hello')
703 x = self.type2test(b'x')
Ezio Melottiaf928422011-04-20 21:56:21 +0300704 self.assertRaisesRegex(TypeError, r'\bfind\b', b.find,
Jesus Ceaac451502011-04-20 17:09:23 +0200705 x, None, None, None)
Ezio Melottiaf928422011-04-20 21:56:21 +0300706 self.assertRaisesRegex(TypeError, r'\brfind\b', b.rfind,
Jesus Ceaac451502011-04-20 17:09:23 +0200707 x, None, None, None)
Ezio Melottiaf928422011-04-20 21:56:21 +0300708 self.assertRaisesRegex(TypeError, r'\bindex\b', b.index,
Jesus Ceaac451502011-04-20 17:09:23 +0200709 x, None, None, None)
Ezio Melottiaf928422011-04-20 21:56:21 +0300710 self.assertRaisesRegex(TypeError, r'\brindex\b', b.rindex,
Jesus Ceaac451502011-04-20 17:09:23 +0200711 x, None, None, None)
Ezio Melottiaf928422011-04-20 21:56:21 +0300712 self.assertRaisesRegex(TypeError, r'\bcount\b', b.count,
Jesus Ceaac451502011-04-20 17:09:23 +0200713 x, None, None, None)
Ezio Melottiaf928422011-04-20 21:56:21 +0300714 self.assertRaisesRegex(TypeError, r'\bstartswith\b', b.startswith,
Jesus Ceaac451502011-04-20 17:09:23 +0200715 x, None, None, None)
Ezio Melottiaf928422011-04-20 21:56:21 +0300716 self.assertRaisesRegex(TypeError, r'\bendswith\b', b.endswith,
Jesus Ceaac451502011-04-20 17:09:23 +0200717 x, None, None, None)
718
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +0300719 def test_free_after_iterating(self):
720 test.support.check_free_after_iterating(self, iter, self.type2test)
721 test.support.check_free_after_iterating(self, reversed, self.type2test)
722
Martin Panter1b6c6da2016-08-27 08:35:02 +0000723 def test_translate(self):
724 b = self.type2test(b'hello')
725 rosetta = bytearray(range(256))
726 rosetta[ord('o')] = ord('e')
727
728 self.assertRaises(TypeError, b.translate)
729 self.assertRaises(TypeError, b.translate, None, None)
730 self.assertRaises(ValueError, b.translate, bytes(range(255)))
731
732 c = b.translate(rosetta, b'hello')
733 self.assertEqual(b, b'hello')
734 self.assertIsInstance(c, self.type2test)
735
736 c = b.translate(rosetta)
737 d = b.translate(rosetta, b'')
738 self.assertEqual(c, d)
739 self.assertEqual(c, b'helle')
740
741 c = b.translate(rosetta, b'l')
742 self.assertEqual(c, b'hee')
743 c = b.translate(None, b'e')
744 self.assertEqual(c, b'hllo')
745
746 # test delete as a keyword argument
747 c = b.translate(rosetta, delete=b'')
748 self.assertEqual(c, b'helle')
749 c = b.translate(rosetta, delete=b'l')
750 self.assertEqual(c, b'hee')
751 c = b.translate(None, delete=b'e')
752 self.assertEqual(c, b'hllo')
753
Christian Heimes510711d2008-01-30 11:57:58 +0000754
Ezio Melotti0dceb562013-01-10 07:43:26 +0200755class BytesTest(BaseBytesTest, unittest.TestCase):
Christian Heimes510711d2008-01-30 11:57:58 +0000756 type2test = bytes
757
Terry Jan Reedyffff1442014-08-02 01:30:37 -0400758 def test_getitem_error(self):
759 msg = "byte indices must be integers or slices"
760 with self.assertRaisesRegex(TypeError, msg):
761 b'python'['a']
762
Antoine Pitrou2f89aa62008-08-02 21:02:48 +0000763 def test_buffer_is_readonly(self):
Victor Stinner76119642014-07-28 22:07:07 +0200764 fd = os.open(__file__, os.O_RDONLY)
Antoine Pitrou47d305d2008-08-16 23:28:44 +0000765 with open(fd, "rb", buffering=0) as f:
Antoine Pitrou2f89aa62008-08-02 21:02:48 +0000766 self.assertRaises(TypeError, f.readinto, b"")
767
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000768 def test_custom(self):
769 class A:
770 def __bytes__(self):
771 return b'abc'
772 self.assertEqual(bytes(A()), b'abc')
773 class A: pass
774 self.assertRaises(TypeError, bytes, A())
775 class A:
776 def __bytes__(self):
777 return None
778 self.assertRaises(TypeError, bytes, A())
Benjamin Peterson5ff3f732012-12-19 15:27:41 -0600779 class A:
780 def __bytes__(self):
781 return b'a'
782 def __index__(self):
783 return 42
784 self.assertEqual(bytes(A()), b'a')
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +0200785 # Issue #25766
786 class A(str):
787 def __bytes__(self):
788 return b'abc'
789 self.assertEqual(bytes(A('\u20ac')), b'abc')
790 self.assertEqual(bytes(A('\u20ac'), 'iso8859-15'), b'\xa4')
Serhiy Storchaka15095802015-11-25 15:47:01 +0200791 # Issue #24731
792 class A:
793 def __bytes__(self):
794 return OtherBytesSubclass(b'abc')
795 self.assertEqual(bytes(A()), b'abc')
796 self.assertIs(type(bytes(A())), OtherBytesSubclass)
797 self.assertEqual(BytesSubclass(A()), b'abc')
798 self.assertIs(type(BytesSubclass(A())), BytesSubclass)
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000799
Victor Stinner29e762c2011-01-05 03:33:28 +0000800 # Test PyBytes_FromFormat()
801 def test_from_format(self):
Victor Stinner7ab986d2015-10-14 02:55:12 +0200802 ctypes = test.support.import_module('ctypes')
Victor Stinner03dab782015-10-14 00:21:35 +0200803 _testcapi = test.support.import_module('_testcapi')
804 from ctypes import pythonapi, py_object
805 from ctypes import (
806 c_int, c_uint,
807 c_long, c_ulong,
808 c_size_t, c_ssize_t,
809 c_char_p)
810
Victor Stinner29e762c2011-01-05 03:33:28 +0000811 PyBytes_FromFormat = pythonapi.PyBytes_FromFormat
812 PyBytes_FromFormat.restype = py_object
813
Victor Stinner03dab782015-10-14 00:21:35 +0200814 # basic tests
Victor Stinner29e762c2011-01-05 03:33:28 +0000815 self.assertEqual(PyBytes_FromFormat(b'format'),
816 b'format')
Victor Stinner03dab782015-10-14 00:21:35 +0200817 self.assertEqual(PyBytes_FromFormat(b'Hello %s !', b'world'),
818 b'Hello world !')
Victor Stinner29e762c2011-01-05 03:33:28 +0000819
Victor Stinner03dab782015-10-14 00:21:35 +0200820 # test formatters
821 self.assertEqual(PyBytes_FromFormat(b'c=%c', c_int(0)),
822 b'c=\0')
823 self.assertEqual(PyBytes_FromFormat(b'c=%c', c_int(ord('@'))),
824 b'c=@')
825 self.assertEqual(PyBytes_FromFormat(b'c=%c', c_int(255)),
826 b'c=\xff')
827 self.assertEqual(PyBytes_FromFormat(b'd=%d ld=%ld zd=%zd',
828 c_int(1), c_long(2),
829 c_size_t(3)),
830 b'd=1 ld=2 zd=3')
831 self.assertEqual(PyBytes_FromFormat(b'd=%d ld=%ld zd=%zd',
832 c_int(-1), c_long(-2),
833 c_size_t(-3)),
834 b'd=-1 ld=-2 zd=-3')
835 self.assertEqual(PyBytes_FromFormat(b'u=%u lu=%lu zu=%zu',
836 c_uint(123), c_ulong(456),
837 c_size_t(789)),
838 b'u=123 lu=456 zu=789')
839 self.assertEqual(PyBytes_FromFormat(b'i=%i', c_int(123)),
840 b'i=123')
841 self.assertEqual(PyBytes_FromFormat(b'i=%i', c_int(-123)),
842 b'i=-123')
843 self.assertEqual(PyBytes_FromFormat(b'x=%x', c_int(0xabc)),
844 b'x=abc')
Victor Stinner83ff8a62015-10-14 15:28:59 +0200845
846 sizeof_ptr = ctypes.sizeof(c_char_p)
847
848 if os.name == 'nt':
849 # Windows (MSCRT)
850 ptr_format = '0x%0{}X'.format(2 * sizeof_ptr)
851 def ptr_formatter(ptr):
852 return (ptr_format % ptr)
853 else:
854 # UNIX (glibc)
855 def ptr_formatter(ptr):
856 return '%#x' % ptr
857
Victor Stinner7ab986d2015-10-14 02:55:12 +0200858 ptr = 0xabcdef
Victor Stinner83ff8a62015-10-14 15:28:59 +0200859 self.assertEqual(PyBytes_FromFormat(b'ptr=%p', c_char_p(ptr)),
860 ('ptr=' + ptr_formatter(ptr)).encode('ascii'))
Victor Stinner03dab782015-10-14 00:21:35 +0200861 self.assertEqual(PyBytes_FromFormat(b's=%s', c_char_p(b'cstr')),
862 b's=cstr')
863
864 # test minimum and maximum integer values
865 size_max = c_size_t(-1).value
866 for formatstr, ctypes_type, value, py_formatter in (
867 (b'%d', c_int, _testcapi.INT_MIN, str),
868 (b'%d', c_int, _testcapi.INT_MAX, str),
869 (b'%ld', c_long, _testcapi.LONG_MIN, str),
870 (b'%ld', c_long, _testcapi.LONG_MAX, str),
871 (b'%lu', c_ulong, _testcapi.ULONG_MAX, str),
872 (b'%zd', c_ssize_t, _testcapi.PY_SSIZE_T_MIN, str),
873 (b'%zd', c_ssize_t, _testcapi.PY_SSIZE_T_MAX, str),
874 (b'%zu', c_size_t, size_max, str),
Victor Stinner83ff8a62015-10-14 15:28:59 +0200875 (b'%p', c_char_p, size_max, ptr_formatter),
Victor Stinner03dab782015-10-14 00:21:35 +0200876 ):
877 self.assertEqual(PyBytes_FromFormat(formatstr, ctypes_type(value)),
878 py_formatter(value).encode('ascii')),
879
880 # width and precision (width is currently ignored)
881 self.assertEqual(PyBytes_FromFormat(b'%5s', b'a'),
882 b'a')
883 self.assertEqual(PyBytes_FromFormat(b'%.3s', b'abcdef'),
884 b'abc')
885
886 # '%%' formatter
887 self.assertEqual(PyBytes_FromFormat(b'%%'),
888 b'%')
889 self.assertEqual(PyBytes_FromFormat(b'[%%]'),
890 b'[%]')
891 self.assertEqual(PyBytes_FromFormat(b'%%%c', c_int(ord('_'))),
892 b'%_')
893 self.assertEqual(PyBytes_FromFormat(b'%%s'),
894 b'%s')
895
896 # Invalid formats and partial formatting
Victor Stinner29e762c2011-01-05 03:33:28 +0000897 self.assertEqual(PyBytes_FromFormat(b'%'), b'%')
Victor Stinner03dab782015-10-14 00:21:35 +0200898 self.assertEqual(PyBytes_FromFormat(b'x=%i y=%', c_int(2), c_int(3)),
899 b'x=2 y=%')
Victor Stinner29e762c2011-01-05 03:33:28 +0000900
Victor Stinner03dab782015-10-14 00:21:35 +0200901 # Issue #19969: %c must raise OverflowError for values
902 # not in the range [0; 255]
Victor Stinnerc9362cf2013-12-13 12:14:44 +0100903 self.assertRaises(OverflowError,
904 PyBytes_FromFormat, b'%c', c_int(-1))
905 self.assertRaises(OverflowError,
906 PyBytes_FromFormat, b'%c', c_int(256))
907
Guido van Rossum97c1adf2016-08-18 09:22:23 -0700908 def test_bytes_blocking(self):
909 class IterationBlocked(list):
910 __bytes__ = None
911 i = [0, 1, 2, 3]
912 self.assertEqual(bytes(i), b'\x00\x01\x02\x03')
913 self.assertRaises(TypeError, bytes, IterationBlocked(i))
914
915 # At least in CPython, because bytes.__new__ and the C API
916 # PyBytes_FromObject have different fallback rules, integer
917 # fallback is handled specially, so test separately.
918 class IntBlocked(int):
919 __bytes__ = None
920 self.assertEqual(bytes(3), b'\0\0\0')
921 self.assertRaises(TypeError, bytes, IntBlocked(3))
922
923 # While there is no separately-defined rule for handling bytes
924 # subclasses differently from other buffer-interface classes,
925 # an implementation may well special-case them (as CPython 2.x
926 # str did), so test them separately.
927 class BytesSubclassBlocked(bytes):
928 __bytes__ = None
929 self.assertEqual(bytes(b'ab'), b'ab')
930 self.assertRaises(TypeError, bytes, BytesSubclassBlocked(b'ab'))
931
932 class BufferBlocked(bytearray):
933 __bytes__ = None
934 ba, bb = bytearray(b'ab'), BufferBlocked(b'ab')
935 self.assertEqual(bytes(ba), b'ab')
936 self.assertRaises(TypeError, bytes, bb)
937
Antoine Pitrou2f89aa62008-08-02 21:02:48 +0000938
Ezio Melotti0dceb562013-01-10 07:43:26 +0200939class ByteArrayTest(BaseBytesTest, unittest.TestCase):
Christian Heimes510711d2008-01-30 11:57:58 +0000940 type2test = bytearray
Guido van Rossumebea9be2007-04-09 00:49:13 +0000941
Terry Jan Reedyffff1442014-08-02 01:30:37 -0400942 def test_getitem_error(self):
943 msg = "bytearray indices must be integers or slices"
944 with self.assertRaisesRegex(TypeError, msg):
945 bytearray(b'python')['a']
946
947 def test_setitem_error(self):
948 msg = "bytearray indices must be integers or slices"
949 with self.assertRaisesRegex(TypeError, msg):
950 b = bytearray(b'python')
951 b['a'] = "python"
952
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000953 def test_nohash(self):
Guido van Rossum254348e2007-11-21 19:29:53 +0000954 self.assertRaises(TypeError, hash, bytearray())
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000955
Guido van Rossum254348e2007-11-21 19:29:53 +0000956 def test_bytearray_api(self):
Guido van Rossum75d6f1a2007-05-24 17:52:00 +0000957 short_sample = b"Hello world\n"
Guido van Rossum98297ee2007-11-06 21:34:58 +0000958 sample = short_sample + b"\0"*(20 - len(short_sample))
Guido van Rossumd624f182006-04-24 13:47:05 +0000959 tfn = tempfile.mktemp()
960 try:
961 # Prepare
962 with open(tfn, "wb") as f:
963 f.write(short_sample)
964 # Test readinto
965 with open(tfn, "rb") as f:
Guido van Rossum254348e2007-11-21 19:29:53 +0000966 b = bytearray(20)
Guido van Rossumd624f182006-04-24 13:47:05 +0000967 n = f.readinto(b)
968 self.assertEqual(n, len(short_sample))
Guido van Rossumc1f779c2007-07-03 08:25:58 +0000969 self.assertEqual(list(b), list(sample))
Guido van Rossumd624f182006-04-24 13:47:05 +0000970 # Test writing in binary mode
971 with open(tfn, "wb") as f:
972 f.write(b)
973 with open(tfn, "rb") as f:
974 self.assertEqual(f.read(), sample)
Guido van Rossum13633bb2007-04-13 18:42:35 +0000975 # Text mode is ambiguous; don't test
Guido van Rossumd624f182006-04-24 13:47:05 +0000976 finally:
977 try:
978 os.remove(tfn)
Andrew Svetlov8b33dd82012-12-24 19:58:48 +0200979 except OSError:
Guido van Rossumd624f182006-04-24 13:47:05 +0000980 pass
981
Neal Norwitz6968b052007-02-27 19:02:19 +0000982 def test_reverse(self):
Guido van Rossum254348e2007-11-21 19:29:53 +0000983 b = bytearray(b'hello')
Neal Norwitz6968b052007-02-27 19:02:19 +0000984 self.assertEqual(b.reverse(), None)
985 self.assertEqual(b, b'olleh')
Guido van Rossum254348e2007-11-21 19:29:53 +0000986 b = bytearray(b'hello1') # test even number of items
Neal Norwitz6968b052007-02-27 19:02:19 +0000987 b.reverse()
988 self.assertEqual(b, b'1olleh')
Guido van Rossum254348e2007-11-21 19:29:53 +0000989 b = bytearray()
Neal Norwitz6968b052007-02-27 19:02:19 +0000990 b.reverse()
991 self.assertFalse(b)
992
Eli Bendersky4db28d32011-03-03 18:21:02 +0000993 def test_clear(self):
994 b = bytearray(b'python')
995 b.clear()
996 self.assertEqual(b, b'')
997
998 b = bytearray(b'')
999 b.clear()
1000 self.assertEqual(b, b'')
1001
1002 b = bytearray(b'')
1003 b.append(ord('r'))
1004 b.clear()
1005 b.append(ord('p'))
1006 self.assertEqual(b, b'p')
1007
1008 def test_copy(self):
1009 b = bytearray(b'abc')
1010 bb = b.copy()
1011 self.assertEqual(bb, b'abc')
1012
1013 b = bytearray(b'')
1014 bb = b.copy()
1015 self.assertEqual(bb, b'')
1016
1017 # test that it's indeed a copy and not a reference
1018 b = bytearray(b'abc')
1019 bb = b.copy()
1020 self.assertEqual(b, bb)
1021 self.assertIsNot(b, bb)
1022 bb.append(ord('d'))
1023 self.assertEqual(bb, b'abcd')
1024 self.assertEqual(b, b'abc')
1025
Guido van Rossumd624f182006-04-24 13:47:05 +00001026 def test_regexps(self):
1027 def by(s):
Guido van Rossum254348e2007-11-21 19:29:53 +00001028 return bytearray(map(ord, s))
Guido van Rossumd624f182006-04-24 13:47:05 +00001029 b = by("Hello, world")
Antoine Pitroufd036452008-08-19 17:56:33 +00001030 self.assertEqual(re.findall(br"\w+", b), [by("Hello"), by("world")])
Guido van Rossumd624f182006-04-24 13:47:05 +00001031
1032 def test_setitem(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001033 b = bytearray([1, 2, 3])
Guido van Rossumd624f182006-04-24 13:47:05 +00001034 b[1] = 100
Guido van Rossum254348e2007-11-21 19:29:53 +00001035 self.assertEqual(b, bytearray([1, 100, 3]))
Guido van Rossumd624f182006-04-24 13:47:05 +00001036 b[-1] = 200
Guido van Rossum254348e2007-11-21 19:29:53 +00001037 self.assertEqual(b, bytearray([1, 100, 200]))
Georg Brandl9a54d7c2008-07-16 23:15:30 +00001038 b[0] = Indexable(10)
Guido van Rossum254348e2007-11-21 19:29:53 +00001039 self.assertEqual(b, bytearray([10, 100, 200]))
Guido van Rossumd624f182006-04-24 13:47:05 +00001040 try:
1041 b[3] = 0
1042 self.fail("Didn't raise IndexError")
1043 except IndexError:
1044 pass
1045 try:
1046 b[-10] = 0
1047 self.fail("Didn't raise IndexError")
1048 except IndexError:
1049 pass
1050 try:
1051 b[0] = 256
1052 self.fail("Didn't raise ValueError")
1053 except ValueError:
1054 pass
1055 try:
Georg Brandl9a54d7c2008-07-16 23:15:30 +00001056 b[0] = Indexable(-1)
Guido van Rossumd624f182006-04-24 13:47:05 +00001057 self.fail("Didn't raise ValueError")
1058 except ValueError:
1059 pass
1060 try:
1061 b[0] = None
1062 self.fail("Didn't raise TypeError")
1063 except TypeError:
1064 pass
1065
1066 def test_delitem(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001067 b = bytearray(range(10))
Guido van Rossumd624f182006-04-24 13:47:05 +00001068 del b[0]
Guido van Rossum254348e2007-11-21 19:29:53 +00001069 self.assertEqual(b, bytearray(range(1, 10)))
Guido van Rossumd624f182006-04-24 13:47:05 +00001070 del b[-1]
Guido van Rossum254348e2007-11-21 19:29:53 +00001071 self.assertEqual(b, bytearray(range(1, 9)))
Guido van Rossumd624f182006-04-24 13:47:05 +00001072 del b[4]
Guido van Rossum254348e2007-11-21 19:29:53 +00001073 self.assertEqual(b, bytearray([1, 2, 3, 4, 6, 7, 8]))
Guido van Rossumd624f182006-04-24 13:47:05 +00001074
1075 def test_setslice(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001076 b = bytearray(range(10))
Guido van Rossumd624f182006-04-24 13:47:05 +00001077 self.assertEqual(list(b), list(range(10)))
1078
Guido van Rossum254348e2007-11-21 19:29:53 +00001079 b[0:5] = bytearray([1, 1, 1, 1, 1])
1080 self.assertEqual(b, bytearray([1, 1, 1, 1, 1, 5, 6, 7, 8, 9]))
Guido van Rossumd624f182006-04-24 13:47:05 +00001081
1082 del b[0:-5]
Guido van Rossum254348e2007-11-21 19:29:53 +00001083 self.assertEqual(b, bytearray([5, 6, 7, 8, 9]))
Guido van Rossumd624f182006-04-24 13:47:05 +00001084
Guido van Rossum254348e2007-11-21 19:29:53 +00001085 b[0:0] = bytearray([0, 1, 2, 3, 4])
1086 self.assertEqual(b, bytearray(range(10)))
Guido van Rossumd624f182006-04-24 13:47:05 +00001087
Guido van Rossum254348e2007-11-21 19:29:53 +00001088 b[-7:-3] = bytearray([100, 101])
1089 self.assertEqual(b, bytearray([0, 1, 2, 100, 101, 7, 8, 9]))
Guido van Rossumd624f182006-04-24 13:47:05 +00001090
1091 b[3:5] = [3, 4, 5, 6]
Guido van Rossum254348e2007-11-21 19:29:53 +00001092 self.assertEqual(b, bytearray(range(10)))
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001093
Thomas Wouters9a6e62b2006-08-23 23:20:29 +00001094 b[3:0] = [42, 42, 42]
Guido van Rossum254348e2007-11-21 19:29:53 +00001095 self.assertEqual(b, bytearray([0, 1, 2, 42, 42, 42, 3, 4, 5, 6, 7, 8, 9]))
Guido van Rossumd624f182006-04-24 13:47:05 +00001096
Ezio Melottic64bcbe2012-11-03 21:19:06 +02001097 b[3:] = b'foo'
1098 self.assertEqual(b, bytearray([0, 1, 2, 102, 111, 111]))
1099
1100 b[:3] = memoryview(b'foo')
1101 self.assertEqual(b, bytearray([102, 111, 111, 102, 111, 111]))
1102
1103 b[3:4] = []
1104 self.assertEqual(b, bytearray([102, 111, 111, 111, 111]))
1105
1106 for elem in [5, -5, 0, int(10e20), 'str', 2.3,
1107 ['a', 'b'], [b'a', b'b'], [[]]]:
1108 with self.assertRaises(TypeError):
1109 b[3:4] = elem
1110
1111 for elem in [[254, 255, 256], [-256, 9000]]:
1112 with self.assertRaises(ValueError):
1113 b[3:4] = elem
1114
Antoine Pitrou5df8a8a2013-10-05 21:12:18 +02001115 def test_setslice_extend(self):
1116 # Exercise the resizing logic (see issue #19087)
1117 b = bytearray(range(100))
1118 self.assertEqual(list(b), list(range(100)))
1119 del b[:10]
1120 self.assertEqual(list(b), list(range(10, 100)))
1121 b.extend(range(100, 110))
1122 self.assertEqual(list(b), list(range(10, 110)))
1123
Antoine Pitrou25454112015-05-19 20:52:27 +02001124 def test_fifo_overrun(self):
1125 # Test for issue #23985, a buffer overrun when implementing a FIFO
1126 # Build Python in pydebug mode for best results.
1127 b = bytearray(10)
1128 b.pop() # Defeat expanding buffer off-by-one quirk
1129 del b[:1] # Advance start pointer without reallocating
1130 b += bytes(2) # Append exactly the number of deleted bytes
1131 del b # Free memory buffer, allowing pydebug verification
1132
1133 def test_del_expand(self):
1134 # Reducing the size should not expand the buffer (issue #23985)
1135 b = bytearray(10)
1136 size = sys.getsizeof(b)
1137 del b[:1]
1138 self.assertLessEqual(sys.getsizeof(b), size)
1139
Thomas Wouters376446d2006-12-19 08:30:14 +00001140 def test_extended_set_del_slice(self):
Mark Dickinsonbc099642010-01-29 17:27:24 +00001141 indices = (0, None, 1, 3, 19, 300, 1<<333, -1, -2, -31, -300)
Thomas Wouters376446d2006-12-19 08:30:14 +00001142 for start in indices:
1143 for stop in indices:
1144 # Skip invalid step 0
1145 for step in indices[1:]:
1146 L = list(range(255))
Guido van Rossum254348e2007-11-21 19:29:53 +00001147 b = bytearray(L)
Thomas Wouters376446d2006-12-19 08:30:14 +00001148 # Make sure we have a slice of exactly the right length,
1149 # but with different data.
1150 data = L[start:stop:step]
1151 data.reverse()
1152 L[start:stop:step] = data
1153 b[start:stop:step] = data
Ezio Melottib3aedd42010-11-20 19:04:17 +00001154 self.assertEqual(b, bytearray(L))
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001155
Thomas Wouters376446d2006-12-19 08:30:14 +00001156 del L[start:stop:step]
1157 del b[start:stop:step]
Ezio Melottib3aedd42010-11-20 19:04:17 +00001158 self.assertEqual(b, bytearray(L))
Thomas Wouters376446d2006-12-19 08:30:14 +00001159
Guido van Rossumd624f182006-04-24 13:47:05 +00001160 def test_setslice_trap(self):
1161 # This test verifies that we correctly handle assigning self
1162 # to a slice of self (the old Lambert Meertens trap).
Guido van Rossum254348e2007-11-21 19:29:53 +00001163 b = bytearray(range(256))
Guido van Rossumd624f182006-04-24 13:47:05 +00001164 b[8:] = b
Guido van Rossum254348e2007-11-21 19:29:53 +00001165 self.assertEqual(b, bytearray(list(range(8)) + list(range(256))))
Guido van Rossumd624f182006-04-24 13:47:05 +00001166
Guido van Rossum13e57212006-04-27 22:54:26 +00001167 def test_iconcat(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001168 b = bytearray(b"abc")
Guido van Rossum13e57212006-04-27 22:54:26 +00001169 b1 = b
Guido van Rossum9c627722007-08-27 18:31:48 +00001170 b += b"def"
1171 self.assertEqual(b, b"abcdef")
Guido van Rossum13e57212006-04-27 22:54:26 +00001172 self.assertEqual(b, b1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001173 self.assertTrue(b is b1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001174 b += b"xyz"
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001175 self.assertEqual(b, b"abcdefxyz")
1176 try:
Guido van Rossumef87d6e2007-05-02 19:09:54 +00001177 b += ""
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001178 except TypeError:
1179 pass
1180 else:
1181 self.fail("bytes += unicode didn't raise TypeError")
Guido van Rossum13e57212006-04-27 22:54:26 +00001182
1183 def test_irepeat(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001184 b = bytearray(b"abc")
Guido van Rossum13e57212006-04-27 22:54:26 +00001185 b1 = b
1186 b *= 3
Guido van Rossum9c627722007-08-27 18:31:48 +00001187 self.assertEqual(b, b"abcabcabc")
Guido van Rossum13e57212006-04-27 22:54:26 +00001188 self.assertEqual(b, b1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001189 self.assertTrue(b is b1)
Guido van Rossum13e57212006-04-27 22:54:26 +00001190
1191 def test_irepeat_1char(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001192 b = bytearray(b"x")
Guido van Rossum13e57212006-04-27 22:54:26 +00001193 b1 = b
1194 b *= 100
Guido van Rossum98297ee2007-11-06 21:34:58 +00001195 self.assertEqual(b, b"x"*100)
Guido van Rossum13e57212006-04-27 22:54:26 +00001196 self.assertEqual(b, b1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001197 self.assertTrue(b is b1)
Guido van Rossum13e57212006-04-27 22:54:26 +00001198
Guido van Rossum20188312006-05-05 15:15:40 +00001199 def test_alloc(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001200 b = bytearray()
Guido van Rossum20188312006-05-05 15:15:40 +00001201 alloc = b.__alloc__()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001202 self.assertTrue(alloc >= 0)
Guido van Rossum20188312006-05-05 15:15:40 +00001203 seq = [alloc]
1204 for i in range(100):
Guido van Rossum9c627722007-08-27 18:31:48 +00001205 b += b"x"
Guido van Rossum20188312006-05-05 15:15:40 +00001206 alloc = b.__alloc__()
Serhiy Storchaka7b6e3b92015-06-29 21:14:06 +03001207 self.assertGreater(alloc, len(b)) # including trailing null byte
Guido van Rossum20188312006-05-05 15:15:40 +00001208 if alloc not in seq:
1209 seq.append(alloc)
Guido van Rossum20188312006-05-05 15:15:40 +00001210
Serhiy Storchaka7b6e3b92015-06-29 21:14:06 +03001211 def test_init_alloc(self):
1212 b = bytearray()
1213 def g():
1214 for i in range(1, 100):
1215 yield i
1216 a = list(b)
1217 self.assertEqual(a, list(range(1, len(a)+1)))
1218 self.assertEqual(len(b), len(a))
1219 self.assertLessEqual(len(b), i)
1220 alloc = b.__alloc__()
1221 self.assertGreater(alloc, len(b)) # including trailing null byte
1222 b.__init__(g())
1223 self.assertEqual(list(b), list(range(1, 100)))
1224 self.assertEqual(len(b), 99)
1225 alloc = b.__alloc__()
1226 self.assertGreater(alloc, len(b))
1227
Neal Norwitz6968b052007-02-27 19:02:19 +00001228 def test_extend(self):
1229 orig = b'hello'
Guido van Rossum254348e2007-11-21 19:29:53 +00001230 a = bytearray(orig)
Neal Norwitz6968b052007-02-27 19:02:19 +00001231 a.extend(a)
1232 self.assertEqual(a, orig + orig)
1233 self.assertEqual(a[5:], orig)
Alexandre Vassalotti09121e82007-12-04 05:51:13 +00001234 a = bytearray(b'')
1235 # Test iterators that don't have a __length_hint__
1236 a.extend(map(int, orig * 25))
1237 a.extend(int(x) for x in orig * 25)
1238 self.assertEqual(a, orig * 50)
1239 self.assertEqual(a[-5:], orig)
1240 a = bytearray(b'')
1241 a.extend(iter(map(int, orig * 50)))
1242 self.assertEqual(a, orig * 50)
1243 self.assertEqual(a[-5:], orig)
1244 a = bytearray(b'')
1245 a.extend(list(map(int, orig * 50)))
1246 self.assertEqual(a, orig * 50)
1247 self.assertEqual(a[-5:], orig)
1248 a = bytearray(b'')
1249 self.assertRaises(ValueError, a.extend, [0, 1, 2, 256])
1250 self.assertRaises(ValueError, a.extend, [0, 1, 2, -1])
1251 self.assertEqual(len(a), 0)
Georg Brandl9a54d7c2008-07-16 23:15:30 +00001252 a = bytearray(b'')
1253 a.extend([Indexable(ord('a'))])
1254 self.assertEqual(a, b'a')
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001255
Neal Norwitz6968b052007-02-27 19:02:19 +00001256 def test_remove(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001257 b = bytearray(b'hello')
Neal Norwitz6968b052007-02-27 19:02:19 +00001258 b.remove(ord('l'))
1259 self.assertEqual(b, b'helo')
1260 b.remove(ord('l'))
1261 self.assertEqual(b, b'heo')
1262 self.assertRaises(ValueError, lambda: b.remove(ord('l')))
1263 self.assertRaises(ValueError, lambda: b.remove(400))
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001264 self.assertRaises(TypeError, lambda: b.remove('e'))
Neal Norwitz6968b052007-02-27 19:02:19 +00001265 # remove first and last
1266 b.remove(ord('o'))
1267 b.remove(ord('h'))
1268 self.assertEqual(b, b'e')
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001269 self.assertRaises(TypeError, lambda: b.remove(b'e'))
Georg Brandl9a54d7c2008-07-16 23:15:30 +00001270 b.remove(Indexable(ord('e')))
1271 self.assertEqual(b, b'')
Neal Norwitz6968b052007-02-27 19:02:19 +00001272
Serhiy Storchaka7bf36da2016-05-16 22:15:38 +03001273 # test values outside of the ascii range: (0, 127)
1274 c = bytearray([126, 127, 128, 129])
1275 c.remove(127)
1276 self.assertEqual(c, bytes([126, 128, 129]))
1277 c.remove(129)
1278 self.assertEqual(c, bytes([126, 128]))
1279
Neal Norwitz6968b052007-02-27 19:02:19 +00001280 def test_pop(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001281 b = bytearray(b'world')
Neal Norwitz6968b052007-02-27 19:02:19 +00001282 self.assertEqual(b.pop(), ord('d'))
1283 self.assertEqual(b.pop(0), ord('w'))
1284 self.assertEqual(b.pop(-2), ord('r'))
1285 self.assertRaises(IndexError, lambda: b.pop(10))
Eli Bendersky1bc4f192011-03-04 04:55:25 +00001286 self.assertRaises(IndexError, lambda: bytearray().pop())
Mark Dickinson54a3db92009-09-06 10:19:23 +00001287 # test for issue #6846
1288 self.assertEqual(bytearray(b'\xff').pop(), 0xff)
Neal Norwitz6968b052007-02-27 19:02:19 +00001289
1290 def test_nosort(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001291 self.assertRaises(AttributeError, lambda: bytearray().sort())
Neal Norwitz6968b052007-02-27 19:02:19 +00001292
Neal Norwitz6968b052007-02-27 19:02:19 +00001293 def test_append(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001294 b = bytearray(b'hell')
Neal Norwitz6968b052007-02-27 19:02:19 +00001295 b.append(ord('o'))
1296 self.assertEqual(b, b'hello')
1297 self.assertEqual(b.append(100), None)
Guido van Rossum254348e2007-11-21 19:29:53 +00001298 b = bytearray()
Neal Norwitz6968b052007-02-27 19:02:19 +00001299 b.append(ord('A'))
1300 self.assertEqual(len(b), 1)
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001301 self.assertRaises(TypeError, lambda: b.append(b'o'))
Georg Brandl9a54d7c2008-07-16 23:15:30 +00001302 b = bytearray()
1303 b.append(Indexable(ord('A')))
1304 self.assertEqual(b, b'A')
Neal Norwitz6968b052007-02-27 19:02:19 +00001305
1306 def test_insert(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001307 b = bytearray(b'msssspp')
Neal Norwitz6968b052007-02-27 19:02:19 +00001308 b.insert(1, ord('i'))
1309 b.insert(4, ord('i'))
1310 b.insert(-2, ord('i'))
1311 b.insert(1000, ord('i'))
1312 self.assertEqual(b, b'mississippi')
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001313 self.assertRaises(TypeError, lambda: b.insert(0, b'1'))
Georg Brandl9a54d7c2008-07-16 23:15:30 +00001314 b = bytearray()
1315 b.insert(0, Indexable(ord('A')))
1316 self.assertEqual(b, b'A')
Neal Norwitz6968b052007-02-27 19:02:19 +00001317
Benjamin Peterson0f3641c2008-11-19 22:05:52 +00001318 def test_copied(self):
1319 # Issue 4348. Make sure that operations that don't mutate the array
1320 # copy the bytes.
1321 b = bytearray(b'abc')
Amaury Forgeot d'Arcb0c29162008-11-22 22:18:04 +00001322 self.assertFalse(b is b.replace(b'abc', b'cde', 0))
Benjamin Peterson0f3641c2008-11-19 22:05:52 +00001323
1324 t = bytearray([i for i in range(256)])
1325 x = bytearray(b'')
1326 self.assertFalse(x is x.translate(t))
1327
Guido van Rossum254348e2007-11-21 19:29:53 +00001328 def test_partition_bytearray_doesnt_share_nullstring(self):
1329 a, b, c = bytearray(b"x").partition(b"y")
Guido van Rossum98297ee2007-11-06 21:34:58 +00001330 self.assertEqual(b, b"")
1331 self.assertEqual(c, b"")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001332 self.assertTrue(b is not c)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001333 b += b"!"
1334 self.assertEqual(c, b"")
Guido van Rossum254348e2007-11-21 19:29:53 +00001335 a, b, c = bytearray(b"x").partition(b"y")
Guido van Rossum98297ee2007-11-06 21:34:58 +00001336 self.assertEqual(b, b"")
1337 self.assertEqual(c, b"")
1338 # Same for rpartition
Guido van Rossum254348e2007-11-21 19:29:53 +00001339 b, c, a = bytearray(b"x").rpartition(b"y")
Guido van Rossum98297ee2007-11-06 21:34:58 +00001340 self.assertEqual(b, b"")
1341 self.assertEqual(c, b"")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001342 self.assertTrue(b is not c)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001343 b += b"!"
1344 self.assertEqual(c, b"")
Guido van Rossum254348e2007-11-21 19:29:53 +00001345 c, b, a = bytearray(b"x").rpartition(b"y")
Guido van Rossum98297ee2007-11-06 21:34:58 +00001346 self.assertEqual(b, b"")
1347 self.assertEqual(c, b"")
1348
Antoine Pitrou5504e892008-12-06 21:27:53 +00001349 def test_resize_forbidden(self):
1350 # #4509: can't resize a bytearray when there are buffer exports, even
1351 # if it wouldn't reallocate the underlying buffer.
1352 # Furthermore, no destructive changes to the buffer may be applied
1353 # before raising the error.
1354 b = bytearray(range(10))
1355 v = memoryview(b)
1356 def resize(n):
1357 b[1:-1] = range(n + 1, 2*n - 1)
1358 resize(10)
1359 orig = b[:]
1360 self.assertRaises(BufferError, resize, 11)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001361 self.assertEqual(b, orig)
Antoine Pitrou5504e892008-12-06 21:27:53 +00001362 self.assertRaises(BufferError, resize, 9)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001363 self.assertEqual(b, orig)
Antoine Pitrou5504e892008-12-06 21:27:53 +00001364 self.assertRaises(BufferError, resize, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001365 self.assertEqual(b, orig)
Antoine Pitrou5504e892008-12-06 21:27:53 +00001366 # Other operations implying resize
1367 self.assertRaises(BufferError, b.pop, 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001368 self.assertEqual(b, orig)
Antoine Pitrou5504e892008-12-06 21:27:53 +00001369 self.assertRaises(BufferError, b.remove, b[1])
Ezio Melottib3aedd42010-11-20 19:04:17 +00001370 self.assertEqual(b, orig)
Antoine Pitrou5504e892008-12-06 21:27:53 +00001371 def delitem():
1372 del b[1]
1373 self.assertRaises(BufferError, delitem)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001374 self.assertEqual(b, orig)
Antoine Pitrou5504e892008-12-06 21:27:53 +00001375 # deleting a non-contiguous slice
1376 def delslice():
1377 b[1:-1:2] = b""
1378 self.assertRaises(BufferError, delslice)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001379 self.assertEqual(b, orig)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001380
Stefan Krah650c1e82015-02-03 21:43:23 +01001381 @test.support.cpython_only
1382 def test_obsolete_write_lock(self):
1383 from _testcapi import getbuffer_with_null_view
1384 self.assertRaises(BufferError, getbuffer_with_null_view, bytearray())
Antoine Pitroufc8d6f42010-01-17 12:38:54 +00001385
Serhiy Storchakaaabafe72016-03-06 14:10:24 +02001386 def test_iterator_pickling2(self):
1387 orig = bytearray(b'abc')
1388 data = list(b'qwerty')
1389 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
1390 # initial iterator
1391 itorig = iter(orig)
1392 d = pickle.dumps((itorig, orig), proto)
1393 it, b = pickle.loads(d)
1394 b[:] = data
1395 self.assertEqual(type(it), type(itorig))
1396 self.assertEqual(list(it), data)
1397
1398 # running iterator
1399 next(itorig)
1400 d = pickle.dumps((itorig, orig), proto)
1401 it, b = pickle.loads(d)
1402 b[:] = data
1403 self.assertEqual(type(it), type(itorig))
1404 self.assertEqual(list(it), data[1:])
1405
1406 # empty iterator
1407 for i in range(1, len(orig)):
1408 next(itorig)
1409 d = pickle.dumps((itorig, orig), proto)
1410 it, b = pickle.loads(d)
1411 b[:] = data
1412 self.assertEqual(type(it), type(itorig))
1413 self.assertEqual(list(it), data[len(orig):])
1414
1415 # exhausted iterator
1416 self.assertRaises(StopIteration, next, itorig)
1417 d = pickle.dumps((itorig, orig), proto)
1418 it, b = pickle.loads(d)
1419 b[:] = data
1420 self.assertEqual(list(it), [])
1421
Serhiy Storchaka8dc2ec12016-03-30 21:01:26 +03001422 test_exhausted_iterator = test.list_tests.CommonTest.test_exhausted_iterator
Serhiy Storchakaaabafe72016-03-06 14:10:24 +02001423
Serhiy Storchakaaf658722016-07-03 14:41:36 +03001424 def test_iterator_length_hint(self):
1425 # Issue 27443: __length_hint__ can return negative integer
1426 ba = bytearray(b'ab')
1427 it = iter(ba)
1428 next(it)
1429 ba.clear()
1430 # Shouldn't raise an error
1431 self.assertEqual(list(it), [])
1432
1433
Christian Heimes510711d2008-01-30 11:57:58 +00001434class AssortedBytesTest(unittest.TestCase):
1435 #
1436 # Test various combinations of bytes and bytearray
1437 #
1438
Florent Xiclunaedf5f0d2010-09-03 20:00:37 +00001439 @check_bytes_warnings
Christian Heimes510711d2008-01-30 11:57:58 +00001440 def test_repr_str(self):
Florent Xiclunaedf5f0d2010-09-03 20:00:37 +00001441 for f in str, repr:
1442 self.assertEqual(f(bytearray()), "bytearray(b'')")
1443 self.assertEqual(f(bytearray([0])), "bytearray(b'\\x00')")
1444 self.assertEqual(f(bytearray([0, 1, 254, 255])),
1445 "bytearray(b'\\x00\\x01\\xfe\\xff')")
1446 self.assertEqual(f(b"abc"), "b'abc'")
1447 self.assertEqual(f(b"'"), '''b"'"''') # '''
1448 self.assertEqual(f(b"'\""), r"""b'\'"'""") # '
Christian Heimes510711d2008-01-30 11:57:58 +00001449
Serhiy Storchakad1af5ef2016-10-30 19:33:54 +02001450 @check_bytes_warnings
1451 def test_format(self):
1452 for b in b'abc', bytearray(b'abc'):
1453 self.assertEqual(format(b), str(b))
1454 self.assertEqual(format(b, ''), str(b))
1455 with self.assertRaisesRegex(TypeError,
1456 r'\b%s\b' % re.escape(type(b).__name__)):
1457 format(b, 's')
1458
Christian Heimes510711d2008-01-30 11:57:58 +00001459 def test_compare_bytes_to_bytearray(self):
1460 self.assertEqual(b"abc" == bytes(b"abc"), True)
1461 self.assertEqual(b"ab" != bytes(b"abc"), True)
1462 self.assertEqual(b"ab" <= bytes(b"abc"), True)
1463 self.assertEqual(b"ab" < bytes(b"abc"), True)
1464 self.assertEqual(b"abc" >= bytes(b"ab"), True)
1465 self.assertEqual(b"abc" > bytes(b"ab"), True)
1466
1467 self.assertEqual(b"abc" != bytes(b"abc"), False)
1468 self.assertEqual(b"ab" == bytes(b"abc"), False)
1469 self.assertEqual(b"ab" > bytes(b"abc"), False)
1470 self.assertEqual(b"ab" >= bytes(b"abc"), False)
1471 self.assertEqual(b"abc" < bytes(b"ab"), False)
1472 self.assertEqual(b"abc" <= bytes(b"ab"), False)
1473
1474 self.assertEqual(bytes(b"abc") == b"abc", True)
1475 self.assertEqual(bytes(b"ab") != b"abc", True)
1476 self.assertEqual(bytes(b"ab") <= b"abc", True)
1477 self.assertEqual(bytes(b"ab") < b"abc", True)
1478 self.assertEqual(bytes(b"abc") >= b"ab", True)
1479 self.assertEqual(bytes(b"abc") > b"ab", True)
1480
1481 self.assertEqual(bytes(b"abc") != b"abc", False)
1482 self.assertEqual(bytes(b"ab") == b"abc", False)
1483 self.assertEqual(bytes(b"ab") > b"abc", False)
1484 self.assertEqual(bytes(b"ab") >= b"abc", False)
1485 self.assertEqual(bytes(b"abc") < b"ab", False)
1486 self.assertEqual(bytes(b"abc") <= b"ab", False)
1487
Stefan Krah6e572b82013-01-26 13:06:36 +01001488 @test.support.requires_docstrings
Christian Heimes510711d2008-01-30 11:57:58 +00001489 def test_doc(self):
Florent Xicluna9b86b9a2010-03-19 19:00:44 +00001490 self.assertIsNotNone(bytearray.__doc__)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001491 self.assertTrue(bytearray.__doc__.startswith("bytearray("), bytearray.__doc__)
Florent Xicluna9b86b9a2010-03-19 19:00:44 +00001492 self.assertIsNotNone(bytes.__doc__)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001493 self.assertTrue(bytes.__doc__.startswith("bytes("), bytes.__doc__)
Christian Heimes510711d2008-01-30 11:57:58 +00001494
1495 def test_from_bytearray(self):
1496 sample = bytes(b"Hello world\n\x80\x81\xfe\xff")
1497 buf = memoryview(sample)
1498 b = bytearray(buf)
1499 self.assertEqual(b, bytearray(sample))
1500
Florent Xiclunaedf5f0d2010-09-03 20:00:37 +00001501 @check_bytes_warnings
Christian Heimes510711d2008-01-30 11:57:58 +00001502 def test_to_str(self):
Florent Xiclunaedf5f0d2010-09-03 20:00:37 +00001503 self.assertEqual(str(b''), "b''")
1504 self.assertEqual(str(b'x'), "b'x'")
1505 self.assertEqual(str(b'\x80'), "b'\\x80'")
1506 self.assertEqual(str(bytearray(b'')), "bytearray(b'')")
1507 self.assertEqual(str(bytearray(b'x')), "bytearray(b'x')")
1508 self.assertEqual(str(bytearray(b'\x80')), "bytearray(b'\\x80')")
Christian Heimes510711d2008-01-30 11:57:58 +00001509
1510 def test_literal(self):
1511 tests = [
1512 (b"Wonderful spam", "Wonderful spam"),
1513 (br"Wonderful spam too", "Wonderful spam too"),
1514 (b"\xaa\x00\000\200", "\xaa\x00\000\200"),
1515 (br"\xaa\x00\000\200", r"\xaa\x00\000\200"),
1516 ]
1517 for b, s in tests:
1518 self.assertEqual(b, bytearray(s, 'latin-1'))
1519 for c in range(128, 256):
1520 self.assertRaises(SyntaxError, eval,
1521 'b"%s"' % chr(c))
1522
Christian Heimes510711d2008-01-30 11:57:58 +00001523 def test_split_bytearray(self):
1524 self.assertEqual(b'a b'.split(memoryview(b' ')), [b'a', b'b'])
1525
1526 def test_rsplit_bytearray(self):
1527 self.assertEqual(b'a b'.rsplit(memoryview(b' ')), [b'a', b'b'])
1528
Georg Brandleb2c9642008-05-30 12:05:02 +00001529 def test_return_self(self):
1530 # bytearray.replace must always return a new bytearray
1531 b = bytearray()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001532 self.assertFalse(b.replace(b'', b'') is b)
Georg Brandleb2c9642008-05-30 12:05:02 +00001533
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001534 @unittest.skipUnless(sys.flags.bytes_warning,
1535 "BytesWarning is needed for this test: use -bb option")
Barry Warsaw9e9dcd62008-10-17 01:50:37 +00001536 def test_compare(self):
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001537 def bytes_warning():
1538 return test.support.check_warnings(('', BytesWarning))
1539 with bytes_warning():
1540 b'' == ''
1541 with bytes_warning():
1542 '' == b''
1543 with bytes_warning():
1544 b'' != ''
1545 with bytes_warning():
1546 '' != b''
1547 with bytes_warning():
1548 bytearray(b'') == ''
1549 with bytes_warning():
1550 '' == bytearray(b'')
1551 with bytes_warning():
1552 bytearray(b'') != ''
1553 with bytes_warning():
1554 '' != bytearray(b'')
1555 with bytes_warning():
1556 b'\0' == 0
1557 with bytes_warning():
1558 0 == b'\0'
1559 with bytes_warning():
1560 b'\0' != 0
1561 with bytes_warning():
1562 0 != b'\0'
Barry Warsaw9e9dcd62008-10-17 01:50:37 +00001563
Guido van Rossumd624f182006-04-24 13:47:05 +00001564 # Optimizations:
Guido van Rossume06b6b82006-04-23 07:43:54 +00001565 # __iter__? (optimization)
Guido van Rossumd624f182006-04-24 13:47:05 +00001566 # __reversed__? (optimization)
1567
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001568 # XXX More string methods? (Those that don't use character properties)
1569
Neal Norwitz6968b052007-02-27 19:02:19 +00001570 # There are tests in string_tests.py that are more
Martin Panter0d0db6c2016-04-10 08:45:26 +00001571 # comprehensive for things like partition, etc.
Neal Norwitz6968b052007-02-27 19:02:19 +00001572 # Unfortunately they are all bundled with tests that
1573 # are not appropriate for bytes
Guido van Rossume06b6b82006-04-23 07:43:54 +00001574
Guido van Rossum254348e2007-11-21 19:29:53 +00001575 # I've started porting some of those into bytearray_tests.py, we should port
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001576 # the rest that make sense (the code can be cleaned up to use modern
1577 # unittest methods at the same time).
1578
Martin Panter152a19c2016-04-06 06:37:17 +00001579class BytearrayPEP3137Test(unittest.TestCase):
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001580 def marshal(self, x):
Guido van Rossum254348e2007-11-21 19:29:53 +00001581 return bytearray(x)
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001582
1583 def test_returns_new_copy(self):
1584 val = self.marshal(b'1234')
1585 # On immutable types these MAY return a reference to themselves
Guido van Rossum254348e2007-11-21 19:29:53 +00001586 # but on mutable types like bytearray they MUST return a new copy.
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001587 for methname in ('zfill', 'rjust', 'ljust', 'center'):
1588 method = getattr(val, methname)
1589 newval = method(3)
1590 self.assertEqual(val, newval)
1591 self.assertTrue(val is not newval,
1592 methname+' returned self on a mutable object')
Antoine Pitroucbaa62502010-01-13 15:03:39 +00001593 for expr in ('val.split()[0]', 'val.rsplit()[0]',
1594 'val.partition(b".")[0]', 'val.rpartition(b".")[2]',
1595 'val.splitlines()[0]', 'val.replace(b"", b"")'):
1596 newval = eval(expr)
1597 self.assertEqual(val, newval)
1598 self.assertTrue(val is not newval,
1599 expr+' returned val on a mutable object')
Antoine Pitroucfc22b42012-10-16 21:07:23 +02001600 sep = self.marshal(b'')
1601 newval = sep.join([val])
1602 self.assertEqual(val, newval)
1603 self.assertIsNot(val, newval)
1604
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001605
Christian Heimes510711d2008-01-30 11:57:58 +00001606class FixedStringTest(test.string_tests.BaseTest):
Guido van Rossum9c627722007-08-27 18:31:48 +00001607 def fixtype(self, obj):
1608 if isinstance(obj, str):
Martin Panter152a19c2016-04-06 06:37:17 +00001609 return self.type2test(obj.encode("utf-8"))
Guido van Rossum9c627722007-08-27 18:31:48 +00001610 return super().fixtype(obj)
1611
Martin Panter152a19c2016-04-06 06:37:17 +00001612 contains_bytes = True
1613
Ezio Melotti0dceb562013-01-10 07:43:26 +02001614class ByteArrayAsStringTest(FixedStringTest, unittest.TestCase):
Christian Heimes510711d2008-01-30 11:57:58 +00001615 type2test = bytearray
1616
Ezio Melotti0dceb562013-01-10 07:43:26 +02001617class BytesAsStringTest(FixedStringTest, unittest.TestCase):
Christian Heimes510711d2008-01-30 11:57:58 +00001618 type2test = bytes
1619
Georg Brandlc7885542007-03-06 19:16:20 +00001620
Ezio Melotti0dceb562013-01-10 07:43:26 +02001621class SubclassTest:
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001622
1623 def test_basic(self):
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001624 self.assertTrue(issubclass(self.type2test, self.basetype))
1625 self.assertIsInstance(self.type2test(), self.basetype)
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001626
1627 a, b = b"abcd", b"efgh"
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001628 _a, _b = self.type2test(a), self.type2test(b)
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001629
1630 # test comparison operators with subclass instances
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001631 self.assertTrue(_a == _a)
1632 self.assertTrue(_a != _b)
1633 self.assertTrue(_a < _b)
1634 self.assertTrue(_a <= _b)
1635 self.assertTrue(_b >= _a)
1636 self.assertTrue(_b > _a)
1637 self.assertTrue(_a is not a)
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001638
1639 # test concat of subclass instances
1640 self.assertEqual(a + b, _a + _b)
1641 self.assertEqual(a + b, a + _b)
1642 self.assertEqual(a + b, _a + b)
1643
1644 # test repeat
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001645 self.assertTrue(a*5 == _a*5)
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001646
1647 def test_join(self):
1648 # Make sure join returns a NEW object for single item sequences
1649 # involving a subclass.
1650 # Make sure that it is of the appropriate type.
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001651 s1 = self.type2test(b"abcd")
1652 s2 = self.basetype().join([s1])
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001653 self.assertTrue(s1 is not s2)
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001654 self.assertTrue(type(s2) is self.basetype, type(s2))
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001655
1656 # Test reverse, calling join on subclass
1657 s3 = s1.join([b"abcd"])
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001658 self.assertTrue(type(s3) is self.basetype)
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001659
1660 def test_pickle(self):
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001661 a = self.type2test(b"abcd")
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001662 a.x = 10
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001663 a.y = self.type2test(b"efgh")
Hirokazu Yamamotod0d0b652008-10-23 00:38:15 +00001664 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001665 b = pickle.loads(pickle.dumps(a, proto))
1666 self.assertNotEqual(id(a), id(b))
1667 self.assertEqual(a, b)
1668 self.assertEqual(a.x, b.x)
1669 self.assertEqual(a.y, b.y)
1670 self.assertEqual(type(a), type(b))
1671 self.assertEqual(type(a.y), type(b.y))
1672
1673 def test_copy(self):
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001674 a = self.type2test(b"abcd")
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001675 a.x = 10
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001676 a.y = self.type2test(b"efgh")
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001677 for copy_method in (copy.copy, copy.deepcopy):
1678 b = copy_method(a)
1679 self.assertNotEqual(id(a), id(b))
1680 self.assertEqual(a, b)
1681 self.assertEqual(a.x, b.x)
1682 self.assertEqual(a.y, b.y)
1683 self.assertEqual(type(a), type(b))
1684 self.assertEqual(type(a.y), type(b.y))
1685
Serhiy Storchaka0855e702016-07-01 17:22:31 +03001686 def test_fromhex(self):
1687 b = self.type2test.fromhex('1a2B30')
1688 self.assertEqual(b, b'\x1a\x2b\x30')
1689 self.assertIs(type(b), self.type2test)
1690
1691 class B1(self.basetype):
1692 def __new__(cls, value):
1693 me = self.basetype.__new__(cls, value)
1694 me.foo = 'bar'
1695 return me
1696
1697 b = B1.fromhex('1a2B30')
1698 self.assertEqual(b, b'\x1a\x2b\x30')
1699 self.assertIs(type(b), B1)
1700 self.assertEqual(b.foo, 'bar')
1701
1702 class B2(self.basetype):
1703 def __init__(me, *args, **kwargs):
1704 if self.basetype is not bytes:
1705 self.basetype.__init__(me, *args, **kwargs)
1706 me.foo = 'bar'
1707
1708 b = B2.fromhex('1a2B30')
1709 self.assertEqual(b, b'\x1a\x2b\x30')
1710 self.assertIs(type(b), B2)
1711 self.assertEqual(b.foo, 'bar')
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001712
Alexandre Vassalotti41f58a72010-01-12 01:23:09 +00001713
1714class ByteArraySubclass(bytearray):
1715 pass
1716
1717class BytesSubclass(bytes):
1718 pass
1719
Serhiy Storchaka15095802015-11-25 15:47:01 +02001720class OtherBytesSubclass(bytes):
1721 pass
1722
Ezio Melotti0dceb562013-01-10 07:43:26 +02001723class ByteArraySubclassTest(SubclassTest, unittest.TestCase):
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001724 basetype = bytearray
1725 type2test = ByteArraySubclass
Alexandre Vassalotti41f58a72010-01-12 01:23:09 +00001726
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001727 def test_init_override(self):
Guido van Rossum254348e2007-11-21 19:29:53 +00001728 class subclass(bytearray):
Alexandre Vassalotti41f58a72010-01-12 01:23:09 +00001729 def __init__(me, newarg=1, *args, **kwargs):
1730 bytearray.__init__(me, *args, **kwargs)
1731 x = subclass(4, b"abcd")
Guido van Rossuma6c04be2007-11-03 00:24:24 +00001732 x = subclass(4, source=b"abcd")
1733 self.assertEqual(x, b"abcd")
1734 x = subclass(newarg=4, source=b"abcd")
1735 self.assertEqual(x, b"abcd")
1736
1737
Ezio Melotti0dceb562013-01-10 07:43:26 +02001738class BytesSubclassTest(SubclassTest, unittest.TestCase):
Serhiy Storchakae78592d2016-05-12 12:33:21 +03001739 basetype = bytes
1740 type2test = BytesSubclass
Alexandre Vassalotti41f58a72010-01-12 01:23:09 +00001741
1742
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001743if __name__ == "__main__":
Ezio Melotti0dceb562013-01-10 07:43:26 +02001744 unittest.main()