Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1 | import unittest |
Brett Cannon | 7a54073 | 2011-02-22 03:04:06 +0000 | [diff] [blame] | 2 | from test.support import (verbose, refcount_test, run_unittest, |
Serhiy Storchaka | 263dcd2 | 2015-04-01 13:01:14 +0300 | [diff] [blame] | 3 | strip_python_stderr, cpython_only, start_threads) |
Antoine Pitrou | 5f454a0 | 2013-05-06 21:15:57 +0200 | [diff] [blame] | 4 | from test.script_helper import assert_python_ok, make_script, temp_dir |
| 5 | |
Neil Schemenauer | 88c761a | 2001-07-12 13:25:53 +0000 | [diff] [blame] | 6 | import sys |
Antoine Pitrou | 2b0218a | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 7 | import time |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 8 | import gc |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 9 | import weakref |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 10 | |
Antoine Pitrou | 2b0218a | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 11 | try: |
| 12 | import threading |
| 13 | except ImportError: |
| 14 | threading = None |
| 15 | |
Serhiy Storchaka | f28ba36 | 2014-02-07 10:10:55 +0200 | [diff] [blame] | 16 | try: |
| 17 | from _testcapi import with_tp_del |
| 18 | except ImportError: |
| 19 | def with_tp_del(cls): |
| 20 | class C(object): |
| 21 | def __new__(cls, *args, **kwargs): |
| 22 | raise TypeError('requires _testcapi.with_tp_del') |
| 23 | return C |
| 24 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 25 | ### Support code |
| 26 | ############################################################################### |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 27 | |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 28 | # Bug 1055820 has several tests of longstanding bugs involving weakrefs and |
| 29 | # cyclic gc. |
| 30 | |
| 31 | # An instance of C1055820 has a self-loop, so becomes cyclic trash when |
| 32 | # unreachable. |
| 33 | class C1055820(object): |
| 34 | def __init__(self, i): |
| 35 | self.i = i |
| 36 | self.loop = self |
| 37 | |
| 38 | class GC_Detector(object): |
| 39 | # Create an instance I. Then gc hasn't happened again so long as |
| 40 | # I.gc_happened is false. |
| 41 | |
| 42 | def __init__(self): |
| 43 | self.gc_happened = False |
| 44 | |
| 45 | def it_happened(ignored): |
| 46 | self.gc_happened = True |
| 47 | |
| 48 | # Create a piece of cyclic trash that triggers it_happened when |
| 49 | # gc collects it. |
| 50 | self.wr = weakref.ref(C1055820(666), it_happened) |
| 51 | |
Serhiy Storchaka | f28ba36 | 2014-02-07 10:10:55 +0200 | [diff] [blame] | 52 | @with_tp_del |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 53 | class Uncollectable(object): |
| 54 | """Create a reference cycle with multiple __del__ methods. |
| 55 | |
| 56 | An object in a reference cycle will never have zero references, |
| 57 | and so must be garbage collected. If one or more objects in the |
| 58 | cycle have __del__ methods, the gc refuses to guess an order, |
| 59 | and leaves the cycle uncollected.""" |
| 60 | def __init__(self, partner=None): |
| 61 | if partner is None: |
| 62 | self.partner = Uncollectable(partner=self) |
| 63 | else: |
| 64 | self.partner = partner |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 65 | def __tp_del__(self): |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 66 | pass |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 67 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 68 | ### Tests |
| 69 | ############################################################################### |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 70 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 71 | class GCTests(unittest.TestCase): |
| 72 | def test_list(self): |
| 73 | l = [] |
| 74 | l.append(l) |
| 75 | gc.collect() |
| 76 | del l |
| 77 | self.assertEqual(gc.collect(), 1) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 78 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 79 | def test_dict(self): |
| 80 | d = {} |
| 81 | d[1] = d |
| 82 | gc.collect() |
| 83 | del d |
| 84 | self.assertEqual(gc.collect(), 1) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 85 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 86 | def test_tuple(self): |
| 87 | # since tuples are immutable we close the loop with a list |
| 88 | l = [] |
| 89 | t = (l,) |
| 90 | l.append(t) |
| 91 | gc.collect() |
| 92 | del t |
| 93 | del l |
| 94 | self.assertEqual(gc.collect(), 2) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 95 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 96 | def test_class(self): |
| 97 | class A: |
| 98 | pass |
| 99 | A.a = A |
| 100 | gc.collect() |
| 101 | del A |
| 102 | self.assertNotEqual(gc.collect(), 0) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 103 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 104 | def test_newstyleclass(self): |
| 105 | class A(object): |
| 106 | pass |
| 107 | gc.collect() |
| 108 | del A |
| 109 | self.assertNotEqual(gc.collect(), 0) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 110 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 111 | def test_instance(self): |
| 112 | class A: |
| 113 | pass |
| 114 | a = A() |
| 115 | a.a = a |
| 116 | gc.collect() |
| 117 | del a |
| 118 | self.assertNotEqual(gc.collect(), 0) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 119 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 120 | def test_newinstance(self): |
| 121 | class A(object): |
| 122 | pass |
| 123 | a = A() |
| 124 | a.a = a |
| 125 | gc.collect() |
| 126 | del a |
| 127 | self.assertNotEqual(gc.collect(), 0) |
| 128 | class B(list): |
| 129 | pass |
| 130 | class C(B, A): |
| 131 | pass |
| 132 | a = C() |
| 133 | a.a = a |
| 134 | gc.collect() |
| 135 | del a |
| 136 | self.assertNotEqual(gc.collect(), 0) |
| 137 | del B, C |
| 138 | self.assertNotEqual(gc.collect(), 0) |
| 139 | A.a = A() |
| 140 | del A |
| 141 | self.assertNotEqual(gc.collect(), 0) |
| 142 | self.assertEqual(gc.collect(), 0) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 143 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 144 | def test_method(self): |
| 145 | # Tricky: self.__init__ is a bound method, it references the instance. |
| 146 | class A: |
| 147 | def __init__(self): |
| 148 | self.init = self.__init__ |
| 149 | a = A() |
| 150 | gc.collect() |
| 151 | del a |
| 152 | self.assertNotEqual(gc.collect(), 0) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 153 | |
Serhiy Storchaka | f28ba36 | 2014-02-07 10:10:55 +0200 | [diff] [blame] | 154 | @cpython_only |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 155 | def test_legacy_finalizer(self): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 156 | # A() is uncollectable if it is part of a cycle, make sure it shows up |
| 157 | # in gc.garbage. |
Serhiy Storchaka | f28ba36 | 2014-02-07 10:10:55 +0200 | [diff] [blame] | 158 | @with_tp_del |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 159 | class A: |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 160 | def __tp_del__(self): pass |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 161 | class B: |
| 162 | pass |
| 163 | a = A() |
| 164 | a.a = a |
| 165 | id_a = id(a) |
| 166 | b = B() |
| 167 | b.b = b |
| 168 | gc.collect() |
| 169 | del a |
| 170 | del b |
| 171 | self.assertNotEqual(gc.collect(), 0) |
| 172 | for obj in gc.garbage: |
| 173 | if id(obj) == id_a: |
| 174 | del obj.a |
| 175 | break |
| 176 | else: |
| 177 | self.fail("didn't find obj in garbage (finalizer)") |
| 178 | gc.garbage.remove(obj) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 179 | |
Serhiy Storchaka | f28ba36 | 2014-02-07 10:10:55 +0200 | [diff] [blame] | 180 | @cpython_only |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 181 | def test_legacy_finalizer_newclass(self): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 182 | # A() is uncollectable if it is part of a cycle, make sure it shows up |
| 183 | # in gc.garbage. |
Serhiy Storchaka | f28ba36 | 2014-02-07 10:10:55 +0200 | [diff] [blame] | 184 | @with_tp_del |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 185 | class A(object): |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 186 | def __tp_del__(self): pass |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 187 | class B(object): |
| 188 | pass |
| 189 | a = A() |
| 190 | a.a = a |
| 191 | id_a = id(a) |
| 192 | b = B() |
| 193 | b.b = b |
| 194 | gc.collect() |
| 195 | del a |
| 196 | del b |
| 197 | self.assertNotEqual(gc.collect(), 0) |
| 198 | for obj in gc.garbage: |
| 199 | if id(obj) == id_a: |
| 200 | del obj.a |
| 201 | break |
| 202 | else: |
| 203 | self.fail("didn't find obj in garbage (finalizer)") |
| 204 | gc.garbage.remove(obj) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 205 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 206 | def test_function(self): |
| 207 | # Tricky: f -> d -> f, code should call d.clear() after the exec to |
| 208 | # break the cycle. |
| 209 | d = {} |
| 210 | exec("def f(): pass\n", d) |
| 211 | gc.collect() |
| 212 | del d |
| 213 | self.assertEqual(gc.collect(), 2) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 214 | |
Brett Cannon | 7a54073 | 2011-02-22 03:04:06 +0000 | [diff] [blame] | 215 | @refcount_test |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 216 | def test_frame(self): |
| 217 | def f(): |
| 218 | frame = sys._getframe() |
| 219 | gc.collect() |
| 220 | f() |
| 221 | self.assertEqual(gc.collect(), 1) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 222 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 223 | def test_saveall(self): |
| 224 | # Verify that cyclic garbage like lists show up in gc.garbage if the |
| 225 | # SAVEALL option is enabled. |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 226 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 227 | # First make sure we don't save away other stuff that just happens to |
| 228 | # be waiting for collection. |
| 229 | gc.collect() |
| 230 | # if this fails, someone else created immortal trash |
| 231 | self.assertEqual(gc.garbage, []) |
| 232 | |
| 233 | L = [] |
| 234 | L.append(L) |
| 235 | id_L = id(L) |
| 236 | |
| 237 | debug = gc.get_debug() |
| 238 | gc.set_debug(debug | gc.DEBUG_SAVEALL) |
| 239 | del L |
| 240 | gc.collect() |
| 241 | gc.set_debug(debug) |
| 242 | |
| 243 | self.assertEqual(len(gc.garbage), 1) |
| 244 | obj = gc.garbage.pop() |
| 245 | self.assertEqual(id(obj), id_L) |
| 246 | |
| 247 | def test_del(self): |
| 248 | # __del__ methods can trigger collection, make this to happen |
| 249 | thresholds = gc.get_threshold() |
| 250 | gc.enable() |
| 251 | gc.set_threshold(1) |
| 252 | |
| 253 | class A: |
| 254 | def __del__(self): |
| 255 | dir(self) |
| 256 | a = A() |
| 257 | del a |
| 258 | |
| 259 | gc.disable() |
| 260 | gc.set_threshold(*thresholds) |
| 261 | |
| 262 | def test_del_newclass(self): |
| 263 | # __del__ methods can trigger collection, make this to happen |
| 264 | thresholds = gc.get_threshold() |
| 265 | gc.enable() |
| 266 | gc.set_threshold(1) |
| 267 | |
| 268 | class A(object): |
| 269 | def __del__(self): |
| 270 | dir(self) |
| 271 | a = A() |
| 272 | del a |
| 273 | |
| 274 | gc.disable() |
| 275 | gc.set_threshold(*thresholds) |
| 276 | |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 277 | # The following two tests are fragile: |
| 278 | # They precisely count the number of allocations, |
| 279 | # which is highly implementation-dependent. |
Antoine Pitrou | b35f29a | 2011-04-04 19:50:42 +0200 | [diff] [blame] | 280 | # For example, disposed tuples are not freed, but reused. |
| 281 | # To minimize variations, though, we first store the get_count() results |
| 282 | # and check them at the end. |
Brett Cannon | 7a54073 | 2011-02-22 03:04:06 +0000 | [diff] [blame] | 283 | @refcount_test |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 284 | def test_get_count(self): |
| 285 | gc.collect() |
Antoine Pitrou | b35f29a | 2011-04-04 19:50:42 +0200 | [diff] [blame] | 286 | a, b, c = gc.get_count() |
| 287 | x = [] |
| 288 | d, e, f = gc.get_count() |
| 289 | self.assertEqual((b, c), (0, 0)) |
| 290 | self.assertEqual((e, f), (0, 0)) |
| 291 | # This is less fragile than asserting that a equals 0. |
| 292 | self.assertLess(a, 5) |
| 293 | # Between the two calls to get_count(), at least one object was |
| 294 | # created (the list). |
| 295 | self.assertGreater(d, a) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 296 | |
Brett Cannon | 7a54073 | 2011-02-22 03:04:06 +0000 | [diff] [blame] | 297 | @refcount_test |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 298 | def test_collect_generations(self): |
| 299 | gc.collect() |
Antoine Pitrou | b35f29a | 2011-04-04 19:50:42 +0200 | [diff] [blame] | 300 | # This object will "trickle" into generation N + 1 after |
| 301 | # each call to collect(N) |
| 302 | x = [] |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 303 | gc.collect(0) |
Antoine Pitrou | b35f29a | 2011-04-04 19:50:42 +0200 | [diff] [blame] | 304 | # x is now in gen 1 |
| 305 | a, b, c = gc.get_count() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 306 | gc.collect(1) |
Antoine Pitrou | b35f29a | 2011-04-04 19:50:42 +0200 | [diff] [blame] | 307 | # x is now in gen 2 |
| 308 | d, e, f = gc.get_count() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 309 | gc.collect(2) |
Antoine Pitrou | b35f29a | 2011-04-04 19:50:42 +0200 | [diff] [blame] | 310 | # x is now in gen 3 |
| 311 | g, h, i = gc.get_count() |
| 312 | # We don't check a, d, g since their exact values depends on |
| 313 | # internal implementation details of the interpreter. |
| 314 | self.assertEqual((b, c), (1, 0)) |
| 315 | self.assertEqual((e, f), (0, 1)) |
| 316 | self.assertEqual((h, i), (0, 0)) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 317 | |
| 318 | def test_trashcan(self): |
| 319 | class Ouch: |
| 320 | n = 0 |
| 321 | def __del__(self): |
| 322 | Ouch.n = Ouch.n + 1 |
| 323 | if Ouch.n % 17 == 0: |
| 324 | gc.collect() |
| 325 | |
| 326 | # "trashcan" is a hack to prevent stack overflow when deallocating |
| 327 | # very deeply nested tuples etc. It works in part by abusing the |
| 328 | # type pointer and refcount fields, and that can yield horrible |
| 329 | # problems when gc tries to traverse the structures. |
| 330 | # If this test fails (as it does in 2.0, 2.1 and 2.2), it will |
| 331 | # most likely die via segfault. |
| 332 | |
| 333 | # Note: In 2.3 the possibility for compiling without cyclic gc was |
| 334 | # removed, and that in turn allows the trashcan mechanism to work |
| 335 | # via much simpler means (e.g., it never abuses the type pointer or |
| 336 | # refcount fields anymore). Since it's much less likely to cause a |
| 337 | # problem now, the various constants in this expensive (we force a lot |
| 338 | # of full collections) test are cut back from the 2.2 version. |
| 339 | gc.enable() |
| 340 | N = 150 |
| 341 | for count in range(2): |
| 342 | t = [] |
| 343 | for i in range(N): |
| 344 | t = [t, Ouch()] |
| 345 | u = [] |
| 346 | for i in range(N): |
| 347 | u = [u, Ouch()] |
| 348 | v = {} |
| 349 | for i in range(N): |
| 350 | v = {1: v, 2: Ouch()} |
| 351 | gc.disable() |
| 352 | |
Antoine Pitrou | 2b0218a | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 353 | @unittest.skipUnless(threading, "test meaningless on builds without threads") |
| 354 | def test_trashcan_threads(self): |
| 355 | # Issue #13992: trashcan mechanism should be thread-safe |
| 356 | NESTING = 60 |
| 357 | N_THREADS = 2 |
| 358 | |
| 359 | def sleeper_gen(): |
| 360 | """A generator that releases the GIL when closed or dealloc'ed.""" |
| 361 | try: |
| 362 | yield |
| 363 | finally: |
| 364 | time.sleep(0.000001) |
| 365 | |
| 366 | class C(list): |
| 367 | # Appending to a list is atomic, which avoids the use of a lock. |
| 368 | inits = [] |
| 369 | dels = [] |
| 370 | def __init__(self, alist): |
| 371 | self[:] = alist |
| 372 | C.inits.append(None) |
| 373 | def __del__(self): |
| 374 | # This __del__ is called by subtype_dealloc(). |
| 375 | C.dels.append(None) |
| 376 | # `g` will release the GIL when garbage-collected. This |
| 377 | # helps assert subtype_dealloc's behaviour when threads |
| 378 | # switch in the middle of it. |
| 379 | g = sleeper_gen() |
| 380 | next(g) |
| 381 | # Now that __del__ is finished, subtype_dealloc will proceed |
| 382 | # to call list_dealloc, which also uses the trashcan mechanism. |
| 383 | |
| 384 | def make_nested(): |
| 385 | """Create a sufficiently nested container object so that the |
| 386 | trashcan mechanism is invoked when deallocating it.""" |
| 387 | x = C([]) |
| 388 | for i in range(NESTING): |
| 389 | x = [C([x])] |
| 390 | del x |
| 391 | |
| 392 | def run_thread(): |
| 393 | """Exercise make_nested() in a loop.""" |
| 394 | while not exit: |
| 395 | make_nested() |
| 396 | |
| 397 | old_switchinterval = sys.getswitchinterval() |
| 398 | sys.setswitchinterval(1e-5) |
| 399 | try: |
Serhiy Storchaka | 263dcd2 | 2015-04-01 13:01:14 +0300 | [diff] [blame] | 400 | exit = [] |
Antoine Pitrou | 2b0218a | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 401 | threads = [] |
| 402 | for i in range(N_THREADS): |
| 403 | t = threading.Thread(target=run_thread) |
| 404 | threads.append(t) |
Serhiy Storchaka | 263dcd2 | 2015-04-01 13:01:14 +0300 | [diff] [blame] | 405 | with start_threads(threads, lambda: exit.append(1)): |
Serhiy Storchaka | 9db5500 | 2015-03-28 20:38:37 +0200 | [diff] [blame] | 406 | time.sleep(1.0) |
Antoine Pitrou | 2b0218a | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 407 | finally: |
| 408 | sys.setswitchinterval(old_switchinterval) |
| 409 | gc.collect() |
| 410 | self.assertEqual(len(C.inits), len(C.dels)) |
| 411 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 412 | def test_boom(self): |
| 413 | class Boom: |
| 414 | def __getattr__(self, someattribute): |
| 415 | del self.attr |
| 416 | raise AttributeError |
| 417 | |
| 418 | a = Boom() |
| 419 | b = Boom() |
| 420 | a.attr = b |
| 421 | b.attr = a |
| 422 | |
| 423 | gc.collect() |
| 424 | garbagelen = len(gc.garbage) |
| 425 | del a, b |
| 426 | # a<->b are in a trash cycle now. Collection will invoke |
| 427 | # Boom.__getattr__ (to see whether a and b have __del__ methods), and |
| 428 | # __getattr__ deletes the internal "attr" attributes as a side effect. |
| 429 | # That causes the trash cycle to get reclaimed via refcounts falling to |
| 430 | # 0, thus mutating the trash graph as a side effect of merely asking |
| 431 | # whether __del__ exists. This used to (before 2.3b1) crash Python. |
| 432 | # Now __getattr__ isn't called. |
| 433 | self.assertEqual(gc.collect(), 4) |
| 434 | self.assertEqual(len(gc.garbage), garbagelen) |
| 435 | |
| 436 | def test_boom2(self): |
| 437 | class Boom2: |
| 438 | def __init__(self): |
| 439 | self.x = 0 |
| 440 | |
| 441 | def __getattr__(self, someattribute): |
| 442 | self.x += 1 |
| 443 | if self.x > 1: |
| 444 | del self.attr |
| 445 | raise AttributeError |
| 446 | |
| 447 | a = Boom2() |
| 448 | b = Boom2() |
| 449 | a.attr = b |
| 450 | b.attr = a |
| 451 | |
| 452 | gc.collect() |
| 453 | garbagelen = len(gc.garbage) |
| 454 | del a, b |
| 455 | # Much like test_boom(), except that __getattr__ doesn't break the |
| 456 | # cycle until the second time gc checks for __del__. As of 2.3b1, |
| 457 | # there isn't a second time, so this simply cleans up the trash cycle. |
| 458 | # We expect a, b, a.__dict__ and b.__dict__ (4 objects) to get |
| 459 | # reclaimed this way. |
| 460 | self.assertEqual(gc.collect(), 4) |
| 461 | self.assertEqual(len(gc.garbage), garbagelen) |
| 462 | |
| 463 | def test_boom_new(self): |
| 464 | # boom__new and boom2_new are exactly like boom and boom2, except use |
| 465 | # new-style classes. |
| 466 | |
| 467 | class Boom_New(object): |
| 468 | def __getattr__(self, someattribute): |
| 469 | del self.attr |
| 470 | raise AttributeError |
| 471 | |
| 472 | a = Boom_New() |
| 473 | b = Boom_New() |
| 474 | a.attr = b |
| 475 | b.attr = a |
| 476 | |
| 477 | gc.collect() |
| 478 | garbagelen = len(gc.garbage) |
| 479 | del a, b |
| 480 | self.assertEqual(gc.collect(), 4) |
| 481 | self.assertEqual(len(gc.garbage), garbagelen) |
| 482 | |
| 483 | def test_boom2_new(self): |
| 484 | class Boom2_New(object): |
| 485 | def __init__(self): |
| 486 | self.x = 0 |
| 487 | |
| 488 | def __getattr__(self, someattribute): |
| 489 | self.x += 1 |
| 490 | if self.x > 1: |
| 491 | del self.attr |
| 492 | raise AttributeError |
| 493 | |
| 494 | a = Boom2_New() |
| 495 | b = Boom2_New() |
| 496 | a.attr = b |
| 497 | b.attr = a |
| 498 | |
| 499 | gc.collect() |
| 500 | garbagelen = len(gc.garbage) |
| 501 | del a, b |
| 502 | self.assertEqual(gc.collect(), 4) |
| 503 | self.assertEqual(len(gc.garbage), garbagelen) |
| 504 | |
| 505 | def test_get_referents(self): |
| 506 | alist = [1, 3, 5] |
| 507 | got = gc.get_referents(alist) |
| 508 | got.sort() |
| 509 | self.assertEqual(got, alist) |
| 510 | |
| 511 | atuple = tuple(alist) |
| 512 | got = gc.get_referents(atuple) |
| 513 | got.sort() |
| 514 | self.assertEqual(got, alist) |
| 515 | |
| 516 | adict = {1: 3, 5: 7} |
| 517 | expected = [1, 3, 5, 7] |
| 518 | got = gc.get_referents(adict) |
| 519 | got.sort() |
| 520 | self.assertEqual(got, expected) |
| 521 | |
| 522 | got = gc.get_referents([1, 2], {3: 4}, (0, 0, 0)) |
| 523 | got.sort() |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 524 | self.assertEqual(got, [0, 0] + list(range(5))) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 525 | |
| 526 | self.assertEqual(gc.get_referents(1, 'a', 4j), []) |
| 527 | |
Antoine Pitrou | 3a652b1 | 2009-03-23 18:52:06 +0000 | [diff] [blame] | 528 | def test_is_tracked(self): |
| 529 | # Atomic built-in types are not tracked, user-defined objects and |
| 530 | # mutable containers are. |
| 531 | # NOTE: types with special optimizations (e.g. tuple) have tests |
| 532 | # in their own test files instead. |
| 533 | self.assertFalse(gc.is_tracked(None)) |
| 534 | self.assertFalse(gc.is_tracked(1)) |
| 535 | self.assertFalse(gc.is_tracked(1.0)) |
| 536 | self.assertFalse(gc.is_tracked(1.0 + 5.0j)) |
| 537 | self.assertFalse(gc.is_tracked(True)) |
| 538 | self.assertFalse(gc.is_tracked(False)) |
| 539 | self.assertFalse(gc.is_tracked(b"a")) |
| 540 | self.assertFalse(gc.is_tracked("a")) |
| 541 | self.assertFalse(gc.is_tracked(bytearray(b"a"))) |
| 542 | self.assertFalse(gc.is_tracked(type)) |
| 543 | self.assertFalse(gc.is_tracked(int)) |
| 544 | self.assertFalse(gc.is_tracked(object)) |
| 545 | self.assertFalse(gc.is_tracked(object())) |
| 546 | |
| 547 | class UserClass: |
| 548 | pass |
Antoine Pitrou | a63cc21 | 2015-04-13 20:10:06 +0200 | [diff] [blame] | 549 | |
| 550 | class UserInt(int): |
| 551 | pass |
| 552 | |
| 553 | # Base class is object; no extra fields. |
| 554 | class UserClassSlots: |
| 555 | __slots__ = () |
| 556 | |
| 557 | # Base class is fixed size larger than object; no extra fields. |
| 558 | class UserFloatSlots(float): |
| 559 | __slots__ = () |
| 560 | |
| 561 | # Base class is variable size; no extra fields. |
| 562 | class UserIntSlots(int): |
| 563 | __slots__ = () |
| 564 | |
Antoine Pitrou | 3a652b1 | 2009-03-23 18:52:06 +0000 | [diff] [blame] | 565 | self.assertTrue(gc.is_tracked(gc)) |
| 566 | self.assertTrue(gc.is_tracked(UserClass)) |
| 567 | self.assertTrue(gc.is_tracked(UserClass())) |
Antoine Pitrou | a63cc21 | 2015-04-13 20:10:06 +0200 | [diff] [blame] | 568 | self.assertTrue(gc.is_tracked(UserInt())) |
Antoine Pitrou | 3a652b1 | 2009-03-23 18:52:06 +0000 | [diff] [blame] | 569 | self.assertTrue(gc.is_tracked([])) |
| 570 | self.assertTrue(gc.is_tracked(set())) |
Antoine Pitrou | a63cc21 | 2015-04-13 20:10:06 +0200 | [diff] [blame] | 571 | self.assertFalse(gc.is_tracked(UserClassSlots())) |
| 572 | self.assertFalse(gc.is_tracked(UserFloatSlots())) |
| 573 | self.assertFalse(gc.is_tracked(UserIntSlots())) |
Antoine Pitrou | 3a652b1 | 2009-03-23 18:52:06 +0000 | [diff] [blame] | 574 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 575 | def test_bug1055820b(self): |
| 576 | # Corresponds to temp2b.py in the bug report. |
| 577 | |
| 578 | ouch = [] |
| 579 | def callback(ignored): |
| 580 | ouch[:] = [wr() for wr in WRs] |
| 581 | |
| 582 | Cs = [C1055820(i) for i in range(2)] |
| 583 | WRs = [weakref.ref(c, callback) for c in Cs] |
| 584 | c = None |
| 585 | |
| 586 | gc.collect() |
| 587 | self.assertEqual(len(ouch), 0) |
| 588 | # Make the two instances trash, and collect again. The bug was that |
| 589 | # the callback materialized a strong reference to an instance, but gc |
| 590 | # cleared the instance's dict anyway. |
| 591 | Cs = None |
| 592 | gc.collect() |
| 593 | self.assertEqual(len(ouch), 2) # else the callbacks didn't run |
| 594 | for x in ouch: |
| 595 | # If the callback resurrected one of these guys, the instance |
| 596 | # would be damaged, with an empty __dict__. |
| 597 | self.assertEqual(x, None) |
| 598 | |
Tim Peters | 5fbc7b1 | 2014-05-08 17:42:19 -0500 | [diff] [blame] | 599 | def test_bug21435(self): |
| 600 | # This is a poor test - its only virtue is that it happened to |
| 601 | # segfault on Tim's Windows box before the patch for 21435 was |
| 602 | # applied. That's a nasty bug relying on specific pieces of cyclic |
| 603 | # trash appearing in exactly the right order in finalize_garbage()'s |
| 604 | # input list. |
| 605 | # But there's no reliable way to force that order from Python code, |
| 606 | # so over time chances are good this test won't really be testing much |
| 607 | # of anything anymore. Still, if it blows up, there's _some_ |
| 608 | # problem ;-) |
| 609 | gc.collect() |
| 610 | |
| 611 | class A: |
| 612 | pass |
| 613 | |
| 614 | class B: |
| 615 | def __init__(self, x): |
| 616 | self.x = x |
| 617 | |
| 618 | def __del__(self): |
| 619 | self.attr = None |
| 620 | |
| 621 | def do_work(): |
| 622 | a = A() |
| 623 | b = B(A()) |
| 624 | |
| 625 | a.attr = b |
| 626 | b.attr = a |
| 627 | |
| 628 | do_work() |
| 629 | gc.collect() # this blows up (bad C pointer) when it fails |
| 630 | |
Serhiy Storchaka | f28ba36 | 2014-02-07 10:10:55 +0200 | [diff] [blame] | 631 | @cpython_only |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 632 | def test_garbage_at_shutdown(self): |
| 633 | import subprocess |
| 634 | code = """if 1: |
| 635 | import gc |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 636 | import _testcapi |
| 637 | @_testcapi.with_tp_del |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 638 | class X: |
| 639 | def __init__(self, name): |
| 640 | self.name = name |
| 641 | def __repr__(self): |
| 642 | return "<X %%r>" %% self.name |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 643 | def __tp_del__(self): |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 644 | pass |
| 645 | |
| 646 | x = X('first') |
| 647 | x.x = x |
| 648 | x.y = X('second') |
| 649 | del x |
Antoine Pitrou | 2ed94eb | 2010-09-14 09:48:39 +0000 | [diff] [blame] | 650 | gc.set_debug(%s) |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 651 | """ |
| 652 | def run_command(code): |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 653 | p = subprocess.Popen([sys.executable, "-Wd", "-c", code], |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 654 | stdout=subprocess.PIPE, |
| 655 | stderr=subprocess.PIPE) |
| 656 | stdout, stderr = p.communicate() |
Brian Curtin | 8291af2 | 2010-11-01 16:40:17 +0000 | [diff] [blame] | 657 | p.stdout.close() |
| 658 | p.stderr.close() |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 659 | self.assertEqual(p.returncode, 0) |
| 660 | self.assertEqual(stdout.strip(), b"") |
| 661 | return strip_python_stderr(stderr) |
| 662 | |
Antoine Pitrou | 2ed94eb | 2010-09-14 09:48:39 +0000 | [diff] [blame] | 663 | stderr = run_command(code % "0") |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 664 | self.assertIn(b"ResourceWarning: gc: 2 uncollectable objects at " |
| 665 | b"shutdown; use", stderr) |
Antoine Pitrou | aee4756 | 2010-09-16 15:04:49 +0000 | [diff] [blame] | 666 | self.assertNotIn(b"<X 'first'>", stderr) |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 667 | # With DEBUG_UNCOLLECTABLE, the garbage list gets printed |
Antoine Pitrou | 2ed94eb | 2010-09-14 09:48:39 +0000 | [diff] [blame] | 668 | stderr = run_command(code % "gc.DEBUG_UNCOLLECTABLE") |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 669 | self.assertIn(b"ResourceWarning: gc: 2 uncollectable objects at " |
| 670 | b"shutdown", stderr) |
Antoine Pitrou | aee4756 | 2010-09-16 15:04:49 +0000 | [diff] [blame] | 671 | self.assertTrue( |
| 672 | (b"[<X 'first'>, <X 'second'>]" in stderr) or |
| 673 | (b"[<X 'second'>, <X 'first'>]" in stderr), stderr) |
Antoine Pitrou | 2ed94eb | 2010-09-14 09:48:39 +0000 | [diff] [blame] | 674 | # With DEBUG_SAVEALL, no additional message should get printed |
| 675 | # (because gc.garbage also contains normally reclaimable cyclic |
| 676 | # references, and its elements get printed at runtime anyway). |
| 677 | stderr = run_command(code % "gc.DEBUG_SAVEALL") |
| 678 | self.assertNotIn(b"uncollectable objects at shutdown", stderr) |
| 679 | |
Antoine Pitrou | 5f454a0 | 2013-05-06 21:15:57 +0200 | [diff] [blame] | 680 | def test_gc_main_module_at_shutdown(self): |
| 681 | # Create a reference cycle through the __main__ module and check |
| 682 | # it gets collected at interpreter shutdown. |
| 683 | code = """if 1: |
| 684 | import weakref |
| 685 | class C: |
| 686 | def __del__(self): |
| 687 | print('__del__ called') |
| 688 | l = [C()] |
| 689 | l.append(l) |
| 690 | """ |
| 691 | rc, out, err = assert_python_ok('-c', code) |
| 692 | self.assertEqual(out.strip(), b'__del__ called') |
| 693 | |
| 694 | def test_gc_ordinary_module_at_shutdown(self): |
| 695 | # Same as above, but with a non-__main__ module. |
| 696 | with temp_dir() as script_dir: |
| 697 | module = """if 1: |
| 698 | import weakref |
| 699 | class C: |
| 700 | def __del__(self): |
| 701 | print('__del__ called') |
| 702 | l = [C()] |
| 703 | l.append(l) |
| 704 | """ |
| 705 | code = """if 1: |
| 706 | import sys |
| 707 | sys.path.insert(0, %r) |
| 708 | import gctest |
| 709 | """ % (script_dir,) |
| 710 | make_script(script_dir, 'gctest', module) |
| 711 | rc, out, err = assert_python_ok('-c', code) |
| 712 | self.assertEqual(out.strip(), b'__del__ called') |
| 713 | |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 714 | def test_get_stats(self): |
| 715 | stats = gc.get_stats() |
| 716 | self.assertEqual(len(stats), 3) |
| 717 | for st in stats: |
| 718 | self.assertIsInstance(st, dict) |
| 719 | self.assertEqual(set(st), |
| 720 | {"collected", "collections", "uncollectable"}) |
| 721 | self.assertGreaterEqual(st["collected"], 0) |
| 722 | self.assertGreaterEqual(st["collections"], 0) |
| 723 | self.assertGreaterEqual(st["uncollectable"], 0) |
| 724 | # Check that collection counts are incremented correctly |
| 725 | if gc.isenabled(): |
| 726 | self.addCleanup(gc.enable) |
| 727 | gc.disable() |
| 728 | old = gc.get_stats() |
| 729 | gc.collect(0) |
| 730 | new = gc.get_stats() |
| 731 | self.assertEqual(new[0]["collections"], old[0]["collections"] + 1) |
| 732 | self.assertEqual(new[1]["collections"], old[1]["collections"]) |
| 733 | self.assertEqual(new[2]["collections"], old[2]["collections"]) |
| 734 | gc.collect(2) |
| 735 | new = gc.get_stats() |
| 736 | self.assertEqual(new[0]["collections"], old[0]["collections"] + 1) |
| 737 | self.assertEqual(new[1]["collections"], old[1]["collections"]) |
| 738 | self.assertEqual(new[2]["collections"], old[2]["collections"] + 1) |
| 739 | |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 740 | |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 741 | class GCCallbackTests(unittest.TestCase): |
| 742 | def setUp(self): |
| 743 | # Save gc state and disable it. |
| 744 | self.enabled = gc.isenabled() |
| 745 | gc.disable() |
| 746 | self.debug = gc.get_debug() |
| 747 | gc.set_debug(0) |
| 748 | gc.callbacks.append(self.cb1) |
| 749 | gc.callbacks.append(self.cb2) |
Antoine Pitrou | 6b64fc6 | 2012-04-16 21:29:02 +0200 | [diff] [blame] | 750 | self.othergarbage = [] |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 751 | |
| 752 | def tearDown(self): |
| 753 | # Restore gc state |
| 754 | del self.visit |
| 755 | gc.callbacks.remove(self.cb1) |
| 756 | gc.callbacks.remove(self.cb2) |
| 757 | gc.set_debug(self.debug) |
| 758 | if self.enabled: |
| 759 | gc.enable() |
| 760 | # destroy any uncollectables |
| 761 | gc.collect() |
| 762 | for obj in gc.garbage: |
| 763 | if isinstance(obj, Uncollectable): |
| 764 | obj.partner = None |
| 765 | del gc.garbage[:] |
Antoine Pitrou | 6b64fc6 | 2012-04-16 21:29:02 +0200 | [diff] [blame] | 766 | del self.othergarbage |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 767 | gc.collect() |
| 768 | |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 769 | def preclean(self): |
| 770 | # Remove all fluff from the system. Invoke this function |
| 771 | # manually rather than through self.setUp() for maximum |
| 772 | # safety. |
| 773 | self.visit = [] |
| 774 | gc.collect() |
| 775 | garbage, gc.garbage[:] = gc.garbage[:], [] |
| 776 | self.othergarbage.append(garbage) |
| 777 | self.visit = [] |
| 778 | |
| 779 | def cb1(self, phase, info): |
| 780 | self.visit.append((1, phase, dict(info))) |
| 781 | |
| 782 | def cb2(self, phase, info): |
| 783 | self.visit.append((2, phase, dict(info))) |
| 784 | if phase == "stop" and hasattr(self, "cleanup"): |
| 785 | # Clean Uncollectable from garbage |
| 786 | uc = [e for e in gc.garbage if isinstance(e, Uncollectable)] |
| 787 | gc.garbage[:] = [e for e in gc.garbage |
| 788 | if not isinstance(e, Uncollectable)] |
| 789 | for e in uc: |
| 790 | e.partner = None |
| 791 | |
Antoine Pitrou | de3c73b | 2012-04-16 21:29:58 +0200 | [diff] [blame] | 792 | def test_collect(self): |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 793 | self.preclean() |
| 794 | gc.collect() |
| 795 | # Algorithmically verify the contents of self.visit |
| 796 | # because it is long and tortuous. |
| 797 | |
| 798 | # Count the number of visits to each callback |
| 799 | n = [v[0] for v in self.visit] |
| 800 | n1 = [i for i in n if i == 1] |
| 801 | n2 = [i for i in n if i == 2] |
| 802 | self.assertEqual(n1, [1]*2) |
| 803 | self.assertEqual(n2, [2]*2) |
| 804 | |
| 805 | # Count that we got the right number of start and stop callbacks. |
| 806 | n = [v[1] for v in self.visit] |
| 807 | n1 = [i for i in n if i == "start"] |
| 808 | n2 = [i for i in n if i == "stop"] |
| 809 | self.assertEqual(n1, ["start"]*2) |
| 810 | self.assertEqual(n2, ["stop"]*2) |
| 811 | |
| 812 | # Check that we got the right info dict for all callbacks |
| 813 | for v in self.visit: |
| 814 | info = v[2] |
| 815 | self.assertTrue("generation" in info) |
| 816 | self.assertTrue("collected" in info) |
| 817 | self.assertTrue("uncollectable" in info) |
| 818 | |
Antoine Pitrou | de3c73b | 2012-04-16 21:29:58 +0200 | [diff] [blame] | 819 | def test_collect_generation(self): |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 820 | self.preclean() |
| 821 | gc.collect(2) |
| 822 | for v in self.visit: |
| 823 | info = v[2] |
| 824 | self.assertEqual(info["generation"], 2) |
| 825 | |
Serhiy Storchaka | f28ba36 | 2014-02-07 10:10:55 +0200 | [diff] [blame] | 826 | @cpython_only |
Antoine Pitrou | de3c73b | 2012-04-16 21:29:58 +0200 | [diff] [blame] | 827 | def test_collect_garbage(self): |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 828 | self.preclean() |
| 829 | # Each of these cause four objects to be garbage: Two |
| 830 | # Uncolectables and their instance dicts. |
| 831 | Uncollectable() |
| 832 | Uncollectable() |
| 833 | C1055820(666) |
| 834 | gc.collect() |
| 835 | for v in self.visit: |
| 836 | if v[1] != "stop": |
| 837 | continue |
| 838 | info = v[2] |
| 839 | self.assertEqual(info["collected"], 2) |
| 840 | self.assertEqual(info["uncollectable"], 8) |
| 841 | |
| 842 | # We should now have the Uncollectables in gc.garbage |
| 843 | self.assertEqual(len(gc.garbage), 4) |
| 844 | for e in gc.garbage: |
| 845 | self.assertIsInstance(e, Uncollectable) |
| 846 | |
| 847 | # Now, let our callback handle the Uncollectable instances |
| 848 | self.cleanup=True |
| 849 | self.visit = [] |
| 850 | gc.garbage[:] = [] |
| 851 | gc.collect() |
| 852 | for v in self.visit: |
| 853 | if v[1] != "stop": |
| 854 | continue |
| 855 | info = v[2] |
| 856 | self.assertEqual(info["collected"], 0) |
| 857 | self.assertEqual(info["uncollectable"], 4) |
| 858 | |
| 859 | # Uncollectables should be gone |
| 860 | self.assertEqual(len(gc.garbage), 0) |
| 861 | |
| 862 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 863 | class GCTogglingTests(unittest.TestCase): |
| 864 | def setUp(self): |
| 865 | gc.enable() |
| 866 | |
| 867 | def tearDown(self): |
| 868 | gc.disable() |
| 869 | |
| 870 | def test_bug1055820c(self): |
| 871 | # Corresponds to temp2c.py in the bug report. This is pretty |
| 872 | # elaborate. |
| 873 | |
| 874 | c0 = C1055820(0) |
| 875 | # Move c0 into generation 2. |
| 876 | gc.collect() |
| 877 | |
| 878 | c1 = C1055820(1) |
| 879 | c1.keep_c0_alive = c0 |
| 880 | del c0.loop # now only c1 keeps c0 alive |
| 881 | |
| 882 | c2 = C1055820(2) |
| 883 | c2wr = weakref.ref(c2) # no callback! |
| 884 | |
| 885 | ouch = [] |
| 886 | def callback(ignored): |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 887 | ouch[:] = [c2wr()] |
| 888 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 889 | # The callback gets associated with a wr on an object in generation 2. |
| 890 | c0wr = weakref.ref(c0, callback) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 891 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 892 | c0 = c1 = c2 = None |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 893 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 894 | # What we've set up: c0, c1, and c2 are all trash now. c0 is in |
| 895 | # generation 2. The only thing keeping it alive is that c1 points to |
| 896 | # it. c1 and c2 are in generation 0, and are in self-loops. There's a |
| 897 | # global weakref to c2 (c2wr), but that weakref has no callback. |
| 898 | # There's also a global weakref to c0 (c0wr), and that does have a |
| 899 | # callback, and that callback references c2 via c2wr(). |
| 900 | # |
| 901 | # c0 has a wr with callback, which references c2wr |
| 902 | # ^ |
| 903 | # | |
| 904 | # | Generation 2 above dots |
| 905 | #. . . . . . . .|. . . . . . . . . . . . . . . . . . . . . . . . |
| 906 | # | Generation 0 below dots |
| 907 | # | |
| 908 | # | |
| 909 | # ^->c1 ^->c2 has a wr but no callback |
| 910 | # | | | | |
| 911 | # <--v <--v |
| 912 | # |
| 913 | # So this is the nightmare: when generation 0 gets collected, we see |
| 914 | # that c2 has a callback-free weakref, and c1 doesn't even have a |
| 915 | # weakref. Collecting generation 0 doesn't see c0 at all, and c0 is |
| 916 | # the only object that has a weakref with a callback. gc clears c1 |
| 917 | # and c2. Clearing c1 has the side effect of dropping the refcount on |
| 918 | # c0 to 0, so c0 goes away (despite that it's in an older generation) |
| 919 | # and c0's wr callback triggers. That in turn materializes a reference |
| 920 | # to c2 via c2wr(), but c2 gets cleared anyway by gc. |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 921 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 922 | # We want to let gc happen "naturally", to preserve the distinction |
| 923 | # between generations. |
| 924 | junk = [] |
| 925 | i = 0 |
| 926 | detector = GC_Detector() |
| 927 | while not detector.gc_happened: |
| 928 | i += 1 |
| 929 | if i > 10000: |
| 930 | self.fail("gc didn't happen after 10000 iterations") |
| 931 | self.assertEqual(len(ouch), 0) |
| 932 | junk.append([]) # this will eventually trigger gc |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 933 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 934 | self.assertEqual(len(ouch), 1) # else the callback wasn't invoked |
| 935 | for x in ouch: |
| 936 | # If the callback resurrected c2, the instance would be damaged, |
| 937 | # with an empty __dict__. |
| 938 | self.assertEqual(x, None) |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 939 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 940 | def test_bug1055820d(self): |
| 941 | # Corresponds to temp2d.py in the bug report. This is very much like |
| 942 | # test_bug1055820c, but uses a __del__ method instead of a weakref |
| 943 | # callback to sneak in a resurrection of cyclic trash. |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 944 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 945 | ouch = [] |
| 946 | class D(C1055820): |
| 947 | def __del__(self): |
| 948 | ouch[:] = [c2wr()] |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 949 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 950 | d0 = D(0) |
| 951 | # Move all the above into generation 2. |
| 952 | gc.collect() |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 953 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 954 | c1 = C1055820(1) |
| 955 | c1.keep_d0_alive = d0 |
| 956 | del d0.loop # now only c1 keeps d0 alive |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 957 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 958 | c2 = C1055820(2) |
| 959 | c2wr = weakref.ref(c2) # no callback! |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 960 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 961 | d0 = c1 = c2 = None |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 962 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 963 | # What we've set up: d0, c1, and c2 are all trash now. d0 is in |
| 964 | # generation 2. The only thing keeping it alive is that c1 points to |
| 965 | # it. c1 and c2 are in generation 0, and are in self-loops. There's |
| 966 | # a global weakref to c2 (c2wr), but that weakref has no callback. |
| 967 | # There are no other weakrefs. |
| 968 | # |
| 969 | # d0 has a __del__ method that references c2wr |
| 970 | # ^ |
| 971 | # | |
| 972 | # | Generation 2 above dots |
| 973 | #. . . . . . . .|. . . . . . . . . . . . . . . . . . . . . . . . |
| 974 | # | Generation 0 below dots |
| 975 | # | |
| 976 | # | |
| 977 | # ^->c1 ^->c2 has a wr but no callback |
| 978 | # | | | | |
| 979 | # <--v <--v |
| 980 | # |
| 981 | # So this is the nightmare: when generation 0 gets collected, we see |
| 982 | # that c2 has a callback-free weakref, and c1 doesn't even have a |
| 983 | # weakref. Collecting generation 0 doesn't see d0 at all. gc clears |
| 984 | # c1 and c2. Clearing c1 has the side effect of dropping the refcount |
| 985 | # on d0 to 0, so d0 goes away (despite that it's in an older |
| 986 | # generation) and d0's __del__ triggers. That in turn materializes |
| 987 | # a reference to c2 via c2wr(), but c2 gets cleared anyway by gc. |
| 988 | |
| 989 | # We want to let gc happen "naturally", to preserve the distinction |
| 990 | # between generations. |
| 991 | detector = GC_Detector() |
| 992 | junk = [] |
| 993 | i = 0 |
| 994 | while not detector.gc_happened: |
| 995 | i += 1 |
| 996 | if i > 10000: |
| 997 | self.fail("gc didn't happen after 10000 iterations") |
| 998 | self.assertEqual(len(ouch), 0) |
| 999 | junk.append([]) # this will eventually trigger gc |
| 1000 | |
| 1001 | self.assertEqual(len(ouch), 1) # else __del__ wasn't invoked |
| 1002 | for x in ouch: |
| 1003 | # If __del__ resurrected c2, the instance would be damaged, with an |
| 1004 | # empty __dict__. |
| 1005 | self.assertEqual(x, None) |
| 1006 | |
| 1007 | def test_main(): |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1008 | enabled = gc.isenabled() |
| 1009 | gc.disable() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1010 | assert not gc.isenabled() |
Neil Schemenauer | faae266 | 2000-09-22 15:26:20 +0000 | [diff] [blame] | 1011 | debug = gc.get_debug() |
| 1012 | gc.set_debug(debug & ~gc.DEBUG_LEAK) # this test is supposed to leak |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1013 | |
Neil Schemenauer | faae266 | 2000-09-22 15:26:20 +0000 | [diff] [blame] | 1014 | try: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1015 | gc.collect() # Delete 2nd generation garbage |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1016 | run_unittest(GCTests, GCTogglingTests, GCCallbackTests) |
Neil Schemenauer | faae266 | 2000-09-22 15:26:20 +0000 | [diff] [blame] | 1017 | finally: |
| 1018 | gc.set_debug(debug) |
| 1019 | # test gc.enable() even if GC is disabled by default |
| 1020 | if verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1021 | print("restoring automatic collection") |
Neil Schemenauer | faae266 | 2000-09-22 15:26:20 +0000 | [diff] [blame] | 1022 | # make sure to always test gc.enable() |
| 1023 | gc.enable() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1024 | assert gc.isenabled() |
Neil Schemenauer | faae266 | 2000-09-22 15:26:20 +0000 | [diff] [blame] | 1025 | if not enabled: |
| 1026 | gc.disable() |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1027 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1028 | if __name__ == "__main__": |
| 1029 | test_main() |