test_deque.py 25.4 KB
Newer Older
1 2
from collections import deque
import unittest
3
from test import support, seq_tests
4 5
import gc
import weakref
6
import copy
7
import pickle
8
from io import StringIO
9
import random
10
import struct
11 12 13

BIG = 100000

14 15 16 17
def fail():
    raise SyntaxError
    yield 1

18 19 20 21 22
class BadCmp:
    def __eq__(self, other):
        raise RuntimeError

class MutateCmp:
23
    def __init__(self, deque, result):
24
        self.deque = deque
25
        self.result = result
26 27
    def __eq__(self, other):
        self.deque.clear()
28
        return self.result
29

30 31 32
class TestBasic(unittest.TestCase):

    def test_basics(self):
33 34
        d = deque(range(-5125, -5000))
        d.__init__(range(200))
35
        for i in range(200, 400):
36
            d.append(i)
37
        for i in reversed(range(-200, 0)):
38
            d.appendleft(i)
39
        self.assertEqual(list(d), list(range(-200, 400)))
40 41
        self.assertEqual(len(d), 600)

42 43 44
        left = [d.popleft() for i in range(250)]
        self.assertEqual(left, list(range(-200, 50)))
        self.assertEqual(list(d), list(range(50, 400)))
45

46
        right = [d.pop() for i in range(250)]
47
        right.reverse()
48 49
        self.assertEqual(right, list(range(150, 400)))
        self.assertEqual(list(d), list(range(50, 150)))
50

51 52 53
    def test_maxlen(self):
        self.assertRaises(ValueError, deque, 'abc', -1)
        self.assertRaises(ValueError, deque, 'abc', -2)
54 55 56
        it = iter(range(10))
        d = deque(it, maxlen=3)
        self.assertEqual(list(it), [])
57 58 59 60 61 62 63 64 65 66 67 68 69
        self.assertEqual(repr(d), 'deque([7, 8, 9], maxlen=3)')
        self.assertEqual(list(d), [7, 8, 9])
        self.assertEqual(d, deque(range(10), 3))
        d.append(10)
        self.assertEqual(list(d), [8, 9, 10])
        d.appendleft(7)
        self.assertEqual(list(d), [7, 8, 9])
        d.extend([10, 11])
        self.assertEqual(list(d), [9, 10, 11])
        d.extendleft([8, 7])
        self.assertEqual(list(d), [7, 8, 9])
        d = deque(range(200), maxlen=10)
        d.append(d)
70 71
        support.unlink(support.TESTFN)
        fo = open(support.TESTFN, "w")
Christian Heimes's avatar
Christian Heimes committed
72 73 74
        try:
            fo.write(str(d))
            fo.close()
75
            fo = open(support.TESTFN, "r")
Christian Heimes's avatar
Christian Heimes committed
76 77 78
            self.assertEqual(fo.read(), repr(d))
        finally:
            fo.close()
79
            support.unlink(support.TESTFN)
Christian Heimes's avatar
Christian Heimes committed
80

81 82
        d = deque(range(10), maxlen=None)
        self.assertEqual(repr(d), 'deque([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])')
83
        fo = open(support.TESTFN, "w")
Christian Heimes's avatar
Christian Heimes committed
84 85 86
        try:
            fo.write(str(d))
            fo.close()
87
            fo = open(support.TESTFN, "r")
Christian Heimes's avatar
Christian Heimes committed
88 89 90
            self.assertEqual(fo.read(), repr(d))
        finally:
            fo.close()
91
            support.unlink(support.TESTFN)
92

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
    def test_maxlen_zero(self):
        it = iter(range(100))
        deque(it, maxlen=0)
        self.assertEqual(list(it), [])

        it = iter(range(100))
        d = deque(maxlen=0)
        d.extend(it)
        self.assertEqual(list(it), [])

        it = iter(range(100))
        d = deque(maxlen=0)
        d.extendleft(it)
        self.assertEqual(list(it), [])

