Merge pull request #4863 from productivememberofsociety666/parasite_axes_not_pyplot

tacaswell · tacaswell · commit c59422355954 · 2015-11-04T23:34:08.000-05:00
ENH: Allow "figure" kwarg for host functions in parasite_axes
diff --git a/lib/mpl_toolkits/axes_grid1/parasite_axes.py b/lib/mpl_toolkits/axes_grid1/parasite_axes.py
@@ -460,20 +460,48 @@ def host_subplot_class_factory(axes_class):
 
 
 def host_axes(*args, **kwargs):
+    """
+    Create axes that can act as a hosts to parasitic axes.
+
+    Parameters
+    ----------
+    figure : `matplotlib.figure.Figure`
+        Figure to which the axes will be added. Defaults to the current figure
+        `pyplot.gcf()`.
+
+    *args, **kwargs :
+        Will be passed on to the underlying ``Axes`` object creation.
+    """
     import matplotlib.pyplot as plt
     axes_class = kwargs.pop("axes_class", None)
     host_axes_class = host_axes_class_factory(axes_class)
-    fig = plt.gcf()
+    fig = kwargs.get("figure", None)
+    if fig is None:
+        fig = plt.gcf()
     ax = host_axes_class(fig, *args, **kwargs)
     fig.add_axes(ax)
     plt.draw_if_interactive()
     return ax
 
 def host_subplot(*args, **kwargs):
+    """
+    Create a subplot that can act as a host to parasitic axes.
+
+    Parameters
+    ----------
+    figure : `matplotlib.figure.Figure`
+        Figure to which the subplot will be added. Defaults to the current
+        figure `pyplot.gcf()`.
+
+    *args, **kwargs :
+        Will be passed on to the underlying ``Axes`` object creation.
+    """
     import matplotlib.pyplot as plt
     axes_class = kwargs.pop("axes_class", None)
     host_subplot_class = host_subplot_class_factory(axes_class)
-    fig = plt.gcf()
+    fig = kwargs.get("figure", None)
+    if fig is None:
+        fig = plt.gcf()
     ax = host_subplot_class(fig, *args, **kwargs)
     fig.add_subplot(ax)
     plt.draw_if_interactive()
