Merge pull request #15680 from anntzer/kwonly

timhoffm · web-flow · commit 8ba451b461b6 · 2020-03-24T19:10:30.000+01:00
Use more kwonly arguments, less manual kwargs-popping.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -1507,7 +1507,7 @@ def getp(obj, property=None):
 get = getp
 
 
-def setp(obj, *args, **kwargs):
+def setp(obj, *args, file=None, **kwargs):
     """
     Set a property on an artist object.
 
@@ -1531,8 +1531,8 @@ def setp(obj, *args, **kwargs):
       >>> setp(line)
           ... long output listing omitted
 
-    You may specify another output file to `setp` if `sys.stdout` is not
-    acceptable for some reason using the *file* keyword-only argument::
+    By default `setp` prints to `sys.stdout`, but this can be modified using
+    the *file* keyword-only argument::
 
       >>> with fopen('output.log') as f:
       >>>     setp(line, file=f)
@@ -1567,16 +1567,11 @@ def setp(obj, *args, **kwargs):
 
     insp = ArtistInspector(objs[0])
 
-    # file has to be popped before checking if kwargs is empty
-    printArgs = {}
-    if 'file' in kwargs:
-        printArgs['file'] = kwargs.pop('file')
-
     if not kwargs and len(args) < 2:
         if args:
-            print(insp.pprint_setters(prop=args[0]), **printArgs)
+            print(insp.pprint_setters(prop=args[0]), file=file)
         else:
-            print('\n'.join(insp.pprint_setters()), **printArgs)
+            print('\n'.join(insp.pprint_setters()), file=file)
         return
 
     if len(args) % 2:
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -430,7 +430,7 @@ def inset_axes(self, bounds, *, transform=None, zorder=5, **kwargs):
             parent axes.
 
         **kwargs
-            Other keyword arguments are passed on to the `.Axes` child axes.
+            Other keyword arguments are passed on to the child `.Axes`.
 
         Returns
         -------
@@ -451,14 +451,13 @@ def inset_axes(self, bounds, *, transform=None, zorder=5, **kwargs):
         """
         if transform is None:
             transform = self.transAxes
-        label = kwargs.pop('label', 'inset_axes')
+        kwargs.setdefault('label', 'inset_axes')
 
         # This puts the rectangle into figure-relative coordinates.
         inset_locator = _make_inset_locator(bounds, transform, self)
         bb = inset_locator(None, None)
 
-        inset_ax = Axes(self.figure, bb.bounds, zorder=zorder, label=label,
-                        **kwargs)
+        inset_ax = Axes(self.figure, bb.bounds, zorder=zorder, **kwargs)
         # this locator lets the axes move if in data coordinates.
         # it gets called in `ax.apply_aspect() (of all places)
         inset_ax.set_axes_locator(inset_locator)
@@ -479,7 +478,6 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
         --------
         This method is experimental as of 3.0, and the API may change.
 
-
         Parameters
         ----------
         bounds : [x0, y0, width, height]
@@ -510,7 +508,9 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
             4.99, is just below the default level of inset axes.
 
         **kwargs
-            Other keyword arguments are passed on to the rectangle patch.
+            Other keyword arguments are passed on to the `.Rectangle` patch:
+
+            %(Rectangle)s
 
         Returns
         -------
@@ -530,13 +530,13 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
 
         if transform is None:
             transform = self.transData
-        label = kwargs.pop('label', 'indicate_inset')
+        kwargs.setdefault('label', 'indicate_inset')
 
         x, y, width, height = bounds
         rectangle_patch = mpatches.Rectangle(
             (x, y), width, height,
             facecolor=facecolor, edgecolor=edgecolor, alpha=alpha,
-            zorder=zorder,  label=label, transform=transform, **kwargs)
+            zorder=zorder, transform=transform, **kwargs)
         self.add_patch(rectangle_patch)
 
         connects = []
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -150,7 +150,7 @@ def set_prop_cycle(self, *args, **kwargs):
         # This should make a copy
         self._prop_keys = prop_cycler.keys
 
-    def __call__(self, *args, **kwargs):
+    def __call__(self, *args, data=None, **kwargs):
         self.axes._process_unit_info(kwargs=kwargs)
 
         for pos_only in "xy":
@@ -161,9 +161,7 @@ def __call__(self, *args, **kwargs):
         if not args:
             return
 
-        # Process the 'data' kwarg.
-        data = kwargs.pop("data", None)
-        if data is not None:
+        if data is not None:  # Process the 'data' kwarg.
             replaced = [mpl._replacer(data, arg) for arg in args]
             if len(args) == 1:
                 label_namer_idx = 0
@@ -446,7 +444,7 @@ def __init__(self, fig, rect,
         self.set_label(label)
         self.set_figure(fig)
         self.set_box_aspect(box_aspect)
-        self.set_axes_locator(kwargs.get("axes_locator", None))
+        self._axes_locator = None  # Optionally set via update(kwargs).
 
         self.spines = self._gen_axes_spines()
 
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1977,9 +1977,11 @@ def _get_output_canvas(self, backend, fmt):
             "Format {!r} is not supported (supported formats: {})"
             .format(fmt, ", ".join(sorted(self.get_supported_filetypes()))))
 
