Merge pull request #5796 from jenshnielsen/backportblacklist

mdboom · mdboom · commit 0c1ae10a4fcd · 2016-01-05T08:47:52.000-05:00
Backport blacklist
diff --git a/doc/users/whats_new/style_blacklist.rst b/doc/users/whats_new/style_blacklist.rst
@@ -0,0 +1,11 @@
+Style parameter blacklist
+-------------------------
+
+In order to prevent unexpected consequences from using a style, style
+files are no longer able to set parameters that affect things
+unrelated to style.  These parameters include::
+
+  'interactive', 'backend', 'backend.qt4', 'webagg.port',
+  'webagg.port_retries', 'webagg.open_in_browser', 'backend_fallback',
+  'toolbar', 'timezone', 'datapath', 'figure.max_open_warning',
+  'savefig.directory', 'tk.window_focus', 'hardcopy.docstring'
diff --git a/lib/matplotlib/mpl-data/stylelib/classic.mplstyle b/lib/matplotlib/mpl-data/stylelib/classic.mplstyle
@@ -293,9 +293,6 @@ figure.facecolor : 0.75    # figure facecolor; 0.75 is scalar gray
 figure.edgecolor : w       # figure edgecolor
 figure.autolayout : False  # When True, automatically adjust subplot
                            # parameters to make the plot fit the figure
-figure.max_open_warning : 20  # The maximum number of figures to open through
-                              # the pyplot interface before emitting a warning.
-                              # If less than one this feature is disabled.
 figure.frameon : True
 
 # The figure subplot parameters.  All dimensions are a fraction of the
@@ -400,18 +397,13 @@ savefig.bbox        : standard # 'tight' or 'standard'.
                                # use ffmpeg_file instead
 savefig.pad_inches  : 0.1      # Padding to be used when bbox is set to 'tight'
 savefig.jpeg_quality: 95       # when a jpeg is saved, the default quality parameter.
-savefig.directory   : ~        # default directory in savefig dialog box,
-                               # leave empty to always use current working directory
 savefig.transparent : False    # setting that controls whether figures are saved with a
                                # transparent background by default
 savefig.frameon : True
 savefig.orientation : portrait
 
 nbagg.transparent: True
 
-# tk backend params
-tk.window_focus   : False    # Maintain shell focus for TkAgg
-
 # ps backend params
 ps.papersize      : letter   # auto, letter, legal, ledger, A0-A10, B0-B10
 ps.useafm         : False    # use of afm fonts, results in small files
@@ -482,8 +474,6 @@ keymap.yscale : l                   # toggle scaling of y-axes ('log'/'linear')
 keymap.xscale : k, L                # toggle scaling of x-axes ('log'/'linear')
 keymap.all_axes : a                 # enable all axes
 
-toolbar: toolbar2
-
 ###ANIMATION settings
 animation.writer : ffmpeg         # MovieWriter 'backend' to use
 animation.codec : mpeg4           # Codec to use for writing movie
diff --git a/lib/matplotlib/style/core.py b/lib/matplotlib/style/core.py
@@ -18,10 +18,11 @@
 import os
 import re
 import contextlib
+import warnings
 
 import matplotlib as mpl
 from matplotlib import cbook
-from matplotlib import rc_params_from_file
+from matplotlib import rc_params_from_file, rcParamsDefault
 
 
 __all__ = ['use', 'context', 'available', 'library', 'reload_library']
@@ -34,11 +35,36 @@
 STYLE_FILE_PATTERN = re.compile('([\S]+).%s$' % STYLE_EXTENSION)
 
 
+# A list of rcParams that should not be applied from styles
+STYLE_BLACKLIST = set([
+    'interactive', 'backend', 'backend.qt4', 'webagg.port',
+    'webagg.port_retries', 'webagg.open_in_browser', 'backend_fallback',
+    'toolbar', 'timezone', 'datapath', 'figure.max_open_warning',
+    'savefig.directory', 'tk.window_focus', 'hardcopy.docstring'])
+
+
+def _remove_blacklisted_style_params(d, warn=True):
+    o = {}
+    for key, val in d.items():
+        if key in STYLE_BLACKLIST:
+            if warn:
+                warnings.warn(
+                    "Style includes a parameter, '{0}', that is not related "
+                    "to style.  Ignoring".format(key))
+        else:
+            o[key] = val
+    return o
+
+
 def is_style_file(filename):
     """Return True if the filename looks like a style file."""
     return STYLE_FILE_PATTERN.match(filename) is not None
 
 
+def _apply_style(d, warn=True):
+    mpl.rcParams.update(_remove_blacklisted_style_params(d, warn=warn))
+
+
 def use(style):
     """Use matplotlib style settings from a style specification.
 
@@ -71,18 +97,15 @@ def use(style):
 
     for style in styles:
         if not cbook.is_string_like(style):
-            mpl.rcParams.update(style)
-            continue
+            _apply_style(style)
         elif style == 'default':
-            mpl.rcdefaults()
-            continue
-
-        if style in library:
-            mpl.rcParams.update(library[style])
+            _apply_style(rcParamsDefault, warn=False)
+        elif style in library:
+            _apply_style(library[style])
         else:
             try:
                 rc = rc_params_from_file(style, use_default_template=False)
-                mpl.rcParams.update(rc)
+                _apply_style(rc)
             except IOError:
                 msg = ("'%s' not found in the style library and input is "
                        "not a valid URL or path. See `style.available` for "
diff --git a/lib/matplotlib/tests/test_backend_qt4.py b/lib/matplotlib/tests/test_backend_qt4.py
@@ -7,7 +7,7 @@
 from matplotlib.testing.decorators import cleanup, switch_backend
 from matplotlib.testing.decorators import knownfailureif
 from matplotlib._pylab_helpers import Gcf
-import matplotlib.style as mstyle
+import matplotlib
 import copy
 
 try:
@@ -17,7 +17,7 @@
     import mock
 
 try:
-    with mstyle.context({'backend': 'Qt4Agg'}):
+    with matplotlib.rc_context(rc={'backend': 'Qt4Agg'}):
         from matplotlib.backends.qt_compat import QtCore
 
     from matplotlib.backends.backend_qt4 import (MODIFIER_KEYS,
diff --git a/lib/matplotlib/tests/test_backend_qt5.py b/lib/matplotlib/tests/test_backend_qt5.py
@@ -6,7 +6,7 @@
 from matplotlib.testing.decorators import cleanup, switch_backend
 from matplotlib.testing.decorators import knownfailureif
 from matplotlib._pylab_helpers import Gcf
-import matplotlib.style as mstyle
+import matplotlib
 import copy
 
 try:
@@ -16,7 +16,7 @@
     import mock
 
 try:
-    with mstyle.context({'backend': 'Qt5Agg'}):
+    with matplotlib.rc_context(rc={'backend': 'Qt5Agg'}):
         from matplotlib.backends.qt_compat import QtCore, __version__
     from matplotlib.backends.backend_qt5 import (MODIFIER_KEYS,
                                                  SUPER, ALT, CTRL, SHIFT)
