Merge pull request #12443 from anntzer/colorbar-mappable-axes

QuLogic · web-flow · commit 98961f624d72 · 2020-07-18T03:27:01.000-04:00
Warn in colorbar() when mappable.axes != figure.gca().
diff --git a/doc/api/next_api_changes/deprecations/12443-AL.rst b/doc/api/next_api_changes/deprecations/12443-AL.rst
@@ -0,0 +1,8 @@
+``colorbar`` now warns when the mappable's axes is different from the current axes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Currently, `.Figure.colorbar` and `.pyplot.colorbar` steal space by default
+from the current axes to place the colorbar.  In a future version, they will
+steal space from the mappable's axes instead.  In preparation for this change,
+`.Figure.colorbar` and `.pyplot.colorbar` now emits a warning when the current
+axes is not the same as the mappable's axes.
diff --git a/lib/matplotlib/blocking_input.py b/lib/matplotlib/blocking_input.py
@@ -277,7 +277,7 @@ class BlockingContourLabeler(BlockingMouseInput):
 
     def __init__(self, cs):
         self.cs = cs
-        BlockingMouseInput.__init__(self, fig=cs.ax.figure)
+        BlockingMouseInput.__init__(self, fig=cs.axes.figure)
 
     def add_click(self, event):
         self.button1(event)
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2322,13 +2322,21 @@ def colorbar(self, mappable, cax=None, ax=None, use_gridspec=True, **kw):
         """%(colorbar_doc)s"""
         if ax is None:
             ax = self.gca()
+            if (hasattr(mappable, "axes") and ax is not mappable.axes
+                    and cax is None):
+                cbook.warn_deprecated(
+                    "3.4", message="Starting from Matplotlib 3.6, colorbar() "
+                    "will steal space from the mappable's axes, rather than "
+                    "from the current axes, to place the colorbar.  To "
+                    "silence this warning, explicitly pass the 'ax' argument "
+                    "to colorbar().")
 
         # Store the value of gca so that we can set it back later on.
         current_ax = self.gca()
 
         if cax is None:
-            if use_gridspec and isinstance(ax, SubplotBase)  \
-                     and (not self.get_constrained_layout()):
+            if (use_gridspec and isinstance(ax, SubplotBase)
+                    and not self.get_constrained_layout()):
                 cax, kw = cbar.make_axes_gridspec(ax, **kw)
             else:
                 cax, kw = cbar.make_axes(ax, **kw)
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -2167,8 +2167,6 @@ def colorbar(mappable=None, cax=None, ax=None, **kw):
                                'creation. First define a mappable such as '
                                'an image (with imshow) or a contour set ('
                                'with contourf).')
-    if ax is None:
-        ax = gca()
     ret = gcf().colorbar(mappable, cax=cax, ax=ax, **kw)
     return ret
 
