resolve suggested improvements

Author: immaxchen

examples/lines_bars_and_markers/bar_label_demo.py

@@ -32,42 +32,44 @@
 ###############################################################################
 # Grouped bar chart
 
-fig1, ax1 = plt.subplots()
+fig, ax = plt.subplots()
 
-rects1 = ax1.bar(ind - width/2, menMeans, width, label='Men')
-rects2 = ax1.bar(ind + width/2, womenMeans, width, label='Women')
+rects1 = ax.bar(ind - width/2, menMeans, width, label='Men')
+rects2 = ax.bar(ind + width/2, womenMeans, width, label='Women')
 
-ax1.set_ylabel('Scores')
-ax1.set_title('Scores by group and gender')
-ax1.set_xticks(ind)
-ax1.set_xticklabels(('G1', 'G2', 'G3', 'G4', 'G5'))
-ax1.legend()
+ax.axhline(0, color='grey', linewidth=0.8)
+ax.set_ylabel('Scores')
+ax.set_title('Scores by group and gender')
+ax.set_xticks(ind)
+ax.set_xticklabels(('G1', 'G2', 'G3', 'G4', 'G5'))
+ax.legend()
 
 # Basic labels
-ax1.bar_label(rects1)
-ax1.bar_label(rects2)
+ax.bar_label(rects1)
+ax.bar_label(rects2)
 
 plt.show()
 
 ###############################################################################
 # Stacked bar plot with error bars
 
-fig2, ax2 = plt.subplots()
+fig, ax = plt.subplots()
 
-p1 = ax2.bar(ind, menMeans, width, yerr=menStd, label='Men')
-p2 = ax2.bar(ind, womenMeans, width,
-             bottom=menMeans, yerr=womenStd, label='Women')
+p1 = ax.bar(ind, menMeans, width, yerr=menStd, label='Men')
+p2 = ax.bar(ind, womenMeans, width,
+            bottom=menMeans, yerr=womenStd, label='Women')
 
-ax2.set_ylabel('Scores')
-ax2.set_title('Scores by group and gender')
-ax2.set_xticks(ind)
-ax2.set_xticklabels(('G1', 'G2', 'G3', 'G4', 'G5'))
-ax2.legend()
+ax.axhline(0, color='grey', linewidth=0.8)
+ax.set_ylabel('Scores')
+ax.set_title('Scores by group and gender')
+ax.set_xticks(ind)
+ax.set_xticklabels(('G1', 'G2', 'G3', 'G4', 'G5'))
+ax.legend()
 
-# Label with 'center' mode instead of the default 'edge' mode
-ax2.bar_label(p1, mode='center')
-ax2.bar_label(p2, mode='center')
-ax2.bar_label(p2)
+# Label with position 'center' instead of the default 'edge'
+ax.bar_label(p1, position='center')
+ax.bar_label(p2, position='center')
+ax.bar_label(p2)
 
 plt.show()
 
@@ -83,38 +85,39 @@
 performance = 3 + 10 * np.random.rand(len(people))
 error = np.random.rand(len(people))
 
-fig3, ax3 = plt.subplots()
+fig, ax = plt.subplots()
 
-hbars1 = ax3.barh(y_pos, performance, xerr=error, align='center')
-ax3.set_yticks(y_pos)
-ax3.set_yticklabels(people)
-ax3.invert_yaxis()  # labels read top-to-bottom
-ax3.set_xlabel('Performance')
-ax3.set_title('How fast do you want to go today?')
+hbars = ax.barh(y_pos, performance, xerr=error, align='center')
+ax.set_yticks(y_pos)
+ax.set_yticklabels(people)
+ax.invert_yaxis()  # labels read top-to-bottom
+ax.set_xlabel('Performance')
+ax.set_title('How fast do you want to go today?')
 
 # Label with specially formatted floats
