blob: e895c3c9f0df90c7fd9ca50585c08c6b8d77f101 [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 Hettinger906d82d2016-01-25 23:00:21 -0800291 def test_index_bug_24913(self):
Raymond Hettinger87674ec2015-08-26 08:08:38 -0700292 d = deque('A' * 3)
293 with self.assertRaises(ValueError):
294 i = d.index("Hello world", 0, 4)
295
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700296 def test_insert(self):
297 # Test to make sure insert behaves like lists
298 elements = 'ABCDEFGHI'
299 for i in range(-5 - len(elements)*2, 5 + len(elements) * 2):
300 d = deque('ABCDEFGHI')
301 s = list('ABCDEFGHI')
302 d.insert(i, 'Z')
303 s.insert(i, 'Z')
304 self.assertEqual(list(d), s)
305
Raymond Hettingera6389712016-02-01 21:21:19 -0800306 def test_insert_bug_26194(self):
Raymond Hettinger37434322016-01-26 21:44:16 -0800307 data = 'ABC'
Raymond Hettingera6389712016-02-01 21:21:19 -0800308 d = deque(data, maxlen=len(data))
309 with self.assertRaises(IndexError):
310 d.insert(2, None)
311
312 elements = 'ABCDEFGHI'
313 for i in range(-len(elements), len(elements)):
314 d = deque(elements, maxlen=len(elements)+1)
315 d.insert(i, 'Z')
316 if i >= 0:
317 self.assertEqual(d[i], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800318 else:
Raymond Hettingera6389712016-02-01 21:21:19 -0800319 self.assertEqual(d[i-1], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800320
Raymond Hettinger41290a62015-03-31 08:12:23 -0700321 def test_imul(self):
322 for n in (-10, -1, 0, 1, 2, 10, 1000):
323 d = deque()
324 d *= n
325 self.assertEqual(d, deque())
326 self.assertIsNone(d.maxlen)
327
328 for n in (-10, -1, 0, 1, 2, 10, 1000):
329 d = deque('a')
330 d *= n
331 self.assertEqual(d, deque('a' * n))
332 self.assertIsNone(d.maxlen)
333
334 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
335 d = deque('a', 500)
336 d *= n
337 self.assertEqual(d, deque('a' * min(n, 500)))
338 self.assertEqual(d.maxlen, 500)
339
340 for n in (-10, -1, 0, 1, 2, 10, 1000):
341 d = deque('abcdef')
342 d *= n
343 self.assertEqual(d, deque('abcdef' * n))
344 self.assertIsNone(d.maxlen)
345
346 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
347 d = deque('abcdef', 500)
348 d *= n
349 self.assertEqual(d, deque(('abcdef' * n)[-500:]))
350 self.assertEqual(d.maxlen, 500)
351
352 def test_mul(self):
353 d = deque('abc')
354 self.assertEqual(d * -5, deque())
355 self.assertEqual(d * 0, deque())
356 self.assertEqual(d * 1, deque('abc'))
357 self.assertEqual(d * 2, deque('abcabc'))
358 self.assertEqual(d * 3, deque('abcabcabc'))
359 self.assertIsNot(d * 1, d)
360
361 self.assertEqual(deque() * 0, deque())
362 self.assertEqual(deque() * 1, deque())
363 self.assertEqual(deque() * 5, deque())
364
365 self.assertEqual(-5 * d, deque())
366 self.assertEqual(0 * d, deque())
367 self.assertEqual(1 * d, deque('abc'))
368 self.assertEqual(2 * d, deque('abcabc'))
369 self.assertEqual(3 * d, deque('abcabcabc'))
370
371 d = deque('abc', maxlen=5)
372 self.assertEqual(d * -5, deque())
373 self.assertEqual(d * 0, deque())
374 self.assertEqual(d * 1, deque('abc'))
375 self.assertEqual(d * 2, deque('bcabc'))
376 self.assertEqual(d * 30, deque('bcabc'))
377
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000378 def test_setitem(self):
379 n = 200
Guido van Rossum805365e2007-05-07 22:24:25 +0000380 d = deque(range(n))
381 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000382 d[i] = 10 * i
Guido van Rossum805365e2007-05-07 22:24:25 +0000383 self.assertEqual(list(d), [10*i for i in range(n)])
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000384 l = list(d)
Guido van Rossum805365e2007-05-07 22:24:25 +0000385 for i in range(1-n, 0, -1):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000386 d[i] = 7*i
387 l[i] = 7*i
388 self.assertEqual(list(d), l)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000389
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000390 def test_delitem(self):
391 n = 500 # O(n**2) test, don't make this too big
Guido van Rossum805365e2007-05-07 22:24:25 +0000392 d = deque(range(n))
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000393 self.assertRaises(IndexError, d.__delitem__, -n-1)
394 self.assertRaises(IndexError, d.__delitem__, n)
Guido van Rossum805365e2007-05-07 22:24:25 +0000395 for i in range(n):
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000396 self.assertEqual(len(d), n-i)
397 j = random.randrange(-len(d), len(d))
398 val = d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000399 self.assertIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000400 del d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000401 self.assertNotIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000402 self.assertEqual(len(d), 0)
403
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000404 def test_reverse(self):
405 n = 500 # O(n**2) test, don't make this too big
406 data = [random.random() for i in range(n)]
407 for i in range(n):
408 d = deque(data[:i])
409 r = d.reverse()
410 self.assertEqual(list(d), list(reversed(data[:i])))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000411 self.assertIs(r, None)
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000412 d.reverse()
413 self.assertEqual(list(d), data[:i])
414 self.assertRaises(TypeError, d.reverse, 1) # Arity is zero
415
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000416 def test_rotate(self):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000417 s = tuple('abcde')
418 n = len(s)
419
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000420 d = deque(s)
Raymond Hettingeree33b272004-02-08 04:05:26 +0000421 d.rotate(1) # verify rot(1)
422 self.assertEqual(''.join(d), 'eabcd')
423
424 d = deque(s)
425 d.rotate(-1) # verify rot(-1)
426 self.assertEqual(''.join(d), 'bcdea')
427 d.rotate() # check default to 1
428 self.assertEqual(tuple(d), s)
429
Guido van Rossum805365e2007-05-07 22:24:25 +0000430 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000431 d = deque(s)
432 e = deque(d)
433 d.rotate(i) # check vs. rot(1) n times
Guido van Rossum805365e2007-05-07 22:24:25 +0000434 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000435 e.rotate(1)
436 self.assertEqual(tuple(d), tuple(e))
437 d.rotate(-i) # check that it works in reverse
438 self.assertEqual(tuple(d), s)
439 e.rotate(n-i) # check that it wraps forward
440 self.assertEqual(tuple(e), s)
441
Guido van Rossum805365e2007-05-07 22:24:25 +0000442 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000443 d = deque(s)
444 e = deque(d)
445 d.rotate(-i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000446 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000447 e.rotate(-1) # check vs. rot(-1) n times
448 self.assertEqual(tuple(d), tuple(e))
449 d.rotate(i) # check that it works in reverse
450 self.assertEqual(tuple(d), s)
451 e.rotate(i-n) # check that it wraps backaround
452 self.assertEqual(tuple(e), s)
453
454 d = deque(s)
455 e = deque(s)
456 e.rotate(BIG+17) # verify on long series of rotates
457 dr = d.rotate
Guido van Rossum805365e2007-05-07 22:24:25 +0000458 for i in range(BIG+17):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000459 dr()
460 self.assertEqual(tuple(d), tuple(e))
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000461
Raymond Hettingera435c532004-07-09 04:10:20 +0000462 self.assertRaises(TypeError, d.rotate, 'x') # Wrong arg type
463 self.assertRaises(TypeError, d.rotate, 1, 10) # Too many args
464
465 d = deque()
466 d.rotate() # rotate an empty deque
467 self.assertEqual(d, deque())
468
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000469 def test_len(self):
470 d = deque('ab')
471 self.assertEqual(len(d), 2)
472 d.popleft()
473 self.assertEqual(len(d), 1)
474 d.pop()
475 self.assertEqual(len(d), 0)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000476 self.assertRaises(IndexError, d.pop)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000477 self.assertEqual(len(d), 0)
478 d.append('c')
479 self.assertEqual(len(d), 1)
480 d.appendleft('d')
481 self.assertEqual(len(d), 2)
482 d.clear()
483 self.assertEqual(len(d), 0)
484
485 def test_underflow(self):
486 d = deque()
Raymond Hettinger738ec902004-02-29 02:15:56 +0000487 self.assertRaises(IndexError, d.pop)
488 self.assertRaises(IndexError, d.popleft)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000489
490 def test_clear(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000491 d = deque(range(100))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000492 self.assertEqual(len(d), 100)
493 d.clear()
494 self.assertEqual(len(d), 0)
495 self.assertEqual(list(d), [])
Martin Pantereb995702016-07-28 01:11:04 +0000496 d.clear() # clear an empty deque
Raymond Hettingera435c532004-07-09 04:10:20 +0000497 self.assertEqual(list(d), [])
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000498
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000499 def test_remove(self):
500 d = deque('abcdefghcij')
501 d.remove('c')
502 self.assertEqual(d, deque('abdefghcij'))
503 d.remove('c')
504 self.assertEqual(d, deque('abdefghij'))
505 self.assertRaises(ValueError, d.remove, 'c')
506 self.assertEqual(d, deque('abdefghij'))
507
Walter Dörwaldc448a912005-03-22 11:22:38 +0000508 # Handle comparison errors
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000509 d = deque(['a', 'b', BadCmp(), 'c'])
510 e = deque(d)
511 self.assertRaises(RuntimeError, d.remove, 'c')
512 for x, y in zip(d, e):
513 # verify that original order and values are retained.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000514 self.assertTrue(x is y)
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000515
516 # Handle evil mutator
Raymond Hettingerd73202c2005-03-19 00:00:51 +0000517 for match in (True, False):
518 d = deque(['ab'])
519 d.extend([MutateCmp(d, match), 'c'])
520 self.assertRaises(IndexError, d.remove, 'c')
521 self.assertEqual(d, deque())
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000522
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000523 def test_repr(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000524 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000525 e = eval(repr(d))
526 self.assertEqual(list(d), list(e))
527 d.append(d)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000528 self.assertIn('...', repr(d))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000529
530 def test_print(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000531 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000532 d.append(d)
Raymond Hettingera435c532004-07-09 04:10:20 +0000533 try:
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000534 support.unlink(support.TESTFN)
535 fo = open(support.TESTFN, "w")
Christian Heimescc47b052008-03-25 14:56:36 +0000536 print(d, file=fo, end='')
Raymond Hettingera435c532004-07-09 04:10:20 +0000537 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000538 fo = open(support.TESTFN, "r")
Raymond Hettingera435c532004-07-09 04:10:20 +0000539 self.assertEqual(fo.read(), repr(d))
540 finally:
541 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000542 support.unlink(support.TESTFN)
Raymond Hettingera435c532004-07-09 04:10:20 +0000543
544 def test_init(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000545 self.assertRaises(TypeError, deque, 'abc', 2, 3);
Raymond Hettingera435c532004-07-09 04:10:20 +0000546 self.assertRaises(TypeError, deque, 1);
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000547
548 def test_hash(self):
549 self.assertRaises(TypeError, hash, deque('abc'))
550
551 def test_long_steadystate_queue_popleft(self):
552 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000553 d = deque(range(size))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000554 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000555 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000556 append(i)
557 x = pop()
558 if x != i - size:
559 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000560 self.assertEqual(list(d), list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000561
562 def test_long_steadystate_queue_popright(self):
563 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000564 d = deque(reversed(range(size)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000565 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000566 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000567 append(i)
568 x = pop()
569 if x != i - size:
570 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000571 self.assertEqual(list(reversed(list(d))),
572 list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000573
574 def test_big_queue_popleft(self):
575 pass
576 d = deque()
577 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000578 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000579 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000580 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000581 x = pop()
582 if x != i:
583 self.assertEqual(x, i)
584
585 def test_big_queue_popright(self):
586 d = deque()
587 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000588 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000589 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000590 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000591 x = pop()
592 if x != i:
593 self.assertEqual(x, i)
594
595 def test_big_stack_right(self):
596 d = deque()
597 append, pop = d.append, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000598 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000599 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000600 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000601 x = pop()
602 if x != i:
603 self.assertEqual(x, i)
604 self.assertEqual(len(d), 0)
605
606 def test_big_stack_left(self):
607 d = deque()
608 append, pop = d.appendleft, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000609 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000610 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000611 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000612 x = pop()
613 if x != i:
614 self.assertEqual(x, i)
615 self.assertEqual(len(d), 0)
616
617 def test_roundtrip_iter_init(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000618 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000619 e = deque(d)
620 self.assertNotEqual(id(d), id(e))
621 self.assertEqual(list(d), list(e))
622
623 def test_pickle(self):
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200624 for d in deque(range(200)), deque(range(200), 100):
625 for i in range(pickle.HIGHEST_PROTOCOL + 1):
626 s = pickle.dumps(d, i)
627 e = pickle.loads(s)
628 self.assertNotEqual(id(e), id(d))
629 self.assertEqual(list(e), list(d))
630 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000631
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200632 def test_pickle_recursive(self):
633 for d in deque('abc'), deque('abc', 3):
634 d.append(d)
635 for i in range(pickle.HIGHEST_PROTOCOL + 1):
636 e = pickle.loads(pickle.dumps(d, i))
637 self.assertNotEqual(id(e), id(d))
638 self.assertEqual(id(e[-1]), id(e))
639 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000640
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000641 def test_iterator_pickle(self):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200642 orig = deque(range(200))
643 data = [i*1.01 for i in orig]
Serhiy Storchakabad12572014-12-15 14:03:42 +0200644 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200645 # initial iterator
646 itorg = iter(orig)
647 dump = pickle.dumps((itorg, orig), proto)
648 it, d = pickle.loads(dump)
649 for i, x in enumerate(data):
650 d[i] = x
651 self.assertEqual(type(it), type(itorg))
652 self.assertEqual(list(it), data)
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000653
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200654 # running iterator
655 next(itorg)
656 dump = pickle.dumps((itorg, orig), proto)
657 it, d = pickle.loads(dump)
658 for i, x in enumerate(data):
659 d[i] = x
660 self.assertEqual(type(it), type(itorg))
661 self.assertEqual(list(it), data[1:])
662
663 # empty iterator
664 for i in range(1, len(data)):
665 next(itorg)
666 dump = pickle.dumps((itorg, orig), proto)
667 it, d = pickle.loads(dump)
668 for i, x in enumerate(data):
669 d[i] = x
670 self.assertEqual(type(it), type(itorg))
671 self.assertEqual(list(it), [])
672
673 # exhausted iterator
674 self.assertRaises(StopIteration, next, itorg)
675 dump = pickle.dumps((itorg, orig), proto)
676 it, d = pickle.loads(dump)
677 for i, x in enumerate(data):
678 d[i] = x
679 self.assertEqual(type(it), type(itorg))
680 self.assertEqual(list(it), [])
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000681
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000682 def test_deepcopy(self):
683 mut = [10]
684 d = deque([mut])
685 e = copy.deepcopy(d)
686 self.assertEqual(list(d), list(e))
687 mut[0] = 11
688 self.assertNotEqual(id(d), id(e))
689 self.assertNotEqual(list(d), list(e))
690
691 def test_copy(self):
692 mut = [10]
693 d = deque([mut])
694 e = copy.copy(d)
695 self.assertEqual(list(d), list(e))
696 mut[0] = 11
697 self.assertNotEqual(id(d), id(e))
698 self.assertEqual(list(d), list(e))
699
Raymond Hettingeraed88302015-09-19 09:05:42 -0700700 for i in range(5):
701 for maxlen in range(-1, 6):
702 s = [random.random() for j in range(i)]
703 d = deque(s) if maxlen == -1 else deque(s, maxlen)
704 e = d.copy()
705 self.assertEqual(d, e)
706 self.assertEqual(d.maxlen, e.maxlen)
707 self.assertTrue(all(x is y for x, y in zip(d, e)))
708
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700709 def test_copy_method(self):
710 mut = [10]
711 d = deque([mut])
712 e = d.copy()
713 self.assertEqual(list(d), list(e))
714 mut[0] = 11
715 self.assertNotEqual(id(d), id(e))
716 self.assertEqual(list(d), list(e))
717
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000718 def test_reversed(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000719 for s in ('abcd', range(2000)):
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000720 self.assertEqual(list(reversed(deque(s))), list(reversed(s)))
721
Raymond Hettingerbadf5d82014-06-14 20:41:22 -0700722 def test_reversed_new(self):
723 klass = type(reversed(deque()))
724 for s in ('abcd', range(2000)):
725 self.assertEqual(list(klass(deque(s))), list(reversed(s)))
726
Tim Peters10c7e862004-10-01 02:01:04 +0000727 def test_gc_doesnt_blowup(self):
728 import gc
729 # This used to assert-fail in deque_traverse() under a debug
730 # build, or run wild with a NULL pointer in a release build.
731 d = deque()
Guido van Rossum805365e2007-05-07 22:24:25 +0000732 for i in range(100):
Tim Peters10c7e862004-10-01 02:01:04 +0000733 d.append(1)
734 gc.collect()
735
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000736 def test_container_iterator(self):
737 # Bug #3680: tp_traverse was not implemented for deque iterator objects
738 class C(object):
739 pass
740 for i in range(2):
741 obj = C()
742 ref = weakref.ref(obj)
743 if i == 0:
744 container = deque([obj, 1])
745 else:
746 container = reversed(deque([obj, 1]))
747 obj.x = iter(container)
748 del obj, container
749 gc.collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000750 self.assertTrue(ref() is None, "Cycle was not collected")
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000751
Jesus Cea16e2fca2012-08-03 14:49:42 +0200752 check_sizeof = support.check_sizeof
753
754 @support.cpython_only
755 def test_sizeof(self):
Raymond Hettingerdaf57f22015-02-26 23:21:29 -0800756 BLOCKLEN = 64
Serhiy Storchakae23c90c2016-05-18 13:00:56 +0300757 basesize = support.calcvobjsize('2P4nP')
758 blocksize = struct.calcsize('P%dPP' % BLOCKLEN)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200759 self.assertEqual(object.__sizeof__(deque()), basesize)
760 check = self.check_sizeof
761 check(deque(), basesize + blocksize)
762 check(deque('a'), basesize + blocksize)
Raymond Hettingerd9c116c2013-07-09 00:13:21 -0700763 check(deque('a' * (BLOCKLEN - 1)), basesize + blocksize)
764 check(deque('a' * BLOCKLEN), basesize + 2 * blocksize)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200765 check(deque('a' * (42 * BLOCKLEN)), basesize + 43 * blocksize)
766
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000767class TestVariousIteratorArgs(unittest.TestCase):
768
769 def test_constructor(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000770 for s in ("123", "", range(1000), ('do', 1.2), range(2000,2200,5)):
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000771 for g in (seq_tests.Sequence, seq_tests.IterFunc,
772 seq_tests.IterGen, seq_tests.IterFuncStop,
773 seq_tests.itermulti, seq_tests.iterfunc):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000774 self.assertEqual(list(deque(g(s))), list(g(s)))
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000775 self.assertRaises(TypeError, deque, seq_tests.IterNextOnly(s))
776 self.assertRaises(TypeError, deque, seq_tests.IterNoNext(s))
777 self.assertRaises(ZeroDivisionError, deque, seq_tests.IterGenExc(s))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000778
779 def test_iter_with_altered_data(self):
780 d = deque('abcdefg')
781 it = iter(d)
782 d.pop()
Georg Brandla18af4e2007-04-21 15:47:16 +0000783 self.assertRaises(RuntimeError, next, it)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000784
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000785 def test_runtime_error_on_empty_deque(self):
786 d = deque()
787 it = iter(d)
788 d.append(10)
Georg Brandla18af4e2007-04-21 15:47:16 +0000789 self.assertRaises(RuntimeError, next, it)
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000790
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000791class Deque(deque):
792 pass
793
Raymond Hettinger952f8802004-11-09 07:27:35 +0000794class DequeWithBadIter(deque):
795 def __iter__(self):
796 raise TypeError
797
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000798class TestSubclass(unittest.TestCase):
799
800 def test_basics(self):
Christian Heimes38053212007-12-14 01:24:44 +0000801 d = Deque(range(25))
802 d.__init__(range(200))
Guido van Rossum805365e2007-05-07 22:24:25 +0000803 for i in range(200, 400):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000804 d.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000805 for i in reversed(range(-200, 0)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000806 d.appendleft(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000807 self.assertEqual(list(d), list(range(-200, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000808 self.assertEqual(len(d), 600)
809
Guido van Rossum805365e2007-05-07 22:24:25 +0000810 left = [d.popleft() for i in range(250)]
811 self.assertEqual(left, list(range(-200, 50)))
812 self.assertEqual(list(d), list(range(50, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000813
Guido van Rossum805365e2007-05-07 22:24:25 +0000814 right = [d.pop() for i in range(250)]
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000815 right.reverse()
Guido van Rossum805365e2007-05-07 22:24:25 +0000816 self.assertEqual(right, list(range(150, 400)))
817 self.assertEqual(list(d), list(range(50, 150)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000818
819 d.clear()
820 self.assertEqual(len(d), 0)
821
822 def test_copy_pickle(self):
823
824 d = Deque('abc')
825
826 e = d.__copy__()
827 self.assertEqual(type(d), type(e))
828 self.assertEqual(list(d), list(e))
829
830 e = Deque(d)
831 self.assertEqual(type(d), type(e))
832 self.assertEqual(list(d), list(e))
833
Serhiy Storchakabad12572014-12-15 14:03:42 +0200834 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
835 s = pickle.dumps(d, proto)
836 e = pickle.loads(s)
837 self.assertNotEqual(id(d), id(e))
838 self.assertEqual(type(d), type(e))
839 self.assertEqual(list(d), list(e))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000840
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000841 d = Deque('abcde', maxlen=4)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000842
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000843 e = d.__copy__()
844 self.assertEqual(type(d), type(e))
845 self.assertEqual(list(d), list(e))
846
847 e = Deque(d)
848 self.assertEqual(type(d), type(e))
849 self.assertEqual(list(d), list(e))
850
Serhiy Storchakabad12572014-12-15 14:03:42 +0200851 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
852 s = pickle.dumps(d, proto)
853 e = pickle.loads(s)
854 self.assertNotEqual(id(d), id(e))
855 self.assertEqual(type(d), type(e))
856 self.assertEqual(list(d), list(e))
Raymond Hettinger952f8802004-11-09 07:27:35 +0000857
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200858 def test_pickle_recursive(self):
859 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
860 for d in Deque('abc'), Deque('abc', 3):
861 d.append(d)
862
863 e = pickle.loads(pickle.dumps(d, proto))
864 self.assertNotEqual(id(e), id(d))
865 self.assertEqual(type(e), type(d))
866 self.assertEqual(e.maxlen, d.maxlen)
867 dd = d.pop()
868 ee = e.pop()
869 self.assertEqual(id(ee), id(e))
870 self.assertEqual(e, d)
871
872 d.x = d
873 e = pickle.loads(pickle.dumps(d, proto))
874 self.assertEqual(id(e.x), id(e))
875
876 for d in DequeWithBadIter('abc'), DequeWithBadIter('abc', 2):
877 self.assertRaises(TypeError, pickle.dumps, d, proto)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000878
Raymond Hettinger691d8052004-05-30 07:26:47 +0000879 def test_weakref(self):
880 d = deque('gallahad')
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000881 p = weakref.proxy(d)
Raymond Hettinger691d8052004-05-30 07:26:47 +0000882 self.assertEqual(str(p), str(d))
883 d = None
884 self.assertRaises(ReferenceError, str, p)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000885
Armin Rigo974d7572004-10-02 13:59:34 +0000886 def test_strange_subclass(self):
887 class X(deque):
888 def __iter__(self):
889 return iter([])
890 d1 = X([1,2,3])
891 d2 = X([4,5,6])
892 d1 == d2 # not clear if this is supposed to be True or False,
893 # but it used to give a SystemError
894
Thomas Woutersb2137042007-02-01 18:02:27 +0000895
896class SubclassWithKwargs(deque):
897 def __init__(self, newarg=1):
898 deque.__init__(self)
899
900class TestSubclassWithKwargs(unittest.TestCase):
901 def test_subclass_with_kwargs(self):
902 # SF bug #1486663 -- this used to erroneously raise a TypeError
903 SubclassWithKwargs(newarg=1)
904
Raymond Hettinger067bbba2015-04-01 08:11:09 -0700905class TestSequence(seq_tests.CommonTest):
906 type2test = deque
907
908 def test_getitem(self):
909 # For now, bypass tests that require slicing
910 pass
911
912 def test_getslice(self):
913 # For now, bypass tests that require slicing
914 pass
915
916 def test_subscript(self):
917 # For now, bypass tests that require slicing
918 pass
919
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +0300920 def test_free_after_iterating(self):
921 # For now, bypass tests that require slicing
922 self.skipTest("Exhausted deque iterator doesn't free a deque")
923
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000924#==============================================================================
925
Raymond Hettinger738ec902004-02-29 02:15:56 +0000926libreftest = """
927Example from the Library Reference: Doc/lib/libcollections.tex
928
929>>> from collections import deque
930>>> d = deque('ghi') # make a new deque with three items
931>>> for elem in d: # iterate over the deque's elements
Guido van Rossum7131f842007-02-09 20:13:25 +0000932... print(elem.upper())
Raymond Hettinger738ec902004-02-29 02:15:56 +0000933G
934H
935I
936>>> d.append('j') # add a new entry to the right side
937>>> d.appendleft('f') # add a new entry to the left side
938>>> d # show the representation of the deque
939deque(['f', 'g', 'h', 'i', 'j'])
940>>> d.pop() # return and remove the rightmost item
941'j'
942>>> d.popleft() # return and remove the leftmost item
943'f'
944>>> list(d) # list the contents of the deque
945['g', 'h', 'i']
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000946>>> d[0] # peek at leftmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000947'g'
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000948>>> d[-1] # peek at rightmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000949'i'
950>>> list(reversed(d)) # list the contents of a deque in reverse
951['i', 'h', 'g']
952>>> 'h' in d # search the deque
953True
954>>> d.extend('jkl') # add multiple elements at once
955>>> d
956deque(['g', 'h', 'i', 'j', 'k', 'l'])
957>>> d.rotate(1) # right rotation
958>>> d
959deque(['l', 'g', 'h', 'i', 'j', 'k'])
960>>> d.rotate(-1) # left rotation
961>>> d
962deque(['g', 'h', 'i', 'j', 'k', 'l'])
963>>> deque(reversed(d)) # make a new deque in reverse order
964deque(['l', 'k', 'j', 'i', 'h', 'g'])
965>>> d.clear() # empty the deque
966>>> d.pop() # cannot pop from an empty deque
967Traceback (most recent call last):
968 File "<pyshell#6>", line 1, in -toplevel-
969 d.pop()
970IndexError: pop from an empty deque
971
972>>> d.extendleft('abc') # extendleft() reverses the input order
973>>> d
974deque(['c', 'b', 'a'])
975
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000976
977
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000978>>> def delete_nth(d, n):
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000979... d.rotate(-n)
980... d.popleft()
981... d.rotate(n)
982...
983>>> d = deque('abcdef')
984>>> delete_nth(d, 2) # remove the entry at d[2]
985>>> d
986deque(['a', 'b', 'd', 'e', 'f'])
987
988
989
990>>> def roundrobin(*iterables):
991... pending = deque(iter(i) for i in iterables)
992... while pending:
993... task = pending.popleft()
994... try:
Georg Brandla18af4e2007-04-21 15:47:16 +0000995... yield next(task)
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000996... except StopIteration:
997... continue
998... pending.append(task)
999...
1000
1001>>> for value in roundrobin('abc', 'd', 'efgh'):
Guido van Rossum7131f842007-02-09 20:13:25 +00001002... print(value)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001003...
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001004a
1005d
1006e
1007b
1008f
1009c
1010g
1011h
1012
1013
1014>>> def maketree(iterable):
1015... d = deque(iterable)
1016... while len(d) > 1:
1017... pair = [d.popleft(), d.popleft()]
1018... d.append(pair)
1019... return list(d)
1020...
Guido van Rossum7131f842007-02-09 20:13:25 +00001021>>> print(maketree('abcdefgh'))
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001022[[[['a', 'b'], ['c', 'd']], [['e', 'f'], ['g', 'h']]]]
1023
Raymond Hettinger738ec902004-02-29 02:15:56 +00001024"""
1025
1026
1027#==============================================================================
1028
1029__test__ = {'libreftest' : libreftest}
1030
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001031def test_main(verbose=None):
1032 import sys
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001033 test_classes = (
1034 TestBasic,
1035 TestVariousIteratorArgs,
1036 TestSubclass,
Thomas Woutersb2137042007-02-01 18:02:27 +00001037 TestSubclassWithKwargs,
Raymond Hettinger067bbba2015-04-01 08:11:09 -07001038 TestSequence,
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001039 )
1040
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001041 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001042
1043 # verify reference counting
1044 if verbose and hasattr(sys, "gettotalrefcount"):
1045 import gc
1046 counts = [None] * 5
Guido van Rossum805365e2007-05-07 22:24:25 +00001047 for i in range(len(counts)):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001048 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001049 gc.collect()
1050 counts[i] = sys.gettotalrefcount()
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001051 print(counts)
Raymond Hettinger0a4977c2004-03-01 23:16:22 +00001052
Raymond Hettinger738ec902004-02-29 02:15:56 +00001053 # doctests
1054 from test import test_deque
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001055 support.run_doctest(test_deque, verbose)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001056
1057if __name__ == "__main__":
1058 test_main(verbose=True)