108 109 110 111 112 113 114 115 116 117
    def test_maxlen_attribute(self):
        self.assertEqual(deque().maxlen, None)
        self.assertEqual(deque('abc').maxlen, None)
        self.assertEqual(deque('abc', maxlen=4).maxlen, 4)
        self.assertEqual(deque('abc', maxlen=2).maxlen, 2)
        self.assertEqual(deque('abc', maxlen=0).maxlen, 0)
        with self.assertRaises(AttributeError):
            d = deque('abc')
            d.maxlen = 10

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
    def test_count(self):
        for s in ('', 'abracadabra', 'simsalabim'*500+'abc'):
            s = list(s)
            d = deque(s)
            for letter in 'abcdefghijklmnopqrstuvwxyz':
                self.assertEqual(s.count(letter), d.count(letter), (s, d, letter))
        self.assertRaises(TypeError, d.count)       # too few args
        self.assertRaises(TypeError, d.count, 1, 2) # too many args
        class BadCompare:
            def __eq__(self, other):
                raise ArithmeticError
        d = deque([1, 2, BadCompare(), 3])
        self.assertRaises(ArithmeticError, d.count, 2)
        d = deque([1, 2, 3])
        self.assertRaises(ArithmeticError, d.count, BadCompare())
        class MutatingCompare:
            def __eq__(self, other):
                self.d.pop()
                return True
        m = MutatingCompare()
        d = deque([1, 2, 3, m, 4, 5])
        m.d = d
        self.assertRaises(RuntimeError, d.count, 3)

142 143 144 145 146 147 148 149 150
        # test issue11004
        # block advance failed after rotation aligned elements on right side of block
        d = deque([None]*16)
        for i in range(len(d)):
            d.rotate(-1)
        d.rotate(1)
        self.assertEqual(d.count(1), 0)
        self.assertEqual(d.count(None), 16)

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
    def test_comparisons(self):
        d = deque('xabc'); d.popleft()
        for e in [d, deque('abc'), deque('ab'), deque(), list(d)]:
            self.assertEqual(d==e, type(d)==type(e) and list(d)==list(e))
            self.assertEqual(d!=e, not(type(d)==type(e) and list(d)==list(e)))

        args = map(deque, ('', 'a', 'b', 'ab', 'ba', 'abc', 'xba', 'xabc', 'cba'))
        for x in args:
            for y in args:
                self.assertEqual(x == y, list(x) == list(y), (x,y))
                self.assertEqual(x != y, list(x) != list(y), (x,y))
                self.assertEqual(x <  y, list(x) <  list(y), (x,y))
                self.assertEqual(x <= y, list(x) <= list(y), (x,y))
                self.assertEqual(x >  y, list(x) >  list(y), (x,y))
                self.assertEqual(x >= y, list(x) >= list(y), (x,y))

167 168 169 170 171
    def test_extend(self):
        d = deque('a')
        self.assertRaises(TypeError, d.extend, 1)
        d.extend('bcd')
        self.assertEqual(list(d), list('abcd'))
172 173 174 175 176 177 178 179 180
        d.extend(d)
        self.assertEqual(list(d), list('abcdabcd'))

    def test_iadd(self):
        d = deque('a')
        d += 'bcd'
        self.assertEqual(list(d), list('abcd'))
        d += d
        self.assertEqual(list(d), list('abcdabcd'))
181 182 183 184 185 186

    def test_extendleft(self):
        d = deque('a')
        self.assertRaises(TypeError, d.extendleft, 1)
        d.extendleft('bcd')
        self.assertEqual(list(d), list(reversed('abcd')))
187 188
        d.extendleft(d)
        self.assertEqual(list(d), list('abcddcba'))
189 190 191 192
        d = deque()
        d.extendleft(range(1000))
        self.assertEqual(list(d), list(reversed(range(1000))))
        self.assertRaises(SyntaxError, d.extendleft, fail())
193

194 195
    def test_getitem(self):
        n = 200
196 197 198
        d = deque(range(n))
        l = list(range(n))
        for i in range(n):
199 200 201 202 203
            d.popleft()
            l.pop(0)
            if random.random() < 0.5:
                d.append(i)
                l.append(i)
204
            for j in range(1-len(l), len(l)):
205 206
                assert d[j] == l[j]

207
        d = deque('superman')
208 209
        self.assertEqual(d[0], 's')
        self.assertEqual(d[-1], 'n')
210
        d = deque()
211 212 213 214 215
        self.assertRaises(IndexError, d.__getitem__, 0)
        self.assertRaises(IndexError, d.__getitem__, -1)

    def test_setitem(self):
        n = 200
216 217
        d = deque(range(n))
        for i in range(n):
218
            d[i] = 10 * i
219
        self.assertEqual(list(d), [10*i for i in range(n)])
220
        l = list(d)
