bpo-1635741: test_embed cheks that Python does not leak

python · vstinner · Feb 24, 2022 · Feb 24, 2022 · Feb 24, 2022 · e6ca72c9e4ee5c1ef051906aef5ea93c8050770f
commit e6ca72c9e4ee5c1ef051906aef5ea93c8050770f
diff --git a/Lib/test/test_cmd_line.py b/Lib/test/test_cmd_line.py
@@ -118,7 +118,7 @@ def run_python(*args):
         self.assertEqual(out.rstrip(), b'{}')
         self.assertEqual(err, b'')
         # "-X showrefcount" shows the refcount, but only in debug builds
-        rc, out, err = run_python('-X', 'showrefcount', '-c', code)
+        rc, out, err = run_python('-I', '-X', 'showrefcount', '-c', code)
         self.assertEqual(out.rstrip(), b"{'showrefcount': True}")
         if Py_DEBUG:
             # bpo-46417: Tolerate negative reference count which can occur

diff --git a/Lib/test/test_embed.py b/Lib/test/test_embed.py
@@ -1641,6 +1641,27 @@ def test_frozenmain(self):
         """).lstrip()
         self.assertEqual(out, expected)
 
+    @unittest.skipUnless(hasattr(sys, 'gettotalrefcount'),
+                         '-X showrefcount requires a Python debug build')
+    def test_no_memleak(self):
+        # bpo-1635741: Python must release all memory at exit
+        cmd = [sys.executable, "-I", "-X", "showrefcount", "-c", "pass"]
+        proc = subprocess.run(cmd,
+                              stdout=subprocess.PIPE,
+                              stderr=subprocess.STDOUT,
+                              text=True)
+        self.assertEqual(proc.returncode, 0)
+        out = proc.stdout.rstrip()
-        cmd = [sys.executable, "-I", "-X", "showrefcount", "-c", "pass"]
-        proc = subprocess.run(cmd,
-                              stdout=subprocess.PIPE,
-                              stderr=subprocess.STDOUT,
-                              text=True)
-        self.assertEqual(proc.returncode, 0)
-        out = proc.stdout.rstrip()
+        rc, _, out = assert_python_ok("-I", "-X", "showrefcount", "-c", "pass")
+        self.assertEqual(rc, 0)
+        out = out.decode()
-        cmd = [sys.executable, "-I", "-X", "showrefcount", "-c", "pass"]
-        proc = subprocess.run(cmd,
-                              stdout=subprocess.PIPE,
-                              stderr=subprocess.STDOUT,
-                              text=True)
-        self.assertEqual(proc.returncode, 0)
-        out = proc.stdout.rstrip()
+        rc, _, out = assert_python_ok("-I", "-X", "showrefcount", "-c", "pass")
+        self.assertEqual(rc, 0)
+        out = out.decode()
+        match = re.match(r'^\[(-?\d+) refs, (-?\d+) blocks\]', out)
+        if not match:
+            self.fail(f"unexpected output: {out!a}")
+        refs = int(match.group(1))
+        blocks = int(match.group(2))
+        # bpo-46417: Tolerate negative reference count which can occur because
+        # of bugs in C extensions. It is only wrong if it's greater than 0.
+        self.assertLessEqual(refs, 0, out)
+        self.assertEqual(blocks, 0, out)
+
 
 class StdPrinterTests(EmbeddingTestsMixin, unittest.TestCase):
     # Test PyStdPrinter_Type which is used by _PySys_SetPreliminaryStderr():