blob: 8bd6ebdbbadb5dbdadc2a88b525308f00613623c [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)
Serhiy Storchakaf9bab742020-06-21 11:11:17 +030069 self.assertEqual(repr(d)[-30:], ', 198, 199, [...]], maxlen=10)')
Guido van Rossum8ce8a782007-11-01 19:42:39 +000070 d = deque(range(10), maxlen=None)
71 self.assertEqual(repr(d), 'deque([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])')
72
Raymond Hettinger060c7f62009-03-10 09:36:07 +000073 def test_maxlen_zero(self):
74 it = iter(range(100))
75 deque(it, maxlen=0)
76 self.assertEqual(list(it), [])
77
78 it = iter(range(100))
79 d = deque(maxlen=0)
80 d.extend(it)
81 self.assertEqual(list(it), [])
82
83 it = iter(range(100))
84 d = deque(maxlen=0)
85 d.extendleft(it)
86 self.assertEqual(list(it), [])
87
Raymond Hettinger5bb0f0e2009-03-10 12:56:32 +000088 def test_maxlen_attribute(self):
89 self.assertEqual(deque().maxlen, None)
90 self.assertEqual(deque('abc').maxlen, None)
91 self.assertEqual(deque('abc', maxlen=4).maxlen, 4)
92 self.assertEqual(deque('abc', maxlen=2).maxlen, 2)
93 self.assertEqual(deque('abc', maxlen=0).maxlen, 0)
94 with self.assertRaises(AttributeError):
95 d = deque('abc')
96 d.maxlen = 10
97
Raymond Hettinger44459de2010-04-03 23:20:46 +000098 def test_count(self):
99 for s in ('', 'abracadabra', 'simsalabim'*500+'abc'):
100 s = list(s)
101 d = deque(s)
102 for letter in 'abcdefghijklmnopqrstuvwxyz':
103 self.assertEqual(s.count(letter), d.count(letter), (s, d, letter))
104 self.assertRaises(TypeError, d.count) # too few args
105 self.assertRaises(TypeError, d.count, 1, 2) # too many args
106 class BadCompare:
107 def __eq__(self, other):
108 raise ArithmeticError
109 d = deque([1, 2, BadCompare(), 3])
110 self.assertRaises(ArithmeticError, d.count, 2)
111 d = deque([1, 2, 3])
112 self.assertRaises(ArithmeticError, d.count, BadCompare())
113 class MutatingCompare:
114 def __eq__(self, other):
115 self.d.pop()
116 return True
117 m = MutatingCompare()
118 d = deque([1, 2, 3, m, 4, 5])
119 m.d = d
120 self.assertRaises(RuntimeError, d.count, 3)
121
Raymond Hettinger512d2cc2011-01-25 21:32:39 +0000122 # test issue11004
123 # block advance failed after rotation aligned elements on right side of block
124 d = deque([None]*16)
125 for i in range(len(d)):
126 d.rotate(-1)
127 d.rotate(1)
128 self.assertEqual(d.count(1), 0)
129 self.assertEqual(d.count(None), 16)
130
Raymond Hettinger738ec902004-02-29 02:15:56 +0000131 def test_comparisons(self):
Miss Islington (bot)280425d2021-06-23 03:02:40 -0700132 d = deque('xabc')
133 d.popleft()
Raymond Hettinger738ec902004-02-29 02:15:56 +0000134 for e in [d, deque('abc'), deque('ab'), deque(), list(d)]:
135 self.assertEqual(d==e, type(d)==type(e) and list(d)==list(e))
136 self.assertEqual(d!=e, not(type(d)==type(e) and list(d)==list(e)))
137
138 args = map(deque, ('', 'a', 'b', 'ab', 'ba', 'abc', 'xba', 'xabc', 'cba'))
139 for x in args:
140 for y in args:
141 self.assertEqual(x == y, list(x) == list(y), (x,y))
142 self.assertEqual(x != y, list(x) != list(y), (x,y))
143 self.assertEqual(x < y, list(x) < list(y), (x,y))
144 self.assertEqual(x <= y, list(x) <= list(y), (x,y))
145 self.assertEqual(x > y, list(x) > list(y), (x,y))
146 self.assertEqual(x >= y, list(x) >= list(y), (x,y))
Raymond Hettinger738ec902004-02-29 02:15:56 +0000147
Raymond Hettinger39dadf72015-03-20 16:38:56 -0700148 def test_contains(self):
149 n = 200
150
151 d = deque(range(n))
152 for i in range(n):
153 self.assertTrue(i in d)
154 self.assertTrue((n+1) not in d)
155
156 # Test detection of mutation during iteration
157 d = deque(range(n))
158 d[n//2] = MutateCmp(d, False)
159 with self.assertRaises(RuntimeError):
160 n in d
161
162 # Test detection of comparison exceptions
163 d = deque(range(n))
164 d[n//2] = BadCmp()
165 with self.assertRaises(RuntimeError):
166 n in d
167
sweeneydec6dedde2020-02-09 03:16:43 -0500168 def test_contains_count_stop_crashes(self):
169 class A:
170 def __eq__(self, other):
171 d.clear()
172 return NotImplemented
173 d = deque([A(), A()])
174 with self.assertRaises(RuntimeError):
175 _ = 3 in d
176 d = deque([A(), A()])
177 with self.assertRaises(RuntimeError):
178 _ = d.count(3)
179
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000180 def test_extend(self):
181 d = deque('a')
182 self.assertRaises(TypeError, d.extend, 1)
183 d.extend('bcd')
184 self.assertEqual(list(d), list('abcd'))
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000185 d.extend(d)
186 self.assertEqual(list(d), list('abcdabcd'))
187
Raymond Hettinger41290a62015-03-31 08:12:23 -0700188 def test_add(self):
189 d = deque()
190 e = deque('abc')
191 f = deque('def')
192 self.assertEqual(d + d, deque())
193 self.assertEqual(e + f, deque('abcdef'))
194 self.assertEqual(e + e, deque('abcabc'))
195 self.assertEqual(e + d, deque('abc'))
196 self.assertEqual(d + e, deque('abc'))
197 self.assertIsNot(d + d, deque())
198 self.assertIsNot(e + d, deque('abc'))
199 self.assertIsNot(d + e, deque('abc'))
200
201 g = deque('abcdef', maxlen=4)
202 h = deque('gh')
203 self.assertEqual(g + h, deque('efgh'))
204
205 with self.assertRaises(TypeError):
206 deque('abc') + 'def'
207
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000208 def test_iadd(self):
209 d = deque('a')
210 d += 'bcd'
211 self.assertEqual(list(d), list('abcd'))
212 d += d
213 self.assertEqual(list(d), list('abcdabcd'))
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000214
215 def test_extendleft(self):
216 d = deque('a')
217 self.assertRaises(TypeError, d.extendleft, 1)
218 d.extendleft('bcd')
219 self.assertEqual(list(d), list(reversed('abcd')))
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000220 d.extendleft(d)
221 self.assertEqual(list(d), list('abcddcba'))
Raymond Hettingera435c532004-07-09 04:10:20 +0000222 d = deque()
223 d.extendleft(range(1000))
224 self.assertEqual(list(d), list(reversed(range(1000))))
225 self.assertRaises(SyntaxError, d.extendleft, fail())
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000226
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000227 def test_getitem(self):
228 n = 200
Guido van Rossum805365e2007-05-07 22:24:25 +0000229 d = deque(range(n))
230 l = list(range(n))
231 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000232 d.popleft()
233 l.pop(0)
234 if random.random() < 0.5:
235 d.append(i)
236 l.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000237 for j in range(1-len(l), len(l)):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000238 assert d[j] == l[j]
239
Raymond Hettinger738ec902004-02-29 02:15:56 +0000240 d = deque('superman')
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000241 self.assertEqual(d[0], 's')
242 self.assertEqual(d[-1], 'n')
Raymond Hettinger738ec902004-02-29 02:15:56 +0000243 d = deque()
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000244 self.assertRaises(IndexError, d.__getitem__, 0)
245 self.assertRaises(IndexError, d.__getitem__, -1)
246
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700247 def test_index(self):
248 for n in 1, 2, 30, 40, 200:
249
250 d = deque(range(n))
251 for i in range(n):
252 self.assertEqual(d.index(i), i)
253
254 with self.assertRaises(ValueError):
255 d.index(n+1)
256
257 # Test detection of mutation during iteration
258 d = deque(range(n))
259 d[n//2] = MutateCmp(d, False)
260 with self.assertRaises(RuntimeError):
261 d.index(n)
262
263 # Test detection of comparison exceptions
264 d = deque(range(n))
265 d[n//2] = BadCmp()
266 with self.assertRaises(RuntimeError):
267 d.index(n)
268
269 # Test start and stop arguments behavior matches list.index()
270 elements = 'ABCDEFGHI'
271 nonelement = 'Z'
272 d = deque(elements * 2)
273 s = list(elements * 2)
274 for start in range(-5 - len(s)*2, 5 + len(s) * 2):
275 for stop in range(-5 - len(s)*2, 5 + len(s) * 2):
276 for element in elements + 'Z':
277 try:
278 target = s.index(element, start, stop)
279 except ValueError:
280 with self.assertRaises(ValueError):
281 d.index(element, start, stop)
282 else:
283 self.assertEqual(d.index(element, start, stop), target)
284
Raymond Hettingerb46ad542018-09-21 01:46:41 -0700285 # Test large start argument
286 d = deque(range(0, 10000, 10))
287 for step in range(100):
288 i = d.index(8500, 700)
289 self.assertEqual(d[i], 8500)
290 # Repeat test with a different internal offset
291 d.rotate()
292
Raymond Hettinger906d82d2016-01-25 23:00:21 -0800293 def test_index_bug_24913(self):
Raymond Hettinger87674ec2015-08-26 08:08:38 -0700294 d = deque('A' * 3)
295 with self.assertRaises(ValueError):
296 i = d.index("Hello world", 0, 4)
297
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700298 def test_insert(self):
299 # Test to make sure insert behaves like lists
300 elements = 'ABCDEFGHI'
301 for i in range(-5 - len(elements)*2, 5 + len(elements) * 2):
302 d = deque('ABCDEFGHI')
303 s = list('ABCDEFGHI')
304 d.insert(i, 'Z')
305 s.insert(i, 'Z')
306 self.assertEqual(list(d), s)
307
Raymond Hettingera6389712016-02-01 21:21:19 -0800308 def test_insert_bug_26194(self):
Raymond Hettinger37434322016-01-26 21:44:16 -0800309 data = 'ABC'
Raymond Hettingera6389712016-02-01 21:21:19 -0800310 d = deque(data, maxlen=len(data))
311 with self.assertRaises(IndexError):
312 d.insert(2, None)
313
314 elements = 'ABCDEFGHI'
315 for i in range(-len(elements), len(elements)):
316 d = deque(elements, maxlen=len(elements)+1)
317 d.insert(i, 'Z')
318 if i >= 0:
319 self.assertEqual(d[i], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800320 else:
Raymond Hettingera6389712016-02-01 21:21:19 -0800321 self.assertEqual(d[i-1], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800322
Raymond Hettinger41290a62015-03-31 08:12:23 -0700323 def test_imul(self):
324 for n in (-10, -1, 0, 1, 2, 10, 1000):
325 d = deque()
326 d *= n
327 self.assertEqual(d, deque())
328 self.assertIsNone(d.maxlen)
329
330 for n in (-10, -1, 0, 1, 2, 10, 1000):
331 d = deque('a')
332 d *= n
333 self.assertEqual(d, deque('a' * n))
334 self.assertIsNone(d.maxlen)
335
336 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
337 d = deque('a', 500)
338 d *= n
339 self.assertEqual(d, deque('a' * min(n, 500)))
340 self.assertEqual(d.maxlen, 500)
341
342 for n in (-10, -1, 0, 1, 2, 10, 1000):
343 d = deque('abcdef')
344 d *= n
345 self.assertEqual(d, deque('abcdef' * n))
346 self.assertIsNone(d.maxlen)
347
348 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
349 d = deque('abcdef', 500)
350 d *= n
351 self.assertEqual(d, deque(('abcdef' * n)[-500:]))
352 self.assertEqual(d.maxlen, 500)
353
354 def test_mul(self):
355 d = deque('abc')
356 self.assertEqual(d * -5, deque())
357 self.assertEqual(d * 0, deque())
358 self.assertEqual(d * 1, deque('abc'))
359 self.assertEqual(d * 2, deque('abcabc'))
360 self.assertEqual(d * 3, deque('abcabcabc'))
361 self.assertIsNot(d * 1, d)
362
363 self.assertEqual(deque() * 0, deque())
364 self.assertEqual(deque() * 1, deque())
365 self.assertEqual(deque() * 5, deque())
366
367 self.assertEqual(-5 * d, deque())
368 self.assertEqual(0 * d, deque())
369 self.assertEqual(1 * d, deque('abc'))
370 self.assertEqual(2 * d, deque('abcabc'))
371 self.assertEqual(3 * d, deque('abcabcabc'))
372
373 d = deque('abc', maxlen=5)
374 self.assertEqual(d * -5, deque())
375 self.assertEqual(d * 0, deque())
376 self.assertEqual(d * 1, deque('abc'))
377 self.assertEqual(d * 2, deque('bcabc'))
378 self.assertEqual(d * 30, deque('bcabc'))
379
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000380 def test_setitem(self):
381 n = 200
Guido van Rossum805365e2007-05-07 22:24:25 +0000382 d = deque(range(n))
383 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000384 d[i] = 10 * i
Guido van Rossum805365e2007-05-07 22:24:25 +0000385 self.assertEqual(list(d), [10*i for i in range(n)])
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000386 l = list(d)
Guido van Rossum805365e2007-05-07 22:24:25 +0000387 for i in range(1-n, 0, -1):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000388 d[i] = 7*i
389 l[i] = 7*i
390 self.assertEqual(list(d), l)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000391
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000392 def test_delitem(self):
393 n = 500 # O(n**2) test, don't make this too big
Guido van Rossum805365e2007-05-07 22:24:25 +0000394 d = deque(range(n))
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000395 self.assertRaises(IndexError, d.__delitem__, -n-1)
396 self.assertRaises(IndexError, d.__delitem__, n)
Guido van Rossum805365e2007-05-07 22:24:25 +0000397 for i in range(n):
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000398 self.assertEqual(len(d), n-i)
399 j = random.randrange(-len(d), len(d))
400 val = d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000401 self.assertIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000402 del d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000403 self.assertNotIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000404 self.assertEqual(len(d), 0)
405
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000406 def test_reverse(self):
407 n = 500 # O(n**2) test, don't make this too big
408 data = [random.random() for i in range(n)]
409 for i in range(n):
410 d = deque(data[:i])
411 r = d.reverse()
412 self.assertEqual(list(d), list(reversed(data[:i])))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000413 self.assertIs(r, None)
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000414 d.reverse()
415 self.assertEqual(list(d), data[:i])
416 self.assertRaises(TypeError, d.reverse, 1) # Arity is zero
417
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000418 def test_rotate(self):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000419 s = tuple('abcde')
420 n = len(s)
421
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000422 d = deque(s)
Raymond Hettingeree33b272004-02-08 04:05:26 +0000423 d.rotate(1) # verify rot(1)
424 self.assertEqual(''.join(d), 'eabcd')
425
426 d = deque(s)
427 d.rotate(-1) # verify rot(-1)
428 self.assertEqual(''.join(d), 'bcdea')
429 d.rotate() # check default to 1
430 self.assertEqual(tuple(d), s)
431
Guido van Rossum805365e2007-05-07 22:24:25 +0000432 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000433 d = deque(s)
434 e = deque(d)
435 d.rotate(i) # check vs. rot(1) n times
Guido van Rossum805365e2007-05-07 22:24:25 +0000436 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000437 e.rotate(1)
438 self.assertEqual(tuple(d), tuple(e))
439 d.rotate(-i) # check that it works in reverse
440 self.assertEqual(tuple(d), s)
441 e.rotate(n-i) # check that it wraps forward
442 self.assertEqual(tuple(e), s)
443
Guido van Rossum805365e2007-05-07 22:24:25 +0000444 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000445 d = deque(s)
446 e = deque(d)
447 d.rotate(-i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000448 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000449 e.rotate(-1) # check vs. rot(-1) n times
450 self.assertEqual(tuple(d), tuple(e))
451 d.rotate(i) # check that it works in reverse
452 self.assertEqual(tuple(d), s)
453 e.rotate(i-n) # check that it wraps backaround
454 self.assertEqual(tuple(e), s)
455
456 d = deque(s)
457 e = deque(s)
458 e.rotate(BIG+17) # verify on long series of rotates
459 dr = d.rotate
Guido van Rossum805365e2007-05-07 22:24:25 +0000460 for i in range(BIG+17):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000461 dr()
462 self.assertEqual(tuple(d), tuple(e))
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000463
Raymond Hettingera435c532004-07-09 04:10:20 +0000464 self.assertRaises(TypeError, d.rotate, 'x') # Wrong arg type
465 self.assertRaises(TypeError, d.rotate, 1, 10) # Too many args
466
467 d = deque()
468 d.rotate() # rotate an empty deque
469 self.assertEqual(d, deque())
470
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000471 def test_len(self):
472 d = deque('ab')
473 self.assertEqual(len(d), 2)
474 d.popleft()
475 self.assertEqual(len(d), 1)
476 d.pop()
477 self.assertEqual(len(d), 0)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000478 self.assertRaises(IndexError, d.pop)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000479 self.assertEqual(len(d), 0)
480 d.append('c')
481 self.assertEqual(len(d), 1)
482 d.appendleft('d')
483 self.assertEqual(len(d), 2)
484 d.clear()
485 self.assertEqual(len(d), 0)
486
487 def test_underflow(self):
488 d = deque()
Raymond Hettinger738ec902004-02-29 02:15:56 +0000489 self.assertRaises(IndexError, d.pop)
490 self.assertRaises(IndexError, d.popleft)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000491
492 def test_clear(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000493 d = deque(range(100))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000494 self.assertEqual(len(d), 100)
495 d.clear()
496 self.assertEqual(len(d), 0)
497 self.assertEqual(list(d), [])
Martin Pantereb995702016-07-28 01:11:04 +0000498 d.clear() # clear an empty deque
Raymond Hettingera435c532004-07-09 04:10:20 +0000499 self.assertEqual(list(d), [])
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000500
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000501 def test_remove(self):
502 d = deque('abcdefghcij')
503 d.remove('c')
504 self.assertEqual(d, deque('abdefghcij'))
505 d.remove('c')
506 self.assertEqual(d, deque('abdefghij'))
507 self.assertRaises(ValueError, d.remove, 'c')
508 self.assertEqual(d, deque('abdefghij'))
509
Walter Dörwaldc448a912005-03-22 11:22:38 +0000510 # Handle comparison errors
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000511 d = deque(['a', 'b', BadCmp(), 'c'])
512 e = deque(d)
513 self.assertRaises(RuntimeError, d.remove, 'c')
514 for x, y in zip(d, e):
515 # verify that original order and values are retained.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000516 self.assertTrue(x is y)
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000517
518 # Handle evil mutator
Raymond Hettingerd73202c2005-03-19 00:00:51 +0000519 for match in (True, False):
520 d = deque(['ab'])
521 d.extend([MutateCmp(d, match), 'c'])
522 self.assertRaises(IndexError, d.remove, 'c')
523 self.assertEqual(d, deque())
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000524
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000525 def test_repr(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000526 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000527 e = eval(repr(d))
528 self.assertEqual(list(d), list(e))
529 d.append(d)
Serhiy Storchakaf9bab742020-06-21 11:11:17 +0300530 self.assertEqual(repr(d)[-20:], '7, 198, 199, [...]])')
Raymond Hettingera435c532004-07-09 04:10:20 +0000531
532 def test_init(self):
Miss Islington (bot)280425d2021-06-23 03:02:40 -0700533 self.assertRaises(TypeError, deque, 'abc', 2, 3)
534 self.assertRaises(TypeError, deque, 1)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000535
536 def test_hash(self):
537 self.assertRaises(TypeError, hash, deque('abc'))
538
539 def test_long_steadystate_queue_popleft(self):
540 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000541 d = deque(range(size))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000542 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000543 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000544 append(i)
545 x = pop()
546 if x != i - size:
547 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000548 self.assertEqual(list(d), list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000549
550 def test_long_steadystate_queue_popright(self):
551 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000552 d = deque(reversed(range(size)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000553 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000554 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000555 append(i)
556 x = pop()
557 if x != i - size:
558 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000559 self.assertEqual(list(reversed(list(d))),
560 list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000561
562 def test_big_queue_popleft(self):
563 pass
564 d = deque()
565 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000566 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000567 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000568 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000569 x = pop()
570 if x != i:
571 self.assertEqual(x, i)
572
573 def test_big_queue_popright(self):
574 d = deque()
575 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000576 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000577 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000578 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000579 x = pop()
580 if x != i:
581 self.assertEqual(x, i)
582
583 def test_big_stack_right(self):
584 d = deque()
585 append, pop = d.append, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000586 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000587 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000588 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000589 x = pop()
590 if x != i:
591 self.assertEqual(x, i)
592 self.assertEqual(len(d), 0)
593
594 def test_big_stack_left(self):
595 d = deque()
596 append, pop = d.appendleft, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000597 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000598 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000599 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000600 x = pop()
601 if x != i:
602 self.assertEqual(x, i)
603 self.assertEqual(len(d), 0)
604
605 def test_roundtrip_iter_init(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000606 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000607 e = deque(d)
608 self.assertNotEqual(id(d), id(e))
609 self.assertEqual(list(d), list(e))
610
611 def test_pickle(self):
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200612 for d in deque(range(200)), deque(range(200), 100):
613 for i in range(pickle.HIGHEST_PROTOCOL + 1):
614 s = pickle.dumps(d, i)
615 e = pickle.loads(s)
616 self.assertNotEqual(id(e), id(d))
617 self.assertEqual(list(e), list(d))
618 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000619
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200620 def test_pickle_recursive(self):
621 for d in deque('abc'), deque('abc', 3):
622 d.append(d)
623 for i in range(pickle.HIGHEST_PROTOCOL + 1):
624 e = pickle.loads(pickle.dumps(d, i))
625 self.assertNotEqual(id(e), id(d))
626 self.assertEqual(id(e[-1]), id(e))
627 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000628
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000629 def test_iterator_pickle(self):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200630 orig = deque(range(200))
631 data = [i*1.01 for i in orig]
Serhiy Storchakabad12572014-12-15 14:03:42 +0200632 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200633 # initial iterator
634 itorg = iter(orig)
635 dump = pickle.dumps((itorg, orig), proto)
636 it, d = pickle.loads(dump)
637 for i, x in enumerate(data):
638 d[i] = x
639 self.assertEqual(type(it), type(itorg))
640 self.assertEqual(list(it), data)
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000641
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200642 # running iterator
643 next(itorg)
644 dump = pickle.dumps((itorg, orig), proto)
645 it, d = pickle.loads(dump)
646 for i, x in enumerate(data):
647 d[i] = x
648 self.assertEqual(type(it), type(itorg))
649 self.assertEqual(list(it), data[1:])
650
651 # empty iterator
652 for i in range(1, len(data)):
653 next(itorg)
654 dump = pickle.dumps((itorg, orig), proto)
655 it, d = pickle.loads(dump)
656 for i, x in enumerate(data):
657 d[i] = x
658 self.assertEqual(type(it), type(itorg))
659 self.assertEqual(list(it), [])
660
661 # exhausted iterator
662 self.assertRaises(StopIteration, next, itorg)
663 dump = pickle.dumps((itorg, orig), proto)
664 it, d = pickle.loads(dump)
665 for i, x in enumerate(data):
666 d[i] = x
667 self.assertEqual(type(it), type(itorg))
668 self.assertEqual(list(it), [])
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000669
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000670 def test_deepcopy(self):
671 mut = [10]
672 d = deque([mut])
673 e = copy.deepcopy(d)
674 self.assertEqual(list(d), list(e))
675 mut[0] = 11
676 self.assertNotEqual(id(d), id(e))
677 self.assertNotEqual(list(d), list(e))
678
679 def test_copy(self):
680 mut = [10]
681 d = deque([mut])
682 e = copy.copy(d)
683 self.assertEqual(list(d), list(e))
684 mut[0] = 11
685 self.assertNotEqual(id(d), id(e))
686 self.assertEqual(list(d), list(e))
687
Raymond Hettingeraed88302015-09-19 09:05:42 -0700688 for i in range(5):
689 for maxlen in range(-1, 6):
690 s = [random.random() for j in range(i)]
691 d = deque(s) if maxlen == -1 else deque(s, maxlen)
692 e = d.copy()
693 self.assertEqual(d, e)
694 self.assertEqual(d.maxlen, e.maxlen)
695 self.assertTrue(all(x is y for x, y in zip(d, e)))
696
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700697 def test_copy_method(self):
698 mut = [10]
699 d = deque([mut])
700 e = d.copy()
701 self.assertEqual(list(d), list(e))
702 mut[0] = 11
703 self.assertNotEqual(id(d), id(e))
704 self.assertEqual(list(d), list(e))
705
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000706 def test_reversed(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000707 for s in ('abcd', range(2000)):
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000708 self.assertEqual(list(reversed(deque(s))), list(reversed(s)))
709
Raymond Hettingerbadf5d82014-06-14 20:41:22 -0700710 def test_reversed_new(self):
711 klass = type(reversed(deque()))
712 for s in ('abcd', range(2000)):
713 self.assertEqual(list(klass(deque(s))), list(reversed(s)))
714
Tim Peters10c7e862004-10-01 02:01:04 +0000715 def test_gc_doesnt_blowup(self):
716 import gc
717 # This used to assert-fail in deque_traverse() under a debug
718 # build, or run wild with a NULL pointer in a release build.
719 d = deque()
Guido van Rossum805365e2007-05-07 22:24:25 +0000720 for i in range(100):
Tim Peters10c7e862004-10-01 02:01:04 +0000721 d.append(1)
722 gc.collect()
723
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000724 def test_container_iterator(self):
725 # Bug #3680: tp_traverse was not implemented for deque iterator objects
726 class C(object):
727 pass
728 for i in range(2):
729 obj = C()
730 ref = weakref.ref(obj)
731 if i == 0:
732 container = deque([obj, 1])
733 else:
734 container = reversed(deque([obj, 1]))
735 obj.x = iter(container)
736 del obj, container
737 gc.collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000738 self.assertTrue(ref() is None, "Cycle was not collected")
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000739
Jesus Cea16e2fca2012-08-03 14:49:42 +0200740 check_sizeof = support.check_sizeof
741
742 @support.cpython_only
743 def test_sizeof(self):
Raymond Hettingerdaf57f22015-02-26 23:21:29 -0800744 BLOCKLEN = 64
Serhiy Storchakae23c90c2016-05-18 13:00:56 +0300745 basesize = support.calcvobjsize('2P4nP')
746 blocksize = struct.calcsize('P%dPP' % BLOCKLEN)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200747 self.assertEqual(object.__sizeof__(deque()), basesize)
748 check = self.check_sizeof
749 check(deque(), basesize + blocksize)
750 check(deque('a'), basesize + blocksize)
Raymond Hettingerd9c116c2013-07-09 00:13:21 -0700751 check(deque('a' * (BLOCKLEN - 1)), basesize + blocksize)
752 check(deque('a' * BLOCKLEN), basesize + 2 * blocksize)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200753 check(deque('a' * (42 * BLOCKLEN)), basesize + 43 * blocksize)
754
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000755class TestVariousIteratorArgs(unittest.TestCase):
756
757 def test_constructor(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000758 for s in ("123", "", range(1000), ('do', 1.2), range(2000,2200,5)):
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000759 for g in (seq_tests.Sequence, seq_tests.IterFunc,
760 seq_tests.IterGen, seq_tests.IterFuncStop,
761 seq_tests.itermulti, seq_tests.iterfunc):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000762 self.assertEqual(list(deque(g(s))), list(g(s)))
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000763 self.assertRaises(TypeError, deque, seq_tests.IterNextOnly(s))
764 self.assertRaises(TypeError, deque, seq_tests.IterNoNext(s))
765 self.assertRaises(ZeroDivisionError, deque, seq_tests.IterGenExc(s))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000766
767 def test_iter_with_altered_data(self):
768 d = deque('abcdefg')
769 it = iter(d)
770 d.pop()
Georg Brandla18af4e2007-04-21 15:47:16 +0000771 self.assertRaises(RuntimeError, next, it)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000772
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000773 def test_runtime_error_on_empty_deque(self):
774 d = deque()
775 it = iter(d)
776 d.append(10)
Georg Brandla18af4e2007-04-21 15:47:16 +0000777 self.assertRaises(RuntimeError, next, it)
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000778
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000779class Deque(deque):
780 pass
781
Raymond Hettinger952f8802004-11-09 07:27:35 +0000782class DequeWithBadIter(deque):
783 def __iter__(self):
784 raise TypeError
785
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000786class TestSubclass(unittest.TestCase):
787
788 def test_basics(self):
Christian Heimes38053212007-12-14 01:24:44 +0000789 d = Deque(range(25))
790 d.__init__(range(200))
Guido van Rossum805365e2007-05-07 22:24:25 +0000791 for i in range(200, 400):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000792 d.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000793 for i in reversed(range(-200, 0)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000794 d.appendleft(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000795 self.assertEqual(list(d), list(range(-200, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000796 self.assertEqual(len(d), 600)
797
Guido van Rossum805365e2007-05-07 22:24:25 +0000798 left = [d.popleft() for i in range(250)]
799 self.assertEqual(left, list(range(-200, 50)))
800 self.assertEqual(list(d), list(range(50, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000801
Guido van Rossum805365e2007-05-07 22:24:25 +0000802 right = [d.pop() for i in range(250)]
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000803 right.reverse()
Guido van Rossum805365e2007-05-07 22:24:25 +0000804 self.assertEqual(right, list(range(150, 400)))
805 self.assertEqual(list(d), list(range(50, 150)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000806
807 d.clear()
808 self.assertEqual(len(d), 0)
809
810 def test_copy_pickle(self):
811
812 d = Deque('abc')
813
814 e = d.__copy__()
815 self.assertEqual(type(d), type(e))
816 self.assertEqual(list(d), list(e))
817
818 e = Deque(d)
819 self.assertEqual(type(d), type(e))
820 self.assertEqual(list(d), list(e))
821
Serhiy Storchakabad12572014-12-15 14:03:42 +0200822 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
823 s = pickle.dumps(d, proto)
824 e = pickle.loads(s)
825 self.assertNotEqual(id(d), id(e))
826 self.assertEqual(type(d), type(e))
827 self.assertEqual(list(d), list(e))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000828
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000829 d = Deque('abcde', maxlen=4)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000830
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000831 e = d.__copy__()
832 self.assertEqual(type(d), type(e))
833 self.assertEqual(list(d), list(e))
834
835 e = Deque(d)
836 self.assertEqual(type(d), type(e))
837 self.assertEqual(list(d), list(e))
838
Serhiy Storchakabad12572014-12-15 14:03:42 +0200839 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
840 s = pickle.dumps(d, proto)
841 e = pickle.loads(s)
842 self.assertNotEqual(id(d), id(e))
843 self.assertEqual(type(d), type(e))
844 self.assertEqual(list(d), list(e))
Raymond Hettinger952f8802004-11-09 07:27:35 +0000845
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200846 def test_pickle_recursive(self):
847 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
848 for d in Deque('abc'), Deque('abc', 3):
849 d.append(d)
850
851 e = pickle.loads(pickle.dumps(d, proto))
852 self.assertNotEqual(id(e), id(d))
853 self.assertEqual(type(e), type(d))
854 self.assertEqual(e.maxlen, d.maxlen)
855 dd = d.pop()
856 ee = e.pop()
857 self.assertEqual(id(ee), id(e))
858 self.assertEqual(e, d)
859
860 d.x = d
861 e = pickle.loads(pickle.dumps(d, proto))
862 self.assertEqual(id(e.x), id(e))
863
864 for d in DequeWithBadIter('abc'), DequeWithBadIter('abc', 2):
865 self.assertRaises(TypeError, pickle.dumps, d, proto)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000866
Raymond Hettinger691d8052004-05-30 07:26:47 +0000867 def test_weakref(self):
868 d = deque('gallahad')
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000869 p = weakref.proxy(d)
Raymond Hettinger691d8052004-05-30 07:26:47 +0000870 self.assertEqual(str(p), str(d))
871 d = None
872 self.assertRaises(ReferenceError, str, p)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000873
Armin Rigo974d7572004-10-02 13:59:34 +0000874 def test_strange_subclass(self):
875 class X(deque):
876 def __iter__(self):
877 return iter([])
878 d1 = X([1,2,3])
879 d2 = X([4,5,6])
880 d1 == d2 # not clear if this is supposed to be True or False,
881 # but it used to give a SystemError
882
Oren Milman24bd50b2018-09-11 21:46:55 +0300883 @support.cpython_only
884 def test_bug_31608(self):
885 # The interpreter used to crash in specific cases where a deque
886 # subclass returned a non-deque.
887 class X(deque):
888 pass
889 d = X()
890 def bad___new__(cls, *args, **kwargs):
891 return [42]
892 X.__new__ = bad___new__
893 with self.assertRaises(TypeError):
894 d * 42 # shouldn't crash
895 with self.assertRaises(TypeError):
896 d + deque([1, 2, 3]) # shouldn't crash
897
Thomas Woutersb2137042007-02-01 18:02:27 +0000898
899class SubclassWithKwargs(deque):
900 def __init__(self, newarg=1):
901 deque.__init__(self)
902
903class TestSubclassWithKwargs(unittest.TestCase):
904 def test_subclass_with_kwargs(self):
905 # SF bug #1486663 -- this used to erroneously raise a TypeError
906 SubclassWithKwargs(newarg=1)
907
Raymond Hettinger067bbba2015-04-01 08:11:09 -0700908class TestSequence(seq_tests.CommonTest):
909 type2test = deque
910
911 def test_getitem(self):
912 # For now, bypass tests that require slicing
913 pass
914
915 def test_getslice(self):
916 # For now, bypass tests that require slicing
917 pass
918
919 def test_subscript(self):
920 # For now, bypass tests that require slicing
921 pass
922
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +0300923 def test_free_after_iterating(self):
924 # For now, bypass tests that require slicing
925 self.skipTest("Exhausted deque iterator doesn't free a deque")
926
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000927#==============================================================================
928
Raymond Hettinger738ec902004-02-29 02:15:56 +0000929libreftest = """
930Example from the Library Reference: Doc/lib/libcollections.tex
931
932>>> from collections import deque
933>>> d = deque('ghi') # make a new deque with three items
934>>> for elem in d: # iterate over the deque's elements
Guido van Rossum7131f842007-02-09 20:13:25 +0000935... print(elem.upper())
Raymond Hettinger738ec902004-02-29 02:15:56 +0000936G
937H
938I
939>>> d.append('j') # add a new entry to the right side
940>>> d.appendleft('f') # add a new entry to the left side
941>>> d # show the representation of the deque
942deque(['f', 'g', 'h', 'i', 'j'])
943>>> d.pop() # return and remove the rightmost item
944'j'
945>>> d.popleft() # return and remove the leftmost item
946'f'
947>>> list(d) # list the contents of the deque
948['g', 'h', 'i']
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000949>>> d[0] # peek at leftmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000950'g'
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000951>>> d[-1] # peek at rightmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000952'i'
953>>> list(reversed(d)) # list the contents of a deque in reverse
954['i', 'h', 'g']
955>>> 'h' in d # search the deque
956True
957>>> d.extend('jkl') # add multiple elements at once
958>>> d
959deque(['g', 'h', 'i', 'j', 'k', 'l'])
960>>> d.rotate(1) # right rotation
961>>> d
962deque(['l', 'g', 'h', 'i', 'j', 'k'])
963>>> d.rotate(-1) # left rotation
964>>> d
965deque(['g', 'h', 'i', 'j', 'k', 'l'])
966>>> deque(reversed(d)) # make a new deque in reverse order
967deque(['l', 'k', 'j', 'i', 'h', 'g'])
968>>> d.clear() # empty the deque
969>>> d.pop() # cannot pop from an empty deque
970Traceback (most recent call last):
971 File "<pyshell#6>", line 1, in -toplevel-
972 d.pop()
973IndexError: pop from an empty deque
974
975>>> d.extendleft('abc') # extendleft() reverses the input order
976>>> d
977deque(['c', 'b', 'a'])
978
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000979
980
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000981>>> def delete_nth(d, n):
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000982... d.rotate(-n)
983... d.popleft()
984... d.rotate(n)
985...
986>>> d = deque('abcdef')
987>>> delete_nth(d, 2) # remove the entry at d[2]
988>>> d
989deque(['a', 'b', 'd', 'e', 'f'])
990
991
992
993>>> def roundrobin(*iterables):
994... pending = deque(iter(i) for i in iterables)
995... while pending:
996... task = pending.popleft()
997... try:
Georg Brandla18af4e2007-04-21 15:47:16 +0000998... yield next(task)
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000999... except StopIteration:
1000... continue
1001... pending.append(task)
1002...
1003
1004>>> for value in roundrobin('abc', 'd', 'efgh'):
Guido van Rossum7131f842007-02-09 20:13:25 +00001005... print(value)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001006...
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001007a
1008d
1009e
1010b
1011f
1012c
1013g
1014h
1015
1016
1017>>> def maketree(iterable):
1018... d = deque(iterable)
1019... while len(d) > 1:
1020... pair = [d.popleft(), d.popleft()]
1021... d.append(pair)
1022... return list(d)
1023...
Guido van Rossum7131f842007-02-09 20:13:25 +00001024>>> print(maketree('abcdefgh'))
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001025[[[['a', 'b'], ['c', 'd']], [['e', 'f'], ['g', 'h']]]]
1026
Raymond Hettinger738ec902004-02-29 02:15:56 +00001027"""
1028
1029
1030#==============================================================================
1031
1032__test__ = {'libreftest' : libreftest}
1033
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001034def test_main(verbose=None):
1035 import sys
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001036 test_classes = (
1037 TestBasic,
1038 TestVariousIteratorArgs,
1039 TestSubclass,
Thomas Woutersb2137042007-02-01 18:02:27 +00001040 TestSubclassWithKwargs,
Raymond Hettinger067bbba2015-04-01 08:11:09 -07001041 TestSequence,
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001042 )
1043
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001044 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001045
1046 # verify reference counting
1047 if verbose and hasattr(sys, "gettotalrefcount"):
1048 import gc
1049 counts = [None] * 5
Guido van Rossum805365e2007-05-07 22:24:25 +00001050 for i in range(len(counts)):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001051 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001052 gc.collect()
1053 counts[i] = sys.gettotalrefcount()
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001054 print(counts)
Raymond Hettinger0a4977c2004-03-01 23:16:22 +00001055
Raymond Hettinger738ec902004-02-29 02:15:56 +00001056 # doctests
1057 from test import test_deque
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001058 support.run_doctest(test_deque, verbose)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001059
1060if __name__ == "__main__":
1061 test_main(verbose=True)