blob: a8487d2d9559266aff17c45fd5b7a52c2624ee92 [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
Guido van Rossum34d19282007-08-09 01:03:29 +00008from io import StringIO
Raymond Hettinger0a4977c2004-03-01 23:16:22 +00009import random
Jesus Cea16e2fca2012-08-03 14:49:42 +020010import struct
Raymond Hettinger756b3f32004-01-29 06:37:52 +000011
12BIG = 100000
13
Raymond Hettingera435c532004-07-09 04:10:20 +000014def fail():
15 raise SyntaxError
16 yield 1
17
Raymond Hettinger4aec61e2005-03-18 21:20:23 +000018class BadCmp:
19 def __eq__(self, other):
20 raise RuntimeError
21
22class MutateCmp:
Raymond Hettingerd73202c2005-03-19 00:00:51 +000023 def __init__(self, deque, result):
Raymond Hettinger4aec61e2005-03-18 21:20:23 +000024 self.deque = deque
Raymond Hettingerd73202c2005-03-19 00:00:51 +000025 self.result = result
Raymond Hettinger4aec61e2005-03-18 21:20:23 +000026 def __eq__(self, other):
27 self.deque.clear()
Raymond Hettingerd73202c2005-03-19 00:00:51 +000028 return self.result
Raymond Hettinger4aec61e2005-03-18 21:20:23 +000029
Raymond Hettinger756b3f32004-01-29 06:37:52 +000030class TestBasic(unittest.TestCase):
31
32 def test_basics(self):
Christian Heimes38053212007-12-14 01:24:44 +000033 d = deque(range(-5125, -5000))
34 d.__init__(range(200))
Guido van Rossum805365e2007-05-07 22:24:25 +000035 for i in range(200, 400):
Raymond Hettinger756b3f32004-01-29 06:37:52 +000036 d.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +000037 for i in reversed(range(-200, 0)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +000038 d.appendleft(i)
Guido van Rossum805365e2007-05-07 22:24:25 +000039 self.assertEqual(list(d), list(range(-200, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +000040 self.assertEqual(len(d), 600)
41
Guido van Rossum805365e2007-05-07 22:24:25 +000042 left = [d.popleft() for i in range(250)]
43 self.assertEqual(left, list(range(-200, 50)))
44 self.assertEqual(list(d), list(range(50, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +000045
Guido van Rossum805365e2007-05-07 22:24:25 +000046 right = [d.pop() for i in range(250)]
Raymond Hettinger756b3f32004-01-29 06:37:52 +000047 right.reverse()
Guido van Rossum805365e2007-05-07 22:24:25 +000048 self.assertEqual(right, list(range(150, 400)))
49 self.assertEqual(list(d), list(range(50, 150)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +000050
Guido van Rossum8ce8a782007-11-01 19:42:39 +000051 def test_maxlen(self):
52 self.assertRaises(ValueError, deque, 'abc', -1)
53 self.assertRaises(ValueError, deque, 'abc', -2)
Raymond Hettinger060c7f62009-03-10 09:36:07 +000054 it = iter(range(10))
55 d = deque(it, maxlen=3)
56 self.assertEqual(list(it), [])
Guido van Rossum8ce8a782007-11-01 19:42:39 +000057 self.assertEqual(repr(d), 'deque([7, 8, 9], maxlen=3)')
58 self.assertEqual(list(d), [7, 8, 9])
59 self.assertEqual(d, deque(range(10), 3))
60 d.append(10)
61 self.assertEqual(list(d), [8, 9, 10])
62 d.appendleft(7)
63 self.assertEqual(list(d), [7, 8, 9])
64 d.extend([10, 11])
65 self.assertEqual(list(d), [9, 10, 11])
66 d.extendleft([8, 7])
67 self.assertEqual(list(d), [7, 8, 9])
68 d = deque(range(200), maxlen=10)
69 d.append(d)
Benjamin Petersonee8712c2008-05-20 21:35:26 +000070 support.unlink(support.TESTFN)
71 fo = open(support.TESTFN, "w")
Christian Heimescc47b052008-03-25 14:56:36 +000072 try:
73 fo.write(str(d))
74 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +000075 fo = open(support.TESTFN, "r")
Christian Heimescc47b052008-03-25 14:56:36 +000076 self.assertEqual(fo.read(), repr(d))
77 finally:
78 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +000079 support.unlink(support.TESTFN)
Christian Heimescc47b052008-03-25 14:56:36 +000080
Guido van Rossum8ce8a782007-11-01 19:42:39 +000081 d = deque(range(10), maxlen=None)
82 self.assertEqual(repr(d), 'deque([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])')
Benjamin Petersonee8712c2008-05-20 21:35:26 +000083 fo = open(support.TESTFN, "w")
Christian Heimescc47b052008-03-25 14:56:36 +000084 try:
85 fo.write(str(d))
86 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +000087 fo = open(support.TESTFN, "r")
Christian Heimescc47b052008-03-25 14:56:36 +000088 self.assertEqual(fo.read(), repr(d))
89 finally:
90 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +000091 support.unlink(support.TESTFN)
Guido van Rossum8ce8a782007-11-01 19:42:39 +000092
Raymond Hettinger060c7f62009-03-10 09:36:07 +000093 def test_maxlen_zero(self):
94 it = iter(range(100))
95 deque(it, maxlen=0)
96 self.assertEqual(list(it), [])
97
98 it = iter(range(100))
99 d = deque(maxlen=0)
100 d.extend(it)
101 self.assertEqual(list(it), [])
102
103 it = iter(range(100))
104 d = deque(maxlen=0)
105 d.extendleft(it)
106 self.assertEqual(list(it), [])
107
Raymond Hettinger5bb0f0e2009-03-10 12:56:32 +0000108 def test_maxlen_attribute(self):
109 self.assertEqual(deque().maxlen, None)
110 self.assertEqual(deque('abc').maxlen, None)
111 self.assertEqual(deque('abc', maxlen=4).maxlen, 4)
112 self.assertEqual(deque('abc', maxlen=2).maxlen, 2)
113 self.assertEqual(deque('abc', maxlen=0).maxlen, 0)
114 with self.assertRaises(AttributeError):
115 d = deque('abc')
116 d.maxlen = 10
117
Raymond Hettinger44459de2010-04-03 23:20:46 +0000118 def test_count(self):
119 for s in ('', 'abracadabra', 'simsalabim'*500+'abc'):
120 s = list(s)
121 d = deque(s)
122 for letter in 'abcdefghijklmnopqrstuvwxyz':
123 self.assertEqual(s.count(letter), d.count(letter), (s, d, letter))
124 self.assertRaises(TypeError, d.count) # too few args
125 self.assertRaises(TypeError, d.count, 1, 2) # too many args
126 class BadCompare:
127 def __eq__(self, other):
128 raise ArithmeticError
129 d = deque([1, 2, BadCompare(), 3])
130 self.assertRaises(ArithmeticError, d.count, 2)
131 d = deque([1, 2, 3])
132 self.assertRaises(ArithmeticError, d.count, BadCompare())
133 class MutatingCompare:
134 def __eq__(self, other):
135 self.d.pop()
136 return True
137 m = MutatingCompare()
138 d = deque([1, 2, 3, m, 4, 5])
139 m.d = d
140 self.assertRaises(RuntimeError, d.count, 3)
141
Raymond Hettinger512d2cc2011-01-25 21:32:39 +0000142 # test issue11004
143 # block advance failed after rotation aligned elements on right side of block
144 d = deque([None]*16)
145 for i in range(len(d)):
146 d.rotate(-1)
147 d.rotate(1)
148 self.assertEqual(d.count(1), 0)
149 self.assertEqual(d.count(None), 16)
150
Raymond Hettinger738ec902004-02-29 02:15:56 +0000151 def test_comparisons(self):
152 d = deque('xabc'); d.popleft()
153 for e in [d, deque('abc'), deque('ab'), deque(), list(d)]:
154 self.assertEqual(d==e, type(d)==type(e) and list(d)==list(e))
155 self.assertEqual(d!=e, not(type(d)==type(e) and list(d)==list(e)))
156
157 args = map(deque, ('', 'a', 'b', 'ab', 'ba', 'abc', 'xba', 'xabc', 'cba'))
158 for x in args:
159 for y in args:
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(x >= y, list(x) >= list(y), (x,y))
Raymond Hettinger738ec902004-02-29 02:15:56 +0000166
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 Hettinger3f9afd82009-12-10 03:03:02 +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 Hettinger3f9afd82009-12-10 03:03:02 +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
Guido van Rossum805365e2007-05-07 22:24:25 +0000196 d = deque(range(n))
197 l = list(range(n))
198 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000199 d.popleft()
200 l.pop(0)
201 if random.random() < 0.5:
202 d.append(i)
203 l.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000204 for j in range(1-len(l), len(l)):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000205 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
Guido van Rossum805365e2007-05-07 22:24:25 +0000216 d = deque(range(n))
217 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000218 d[i] = 10 * i
Guido van Rossum805365e2007-05-07 22:24:25 +0000219 self.assertEqual(list(d), [10*i for i in range(n)])
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000220 l = list(d)
Guido van Rossum805365e2007-05-07 22:24:25 +0000221 for i in range(1-n, 0, -1):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000222 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
Guido van Rossum805365e2007-05-07 22:24:25 +0000228 d = deque(range(n))
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000229 self.assertRaises(IndexError, d.__delitem__, -n-1)
230 self.assertRaises(IndexError, d.__delitem__, n)
Guido van Rossum805365e2007-05-07 22:24:25 +0000231 for i in range(n):
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000232 self.assertEqual(len(d), n-i)
233 j = random.randrange(-len(d), len(d))
234 val = d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000235 self.assertIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000236 del d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000237 self.assertNotIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000238 self.assertEqual(len(d), 0)
239
Raymond Hettingere5fdedb2009-12-10 00:47:21 +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 Melottib3aedd42010-11-20 19:04:17 +0000247 self.assertIs(r, None)
Raymond Hettingere5fdedb2009-12-10 00:47:21 +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
Guido van Rossum805365e2007-05-07 22:24:25 +0000266 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000267 d = deque(s)
268 e = deque(d)
269 d.rotate(i) # check vs. rot(1) n times
Guido van Rossum805365e2007-05-07 22:24:25 +0000270 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000271 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
Guido van Rossum805365e2007-05-07 22:24:25 +0000278 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000279 d = deque(s)
280 e = deque(d)
281 d.rotate(-i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000282 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000283 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
Guido van Rossum805365e2007-05-07 22:24:25 +0000294 for i in range(BIG+17):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000295 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):
Guido van Rossum805365e2007-05-07 22:24:25 +0000327 d = deque(range(100))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000328 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 Petersonc9c0f202009-06-30 23:06:06 +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):
Guido van Rossum805365e2007-05-07 22:24:25 +0000360 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000361 e = eval(repr(d))
362 self.assertEqual(list(d), list(e))
363 d.append(d)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000364 self.assertIn('...', repr(d))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000365
366 def test_print(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000367 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000368 d.append(d)
Raymond Hettingera435c532004-07-09 04:10:20 +0000369 try:
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000370 support.unlink(support.TESTFN)
371 fo = open(support.TESTFN, "w")
Christian Heimescc47b052008-03-25 14:56:36 +0000372 print(d, file=fo, end='')
Raymond Hettingera435c532004-07-09 04:10:20 +0000373 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000374 fo = open(support.TESTFN, "r")
Raymond Hettingera435c532004-07-09 04:10:20 +0000375 self.assertEqual(fo.read(), repr(d))
376 finally:
377 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000378 support.unlink(support.TESTFN)
Raymond Hettingera435c532004-07-09 04:10:20 +0000379
380 def test_init(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +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):
Guido van Rossum805365e2007-05-07 22:24:25 +0000389 d = deque(range(size))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000390 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000391 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000392 append(i)
393 x = pop()
394 if x != i - size:
395 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000396 self.assertEqual(list(d), list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000397
398 def test_long_steadystate_queue_popright(self):
399 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000400 d = deque(reversed(range(size)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000401 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000402 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000403 append(i)
404 x = pop()
405 if x != i - size:
406 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000407 self.assertEqual(list(reversed(list(d))),
408 list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000409
410 def test_big_queue_popleft(self):
411 pass
412 d = deque()
413 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000414 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000415 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000416 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000417 x = pop()
418 if x != i:
419 self.assertEqual(x, i)
420
421 def test_big_queue_popright(self):
422 d = deque()
423 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000424 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000425 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000426 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000427 x = pop()
428 if x != i:
429 self.assertEqual(x, i)
430
431 def test_big_stack_right(self):
432 d = deque()
433 append, pop = d.append, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000434 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000435 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000436 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000437 x = pop()
438 if x != i:
439 self.assertEqual(x, i)
440 self.assertEqual(len(d), 0)
441
442 def test_big_stack_left(self):
443 d = deque()
444 append, pop = d.appendleft, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000445 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000446 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000447 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000448 x = pop()
449 if x != i:
450 self.assertEqual(x, i)
451 self.assertEqual(len(d), 0)
452
453 def test_roundtrip_iter_init(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000454 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000455 e = deque(d)
456 self.assertNotEqual(id(d), id(e))
457 self.assertEqual(list(d), list(e))
458
459 def test_pickle(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000460 d = deque(range(200))
Hirokazu Yamamoto801f9d32008-12-27 04:21:44 +0000461 for i in range(pickle.HIGHEST_PROTOCOL + 1):
Raymond Hettinger952f8802004-11-09 07:27:35 +0000462 s = pickle.dumps(d, i)
463 e = pickle.loads(s)
464 self.assertNotEqual(id(d), id(e))
465 self.assertEqual(list(d), list(e))
466
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000467## def test_pickle_recursive(self):
468## d = deque('abc')
469## d.append(d)
Hirokazu Yamamoto801f9d32008-12-27 04:21:44 +0000470## for i in range(pickle.HIGHEST_PROTOCOL + 1):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000471## e = pickle.loads(pickle.dumps(d, i))
472## self.assertNotEqual(id(d), id(e))
473## self.assertEqual(id(e), id(e[-1]))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000474
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000475 def test_iterator_pickle(self):
476 data = deque(range(200))
477 it = itorg = iter(data)
478 d = pickle.dumps(it)
479 it = pickle.loads(d)
480 self.assertEqual(type(itorg), type(it))
481 self.assertEqual(list(it), list(data))
482
483 it = pickle.loads(d)
484 next(it)
485 d = pickle.dumps(it)
486 self.assertEqual(list(it), list(data)[1:])
487
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000488 def test_deepcopy(self):
489 mut = [10]
490 d = deque([mut])
491 e = copy.deepcopy(d)
492 self.assertEqual(list(d), list(e))
493 mut[0] = 11
494 self.assertNotEqual(id(d), id(e))
495 self.assertNotEqual(list(d), list(e))
496
497 def test_copy(self):
498 mut = [10]
499 d = deque([mut])
500 e = copy.copy(d)
501 self.assertEqual(list(d), list(e))
502 mut[0] = 11
503 self.assertNotEqual(id(d), id(e))
504 self.assertEqual(list(d), list(e))
505
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000506 def test_reversed(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000507 for s in ('abcd', range(2000)):
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000508 self.assertEqual(list(reversed(deque(s))), list(reversed(s)))
509
Tim Peters10c7e862004-10-01 02:01:04 +0000510 def test_gc_doesnt_blowup(self):
511 import gc
512 # This used to assert-fail in deque_traverse() under a debug
513 # build, or run wild with a NULL pointer in a release build.
514 d = deque()
Guido van Rossum805365e2007-05-07 22:24:25 +0000515 for i in range(100):
Tim Peters10c7e862004-10-01 02:01:04 +0000516 d.append(1)
517 gc.collect()
518
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000519 def test_container_iterator(self):
520 # Bug #3680: tp_traverse was not implemented for deque iterator objects
521 class C(object):
522 pass
523 for i in range(2):
524 obj = C()
525 ref = weakref.ref(obj)
526 if i == 0:
527 container = deque([obj, 1])
528 else:
529 container = reversed(deque([obj, 1]))
530 obj.x = iter(container)
531 del obj, container
532 gc.collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000533 self.assertTrue(ref() is None, "Cycle was not collected")
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000534
Jesus Cea16e2fca2012-08-03 14:49:42 +0200535 check_sizeof = support.check_sizeof
536
537 @support.cpython_only
538 def test_sizeof(self):
539 BLOCKLEN = 62
Jesus Cea1659b752012-08-03 14:52:12 +0200540 basesize = support.calcobjsize('2P4nlP')
Jesus Cea16e2fca2012-08-03 14:49:42 +0200541 blocksize = struct.calcsize('2P%dP' % BLOCKLEN)
542 self.assertEqual(object.__sizeof__(deque()), basesize)
543 check = self.check_sizeof
544 check(deque(), basesize + blocksize)
545 check(deque('a'), basesize + blocksize)
546 check(deque('a' * (BLOCKLEN // 2)), basesize + blocksize)
547 check(deque('a' * (BLOCKLEN // 2 + 1)), basesize + 2 * blocksize)
548 check(deque('a' * (42 * BLOCKLEN)), basesize + 43 * blocksize)
549
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000550class TestVariousIteratorArgs(unittest.TestCase):
551
552 def test_constructor(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000553 for s in ("123", "", range(1000), ('do', 1.2), range(2000,2200,5)):
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000554 for g in (seq_tests.Sequence, seq_tests.IterFunc,
555 seq_tests.IterGen, seq_tests.IterFuncStop,
556 seq_tests.itermulti, seq_tests.iterfunc):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000557 self.assertEqual(list(deque(g(s))), list(g(s)))
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000558 self.assertRaises(TypeError, deque, seq_tests.IterNextOnly(s))
559 self.assertRaises(TypeError, deque, seq_tests.IterNoNext(s))
560 self.assertRaises(ZeroDivisionError, deque, seq_tests.IterGenExc(s))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000561
562 def test_iter_with_altered_data(self):
563 d = deque('abcdefg')
564 it = iter(d)
565 d.pop()
Georg Brandla18af4e2007-04-21 15:47:16 +0000566 self.assertRaises(RuntimeError, next, it)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000567
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000568 def test_runtime_error_on_empty_deque(self):
569 d = deque()
570 it = iter(d)
571 d.append(10)
Georg Brandla18af4e2007-04-21 15:47:16 +0000572 self.assertRaises(RuntimeError, next, it)
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000573
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000574class Deque(deque):
575 pass
576
Raymond Hettinger952f8802004-11-09 07:27:35 +0000577class DequeWithBadIter(deque):
578 def __iter__(self):
579 raise TypeError
580
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000581class TestSubclass(unittest.TestCase):
582
583 def test_basics(self):
Christian Heimes38053212007-12-14 01:24:44 +0000584 d = Deque(range(25))
585 d.__init__(range(200))
Guido van Rossum805365e2007-05-07 22:24:25 +0000586 for i in range(200, 400):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000587 d.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000588 for i in reversed(range(-200, 0)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000589 d.appendleft(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000590 self.assertEqual(list(d), list(range(-200, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000591 self.assertEqual(len(d), 600)
592
Guido van Rossum805365e2007-05-07 22:24:25 +0000593 left = [d.popleft() for i in range(250)]
594 self.assertEqual(left, list(range(-200, 50)))
595 self.assertEqual(list(d), list(range(50, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000596
Guido van Rossum805365e2007-05-07 22:24:25 +0000597 right = [d.pop() for i in range(250)]
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000598 right.reverse()
Guido van Rossum805365e2007-05-07 22:24:25 +0000599 self.assertEqual(right, list(range(150, 400)))
600 self.assertEqual(list(d), list(range(50, 150)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000601
602 d.clear()
603 self.assertEqual(len(d), 0)
604
605 def test_copy_pickle(self):
606
607 d = Deque('abc')
608
609 e = d.__copy__()
610 self.assertEqual(type(d), type(e))
611 self.assertEqual(list(d), list(e))
612
613 e = Deque(d)
614 self.assertEqual(type(d), type(e))
615 self.assertEqual(list(d), list(e))
616
617 s = pickle.dumps(d)
618 e = pickle.loads(s)
619 self.assertNotEqual(id(d), id(e))
620 self.assertEqual(type(d), type(e))
621 self.assertEqual(list(d), list(e))
622
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000623 d = Deque('abcde', maxlen=4)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000624
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000625 e = d.__copy__()
626 self.assertEqual(type(d), type(e))
627 self.assertEqual(list(d), list(e))
628
629 e = Deque(d)
630 self.assertEqual(type(d), type(e))
631 self.assertEqual(list(d), list(e))
632
633 s = pickle.dumps(d)
634 e = pickle.loads(s)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000635 self.assertNotEqual(id(d), id(e))
636 self.assertEqual(type(d), type(e))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000637 self.assertEqual(list(d), list(e))
Raymond Hettinger952f8802004-11-09 07:27:35 +0000638
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000639## def test_pickle(self):
640## d = Deque('abc')
641## d.append(d)
642##
643## e = pickle.loads(pickle.dumps(d))
644## self.assertNotEqual(id(d), id(e))
645## self.assertEqual(type(d), type(e))
646## dd = d.pop()
647## ee = e.pop()
648## self.assertEqual(id(e), id(ee))
649## self.assertEqual(d, e)
650##
651## d.x = d
652## e = pickle.loads(pickle.dumps(d))
653## self.assertEqual(id(e), id(e.x))
654##
655## d = DequeWithBadIter('abc')
656## self.assertRaises(TypeError, pickle.dumps, d)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000657
Raymond Hettinger691d8052004-05-30 07:26:47 +0000658 def test_weakref(self):
659 d = deque('gallahad')
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000660 p = weakref.proxy(d)
Raymond Hettinger691d8052004-05-30 07:26:47 +0000661 self.assertEqual(str(p), str(d))
662 d = None
663 self.assertRaises(ReferenceError, str, p)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000664
Armin Rigo974d7572004-10-02 13:59:34 +0000665 def test_strange_subclass(self):
666 class X(deque):
667 def __iter__(self):
668 return iter([])
669 d1 = X([1,2,3])
670 d2 = X([4,5,6])
671 d1 == d2 # not clear if this is supposed to be True or False,
672 # but it used to give a SystemError
673
Thomas Woutersb2137042007-02-01 18:02:27 +0000674
675class SubclassWithKwargs(deque):
676 def __init__(self, newarg=1):
677 deque.__init__(self)
678
679class TestSubclassWithKwargs(unittest.TestCase):
680 def test_subclass_with_kwargs(self):
681 # SF bug #1486663 -- this used to erroneously raise a TypeError
682 SubclassWithKwargs(newarg=1)
683
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000684#==============================================================================
685
Raymond Hettinger738ec902004-02-29 02:15:56 +0000686libreftest = """
687Example from the Library Reference: Doc/lib/libcollections.tex
688
689>>> from collections import deque
690>>> d = deque('ghi') # make a new deque with three items
691>>> for elem in d: # iterate over the deque's elements
Guido van Rossum7131f842007-02-09 20:13:25 +0000692... print(elem.upper())
Raymond Hettinger738ec902004-02-29 02:15:56 +0000693G
694H
695I
696>>> d.append('j') # add a new entry to the right side
697>>> d.appendleft('f') # add a new entry to the left side
698>>> d # show the representation of the deque
699deque(['f', 'g', 'h', 'i', 'j'])
700>>> d.pop() # return and remove the rightmost item
701'j'
702>>> d.popleft() # return and remove the leftmost item
703'f'
704>>> list(d) # list the contents of the deque
705['g', 'h', 'i']
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000706>>> d[0] # peek at leftmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000707'g'
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000708>>> d[-1] # peek at rightmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000709'i'
710>>> list(reversed(d)) # list the contents of a deque in reverse
711['i', 'h', 'g']
712>>> 'h' in d # search the deque
713True
714>>> d.extend('jkl') # add multiple elements at once
715>>> d
716deque(['g', 'h', 'i', 'j', 'k', 'l'])
717>>> d.rotate(1) # right rotation
718>>> d
719deque(['l', 'g', 'h', 'i', 'j', 'k'])
720>>> d.rotate(-1) # left rotation
721>>> d
722deque(['g', 'h', 'i', 'j', 'k', 'l'])
723>>> deque(reversed(d)) # make a new deque in reverse order
724deque(['l', 'k', 'j', 'i', 'h', 'g'])
725>>> d.clear() # empty the deque
726>>> d.pop() # cannot pop from an empty deque
727Traceback (most recent call last):
728 File "<pyshell#6>", line 1, in -toplevel-
729 d.pop()
730IndexError: pop from an empty deque
731
732>>> d.extendleft('abc') # extendleft() reverses the input order
733>>> d
734deque(['c', 'b', 'a'])
735
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000736
737
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000738>>> def delete_nth(d, n):
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000739... d.rotate(-n)
740... d.popleft()
741... d.rotate(n)
742...
743>>> d = deque('abcdef')
744>>> delete_nth(d, 2) # remove the entry at d[2]
745>>> d
746deque(['a', 'b', 'd', 'e', 'f'])
747
748
749
750>>> def roundrobin(*iterables):
751... pending = deque(iter(i) for i in iterables)
752... while pending:
753... task = pending.popleft()
754... try:
Georg Brandla18af4e2007-04-21 15:47:16 +0000755... yield next(task)
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000756... except StopIteration:
757... continue
758... pending.append(task)
759...
760
761>>> for value in roundrobin('abc', 'd', 'efgh'):
Guido van Rossum7131f842007-02-09 20:13:25 +0000762... print(value)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000763...
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000764a
765d
766e
767b
768f
769c
770g
771h
772
773
774>>> def maketree(iterable):
775... d = deque(iterable)
776... while len(d) > 1:
777... pair = [d.popleft(), d.popleft()]
778... d.append(pair)
779... return list(d)
780...
Guido van Rossum7131f842007-02-09 20:13:25 +0000781>>> print(maketree('abcdefgh'))
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000782[[[['a', 'b'], ['c', 'd']], [['e', 'f'], ['g', 'h']]]]
783
Raymond Hettinger738ec902004-02-29 02:15:56 +0000784"""
785
786
787#==============================================================================
788
789__test__ = {'libreftest' : libreftest}
790
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000791def test_main(verbose=None):
792 import sys
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000793 test_classes = (
794 TestBasic,
795 TestVariousIteratorArgs,
796 TestSubclass,
Thomas Woutersb2137042007-02-01 18:02:27 +0000797 TestSubclassWithKwargs,
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000798 )
799
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000800 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000801
802 # verify reference counting
803 if verbose and hasattr(sys, "gettotalrefcount"):
804 import gc
805 counts = [None] * 5
Guido van Rossum805365e2007-05-07 22:24:25 +0000806 for i in range(len(counts)):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000807 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000808 gc.collect()
809 counts[i] = sys.gettotalrefcount()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000810 print(counts)
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000811
Raymond Hettinger738ec902004-02-29 02:15:56 +0000812 # doctests
813 from test import test_deque
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000814 support.run_doctest(test_deque, verbose)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000815
816if __name__ == "__main__":
817 test_main(verbose=True)