Merge pull request #10685 from CinnyCao/becky-fix-#7908

jkseppan · jkseppan · commit 02646cb99e91 · 2018-04-01T22:29:11.000+03:00
fix plt.show doesn't warn if a non-GUI backend
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -179,13 +179,20 @@ def show(cls, block=None):
         is ``None`` and we are neither in IPython's ``%pylab`` mode, nor in
         `interactive` mode.
         """
-        if cls.mainloop is None:
-            return
         managers = Gcf.get_all_fig_managers()
         if not managers:
             return
         for manager in managers:
-            manager.show()
+            try:
+                manager.show()
+            except NonGuiException:
+                warnings.warn(
+                    ('matplotlib is currently using %s, which is a ' +
+                     'non-GUI backend, so cannot show the figure.')
+                    % get_backend())
+                return
+        if cls.mainloop is None:
+            return
         if block is None:
             # Hack: Are we in IPython's pylab mode?
             from matplotlib import pyplot
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -19,6 +19,7 @@
 from matplotlib import rcParams
 from matplotlib import docstring
 from matplotlib import __version__ as _mpl_version
+from matplotlib import get_backend
 
 import matplotlib.artist as martist
 from matplotlib.artist import Artist, allow_rasterization
@@ -414,7 +415,7 @@ def show(self, warn=True):
 
         Parameters
         ----------
-        warm : bool
+        warn : bool
             If ``True``, issue warning when called on a non-GUI backend
 
         Notes
@@ -437,10 +438,10 @@ def show(self, warn=True):
             except NonGuiException:
                 pass
         if warn:
-            import warnings
             warnings.warn(
-                "matplotlib is currently using a non-GUI backend, "
-                "so cannot show the figure")
+                ('matplotlib is currently using %s, which is a ' +
+                 'non-GUI backend, so cannot show the figure.')
+                % get_backend())
 
     def _get_axes(self):
         return self._axstack.as_list()
diff --git a/lib/matplotlib/tests/test_backend_bases.py b/lib/matplotlib/tests/test_backend_bases.py
@@ -9,6 +9,7 @@
 import os
 import shutil
 import tempfile
+import pytest
 
 
 def test_uses_per_path():
@@ -60,3 +61,21 @@ def test_get_default_filename():
         assert filename == 'image.png'
     finally:
         shutil.rmtree(test_dir)
+
+
+@pytest.mark.backend('pdf')
+def test_non_gui_warning():
+    plt.subplots()
+    with pytest.warns(UserWarning) as rec:
+        plt.show()
+        assert len(rec) == 1
+        assert 'matplotlib is currently using pdf, ' \
+               'which is a non-GUI backend' \
+               in str(rec[0].message)
+
+    with pytest.warns(UserWarning) as rec:
+        plt.gcf().show()
+        assert len(rec) == 1
+        assert 'matplotlib is currently using pdf, ' \
+               'which is a non-GUI backend' \
+               in str(rec[0].message)