221
        for i in range(1-n, 0, -1):
222 223 224
            d[i] = 7*i
            l[i] = 7*i
        self.assertEqual(list(d), l)
225

226 227
    def test_delitem(self):
        n = 500         # O(n**2) test, don't make this too big
228
        d = deque(range(n))
229 230
        self.assertRaises(IndexError, d.__delitem__, -n-1)
        self.assertRaises(IndexError, d.__delitem__, n)
231
        for i in range(n):
232 233 234
            self.assertEqual(len(d), n-i)
            j = random.randrange(-len(d), len(d))
            val = d[j]
235
            self.assertIn(val, d)
236
            del d[j]
237
            self.assertNotIn(val, d)
238 239
        self.assertEqual(len(d), 0)

240 241 242 243 244 245 246
    def test_reverse(self):
        n = 500         # O(n**2) test, don't make this too big
        data = [random.random() for i in range(n)]
        for i in range(n):
            d = deque(data[:i])
            r = d.reverse()
            self.assertEqual(list(d), list(reversed(data[:i])))
247
            self.assertIs(r, None)
248 249 250 251
            d.reverse()
            self.assertEqual(list(d), data[:i])
        self.assertRaises(TypeError, d.reverse, 1)          # Arity is zero

252
    def test_rotate(self):
253 254 255 256 257 258 259 260 261 262 263 264 265
        s = tuple('abcde')
        n = len(s)

        d = deque(s)
        d.rotate(1)             # verify rot(1)
        self.assertEqual(''.join(d), 'eabcd')

        d = deque(s)
        d.rotate(-1)            # verify rot(-1)
        self.assertEqual(''.join(d), 'bcdea')
        d.rotate()              # check default to 1
        self.assertEqual(tuple(d), s)

266
        for i in range(n*3):
267 268 269
            d = deque(s)
            e = deque(d)
            d.rotate(i)         # check vs. rot(1) n times
270
            for j in range(i):
271 272 273 274 275 276 277
                e.rotate(1)
            self.assertEqual(tuple(d), tuple(e))
            d.rotate(-i)        # check that it works in reverse
            self.assertEqual(tuple(d), s)
            e.rotate(n-i)       # check that it wraps forward
            self.assertEqual(tuple(e), s)

278
        for i in range(n*3):
279 280 281
            d = deque(s)
            e = deque(d)
            d.rotate(-i)
282
            for j in range(i):
283 284 285 286 287 288 289
                e.rotate(-1)    # check vs. rot(-1) n times
            self.assertEqual(tuple(d), tuple(e))
            d.rotate(i)         # check that it works in reverse
            self.assertEqual(tuple(d), s)
            e.rotate(i-n)       # check that it wraps backaround
            self.assertEqual(tuple(e), s)

290
        d = deque(s)
291 292 293
        e = deque(s)
        e.rotate(BIG+17)        # verify on long series of rotates
        dr = d.rotate
294
        for i in range(BIG+17):
295 296
            dr()
        self.assertEqual(tuple(d), tuple(e))
297

298 299 300 301 302 303 304
        self.assertRaises(TypeError, d.rotate, 'x')   # Wrong arg type
        self.assertRaises(TypeError, d.rotate, 1, 10) # Too many args

        d = deque()
        d.rotate()              # rotate an empty deque
        self.assertEqual(d, deque())

305 306 307 308 309 310 311
    def test_len(self):
        d = deque('ab')
        self.assertEqual(len(d), 2)
        d.popleft()
        self.assertEqual(len(d), 1)
        d.pop()
        self.assertEqual(len(d), 0)
312
        self.assertRaises(IndexError, d.pop)
313 314 315 316 317 318 319 320 321 322
        self.assertEqual(len(d), 0)
        d.append('c')
        self.assertEqual(len(d), 1)
        d.appendleft('d')
        self.assertEqual(len(d), 2)
        d.clear()
        self.assertEqual(len(d), 0)

    def test_underflow(self):
        d = deque()
323 324
        self.assertRaises(IndexError, d.pop)
        self.assertRaises(IndexError, d.popleft)
325 326

    def test_clear(self):
327
        d = deque(range(100))
328 329 330 331
        self.assertEqual(len(d), 100)
        d.clear()
        self.assertEqual(len(d), 0)
        self.assertEqual(list(d), [])
332 333
        d.clear()               # clear an emtpy deque
        self.assertEqual(list(d), [])
