Warn in colorbar() when mappable.axes != figure.gca().

anntzer · anntzer · commit e3a521486dcd · 2020-07-02T22:37:14.000+02:00
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 @@
+Figure.colorbar now warns when the mappable's axes is different from the current axes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Currently, `.Figure.colorbar` steals space by default from the current axes
+to place the colorbar.  In a future version, it will steal space from the
+mappable's axes instead.  In preparation for this change, `.Figure.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
@@ -2318,13 +2318,20 @@ 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:
+                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)
