Merge pull request #13656 from anntzer/hist-return

timhoffm · web-flow · commit d2a12cbc8a24 · 2020-05-05T16:36:57.000+02:00
For single datasets, don't wrap artist added by Axes.hist in silent_list
diff --git a/doc/api/api_changes_3.3/behaviour.rst b/doc/api/api_changes_3.3/behaviour.rst
@@ -241,3 +241,36 @@ also be 'x' or 'y'.
 This newly allowed value for :rc:`savefig.facecolor` and :rc:`savefig.edgecolor`,
 as well as the *facecolor* and *edgecolor* parameters to `.Figure.savefig`, means
 "use whatever facecolor and edgecolor the figure current has".
+
+When using a single dataset, `.Axes.hist` no longer wraps the added artist in a `.silent_list`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When `.Axes.hist` is called with a single dataset, it adds to the axes either
+a `.BarContainer` object (when ``histtype="bar"`` or ``"barstacked"``), or a
+`.Polygon` object (when ``histype="step"`` or ``"stepfilled"``) -- the latter
+being wrapped in a list-of-one-element.  Previously, either artist would be
+wrapped in a `.silent_list`.  This is no longer the case: the `.BarContainer` is
+now returned as is (this is an API breaking change if you were directly relying
+on the concrete `list` API; however, `.BarContainer` inherits from `tuple` so
+most common operations remain available), and the list-of-one `.Polygon` is
+returned as is.  This makes the `repr` of the returned artist more accurate: it
+is now ::
+
+    <BarContainer object of of 10 artists>  # "bar", "barstacked"
+    [<matplotlib.patches.Polygon object at 0xdeadbeef>]  # "step", "stepfilled"
+
+instead of ::
+
+    <a list of 10 Patch objects>  # "bar", "barstacked"
+    <a list of 1 Patch objects>  # "step", "stepfilled"
+
+When `.Axes.hist` is called with multiple artists, it still wraps its return
+value in a `.silent_list`, but uses more accurate type information ::
+
+    <a list of 3 BarContainer objects>  # "bar", "barstacked"
+    <a list of 3 List[Polygon] objects>  # "step", "stepfilled"
+
+instead of ::
+
+    <a list of 3 Lists of Patches objects>  # "bar", "barstacked"
+    <a list of 3 Lists of Patches objects>  # "step", "stepfilled"
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -6514,9 +6514,10 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
             edge of last bin).  Always a single array even when multiple data
             sets are passed in.
 
-        patches : list or list of lists
-            Silent list of individual patches used to create the histogram
-            or list of such list if multiple input datasets.
+        patches : `.BarContainer` or list of a single `.Polygon` or list of \
+such objects
+            Container of individual artists used to create the histogram
+            or list of such containers if there are multiple input datasets.
 
         Other Parameters
         ----------------
@@ -6798,9 +6799,11 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
                     p.set_label('_nolegend_')
 
         if nx == 1:
-            return tops[0], bins, cbook.silent_list('Patch', patches[0])
+            return tops[0], bins, patches[0]
         else:
-            return tops, bins, cbook.silent_list('Lists of Patches', patches)
+            patch_type = ("BarContainer" if histtype.startswith("bar")
+                          else "List[Polygon]")
+            return tops, bins, cbook.silent_list(patch_type, patches)
 
     @_preprocess_data(replace_names=["x", "y", "weights"])
     @docstring.dedent_interpd
