blob: c0f7138254f3f6f493314fd1fcbccc80a0c74a64 [file] [log] [blame]
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001from collections import deque
2import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00003from test import support, seq_tests
Antoine Pitrou7ddda782009-01-01 15:35:33 +00004import gc
5import weakref
Raymond Hettinger756b3f32004-01-29 06:37:52 +00006import copy
Guido van Rossumbf12cdb2006-08-17 20:24:18 +00007import pickle
Raymond Hettinger0a4977c2004-03-01 23:16:22 +00008import random
Jesus Cea16e2fca2012-08-03 14:49:42 +02009import struct
Raymond Hettinger756b3f32004-01-29 06:37:52 +000010
11BIG = 100000
12
Raymond Hettingera435c532004-07-09 04:10:20 +000013def fail():
14 raise SyntaxError
15 yield 1
16
Raymond Hettinger4aec61e2005-03-18 21:20:23 +000017class BadCmp:
18 def __eq__(self, other):
19 raise RuntimeError
20
21class MutateCmp:
Raymond Hettingerd73202c2005-03-19 00:00:51 +000022 def __init__(self, deque, result):
Raymond Hettinger4aec61e2005-03-18 21:20:23 +000023 self.deque = deque
Raymond Hettingerd73202c2005-03-19 00:00:51 +000024 self.result = result
Raymond Hettinger4aec61e2005-03-18 21:20:23 +000025 def __eq__(self, other):
26 self.deque.clear()
Raymond Hettingerd73202c2005-03-19 00:00:51 +000027 return self.result
Raymond Hettinger4aec61e2005-03-18 21:20:23 +000028
Raymond Hettinger756b3f32004-01-29 06:37:52 +000029class TestBasic(unittest.TestCase):
30
31 def test_basics(self):
Christian Heimes38053212007-12-14 01:24:44 +000032 d = deque(range(-5125, -5000))
33 d.__init__(range(200))
Guido van Rossum805365e2007-05-07 22:24:25 +000034 for i in range(200, 400):
Raymond Hettinger756b3f32004-01-29 06:37:52 +000035 d.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +000036 for i in reversed(range(-200, 0)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +000037 d.appendleft(i)
Guido van Rossum805365e2007-05-07 22:24:25 +000038 self.assertEqual(list(d), list(range(-200, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +000039 self.assertEqual(len(d), 600)
40
Guido van Rossum805365e2007-05-07 22:24:25 +000041 left = [d.popleft() for i in range(250)]
42 self.assertEqual(left, list(range(-200, 50)))
43 self.assertEqual(list(d), list(range(50, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +000044
Guido van Rossum805365e2007-05-07 22:24:25 +000045 right = [d.pop() for i in range(250)]
Raymond Hettinger756b3f32004-01-29 06:37:52 +000046 right.reverse()
Guido van Rossum805365e2007-05-07 22:24:25 +000047 self.assertEqual(right, list(range(150, 400)))
48 self.assertEqual(list(d), list(range(50, 150)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +000049
Guido van Rossum8ce8a782007-11-01 19:42:39 +000050 def test_maxlen(self):
51 self.assertRaises(ValueError, deque, 'abc', -1)
52 self.assertRaises(ValueError, deque, 'abc', -2)
Raymond Hettinger060c7f62009-03-10 09:36:07 +000053 it = iter(range(10))
54 d = deque(it, maxlen=3)
55 self.assertEqual(list(it), [])
Guido van Rossum8ce8a782007-11-01 19:42:39 +000056 self.assertEqual(repr(d), 'deque([7, 8, 9], maxlen=3)')
57 self.assertEqual(list(d), [7, 8, 9])
58 self.assertEqual(d, deque(range(10), 3))
59 d.append(10)
60 self.assertEqual(list(d), [8, 9, 10])
61 d.appendleft(7)
62 self.assertEqual(list(d), [7, 8, 9])
63 d.extend([10, 11])
64 self.assertEqual(list(d), [9, 10, 11])
65 d.extendleft([8, 7])
66 self.assertEqual(list(d), [7, 8, 9])
67 d = deque(range(200), maxlen=10)
68 d.append(d)
Benjamin Petersonee8712c2008-05-20 21:35:26 +000069 support.unlink(support.TESTFN)
70 fo = open(support.TESTFN, "w")
Christian Heimescc47b052008-03-25 14:56:36 +000071 try:
72 fo.write(str(d))
73 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +000074 fo = open(support.TESTFN, "r")
Christian Heimescc47b052008-03-25 14:56:36 +000075 self.assertEqual(fo.read(), repr(d))
76 finally:
77 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +000078 support.unlink(support.TESTFN)
Christian Heimescc47b052008-03-25 14:56:36 +000079
Guido van Rossum8ce8a782007-11-01 19:42:39 +000080 d = deque(range(10), maxlen=None)
81 self.assertEqual(repr(d), 'deque([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])')
Benjamin Petersonee8712c2008-05-20 21:35:26 +000082 fo = open(support.TESTFN, "w")
Christian Heimescc47b052008-03-25 14:56:36 +000083 try:
84 fo.write(str(d))
85 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +000086 fo = open(support.TESTFN, "r")
Christian Heimescc47b052008-03-25 14:56:36 +000087 self.assertEqual(fo.read(), repr(d))
88 finally:
89 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +000090 support.unlink(support.TESTFN)
Guido van Rossum8ce8a782007-11-01 19:42:39 +000091
Raymond Hettinger060c7f62009-03-10 09:36:07 +000092 def test_maxlen_zero(self):
93 it = iter(range(100))
94 deque(it, maxlen=0)
95 self.assertEqual(list(it), [])
96
97 it = iter(range(100))
98 d = deque(maxlen=0)
99 d.extend(it)
100 self.assertEqual(list(it), [])
101
102 it = iter(range(100))
103 d = deque(maxlen=0)
104 d.extendleft(it)
105 self.assertEqual(list(it), [])
106
Raymond Hettinger5bb0f0e2009-03-10 12:56:32 +0000107 def test_maxlen_attribute(self):
108 self.assertEqual(deque().maxlen, None)
109 self.assertEqual(deque('abc').maxlen, None)
110 self.assertEqual(deque('abc', maxlen=4).maxlen, 4)
111 self.assertEqual(deque('abc', maxlen=2).maxlen, 2)
112 self.assertEqual(deque('abc', maxlen=0).maxlen, 0)
113 with self.assertRaises(AttributeError):
114 d = deque('abc')
115 d.maxlen = 10
116
Raymond Hettinger44459de2010-04-03 23:20:46 +0000117 def test_count(self):
118 for s in ('', 'abracadabra', 'simsalabim'*500+'abc'):
119 s = list(s)
120 d = deque(s)
121 for letter in 'abcdefghijklmnopqrstuvwxyz':
122 self.assertEqual(s.count(letter), d.count(letter), (s, d, letter))
123 self.assertRaises(TypeError, d.count) # too few args
124 self.assertRaises(TypeError, d.count, 1, 2) # too many args
125 class BadCompare:
126 def __eq__(self, other):
127 raise ArithmeticError
128 d = deque([1, 2, BadCompare(), 3])
129 self.assertRaises(ArithmeticError, d.count, 2)
130 d = deque([1, 2, 3])
131 self.assertRaises(ArithmeticError, d.count, BadCompare())
132 class MutatingCompare:
133 def __eq__(self, other):
134 self.d.pop()
135 return True
136 m = MutatingCompare()
137 d = deque([1, 2, 3, m, 4, 5])
138 m.d = d
139 self.assertRaises(RuntimeError, d.count, 3)
140
Raymond Hettinger512d2cc2011-01-25 21:32:39 +0000141 # test issue11004
142 # block advance failed after rotation aligned elements on right side of block
143 d = deque([None]*16)
144 for i in range(len(d)):
145 d.rotate(-1)
146 d.rotate(1)
147 self.assertEqual(d.count(1), 0)
148 self.assertEqual(d.count(None), 16)
149
Raymond Hettinger738ec902004-02-29 02:15:56 +0000150 def test_comparisons(self):
151 d = deque('xabc'); d.popleft()
152 for e in [d, deque('abc'), deque('ab'), deque(), list(d)]:
153 self.assertEqual(d==e, type(d)==type(e) and list(d)==list(e))
154 self.assertEqual(d!=e, not(type(d)==type(e) and list(d)==list(e)))
155
156 args = map(deque, ('', 'a', 'b', 'ab', 'ba', 'abc', 'xba', 'xabc', 'cba'))
157 for x in args:
158 for y in args:
159 self.assertEqual(x == y, list(x) == list(y), (x,y))
160 self.assertEqual(x != y, list(x) != list(y), (x,y))
161 self.assertEqual(x < y, list(x) < list(y), (x,y))
162 self.assertEqual(x <= y, list(x) <= list(y), (x,y))
163 self.assertEqual(x > y, list(x) > list(y), (x,y))
164 self.assertEqual(x >= y, list(x) >= list(y), (x,y))
Raymond Hettinger738ec902004-02-29 02:15:56 +0000165
Raymond Hettinger39dadf72015-03-20 16:38:56 -0700166 def test_contains(self):
167 n = 200
168
169 d = deque(range(n))
170 for i in range(n):
171 self.assertTrue(i in d)
172 self.assertTrue((n+1) not in d)
173
174 # Test detection of mutation during iteration
175 d = deque(range(n))
176 d[n//2] = MutateCmp(d, False)
177 with self.assertRaises(RuntimeError):
178 n in d
179
180 # Test detection of comparison exceptions
181 d = deque(range(n))
182 d[n//2] = BadCmp()
183 with self.assertRaises(RuntimeError):
184 n in d
185
sweeneydec6dedde2020-02-09 03:16:43 -0500186 def test_contains_count_stop_crashes(self):
187 class A:
188 def __eq__(self, other):
189 d.clear()
190 return NotImplemented
191 d = deque([A(), A()])
192 with self.assertRaises(RuntimeError):
193 _ = 3 in d
194 d = deque([A(), A()])
195 with self.assertRaises(RuntimeError):
196 _ = d.count(3)
197
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000198 def test_extend(self):
199 d = deque('a')
200 self.assertRaises(TypeError, d.extend, 1)
201 d.extend('bcd')
202 self.assertEqual(list(d), list('abcd'))
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000203 d.extend(d)
204 self.assertEqual(list(d), list('abcdabcd'))
205
Raymond Hettinger41290a62015-03-31 08:12:23 -0700206 def test_add(self):
207 d = deque()
208 e = deque('abc')
209 f = deque('def')
210 self.assertEqual(d + d, deque())
211 self.assertEqual(e + f, deque('abcdef'))
212 self.assertEqual(e + e, deque('abcabc'))
213 self.assertEqual(e + d, deque('abc'))
214 self.assertEqual(d + e, deque('abc'))
215 self.assertIsNot(d + d, deque())
216 self.assertIsNot(e + d, deque('abc'))
217 self.assertIsNot(d + e, deque('abc'))
218
219 g = deque('abcdef', maxlen=4)
220 h = deque('gh')
221 self.assertEqual(g + h, deque('efgh'))
222
223 with self.assertRaises(TypeError):
224 deque('abc') + 'def'
225
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000226 def test_iadd(self):
227 d = deque('a')
228 d += 'bcd'
229 self.assertEqual(list(d), list('abcd'))
230 d += d
231 self.assertEqual(list(d), list('abcdabcd'))
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000232
233 def test_extendleft(self):
234 d = deque('a')
235 self.assertRaises(TypeError, d.extendleft, 1)
236 d.extendleft('bcd')
237 self.assertEqual(list(d), list(reversed('abcd')))
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000238 d.extendleft(d)
239 self.assertEqual(list(d), list('abcddcba'))
Raymond Hettingera435c532004-07-09 04:10:20 +0000240 d = deque()
241 d.extendleft(range(1000))
242 self.assertEqual(list(d), list(reversed(range(1000))))
243 self.assertRaises(SyntaxError, d.extendleft, fail())
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000244
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000245 def test_getitem(self):
246 n = 200
Guido van Rossum805365e2007-05-07 22:24:25 +0000247 d = deque(range(n))
248 l = list(range(n))
249 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000250 d.popleft()
251 l.pop(0)
252 if random.random() < 0.5:
253 d.append(i)
254 l.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000255 for j in range(1-len(l), len(l)):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000256 assert d[j] == l[j]
257
Raymond Hettinger738ec902004-02-29 02:15:56 +0000258 d = deque('superman')
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000259 self.assertEqual(d[0], 's')
260 self.assertEqual(d[-1], 'n')
Raymond Hettinger738ec902004-02-29 02:15:56 +0000261 d = deque()
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000262 self.assertRaises(IndexError, d.__getitem__, 0)
263 self.assertRaises(IndexError, d.__getitem__, -1)
264
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700265 def test_index(self):
266 for n in 1, 2, 30, 40, 200:
267
268 d = deque(range(n))
269 for i in range(n):
270 self.assertEqual(d.index(i), i)
271
272 with self.assertRaises(ValueError):
273 d.index(n+1)
274
275 # Test detection of mutation during iteration
276 d = deque(range(n))
277 d[n//2] = MutateCmp(d, False)
278 with self.assertRaises(RuntimeError):
279 d.index(n)
280
281 # Test detection of comparison exceptions
282 d = deque(range(n))
283 d[n//2] = BadCmp()
284 with self.assertRaises(RuntimeError):
285 d.index(n)
286
287 # Test start and stop arguments behavior matches list.index()
288 elements = 'ABCDEFGHI'
289 nonelement = 'Z'
290 d = deque(elements * 2)
291 s = list(elements * 2)
292 for start in range(-5 - len(s)*2, 5 + len(s) * 2):
293 for stop in range(-5 - len(s)*2, 5 + len(s) * 2):
294 for element in elements + 'Z':
295 try:
296 target = s.index(element, start, stop)
297 except ValueError:
298 with self.assertRaises(ValueError):
299 d.index(element, start, stop)
300 else:
301 self.assertEqual(d.index(element, start, stop), target)
302
Raymond Hettingerb46ad542018-09-21 01:46:41 -0700303 # Test large start argument
304 d = deque(range(0, 10000, 10))
305 for step in range(100):
306 i = d.index(8500, 700)
307 self.assertEqual(d[i], 8500)
308 # Repeat test with a different internal offset
309 d.rotate()
310
Raymond Hettinger906d82d2016-01-25 23:00:21 -0800311 def test_index_bug_24913(self):
Raymond Hettinger87674ec2015-08-26 08:08:38 -0700312 d = deque('A' * 3)
313 with self.assertRaises(ValueError):
314 i = d.index("Hello world", 0, 4)
315
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700316 def test_insert(self):
317 # Test to make sure insert behaves like lists
318 elements = 'ABCDEFGHI'
319 for i in range(-5 - len(elements)*2, 5 + len(elements) * 2):
320 d = deque('ABCDEFGHI')
321 s = list('ABCDEFGHI')
322 d.insert(i, 'Z')
323 s.insert(i, 'Z')
324 self.assertEqual(list(d), s)
325
Raymond Hettingera6389712016-02-01 21:21:19 -0800326 def test_insert_bug_26194(self):
Raymond Hettinger37434322016-01-26 21:44:16 -0800327 data = 'ABC'
Raymond Hettingera6389712016-02-01 21:21:19 -0800328 d = deque(data, maxlen=len(data))
329 with self.assertRaises(IndexError):
330 d.insert(2, None)
331
332 elements = 'ABCDEFGHI'
333 for i in range(-len(elements), len(elements)):
334 d = deque(elements, maxlen=len(elements)+1)
335 d.insert(i, 'Z')
336 if i >= 0:
337 self.assertEqual(d[i], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800338 else:
Raymond Hettingera6389712016-02-01 21:21:19 -0800339 self.assertEqual(d[i-1], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800340
Raymond Hettinger41290a62015-03-31 08:12:23 -0700341 def test_imul(self):
342 for n in (-10, -1, 0, 1, 2, 10, 1000):
343 d = deque()
344 d *= n
345 self.assertEqual(d, deque())
346 self.assertIsNone(d.maxlen)
347
348 for n in (-10, -1, 0, 1, 2, 10, 1000):
349 d = deque('a')
350 d *= n
351 self.assertEqual(d, deque('a' * n))
352 self.assertIsNone(d.maxlen)
353
354 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
355 d = deque('a', 500)
356 d *= n
357 self.assertEqual(d, deque('a' * min(n, 500)))
358 self.assertEqual(d.maxlen, 500)
359
360 for n in (-10, -1, 0, 1, 2, 10, 1000):
361 d = deque('abcdef')
362 d *= n
363 self.assertEqual(d, deque('abcdef' * n))
364 self.assertIsNone(d.maxlen)
365
366 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
367 d = deque('abcdef', 500)
368 d *= n
369 self.assertEqual(d, deque(('abcdef' * n)[-500:]))
370 self.assertEqual(d.maxlen, 500)
371
372 def test_mul(self):
373 d = deque('abc')
374 self.assertEqual(d * -5, deque())
375 self.assertEqual(d * 0, deque())
376 self.assertEqual(d * 1, deque('abc'))
377 self.assertEqual(d * 2, deque('abcabc'))
378 self.assertEqual(d * 3, deque('abcabcabc'))
379 self.assertIsNot(d * 1, d)
380
381 self.assertEqual(deque() * 0, deque())
382 self.assertEqual(deque() * 1, deque())
383 self.assertEqual(deque() * 5, deque())
384
385 self.assertEqual(-5 * d, deque())
386 self.assertEqual(0 * d, deque())
387 self.assertEqual(1 * d, deque('abc'))
388 self.assertEqual(2 * d, deque('abcabc'))
389 self.assertEqual(3 * d, deque('abcabcabc'))
390
391 d = deque('abc', maxlen=5)
392 self.assertEqual(d * -5, deque())
393 self.assertEqual(d * 0, deque())
394 self.assertEqual(d * 1, deque('abc'))
395 self.assertEqual(d * 2, deque('bcabc'))
396 self.assertEqual(d * 30, deque('bcabc'))
397
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000398 def test_setitem(self):
399 n = 200
Guido van Rossum805365e2007-05-07 22:24:25 +0000400 d = deque(range(n))
401 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000402 d[i] = 10 * i
Guido van Rossum805365e2007-05-07 22:24:25 +0000403 self.assertEqual(list(d), [10*i for i in range(n)])
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000404 l = list(d)
Guido van Rossum805365e2007-05-07 22:24:25 +0000405 for i in range(1-n, 0, -1):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000406 d[i] = 7*i
407 l[i] = 7*i
408 self.assertEqual(list(d), l)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000409
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000410 def test_delitem(self):
411 n = 500 # O(n**2) test, don't make this too big
Guido van Rossum805365e2007-05-07 22:24:25 +0000412 d = deque(range(n))
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000413 self.assertRaises(IndexError, d.__delitem__, -n-1)
414 self.assertRaises(IndexError, d.__delitem__, n)
Guido van Rossum805365e2007-05-07 22:24:25 +0000415 for i in range(n):
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000416 self.assertEqual(len(d), n-i)
417 j = random.randrange(-len(d), len(d))
418 val = d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000419 self.assertIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000420 del d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000421 self.assertNotIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000422 self.assertEqual(len(d), 0)
423
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000424 def test_reverse(self):
425 n = 500 # O(n**2) test, don't make this too big
426 data = [random.random() for i in range(n)]
427 for i in range(n):
428 d = deque(data[:i])
429 r = d.reverse()
430 self.assertEqual(list(d), list(reversed(data[:i])))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000431 self.assertIs(r, None)
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000432 d.reverse()
433 self.assertEqual(list(d), data[:i])
434 self.assertRaises(TypeError, d.reverse, 1) # Arity is zero
435
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000436 def test_rotate(self):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000437 s = tuple('abcde')
438 n = len(s)
439
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000440 d = deque(s)
Raymond Hettingeree33b272004-02-08 04:05:26 +0000441 d.rotate(1) # verify rot(1)
442 self.assertEqual(''.join(d), 'eabcd')
443
444 d = deque(s)
445 d.rotate(-1) # verify rot(-1)
446 self.assertEqual(''.join(d), 'bcdea')
447 d.rotate() # check default to 1
448 self.assertEqual(tuple(d), s)
449
Guido van Rossum805365e2007-05-07 22:24:25 +0000450 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000451 d = deque(s)
452 e = deque(d)
453 d.rotate(i) # check vs. rot(1) n times
Guido van Rossum805365e2007-05-07 22:24:25 +0000454 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000455 e.rotate(1)
456 self.assertEqual(tuple(d), tuple(e))
457 d.rotate(-i) # check that it works in reverse
458 self.assertEqual(tuple(d), s)
459 e.rotate(n-i) # check that it wraps forward
460 self.assertEqual(tuple(e), s)
461
Guido van Rossum805365e2007-05-07 22:24:25 +0000462 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000463 d = deque(s)
464 e = deque(d)
465 d.rotate(-i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000466 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000467 e.rotate(-1) # check vs. rot(-1) n times
468 self.assertEqual(tuple(d), tuple(e))
469 d.rotate(i) # check that it works in reverse
470 self.assertEqual(tuple(d), s)
471 e.rotate(i-n) # check that it wraps backaround
472 self.assertEqual(tuple(e), s)
473
474 d = deque(s)
475 e = deque(s)
476 e.rotate(BIG+17) # verify on long series of rotates
477 dr = d.rotate
Guido van Rossum805365e2007-05-07 22:24:25 +0000478 for i in range(BIG+17):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000479 dr()
480 self.assertEqual(tuple(d), tuple(e))
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000481
Raymond Hettingera435c532004-07-09 04:10:20 +0000482 self.assertRaises(TypeError, d.rotate, 'x') # Wrong arg type
483 self.assertRaises(TypeError, d.rotate, 1, 10) # Too many args
484
485 d = deque()
486 d.rotate() # rotate an empty deque
487 self.assertEqual(d, deque())
488
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000489 def test_len(self):
490 d = deque('ab')
491 self.assertEqual(len(d), 2)
492 d.popleft()
493 self.assertEqual(len(d), 1)
494 d.pop()
495 self.assertEqual(len(d), 0)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000496 self.assertRaises(IndexError, d.pop)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000497 self.assertEqual(len(d), 0)
498 d.append('c')
499 self.assertEqual(len(d), 1)
500 d.appendleft('d')
501 self.assertEqual(len(d), 2)
502 d.clear()
503 self.assertEqual(len(d), 0)
504
505 def test_underflow(self):
506 d = deque()
Raymond Hettinger738ec902004-02-29 02:15:56 +0000507 self.assertRaises(IndexError, d.pop)
508 self.assertRaises(IndexError, d.popleft)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000509
510 def test_clear(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000511 d = deque(range(100))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000512 self.assertEqual(len(d), 100)
513 d.clear()
514 self.assertEqual(len(d), 0)
515 self.assertEqual(list(d), [])
Martin Pantereb995702016-07-28 01:11:04 +0000516 d.clear() # clear an empty deque
Raymond Hettingera435c532004-07-09 04:10:20 +0000517 self.assertEqual(list(d), [])
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000518
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000519 def test_remove(self):
520 d = deque('abcdefghcij')
521 d.remove('c')
522 self.assertEqual(d, deque('abdefghcij'))
523 d.remove('c')
524 self.assertEqual(d, deque('abdefghij'))
525 self.assertRaises(ValueError, d.remove, 'c')
526 self.assertEqual(d, deque('abdefghij'))
527
Walter Dörwaldc448a912005-03-22 11:22:38 +0000528 # Handle comparison errors
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000529 d = deque(['a', 'b', BadCmp(), 'c'])
530 e = deque(d)
531 self.assertRaises(RuntimeError, d.remove, 'c')
532 for x, y in zip(d, e):
533 # verify that original order and values are retained.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000534 self.assertTrue(x is y)
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000535
536 # Handle evil mutator
Raymond Hettingerd73202c2005-03-19 00:00:51 +0000537 for match in (True, False):
538 d = deque(['ab'])
539 d.extend([MutateCmp(d, match), 'c'])
540 self.assertRaises(IndexError, d.remove, 'c')
541 self.assertEqual(d, deque())
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000542
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000543 def test_repr(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000544 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000545 e = eval(repr(d))
546 self.assertEqual(list(d), list(e))
547 d.append(d)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000548 self.assertIn('...', repr(d))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000549
550 def test_print(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000551 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000552 d.append(d)
Raymond Hettingera435c532004-07-09 04:10:20 +0000553 try:
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000554 support.unlink(support.TESTFN)
555 fo = open(support.TESTFN, "w")
Christian Heimescc47b052008-03-25 14:56:36 +0000556 print(d, file=fo, end='')
Raymond Hettingera435c532004-07-09 04:10:20 +0000557 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000558 fo = open(support.TESTFN, "r")
Raymond Hettingera435c532004-07-09 04:10:20 +0000559 self.assertEqual(fo.read(), repr(d))
560 finally:
561 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000562 support.unlink(support.TESTFN)
Raymond Hettingera435c532004-07-09 04:10:20 +0000563
564 def test_init(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000565 self.assertRaises(TypeError, deque, 'abc', 2, 3);
Raymond Hettingera435c532004-07-09 04:10:20 +0000566 self.assertRaises(TypeError, deque, 1);
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000567
568 def test_hash(self):
569 self.assertRaises(TypeError, hash, deque('abc'))
570
571 def test_long_steadystate_queue_popleft(self):
572 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000573 d = deque(range(size))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000574 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000575 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000576 append(i)
577 x = pop()
578 if x != i - size:
579 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000580 self.assertEqual(list(d), list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000581
582 def test_long_steadystate_queue_popright(self):
583 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000584 d = deque(reversed(range(size)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000585 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000586 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000587 append(i)
588 x = pop()
589 if x != i - size:
590 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000591 self.assertEqual(list(reversed(list(d))),
592 list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000593
594 def test_big_queue_popleft(self):
595 pass
596 d = deque()
597 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000598 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000599 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000600 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000601 x = pop()
602 if x != i:
603 self.assertEqual(x, i)
604
605 def test_big_queue_popright(self):
606 d = deque()
607 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000608 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000609 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000610 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000611 x = pop()
612 if x != i:
613 self.assertEqual(x, i)
614
615 def test_big_stack_right(self):
616 d = deque()
617 append, pop = d.append, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000618 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000619 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000620 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000621 x = pop()
622 if x != i:
623 self.assertEqual(x, i)
624 self.assertEqual(len(d), 0)
625
626 def test_big_stack_left(self):
627 d = deque()
628 append, pop = d.appendleft, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000629 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000630 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000631 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000632 x = pop()
633 if x != i:
634 self.assertEqual(x, i)
635 self.assertEqual(len(d), 0)
636
637 def test_roundtrip_iter_init(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000638 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000639 e = deque(d)
640 self.assertNotEqual(id(d), id(e))
641 self.assertEqual(list(d), list(e))
642
643 def test_pickle(self):
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200644 for d in deque(range(200)), deque(range(200), 100):
645 for i in range(pickle.HIGHEST_PROTOCOL + 1):
646 s = pickle.dumps(d, i)
647 e = pickle.loads(s)
648 self.assertNotEqual(id(e), id(d))
649 self.assertEqual(list(e), list(d))
650 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000651
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200652 def test_pickle_recursive(self):
653 for d in deque('abc'), deque('abc', 3):
654 d.append(d)
655 for i in range(pickle.HIGHEST_PROTOCOL + 1):
656 e = pickle.loads(pickle.dumps(d, i))
657 self.assertNotEqual(id(e), id(d))
658 self.assertEqual(id(e[-1]), id(e))
659 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000660
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000661 def test_iterator_pickle(self):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200662 orig = deque(range(200))
663 data = [i*1.01 for i in orig]
Serhiy Storchakabad12572014-12-15 14:03:42 +0200664 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200665 # initial iterator
666 itorg = iter(orig)
667 dump = pickle.dumps((itorg, orig), proto)
668 it, d = pickle.loads(dump)
669 for i, x in enumerate(data):
670 d[i] = x
671 self.assertEqual(type(it), type(itorg))
672 self.assertEqual(list(it), data)
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000673
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200674 # running iterator
675 next(itorg)
676 dump = pickle.dumps((itorg, orig), proto)
677 it, d = pickle.loads(dump)
678 for i, x in enumerate(data):
679 d[i] = x
680 self.assertEqual(type(it), type(itorg))
681 self.assertEqual(list(it), data[1:])
682
683 # empty iterator
684 for i in range(1, len(data)):
685 next(itorg)
686 dump = pickle.dumps((itorg, orig), proto)
687 it, d = pickle.loads(dump)
688 for i, x in enumerate(data):
689 d[i] = x
690 self.assertEqual(type(it), type(itorg))
691 self.assertEqual(list(it), [])
692
693 # exhausted iterator
694 self.assertRaises(StopIteration, next, itorg)
695 dump = pickle.dumps((itorg, orig), proto)
696 it, d = pickle.loads(dump)
697 for i, x in enumerate(data):
698 d[i] = x
699 self.assertEqual(type(it), type(itorg))
700 self.assertEqual(list(it), [])
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000701
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000702 def test_deepcopy(self):
703 mut = [10]
704 d = deque([mut])
705 e = copy.deepcopy(d)
706 self.assertEqual(list(d), list(e))
707 mut[0] = 11
708 self.assertNotEqual(id(d), id(e))
709 self.assertNotEqual(list(d), list(e))
710
711 def test_copy(self):
712 mut = [10]
713 d = deque([mut])
714 e = copy.copy(d)
715 self.assertEqual(list(d), list(e))
716 mut[0] = 11
717 self.assertNotEqual(id(d), id(e))
718 self.assertEqual(list(d), list(e))
719
Raymond Hettingeraed88302015-09-19 09:05:42 -0700720 for i in range(5):
721 for maxlen in range(-1, 6):
722 s = [random.random() for j in range(i)]
723 d = deque(s) if maxlen == -1 else deque(s, maxlen)
724 e = d.copy()
725 self.assertEqual(d, e)
726 self.assertEqual(d.maxlen, e.maxlen)
727 self.assertTrue(all(x is y for x, y in zip(d, e)))
728
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700729 def test_copy_method(self):
730 mut = [10]
731 d = deque([mut])
732 e = d.copy()
733 self.assertEqual(list(d), list(e))
734 mut[0] = 11
735 self.assertNotEqual(id(d), id(e))
736 self.assertEqual(list(d), list(e))
737
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000738 def test_reversed(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000739 for s in ('abcd', range(2000)):
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000740 self.assertEqual(list(reversed(deque(s))), list(reversed(s)))
741
Raymond Hettingerbadf5d82014-06-14 20:41:22 -0700742 def test_reversed_new(self):
743 klass = type(reversed(deque()))
744 for s in ('abcd', range(2000)):
745 self.assertEqual(list(klass(deque(s))), list(reversed(s)))
746
Tim Peters10c7e862004-10-01 02:01:04 +0000747 def test_gc_doesnt_blowup(self):
748 import gc
749 # This used to assert-fail in deque_traverse() under a debug
750 # build, or run wild with a NULL pointer in a release build.
751 d = deque()
Guido van Rossum805365e2007-05-07 22:24:25 +0000752 for i in range(100):
Tim Peters10c7e862004-10-01 02:01:04 +0000753 d.append(1)
754 gc.collect()
755
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000756 def test_container_iterator(self):
757 # Bug #3680: tp_traverse was not implemented for deque iterator objects
758 class C(object):
759 pass
760 for i in range(2):
761 obj = C()
762 ref = weakref.ref(obj)
763 if i == 0:
764 container = deque([obj, 1])
765 else:
766 container = reversed(deque([obj, 1]))
767 obj.x = iter(container)
768 del obj, container
769 gc.collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000770 self.assertTrue(ref() is None, "Cycle was not collected")
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000771
Jesus Cea16e2fca2012-08-03 14:49:42 +0200772 check_sizeof = support.check_sizeof
773
774 @support.cpython_only
775 def test_sizeof(self):
Raymond Hettingerdaf57f22015-02-26 23:21:29 -0800776 BLOCKLEN = 64
Serhiy Storchakae23c90c2016-05-18 13:00:56 +0300777 basesize = support.calcvobjsize('2P4nP')
778 blocksize = struct.calcsize('P%dPP' % BLOCKLEN)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200779 self.assertEqual(object.__sizeof__(deque()), basesize)
780 check = self.check_sizeof
781 check(deque(), basesize + blocksize)
782 check(deque('a'), basesize + blocksize)
Raymond Hettingerd9c116c2013-07-09 00:13:21 -0700783 check(deque('a' * (BLOCKLEN - 1)), basesize + blocksize)
784 check(deque('a' * BLOCKLEN), basesize + 2 * blocksize)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200785 check(deque('a' * (42 * BLOCKLEN)), basesize + 43 * blocksize)
786
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000787class TestVariousIteratorArgs(unittest.TestCase):
788
789 def test_constructor(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000790 for s in ("123", "", range(1000), ('do', 1.2), range(2000,2200,5)):
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000791 for g in (seq_tests.Sequence, seq_tests.IterFunc,
792 seq_tests.IterGen, seq_tests.IterFuncStop,
793 seq_tests.itermulti, seq_tests.iterfunc):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000794 self.assertEqual(list(deque(g(s))), list(g(s)))
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000795 self.assertRaises(TypeError, deque, seq_tests.IterNextOnly(s))
796 self.assertRaises(TypeError, deque, seq_tests.IterNoNext(s))
797 self.assertRaises(ZeroDivisionError, deque, seq_tests.IterGenExc(s))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000798
799 def test_iter_with_altered_data(self):
800 d = deque('abcdefg')
801 it = iter(d)
802 d.pop()
Georg Brandla18af4e2007-04-21 15:47:16 +0000803 self.assertRaises(RuntimeError, next, it)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000804
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000805 def test_runtime_error_on_empty_deque(self):
806 d = deque()
807 it = iter(d)
808 d.append(10)
Georg Brandla18af4e2007-04-21 15:47:16 +0000809 self.assertRaises(RuntimeError, next, it)
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000810
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000811class Deque(deque):
812 pass
813
Raymond Hettinger952f8802004-11-09 07:27:35 +0000814class DequeWithBadIter(deque):
815 def __iter__(self):
816 raise TypeError
817
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000818class TestSubclass(unittest.TestCase):
819
820 def test_basics(self):
Christian Heimes38053212007-12-14 01:24:44 +0000821 d = Deque(range(25))
822 d.__init__(range(200))
Guido van Rossum805365e2007-05-07 22:24:25 +0000823 for i in range(200, 400):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000824 d.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000825 for i in reversed(range(-200, 0)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000826 d.appendleft(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000827 self.assertEqual(list(d), list(range(-200, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000828 self.assertEqual(len(d), 600)
829
Guido van Rossum805365e2007-05-07 22:24:25 +0000830 left = [d.popleft() for i in range(250)]
831 self.assertEqual(left, list(range(-200, 50)))
832 self.assertEqual(list(d), list(range(50, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000833
Guido van Rossum805365e2007-05-07 22:24:25 +0000834 right = [d.pop() for i in range(250)]
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000835 right.reverse()
Guido van Rossum805365e2007-05-07 22:24:25 +0000836 self.assertEqual(right, list(range(150, 400)))
837 self.assertEqual(list(d), list(range(50, 150)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000838
839 d.clear()
840 self.assertEqual(len(d), 0)
841
842 def test_copy_pickle(self):
843
844 d = Deque('abc')
845
846 e = d.__copy__()
847 self.assertEqual(type(d), type(e))
848 self.assertEqual(list(d), list(e))
849
850 e = Deque(d)
851 self.assertEqual(type(d), type(e))
852 self.assertEqual(list(d), list(e))
853
Serhiy Storchakabad12572014-12-15 14:03:42 +0200854 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
855 s = pickle.dumps(d, proto)
856 e = pickle.loads(s)
857 self.assertNotEqual(id(d), id(e))
858 self.assertEqual(type(d), type(e))
859 self.assertEqual(list(d), list(e))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000860
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000861 d = Deque('abcde', maxlen=4)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000862
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000863 e = d.__copy__()
864 self.assertEqual(type(d), type(e))
865 self.assertEqual(list(d), list(e))
866
867 e = Deque(d)
868 self.assertEqual(type(d), type(e))
869 self.assertEqual(list(d), list(e))
870
Serhiy Storchakabad12572014-12-15 14:03:42 +0200871 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
872 s = pickle.dumps(d, proto)
873 e = pickle.loads(s)
874 self.assertNotEqual(id(d), id(e))
875 self.assertEqual(type(d), type(e))
876 self.assertEqual(list(d), list(e))
Raymond Hettinger952f8802004-11-09 07:27:35 +0000877
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200878 def test_pickle_recursive(self):
879 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
880 for d in Deque('abc'), Deque('abc', 3):
881 d.append(d)
882
883 e = pickle.loads(pickle.dumps(d, proto))
884 self.assertNotEqual(id(e), id(d))
885 self.assertEqual(type(e), type(d))
886 self.assertEqual(e.maxlen, d.maxlen)
887 dd = d.pop()
888 ee = e.pop()
889 self.assertEqual(id(ee), id(e))
890 self.assertEqual(e, d)
891
892 d.x = d
893 e = pickle.loads(pickle.dumps(d, proto))
894 self.assertEqual(id(e.x), id(e))
895
896 for d in DequeWithBadIter('abc'), DequeWithBadIter('abc', 2):
897 self.assertRaises(TypeError, pickle.dumps, d, proto)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000898
Raymond Hettinger691d8052004-05-30 07:26:47 +0000899 def test_weakref(self):
900 d = deque('gallahad')
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000901 p = weakref.proxy(d)
Raymond Hettinger691d8052004-05-30 07:26:47 +0000902 self.assertEqual(str(p), str(d))
903 d = None
904 self.assertRaises(ReferenceError, str, p)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000905
Armin Rigo974d7572004-10-02 13:59:34 +0000906 def test_strange_subclass(self):
907 class X(deque):
908 def __iter__(self):
909 return iter([])
910 d1 = X([1,2,3])
911 d2 = X([4,5,6])
912 d1 == d2 # not clear if this is supposed to be True or False,
913 # but it used to give a SystemError
914
Oren Milman24bd50b2018-09-11 21:46:55 +0300915 @support.cpython_only
916 def test_bug_31608(self):
917 # The interpreter used to crash in specific cases where a deque
918 # subclass returned a non-deque.
919 class X(deque):
920 pass
921 d = X()
922 def bad___new__(cls, *args, **kwargs):
923 return [42]
924 X.__new__ = bad___new__
925 with self.assertRaises(TypeError):
926 d * 42 # shouldn't crash
927 with self.assertRaises(TypeError):
928 d + deque([1, 2, 3]) # shouldn't crash
929
Thomas Woutersb2137042007-02-01 18:02:27 +0000930
931class SubclassWithKwargs(deque):
932 def __init__(self, newarg=1):
933 deque.__init__(self)
934
935class TestSubclassWithKwargs(unittest.TestCase):
936 def test_subclass_with_kwargs(self):
937 # SF bug #1486663 -- this used to erroneously raise a TypeError
938 SubclassWithKwargs(newarg=1)
939
Raymond Hettinger067bbba2015-04-01 08:11:09 -0700940class TestSequence(seq_tests.CommonTest):
941 type2test = deque
942
943 def test_getitem(self):
944 # For now, bypass tests that require slicing
945 pass
946
947 def test_getslice(self):
948 # For now, bypass tests that require slicing
949 pass
950
951 def test_subscript(self):
952 # For now, bypass tests that require slicing
953 pass
954
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +0300955 def test_free_after_iterating(self):
956 # For now, bypass tests that require slicing
957 self.skipTest("Exhausted deque iterator doesn't free a deque")
958
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000959#==============================================================================
960
Raymond Hettinger738ec902004-02-29 02:15:56 +0000961libreftest = """
962Example from the Library Reference: Doc/lib/libcollections.tex
963
964>>> from collections import deque
965>>> d = deque('ghi') # make a new deque with three items
966>>> for elem in d: # iterate over the deque's elements
Guido van Rossum7131f842007-02-09 20:13:25 +0000967... print(elem.upper())
Raymond Hettinger738ec902004-02-29 02:15:56 +0000968G
969H
970I
971>>> d.append('j') # add a new entry to the right side
972>>> d.appendleft('f') # add a new entry to the left side
973>>> d # show the representation of the deque
974deque(['f', 'g', 'h', 'i', 'j'])
975>>> d.pop() # return and remove the rightmost item
976'j'
977>>> d.popleft() # return and remove the leftmost item
978'f'
979>>> list(d) # list the contents of the deque
980['g', 'h', 'i']
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000981>>> d[0] # peek at leftmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000982'g'
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000983>>> d[-1] # peek at rightmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000984'i'
985>>> list(reversed(d)) # list the contents of a deque in reverse
986['i', 'h', 'g']
987>>> 'h' in d # search the deque
988True
989>>> d.extend('jkl') # add multiple elements at once
990>>> d
991deque(['g', 'h', 'i', 'j', 'k', 'l'])
992>>> d.rotate(1) # right rotation
993>>> d
994deque(['l', 'g', 'h', 'i', 'j', 'k'])
995>>> d.rotate(-1) # left rotation
996>>> d
997deque(['g', 'h', 'i', 'j', 'k', 'l'])
998>>> deque(reversed(d)) # make a new deque in reverse order
999deque(['l', 'k', 'j', 'i', 'h', 'g'])
1000>>> d.clear() # empty the deque
1001>>> d.pop() # cannot pop from an empty deque
1002Traceback (most recent call last):
1003 File "<pyshell#6>", line 1, in -toplevel-
1004 d.pop()
1005IndexError: pop from an empty deque
1006
1007>>> d.extendleft('abc') # extendleft() reverses the input order
1008>>> d
1009deque(['c', 'b', 'a'])
1010
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001011
1012
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001013>>> def delete_nth(d, n):
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001014... d.rotate(-n)
1015... d.popleft()
1016... d.rotate(n)
1017...
1018>>> d = deque('abcdef')
1019>>> delete_nth(d, 2) # remove the entry at d[2]
1020>>> d
1021deque(['a', 'b', 'd', 'e', 'f'])
1022
1023
1024
1025>>> def roundrobin(*iterables):
1026... pending = deque(iter(i) for i in iterables)
1027... while pending:
1028... task = pending.popleft()
1029... try:
Georg Brandla18af4e2007-04-21 15:47:16 +00001030... yield next(task)
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001031... except StopIteration:
1032... continue
1033... pending.append(task)
1034...
1035
1036>>> for value in roundrobin('abc', 'd', 'efgh'):
Guido van Rossum7131f842007-02-09 20:13:25 +00001037... print(value)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001038...
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001039a
1040d
1041e
1042b
1043f
1044c
1045g
1046h
1047
1048
1049>>> def maketree(iterable):
1050... d = deque(iterable)
1051... while len(d) > 1:
1052... pair = [d.popleft(), d.popleft()]
1053... d.append(pair)
1054... return list(d)
1055...
Guido van Rossum7131f842007-02-09 20:13:25 +00001056>>> print(maketree('abcdefgh'))
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001057[[[['a', 'b'], ['c', 'd']], [['e', 'f'], ['g', 'h']]]]
1058
Raymond Hettinger738ec902004-02-29 02:15:56 +00001059"""
1060
1061
1062#==============================================================================
1063
1064__test__ = {'libreftest' : libreftest}
1065
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001066def test_main(verbose=None):
1067 import sys
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001068 test_classes = (
1069 TestBasic,
1070 TestVariousIteratorArgs,
1071 TestSubclass,
Thomas Woutersb2137042007-02-01 18:02:27 +00001072 TestSubclassWithKwargs,
Raymond Hettinger067bbba2015-04-01 08:11:09 -07001073 TestSequence,
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001074 )
1075
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001076 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001077
1078 # verify reference counting
1079 if verbose and hasattr(sys, "gettotalrefcount"):
1080 import gc
1081 counts = [None] * 5
Guido van Rossum805365e2007-05-07 22:24:25 +00001082 for i in range(len(counts)):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001083 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001084 gc.collect()
1085 counts[i] = sys.gettotalrefcount()
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001086 print(counts)
Raymond Hettinger0a4977c2004-03-01 23:16:22 +00001087
Raymond Hettinger738ec902004-02-29 02:15:56 +00001088 # doctests
1089 from test import test_deque
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001090 support.run_doctest(test_deque, verbose)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001091
1092if __name__ == "__main__":
1093 test_main(verbose=True)