GH-89988: Fix memory leak in pickle.Pickler dispatch_table lookup (GH-94298)

kumaraditya303 · web-flow · commit 01ef1f95dab9 · 2022-06-28T10:01:43.000+03:00
diff --git a/Lib/test/test_pickle.py b/Lib/test/test_pickle.py
@@ -154,6 +154,29 @@ def persistent_id(obj):
                 return obj
         check(PersPickler)
 
+    @support.cpython_only
+    def test_custom_pickler_dispatch_table_memleak(self):
+        # See https://github.com/python/cpython/issues/89988
+
+        class Pickler(self.pickler):
+            def __init__(self, *args, **kwargs):
+                self.dispatch_table = table
+                super().__init__(*args, **kwargs)
+
+        class DispatchTable:
+            pass
+
+        table = DispatchTable()
+        pickler = Pickler(io.BytesIO())
+        self.assertIs(pickler.dispatch_table, table)
+        table_ref = weakref.ref(table)
+        self.assertIsNotNone(table_ref())
+        del pickler
+        del table
+        support.gc_collect()
+        self.assertIsNone(table_ref())
+
+
     @support.cpython_only
     def test_unpickler_reference_cycle(self):
         def check(Unpickler):
diff --git a/Misc/NEWS.d/next/Library/2022-06-26-10-59-15.gh-issue-89988.K8rnmt.rst b/Misc/NEWS.d/next/Library/2022-06-26-10-59-15.gh-issue-89988.K8rnmt.rst
@@ -0,0 +1 @@
+Fix memory leak in :class:`pickle.Pickler` when looking up :attr:`dispatch_table`. Patch by Kumar Aditya.
diff --git a/Modules/_pickle.c b/Modules/_pickle.c
@@ -4761,7 +4761,9 @@ _pickle_Pickler___init___impl(PicklerObject *self, PyObject *file,
     {
         return -1;
     }
-
+    if (self->dispatch_table != NULL) {
+        return 0;
+    }
     if (_PyObject_LookupAttr((PyObject *)self, &_Py_ID(dispatch_table),
                              &self->dispatch_table) < 0) {
         return -1;

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Fix memory leak in :class:`pickle.Pickler` when looking up :attr:`dispatch_table`. Patch by Kumar Aditya.
Original file line number	Diff line number	Diff line change
`@@ -4761,7 +4761,9 @@ _pickle_Pickler___init___impl(PicklerObject self, PyObject file,`
`4761`	`4761`	`{`
`4762`	`4762`	`return -1;`
`4763`	`4763`	`}`
`4764`		`-`
	`4764`	`+ if (self->dispatch_table != NULL) {`
	`4765`	`+ return 0;`
	`4766`	`+ }`
`4765`	`4767`	`if (_PyObject_LookupAttr((PyObject *)self, &_Py_ID(dispatch_table),`
`4766`	`4768`	`&self->dispatch_table) < 0) {`
`4767`	`4769`	`return -1;`