334

335 336 337 338 339 340 341 342 343
    def test_remove(self):
        d = deque('abcdefghcij')
        d.remove('c')
        self.assertEqual(d, deque('abdefghcij'))
        d.remove('c')
        self.assertEqual(d, deque('abdefghij'))
        self.assertRaises(ValueError, d.remove, 'c')
        self.assertEqual(d, deque('abdefghij'))

Walter Dörwald's avatar
Walter Dörwald committed
344
        # Handle comparison errors
345 346 347 348 349
        d = deque(['a', 'b', BadCmp(), 'c'])
        e = deque(d)
        self.assertRaises(RuntimeError, d.remove, 'c')
        for x, y in zip(d, e):
            # verify that original order and values are retained.
350
            self.assertTrue(x is y)
351 352

        # Handle evil mutator
353 354 355 356 357
        for match in (True, False):
            d = deque(['ab'])
            d.extend([MutateCmp(d, match), 'c'])
            self.assertRaises(IndexError, d.remove, 'c')
            self.assertEqual(d, deque())
358

359
    def test_repr(self):
360
        d = deque(range(200))
361 362 363
        e = eval(repr(d))
        self.assertEqual(list(d), list(e))
        d.append(d)
364
        self.assertIn('...', repr(d))
365 366

    def test_print(self):
367
        d = deque(range(200))
368
        d.append(d)
369
        try:
370 371
            support.unlink(support.TESTFN)
            fo = open(support.TESTFN, "w")
Christian Heimes's avatar
Christian Heimes committed
372
            print(d, file=fo, end='')
373
            fo.close()
374
            fo = open(support.TESTFN, "r")
375 376 377
            self.assertEqual(fo.read(), repr(d))
        finally:
            fo.close()
378
            support.unlink(support.TESTFN)
379 380

    def test_init(self):
381
        self.assertRaises(TypeError, deque, 'abc', 2, 3);
382
        self.assertRaises(TypeError, deque, 1);
383 384 385 386 387 388

    def test_hash(self):
        self.assertRaises(TypeError, hash, deque('abc'))

    def test_long_steadystate_queue_popleft(self):
        for size in (0, 1, 2, 100, 1000):
389
            d = deque(range(size))
390
            append, pop = d.append, d.popleft
391
            for i in range(size, BIG):
392 393 394 395
                append(i)
                x = pop()
                if x != i - size:
                    self.assertEqual(x, i-size)
396
            self.assertEqual(list(d), list(range(BIG-size, BIG)))
397 398 399

    def test_long_steadystate_queue_popright(self):
        for size in (0, 1, 2, 100, 1000):
400
            d = deque(reversed(range(size)))
401
            append, pop = d.appendleft, d.pop
402
            for i in range(size, BIG):
403 404 405 406
                append(i)
                x = pop()
                if x != i - size:
                    self.assertEqual(x, i-size)
407 408
            self.assertEqual(list(reversed(list(d))),
                             list(range(BIG-size, BIG)))
409 410 411 412 413

    def test_big_queue_popleft(self):
        pass
        d = deque()
        append, pop = d.append, d.popleft
414
        for i in range(BIG):
415
            append(i)
416
        for i in range(BIG):
417 418 419 420 421 422 423
            x = pop()
            if x != i:
                self.assertEqual(x, i)

    def test_big_queue_popright(self):
        d = deque()
        append, pop = d.appendleft, d.pop
424
        for i in range(BIG):
425
            append(i)
426
        for i in range(BIG):
427 428 429 430 431 432 433
            x = pop()
            if x != i:
                self.assertEqual(x, i)

    def test_big_stack_right(self):
        d = deque()
        append, pop = d.append, d.pop
434
        for i in range(BIG):
435
            append(i)
436
        for i in reversed(range(BIG)):
437 438 439 440 441 442 443 444
            x = pop()
            if x != i:
                self.assertEqual(x, i)
        self.assertEqual(len(d), 0)

    def test_big_stack_left(self):
        d = deque()
        append, pop = d.appendleft, d.popleft
445
        for i in range(BIG):
446
            append(i)
447
        for i in reversed(range(BIG)):
448 449 450 451 452 453
            x = pop()
            if x != i:
                self.assertEqual(x, i)
        self.assertEqual(len(d), 0)

    def test_roundtrip_iter_init(self):
454
        d = deque(range(200))
