ENH: PEP484 type annotations for inset axes

clbarnes · clbarnes · commit 23f56c810c47 · 2019-05-21T15:14:26.000-04:00
And minor formatting changes.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -4,25 +4,22 @@
 import logging
 import math
 from numbers import Number
+from typing import Tuple, Optional
 
-import numpy as np
-from numpy import ma
-
-from matplotlib import _preprocess_data, rcParams
+import matplotlib.category as _  # <-registers a category unit converter
 import matplotlib.cbook as cbook
 import matplotlib.collections as mcoll
 import matplotlib.colors as mcolors
 import matplotlib.contour as mcontour
-import matplotlib.category as _  # <-registers a category unit converter
 import matplotlib.dates as _  # <-registers a date unit converter
 import matplotlib.docstring as docstring
 import matplotlib.image as mimage
 import matplotlib.legend as mlegend
 import matplotlib.lines as mlines
 import matplotlib.markers as mmarkers
 import matplotlib.mlab as mlab
-import matplotlib.path as mpath
 import matplotlib.patches as mpatches
+import matplotlib.path as mpath
 import matplotlib.quiver as mquiver
 import matplotlib.stackplot as mstack
 import matplotlib.streamplot as mstream
@@ -31,9 +28,12 @@
 import matplotlib.ticker as mticker
 import matplotlib.transforms as mtransforms
 import matplotlib.tri as mtri
-from matplotlib.container import BarContainer, ErrorbarContainer, StemContainer
+import numpy as np
+from matplotlib import _preprocess_data, rcParams
 from matplotlib.axes._base import _AxesBase, _process_plot_format
 from matplotlib.axes._secondary_axes import SecondaryAxis
+from matplotlib.container import BarContainer, ErrorbarContainer, StemContainer
+from numpy import ma
 
 try:
     from numpy.lib.histograms import histogram_bin_edges
@@ -408,8 +408,14 @@ def legend(self, *args, **kwargs):
     def _remove_legend(self, legend):
         self.legend_ = None
 
-    def inset_axes(self, bounds, *, transform=None, zorder=5,
-            **kwargs):
+    def inset_axes(
+            self,
+            bounds: Tuple[float, float, float, float],
+            *,
+            transform: Optional[mtransforms.Transform] = None,
+            zorder: float = 5,
+            **kwargs
+        ):
         """
         Add a child inset axes to this existing axes.
 
@@ -475,9 +481,25 @@ def inset_axes(self, bounds, *, transform=None, zorder=5,
 
         return inset_ax
 
-    def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
-            facecolor='none', edgecolor='0.5', alpha=0.5,
-            zorder=4.99, **kwargs):
+    def indicate_inset(
+            self,
+            bounds: Tuple[float, float, float, float],
+            inset_ax: Optional['Axes'] = None,
+            *,
+            transform: Optional[mtransforms.Transform] = None,
+            facecolor='none',
+            edgecolor='0.5',
+            alpha: float = 0.5,
+            zorder: float = 4.99, **kwargs
+        ) -> Tuple[
+            mpatches.Rectangle,
+            Optional[
+                Tuple[
+                    mpatches.ConnectionPatch, mpatches.ConnectionPatch,
+                    mpatches.ConnectionPatch, mpatches.ConnectionPatch
+                ]
+            ]
+        ]:
         """
         Add an inset indicator to the axes.  This is a rectangle on the plot
         at the position indicated by *bounds* that optionally has lines that
@@ -577,7 +599,8 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
             pos = inset_ax.get_position()
             bboxins = pos.transformed(self.figure.transFigure)
             rectbbox = mtransforms.Bbox.from_bounds(
-                        *bounds).transformed(transform)
+                *bounds
+            ).transformed(transform)
             x0 = rectbbox.x0 < bboxins.x0
             x1 = rectbbox.x1 < bboxins.x1
             y0 = rectbbox.y0 < bboxins.y0
@@ -589,7 +612,15 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
 
         return rectpatch, tuple(connects) if connects else None
 
-    def indicate_inset_zoom(self, inset_ax, **kwargs):
+    def indicate_inset_zoom(
+            self, inset_ax: 'Axes', **kwargs
+        ) -> Tuple[
+            mpatches.Rectangle,
+            Tuple[
+                mpatches.ConnectionPatch, mpatches.ConnectionPatch,
+                mpatches.ConnectionPatch, mpatches.ConnectionPatch
+            ]
+        ]:
         """
         Add an inset indicator rectangle to the axes based on the axis
         limits for an *inset_ax* and draw connectors between *inset_ax*
