FIX: savefig(...,transparent=True) now makes inset_axes transparent

sramesh750 · tacaswell · commit e64af6d64d92 · 2022-04-18T19:07:49.000-04:00
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -3061,10 +3061,24 @@ def savefig(self, fname, *, transparent=None, **kwargs):
             if transparent:
                 kwargs.setdefault('facecolor', 'none')
                 kwargs.setdefault('edgecolor', 'none')
+                # set subfigure to appear transparent in printed image
+                for subfig in self.subfigs:
+                    stack.enter_context(
+                        subfig.patch._cm_set(
+                            facecolor='none', edgecolor='none'))
+                    for subfig_ax in subfig.axes:
+                        stack.enter_context(
+                            subfig_ax.patch._cm_set(
+                                facecolor='none', edgecolor='none'))
+                # set axes to be transparent
                 for ax in self.axes:
                     stack.enter_context(
                         ax.patch._cm_set(facecolor='none', edgecolor='none'))
-
+                    # set inset axes to be transparent as well
+                    for child_ax in ax.child_axes:
+                        stack.enter_context(
+                            child_ax.patch._cm_set(
+                                facecolor='none', edgecolor='none'))
             self.canvas.print_figure(fname, **kwargs)
 
     def ginput(self, n=1, timeout=30, show_clicks=True,
diff --git a/lib/matplotlib/tests/baseline_images/test_figure/transparent_background.png b/lib/matplotlib/tests/baseline_images/test_figure/transparent_background.png
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
@@ -557,6 +557,24 @@ def test_savefig_pixel_ratio(backend):
     assert ratio1 == ratio2
 
 
+@image_comparison(['transparent_background'],
+                    extensions=['png'], savefig_kwarg={'transparent': True},
+                    remove_text=True)
+def test_savefig_transparent():
+    # create two transparent subfigures with corresponding transparent inset
+    # axes. the entire background of the image should be transparent.
+    fig = plt.gcf()
+    gs = fig.add_gridspec(3, 3)
+    fig.add_subfigure(gs[0, 0])
+    fig.add_subplot(gs[0, 0])
+    ax = plt.gca()
+    ax.inset_axes([.1, .2, .3, .4])
+    fig.add_subfigure(gs[0:2, 1])
+    fig.add_subplot(gs[0:2, 1])
+    ax2 = plt.gca()
+    ax2.inset_axes([.1, .2, .3, .4])
+
+
 def test_figure_repr():
     fig = plt.figure(figsize=(10, 20), dpi=10)
     assert repr(fig) == "<Figure size 100x200 with 0 Axes>"
