Issue #1545463: Global variables caught in reference cycles are now garbage-collected at shutdown.

pitrou · pitrou · commit 5f454a07a054 · 2013-05-06T21:15:57.000+02:00
diff --git a/Include/pythonrun.h b/Include/pythonrun.h
@@ -217,6 +217,7 @@ PyAPI_FUNC(void) PyBytes_Fini(void);
 PyAPI_FUNC(void) PyByteArray_Fini(void);
 PyAPI_FUNC(void) PyFloat_Fini(void);
 PyAPI_FUNC(void) PyOS_FiniInterrupts(void);
+PyAPI_FUNC(void) _PyGC_DumpShutdownStats(void);
 PyAPI_FUNC(void) _PyGC_Fini(void);
 PyAPI_FUNC(void) PySlice_Fini(void);
 PyAPI_FUNC(void) _PyType_Fini(void);
diff --git a/Lib/test/test_gc.py b/Lib/test/test_gc.py
@@ -1,6 +1,8 @@
 import unittest
 from test.support import (verbose, refcount_test, run_unittest,
                             strip_python_stderr)
+from test.script_helper import assert_python_ok, make_script, temp_dir
+
 import sys
 import time
 import gc
@@ -610,6 +612,40 @@ def run_command(code):
         stderr = run_command(code % "gc.DEBUG_SAVEALL")
         self.assertNotIn(b"uncollectable objects at shutdown", stderr)
 
+    def test_gc_main_module_at_shutdown(self):
+        # Create a reference cycle through the __main__ module and check
+        # it gets collected at interpreter shutdown.
+        code = """if 1:
+            import weakref
+            class C:
+                def __del__(self):
+                    print('__del__ called')
+            l = [C()]
+            l.append(l)
+            """
+        rc, out, err = assert_python_ok('-c', code)
+        self.assertEqual(out.strip(), b'__del__ called')
+
+    def test_gc_ordinary_module_at_shutdown(self):
+        # Same as above, but with a non-__main__ module.
+        with temp_dir() as script_dir:
+            module = """if 1:
+                import weakref
+                class C:
+                    def __del__(self):
+                        print('__del__ called')
+                l = [C()]
+                l.append(l)
+                """
+            code = """if 1:
+                import sys
+                sys.path.insert(0, %r)
+                import gctest
+                """ % (script_dir,)
+            make_script(script_dir, 'gctest', module)
+            rc, out, err = assert_python_ok('-c', code)
+            self.assertEqual(out.strip(), b'__del__ called')
+
     def test_get_stats(self):
         stats = gc.get_stats()
         self.assertEqual(len(stats), 3)
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -10,6 +10,9 @@ What's New in Python 3.4.0 Alpha 1?
 Core and Builtins
 -----------------
 
+- Issue #1545463: Global variables caught in reference cycles are now
+  garbage-collected at shutdown.
+
 - Issue #17094: Clear stale thread states after fork().  Note that this
   is a potentially disruptive change since it may release some system
   resources which would otherwise remain perpetually alive (e.g. database
diff --git a/Modules/gcmodule.c b/Modules/gcmodule.c
@@ -1544,8 +1544,9 @@ PyGC_Collect(void)
     return n;
 }
 
+
 void
-_PyGC_Fini(void)
+_PyGC_DumpShutdownStats(void)
 {
     if (!(debug & DEBUG_SAVEALL)
         && garbage != NULL && PyList_GET_SIZE(garbage) > 0) {
@@ -1574,6 +1575,11 @@ _PyGC_Fini(void)
             Py_XDECREF(bytes);
         }
     }
+}
+
+void
+_PyGC_Fini(void)
+{
     Py_CLEAR(callbacks);
 }
 
diff --git a/Python/import.c b/Python/import.c
@@ -403,6 +403,14 @@ PyImport_Cleanup(void)
         }
     }
 
+    /* Collect garbage remaining after deleting the modules. Mostly
+       reference cycles created by classes. */
+    PyGC_Collect();
+
+    /* Dump GC stats before it's too late, since it uses the warnings
+       machinery. */
+    _PyGC_DumpShutdownStats();
+
     /* Next, delete sys and builtins (in that order) */
     value = PyDict_GetItemString(modules, "sys");
     if (value != NULL && PyModule_Check(value)) {
diff --git a/Python/pythonrun.c b/Python/pythonrun.c
@@ -544,10 +544,6 @@ Py_Finalize(void)
     while (PyGC_Collect() > 0)
         /* nothing */;
 #endif
-    /* We run this while most interpreter state is still alive, so that
-       debug information can be printed out */
-    _PyGC_Fini();
-
     /* Destroy all modules */
     PyImport_Cleanup();
 
@@ -628,6 +624,7 @@ Py_Finalize(void)
     PyFloat_Fini();
     PyDict_Fini();
     PySlice_Fini();
+    _PyGC_Fini();
 
     /* Cleanup Unicode implementation */
     _PyUnicode_Fini();

Original file line number	Diff line number	Diff line change
`@@ -1544,8 +1544,9 @@ PyGC_Collect(void)`
`1544`	`1544`	`return n;`
`1545`	`1545`	`}`
`1546`	`1546`
	`1547`	`+`
`1547`	`1548`	`void`
`1548`		`-_PyGC_Fini(void)`
	`1549`	`+_PyGC_DumpShutdownStats(void)`
`1549`	`1550`	`{`
`1550`	`1551`	`if (!(debug & DEBUG_SAVEALL)`
`1551`	`1552`	`&& garbage != NULL && PyList_GET_SIZE(garbage) > 0) {`
`@@ -1574,6 +1575,11 @@ _PyGC_Fini(void)`
`1574`	`1575`	`Py_XDECREF(bytes);`
`1575`	`1576`	`}`
`1576`	`1577`	`}`
	`1578`	`+}`
	`1579`	`+`
	`1580`	`+void`
	`1581`	`+_PyGC_Fini(void)`
	`1582`	`+{`
`1577`	`1583`	`Py_CLEAR(callbacks);`
`1578`	`1584`	`}`
`1579`	`1585`
Original file line number	Diff line number	Diff line change
`@@ -403,6 +403,14 @@ PyImport_Cleanup(void)`
`403`	`403`	`}`
`404`	`404`	`}`
`405`	`405`
	`406`	`+ /* Collect garbage remaining after deleting the modules. Mostly`
	`407`	`+ reference cycles created by classes. */`
	`408`	`+ PyGC_Collect();`
	`409`	`+`
	`410`	`+ /* Dump GC stats before it's too late, since it uses the warnings`
	`411`	`+ machinery. */`
	`412`	`+ _PyGC_DumpShutdownStats();`
	`413`	`+`
`406`	`414`	`/* Next, delete sys and builtins (in that order) */`
`407`	`415`	`value = PyDict_GetItemString(modules, "sys");`
`408`	`416`	`if (value != NULL && PyModule_Check(value)) {`