455 456 457 458 459
        e = deque(d)
        self.assertNotEqual(id(d), id(e))
        self.assertEqual(list(d), list(e))

    def test_pickle(self):
460
        d = deque(range(200))
461
        for i in range(pickle.HIGHEST_PROTOCOL + 1):
462 463 464 465 466
            s = pickle.dumps(d, i)
            e = pickle.loads(s)
            self.assertNotEqual(id(d), id(e))
            self.assertEqual(list(d), list(e))

467 468 469
##    def test_pickle_recursive(self):
##        d = deque('abc')
##        d.append(d)
470
##        for i in range(pickle.HIGHEST_PROTOCOL + 1):
471 472 473
##            e = pickle.loads(pickle.dumps(d, i))
##            self.assertNotEqual(id(d), id(e))
##            self.assertEqual(id(e), id(e[-1]))
474

475 476
    def test_iterator_pickle(self):
        data = deque(range(200))
477 478 479 480 481 482 483 484 485 486 487
        for proto in range(pickle.HIGHEST_PROTOCOL + 1):
            it = itorg = iter(data)
            d = pickle.dumps(it, proto)
            it = pickle.loads(d)
            self.assertEqual(type(itorg), type(it))
            self.assertEqual(list(it), list(data))

            it = pickle.loads(d)
            next(it)
            d = pickle.dumps(it, proto)
            self.assertEqual(list(it), list(data)[1:])
488

489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
    def test_deepcopy(self):
        mut = [10]
        d = deque([mut])
        e = copy.deepcopy(d)
        self.assertEqual(list(d), list(e))
        mut[0] = 11
        self.assertNotEqual(id(d), id(e))
        self.assertNotEqual(list(d), list(e))

    def test_copy(self):
        mut = [10]
        d = deque([mut])
        e = copy.copy(d)
        self.assertEqual(list(d), list(e))
        mut[0] = 11
        self.assertNotEqual(id(d), id(e))
        self.assertEqual(list(d), list(e))

507
    def test_reversed(self):
508
        for s in ('abcd', range(2000)):
509 510
            self.assertEqual(list(reversed(deque(s))), list(reversed(s)))

511 512 513 514 515
    def test_reversed_new(self):
        klass = type(reversed(deque()))
        for s in ('abcd', range(2000)):
            self.assertEqual(list(klass(deque(s))), list(reversed(s)))

516 517 518 519 520
    def test_gc_doesnt_blowup(self):
        import gc
        # This used to assert-fail in deque_traverse() under a debug
        # build, or run wild with a NULL pointer in a release build.
        d = deque()
521
        for i in range(100):
522 523 524
            d.append(1)
            gc.collect()

525 526 527 528 529 530 531 532 533 534 535 536 537 538
    def test_container_iterator(self):
        # Bug #3680: tp_traverse was not implemented for deque iterator objects
        class C(object):
            pass
        for i in range(2):
            obj = C()
            ref = weakref.ref(obj)
            if i == 0:
                container = deque([obj, 1])
            else:
                container = reversed(deque([obj, 1]))
            obj.x = iter(container)
            del obj, container
            gc.collect()
539
            self.assertTrue(ref() is None, "Cycle was not collected")
540

541 542 543 544
    check_sizeof = support.check_sizeof

    @support.cpython_only
    def test_sizeof(self):
545
        BLOCKLEN = 62
546
        basesize = support.calcobjsize('2P4nlP')
547 548 549 550 551
        blocksize = struct.calcsize('2P%dP' % BLOCKLEN)
        self.assertEqual(object.__sizeof__(deque()), basesize)
        check = self.check_sizeof
        check(deque(), basesize + blocksize)
        check(deque('a'), basesize + blocksize)
552 553
        check(deque('a' * (BLOCKLEN - 1)), basesize + blocksize)
        check(deque('a' * BLOCKLEN), basesize + 2 * blocksize)
554 555
        check(deque('a' * (42 * BLOCKLEN)), basesize + 43 * blocksize)

556 557 558
class TestVariousIteratorArgs(unittest.TestCase):

    def test_constructor(self):
559
        for s in ("123", "", range(1000), ('do', 1.2), range(2000,2200,5)):
560 561 562
            for g in (seq_tests.Sequence, seq_tests.IterFunc,
                      seq_tests.IterGen, seq_tests.IterFuncStop,
                      seq_tests.itermulti, seq_tests.iterfunc):
