blob: 51b66b76aca91d03540db2e05aa80e7fc55af073 [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
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000186 def test_extend(self):
187 d = deque('a')
188 self.assertRaises(TypeError, d.extend, 1)
189 d.extend('bcd')
190 self.assertEqual(list(d), list('abcd'))
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000191 d.extend(d)
192 self.assertEqual(list(d), list('abcdabcd'))
193
Raymond Hettinger41290a62015-03-31 08:12:23 -0700194 def test_add(self):
195 d = deque()
196 e = deque('abc')
197 f = deque('def')
198 self.assertEqual(d + d, deque())
199 self.assertEqual(e + f, deque('abcdef'))
200 self.assertEqual(e + e, deque('abcabc'))
201 self.assertEqual(e + d, deque('abc'))
202 self.assertEqual(d + e, deque('abc'))
203 self.assertIsNot(d + d, deque())
204 self.assertIsNot(e + d, deque('abc'))
205 self.assertIsNot(d + e, deque('abc'))
206
207 g = deque('abcdef', maxlen=4)
208 h = deque('gh')
209 self.assertEqual(g + h, deque('efgh'))
210
211 with self.assertRaises(TypeError):
212 deque('abc') + 'def'
213
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000214 def test_iadd(self):
215 d = deque('a')
216 d += 'bcd'
217 self.assertEqual(list(d), list('abcd'))
218 d += d
219 self.assertEqual(list(d), list('abcdabcd'))
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000220
221 def test_extendleft(self):
222 d = deque('a')
223 self.assertRaises(TypeError, d.extendleft, 1)
224 d.extendleft('bcd')
225 self.assertEqual(list(d), list(reversed('abcd')))
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000226 d.extendleft(d)
227 self.assertEqual(list(d), list('abcddcba'))
Raymond Hettingera435c532004-07-09 04:10:20 +0000228 d = deque()
229 d.extendleft(range(1000))
230 self.assertEqual(list(d), list(reversed(range(1000))))
231 self.assertRaises(SyntaxError, d.extendleft, fail())
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000232
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000233 def test_getitem(self):
234 n = 200
Guido van Rossum805365e2007-05-07 22:24:25 +0000235 d = deque(range(n))
236 l = list(range(n))
237 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000238 d.popleft()
239 l.pop(0)
240 if random.random() < 0.5:
241 d.append(i)
242 l.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000243 for j in range(1-len(l), len(l)):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000244 assert d[j] == l[j]
245
Raymond Hettinger738ec902004-02-29 02:15:56 +0000246 d = deque('superman')
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000247 self.assertEqual(d[0], 's')
248 self.assertEqual(d[-1], 'n')
Raymond Hettinger738ec902004-02-29 02:15:56 +0000249 d = deque()
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000250 self.assertRaises(IndexError, d.__getitem__, 0)
251 self.assertRaises(IndexError, d.__getitem__, -1)
252
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700253 def test_index(self):
254 for n in 1, 2, 30, 40, 200:
255
256 d = deque(range(n))
257 for i in range(n):
258 self.assertEqual(d.index(i), i)
259
260 with self.assertRaises(ValueError):
261 d.index(n+1)
262
263 # Test detection of mutation during iteration
264 d = deque(range(n))
265 d[n//2] = MutateCmp(d, False)
266 with self.assertRaises(RuntimeError):
267 d.index(n)
268
269 # Test detection of comparison exceptions
270 d = deque(range(n))
271 d[n//2] = BadCmp()
272 with self.assertRaises(RuntimeError):
273 d.index(n)
274
275 # Test start and stop arguments behavior matches list.index()
276 elements = 'ABCDEFGHI'
277 nonelement = 'Z'
278 d = deque(elements * 2)
279 s = list(elements * 2)
280 for start in range(-5 - len(s)*2, 5 + len(s) * 2):
281 for stop in range(-5 - len(s)*2, 5 + len(s) * 2):
282 for element in elements + 'Z':
283 try:
284 target = s.index(element, start, stop)
285 except ValueError:
286 with self.assertRaises(ValueError):
287 d.index(element, start, stop)
288 else:
289 self.assertEqual(d.index(element, start, stop), target)
290
Raymond Hettingerb46ad542018-09-21 01:46:41 -0700291 # Test large start argument
292 d = deque(range(0, 10000, 10))
293 for step in range(100):
294 i = d.index(8500, 700)
295 self.assertEqual(d[i], 8500)
296 # Repeat test with a different internal offset
297 d.rotate()
298
Raymond Hettinger906d82d2016-01-25 23:00:21 -0800299 def test_index_bug_24913(self):
Raymond Hettinger87674ec2015-08-26 08:08:38 -0700300 d = deque('A' * 3)
301 with self.assertRaises(ValueError):
302 i = d.index("Hello world", 0, 4)
303
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700304 def test_insert(self):
305 # Test to make sure insert behaves like lists
306 elements = 'ABCDEFGHI'
307 for i in range(-5 - len(elements)*2, 5 + len(elements) * 2):
308 d = deque('ABCDEFGHI')
309 s = list('ABCDEFGHI')
310 d.insert(i, 'Z')
311 s.insert(i, 'Z')
312 self.assertEqual(list(d), s)
313
Raymond Hettingera6389712016-02-01 21:21:19 -0800314 def test_insert_bug_26194(self):
Raymond Hettinger37434322016-01-26 21:44:16 -0800315 data = 'ABC'
Raymond Hettingera6389712016-02-01 21:21:19 -0800316 d = deque(data, maxlen=len(data))
317 with self.assertRaises(IndexError):
318 d.insert(2, None)
319
320 elements = 'ABCDEFGHI'
321 for i in range(-len(elements), len(elements)):
322 d = deque(elements, maxlen=len(elements)+1)
323 d.insert(i, 'Z')
324 if i >= 0:
325 self.assertEqual(d[i], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800326 else:
Raymond Hettingera6389712016-02-01 21:21:19 -0800327 self.assertEqual(d[i-1], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800328
Raymond Hettinger41290a62015-03-31 08:12:23 -0700329 def test_imul(self):
330 for n in (-10, -1, 0, 1, 2, 10, 1000):
331 d = deque()
332 d *= n
333 self.assertEqual(d, deque())
334 self.assertIsNone(d.maxlen)
335
336 for n in (-10, -1, 0, 1, 2, 10, 1000):
337 d = deque('a')
338 d *= n
339 self.assertEqual(d, deque('a' * n))
340 self.assertIsNone(d.maxlen)
341
342 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
343 d = deque('a', 500)
344 d *= n
345 self.assertEqual(d, deque('a' * min(n, 500)))
346 self.assertEqual(d.maxlen, 500)
347
348 for n in (-10, -1, 0, 1, 2, 10, 1000):
349 d = deque('abcdef')
350 d *= n
351 self.assertEqual(d, deque('abcdef' * n))
352 self.assertIsNone(d.maxlen)
353
354 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
355 d = deque('abcdef', 500)
356 d *= n
357 self.assertEqual(d, deque(('abcdef' * n)[-500:]))
358 self.assertEqual(d.maxlen, 500)
359
360 def test_mul(self):
361 d = deque('abc')
362 self.assertEqual(d * -5, deque())
363 self.assertEqual(d * 0, deque())
364 self.assertEqual(d * 1, deque('abc'))
365 self.assertEqual(d * 2, deque('abcabc'))
366 self.assertEqual(d * 3, deque('abcabcabc'))
367 self.assertIsNot(d * 1, d)
368
369 self.assertEqual(deque() * 0, deque())
370 self.assertEqual(deque() * 1, deque())
371 self.assertEqual(deque() * 5, deque())
372
373 self.assertEqual(-5 * d, deque())
374 self.assertEqual(0 * d, deque())
375 self.assertEqual(1 * d, deque('abc'))
376 self.assertEqual(2 * d, deque('abcabc'))
377 self.assertEqual(3 * d, deque('abcabcabc'))
378
379 d = deque('abc', maxlen=5)
380 self.assertEqual(d * -5, deque())
381 self.assertEqual(d * 0, deque())
382 self.assertEqual(d * 1, deque('abc'))
383 self.assertEqual(d * 2, deque('bcabc'))
384 self.assertEqual(d * 30, deque('bcabc'))
385
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000386 def test_setitem(self):
387 n = 200
Guido van Rossum805365e2007-05-07 22:24:25 +0000388 d = deque(range(n))
389 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000390 d[i] = 10 * i
Guido van Rossum805365e2007-05-07 22:24:25 +0000391 self.assertEqual(list(d), [10*i for i in range(n)])
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000392 l = list(d)
Guido van Rossum805365e2007-05-07 22:24:25 +0000393 for i in range(1-n, 0, -1):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000394 d[i] = 7*i
395 l[i] = 7*i
396 self.assertEqual(list(d), l)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000397
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000398 def test_delitem(self):
399 n = 500 # O(n**2) test, don't make this too big
Guido van Rossum805365e2007-05-07 22:24:25 +0000400 d = deque(range(n))
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000401 self.assertRaises(IndexError, d.__delitem__, -n-1)
402 self.assertRaises(IndexError, d.__delitem__, n)
Guido van Rossum805365e2007-05-07 22:24:25 +0000403 for i in range(n):
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000404 self.assertEqual(len(d), n-i)
405 j = random.randrange(-len(d), len(d))
406 val = d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000407 self.assertIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000408 del d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000409 self.assertNotIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000410 self.assertEqual(len(d), 0)
411
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000412 def test_reverse(self):
413 n = 500 # O(n**2) test, don't make this too big
414 data = [random.random() for i in range(n)]
415 for i in range(n):
416 d = deque(data[:i])
417 r = d.reverse()
418 self.assertEqual(list(d), list(reversed(data[:i])))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000419 self.assertIs(r, None)
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000420 d.reverse()
421 self.assertEqual(list(d), data[:i])
422 self.assertRaises(TypeError, d.reverse, 1) # Arity is zero
423
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000424 def test_rotate(self):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000425 s = tuple('abcde')
426 n = len(s)
427
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000428 d = deque(s)
Raymond Hettingeree33b272004-02-08 04:05:26 +0000429 d.rotate(1) # verify rot(1)
430 self.assertEqual(''.join(d), 'eabcd')
431
432 d = deque(s)
433 d.rotate(-1) # verify rot(-1)
434 self.assertEqual(''.join(d), 'bcdea')
435 d.rotate() # check default to 1
436 self.assertEqual(tuple(d), s)
437
Guido van Rossum805365e2007-05-07 22:24:25 +0000438 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000439 d = deque(s)
440 e = deque(d)
441 d.rotate(i) # check vs. rot(1) n times
Guido van Rossum805365e2007-05-07 22:24:25 +0000442 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000443 e.rotate(1)
444 self.assertEqual(tuple(d), tuple(e))
445 d.rotate(-i) # check that it works in reverse
446 self.assertEqual(tuple(d), s)
447 e.rotate(n-i) # check that it wraps forward
448 self.assertEqual(tuple(e), 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)
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) # check vs. rot(-1) n times
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(i-n) # check that it wraps backaround
460 self.assertEqual(tuple(e), s)
461
462 d = deque(s)
463 e = deque(s)
464 e.rotate(BIG+17) # verify on long series of rotates
465 dr = d.rotate
Guido van Rossum805365e2007-05-07 22:24:25 +0000466 for i in range(BIG+17):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000467 dr()
468 self.assertEqual(tuple(d), tuple(e))
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000469
Raymond Hettingera435c532004-07-09 04:10:20 +0000470 self.assertRaises(TypeError, d.rotate, 'x') # Wrong arg type
471 self.assertRaises(TypeError, d.rotate, 1, 10) # Too many args
472
473 d = deque()
474 d.rotate() # rotate an empty deque
475 self.assertEqual(d, deque())
476
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000477 def test_len(self):
478 d = deque('ab')
479 self.assertEqual(len(d), 2)
480 d.popleft()
481 self.assertEqual(len(d), 1)
482 d.pop()
483 self.assertEqual(len(d), 0)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000484 self.assertRaises(IndexError, d.pop)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000485 self.assertEqual(len(d), 0)
486 d.append('c')
487 self.assertEqual(len(d), 1)
488 d.appendleft('d')
489 self.assertEqual(len(d), 2)
490 d.clear()
491 self.assertEqual(len(d), 0)
492
493 def test_underflow(self):
494 d = deque()
Raymond Hettinger738ec902004-02-29 02:15:56 +0000495 self.assertRaises(IndexError, d.pop)
496 self.assertRaises(IndexError, d.popleft)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000497
498 def test_clear(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000499 d = deque(range(100))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000500 self.assertEqual(len(d), 100)
501 d.clear()
502 self.assertEqual(len(d), 0)
503 self.assertEqual(list(d), [])
Martin Pantereb995702016-07-28 01:11:04 +0000504 d.clear() # clear an empty deque
Raymond Hettingera435c532004-07-09 04:10:20 +0000505 self.assertEqual(list(d), [])
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000506
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000507 def test_remove(self):
508 d = deque('abcdefghcij')
509 d.remove('c')
510 self.assertEqual(d, deque('abdefghcij'))
511 d.remove('c')
512 self.assertEqual(d, deque('abdefghij'))
513 self.assertRaises(ValueError, d.remove, 'c')
514 self.assertEqual(d, deque('abdefghij'))
515
Walter Dörwaldc448a912005-03-22 11:22:38 +0000516 # Handle comparison errors
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000517 d = deque(['a', 'b', BadCmp(), 'c'])
518 e = deque(d)
519 self.assertRaises(RuntimeError, d.remove, 'c')
520 for x, y in zip(d, e):
521 # verify that original order and values are retained.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000522 self.assertTrue(x is y)
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000523
524 # Handle evil mutator
Raymond Hettingerd73202c2005-03-19 00:00:51 +0000525 for match in (True, False):
526 d = deque(['ab'])
527 d.extend([MutateCmp(d, match), 'c'])
528 self.assertRaises(IndexError, d.remove, 'c')
529 self.assertEqual(d, deque())
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000530
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000531 def test_repr(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000532 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000533 e = eval(repr(d))
534 self.assertEqual(list(d), list(e))
535 d.append(d)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000536 self.assertIn('...', repr(d))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000537
538 def test_print(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000539 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000540 d.append(d)
Raymond Hettingera435c532004-07-09 04:10:20 +0000541 try:
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000542 support.unlink(support.TESTFN)
543 fo = open(support.TESTFN, "w")
Christian Heimescc47b052008-03-25 14:56:36 +0000544 print(d, file=fo, end='')
Raymond Hettingera435c532004-07-09 04:10:20 +0000545 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000546 fo = open(support.TESTFN, "r")
Raymond Hettingera435c532004-07-09 04:10:20 +0000547 self.assertEqual(fo.read(), repr(d))
548 finally:
549 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000550 support.unlink(support.TESTFN)
Raymond Hettingera435c532004-07-09 04:10:20 +0000551
552 def test_init(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000553 self.assertRaises(TypeError, deque, 'abc', 2, 3);
Raymond Hettingera435c532004-07-09 04:10:20 +0000554 self.assertRaises(TypeError, deque, 1);
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000555
556 def test_hash(self):
557 self.assertRaises(TypeError, hash, deque('abc'))
558
559 def test_long_steadystate_queue_popleft(self):
560 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000561 d = deque(range(size))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000562 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000563 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000564 append(i)
565 x = pop()
566 if x != i - size:
567 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000568 self.assertEqual(list(d), list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000569
570 def test_long_steadystate_queue_popright(self):
571 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000572 d = deque(reversed(range(size)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000573 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000574 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000575 append(i)
576 x = pop()
577 if x != i - size:
578 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000579 self.assertEqual(list(reversed(list(d))),
580 list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000581
582 def test_big_queue_popleft(self):
583 pass
584 d = deque()
585 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000586 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000587 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000588 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000589 x = pop()
590 if x != i:
591 self.assertEqual(x, i)
592
593 def test_big_queue_popright(self):
594 d = deque()
595 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000596 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000597 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000598 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000599 x = pop()
600 if x != i:
601 self.assertEqual(x, i)
602
603 def test_big_stack_right(self):
604 d = deque()
605 append, pop = d.append, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000606 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000607 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000608 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000609 x = pop()
610 if x != i:
611 self.assertEqual(x, i)
612 self.assertEqual(len(d), 0)
613
614 def test_big_stack_left(self):
615 d = deque()
616 append, pop = d.appendleft, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000617 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000618 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000619 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000620 x = pop()
621 if x != i:
622 self.assertEqual(x, i)
623 self.assertEqual(len(d), 0)
624
625 def test_roundtrip_iter_init(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000626 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000627 e = deque(d)
628 self.assertNotEqual(id(d), id(e))
629 self.assertEqual(list(d), list(e))
630
631 def test_pickle(self):
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200632 for d in deque(range(200)), deque(range(200), 100):
633 for i in range(pickle.HIGHEST_PROTOCOL + 1):
634 s = pickle.dumps(d, i)
635 e = pickle.loads(s)
636 self.assertNotEqual(id(e), id(d))
637 self.assertEqual(list(e), list(d))
638 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000639
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200640 def test_pickle_recursive(self):
641 for d in deque('abc'), deque('abc', 3):
642 d.append(d)
643 for i in range(pickle.HIGHEST_PROTOCOL + 1):
644 e = pickle.loads(pickle.dumps(d, i))
645 self.assertNotEqual(id(e), id(d))
646 self.assertEqual(id(e[-1]), id(e))
647 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000648
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000649 def test_iterator_pickle(self):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200650 orig = deque(range(200))
651 data = [i*1.01 for i in orig]
Serhiy Storchakabad12572014-12-15 14:03:42 +0200652 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200653 # initial iterator
654 itorg = iter(orig)
655 dump = pickle.dumps((itorg, orig), proto)
656 it, d = pickle.loads(dump)
657 for i, x in enumerate(data):
658 d[i] = x
659 self.assertEqual(type(it), type(itorg))
660 self.assertEqual(list(it), data)
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000661
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200662 # running iterator
663 next(itorg)
664 dump = pickle.dumps((itorg, orig), proto)
665 it, d = pickle.loads(dump)
666 for i, x in enumerate(data):
667 d[i] = x
668 self.assertEqual(type(it), type(itorg))
669 self.assertEqual(list(it), data[1:])
670
671 # empty iterator
672 for i in range(1, len(data)):
673 next(itorg)
674 dump = pickle.dumps((itorg, orig), proto)
675 it, d = pickle.loads(dump)
676 for i, x in enumerate(data):
677 d[i] = x
678 self.assertEqual(type(it), type(itorg))
679 self.assertEqual(list(it), [])
680
681 # exhausted iterator
682 self.assertRaises(StopIteration, next, itorg)
683 dump = pickle.dumps((itorg, orig), proto)
684 it, d = pickle.loads(dump)
685 for i, x in enumerate(data):
686 d[i] = x
687 self.assertEqual(type(it), type(itorg))
688 self.assertEqual(list(it), [])
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000689
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000690 def test_deepcopy(self):
691 mut = [10]
692 d = deque([mut])
693 e = copy.deepcopy(d)
694 self.assertEqual(list(d), list(e))
695 mut[0] = 11
696 self.assertNotEqual(id(d), id(e))
697 self.assertNotEqual(list(d), list(e))
698
699 def test_copy(self):
700 mut = [10]
701 d = deque([mut])
702 e = copy.copy(d)
703 self.assertEqual(list(d), list(e))
704 mut[0] = 11
705 self.assertNotEqual(id(d), id(e))
706 self.assertEqual(list(d), list(e))
707
Raymond Hettingeraed88302015-09-19 09:05:42 -0700708 for i in range(5):
709 for maxlen in range(-1, 6):
710 s = [random.random() for j in range(i)]
711 d = deque(s) if maxlen == -1 else deque(s, maxlen)
712 e = d.copy()
713 self.assertEqual(d, e)
714 self.assertEqual(d.maxlen, e.maxlen)
715 self.assertTrue(all(x is y for x, y in zip(d, e)))
716
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700717 def test_copy_method(self):
718 mut = [10]
719 d = deque([mut])
720 e = d.copy()
721 self.assertEqual(list(d), list(e))
722 mut[0] = 11
723 self.assertNotEqual(id(d), id(e))
724 self.assertEqual(list(d), list(e))
725
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000726 def test_reversed(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000727 for s in ('abcd', range(2000)):
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000728 self.assertEqual(list(reversed(deque(s))), list(reversed(s)))
729
Raymond Hettingerbadf5d82014-06-14 20:41:22 -0700730 def test_reversed_new(self):
731 klass = type(reversed(deque()))
732 for s in ('abcd', range(2000)):
733 self.assertEqual(list(klass(deque(s))), list(reversed(s)))
734
Tim Peters10c7e862004-10-01 02:01:04 +0000735 def test_gc_doesnt_blowup(self):
736 import gc
737 # This used to assert-fail in deque_traverse() under a debug
738 # build, or run wild with a NULL pointer in a release build.
739 d = deque()
Guido van Rossum805365e2007-05-07 22:24:25 +0000740 for i in range(100):
Tim Peters10c7e862004-10-01 02:01:04 +0000741 d.append(1)
742 gc.collect()
743
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000744 def test_container_iterator(self):
745 # Bug #3680: tp_traverse was not implemented for deque iterator objects
746 class C(object):
747 pass
748 for i in range(2):
749 obj = C()
750 ref = weakref.ref(obj)
751 if i == 0:
752 container = deque([obj, 1])
753 else:
754 container = reversed(deque([obj, 1]))
755 obj.x = iter(container)
756 del obj, container
757 gc.collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000758 self.assertTrue(ref() is None, "Cycle was not collected")
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000759
Jesus Cea16e2fca2012-08-03 14:49:42 +0200760 check_sizeof = support.check_sizeof
761
762 @support.cpython_only
763 def test_sizeof(self):
Raymond Hettingerdaf57f22015-02-26 23:21:29 -0800764 BLOCKLEN = 64
Serhiy Storchakae23c90c2016-05-18 13:00:56 +0300765 basesize = support.calcvobjsize('2P4nP')
766 blocksize = struct.calcsize('P%dPP' % BLOCKLEN)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200767 self.assertEqual(object.__sizeof__(deque()), basesize)
768 check = self.check_sizeof
769 check(deque(), basesize + blocksize)
770 check(deque('a'), basesize + blocksize)
Raymond Hettingerd9c116c2013-07-09 00:13:21 -0700771 check(deque('a' * (BLOCKLEN - 1)), basesize + blocksize)
772 check(deque('a' * BLOCKLEN), basesize + 2 * blocksize)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200773 check(deque('a' * (42 * BLOCKLEN)), basesize + 43 * blocksize)
774
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000775class TestVariousIteratorArgs(unittest.TestCase):
776
777 def test_constructor(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000778 for s in ("123", "", range(1000), ('do', 1.2), range(2000,2200,5)):
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000779 for g in (seq_tests.Sequence, seq_tests.IterFunc,
780 seq_tests.IterGen, seq_tests.IterFuncStop,
781 seq_tests.itermulti, seq_tests.iterfunc):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000782 self.assertEqual(list(deque(g(s))), list(g(s)))
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000783 self.assertRaises(TypeError, deque, seq_tests.IterNextOnly(s))
784 self.assertRaises(TypeError, deque, seq_tests.IterNoNext(s))
785 self.assertRaises(ZeroDivisionError, deque, seq_tests.IterGenExc(s))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000786
787 def test_iter_with_altered_data(self):
788 d = deque('abcdefg')
789 it = iter(d)
790 d.pop()
Georg Brandla18af4e2007-04-21 15:47:16 +0000791 self.assertRaises(RuntimeError, next, it)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000792
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000793 def test_runtime_error_on_empty_deque(self):
794 d = deque()
795 it = iter(d)
796 d.append(10)
Georg Brandla18af4e2007-04-21 15:47:16 +0000797 self.assertRaises(RuntimeError, next, it)
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000798
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000799class Deque(deque):
800 pass
801
Raymond Hettinger952f8802004-11-09 07:27:35 +0000802class DequeWithBadIter(deque):
803 def __iter__(self):
804 raise TypeError
805
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000806class TestSubclass(unittest.TestCase):
807
808 def test_basics(self):
Christian Heimes38053212007-12-14 01:24:44 +0000809 d = Deque(range(25))
810 d.__init__(range(200))
Guido van Rossum805365e2007-05-07 22:24:25 +0000811 for i in range(200, 400):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000812 d.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000813 for i in reversed(range(-200, 0)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000814 d.appendleft(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000815 self.assertEqual(list(d), list(range(-200, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000816 self.assertEqual(len(d), 600)
817
Guido van Rossum805365e2007-05-07 22:24:25 +0000818 left = [d.popleft() for i in range(250)]
819 self.assertEqual(left, list(range(-200, 50)))
820 self.assertEqual(list(d), list(range(50, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000821
Guido van Rossum805365e2007-05-07 22:24:25 +0000822 right = [d.pop() for i in range(250)]
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000823 right.reverse()
Guido van Rossum805365e2007-05-07 22:24:25 +0000824 self.assertEqual(right, list(range(150, 400)))
825 self.assertEqual(list(d), list(range(50, 150)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000826
827 d.clear()
828 self.assertEqual(len(d), 0)
829
830 def test_copy_pickle(self):
831
832 d = Deque('abc')
833
834 e = d.__copy__()
835 self.assertEqual(type(d), type(e))
836 self.assertEqual(list(d), list(e))
837
838 e = Deque(d)
839 self.assertEqual(type(d), type(e))
840 self.assertEqual(list(d), list(e))
841
Serhiy Storchakabad12572014-12-15 14:03:42 +0200842 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
843 s = pickle.dumps(d, proto)
844 e = pickle.loads(s)
845 self.assertNotEqual(id(d), id(e))
846 self.assertEqual(type(d), type(e))
847 self.assertEqual(list(d), list(e))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000848
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000849 d = Deque('abcde', maxlen=4)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000850
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000851 e = d.__copy__()
852 self.assertEqual(type(d), type(e))
853 self.assertEqual(list(d), list(e))
854
855 e = Deque(d)
856 self.assertEqual(type(d), type(e))
857 self.assertEqual(list(d), list(e))
858
Serhiy Storchakabad12572014-12-15 14:03:42 +0200859 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
860 s = pickle.dumps(d, proto)
861 e = pickle.loads(s)
862 self.assertNotEqual(id(d), id(e))
863 self.assertEqual(type(d), type(e))
864 self.assertEqual(list(d), list(e))
Raymond Hettinger952f8802004-11-09 07:27:35 +0000865
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200866 def test_pickle_recursive(self):
867 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
868 for d in Deque('abc'), Deque('abc', 3):
869 d.append(d)
870
871 e = pickle.loads(pickle.dumps(d, proto))
872 self.assertNotEqual(id(e), id(d))
873 self.assertEqual(type(e), type(d))
874 self.assertEqual(e.maxlen, d.maxlen)
875 dd = d.pop()
876 ee = e.pop()
877 self.assertEqual(id(ee), id(e))
878 self.assertEqual(e, d)
879
880 d.x = d
881 e = pickle.loads(pickle.dumps(d, proto))
882 self.assertEqual(id(e.x), id(e))
883
884 for d in DequeWithBadIter('abc'), DequeWithBadIter('abc', 2):
885 self.assertRaises(TypeError, pickle.dumps, d, proto)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000886
Raymond Hettinger691d8052004-05-30 07:26:47 +0000887 def test_weakref(self):
888 d = deque('gallahad')
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000889 p = weakref.proxy(d)
Raymond Hettinger691d8052004-05-30 07:26:47 +0000890 self.assertEqual(str(p), str(d))
891 d = None
892 self.assertRaises(ReferenceError, str, p)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000893
Armin Rigo974d7572004-10-02 13:59:34 +0000894 def test_strange_subclass(self):
895 class X(deque):
896 def __iter__(self):
897 return iter([])
898 d1 = X([1,2,3])
899 d2 = X([4,5,6])
900 d1 == d2 # not clear if this is supposed to be True or False,
901 # but it used to give a SystemError
902
Oren Milman24bd50b2018-09-11 21:46:55 +0300903 @support.cpython_only
904 def test_bug_31608(self):
905 # The interpreter used to crash in specific cases where a deque
906 # subclass returned a non-deque.
907 class X(deque):
908 pass
909 d = X()
910 def bad___new__(cls, *args, **kwargs):
911 return [42]
912 X.__new__ = bad___new__
913 with self.assertRaises(TypeError):
914 d * 42 # shouldn't crash
915 with self.assertRaises(TypeError):
916 d + deque([1, 2, 3]) # shouldn't crash
917
Thomas Woutersb2137042007-02-01 18:02:27 +0000918
919class SubclassWithKwargs(deque):
920 def __init__(self, newarg=1):
921 deque.__init__(self)
922
923class TestSubclassWithKwargs(unittest.TestCase):
924 def test_subclass_with_kwargs(self):
925 # SF bug #1486663 -- this used to erroneously raise a TypeError
926 SubclassWithKwargs(newarg=1)
927
Raymond Hettinger067bbba2015-04-01 08:11:09 -0700928class TestSequence(seq_tests.CommonTest):
929 type2test = deque
930
931 def test_getitem(self):
932 # For now, bypass tests that require slicing
933 pass
934
935 def test_getslice(self):
936 # For now, bypass tests that require slicing
937 pass
938
939 def test_subscript(self):
940 # For now, bypass tests that require slicing
941 pass
942
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +0300943 def test_free_after_iterating(self):
944 # For now, bypass tests that require slicing
945 self.skipTest("Exhausted deque iterator doesn't free a deque")
946
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000947#==============================================================================
948
Raymond Hettinger738ec902004-02-29 02:15:56 +0000949libreftest = """
950Example from the Library Reference: Doc/lib/libcollections.tex
951
952>>> from collections import deque
953>>> d = deque('ghi') # make a new deque with three items
954>>> for elem in d: # iterate over the deque's elements
Guido van Rossum7131f842007-02-09 20:13:25 +0000955... print(elem.upper())
Raymond Hettinger738ec902004-02-29 02:15:56 +0000956G
957H
958I
959>>> d.append('j') # add a new entry to the right side
960>>> d.appendleft('f') # add a new entry to the left side
961>>> d # show the representation of the deque
962deque(['f', 'g', 'h', 'i', 'j'])
963>>> d.pop() # return and remove the rightmost item
964'j'
965>>> d.popleft() # return and remove the leftmost item
966'f'
967>>> list(d) # list the contents of the deque
968['g', 'h', 'i']
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000969>>> d[0] # peek at leftmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000970'g'
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000971>>> d[-1] # peek at rightmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000972'i'
973>>> list(reversed(d)) # list the contents of a deque in reverse
974['i', 'h', 'g']
975>>> 'h' in d # search the deque
976True
977>>> d.extend('jkl') # add multiple elements at once
978>>> d
979deque(['g', 'h', 'i', 'j', 'k', 'l'])
980>>> d.rotate(1) # right rotation
981>>> d
982deque(['l', 'g', 'h', 'i', 'j', 'k'])
983>>> d.rotate(-1) # left rotation
984>>> d
985deque(['g', 'h', 'i', 'j', 'k', 'l'])
986>>> deque(reversed(d)) # make a new deque in reverse order
987deque(['l', 'k', 'j', 'i', 'h', 'g'])
988>>> d.clear() # empty the deque
989>>> d.pop() # cannot pop from an empty deque
990Traceback (most recent call last):
991 File "<pyshell#6>", line 1, in -toplevel-
992 d.pop()
993IndexError: pop from an empty deque
994
995>>> d.extendleft('abc') # extendleft() reverses the input order
996>>> d
997deque(['c', 'b', 'a'])
998
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000999
1000
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001001>>> def delete_nth(d, n):
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001002... d.rotate(-n)
1003... d.popleft()
1004... d.rotate(n)
1005...
1006>>> d = deque('abcdef')
1007>>> delete_nth(d, 2) # remove the entry at d[2]
1008>>> d
1009deque(['a', 'b', 'd', 'e', 'f'])
1010
1011
1012
1013>>> def roundrobin(*iterables):
1014... pending = deque(iter(i) for i in iterables)
1015... while pending:
1016... task = pending.popleft()
1017... try:
Georg Brandla18af4e2007-04-21 15:47:16 +00001018... yield next(task)
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001019... except StopIteration:
1020... continue
1021... pending.append(task)
1022...
1023
1024>>> for value in roundrobin('abc', 'd', 'efgh'):
Guido van Rossum7131f842007-02-09 20:13:25 +00001025... print(value)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001026...
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001027a
1028d
1029e
1030b
1031f
1032c
1033g
1034h
1035
1036
1037>>> def maketree(iterable):
1038... d = deque(iterable)
1039... while len(d) > 1:
1040... pair = [d.popleft(), d.popleft()]
1041... d.append(pair)
1042... return list(d)
1043...
Guido van Rossum7131f842007-02-09 20:13:25 +00001044>>> print(maketree('abcdefgh'))
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001045[[[['a', 'b'], ['c', 'd']], [['e', 'f'], ['g', 'h']]]]
1046
Raymond Hettinger738ec902004-02-29 02:15:56 +00001047"""
1048
1049
1050#==============================================================================
1051
1052__test__ = {'libreftest' : libreftest}
1053
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001054def test_main(verbose=None):
1055 import sys
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001056 test_classes = (
1057 TestBasic,
1058 TestVariousIteratorArgs,
1059 TestSubclass,
Thomas Woutersb2137042007-02-01 18:02:27 +00001060 TestSubclassWithKwargs,
Raymond Hettinger067bbba2015-04-01 08:11:09 -07001061 TestSequence,
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001062 )
1063
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001064 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001065
1066 # verify reference counting
1067 if verbose and hasattr(sys, "gettotalrefcount"):
1068 import gc
1069 counts = [None] * 5
Guido van Rossum805365e2007-05-07 22:24:25 +00001070 for i in range(len(counts)):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001071 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001072 gc.collect()
1073 counts[i] = sys.gettotalrefcount()
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001074 print(counts)
Raymond Hettinger0a4977c2004-03-01 23:16:22 +00001075
Raymond Hettinger738ec902004-02-29 02:15:56 +00001076 # doctests
1077 from test import test_deque
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001078 support.run_doctest(test_deque, verbose)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001079
1080if __name__ == "__main__":
1081 test_main(verbose=True)