-    def print_figure(self, filename, dpi=None, facecolor=None, edgecolor=None,
-                     orientation='portrait', format=None,
-                     *, bbox_inches=None, backend=None, **kwargs):
+    def print_figure(
+            self, filename, dpi=None, facecolor=None, edgecolor=None,
+            orientation='portrait', format=None, *,
+            bbox_inches=None, pad_inches=None, bbox_extra_artists=None,
+            backend=None, **kwargs):
         """
         Render the figure to hardcopy. Set the figure patch face and edge
         colors.  This is useful because some of the GUIs have a gray figure
@@ -2077,14 +2079,11 @@ def print_figure(self, filename, dpi=None, facecolor=None, edgecolor=None,
                             print_method, dpi=dpi, orientation=orientation),
                         draw_disabled=True)
                     self.figure.draw(renderer)
-                    bbox_artists = kwargs.pop("bbox_extra_artists", None)
                     bbox_inches = self.figure.get_tightbbox(
-                        renderer, bbox_extra_artists=bbox_artists)
-                    pad = kwargs.pop("pad_inches", None)
-                    if pad is None:
-                        pad = rcParams['savefig.pad_inches']
-
-                    bbox_inches = bbox_inches.padded(pad)
+                        renderer, bbox_extra_artists=bbox_extra_artists)
+                    if pad_inches is None:
+                        pad_inches = rcParams['savefig.pad_inches']
+                    bbox_inches = bbox_inches.padded(pad_inches)
 
                 # call adjust_bbox to save only the given area
                 restore_bbox = tight_bbox.adjust_bbox(self.figure, bbox_inches,
diff --git a/lib/matplotlib/backends/backend_cairo.py b/lib/matplotlib/backends/backend_cairo.py
@@ -436,9 +436,8 @@ def print_svg(self, fobj, *args, **kwargs):
     def print_svgz(self, fobj, *args, **kwargs):
         return self._save(fobj, 'svgz', *args, **kwargs)
 
-    def _save(self, fo, fmt, **kwargs):
+    def _save(self, fo, fmt, *, orientation='portrait', **kwargs):
         # save PDF/PS/SVG
-        orientation = kwargs.get('orientation', 'portrait')
 
         dpi = 72
         self.figure.dpi = dpi
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -727,9 +727,10 @@ class ContourSet(cm.ScalarMappable, ContourLabeler):
 
     def __init__(self, ax, *args,
                  levels=None, filled=False, linewidths=None, linestyles=None,
-                 alpha=None, origin=None, extent=None,
+                 hatches=(None,), alpha=None, origin=None, extent=None,
                  cmap=None, colors=None, norm=None, vmin=None, vmax=None,
-                 extend='neither', antialiased=None,
+                 extend='neither', antialiased=None, nchunk=0, locator=None,
+                 transform=None,
                  **kwargs):
         """
         Draw contour lines or filled regions, depending on
@@ -780,7 +781,7 @@ def __init__(self, ax, *args,
         self.filled = filled
         self.linewidths = linewidths
         self.linestyles = linestyles
-        self.hatches = kwargs.pop('hatches', [None])
+        self.hatches = hatches
         self.alpha = alpha
         self.origin = origin
         self.extent = extent
@@ -793,8 +794,8 @@ def __init__(self, ax, *args,
             # The default for line contours will be taken from the
             # LineCollection default, which uses :rc:`lines.antialiased`.
 
-        self.nchunk = kwargs.pop('nchunk', 0)
-        self.locator = kwargs.pop('locator', None)
+        self.nchunk = nchunk
+        self.locator = locator
         if (isinstance(norm, mcolors.LogNorm)
                 or isinstance(self.locator, ticker.LogLocator)):
             self.logscale = True
@@ -812,7 +813,7 @@ def __init__(self, ax, *args,
         if self.origin == 'image':
             self.origin = mpl.rcParams['image.origin']
 
-        self._transform = kwargs.pop('transform', None)
+        self._transform = transform
 
         kwargs = self._process_args(*args, **kwargs)
         self._process_levels()
@@ -1401,7 +1402,7 @@ class QuadContourSet(ContourSet):
         levels for filled contours. See :meth:`_process_colors` method.
     """
 
-    def _process_args(self, *args, **kwargs):
+    def _process_args(self, *args, corner_mask=None, **kwargs):
         """
         Process args and kwargs.
         """
@@ -1417,9 +1418,9 @@ def _process_args(self, *args, **kwargs):
         else:
             import matplotlib._contour as _contour
 
-            self._corner_mask = kwargs.pop('corner_mask', None)
-            if self._corner_mask is None:
-                self._corner_mask = mpl.rcParams['contour.corner_mask']
+            if corner_mask is None:
+                corner_mask = mpl.rcParams['contour.corner_mask']
+            self._corner_mask = corner_mask
 
             x, y, z = self._contour_args(args, kwargs)
 
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -2164,8 +2164,7 @@ def get_next_color():
                     get_next_color_func=get_next_color)
 
 
-def _params(c=None, xsize=2, **kwargs):
-    edgecolors = kwargs.pop('edgecolors', None)
+def _params(c=None, xsize=2, *, edgecolors=None, **kwargs):
     return (c, edgecolors, kwargs if kwargs is not None else {}, xsize)
 _result = namedtuple('_result', 'c, colors')
 
diff --git a/lib/mpl_toolkits/axisartist/floating_axes.py b/lib/mpl_toolkits/axisartist/floating_axes.py
@@ -320,17 +320,7 @@ def __init__(self, *args, **kwargs):
         self.adjust_axes_lim()
 
     def _gen_axes_patch(self):
-        """
-        Returns the patch used to draw the background of the axes.  It
-        is also used as the clipping path for any data elements on the
-        axes.
-
-        In the standard axes, this is a rectangle, but in other
-        projections it may not be.
-
-        .. note::
-            Intended to be overridden by new projection types.
-        """
+        # docstring inherited
         grid_helper = self.get_grid_helper()
         t = grid_helper.get_boundary()
         return mpatches.Polygon(t)
