Don't warn in show() when running a non-interactive backened headless.

anntzer · anntzer · commit 37190ec13206 · 2018-09-25T13:14:52.000+02:00
On Linux, $DISPLAY is unset, then we can't run a GUI toolkit anyways, so
don't warn about that in `show()`.

Delete the Note in the docstring which was redundant with the Parameters
entry.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -18,7 +18,7 @@
 import numpy as np
 
 from matplotlib import rcParams
-from matplotlib import docstring
+from matplotlib import backends, docstring
 from matplotlib import __version__ as _mpl_version
 from matplotlib import get_backend
 
@@ -415,12 +415,8 @@ def show(self, warn=True):
         Parameters
         ----------
         warn : bool
-            If ``True``, issue warning when called on a non-GUI backend
-
-        Notes
-        -----
-        For non-GUI backends, this does nothing, in which case a warning will
-        be issued if *warn* is ``True`` (default).
+            If ``True`` and we are not running headless (i.e. on Linux with an
+            unset DISPLAY), issue warning when called on a non-GUI backend.
         """
         try:
             manager = getattr(self.canvas, 'manager')
@@ -436,7 +432,8 @@ def show(self, warn=True):
                 return
             except NonGuiException:
                 pass
-        if warn:
+        if (backends._get_running_interactive_framework() != "headless"
+                and warn):
             warnings.warn('Matplotlib is currently using %s, which is a '
                           'non-GUI backend, so cannot show the figure.'
                           % get_backend())
