blob: 93cc6ca4f44ecb546c4a3c7b1e8e64d10c0cce1a [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):
132 d = deque('xabc'); d.popleft()
133 for e in [d, deque('abc'), deque('ab'), deque(), list(d)]:
134 self.assertEqual(d==e, type(d)==type(e) and list(d)==list(e))
135 self.assertEqual(d!=e, not(type(d)==type(e) and list(d)==list(e)))
136
137 args = map(deque, ('', 'a', 'b', 'ab', 'ba', 'abc', 'xba', 'xabc', 'cba'))
138 for x in args:
139 for y in args:
140 self.assertEqual(x == y, list(x) == list(y), (x,y))
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))
Raymond Hettinger738ec902004-02-29 02:15:56 +0000146
Raymond Hettinger39dadf72015-03-20 16:38:56 -0700147 def test_contains(self):
148 n = 200
149
150 d = deque(range(n))
151 for i in range(n):
152 self.assertTrue(i in d)
153 self.assertTrue((n+1) not in d)
154
155 # Test detection of mutation during iteration
156 d = deque(range(n))
157 d[n//2] = MutateCmp(d, False)
158 with self.assertRaises(RuntimeError):
159 n in d
160
161 # Test detection of comparison exceptions
162 d = deque(range(n))
163 d[n//2] = BadCmp()
164 with self.assertRaises(RuntimeError):
165 n in d
166
sweeneydec6dedde2020-02-09 03:16:43 -0500167 def test_contains_count_stop_crashes(self):
168 class A:
169 def __eq__(self, other):
170 d.clear()
171 return NotImplemented
172 d = deque([A(), A()])
173 with self.assertRaises(RuntimeError):
174 _ = 3 in d
175 d = deque([A(), A()])
176 with self.assertRaises(RuntimeError):
177 _ = d.count(3)
178
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000179 def test_extend(self):
180 d = deque('a')
181 self.assertRaises(TypeError, d.extend, 1)
182 d.extend('bcd')
183 self.assertEqual(list(d), list('abcd'))
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000184 d.extend(d)
185 self.assertEqual(list(d), list('abcdabcd'))
186
Raymond Hettinger41290a62015-03-31 08:12:23 -0700187 def test_add(self):
188 d = deque()
189 e = deque('abc')
190 f = deque('def')
191 self.assertEqual(d + d, deque())
192 self.assertEqual(e + f, deque('abcdef'))
193 self.assertEqual(e + e, deque('abcabc'))
194 self.assertEqual(e + d, deque('abc'))
195 self.assertEqual(d + e, deque('abc'))
196 self.assertIsNot(d + d, deque())
197 self.assertIsNot(e + d, deque('abc'))
198 self.assertIsNot(d + e, deque('abc'))
199
200 g = deque('abcdef', maxlen=4)
201 h = deque('gh')
202 self.assertEqual(g + h, deque('efgh'))
203
204 with self.assertRaises(TypeError):
205 deque('abc') + 'def'
206
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000207 def test_iadd(self):
208 d = deque('a')
209 d += 'bcd'
210 self.assertEqual(list(d), list('abcd'))
211 d += d
212 self.assertEqual(list(d), list('abcdabcd'))
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000213
214 def test_extendleft(self):
215 d = deque('a')
216 self.assertRaises(TypeError, d.extendleft, 1)
217 d.extendleft('bcd')
218 self.assertEqual(list(d), list(reversed('abcd')))
Raymond Hettinger3f9afd82009-12-10 03:03:02 +0000219 d.extendleft(d)
220 self.assertEqual(list(d), list('abcddcba'))
Raymond Hettingera435c532004-07-09 04:10:20 +0000221 d = deque()
222 d.extendleft(range(1000))
223 self.assertEqual(list(d), list(reversed(range(1000))))
224 self.assertRaises(SyntaxError, d.extendleft, fail())
Raymond Hettinger3ba85c22004-02-06 19:04:56 +0000225
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000226 def test_getitem(self):
227 n = 200
Guido van Rossum805365e2007-05-07 22:24:25 +0000228 d = deque(range(n))
229 l = list(range(n))
230 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000231 d.popleft()
232 l.pop(0)
233 if random.random() < 0.5:
234 d.append(i)
235 l.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000236 for j in range(1-len(l), len(l)):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000237 assert d[j] == l[j]
238
Raymond Hettinger738ec902004-02-29 02:15:56 +0000239 d = deque('superman')
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000240 self.assertEqual(d[0], 's')
241 self.assertEqual(d[-1], 'n')
Raymond Hettinger738ec902004-02-29 02:15:56 +0000242 d = deque()
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000243 self.assertRaises(IndexError, d.__getitem__, 0)
244 self.assertRaises(IndexError, d.__getitem__, -1)
245
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700246 def test_index(self):
247 for n in 1, 2, 30, 40, 200:
248
249 d = deque(range(n))
250 for i in range(n):
251 self.assertEqual(d.index(i), i)
252
253 with self.assertRaises(ValueError):
254 d.index(n+1)
255
256 # Test detection of mutation during iteration
257 d = deque(range(n))
258 d[n//2] = MutateCmp(d, False)
259 with self.assertRaises(RuntimeError):
260 d.index(n)
261
262 # Test detection of comparison exceptions
263 d = deque(range(n))
264 d[n//2] = BadCmp()
265 with self.assertRaises(RuntimeError):
266 d.index(n)
267
268 # Test start and stop arguments behavior matches list.index()
269 elements = 'ABCDEFGHI'
270 nonelement = 'Z'
271 d = deque(elements * 2)
272 s = list(elements * 2)
273 for start in range(-5 - len(s)*2, 5 + len(s) * 2):
274 for stop in range(-5 - len(s)*2, 5 + len(s) * 2):
275 for element in elements + 'Z':
276 try:
277 target = s.index(element, start, stop)
278 except ValueError:
279 with self.assertRaises(ValueError):
280 d.index(element, start, stop)
281 else:
282 self.assertEqual(d.index(element, start, stop), target)
283
Raymond Hettingerb46ad542018-09-21 01:46:41 -0700284 # Test large start argument
285 d = deque(range(0, 10000, 10))
286 for step in range(100):
287 i = d.index(8500, 700)
288 self.assertEqual(d[i], 8500)
289 # Repeat test with a different internal offset
290 d.rotate()
291
Raymond Hettinger906d82d2016-01-25 23:00:21 -0800292 def test_index_bug_24913(self):
Raymond Hettinger87674ec2015-08-26 08:08:38 -0700293 d = deque('A' * 3)
294 with self.assertRaises(ValueError):
295 i = d.index("Hello world", 0, 4)
296
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700297 def test_insert(self):
298 # Test to make sure insert behaves like lists
299 elements = 'ABCDEFGHI'
300 for i in range(-5 - len(elements)*2, 5 + len(elements) * 2):
301 d = deque('ABCDEFGHI')
302 s = list('ABCDEFGHI')
303 d.insert(i, 'Z')
304 s.insert(i, 'Z')
305 self.assertEqual(list(d), s)
306
Raymond Hettingera6389712016-02-01 21:21:19 -0800307 def test_insert_bug_26194(self):
Raymond Hettinger37434322016-01-26 21:44:16 -0800308 data = 'ABC'
Raymond Hettingera6389712016-02-01 21:21:19 -0800309 d = deque(data, maxlen=len(data))
310 with self.assertRaises(IndexError):
311 d.insert(2, None)
312
313 elements = 'ABCDEFGHI'
314 for i in range(-len(elements), len(elements)):
315 d = deque(elements, maxlen=len(elements)+1)
316 d.insert(i, 'Z')
317 if i >= 0:
318 self.assertEqual(d[i], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800319 else:
Raymond Hettingera6389712016-02-01 21:21:19 -0800320 self.assertEqual(d[i-1], 'Z')
Raymond Hettinger37434322016-01-26 21:44:16 -0800321
Raymond Hettinger41290a62015-03-31 08:12:23 -0700322 def test_imul(self):
323 for n in (-10, -1, 0, 1, 2, 10, 1000):
324 d = deque()
325 d *= n
326 self.assertEqual(d, deque())
327 self.assertIsNone(d.maxlen)
328
329 for n in (-10, -1, 0, 1, 2, 10, 1000):
330 d = deque('a')
331 d *= n
332 self.assertEqual(d, deque('a' * n))
333 self.assertIsNone(d.maxlen)
334
335 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
336 d = deque('a', 500)
337 d *= n
338 self.assertEqual(d, deque('a' * min(n, 500)))
339 self.assertEqual(d.maxlen, 500)
340
341 for n in (-10, -1, 0, 1, 2, 10, 1000):
342 d = deque('abcdef')
343 d *= n
344 self.assertEqual(d, deque('abcdef' * n))
345 self.assertIsNone(d.maxlen)
346
347 for n in (-10, -1, 0, 1, 2, 10, 499, 500, 501, 1000):
348 d = deque('abcdef', 500)
349 d *= n
350 self.assertEqual(d, deque(('abcdef' * n)[-500:]))
351 self.assertEqual(d.maxlen, 500)
352
353 def test_mul(self):
354 d = deque('abc')
355 self.assertEqual(d * -5, deque())
356 self.assertEqual(d * 0, deque())
357 self.assertEqual(d * 1, deque('abc'))
358 self.assertEqual(d * 2, deque('abcabc'))
359 self.assertEqual(d * 3, deque('abcabcabc'))
360 self.assertIsNot(d * 1, d)
361
362 self.assertEqual(deque() * 0, deque())
363 self.assertEqual(deque() * 1, deque())
364 self.assertEqual(deque() * 5, deque())
365
366 self.assertEqual(-5 * d, deque())
367 self.assertEqual(0 * d, deque())
368 self.assertEqual(1 * d, deque('abc'))
369 self.assertEqual(2 * d, deque('abcabc'))
370 self.assertEqual(3 * d, deque('abcabcabc'))
371
372 d = deque('abc', maxlen=5)
373 self.assertEqual(d * -5, deque())
374 self.assertEqual(d * 0, deque())
375 self.assertEqual(d * 1, deque('abc'))
376 self.assertEqual(d * 2, deque('bcabc'))
377 self.assertEqual(d * 30, deque('bcabc'))
378
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000379 def test_setitem(self):
380 n = 200
Guido van Rossum805365e2007-05-07 22:24:25 +0000381 d = deque(range(n))
382 for i in range(n):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000383 d[i] = 10 * i
Guido van Rossum805365e2007-05-07 22:24:25 +0000384 self.assertEqual(list(d), [10*i for i in range(n)])
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000385 l = list(d)
Guido van Rossum805365e2007-05-07 22:24:25 +0000386 for i in range(1-n, 0, -1):
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000387 d[i] = 7*i
388 l[i] = 7*i
389 self.assertEqual(list(d), l)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000390
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000391 def test_delitem(self):
392 n = 500 # O(n**2) test, don't make this too big
Guido van Rossum805365e2007-05-07 22:24:25 +0000393 d = deque(range(n))
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000394 self.assertRaises(IndexError, d.__delitem__, -n-1)
395 self.assertRaises(IndexError, d.__delitem__, n)
Guido van Rossum805365e2007-05-07 22:24:25 +0000396 for i in range(n):
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000397 self.assertEqual(len(d), n-i)
398 j = random.randrange(-len(d), len(d))
399 val = d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000400 self.assertIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000401 del d[j]
Benjamin Peterson577473f2010-01-19 00:09:57 +0000402 self.assertNotIn(val, d)
Raymond Hettinger0e371f22004-05-12 20:55:56 +0000403 self.assertEqual(len(d), 0)
404
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000405 def test_reverse(self):
406 n = 500 # O(n**2) test, don't make this too big
407 data = [random.random() for i in range(n)]
408 for i in range(n):
409 d = deque(data[:i])
410 r = d.reverse()
411 self.assertEqual(list(d), list(reversed(data[:i])))
Ezio Melottib3aedd42010-11-20 19:04:17 +0000412 self.assertIs(r, None)
Raymond Hettingere5fdedb2009-12-10 00:47:21 +0000413 d.reverse()
414 self.assertEqual(list(d), data[:i])
415 self.assertRaises(TypeError, d.reverse, 1) # Arity is zero
416
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000417 def test_rotate(self):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000418 s = tuple('abcde')
419 n = len(s)
420
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000421 d = deque(s)
Raymond Hettingeree33b272004-02-08 04:05:26 +0000422 d.rotate(1) # verify rot(1)
423 self.assertEqual(''.join(d), 'eabcd')
424
425 d = deque(s)
426 d.rotate(-1) # verify rot(-1)
427 self.assertEqual(''.join(d), 'bcdea')
428 d.rotate() # check default to 1
429 self.assertEqual(tuple(d), s)
430
Guido van Rossum805365e2007-05-07 22:24:25 +0000431 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000432 d = deque(s)
433 e = deque(d)
434 d.rotate(i) # check vs. rot(1) n times
Guido van Rossum805365e2007-05-07 22:24:25 +0000435 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000436 e.rotate(1)
437 self.assertEqual(tuple(d), tuple(e))
438 d.rotate(-i) # check that it works in reverse
439 self.assertEqual(tuple(d), s)
440 e.rotate(n-i) # check that it wraps forward
441 self.assertEqual(tuple(e), s)
442
Guido van Rossum805365e2007-05-07 22:24:25 +0000443 for i in range(n*3):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000444 d = deque(s)
445 e = deque(d)
446 d.rotate(-i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000447 for j in range(i):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000448 e.rotate(-1) # check vs. rot(-1) n times
449 self.assertEqual(tuple(d), tuple(e))
450 d.rotate(i) # check that it works in reverse
451 self.assertEqual(tuple(d), s)
452 e.rotate(i-n) # check that it wraps backaround
453 self.assertEqual(tuple(e), s)
454
455 d = deque(s)
456 e = deque(s)
457 e.rotate(BIG+17) # verify on long series of rotates
458 dr = d.rotate
Guido van Rossum805365e2007-05-07 22:24:25 +0000459 for i in range(BIG+17):
Raymond Hettingeree33b272004-02-08 04:05:26 +0000460 dr()
461 self.assertEqual(tuple(d), tuple(e))
Raymond Hettinger5c5eb862004-02-07 21:13:00 +0000462
Raymond Hettingera435c532004-07-09 04:10:20 +0000463 self.assertRaises(TypeError, d.rotate, 'x') # Wrong arg type
464 self.assertRaises(TypeError, d.rotate, 1, 10) # Too many args
465
466 d = deque()
467 d.rotate() # rotate an empty deque
468 self.assertEqual(d, deque())
469
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000470 def test_len(self):
471 d = deque('ab')
472 self.assertEqual(len(d), 2)
473 d.popleft()
474 self.assertEqual(len(d), 1)
475 d.pop()
476 self.assertEqual(len(d), 0)
Raymond Hettinger738ec902004-02-29 02:15:56 +0000477 self.assertRaises(IndexError, d.pop)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000478 self.assertEqual(len(d), 0)
479 d.append('c')
480 self.assertEqual(len(d), 1)
481 d.appendleft('d')
482 self.assertEqual(len(d), 2)
483 d.clear()
484 self.assertEqual(len(d), 0)
485
486 def test_underflow(self):
487 d = deque()
Raymond Hettinger738ec902004-02-29 02:15:56 +0000488 self.assertRaises(IndexError, d.pop)
489 self.assertRaises(IndexError, d.popleft)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000490
491 def test_clear(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000492 d = deque(range(100))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000493 self.assertEqual(len(d), 100)
494 d.clear()
495 self.assertEqual(len(d), 0)
496 self.assertEqual(list(d), [])
Martin Pantereb995702016-07-28 01:11:04 +0000497 d.clear() # clear an empty deque
Raymond Hettingera435c532004-07-09 04:10:20 +0000498 self.assertEqual(list(d), [])
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000499
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000500 def test_remove(self):
501 d = deque('abcdefghcij')
502 d.remove('c')
503 self.assertEqual(d, deque('abdefghcij'))
504 d.remove('c')
505 self.assertEqual(d, deque('abdefghij'))
506 self.assertRaises(ValueError, d.remove, 'c')
507 self.assertEqual(d, deque('abdefghij'))
508
Walter Dörwaldc448a912005-03-22 11:22:38 +0000509 # Handle comparison errors
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000510 d = deque(['a', 'b', BadCmp(), 'c'])
511 e = deque(d)
512 self.assertRaises(RuntimeError, d.remove, 'c')
513 for x, y in zip(d, e):
514 # verify that original order and values are retained.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000515 self.assertTrue(x is y)
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000516
517 # Handle evil mutator
Raymond Hettingerd73202c2005-03-19 00:00:51 +0000518 for match in (True, False):
519 d = deque(['ab'])
520 d.extend([MutateCmp(d, match), 'c'])
521 self.assertRaises(IndexError, d.remove, 'c')
522 self.assertEqual(d, deque())
Raymond Hettinger4aec61e2005-03-18 21:20:23 +0000523
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000524 def test_repr(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000525 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000526 e = eval(repr(d))
527 self.assertEqual(list(d), list(e))
528 d.append(d)
Serhiy Storchakaf9bab742020-06-21 11:11:17 +0300529 self.assertEqual(repr(d)[-20:], '7, 198, 199, [...]])')
Raymond Hettingera435c532004-07-09 04:10:20 +0000530
531 def test_init(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000532 self.assertRaises(TypeError, deque, 'abc', 2, 3);
Raymond Hettingera435c532004-07-09 04:10:20 +0000533 self.assertRaises(TypeError, deque, 1);
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000534
535 def test_hash(self):
536 self.assertRaises(TypeError, hash, deque('abc'))
537
538 def test_long_steadystate_queue_popleft(self):
539 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000540 d = deque(range(size))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000541 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000542 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000543 append(i)
544 x = pop()
545 if x != i - size:
546 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000547 self.assertEqual(list(d), list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000548
549 def test_long_steadystate_queue_popright(self):
550 for size in (0, 1, 2, 100, 1000):
Guido van Rossum805365e2007-05-07 22:24:25 +0000551 d = deque(reversed(range(size)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000552 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000553 for i in range(size, BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000554 append(i)
555 x = pop()
556 if x != i - size:
557 self.assertEqual(x, i-size)
Guido van Rossum805365e2007-05-07 22:24:25 +0000558 self.assertEqual(list(reversed(list(d))),
559 list(range(BIG-size, BIG)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000560
561 def test_big_queue_popleft(self):
562 pass
563 d = deque()
564 append, pop = d.append, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000565 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000566 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000567 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000568 x = pop()
569 if x != i:
570 self.assertEqual(x, i)
571
572 def test_big_queue_popright(self):
573 d = deque()
574 append, pop = d.appendleft, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000575 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000576 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000577 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000578 x = pop()
579 if x != i:
580 self.assertEqual(x, i)
581
582 def test_big_stack_right(self):
583 d = deque()
584 append, pop = d.append, d.pop
Guido van Rossum805365e2007-05-07 22:24:25 +0000585 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000586 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000587 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000588 x = pop()
589 if x != i:
590 self.assertEqual(x, i)
591 self.assertEqual(len(d), 0)
592
593 def test_big_stack_left(self):
594 d = deque()
595 append, pop = d.appendleft, d.popleft
Guido van Rossum805365e2007-05-07 22:24:25 +0000596 for i in range(BIG):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000597 append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000598 for i in reversed(range(BIG)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000599 x = pop()
600 if x != i:
601 self.assertEqual(x, i)
602 self.assertEqual(len(d), 0)
603
604 def test_roundtrip_iter_init(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000605 d = deque(range(200))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000606 e = deque(d)
607 self.assertNotEqual(id(d), id(e))
608 self.assertEqual(list(d), list(e))
609
610 def test_pickle(self):
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200611 for d in deque(range(200)), deque(range(200), 100):
612 for i in range(pickle.HIGHEST_PROTOCOL + 1):
613 s = pickle.dumps(d, i)
614 e = pickle.loads(s)
615 self.assertNotEqual(id(e), id(d))
616 self.assertEqual(list(e), list(d))
617 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000618
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200619 def test_pickle_recursive(self):
620 for d in deque('abc'), deque('abc', 3):
621 d.append(d)
622 for i in range(pickle.HIGHEST_PROTOCOL + 1):
623 e = pickle.loads(pickle.dumps(d, i))
624 self.assertNotEqual(id(e), id(d))
625 self.assertEqual(id(e[-1]), id(e))
626 self.assertEqual(e.maxlen, d.maxlen)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000627
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000628 def test_iterator_pickle(self):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200629 orig = deque(range(200))
630 data = [i*1.01 for i in orig]
Serhiy Storchakabad12572014-12-15 14:03:42 +0200631 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200632 # initial iterator
633 itorg = iter(orig)
634 dump = pickle.dumps((itorg, orig), proto)
635 it, d = pickle.loads(dump)
636 for i, x in enumerate(data):
637 d[i] = x
638 self.assertEqual(type(it), type(itorg))
639 self.assertEqual(list(it), data)
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000640
Serhiy Storchakaaabafe72016-03-06 14:10:24 +0200641 # running iterator
642 next(itorg)
643 dump = pickle.dumps((itorg, orig), proto)
644 it, d = pickle.loads(dump)
645 for i, x in enumerate(data):
646 d[i] = x
647 self.assertEqual(type(it), type(itorg))
648 self.assertEqual(list(it), data[1:])
649
650 # empty iterator
651 for i in range(1, len(data)):
652 next(itorg)
653 dump = pickle.dumps((itorg, orig), proto)
654 it, d = pickle.loads(dump)
655 for i, x in enumerate(data):
656 d[i] = x
657 self.assertEqual(type(it), type(itorg))
658 self.assertEqual(list(it), [])
659
660 # exhausted iterator
661 self.assertRaises(StopIteration, next, itorg)
662 dump = pickle.dumps((itorg, orig), proto)
663 it, d = pickle.loads(dump)
664 for i, x in enumerate(data):
665 d[i] = x
666 self.assertEqual(type(it), type(itorg))
667 self.assertEqual(list(it), [])
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000668
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000669 def test_deepcopy(self):
670 mut = [10]
671 d = deque([mut])
672 e = copy.deepcopy(d)
673 self.assertEqual(list(d), list(e))
674 mut[0] = 11
675 self.assertNotEqual(id(d), id(e))
676 self.assertNotEqual(list(d), list(e))
677
678 def test_copy(self):
679 mut = [10]
680 d = deque([mut])
681 e = copy.copy(d)
682 self.assertEqual(list(d), list(e))
683 mut[0] = 11
684 self.assertNotEqual(id(d), id(e))
685 self.assertEqual(list(d), list(e))
686
Raymond Hettingeraed88302015-09-19 09:05:42 -0700687 for i in range(5):
688 for maxlen in range(-1, 6):
689 s = [random.random() for j in range(i)]
690 d = deque(s) if maxlen == -1 else deque(s, maxlen)
691 e = d.copy()
692 self.assertEqual(d, e)
693 self.assertEqual(d.maxlen, e.maxlen)
694 self.assertTrue(all(x is y for x, y in zip(d, e)))
695
Raymond Hettinger32ea1652015-03-21 01:37:37 -0700696 def test_copy_method(self):
697 mut = [10]
698 d = deque([mut])
699 e = d.copy()
700 self.assertEqual(list(d), list(e))
701 mut[0] = 11
702 self.assertNotEqual(id(d), id(e))
703 self.assertEqual(list(d), list(e))
704
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000705 def test_reversed(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000706 for s in ('abcd', range(2000)):
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000707 self.assertEqual(list(reversed(deque(s))), list(reversed(s)))
708
Raymond Hettingerbadf5d82014-06-14 20:41:22 -0700709 def test_reversed_new(self):
710 klass = type(reversed(deque()))
711 for s in ('abcd', range(2000)):
712 self.assertEqual(list(klass(deque(s))), list(reversed(s)))
713
Tim Peters10c7e862004-10-01 02:01:04 +0000714 def test_gc_doesnt_blowup(self):
715 import gc
716 # This used to assert-fail in deque_traverse() under a debug
717 # build, or run wild with a NULL pointer in a release build.
718 d = deque()
Guido van Rossum805365e2007-05-07 22:24:25 +0000719 for i in range(100):
Tim Peters10c7e862004-10-01 02:01:04 +0000720 d.append(1)
721 gc.collect()
722
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000723 def test_container_iterator(self):
724 # Bug #3680: tp_traverse was not implemented for deque iterator objects
725 class C(object):
726 pass
727 for i in range(2):
728 obj = C()
729 ref = weakref.ref(obj)
730 if i == 0:
731 container = deque([obj, 1])
732 else:
733 container = reversed(deque([obj, 1]))
734 obj.x = iter(container)
735 del obj, container
736 gc.collect()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000737 self.assertTrue(ref() is None, "Cycle was not collected")
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000738
Jesus Cea16e2fca2012-08-03 14:49:42 +0200739 check_sizeof = support.check_sizeof
740
741 @support.cpython_only
742 def test_sizeof(self):
Raymond Hettingerdaf57f22015-02-26 23:21:29 -0800743 BLOCKLEN = 64
Serhiy Storchakae23c90c2016-05-18 13:00:56 +0300744 basesize = support.calcvobjsize('2P4nP')
745 blocksize = struct.calcsize('P%dPP' % BLOCKLEN)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200746 self.assertEqual(object.__sizeof__(deque()), basesize)
747 check = self.check_sizeof
748 check(deque(), basesize + blocksize)
749 check(deque('a'), basesize + blocksize)
Raymond Hettingerd9c116c2013-07-09 00:13:21 -0700750 check(deque('a' * (BLOCKLEN - 1)), basesize + blocksize)
751 check(deque('a' * BLOCKLEN), basesize + 2 * blocksize)
Jesus Cea16e2fca2012-08-03 14:49:42 +0200752 check(deque('a' * (42 * BLOCKLEN)), basesize + 43 * blocksize)
753
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000754class TestVariousIteratorArgs(unittest.TestCase):
755
756 def test_constructor(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000757 for s in ("123", "", range(1000), ('do', 1.2), range(2000,2200,5)):
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000758 for g in (seq_tests.Sequence, seq_tests.IterFunc,
759 seq_tests.IterGen, seq_tests.IterFuncStop,
760 seq_tests.itermulti, seq_tests.iterfunc):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000761 self.assertEqual(list(deque(g(s))), list(g(s)))
Walter Dörwald09a3f2c2005-03-22 22:43:28 +0000762 self.assertRaises(TypeError, deque, seq_tests.IterNextOnly(s))
763 self.assertRaises(TypeError, deque, seq_tests.IterNoNext(s))
764 self.assertRaises(ZeroDivisionError, deque, seq_tests.IterGenExc(s))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000765
766 def test_iter_with_altered_data(self):
767 d = deque('abcdefg')
768 it = iter(d)
769 d.pop()
Georg Brandla18af4e2007-04-21 15:47:16 +0000770 self.assertRaises(RuntimeError, next, it)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000771
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000772 def test_runtime_error_on_empty_deque(self):
773 d = deque()
774 it = iter(d)
775 d.append(10)
Georg Brandla18af4e2007-04-21 15:47:16 +0000776 self.assertRaises(RuntimeError, next, it)
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000777
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000778class Deque(deque):
779 pass
780
Raymond Hettinger952f8802004-11-09 07:27:35 +0000781class DequeWithBadIter(deque):
782 def __iter__(self):
783 raise TypeError
784
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000785class TestSubclass(unittest.TestCase):
786
787 def test_basics(self):
Christian Heimes38053212007-12-14 01:24:44 +0000788 d = Deque(range(25))
789 d.__init__(range(200))
Guido van Rossum805365e2007-05-07 22:24:25 +0000790 for i in range(200, 400):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000791 d.append(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000792 for i in reversed(range(-200, 0)):
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000793 d.appendleft(i)
Guido van Rossum805365e2007-05-07 22:24:25 +0000794 self.assertEqual(list(d), list(range(-200, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000795 self.assertEqual(len(d), 600)
796
Guido van Rossum805365e2007-05-07 22:24:25 +0000797 left = [d.popleft() for i in range(250)]
798 self.assertEqual(left, list(range(-200, 50)))
799 self.assertEqual(list(d), list(range(50, 400)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000800
Guido van Rossum805365e2007-05-07 22:24:25 +0000801 right = [d.pop() for i in range(250)]
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000802 right.reverse()
Guido van Rossum805365e2007-05-07 22:24:25 +0000803 self.assertEqual(right, list(range(150, 400)))
804 self.assertEqual(list(d), list(range(50, 150)))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000805
806 d.clear()
807 self.assertEqual(len(d), 0)
808
809 def test_copy_pickle(self):
810
811 d = Deque('abc')
812
813 e = d.__copy__()
814 self.assertEqual(type(d), type(e))
815 self.assertEqual(list(d), list(e))
816
817 e = Deque(d)
818 self.assertEqual(type(d), type(e))
819 self.assertEqual(list(d), list(e))
820
Serhiy Storchakabad12572014-12-15 14:03:42 +0200821 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
822 s = pickle.dumps(d, proto)
823 e = pickle.loads(s)
824 self.assertNotEqual(id(d), id(e))
825 self.assertEqual(type(d), type(e))
826 self.assertEqual(list(d), list(e))
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000827
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000828 d = Deque('abcde', maxlen=4)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000829
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000830 e = d.__copy__()
831 self.assertEqual(type(d), type(e))
832 self.assertEqual(list(d), list(e))
833
834 e = Deque(d)
835 self.assertEqual(type(d), type(e))
836 self.assertEqual(list(d), list(e))
837
Serhiy Storchakabad12572014-12-15 14:03:42 +0200838 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
839 s = pickle.dumps(d, proto)
840 e = pickle.loads(s)
841 self.assertNotEqual(id(d), id(e))
842 self.assertEqual(type(d), type(e))
843 self.assertEqual(list(d), list(e))
Raymond Hettinger952f8802004-11-09 07:27:35 +0000844
Serhiy Storchakaa0d416f2016-03-06 08:55:21 +0200845 def test_pickle_recursive(self):
846 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
847 for d in Deque('abc'), Deque('abc', 3):
848 d.append(d)
849
850 e = pickle.loads(pickle.dumps(d, proto))
851 self.assertNotEqual(id(e), id(d))
852 self.assertEqual(type(e), type(d))
853 self.assertEqual(e.maxlen, d.maxlen)
854 dd = d.pop()
855 ee = e.pop()
856 self.assertEqual(id(ee), id(e))
857 self.assertEqual(e, d)
858
859 d.x = d
860 e = pickle.loads(pickle.dumps(d, proto))
861 self.assertEqual(id(e.x), id(e))
862
863 for d in DequeWithBadIter('abc'), DequeWithBadIter('abc', 2):
864 self.assertRaises(TypeError, pickle.dumps, d, proto)
Raymond Hettinger952f8802004-11-09 07:27:35 +0000865
Raymond Hettinger691d8052004-05-30 07:26:47 +0000866 def test_weakref(self):
867 d = deque('gallahad')
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000868 p = weakref.proxy(d)
Raymond Hettinger691d8052004-05-30 07:26:47 +0000869 self.assertEqual(str(p), str(d))
870 d = None
871 self.assertRaises(ReferenceError, str, p)
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000872
Armin Rigo974d7572004-10-02 13:59:34 +0000873 def test_strange_subclass(self):
874 class X(deque):
875 def __iter__(self):
876 return iter([])
877 d1 = X([1,2,3])
878 d2 = X([4,5,6])
879 d1 == d2 # not clear if this is supposed to be True or False,
880 # but it used to give a SystemError
881
Oren Milman24bd50b2018-09-11 21:46:55 +0300882 @support.cpython_only
883 def test_bug_31608(self):
884 # The interpreter used to crash in specific cases where a deque
885 # subclass returned a non-deque.
886 class X(deque):
887 pass
888 d = X()
889 def bad___new__(cls, *args, **kwargs):
890 return [42]
891 X.__new__ = bad___new__
892 with self.assertRaises(TypeError):
893 d * 42 # shouldn't crash
894 with self.assertRaises(TypeError):
895 d + deque([1, 2, 3]) # shouldn't crash
896
Thomas Woutersb2137042007-02-01 18:02:27 +0000897
898class SubclassWithKwargs(deque):
899 def __init__(self, newarg=1):
900 deque.__init__(self)
901
902class TestSubclassWithKwargs(unittest.TestCase):
903 def test_subclass_with_kwargs(self):
904 # SF bug #1486663 -- this used to erroneously raise a TypeError
905 SubclassWithKwargs(newarg=1)
906
Raymond Hettinger067bbba2015-04-01 08:11:09 -0700907class TestSequence(seq_tests.CommonTest):
908 type2test = deque
909
910 def test_getitem(self):
911 # For now, bypass tests that require slicing
912 pass
913
914 def test_getslice(self):
915 # For now, bypass tests that require slicing
916 pass
917
918 def test_subscript(self):
919 # For now, bypass tests that require slicing
920 pass
921
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +0300922 def test_free_after_iterating(self):
923 # For now, bypass tests that require slicing
924 self.skipTest("Exhausted deque iterator doesn't free a deque")
925
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000926#==============================================================================
927
Raymond Hettinger738ec902004-02-29 02:15:56 +0000928libreftest = """
929Example from the Library Reference: Doc/lib/libcollections.tex
930
931>>> from collections import deque
932>>> d = deque('ghi') # make a new deque with three items
933>>> for elem in d: # iterate over the deque's elements
Guido van Rossum7131f842007-02-09 20:13:25 +0000934... print(elem.upper())
Raymond Hettinger738ec902004-02-29 02:15:56 +0000935G
936H
937I
938>>> d.append('j') # add a new entry to the right side
939>>> d.appendleft('f') # add a new entry to the left side
940>>> d # show the representation of the deque
941deque(['f', 'g', 'h', 'i', 'j'])
942>>> d.pop() # return and remove the rightmost item
943'j'
944>>> d.popleft() # return and remove the leftmost item
945'f'
946>>> list(d) # list the contents of the deque
947['g', 'h', 'i']
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000948>>> d[0] # peek at leftmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000949'g'
Raymond Hettinger0a4977c2004-03-01 23:16:22 +0000950>>> d[-1] # peek at rightmost item
Raymond Hettinger738ec902004-02-29 02:15:56 +0000951'i'
952>>> list(reversed(d)) # list the contents of a deque in reverse
953['i', 'h', 'g']
954>>> 'h' in d # search the deque
955True
956>>> d.extend('jkl') # add multiple elements at once
957>>> d
958deque(['g', 'h', 'i', 'j', 'k', 'l'])
959>>> d.rotate(1) # right rotation
960>>> d
961deque(['l', 'g', 'h', 'i', 'j', 'k'])
962>>> d.rotate(-1) # left rotation
963>>> d
964deque(['g', 'h', 'i', 'j', 'k', 'l'])
965>>> deque(reversed(d)) # make a new deque in reverse order
966deque(['l', 'k', 'j', 'i', 'h', 'g'])
967>>> d.clear() # empty the deque
968>>> d.pop() # cannot pop from an empty deque
969Traceback (most recent call last):
970 File "<pyshell#6>", line 1, in -toplevel-
971 d.pop()
972IndexError: pop from an empty deque
973
974>>> d.extendleft('abc') # extendleft() reverses the input order
975>>> d
976deque(['c', 'b', 'a'])
977
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000978
979
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000980>>> def delete_nth(d, n):
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000981... d.rotate(-n)
982... d.popleft()
983... d.rotate(n)
984...
985>>> d = deque('abcdef')
986>>> delete_nth(d, 2) # remove the entry at d[2]
987>>> d
988deque(['a', 'b', 'd', 'e', 'f'])
989
990
991
992>>> def roundrobin(*iterables):
993... pending = deque(iter(i) for i in iterables)
994... while pending:
995... task = pending.popleft()
996... try:
Georg Brandla18af4e2007-04-21 15:47:16 +0000997... yield next(task)
Raymond Hettingere7169eb2004-05-09 01:15:01 +0000998... except StopIteration:
999... continue
1000... pending.append(task)
1001...
1002
1003>>> for value in roundrobin('abc', 'd', 'efgh'):
Guido van Rossum7131f842007-02-09 20:13:25 +00001004... print(value)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001005...
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001006a
1007d
1008e
1009b
1010f
1011c
1012g
1013h
1014
1015
1016>>> def maketree(iterable):
1017... d = deque(iterable)
1018... while len(d) > 1:
1019... pair = [d.popleft(), d.popleft()]
1020... d.append(pair)
1021... return list(d)
1022...
Guido van Rossum7131f842007-02-09 20:13:25 +00001023>>> print(maketree('abcdefgh'))
Raymond Hettingere7169eb2004-05-09 01:15:01 +00001024[[[['a', 'b'], ['c', 'd']], [['e', 'f'], ['g', 'h']]]]
1025
Raymond Hettinger738ec902004-02-29 02:15:56 +00001026"""
1027
1028
1029#==============================================================================
1030
1031__test__ = {'libreftest' : libreftest}
1032
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001033def test_main(verbose=None):
1034 import sys
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001035 test_classes = (
1036 TestBasic,
1037 TestVariousIteratorArgs,
1038 TestSubclass,
Thomas Woutersb2137042007-02-01 18:02:27 +00001039 TestSubclassWithKwargs,
Raymond Hettinger067bbba2015-04-01 08:11:09 -07001040 TestSequence,
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001041 )
1042
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001043 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001044
1045 # verify reference counting
1046 if verbose and hasattr(sys, "gettotalrefcount"):
1047 import gc
1048 counts = [None] * 5
Guido van Rossum805365e2007-05-07 22:24:25 +00001049 for i in range(len(counts)):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001050 support.run_unittest(*test_classes)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001051 gc.collect()
1052 counts[i] = sys.gettotalrefcount()
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001053 print(counts)
Raymond Hettinger0a4977c2004-03-01 23:16:22 +00001054
Raymond Hettinger738ec902004-02-29 02:15:56 +00001055 # doctests
1056 from test import test_deque
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001057 support.run_doctest(test_deque, verbose)
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001058
1059if __name__ == "__main__":
1060 test_main(verbose=True)