563
                self.assertEqual(list(deque(g(s))), list(g(s)))
564 565 566
            self.assertRaises(TypeError, deque, seq_tests.IterNextOnly(s))
            self.assertRaises(TypeError, deque, seq_tests.IterNoNext(s))
            self.assertRaises(ZeroDivisionError, deque, seq_tests.IterGenExc(s))
567 568 569 570 571

    def test_iter_with_altered_data(self):
        d = deque('abcdefg')
        it = iter(d)
        d.pop()
572
        self.assertRaises(RuntimeError, next, it)
573

574 575 576 577
    def test_runtime_error_on_empty_deque(self):
        d = deque()
        it = iter(d)
        d.append(10)
578
        self.assertRaises(RuntimeError, next, it)
579

580 581 582
class Deque(deque):
    pass

583 584 585 586
class DequeWithBadIter(deque):
    def __iter__(self):
        raise TypeError

587 588 589
class TestSubclass(unittest.TestCase):

    def test_basics(self):
590 591
        d = Deque(range(25))
        d.__init__(range(200))
592
        for i in range(200, 400):
593
            d.append(i)
594
        for i in reversed(range(-200, 0)):
595
            d.appendleft(i)
596
        self.assertEqual(list(d), list(range(-200, 400)))
597 598
        self.assertEqual(len(d), 600)

599 600 601
        left = [d.popleft() for i in range(250)]
        self.assertEqual(left, list(range(-200, 50)))
        self.assertEqual(list(d), list(range(50, 400)))
602

603
        right = [d.pop() for i in range(250)]
604
        right.reverse()
605 606
        self.assertEqual(right, list(range(150, 400)))
        self.assertEqual(list(d), list(range(50, 150)))
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622

        d.clear()
        self.assertEqual(len(d), 0)

    def test_copy_pickle(self):

        d = Deque('abc')

        e = d.__copy__()
        self.assertEqual(type(d), type(e))
        self.assertEqual(list(d), list(e))

        e = Deque(d)
        self.assertEqual(type(d), type(e))
        self.assertEqual(list(d), list(e))

623 624 625 626 627 628
        for proto in range(pickle.HIGHEST_PROTOCOL + 1):
            s = pickle.dumps(d, proto)
            e = pickle.loads(s)
            self.assertNotEqual(id(d), id(e))
            self.assertEqual(type(d), type(e))
            self.assertEqual(list(d), list(e))
629

630
        d = Deque('abcde', maxlen=4)
631

632
        e = d.__copy__()
633
        self.assertEqual(type(d), type(e))
634 635 636 637 638
        self.assertEqual(list(d), list(e))

        e = Deque(d)
        self.assertEqual(type(d), type(e))
        self.assertEqual(list(d), list(e))
639

640 641 642 643 644 645
        for proto in range(pickle.HIGHEST_PROTOCOL + 1):
            s = pickle.dumps(d, proto)
            e = pickle.loads(s)
            self.assertNotEqual(id(d), id(e))
            self.assertEqual(type(d), type(e))
            self.assertEqual(list(d), list(e))
646

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
##    def test_pickle(self):
##        d = Deque('abc')
##        d.append(d)
##
##        e = pickle.loads(pickle.dumps(d))
##        self.assertNotEqual(id(d), id(e))
##        self.assertEqual(type(d), type(e))
##        dd = d.pop()
##        ee = e.pop()
##        self.assertEqual(id(e), id(ee))
##        self.assertEqual(d, e)
##
##        d.x = d
##        e = pickle.loads(pickle.dumps(d))
##        self.assertEqual(id(e), id(e.x))
##
##        d = DequeWithBadIter('abc')
##        self.assertRaises(TypeError, pickle.dumps, d)
665

666 667
    def test_weakref(self):
        d = deque('gallahad')
668
        p = weakref.proxy(d)
669 670 671
        self.assertEqual(str(p), str(d))
        d = None
        self.assertRaises(ReferenceError, str, p)
672

673 674 675 676 677 678 679 680 681
    def test_strange_subclass(self):
        class X(deque):
            def __iter__(self):
                return iter([])
        d1 = X([1,2,3])
        d2 = X([4,5,6])
        d1 == d2   # not clear if this is supposed to be True or False,
                   # but it used to give a SystemError

682 683 684 685 686 687 688 689 690 691

class SubclassWithKwargs(deque):
    def __init__(self, newarg=1):
        deque.__init__(self)

