Don't save parents in LayoutGrid

QuLogic · QuLogic · commit 8864085960b7 · 2023-05-10T17:14:03.000-04:00
Internally, the parent is only used in `__init__`, so doesn't need to be
saved as an attribute. Externally, the constrained layout code needs the
parent only for subfigure margins, but we have the parent gridspec
available directly to use.

The `LayoutGrid` stores its children in a NumPy array, and saving the
parent causes a reference cycle. Apparently having one reference in a
C-level NumPy array causes Python to not realize it can garbage collect
the cycle, causing all `LayoutGrid` and its children to leak.
diff --git a/lib/matplotlib/_constrained_layout.py b/lib/matplotlib/_constrained_layout.py
@@ -346,13 +346,15 @@ def make_layout_margins(layoutgrids, fig, renderer, *, w_pad=0, h_pad=0,
     """
     for sfig in fig.subfigs:  # recursively make child panel margins
         ss = sfig._subplotspec
+        gs = ss.get_gridspec()
+
         make_layout_margins(layoutgrids, sfig, renderer,
                             w_pad=w_pad, h_pad=h_pad,
                             hspace=hspace, wspace=wspace)
 
         margins = get_margin_from_padding(sfig, w_pad=0, h_pad=0,
                                           hspace=hspace, wspace=wspace)
-        layoutgrids[sfig].parent.edit_outer_margin_mins(margins, ss)
+        layoutgrids[gs].edit_outer_margin_mins(margins, ss)
 
     for ax in fig._localaxes:
         if not ax.get_subplotspec() or not ax.get_in_layout():
diff --git a/lib/matplotlib/_layoutgrid.py b/lib/matplotlib/_layoutgrid.py
@@ -38,7 +38,6 @@ def __init__(self, parent=None, parent_pos=(0, 0),
                  h_pad=None, w_pad=None, width_ratios=None,
                  height_ratios=None):
         Variable = kiwi.Variable
-        self.parent = parent
         self.parent_pos = parent_pos
         self.parent_inner = parent_inner
         self.name = name + seq_id()
@@ -57,12 +56,10 @@ def __init__(self, parent=None, parent_pos=(0, 0),
         if not isinstance(parent, LayoutGrid):
             # parent can be a rect if not a LayoutGrid
             # allows specifying a rectangle to contain the layout.
-            self.parent = parent
             self.solver = kiwi.Solver()
         else:
-            self.parent = parent
             parent.add_child(self, *parent_pos)
-            self.solver = self.parent.solver
+            self.solver = parent.solver
         # keep track of artist associated w/ this layout.  Can be none
         self.artists = np.empty((nrows, ncols), dtype=object)
         self.children = np.empty((nrows, ncols), dtype=object)
@@ -100,7 +97,7 @@ def __init__(self, parent=None, parent_pos=(0, 0),
         # set these margins to zero by default. They will be edited as
         # children are filled.
         self.reset_margins()
-        self.add_constraints()
+        self.add_constraints(parent)
 
         self.h_pad = h_pad
         self.w_pad = w_pad
@@ -130,11 +127,11 @@ def reset_margins(self):
                      'leftcb', 'rightcb', 'bottomcb', 'topcb']:
             self.edit_margins(todo, 0.0)
 
-    def add_constraints(self):
+    def add_constraints(self, parent):
         # define self-consistent constraints
         self.hard_constraints()
         # define relationship with parent layoutgrid:
-        self.parent_constraints()
+        self.parent_constraints(parent)
         # define relative widths of the grid cells to each other
         # and stack horizontally and vertically.
         self.grid_constraints()
@@ -168,12 +165,11 @@ def add_child(self, child, i=0, j=0):
         # np.ix_ returns the cross product of i and j indices
         self.children[np.ix_(np.atleast_1d(i), np.atleast_1d(j))] = child
 
-    def parent_constraints(self):
+    def parent_constraints(self, parent):
         # constraints that are due to the parent...
         # i.e. the first column's left is equal to the
         # parent's left, the last column right equal to the
         # parent's right...
-        parent = self.parent
         if not isinstance(parent, LayoutGrid):
             # specify a rectangle in figure coordinates
             hc = [self.lefts[0] == parent[0],
