Merge pull request #21698 from anntzer/style

tacaswell · web-flow · commit c2a5e22baf6e · 2021-11-22T11:15:27.000-05:00
STY: Small code cleanups and style fixes.
diff --git a/examples/axisartist/demo_floating_axis.py b/examples/axisartist/demo_floating_axis.py
@@ -29,8 +29,7 @@ def curvelinear_test2(fig):
                                                      lon_cycle=360,
                                                      lat_cycle=None,
                                                      lon_minmax=None,
-                                                     lat_minmax=(0,
-                                                                 np.inf),
+                                                     lat_minmax=(0, np.inf),
                                                      )
 
     grid_locator1 = angle_helper.LocatorDMS(12)
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -714,10 +714,11 @@ def _get_key(self, event):
         else:
             key = None
 
-        for meth, prefix, key_name in (
-                [event.ControlDown, 'ctrl', 'control'],
-                [event.AltDown, 'alt', 'alt'],
-                [event.ShiftDown, 'shift', 'shift'],):
+        for meth, prefix, key_name in [
+                (event.ControlDown, 'ctrl', 'control'),
+                (event.AltDown, 'alt', 'alt'),
+                (event.ShiftDown, 'shift', 'shift'),
+        ]:
             if meth() and key_name != key:
                 if not (key_name == 'shift' and key.isupper()):
                     key = '{0}+{1}'.format(prefix, key)
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -146,13 +146,13 @@ class CallbackRegistry:
         drink 123
         >>> callbacks.process('eat', 456)
         eat 456
-        >>> callbacks.process('be merry', 456) # nothing will be called
+        >>> callbacks.process('be merry', 456)   # nothing will be called
 
         >>> callbacks.disconnect(id_eat)
-        >>> callbacks.process('eat', 456)      # nothing will be called
+        >>> callbacks.process('eat', 456)        # nothing will be called
 
         >>> with callbacks.blocked(signal='drink'):
-        ...     callbacks.process('drink', 123) # nothing will be called
+        ...     callbacks.process('drink', 123)  # nothing will be called
         >>> callbacks.process('drink', 123)
         drink 123
 
@@ -948,7 +948,7 @@ def delete_masked_points(*args):
             else:
                 x = np.asarray(x)
         margs.append(x)