-ax3.bar_label(hbars1, fmt='%.2f')
+ax.bar_label(hbars, fmt='%.2f')
+ax.set_xlim(right=15)  # adjust xlim to fit labels
 
 plt.show()
 
 ###############################################################################
 # Some of the more advanced things that one can do with bar labels
 
-fig4, ax4 = plt.subplots()
+fig, ax = plt.subplots()
 
-hbars2 = ax4.barh(y_pos, performance, xerr=error, align='center')
-ax4.set_yticks(y_pos)
-ax4.set_yticklabels(people)
-ax4.invert_yaxis()  # labels read top-to-bottom
-ax4.set_xlabel('Performance')
-ax4.set_title('How fast do you want to go today?')
+hbars = ax.barh(y_pos, performance, xerr=error, align='center')
+ax.set_yticks(y_pos)
+ax.set_yticklabels(people)
+ax.invert_yaxis()  # labels read top-to-bottom
+ax.set_xlabel('Performance')
+ax.set_title('How fast do you want to go today?')
 
 # Label with given captions, custom padding, shifting and annotate option
 arrowprops = dict(color='b', arrowstyle="-|>",
                   connectionstyle="angle,angleA=0,angleB=90,rad=20")
-
-ax4.bar_label(hbars2, captions=['±%.2f' % e for e in error],
-              padding=30, shifting=20, arrowprops=arrowprops, color='b')
+ax.bar_label(hbars, captions=['±%.2f' % e for e in error],
+             padding=30, shifting=20, arrowprops=arrowprops, color='b')
+ax.set_xlim(right=17)
 
 plt.show()
 

lib/matplotlib/axes/_axes.py

@@ -2381,8 +2381,8 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
 
         self._request_autoscale_view()
 
-        bar_container = BarContainer(patches, errorbar, orientation,
-                                     label=label)
+        bar_container = BarContainer(patches, errorbar,
+                                     orientation=orientation, label=label)
         self.add_container(bar_container)
 
         if tick_labels is not None:
@@ -2498,12 +2498,13 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
                            align=align, **kwargs)
         return patches
 
-    def bar_label(self, container, captions=[], fmt="%g", mode="edge",
-                  padding=None, shifting=0, autoscale=True, **kwargs):
+    def bar_label(self, container, captions=[], *, fmt="%g", position="edge",
+                  padding=0, shifting=0, **kwargs):
         """
         Label a bar plot.
 
         Adds labels to bars in the given `.BarContainer`.
+        You may need to adjust the axis limits to fit the labels.
 
         Parameters
         ----------
@@ -2514,40 +2515,33 @@ def bar_label(self, container, captions=[], fmt="%g", mode="edge",
             A list of label texts, that should be displayed. If not given, the
             label texts will be the data values formatted with *fmt*.
 
-        fmt : str, optional
-            A format string for the label. Default is '%g'
+        fmt : str, default: '%g'
+            A format string for the label.
 
-        mode : {'edge', 'center'}, optional, default: 'edge'
+        position : {'edge', 'center'}, default: 'edge'
             Position of the label relative to the bar:
 
             - 'edge': Placed at edge, the cumulative values will be shown.
             - 'center': Placed at center, the individual values will be shown.
 
-        padding : float, optional
-            Space in points for label to leave the edge of the bar.
-
-        shifting : float, optional
-            Translation in points for label to leave the center of the bar.
+        padding : float, default: 0
+            Offset in points for label to shift in longitudinal direction.
 
-        autoscale : bool, optional
-            If ``True``, try to rescale to fit the labels. Default is ``True``.
+        shifting : float, default: 0
+            Offset in points for label to shift in lateral direction.
 
         Returns
         -------
         annotations
             A list of `.Text` instances for the labels.
         """
-        def nonefill(a, n):
-            return list(a) + [None] * (n - len(a))
+        def extend_with_none(iterable, length):
+            return list(iterable) + [None] * (length - len(iterable))
 
         def sign(x):
             return 1 if x >= 0 else -1
 