class TestSubclassWithKwargs(unittest.TestCase):
    def test_subclass_with_kwargs(self):
        # SF bug #1486663 -- this used to erroneously raise a TypeError
        SubclassWithKwargs(newarg=1)

692 693
#==============================================================================

694 695 696 697 698 699
libreftest = """
Example from the Library Reference:  Doc/lib/libcollections.tex

>>> from collections import deque
>>> d = deque('ghi')                 # make a new deque with three items
>>> for elem in d:                   # iterate over the deque's elements
700
...     print(elem.upper())
701 702 703 704 705 706 707 708 709 710 711 712 713
G
H
I
>>> d.append('j')                    # add a new entry to the right side
>>> d.appendleft('f')                # add a new entry to the left side
>>> d                                # show the representation of the deque
deque(['f', 'g', 'h', 'i', 'j'])
>>> d.pop()                          # return and remove the rightmost item
'j'
>>> d.popleft()                      # return and remove the leftmost item
'f'
>>> list(d)                          # list the contents of the deque
['g', 'h', 'i']
714
>>> d[0]                             # peek at leftmost item
715
'g'
716
>>> d[-1]                            # peek at rightmost item
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
'i'
>>> list(reversed(d))                # list the contents of a deque in reverse
['i', 'h', 'g']
>>> 'h' in d                         # search the deque
True
>>> d.extend('jkl')                  # add multiple elements at once
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])
>>> d.rotate(1)                      # right rotation
>>> d
deque(['l', 'g', 'h', 'i', 'j', 'k'])
>>> d.rotate(-1)                     # left rotation
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])
>>> deque(reversed(d))               # make a new deque in reverse order
deque(['l', 'k', 'j', 'i', 'h', 'g'])
>>> d.clear()                        # empty the deque
>>> d.pop()                          # cannot pop from an empty deque
Traceback (most recent call last):
  File "<pyshell#6>", line 1, in -toplevel-
    d.pop()
IndexError: pop from an empty deque

>>> d.extendleft('abc')              # extendleft() reverses the input order
>>> d
deque(['c', 'b', 'a'])

Raymond Hettinger's avatar
Raymond Hettinger committed
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762


>>> def delete_nth(d, n):
...     d.rotate(-n)
...     d.popleft()
...     d.rotate(n)
...
>>> d = deque('abcdef')
>>> delete_nth(d, 2)   # remove the entry at d[2]
>>> d
deque(['a', 'b', 'd', 'e', 'f'])



>>> def roundrobin(*iterables):
...     pending = deque(iter(i) for i in iterables)
...     while pending:
...         task = pending.popleft()
...         try:
763
...             yield next(task)
Raymond Hettinger's avatar
Raymond Hettinger committed
764 765 766 767 768 769
...         except StopIteration:
...             continue
...         pending.append(task)
...

>>> for value in roundrobin('abc', 'd', 'efgh'):
770
...     print(value)
771
...
Raymond Hettinger's avatar
Raymond Hettinger committed
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
a
d
e
b
f
c
g
h


>>> def maketree(iterable):
...     d = deque(iterable)
...     while len(d) > 1:
...         pair = [d.popleft(), d.popleft()]
...         d.append(pair)
...     return list(d)
...
789
>>> print(maketree('abcdefgh'))
Raymond Hettinger's avatar
Raymond Hettinger committed
790 791
[[[['a', 'b'], ['c', 'd']], [['e', 'f'], ['g', 'h']]]]

792 793 794 795 796 797 798
"""


#==============================================================================

__test__ = {'libreftest' : libreftest}

799 800 801 802 803 804
def test_main(verbose=None):
    import sys
    test_classes = (
        TestBasic,
        TestVariousIteratorArgs,
        TestSubclass,
805
        TestSubclassWithKwargs,
806 807
    )

808
    support.run_unittest(*test_classes)
809 810 811 812 813

    # verify reference counting
    if verbose and hasattr(sys, "gettotalrefcount"):
        import gc
        counts = [None] * 5
814
        for i in range(len(counts)):
815
            support.run_unittest(*test_classes)
816 817
            gc.collect()
            counts[i] = sys.gettotalrefcount()
818
        print(counts)
819

820 821
    # doctests
    from test import test_deque
822
    support.run_doctest(test_deque, verbose)
823 824 825

if __name__ == "__main__":
    test_main(verbose=True)