Properly deprecate access to second item returned by HandlerLine2D.

anntzer · anntzer · commit c0e1c1b44e1a · 2021-07-29T11:15:36.000+02:00
diff --git a/lib/matplotlib/legend_handler.py b/lib/matplotlib/legend_handler.py
@@ -27,11 +27,12 @@
     def legend_artist(self, legend, orig_handle, fontsize, handlebox)
 """
 
+from collections.abc import Sequence
 from itertools import cycle
 
 import numpy as np
 
-from matplotlib import cbook
+from matplotlib import _api, cbook
 from matplotlib.lines import Line2D
 from matplotlib.patches import Rectangle
 import matplotlib.collections as mcoll
@@ -119,6 +120,9 @@ def legend_artist(self, legend, orig_handle,
                                       xdescent, ydescent, width, height,
                                       fontsize, handlebox.get_transform())
 
+        if isinstance(artists, _Line2DHandleList):
+            artists = [artists[0]]
+
         # create_artists will return a list of artists.
         for a in artists:
             handlebox.add_artist(a)
@@ -254,6 +258,24 @@ def create_artists(self, legend, orig_handle,
         return [legline, legline_marker]
 
 
+class _Line2DHandleList(Sequence):
+   def __init__(self, legline):
+       self._legline = legline
+
+   def __len__(self):
+       return 2
+
+   def __getitem__(self, index):
+       if index != 0:
+           # Make HandlerLine2D return [self._legline] directly after
+           # deprecation elapses.
+           _api.warn_deprecated(
+               "3.5", message="Access to the second element returned by "
+               "HandlerLine2D is deprecated since %(since)s; it will be "
+               "removed %(removal)s.")
+       return [self._legline, self._legline][index]
+
+
 class HandlerLine2D(HandlerNpoints):
     """
     Handler for `.Line2D` instances.
@@ -304,7 +326,7 @@ def create_artists(self, legend, orig_handle,
 
         legline.set_transform(trans)
 
-        return [legline]
+        return _Line2DHandleList(legline)
 
 
 class HandlerPatch(HandlerBase):
