MAINT: Updating all cbar.ax calls to just cbar

This is for clarity that the colorbar is now an Axes itself.
greglucas · Jun 2, 2021 · Jun 2, 2021 · Jun 2, 2021 · Jun 2, 2021 · Jun 11, 2021
commit 8a3223411d924c7115502ee9bee6ba5b706eaf70
diff --git a/examples/axes_grid1/demo_axes_divider.py b/examples/axes_grid1/demo_axes_divider.py
@@ -22,7 +22,7 @@ def demo_simple_image(ax):
 
     im = ax.imshow(Z, extent=extent)
     cb = plt.colorbar(im)
-    plt.setp(cb.ax.get_yticklabels(), visible=False)
+    plt.setp(cb.get_yticklabels(), visible=False)
 
 
 def demo_locatable_axes_hard(fig):

diff --git a/examples/images_contours_and_fields/contour_demo.py b/examples/images_contours_and_fields/contour_demo.py
@@ -103,8 +103,8 @@
 # so let's improve its position.
 
 l, b, w, h = ax.get_position().bounds
-ll, bb, ww, hh = CB.ax.get_position().bounds
-CB.ax.set_position([ll, b + 0.1*h, ww, h*0.8])
+ll, bb, ww, hh = CB.get_position().bounds
+CB.set_position([ll, b + 0.1*h, ww, h*0.8])
 
 plt.show()
 

diff --git a/examples/images_contours_and_fields/contourf_demo.py b/examples/images_contours_and_fields/contourf_demo.py
@@ -54,7 +54,7 @@
 
 # Make a colorbar for the ContourSet returned by the contourf call.
 cbar = fig1.colorbar(CS)
-cbar.ax.set_ylabel('verbosity coefficient')
+cbar.set_ylabel('verbosity coefficient')
 # Add the contour line levels to the colorbar
 cbar.add_lines(CS2)
 

