blob: 595a0c4a35cace415f66468eb046664d63c2ec63 [file] [log] [blame]
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001from collections import deque
2import unittest
Walter Dörwald09a3f2c2005-03-22 22:43:28 +00003from test import test_support, seq_tests
Antoine Pitrouaa687902009-01-01 14:11:22 +00004import gc
5import weakref
Raymond Hettinger756b3f32004-01-29 06:37:52 +00006import copy
7import cPickle as pickle
Raymond Hettinger0a4977c2004-03-01 23:16:22 +00008import random
Jesus Cead4e58dc2012-08-03 14:48:23 +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):
Raymond Hettingeradf9ffd2007-12-13 00:08:37 +000032 d = deque(xrange(-5125, -5000))
33 d.__init__(xrange(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +000034 for i in xrange(200, 400):
35 d.append(i)
36 for i in reversed(xrange(-200, 0)):
37 d.appendleft(i)
38 self.assertEqual(list(d), range(-200, 400))
39 self.assertEqual(len(d), 600)
40
41 left = [d.popleft() for i in xrange(250)]
42 self.assertEqual(left, range(-200, 50))
43 self.assertEqual(list(d), range(50, 400))
44
45 right = [d.pop() for i in xrange(250)]
46 right.reverse()
47 self.assertEqual(right, range(150, 400))
48 self.assertEqual(list(d), range(50, 150))
49
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000050 def test_maxlen(self):
Raymond Hettinger68995862007-10-10 00:26:46 +000051 self.assertRaises(ValueError, deque, 'abc', -1)
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000052 self.assertRaises(ValueError, deque, 'abc', -2)
Raymond Hettingerbac769b2009-03-10 09:31:48 +000053 it = iter(range(10))
54 d = deque(it, maxlen=3)
55 self.assertEqual(list(it), [])
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000056 self.assertEqual(repr(d), 'deque([7, 8, 9], maxlen=3)')
57 self.assertEqual(list(d), range(7, 10))
58 self.assertEqual(d, deque(range(10), 3))
59 d.append(10)
60 self.assertEqual(list(d), range(8, 11))
61 d.appendleft(7)
62 self.assertEqual(list(d), range(7, 10))
63 d.extend([10, 11])
64 self.assertEqual(list(d), range(9, 12))
65 d.extendleft([8, 7])
66 self.assertEqual(list(d), range(7, 10))
67 d = deque(xrange(200), maxlen=10)
68 d.append(d)
Neal Norwitz36a59b42008-04-10 05:46:39 +000069 test_support.unlink(test_support.TESTFN)
Neal Norwitz40f5e4c2008-03-25 04:17:38 +000070 fo = open(test_support.TESTFN, "wb")
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000071 try:
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000072 print >> fo, d,
73 fo.close()
74 fo = open(test_support.TESTFN, "rb")
75 self.assertEqual(fo.read(), repr(d))
76 finally:
77 fo.close()
Neal Norwitz40f5e4c2008-03-25 04:17:38 +000078 test_support.unlink(test_support.TESTFN)
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000079
Raymond Hettinger68995862007-10-10 00:26:46 +000080 d = deque(range(10), maxlen=None)
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000081 self.assertEqual(repr(d), 'deque([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])')
Neal Norwitz40f5e4c2008-03-25 04:17:38 +000082 fo = open(test_support.TESTFN, "wb")
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000083 try:
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000084 print >> fo, d,
85 fo.close()
86 fo = open(test_support.TESTFN, "rb")
87 self.assertEqual(fo.read(), repr(d))
88 finally:
89 fo.close()
Neal Norwitz40f5e4c2008-03-25 04:17:38 +000090 test_support.unlink(test_support.TESTFN)
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000091
Raymond Hettingerbac769b2009-03-10 09:31:48 +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 Hettinger56411aa2009-03-10 12:50:59 +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 Hettinger5f516ed2010-04-03 18:10:37 +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))
Raymond Hettingerab8b9ca2010-04-03 22:34:15 +0000123 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)
Raymond Hettinger5f516ed2010-04-03 18:10:37 +0000140
Raymond Hettinger57a86892011-01-25 21:43:29 +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))
165 self.assertEqual(cmp(x,y), cmp(list(x),list(y)), (x,y))
166
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000167 def test_extend(self):
168 d = deque('a')
169 self.assertRaises(TypeError, d.extend, 1)
170 d.extend('bcd')
171 self.assertEqual(list(d), list('abcd'))
Raymond Hettinger0b3263b2009-12-10 06:00:33 +0000172 d.extend(d)
173 self.assertEqual(list(d), list('abcdabcd'))
174
175 def test_iadd(self):
176 d = deque('a')
177 d += 'bcd'
178 self.assertEqual(list(d), list('abcd'))
179 d += d
180 self.assertEqual(list(d), list('abcdabcd'))
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000181
182 def test_extendleft(self):
183 d = deque('a')
184 self.assertRaises(TypeError, d.extendleft, 1)
185 d.extendleft('bcd')
186 self.assertEqual(list(d), list(reversed('abcd')))
Raymond Hettinger0b3263b2009-12-10 06:00:33 +0000187 d.extendleft(d)
188 self.assertEqual(list(d), list('abcddcba'))
Raymond Hettingera435c532004-07-09 04:10:20 +0000189 d = deque()
190 d.extendleft(range(1000))
191 self.assertEqual(list(d), list(reversed(range(1000))))
192 self.assertRaises(SyntaxError, d.extendleft, fail())
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000193
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000194 def test_getitem(self):
195 n = 200
196 d = deque(xrange(n))
197 l = range(n)
198 for i in xrange(n):
199 d.popleft()
200 l.pop(0)
201 if random.random() < 0.5:
202 d.append(i)
203 l.append(i)
204 for j in xrange(1-len(l), len(l)):
205 assert d[j] == l[j]
206
Raymond Hettinger738ec902004-02-29 02:15:56 +0000207 d = deque('superman')
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000208 self.assertEqual(d[0], 's')
209 self.assertEqual(d[-1], 'n')
Raymond Hettinger738ec902004-02-29 02:15:56 +0000210 d = deque()
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000211 self.assertRaises(IndexError, d.__getitem__, 0)
212 self.assertRaises(IndexError, d.__getitem__, -1)
213
214 def test_setitem(self):
215 n = 200
216 d = deque(xrange(n))
217 for i in xrange(n):
218 d[i] = 10 * i
219 self.assertEqual(list(d), [10*i for i in xrange(n)])
220 l = list(d)
221 for i in xrange(1-n, 0, -1):
222 d[i] = 7*i
223 l[i] = 7*i
224 self.assertEqual(list(d), l)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000225
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000226 def test_delitem(self):
227 n = 500 # O(n**2) test, don't make this too big
228 d = deque(xrange(n))
229 self.assertRaises(IndexError, d.__delitem__, -n-1)
230 self.assertRaises(IndexError, d.__delitem__, n)
231 for i in xrange(n):
232 self.assertEqual(len(d), n-i)
233 j = random.randrange(-len(d), len(d))
234 val = d[j]
Ezio Melottiaa980582010-01-23 23:04:36 +0000235 self.assertIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000236 del d[j]
Ezio Melottiaa980582010-01-23 23:04:36 +0000237 self.assertNotIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000238 self.assertEqual(len(d), 0)
239
Raymond Hettingera5fd24e2009-12-10 06:42:54 +0000240 def test_reverse(self):
241 n = 500 # O(n**2) test, don't make this too big
242 data = [random.random() for i in range(n)]
243 for i in range(n):
244 d = deque(data[:i])
245 r = d.reverse()
246 self.assertEqual(list(d), list(reversed(data[:i])))
Ezio Melotti2623a372010-11-21 13:34:58 +0000247 self.assertIs(r, None)
Raymond Hettingera5fd24e2009-12-10 06:42:54 +0000248 d.reverse()
249 self.assertEqual(list(d), data[:i])
250 self.assertRaises(TypeError, d.reverse, 1) # Arity is zero
251
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000252 def test_rotate(self):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000253 s = tuple('abcde')
254 n = len(s)
255
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000256 d = deque(s)
Raymond Hettingeree33b272004-02-08 04:05:26 +0000257 d.rotate(1) # verify rot(1)
258 self.assertEqual(''.join(d), 'eabcd')
259
260 d = deque(s)
261 d.rotate(-1) # verify rot(-1)
262 self.assertEqual(''.join(d), 'bcdea')
263 d.rotate() # check default to 1
264 self.assertEqual(tuple(d), s)
265
266 for i in xrange(n*3):
267 d = deque(s)
268 e = deque(d)
269 d.rotate(i) # check vs. rot(1) n times
270 for j in xrange(i):
271 e.rotate(1)
272 self.assertEqual(tuple(d), tuple(e))
273 d.rotate(-i) # check that it works in reverse
274 self.assertEqual(tuple(d), s)
275 e.rotate(n-i) # check that it wraps forward
276 self.assertEqual(tuple(e), s)
277
278 for i in xrange(n*3):
279 d = deque(s)
280 e = deque(d)
281 d.rotate(-i)
282 for j in xrange(i):
283 e.rotate(-1) # check vs. rot(-1) n times
284 self.assertEqual(tuple(d), tuple(e))
285 d.rotate(i) # check that it works in reverse
286 self.assertEqual(tuple(d), s)
287 e.rotate(i-n) # check that it wraps backaround
288 self.assertEqual(tuple(e), s)
289
290 d = deque(s)
291 e = deque(s)
292 e.rotate(BIG+17) # verify on long series of rotates
293 dr = d.rotate
294 for i in xrange(BIG+17):
295 dr()
296 self.assertEqual(tuple(d), tuple(e))
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000297
Raymond Hettingera435c532004-07-09 04:10:20 +0000298 self.assertRaises(TypeError, d.rotate, 'x') # Wrong arg type
299 self.assertRaises(TypeError, d.rotate, 1, 10) # Too many args
300
301 d = deque()
302 d.rotate() # rotate an empty deque
303 self.assertEqual(d, deque())
304
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000305 def test_len(self):
306 d = deque('ab')
307 self.assertEqual(len(d), 2)
308 d.popleft()
309 self.assertEqual(len(d), 1)
310 d.pop()
311 self.assertEqual(len(d), 0)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000312 self.assertRaises(IndexError, d.pop)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000313 self.assertEqual(len(d), 0)
314 d.append('c')
315 self.assertEqual(len(d), 1)
316 d.appendleft('d')
317 self.assertEqual(len(d), 2)
318 d.clear()
319 self.assertEqual(len(d), 0)
320
321 def test_underflow(self):
322 d = deque()
Raymond Hettinger738ec902004-02-29 02:15:56 +0000323 self.assertRaises(IndexError, d.pop)
324 self.assertRaises(IndexError, d.popleft)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000325
326 def test_clear(self):
327 d = deque(xrange(100))
328 self.assertEqual(len(d), 100)
329 d.clear()
330 self.assertEqual(len(d), 0)
331 self.assertEqual(list(d), [])
Raymond Hettingera435c532004-07-09 04:10:20 +0000332 d.clear() # clear an emtpy deque
333 self.assertEqual(list(d), [])
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000334
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000335 def test_remove(self):
336 d = deque('abcdefghcij')
337 d.remove('c')
338 self.assertEqual(d, deque('abdefghcij'))
339 d.remove('c')
340 self.assertEqual(d, deque('abdefghij'))
341 self.assertRaises(ValueError, d.remove, 'c')
342 self.assertEqual(d, deque('abdefghij'))
343
Walter Dörwaldc448a912005-03-22 11:22:38 +0000344 # Handle comparison errors
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000345 d = deque(['a', 'b', BadCmp(), 'c'])
346 e = deque(d)
347 self.assertRaises(RuntimeError, d.remove, 'c')
348 for x, y in zip(d, e):
349 # verify that original order and values are retained.
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000350 self.assertTrue(x is y)
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000351
352 # Handle evil mutator
Raymond Hettingerd73202c2005-03-19 00:00:51 +0000353 for match in (True, False):
354 d = deque(['ab'])
355 d.extend([MutateCmp(d, match), 'c'])
356 self.assertRaises(IndexError, d.remove, 'c')
357 self.assertEqual(d, deque())
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000358
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000359 def test_repr(self):
360 d = deque(xrange(200))
361 e = eval(repr(d))
362 self.assertEqual(list(d), list(e))
363 d.append(d)
Ezio Melottiaa980582010-01-23 23:04:36 +0000364 self.assertIn('...', repr(d))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000365
366 def test_print(self):
367 d = deque(xrange(200))
368 d.append(d)
Neal Norwitz36a59b42008-04-10 05:46:39 +0000369 test_support.unlink(test_support.TESTFN)
Neal Norwitz40f5e4c2008-03-25 04:17:38 +0000370 fo = open(test_support.TESTFN, "wb")
Raymond Hettingera435c532004-07-09 04:10:20 +0000371 try:
Raymond Hettingera435c532004-07-09 04:10:20 +0000372 print >> fo, d,
373 fo.close()
374 fo = open(test_support.TESTFN, "rb")
375 self.assertEqual(fo.read(), repr(d))
376 finally:
377 fo.close()
Neal Norwitz40f5e4c2008-03-25 04:17:38 +0000378 test_support.unlink(test_support.TESTFN)
Raymond Hettingera435c532004-07-09 04:10:20 +0000379
380 def test_init(self):
Raymond Hettingera7fc4b12007-10-05 02:47:07 +0000381 self.assertRaises(TypeError, deque, 'abc', 2, 3);
Raymond Hettingera435c532004-07-09 04:10:20 +0000382 self.assertRaises(TypeError, deque, 1);
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000383
384 def test_hash(self):
385 self.assertRaises(TypeError, hash, deque('abc'))
386
387 def test_long_steadystate_queue_popleft(self):
388 for size in (0, 1, 2, 100, 1000):
389 d = deque(xrange(size))
390 append, pop = d.append, d.popleft
391 for i in xrange(size, BIG):
392 append(i)
393 x = pop()
394 if x != i - size:
395 self.assertEqual(x, i-size)
396 self.assertEqual(list(d), range(BIG-size, BIG))
397
398 def test_long_steadystate_queue_popright(self):
399 for size in (0, 1, 2, 100, 1000):
400 d = deque(reversed(xrange(size)))
401 append, pop = d.appendleft, d.pop
402 for i in xrange(size, BIG):
403 append(i)
404 x = pop()
405 if x != i - size:
406 self.assertEqual(x, i-size)
407 self.assertEqual(list(reversed(list(d))), range(BIG-size, BIG))
408
409 def test_big_queue_popleft(self):
410 pass
411 d = deque()
412 append, pop = d.append, d.popleft
413 for i in xrange(BIG):
414 append(i)
415 for i in xrange(BIG):
416 x = pop()
417 if x != i:
418 self.assertEqual(x, i)
419
420 def test_big_queue_popright(self):
421 d = deque()
422 append, pop = d.appendleft, d.pop
423 for i in xrange(BIG):
424 append(i)
425 for i in xrange(BIG):
426 x = pop()
427 if x != i:
428 self.assertEqual(x, i)
429
430 def test_big_stack_right(self):
431 d = deque()
432 append, pop = d.append, d.pop
433 for i in xrange(BIG):
434 append(i)
435 for i in reversed(xrange(BIG)):
436 x = pop()
437 if x != i:
438 self.assertEqual(x, i)
439 self.assertEqual(len(d), 0)
440
441 def test_big_stack_left(self):
442 d = deque()
443 append, pop = d.appendleft, d.popleft
444 for i in xrange(BIG):
445 append(i)
446 for i in reversed(xrange(BIG)):
447 x = pop()
448 if x != i:
449 self.assertEqual(x, i)
450 self.assertEqual(len(d), 0)
451
452 def test_roundtrip_iter_init(self):
453 d = deque(xrange(200))
454 e = deque(d)
455 self.assertNotEqual(id(d), id(e))
456 self.assertEqual(list(d), list(e))
457
458 def test_pickle(self):
459 d = deque(xrange(200))
Hirokazu Yamamoto0fc07472008-12-27 04:19:48 +0000460 for i in range(pickle.HIGHEST_PROTOCOL + 1):
Raymond Hettinger952f8802004-11-09 07:27:35 +0000461 s = pickle.dumps(d, i)
462 e = pickle.loads(s)
463 self.assertNotEqual(id(d), id(e))
464 self.assertEqual(list(d), list(e))
465
Raymond Hettingera7fc4b12007-10-05 02:47:07 +0000466## def test_pickle_recursive(self):
467## d = deque('abc')
468## d.append(d)
Hirokazu Yamamoto0fc07472008-12-27 04:19:48 +0000469## for i in range(pickle.HIGHEST_PROTOCOL + 1):
Raymond Hettingera7fc4b12007-10-05 02:47:07 +0000470## e = pickle.loads(pickle.dumps(d, i))
471## self.assertNotEqual(id(d), id(e))
472## self.assertEqual(id(e), id(e[-1]))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000473
474 def test_deepcopy(self):
475 mut = [10]
476 d = deque([mut])
477 e = copy.deepcopy(d)
478 self.assertEqual(list(d), list(e))
479 mut[0] = 11
480 self.assertNotEqual(id(d), id(e))
481 self.assertNotEqual(list(d), list(e))
482
483 def test_copy(self):
484 mut = [10]
485 d = deque([mut])
486 e = copy.copy(d)
487 self.assertEqual(list(d), list(e))
488 mut[0] = 11
489 self.assertNotEqual(id(d), id(e))
490 self.assertEqual(list(d), list(e))
491
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000492 def test_reversed(self):
493 for s in ('abcd', xrange(2000)):
494 self.assertEqual(list(reversed(deque(s))), list(reversed(s)))
495
Tim Peters10c7e862004-10-01 02:01:04 +0000496 def test_gc_doesnt_blowup(self):
497 import gc
498 # This used to assert-fail in deque_traverse() under a debug
499 # build, or run wild with a NULL pointer in a release build.
500 d = deque()
501 for i in xrange(100):
502 d.append(1)
503 gc.collect()
504
Antoine Pitrouaa687902009-01-01 14:11:22 +0000505 def test_container_iterator(self):
Antoine Pitrou733dc742009-01-01 15:38:03 +0000506 # Bug #3680: tp_traverse was not implemented for deque iterator objects
Antoine Pitrouaa687902009-01-01 14:11:22 +0000507 class C(object):
508 pass
509 for i in range(2):
510 obj = C()
511 ref = weakref.ref(obj)
512 if i == 0:
513 container = deque([obj, 1])
514 else:
515 container = reversed(deque([obj, 1]))
516 obj.x = iter(container)
517 del obj, container
518 gc.collect()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000519 self.assertTrue(ref() is None, "Cycle was not collected")
Antoine Pitrouaa687902009-01-01 14:11:22 +0000520
Jesus Cead4e58dc2012-08-03 14:48:23 +0200521 check_sizeof = test_support.check_sizeof
522
523 @test_support.cpython_only
524 def test_sizeof(self):
525 BLOCKLEN = 62
526 basesize = test_support.calcobjsize('2P4PlP')
527 blocksize = struct.calcsize('2P%dP' % BLOCKLEN)
528 self.assertEqual(object.__sizeof__(deque()), basesize)
529 check = self.check_sizeof
530 check(deque(), basesize + blocksize)
531 check(deque('a'), basesize + blocksize)
532 check(deque('a' * (BLOCKLEN // 2)), basesize + blocksize)
533 check(deque('a' * (BLOCKLEN // 2 + 1)), basesize + 2 * blocksize)
534 check(deque('a' * (42 * BLOCKLEN)), basesize + 43 * blocksize)
535
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000536class TestVariousIteratorArgs(unittest.TestCase):
537
538 def test_constructor(self):
539 for s in ("123", "", range(1000), ('do', 1.2), xrange(2000,2200,5)):
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000540 for g in (seq_tests.Sequence, seq_tests.IterFunc,
541 seq_tests.IterGen, seq_tests.IterFuncStop,
542 seq_tests.itermulti, seq_tests.iterfunc):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000543 self.assertEqual(list(deque(g(s))), list(g(s)))
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000544 self.assertRaises(TypeError, deque, seq_tests.IterNextOnly(s))
545 self.assertRaises(TypeError, deque, seq_tests.IterNoNext(s))
546 self.assertRaises(ZeroDivisionError, deque, seq_tests.IterGenExc(s))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000547
548 def test_iter_with_altered_data(self):
549 d = deque('abcdefg')
550 it = iter(d)
551 d.pop()
552 self.assertRaises(RuntimeError, it.next)
553
Raymond Hettinger51c2f6c2007-01-08 18:09:20 +0000554 def test_runtime_error_on_empty_deque(self):
555 d = deque()
556 it = iter(d)
557 d.append(10)
558 self.assertRaises(RuntimeError, it.next)
559
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000560class Deque(deque):
561 pass
562
Raymond Hettinger952f8802004-11-09 07:27:35 +0000563class DequeWithBadIter(deque):
564 def __iter__(self):
565 raise TypeError
566
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000567class TestSubclass(unittest.TestCase):
568
569 def test_basics(self):
Raymond Hettingeradf9ffd2007-12-13 00:08:37 +0000570 d = Deque(xrange(25))
571 d.__init__(xrange(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000572 for i in xrange(200, 400):
573 d.append(i)
574 for i in reversed(xrange(-200, 0)):
575 d.appendleft(i)
576 self.assertEqual(list(d), range(-200, 400))
577 self.assertEqual(len(d), 600)
578
579 left = [d.popleft() for i in xrange(250)]
580 self.assertEqual(left, range(-200, 50))
581 self.assertEqual(list(d), range(50, 400))
582
583 right = [d.pop() for i in xrange(250)]
584 right.reverse()
585 self.assertEqual(right, range(150, 400))
586 self.assertEqual(list(d), range(50, 150))
587
588 d.clear()
589 self.assertEqual(len(d), 0)
590
591 def test_copy_pickle(self):
592
593 d = Deque('abc')
594
595 e = d.__copy__()
596 self.assertEqual(type(d), type(e))
597 self.assertEqual(list(d), list(e))
598
599 e = Deque(d)
600 self.assertEqual(type(d), type(e))
601 self.assertEqual(list(d), list(e))
602
603 s = pickle.dumps(d)
604 e = pickle.loads(s)
605 self.assertNotEqual(id(d), id(e))
606 self.assertEqual(type(d), type(e))
607 self.assertEqual(list(d), list(e))
608
Raymond Hettinger68995862007-10-10 00:26:46 +0000609 d = Deque('abcde', maxlen=4)
610
611 e = d.__copy__()
612 self.assertEqual(type(d), type(e))
613 self.assertEqual(list(d), list(e))
614
615 e = Deque(d)
616 self.assertEqual(type(d), type(e))
617 self.assertEqual(list(d), list(e))
618
619 s = pickle.dumps(d)
620 e = pickle.loads(s)
621 self.assertNotEqual(id(d), id(e))
622 self.assertEqual(type(d), type(e))
623 self.assertEqual(list(d), list(e))
624
Raymond Hettingera7fc4b12007-10-05 02:47:07 +0000625## def test_pickle(self):
626## d = Deque('abc')
627## d.append(d)
628##
629## e = pickle.loads(pickle.dumps(d))
630## self.assertNotEqual(id(d), id(e))
631## self.assertEqual(type(d), type(e))
632## dd = d.pop()
633## ee = e.pop()
634## self.assertEqual(id(e), id(ee))
635## self.assertEqual(d, e)
636##
637## d.x = d
638## e = pickle.loads(pickle.dumps(d))
639## self.assertEqual(id(e), id(e.x))
640##
641## d = DequeWithBadIter('abc')
642## self.assertRaises(TypeError, pickle.dumps, d)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000643
Raymond Hettinger691d8052004-05-30 07:26:47 +0000644 def test_weakref(self):
645 d = deque('gallahad')
Antoine Pitrouaa687902009-01-01 14:11:22 +0000646 p = weakref.proxy(d)
Raymond Hettinger691d8052004-05-30 07:26:47 +0000647 self.assertEqual(str(p), str(d))
648 d = None
649 self.assertRaises(ReferenceError, str, p)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000650
Armin Rigo974d7572004-10-02 13:59:34 +0000651 def test_strange_subclass(self):
652 class X(deque):
653 def __iter__(self):
654 return iter([])
655 d1 = X([1,2,3])
656 d2 = X([4,5,6])
657 d1 == d2 # not clear if this is supposed to be True or False,
658 # but it used to give a SystemError
659
Georg Brandlb84c1372007-01-21 10:28:43 +0000660
661class SubclassWithKwargs(deque):
662 def __init__(self, newarg=1):
663 deque.__init__(self)
664
665class TestSubclassWithKwargs(unittest.TestCase):
666 def test_subclass_with_kwargs(self):
667 # SF bug #1486663 -- this used to erroneously raise a TypeError
668 SubclassWithKwargs(newarg=1)
669
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000670#==============================================================================
671
Raymond Hettinger738ec902004-02-29 02:15:56 +0000672libreftest = """
673Example from the Library Reference: Doc/lib/libcollections.tex
674
675>>> from collections import deque
676>>> d = deque('ghi') # make a new deque with three items
677>>> for elem in d: # iterate over the deque's elements
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000678... print elem.upper()
Raymond Hettinger738ec902004-02-29 02:15:56 +0000679G
680H
681I
682>>> d.append('j') # add a new entry to the right side
683>>> d.appendleft('f') # add a new entry to the left side
684>>> d # show the representation of the deque
685deque(['f', 'g', 'h', 'i', 'j'])
686>>> d.pop() # return and remove the rightmost item
687'j'
688>>> d.popleft() # return and remove the leftmost item
689'f'
690>>> list(d) # list the contents of the deque
691['g', 'h', 'i']
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000692>>> d[0] # peek at leftmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000693'g'
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000694>>> d[-1] # peek at rightmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000695'i'
696>>> list(reversed(d)) # list the contents of a deque in reverse
697['i', 'h', 'g']
698>>> 'h' in d # search the deque
699True
700>>> d.extend('jkl') # add multiple elements at once
701>>> d
702deque(['g', 'h', 'i', 'j', 'k', 'l'])
703>>> d.rotate(1) # right rotation
704>>> d
705deque(['l', 'g', 'h', 'i', 'j', 'k'])
706>>> d.rotate(-1) # left rotation
707>>> d
708deque(['g', 'h', 'i', 'j', 'k', 'l'])
709>>> deque(reversed(d)) # make a new deque in reverse order
710deque(['l', 'k', 'j', 'i', 'h', 'g'])
711>>> d.clear() # empty the deque
712>>> d.pop() # cannot pop from an empty deque
713Traceback (most recent call last):
714 File "<pyshell#6>", line 1, in -toplevel-
715 d.pop()
716IndexError: pop from an empty deque
717
718>>> d.extendleft('abc') # extendleft() reverses the input order
719>>> d
720deque(['c', 'b', 'a'])
721
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000722
723
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000724>>> def delete_nth(d, n):
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000725... d.rotate(-n)
726... d.popleft()
727... d.rotate(n)
728...
729>>> d = deque('abcdef')
730>>> delete_nth(d, 2) # remove the entry at d[2]
731>>> d
732deque(['a', 'b', 'd', 'e', 'f'])
733
734
735
736>>> def roundrobin(*iterables):
737... pending = deque(iter(i) for i in iterables)
738... while pending:
739... task = pending.popleft()
740... try:
741... yield task.next()
742... except StopIteration:
743... continue
744... pending.append(task)
745...
746
747>>> for value in roundrobin('abc', 'd', 'efgh'):
748... print value
749...
750a
751d
752e
753b
754f
755c
756g
757h
758
759
760>>> def maketree(iterable):
761... d = deque(iterable)
762... while len(d) > 1:
763... pair = [d.popleft(), d.popleft()]
764... d.append(pair)
765... return list(d)
766...
767>>> print maketree('abcdefgh')
768[[[['a', 'b'], ['c', 'd']], [['e', 'f'], ['g', 'h']]]]
769
Raymond Hettinger738ec902004-02-29 02:15:56 +0000770"""
771
772
773#==============================================================================
774
775__test__ = {'libreftest' : libreftest}
776
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000777def test_main(verbose=None):
778 import sys
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000779 test_classes = (
780 TestBasic,
781 TestVariousIteratorArgs,
782 TestSubclass,
Georg Brandlb84c1372007-01-21 10:28:43 +0000783 TestSubclassWithKwargs,
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000784 )
785
786 test_support.run_unittest(*test_classes)
787
788 # verify reference counting
789 if verbose and hasattr(sys, "gettotalrefcount"):
790 import gc
791 counts = [None] * 5
792 for i in xrange(len(counts)):
793 test_support.run_unittest(*test_classes)
794 gc.collect()
795 counts[i] = sys.gettotalrefcount()
796 print counts
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000797
Raymond Hettinger738ec902004-02-29 02:15:56 +0000798 # doctests
799 from test import test_deque
Raymond Hettinger354433a2004-05-19 08:20:33 +0000800 test_support.run_doctest(test_deque, verbose)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000801
802if __name__ == "__main__":
803 test_main(verbose=True)