-        cbook._check_in_list(['edge', 'center'], mode=mode)
-        if mode == "edge":
-            padding = padding or 3
-        elif mode == "center":
-            padding = padding or 0
+        cbook._check_in_list(['edge', 'center'], position=position)
 
         bars = container.patches
         errorbar = container.errorbar
@@ -2559,10 +2553,10 @@ def sign(x):
             barlinecols = lines[2]
             barlinecol = barlinecols[0]
             segments = barlinecol.get_segments()
-            errs = nonefill(segments, N)
+            errs = extend_with_none(segments, length=N)
         else:
-            errs = nonefill([], N)
-        caps = nonefill(captions, N)
+            errs = extend_with_none([], length=N)
+        caps = extend_with_none(captions, length=N)
 
         annotations = []
         for bar, err, cap in zip(bars, errs, caps):
@@ -2584,49 +2578,41 @@ def sign(x):
             elif orientation == "horizontal":
                 endpt = err[:, 0].max() if xc >= 0 else err[:, 0].min()
 
-            if mode == "center":
+            if position == "center":
                 value = sign(extrema) * length
-            elif mode == "edge":
+            elif position == "edge":
                 value = extrema
 
-            if mode == "center":
+            if position == "center":
                 xy = xc, yc
-            elif mode == "edge" and orientation == "vertical":
+            elif position == "edge" and orientation == "vertical":
                 xy = xc, endpt
-            elif mode == "edge" and orientation == "horizontal":
+            elif position == "edge" and orientation == "horizontal":
                 xy = endpt, yc
 
             if orientation == "vertical":
                 xytext = shifting, sign(extrema) * padding
             else:
                 xytext = sign(extrema) * padding, shifting
 
-            if mode == "center":
+            if position == "center":
                 ha, va = "center", "center"
-            elif mode == "edge" and orientation == "vertical" and yc >= 0:
+            elif position == "edge" and orientation == "vertical" and yc >= 0:
                 ha, va = "center", "bottom"
-            elif mode == "edge" and orientation == "vertical" and yc < 0:
+            elif position == "edge" and orientation == "vertical" and yc < 0:
                 ha, va = "center", "top"
-            elif mode == "edge" and orientation == "horizontal" and xc >= 0:
+            elif (
+                position == "edge" and orientation == "horizontal" and xc >= 0
+            ):
                 ha, va = "left", "center"
-            elif mode == "edge" and orientation == "horizontal" and xc < 0:
+            elif position == "edge" and orientation == "horizontal" and xc < 0:
                 ha, va = "right", "center"
 
             annotation = self.annotate(cap or fmt % value, xy, xytext,
                                        textcoords="offset points",
                                        ha=ha, va=va, **kwargs)
             annotations.append(annotation)
 
-        if autoscale:
-            transform = self.transData.inverted()
-            renderer = self.figure.canvas.get_renderer()
-            corners = []
-            for text in annotations:
-                points = text.get_window_extent(renderer).get_points()
-                corners.append(transform.transform(points))
-            self.update_datalim(np.vstack(corners))
-            self.autoscale_view()
-
         return annotations
 
     @_preprocess_data()

lib/matplotlib/container.py

@@ -62,7 +62,7 @@ class BarContainer(Container):
 
     """
 
-    def __init__(self, patches, errorbar=None, orientation=None, **kwargs):
+    def __init__(self, patches, errorbar=None, *, orientation=None, **kwargs):
         self.patches = patches
         self.errorbar = errorbar
         self.orientation = orientation

lib/matplotlib/tests/test_axes.py

@@ -6814,7 +6814,7 @@ def test_bar_label_location_center():
     ax = plt.gca()
     ys, widths = [1, 2], [3, -4]
     rects = ax.barh(ys, widths)
-    labels = ax.bar_label(rects, mode='center')
+    labels = ax.bar_label(rects, position='center')
     assert labels[0].xy == (widths[0] / 2, ys[0])
     assert labels[0].get_ha() == 'center'
     assert labels[0].get_va() == 'center'