Merge pull request #3943 from tacaswell/legend_deprecate_removal

WeatherGod · WeatherGod · commit e25f29c072c7 · 2014-12-30T17:07:34.000-05:00
Legend deprecate removal + cleanup
diff --git a/doc/api/api_changes/code_removal.rst b/doc/api/api_changes/code_removal.rst
@@ -0,0 +1,6 @@
+Code Removal
+````````````
+
+Legend
+------
+Removed handling of `loc` as a positional argument to `Legend`
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -458,7 +458,16 @@ def legend(self, *args, **kwargs):
         handles = kwargs.pop('handles', None)
         labels = kwargs.pop('labels', None)
 
-        if handles is not None and labels is None:
+        if (handles is not None or labels is not None) and len(args):
+            warnings.warn("You have mixed positional and keyword "
+                          "arguments, some input will be "
+                          "discarded.")
+
+        # if got both handles and labels as kwargs, make same length
+        if handles and labels:
+            handles, labels = zip(*zip(handles, labels))
+
+        elif handles is not None and labels is None:
             labels = [handle.get_label() for handle in handles]
             for label, handle in zip(labels[:], handles[:]):
                 if label.startswith('_'):
@@ -470,7 +479,7 @@ def legend(self, *args, **kwargs):
 
         elif labels is not None and handles is None:
             # Get as many handles as there are labels.
-            handles = [handle for handle, _
+            handles = [handle for handle, label
                        in zip(self._get_legend_handles(handlers), labels)]
 
         # No arguments - automatically detect labels and handles.
@@ -485,32 +494,13 @@ def legend(self, *args, **kwargs):
         elif len(args) == 1:
             labels, = args
             # Get as many handles as there are labels.
-            handles = [handle for handle, _
+            handles = [handle for handle, label
                        in zip(self._get_legend_handles(handlers), labels)]
 
-        # Two arguments. Either:
+        # Two arguments:
         #   * user defined handles and labels
-        #   * user defined labels and location (deprecated)
         elif len(args) == 2:
-            if is_string_like(args[1]) or isinstance(args[1], int):
-                cbook.warn_deprecated('1.4', 'The "loc" positional argument '
-                                      'to legend is deprecated. Please use '
-                                      'the "loc" keyword instead.')
-                labels, loc = args
-                handles = [handle for handle, _
-                           in zip(self._get_legend_handles(handlers), labels)]
-                kwargs['loc'] = loc
-            else:
-                handles, labels = args
-
-        # Three arguments. User defined handles, labels and
-        # location (deprecated).
-        elif len(args) == 3:
-            cbook.warn_deprecated('1.4', 'The "loc" positional argument '
-                                         'to legend is deprecated. Please '
-                                         'use the "loc" keyword instead.')
-            handles, labels, loc = args
-            kwargs['loc'] = loc
+            handles, labels = args
 
         else:
             raise TypeError('Invalid arguments to legend.')
diff --git a/lib/matplotlib/tests/test_legend.py b/lib/matplotlib/tests/test_legend.py
@@ -144,22 +144,6 @@ def test_legend_remove():
 class TestLegendFunction(object):
     # Tests the legend function on the Axes and pyplot.
 
-    deprecation_message = ('The "loc" positional argument '
-                           'to legend is deprecated. Please use '
-                           'the "loc" keyword instead.')
-
-    @cleanup
-    def test_legend_label_loc_args(self):
-        # Check the deprecated warning is created and that the appropriate
-        # call to Legend is made. This wouldn't actually create a valid
-        # legend as there is no artist to legendify, but that doesn't matter.
-        with mock.patch('matplotlib.cbook.warn_deprecated') as deprecation:
-            with mock.patch('matplotlib.legend.Legend') as Legend:
-                plt.legend(['hello world'], 1)
-
-        deprecation.assert_called_with('1.4', self.deprecation_message)
-        Legend.assert_called_with(plt.gca(), [], ['hello world'], loc=1)
-
     @cleanup
     def test_old_legend_handler_interface(self):
         # Check the deprecated warning is created and that the appropriate
@@ -187,18 +171,6 @@ def __call__(self, legend, orig_handle, fontsize, handlebox):
                                 MatplotlibDeprecationWarning,
                                 stacklevel=1)
 
-    @cleanup
-    def test_legend_handle_label_loc_args(self):
-        # Check the deprecated warning is created and that the appropriate
-        # call to Legend is made.
-        lines = plt.plot(range(10))
-        with mock.patch('matplotlib.cbook.warn_deprecated') as deprecation:
-            with mock.patch('matplotlib.legend.Legend') as Legend:
-                plt.legend(lines, ['hello world'], 1)
-
-        deprecation.assert_called_with('1.4', self.deprecation_message)
-        Legend.assert_called_with(plt.gca(), lines, ['hello world'], loc=1)
-
     @cleanup
     def test_legend_handle_label(self):
         lines = plt.plot(range(10))
@@ -229,6 +201,29 @@ def test_legend_handler_map(self):
             plt.legend(handler_map={'1': 2})
         handles_labels.assert_called_with({'1': 2})
 
+    @cleanup
+    def test_kwargs(self):
+        fig, ax = plt.subplots(1, 1)
+        th = np.linspace(0, 2*np.pi, 1024)
+        lns, = ax.plot(th, np.sin(th), label='sin', lw=5)
+        lnc, = ax.plot(th, np.cos(th), label='cos', lw=5)
+        with mock.patch('matplotlib.legend.Legend') as Legend:
+            ax.legend(handles=(lnc, lns), labels=('a', 'b'))
+        Legend.assert_called_with(ax, (lnc, lns), ('a', 'b'))
+
+    @cleanup
+    def test_warn_args_kwargs(self):
+        fig, ax = plt.subplots(1, 1)
+        th = np.linspace(0, 2*np.pi, 1024)
+        lns, = ax.plot(th, np.sin(th), label='sin', lw=5)
+        lnc, = ax.plot(th, np.cos(th), label='cos', lw=5)
+        with mock.patch('warnings.warn') as warn:
+            ax.legend((lnc, lns), labels=('a', 'b'))
+
+        warn.assert_called_with("You have mixed positional and keyword "
+                          "arguments, some input will be "
+                          "discarded.")
+
 
 @image_comparison(baseline_images=['legend_stackplot'], extensions=['png'])
 def test_legend_stackplot():
