Deprecate get_current_figure_manager().

anntzer · anntzer · commit 86fe348fea93 · 2019-04-29T17:05:30.000+02:00
It's longer to type(!) than its actual implementation
(``gcf().canvas.manager``), and mixes the pyplot and the OO-interfaces.

Also make ``plt.subplot_tool`` work even for non-pyplot-managed figures
-- there's no reason not to, it's just that such figures cannot be made
the "current" pyplot figure.
diff --git a/doc/api/next_api_changes/2019-04-28-AL.rst b/doc/api/next_api_changes/2019-04-28-AL.rst
@@ -0,0 +1,5 @@
+Deprecations
+````````````
+
+``plt.get_current_figure_manager()`` is deprecated, in favor of
+``plt.gcf().canvas.manager``.
diff --git a/examples/misc/agg_buffer.py b/examples/misc/agg_buffer.py
@@ -14,7 +14,7 @@
 
 plt.plot([1, 2, 3])
 
-canvas = plt.get_current_fig_manager().canvas
+canvas = plt.gcf().canvas
 
 agg = canvas.switch_backends(FigureCanvasAgg)
 agg.draw()
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -601,6 +601,7 @@ def get_figlabels():
     return [m.canvas.figure.get_label() for m in figManagers]
 
 
+@cbook.deprecated("3.2", alternative="gcf().canvas.manager")
 def get_current_fig_manager():
     """
     Return the figure manager of the active figure.
@@ -616,12 +617,12 @@ def get_current_fig_manager():
 
 @docstring.copy(FigureCanvasBase.mpl_connect)
 def connect(s, func):
-    return get_current_fig_manager().canvas.mpl_connect(s, func)
+    return gcf().canvas.mpl_connect(s, func)
 
 
 @docstring.copy(FigureCanvasBase.mpl_disconnect)
 def disconnect(cid):
-    return get_current_fig_manager().canvas.mpl_disconnect(cid)
+    return gcf().canvas.mpl_disconnect(cid)
 
 
 def close(fig=None):
@@ -683,7 +684,7 @@ def draw():
     This is equivalent to calling ``fig.canvas.draw_idle()``, where ``fig`` is
     the current figure.
     """
-    get_current_fig_manager().canvas.draw_idle()
+    gcf().canvas.draw_idle()
 
 
 @docstring.copy(Figure.savefig)
@@ -1262,25 +1263,19 @@ def subplot_tool(targetfig=None):
 
     A :class:`matplotlib.widgets.SubplotTool` instance is returned.
     """
-    tbar = rcParams['toolbar']  # turn off navigation toolbar for the toolfig
-    rcParams['toolbar'] = 'None'
     if targetfig is None:
-        manager = get_current_fig_manager()
-        targetfig = manager.canvas.figure
-    else:
-        # find the manager for this figure
-        for manager in _pylab_helpers.Gcf._activeQue:
-            if manager.canvas.figure == targetfig:
-                break
-        else:
-            raise RuntimeError('Could not find manager for targetfig')
+        targetfig = gcf()
 
+    tbar = rcParams['toolbar']  # turn off navigation toolbar for the toolfig
+    rcParams['toolbar'] = 'None'
     toolfig = figure(figsize=(6, 3))
     toolfig.subplots_adjust(top=0.9)
-    ret = SubplotTool(targetfig, toolfig)
     rcParams['toolbar'] = tbar
-    _pylab_helpers.Gcf.set_active(manager)  # restore the current figure
-    return ret
+
+    if hasattr(targetfig.canvas, "manager"):  # Restore the current figure
+        _pylab_helpers.Gcf.set_active(targetfig.canvas.manager)
+
+    return SubplotTool(targetfig, toolfig)
 
 
 def tight_layout(pad=1.08, h_pad=None, w_pad=None, rect=None):