-    masks = []    # list of masks that are True where good
+    masks = []  # List of masks that are True where good.
     for i, x in enumerate(margs):
         if seqlist[i]:
             if x.ndim > 1:
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -486,7 +486,7 @@ def __init__(self, ax, mappable=None, *, cmap=None,
         if np.iterable(ticks):
             self.locator = ticker.FixedLocator(ticks, nbins=len(ticks))
         else:
-            self.locator = ticks    # Handle default in _ticker()
+            self.locator = ticks  # Handle default in _ticker()
 
         if isinstance(format, str):
             # Check format between FormatStrFormatter and StrMethodFormatter
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -1236,7 +1236,7 @@ def __call__(self, value, clip=None):
         (vmin,), _ = self.process_value(self.vmin)
         (vmax,), _ = self.process_value(self.vmax)
         if vmin == vmax:
-            result.fill(0)   # Or should it be all masked?  Or 0.5?
+            result.fill(0)  # Or should it be all masked?  Or 0.5?
         elif vmin > vmax:
             raise ValueError("minvalue must be less than or equal to maxvalue")
         else:
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -1224,7 +1224,7 @@ def get_unit_generic(freq):
             return 1.0 / SEC_PER_DAY
         else:
             # error
-            return -1   # or should this just return '1'?
+            return -1  # or should this just return '1'?
 
     def _get_interval(self):
         return self.rule._rrule._interval
@@ -1377,7 +1377,7 @@ def get_locator(self, dmin, dmax):
         # whenever possible.
         numYears = float(delta.years)
         numMonths = numYears * MONTHS_PER_YEAR + delta.months
-        numDays = tdelta.days   # Avoids estimates of days/month, days/year
+        numDays = tdelta.days  # Avoids estimates of days/month, days/year.
         numHours = numDays * HOURS_PER_DAY + delta.hours
         numMinutes = numHours * MIN_PER_HOUR + delta.minutes
         numSeconds = np.floor(tdelta.total_seconds())
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2756,7 +2756,7 @@ def clf(self, keep_observers=False):
 
         for ax in tuple(self.axes):  # Iterate over the copy.
             ax.cla()
-            self.delaxes(ax)         # removes ax from self._axstack
+            self.delaxes(ax)  # Remove ax from self._axstack.
 
         toolbar = getattr(self.canvas, 'toolbar', None)
         if toolbar is not None:
diff --git a/lib/matplotlib/mathtext.py b/lib/matplotlib/mathtext.py
@@ -506,15 +506,11 @@ def to_rgba(self, texstr, color='black', dpi=120, fontsize=14):
         depth : int
             Offset of the baseline from the bottom of the image, in pixels.
         """
-        x, depth = self.to_mask(texstr, dpi=dpi, fontsize=fontsize)
-
-        r, g, b, a = mcolors.to_rgba(color)
-        RGBA = np.zeros((x.shape[0], x.shape[1], 4), dtype=np.uint8)
-        RGBA[:, :, 0] = 255 * r
-        RGBA[:, :, 1] = 255 * g
-        RGBA[:, :, 2] = 255 * b
-        RGBA[:, :, 3] = x
-        return RGBA, depth
+        alpha, depth = self.to_mask(texstr, dpi=dpi, fontsize=fontsize)
+        rgba = np.zeros((alpha.shape[0], alpha.shape[1], 4), dtype=np.uint8)
+        rgba[:] = 255 * np.asarray(mcolors.to_rgba(color))
+        rgba[:, :, 3] = alpha
+        return rgba, depth
 
     @_api.deprecated("3.4", alternative="mathtext.math_to_image")
     def to_png(self, filename, texstr, color='black', dpi=120, fontsize=14):
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -356,15 +356,11 @@ def draw(self, renderer):
         Update the location of children if necessary and draw them
         to the given *renderer*.
         """
-        width, height, xdescent, ydescent, offsets = self.get_extent_offsets(
-                                                        renderer)
-
-        px, py = self.get_offset(width, height, xdescent, ydescent, renderer)
-
+        w, h, xdescent, ydescent, offsets = self.get_extent_offsets(renderer)
+        px, py = self.get_offset(w, h, xdescent, ydescent, renderer)
         for c, (ox, oy) in zip(self.get_visible_children(), offsets):
             c.set_offset((px + ox, py + oy))
             c.draw(renderer)
-
         bbox_artist(self, renderer, fill=False, props=dict(pad=0.))
         self.stale = False
 
@@ -541,11 +537,8 @@ def get_extent_offsets(self, renderer):
 
     def draw(self, renderer):
         # docstring inherited
-        width, height, xdescent, ydescent, offsets = self.get_extent_offsets(
-                                                        renderer)
-
-        px, py = self.get_offset(width, height, xdescent, ydescent, renderer)
-
+        w, h, xdescent, ydescent, offsets = self.get_extent_offsets(renderer)
+        px, py = self.get_offset(w, h, xdescent, ydescent, renderer)
         for c, (ox, oy) in zip(self.get_visible_children(), offsets):
             c.set_offset((px + ox, py + oy))
 
@@ -576,8 +569,7 @@ class DrawingArea(OffsetBox):
     boundaries of the parent.
     """
 
-    def __init__(self, width, height, xdescent=0.,
-                 ydescent=0., clip=False):
+    def __init__(self, width, height, xdescent=0., ydescent=0., clip=False):
         """
         Parameters
         ----------
@@ -1055,8 +1047,7 @@ def get_bbox_to_anchor(self):
             if transform is None:
                 return self._bbox_to_anchor
             else:
-                return TransformedBbox(self._bbox_to_anchor,
-                                       transform)
+                return TransformedBbox(self._bbox_to_anchor, transform)
 
     def set_bbox_to_anchor(self, bbox, transform=None):
         """
@@ -1342,22 +1333,12 @@ def __init__(self, offsetbox, xy,
                                        xy,
                                        xycoords=xycoords,
                                        annotation_clip=annotation_clip)
-
         self.offsetbox = offsetbox
-
         self.arrowprops = arrowprops
-
         self.set_fontsize(fontsize)
-
-        if xybox is None:
-            self.xybox = xy
-        else:
-            self.xybox = xybox
-
-        if boxcoords is None:
-            self.boxcoords = xycoords
-        else:
-            self.boxcoords = boxcoords
+        self.xybox = xybox if xybox is not None else xy
+        self.boxcoords = boxcoords if boxcoords is not None else xycoords
+        self._box_alignment = box_alignment
 
         if arrowprops is not None:
             self._arrow_relpos = self.arrowprops.pop("relpos", (0.5, 0.5))
@@ -1367,10 +1348,7 @@ def __init__(self, offsetbox, xy,
             self._arrow_relpos = None
             self.arrow_patch = None
 
-        self._box_alignment = box_alignment
-
-        # frame
-        self.patch = FancyBboxPatch(
+        self.patch = FancyBboxPatch(  # frame
             xy=(0.0, 0.0), width=1., height=1.,
             facecolor='w', edgecolor='k',
             mutation_scale=self.prop.get_size_in_points(),
@@ -1488,28 +1466,24 @@ def _update_position_xybox(self, renderer, xy_pixel):
         bbox = self.offsetbox.get_window_extent(renderer)
         self.patch.set_bounds(bbox.bounds)
 
-        x, y = xy_pixel
-
-        ox1, oy1 = x, y
+        ox1, oy1 = xy_pixel
 
         if self.arrowprops:
             d = self.arrowprops.copy()
 
             # Use FancyArrowPatch if self.arrowprops has "arrowstyle" key.
 
-            # adjust the starting point of the arrow relative to
-            # the textbox.
-            # TODO : Rotation needs to be accounted.
+            # Adjust the starting point of the arrow relative to the textbox.
+            # TODO: Rotation needs to be accounted.
             relpos = self._arrow_relpos
 
             ox0 = bbox.x0 + bbox.width * relpos[0]
             oy0 = bbox.y0 + bbox.height * relpos[1]
 
-            # The arrow will be drawn from (ox0, oy0) to (ox1,
-            # oy1). It will be first clipped by patchA and patchB.
-            # Then it will be shrunk by shrinkA and shrinkB
-            # (in points). If patch A is not set, self.bbox_patch
-            # is used.
+            # The arrow will be drawn from (ox0, oy0) to (ox1, oy1).
+            # It will be first clipped by patchA and patchB.
+            # Then it will be shrunk by shrinkA and shrinkB (in points).
+            # If patch A is not set, self.bbox_patch is used.
 
             self.arrow_patch.set_positions((ox0, oy0), (ox1, oy1))
             fs = self.prop.get_size_in_points()
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -956,7 +956,7 @@ def draw():
 def savefig(*args, **kwargs):
     fig = gcf()
     res = fig.savefig(*args, **kwargs)
-    fig.canvas.draw_idle()   # need this if 'transparent=True' to reset colors
+    fig.canvas.draw_idle()  # Need this if 'transparent=True', to reset colors.
     return res
 
 
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -744,12 +744,11 @@ def validate_cycler(s):
     for prop in cycler_inst.keys:
         norm_prop = _prop_aliases.get(prop, prop)
         if norm_prop != prop and norm_prop in cycler_inst.keys:
-            raise ValueError("Cannot specify both '{0}' and alias '{1}'"
-                             " in the same prop_cycle".format(norm_prop, prop))
+            raise ValueError(f"Cannot specify both {norm_prop!r} and alias "
+                             f"{prop!r} in the same prop_cycle")
         if norm_prop in checker:
-            raise ValueError("Another property was already aliased to '{0}'."
-                             " Collision normalizing '{1}'.".format(norm_prop,
-                                                                    prop))
+            raise ValueError(f"Another property was already aliased to "
+                             f"{norm_prop!r}. Collision normalizing {prop!r}.")
         checker.update([norm_prop])
 
     # This is just an extra-careful check, just in case there is some
diff --git a/lib/matplotlib/tests/test_bbox_tight.py b/lib/matplotlib/tests/test_bbox_tight.py
@@ -24,7 +24,7 @@ def test_bbox_inches_tight():
     rows = len(data)
     ind = np.arange(len(col_labels)) + 0.3  # the x locations for the groups
     cell_text = []
-    width = 0.4     # the width of the bars
+    width = 0.4  # the width of the bars
     yoff = np.zeros(len(col_labels))
     # the bottom values for stacked bar chart
     fig, ax = plt.subplots(1, 1)
diff --git a/lib/matplotlib/tests/test_dates.py b/lib/matplotlib/tests/test_dates.py
@@ -878,7 +878,7 @@ def _test_date2num_dst(date_range, tz_convert):
     # Interval is 0b0.0000011 days, to prevent float rounding issues
     dtstart = datetime.datetime(2014, 3, 30, 0, 0, tzinfo=UTC)
     interval = datetime.timedelta(minutes=33, seconds=45)
-    interval_days = 0.0234375   # 2025 / 86400 seconds
+    interval_days = interval.seconds / 86400
     N = 8
 
     dt_utc = date_range(start=dtstart, freq=interval, periods=N)
diff --git a/lib/matplotlib/tests/test_patches.py b/lib/matplotlib/tests/test_patches.py
@@ -487,7 +487,7 @@ def test_datetime_datetime_fails():
     from datetime import datetime
 
     start = datetime(2017, 1, 1, 0, 0, 0)
-    dt_delta = datetime(1970, 1, 5)    # Will be 5 days if units are done wrong
+    dt_delta = datetime(1970, 1, 5)  # Will be 5 days if units are done wrong.
 
     with pytest.raises(TypeError):
         mpatches.Rectangle((start, 0), dt_delta, 1)
diff --git a/lib/matplotlib/tests/test_text.py b/lib/matplotlib/tests/test_text.py
@@ -240,7 +240,7 @@ def test_annotation_contains():
     fig, ax = plt.subplots()
     ann = ax.annotate(
         "hello", xy=(.4, .4), xytext=(.6, .6), arrowprops={"arrowstyle": "->"})
-    fig.canvas.draw()   # Needed for the same reason as in test_contains.
+    fig.canvas.draw()  # Needed for the same reason as in test_contains.
     event = MouseEvent(
         "button_press_event", fig.canvas, *ax.transData.transform((.5, .6)))
     assert ann.contains(event) == (False, {})
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -154,7 +154,7 @@ def __init__(self,
         self._bbox_patch = None  # a FancyBboxPatch instance
         self._renderer = None
         if linespacing is None:
-            linespacing = 1.2   # Maybe use rcParam later.
+            linespacing = 1.2  # Maybe use rcParam later.
         self._linespacing = linespacing
         self.set_rotation_mode(rotation_mode)
         self.update(kwargs)
@@ -1976,7 +1976,7 @@ def draw(self, renderer):
         # FancyArrowPatch is correctly positioned.
         self.update_positions(renderer)
         self.update_bbox_position_size(renderer)
-        if self.arrow_patch is not None:   # FancyArrowPatch
+        if self.arrow_patch is not None:  # FancyArrowPatch
             if self.arrow_patch.figure is None and self.figure is not None:
                 self.arrow_patch.figure = self.figure
             self.arrow_patch.draw(renderer)
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -1412,13 +1412,13 @@ def format_eng(self, num):
         representing the power of 1000 of the original number.
         Some examples:
 
-        >>> format_eng(0)       # for self.places = 0
+        >>> format_eng(0)        # for self.places = 0
         '0'
 
-        >>> format_eng(1000000) # for self.places = 1
+        >>> format_eng(1000000)  # for self.places = 1
         '1.0 M'
 
-        >>> format_eng("-1e-6") # for self.places = 2
+        >>> format_eng("-1e-6")  # for self.places = 2
         '-1.00 \N{MICRO SIGN}'
         """
         sign = 1
diff --git a/lib/mpl_toolkits/mplot3d/axis3d.py b/lib/mpl_toolkits/mplot3d/axis3d.py
@@ -36,9 +36,9 @@ class Axis(maxis.XAxis):
     """An Axis class for the 3D plots."""
     # These points from the unit cube make up the x, y and z-planes
     _PLANES = (
-        (0, 3, 7, 4), (1, 2, 6, 5),     # yz planes
-        (0, 1, 5, 4), (3, 2, 6, 7),     # xz planes
-        (0, 1, 2, 3), (4, 5, 6, 7),     # xy planes
+        (0, 3, 7, 4), (1, 2, 6, 5),  # yz planes
+        (0, 1, 5, 4), (3, 2, 6, 7),  # xz planes
+        (0, 1, 2, 3), (4, 5, 6, 7),  # xy planes
     )
 
     # Some properties for the axes

Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,7 @@ def curvelinear_test2(fig):`
`29`	`29`	`lon_cycle=360,`
`30`	`30`	`lat_cycle=None,`
`31`	`31`	`lon_minmax=None,`
`32`		`- lat_minmax=(0,`
`33`		`- np.inf),`
	`32`	`+ lat_minmax=(0, np.inf),`
`34`	`33`	`)`
`35`	`34`
`36`	`35`	`grid_locator1 = angle_helper.LocatorDMS(12)`