diff --git a/examples/images_contours_and_fields/image_annotated_heatmap.py b/examples/images_contours_and_fields/image_annotated_heatmap.py
@@ -131,7 +131,7 @@ def heatmap(data, row_labels, col_labels, ax=None,
 
     # Create colorbar
     cbar = ax.figure.colorbar(im, ax=ax, **cbar_kw)
-    cbar.ax.set_ylabel(cbarlabel, rotation=-90, va="bottom")
+    cbar.set_ylabel(cbarlabel, rotation=-90, va="bottom")
 
     # We want to show all ticks...
     ax.set_xticks(np.arange(data.shape[1]))

diff --git a/examples/ticks_and_spines/colorbar_tick_labelling_demo.py b/examples/ticks_and_spines/colorbar_tick_labelling_demo.py
@@ -29,7 +29,7 @@
 
 # Add colorbar, make sure to specify tick locations to match desired ticklabels
 cbar = fig.colorbar(cax, ticks=[-1, 0, 1])
-cbar.ax.set_yticklabels(['< -1', '0', '> 1'])  # vertically oriented colorbar
+cbar.set_yticklabels(['< -1', '0', '> 1'])  # vertically oriented colorbar
 
 ###############################################################################
 # Make plot with horizontal colorbar
@@ -42,6 +42,6 @@
 ax.set_title('Gaussian noise with horizontal colorbar')
 
 cbar = fig.colorbar(cax, ticks=[-1, 0, 1], orientation='horizontal')
-cbar.ax.set_xticklabels(['Low', 'Medium', 'High'])  # horizontal colorbar
+cbar.set_xticklabels(['Low', 'Medium', 'High'])  # horizontal colorbar
 
 plt.show()
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -1,6 +1,6 @@
 """
 Colorbars are a visualization of the mapping from scalar values to colors.
-In Matplotlib they are drawn into a dedicated `~.axes.Axes`.
+In Matplotlib they are a separate dedicated `~.axes.Axes`.
 
 .. note::
    Colorbars are typically created through `.Figure.colorbar` or its pyplot
@@ -233,7 +233,7 @@ class ColorbarAxes(Axes):
     over/under colors.
 
     Users should not normally instantiate this class, but it is the class
-    returned by ``cbar = fig.colorbar(im); cax = cbar.ax``.
+    that the Colorbar inherits from by ``cbar = fig.colorbar(im);``.
     """
     def __init__(self, parent, userax=True):
         """
@@ -339,8 +339,6 @@ class ColorbarBase(ColorbarAxes):
 
     Attributes
     ----------
-    ax : `~matplotlib.axes.Axes`
-        The `~.axes.Axes` instance in which the colorbar is drawn.
     lines : list
         A list of `.LineCollection` (empty if no lines were drawn).
     dividers : `.LineCollection`
@@ -384,7 +382,7 @@ class ColorbarBase(ColorbarAxes):
     label : str
 
     userax : boolean
-        Whether the user created the axes or not.  Default True
+        Whether the user created the axes or not.  Default False
     """
 
     n_rasterize = 50  # rasterize solids if number of colors >= n_rasterize

diff --git a/lib/matplotlib/tests/test_colorbar.py b/lib/matplotlib/tests/test_colorbar.py
@@ -284,7 +284,7 @@ def test_colorbar_ticks():
     colors = ['r', 'g', 'b', 'c']
     cs = ax.contourf(X, Y, Z, clevs, colors=colors, extend='neither')
     cbar = fig.colorbar(cs, ax=ax, orientation='horizontal', ticks=clevs)
-    assert len(cbar.ax.xaxis.get_ticklocs()) == len(clevs)
+    assert len(cbar.xaxis.get_ticklocs()) == len(clevs)
 
 
 def test_colorbar_minorticks_on_off():
@@ -301,17 +301,17 @@ def test_colorbar_minorticks_on_off():
         # testing after minorticks_on()
         cbar.minorticks_on()
         np.testing.assert_almost_equal(
-            cbar.ax.yaxis.get_minorticklocs(),
+            cbar.yaxis.get_minorticklocs(),
             [-2.2, -1.8, -1.6, -1.4, -1.2, -0.8, -0.6, -0.4, -0.2,
              0.2, 0.4, 0.6, 0.8, 1.2, 1.4, 1.6, 1.8, 2.2, 2.4, 2.6, 2.8, 3.2])
         # testing after minorticks_off()
         cbar.minorticks_off()
-        np.testing.assert_almost_equal(cbar.ax.yaxis.get_minorticklocs(), [])
+        np.testing.assert_almost_equal(cbar.yaxis.get_minorticklocs(), [])
 
         im.set_clim(vmin=-1.2, vmax=1.2)
         cbar.minorticks_on()
         np.testing.assert_almost_equal(
-            cbar.ax.yaxis.get_minorticklocs(),
+            cbar.yaxis.get_minorticklocs(),
             [-1.1, -0.9, -0.8, -0.7, -0.6, -0.4, -0.3, -0.2, -0.1,
              0.1, 0.2, 0.3, 0.4, 0.6, 0.7, 0.8, 0.9, 1.1, 1.2, 1.3])
 
@@ -322,20 +322,20 @@ def test_colorbar_minorticks_on_off():
     im = ax.pcolormesh(data, norm=LogNorm())
     cbar = fig.colorbar(im)
     fig.canvas.draw()
-    default_minorticklocks = cbar.ax.yaxis.get_minorticklocs()
+    default_minorticklocks = cbar.yaxis.get_minorticklocs()
     # test that minorticks turn off for LogNorm
     cbar.minorticks_off()
-    np.testing.assert_equal(cbar.ax.yaxis.get_minorticklocs(), [])
+    np.testing.assert_equal(cbar.yaxis.get_minorticklocs(), [])
 
     # test that minorticks turn back on for LogNorm
     cbar.minorticks_on()
-    np.testing.assert_equal(cbar.ax.yaxis.get_minorticklocs(),
+    np.testing.assert_equal(cbar.yaxis.get_minorticklocs(),
                             default_minorticklocks)
 
     # test issue #13339: minorticks for LogNorm should stay off
     cbar.minorticks_off()
     cbar.set_ticks([3, 5, 7, 9])
-    np.testing.assert_equal(cbar.ax.yaxis.get_minorticklocs(), [])
+    np.testing.assert_equal(cbar.yaxis.get_minorticklocs(), [])
 
 
 def test_cbar_minorticks_for_rc_xyminortickvisible():
@@ -358,12 +358,12 @@ def test_cbar_minorticks_for_rc_xyminortickvisible():
     im = ax.pcolormesh([[1, 2]], vmin=vmin, vmax=vmax)
 
     cbar = fig.colorbar(im, extend='both', orientation='vertical')
-    assert cbar.ax.yaxis.get_minorticklocs()[0] >= vmin
-    assert cbar.ax.yaxis.get_minorticklocs()[-1] <= vmax
+    assert cbar.yaxis.get_minorticklocs()[0] >= vmin
+    assert cbar.yaxis.get_minorticklocs()[-1] <= vmax
 
     cbar = fig.colorbar(im, extend='both', orientation='horizontal')
-    assert cbar.ax.xaxis.get_minorticklocs()[0] >= vmin
-    assert cbar.ax.xaxis.get_minorticklocs()[-1] <= vmax
+    assert cbar.xaxis.get_minorticklocs()[0] >= vmin
+    assert cbar.xaxis.get_minorticklocs()[-1] <= vmax
 
 
 def test_colorbar_autoticks():
@@ -384,7 +384,7 @@ def test_colorbar_autoticks():
         cbar2 = fig.colorbar(pcm, ax=ax[1], extend='both',
                              orientation='vertical', shrink=0.4)
         # note only -10 to 10 are visible,
-        np.testing.assert_almost_equal(cbar.ax.yaxis.get_ticklocs(),
+        np.testing.assert_almost_equal(cbar.yaxis.get_ticklocs(),
                                        np.arange(-15, 16, 5))
         # note only -10 to 10 are visible
         np.testing.assert_almost_equal(cbar2.ax.yaxis.get_ticklocs(),
@@ -408,7 +408,7 @@ def test_colorbar_autotickslog():
         cbar2 = fig.colorbar(pcm, ax=ax[1], extend='both',
                              orientation='vertical', shrink=0.4)
         # note only -12 to +12 are visible
-        np.testing.assert_almost_equal(cbar.ax.yaxis.get_ticklocs(),
+        np.testing.assert_almost_equal(cbar.yaxis.get_ticklocs(),
                                        10**np.arange(-16., 16.2, 4.))
         # note only -24 to +24 are visible
         np.testing.assert_almost_equal(cbar2.ax.yaxis.get_ticklocs(),
@@ -488,7 +488,7 @@ def test_colorbar_log_minortick_labels():
         pcm = ax.imshow([[10000, 50000]], norm=LogNorm())
         cb = fig.colorbar(pcm)
         fig.canvas.draw()
-        lb = [l.get_text() for l in cb.ax.yaxis.get_ticklabels(which='both')]
+        lb = [l.get_text() for l in cb.yaxis.get_ticklabels(which='both')]
         expected = [r'$\mathdefault{10^{4}}$',
                     r'$\mathdefault{2\times10^{4}}$',
                     r'$\mathdefault{3\times10^{4}}$',
@@ -504,21 +504,21 @@ def test_colorbar_renorm():
     fig, ax = plt.subplots()
     im = ax.imshow(z)
     cbar = fig.colorbar(im)
-    np.testing.assert_allclose(cbar.ax.yaxis.get_majorticklocs(),
+    np.testing.assert_allclose(cbar.yaxis.get_majorticklocs(),
                                np.arange(0, 120000.1, 20000))
 
     cbar.set_ticks([1, 2, 3])
     assert isinstance(cbar.locator, FixedLocator)
 
     norm = LogNorm(z.min(), z.max())
     im.set_norm(norm)
-    np.testing.assert_allclose(cbar.ax.yaxis.get_majorticklocs(),
+    np.testing.assert_allclose(cbar.yaxis.get_majorticklocs(),
                                np.logspace(-10, 7, 18))
     # note that set_norm removes the FixedLocator...
     assert np.isclose(cbar.vmin, z.min())
     cbar.set_ticks([1, 2, 3])
     assert isinstance(cbar.locator, FixedLocator)
-    np.testing.assert_allclose(cbar.ax.yaxis.get_majorticklocs(),
+    np.testing.assert_allclose(cbar.yaxis.get_majorticklocs(),
                                [1.0, 2.0, 3.0])
 
     norm = LogNorm(z.min() * 1000, z.max() * 1000)
@@ -536,18 +536,18 @@ def test_colorbar_format():
     im = ax.imshow(z)
     cbar = fig.colorbar(im, format='%4.2e')
     fig.canvas.draw()
-    assert cbar.ax.yaxis.get_ticklabels()[4].get_text() == '8.00e+04'
+    assert cbar.yaxis.get_ticklabels()[4].get_text() == '8.00e+04'
 
     # make sure that if we change the clim of the mappable that the
     # formatting is *not* lost:
     im.set_clim([4, 200])
     fig.canvas.draw()
-    assert cbar.ax.yaxis.get_ticklabels()[4].get_text() == '2.00e+02'
+    assert cbar.yaxis.get_ticklabels()[4].get_text() == '2.00e+02'
 
     # but if we change the norm:
     im.set_norm(LogNorm(vmin=0.1, vmax=10))
     fig.canvas.draw()
-    assert (cbar.ax.yaxis.get_ticklabels()[0].get_text() ==
+    assert (cbar.yaxis.get_ticklabels()[0].get_text() ==
             r'$\mathdefault{10^{-2}}$')
 
 
@@ -559,12 +559,12 @@ def test_colorbar_scale_reset():
     pcm = ax.pcolormesh(z, cmap='RdBu_r', rasterized=True)
     cbar = fig.colorbar(pcm, ax=ax)
     cbar.outline.set_edgecolor('red')
-    assert cbar.ax.yaxis.get_scale() == 'linear'
+    assert cbar.yaxis.get_scale() == 'linear'
 
     pcm.set_norm(LogNorm(vmin=1, vmax=100))
-    assert cbar.ax.yaxis.get_scale() == 'log'
+    assert cbar.yaxis.get_scale() == 'log'
     pcm.set_norm(Normalize(vmin=-20, vmax=20))
-    assert cbar.ax.yaxis.get_scale() == 'linear'
+    assert cbar.yaxis.get_scale() == 'linear'
 
     assert cbar.outline.get_edgecolor() == mcolors.to_rgba('red')
 
@@ -583,7 +583,7 @@ def test_colorbar_inverted_ticks():
     pc = ax.pcolormesh(10**np.arange(1, 5).reshape(2, 2), norm=LogNorm())
     cbar = fig.colorbar(pc, ax=ax, extend='both')
     ticks = cbar.get_ticks()
-    cbar.ax.invert_yaxis()
+    cbar.invert_yaxis()
     np.testing.assert_allclose(ticks, cbar.get_ticks())
 
     ax = axs[1]
@@ -592,7 +592,7 @@ def test_colorbar_inverted_ticks():
     cbar.minorticks_on()
     ticks = cbar.get_ticks()
     minorticks = cbar.get_ticks(minor=True)
-    cbar.ax.invert_yaxis()
+    cbar.invert_yaxis()
     np.testing.assert_allclose(ticks, cbar.get_ticks())
     np.testing.assert_allclose(minorticks, cbar.get_ticks(minor=True))
 
@@ -603,7 +603,7 @@ def test_extend_colorbar_customnorm():
     fig, (ax0, ax1) = plt.subplots(2, 1)
     pcm = ax0.pcolormesh([[0]], norm=TwoSlopeNorm(vcenter=0., vmin=-2, vmax=1))
     cb = fig.colorbar(pcm, ax=ax0, extend='both')
-    np.testing.assert_allclose(cb.ax.get_position().extents,
+    np.testing.assert_allclose(cb.get_position().extents,
                                [0.78375, 0.536364, 0.796147, 0.9], rtol=2e-3)
 
 
@@ -623,11 +623,11 @@ def test_colorbar_label():
     fig, ax = plt.subplots()
     im = ax.imshow([[1, 2], [3, 4]])
     cbar = fig.colorbar(im, label='cbar')
-    assert cbar.ax.get_ylabel() == 'cbar'
+    assert cbar.get_ylabel() == 'cbar'
     cbar.set_label(None)
-    assert cbar.ax.get_ylabel() == ''
+    assert cbar.get_ylabel() == ''
     cbar.set_label('cbar 2')
-    assert cbar.ax.get_ylabel() == 'cbar 2'
+    assert cbar.get_ylabel() == 'cbar 2'
 
     cbar2 = fig.colorbar(im, label=None)
     assert cbar2.ax.get_ylabel() == ''
@@ -663,7 +663,7 @@ def test_anchored_cbar_position_using_specgrid():
     # the top right corner of one ax is (x1, y1)
     # p0: the vertical / horizontal position of anchor
     x0, y0, x1, y1 = ax.get_position().extents
-    cx0, cy0, cx1, cy1 = cbar.ax.get_position().extents
+    cx0, cy0, cx1, cy1 = cbar.get_position().extents
     p0 = (y1 - y0) * anchor_y + y0
 
     np.testing.assert_allclose(
@@ -681,7 +681,7 @@ def test_anchored_cbar_position_using_specgrid():
     # the top right corner of one ax is (x1, y1)
     # p0: the vertical / horizontal position of anchor
     x0, y0, x1, y1 = ax.get_position().extents
-    cx0, cy0, cx1, cy1 = cbar.ax.get_position().extents
+    cx0, cy0, cx1, cy1 = cbar.get_position().extents
     p0 = (y1 - y0) * anchor_y + y0
 
     np.testing.assert_allclose(
@@ -701,7 +701,7 @@ def test_anchored_cbar_position_using_specgrid():
     # the top right corner of one ax is (x1, y1)
     # p0: the vertical / horizontal position of anchor
     x0, y0, x1, y1 = ax.get_position().extents
-    cx0, cy0, cx1, cy1 = cbar.ax.get_position().extents
+    cx0, cy0, cx1, cy1 = cbar.get_position().extents
     p0 = (x1 - x0) * anchor_x + x0
 
     np.testing.assert_allclose(
@@ -721,7 +721,7 @@ def test_anchored_cbar_position_using_specgrid():
     # the top right corner of one ax is (x1, y1)
     # p0: the vertical / horizontal position of anchor
     x0, y0, x1, y1 = ax.get_position().extents
-    cx0, cy0, cx1, cy1 = cbar.ax.get_position().extents
+    cx0, cy0, cx1, cy1 = cbar.get_position().extents
     p0 = (x1 - x0) * anchor_x + x0
 
     np.testing.assert_allclose(
@@ -735,16 +735,16 @@ def test_colorbar_change_lim_scale():
     fig, ax = plt.subplots(1, 2, constrained_layout=True)
     pc = ax[0].pcolormesh(np.arange(100).reshape(10, 10)+1)
     cb = fig.colorbar(pc, ax=ax[0], extend='both')
-    cb.ax.set_yscale('log')
+    cb.set_yscale('log')
 
     pc = ax[1].pcolormesh(np.arange(100).reshape(10, 10)+1)
     cb = fig.colorbar(pc, ax=ax[1], extend='both')
-    cb.ax.set_ylim([20, 90])
+    cb.set_ylim([20, 90])
 
 
 @check_figures_equal(extensions=["png"])
 def test_axes_handles_same_functions(fig_ref, fig_test):
-    # prove that cax and cb.ax are functionally the same
+    # prove that cax and cb are functionally the same
     for nn, fig in enumerate([fig_ref, fig_test]):
         ax = fig.add_subplot()
         pc = ax.pcolormesh(np.ones(300).reshape(10, 30))
@@ -753,7 +753,7 @@ def test_axes_handles_same_functions(fig_ref, fig_test):
         if nn == 0:
             caxx = cax
         else:
-            caxx = cb.ax
+            caxx = cb
         caxx.set_yticks(np.arange(20))
         caxx.set_yscale('log')
         caxx.set_position([0.92, 0.1, 0.02, 0.7])

diff --git a/lib/matplotlib/tests/test_constrainedlayout.py b/lib/matplotlib/tests/test_constrainedlayout.py
@@ -422,10 +422,10 @@ def test_colorbar_align():
             cb = fig.colorbar(pc, ax=ax, location=location, shrink=0.6,
                               pad=0.04)
             cbs += [cb]
-            cb.ax.tick_params(direction='in')
+            cb.tick_params(direction='in')
             if nn != 1:
-                cb.ax.xaxis.set_ticks([])
-                cb.ax.yaxis.set_ticks([])
+                cb.xaxis.set_ticks([])
+                cb.yaxis.set_ticks([])
                 ax.set_xticklabels('')
                 ax.set_yticklabels('')
         fig.set_constrained_layout_pads(w_pad=4 / 72, h_pad=4 / 72, hspace=0.1,

diff --git a/lib/matplotlib/tests/test_contour.py b/lib/matplotlib/tests/test_contour.py
@@ -334,9 +334,9 @@ def test_contourf_log_extension():
                       norm=LogNorm(vmin=levels.min(), vmax=levels.max()),
                       extend='both')
     cb = plt.colorbar(c1, ax=ax1)
-    assert cb.ax.get_ylim() == (1e-8, 1e10)
+    assert cb.get_ylim() == (1e-8, 1e10)
     cb = plt.colorbar(c2, ax=ax2)
-    assert cb.ax.get_ylim() == (1e-4, 1e6)
+    assert cb.get_ylim() == (1e-4, 1e6)
     cb = plt.colorbar(c3, ax=ax3)
 
 
@@ -356,7 +356,7 @@ def test_contour_addlines():
     cont = ax.contour(X+1000)
     cb = fig.colorbar(pcm)
     cb.add_lines(cont)
-    assert_array_almost_equal(cb.ax.get_ylim(), [114.3091, 9972.30735], 3)
+    assert_array_almost_equal(cb.get_ylim(), [114.3091, 9972.30735], 3)
 
 
 @image_comparison(baseline_images=['contour_uneven'],