Use rc_context more.

anntzer · anntzer · commit df7f0ab94f2c · 2019-12-16T15:30:50.000+01:00
rather than manually restoring rcParams at exit.
diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/next_api_changes/deprecations.rst
@@ -63,3 +63,7 @@ it via the *cmap* parameter:
 ``DateFormatter.illegal_s``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This attribute is unused and deprecated.
+
+``widgets.TextBox.params_to_disable``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This attribute is deprecated.
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -1102,33 +1102,31 @@ def func(current_frame: int, total_frames: int) -> Any
         # TODO: Right now, after closing the figure, saving a movie won't work
         # since GUI widgets are gone. Either need to remove extra code to
         # allow for this non-existent use case or find a way to make it work.
-        with mpl.rc_context():
-            if mpl.rcParams['savefig.bbox'] == 'tight':
-                _log.info("Disabling savefig.bbox = 'tight', as it may cause "
-                          "frame size to vary, which is inappropriate for "
-                          "animation.")
-                mpl.rcParams['savefig.bbox'] = None
-            with writer.saving(self._fig, filename, dpi):
-                for anim in all_anim:
-                    # Clear the initial frame
-                    anim._init_draw()
-                frame_number = 0
-                # TODO: Currently only FuncAnimation has a save_count
-                #       attribute. Can we generalize this to all Animations?
-                save_count_list = [getattr(a, 'save_count', None)
-                                   for a in all_anim]
-                if None in save_count_list:
-                    total_frames = None
-                else:
-                    total_frames = sum(save_count_list)
-                for data in zip(*[a.new_saved_frame_seq() for a in all_anim]):
-                    for anim, d in zip(all_anim, data):
-                        # TODO: See if turning off blit is really necessary
-                        anim._draw_next_frame(d, blit=False)
-                        if progress_callback is not None:
-                            progress_callback(frame_number, total_frames)
-                            frame_number += 1
-                    writer.grab_frame(**savefig_kwargs)
+        if mpl.rcParams['savefig.bbox'] == 'tight':
+            _log.info("Disabling savefig.bbox = 'tight', as it may cause "
+                      "frame size to vary, which is inappropriate for "
+                      "animation.")
+        with mpl.rc_context({'savefig.bbox': None}), \
+             writer.saving(self._fig, filename, dpi):
+            for anim in all_anim:
+                anim._init_draw()  # Clear the initial frame
+            frame_number = 0
+            # TODO: Currently only FuncAnimation has a save_count
+            #       attribute. Can we generalize this to all Animations?
+            save_count_list = [getattr(a, 'save_count', None)
+                               for a in all_anim]
+            if None in save_count_list:
+                total_frames = None
+            else:
+                total_frames = sum(save_count_list)
+            for data in zip(*[a.new_saved_frame_seq() for a in all_anim]):
+                for anim, d in zip(all_anim, data):
+                    # TODO: See if turning off blit is really necessary
+                    anim._draw_next_frame(d, blit=False)
+                    if progress_callback is not None:
+                        progress_callback(frame_number, total_frames)
+                        frame_number += 1
+                writer.grab_frame(**savefig_kwargs)
 
         # Reconnect signal for first draw if necessary
         if reconnect_first_draw:
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1223,11 +1223,9 @@ def subplot_tool(targetfig=None):
     if targetfig is None:
         targetfig = gcf()
 
-    tbar = rcParams['toolbar']  # Turn off navigation toolbar for the toolfig.
-    rcParams['toolbar'] = 'None'
-    toolfig = figure(figsize=(6, 3))
+    with rc_context({'toolbar': 'None'}):  # No nav toolbar for the toolfig.
+        toolfig = figure(figsize=(6, 3))
     toolfig.subplots_adjust(top=0.9)
-    rcParams['toolbar'] = tbar
 
     if hasattr(targetfig.canvas, "manager"):  # Restore the current figure.
         _pylab_helpers.Gcf.set_active(targetfig.canvas.manager)
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -15,7 +15,8 @@
 
 import numpy as np
 
-from . import cbook, rcParams
+import matplotlib as mpl
+from . import cbook
 from .lines import Line2D
 from .patches import Circle, Rectangle, Ellipse
 from .transforms import blended_transform_factory
@@ -678,6 +679,11 @@ class TextBox(AxesWidget):
         The color of the text box when hovering.
     """
 
+    @cbook.deprecated("3.3")
+    @property
+    def params_to_disable(self):
+        return [key for key in mpl.rcParams if 'keymap' in key]
+
     def __init__(self, ax, label, initial='',
                  color='.95', hovercolor='1', label_pad=.01):
         """
@@ -700,8 +706,6 @@ def __init__(self, ax, label, initial='',
 
         self.DIST_FROM_LEFT = .05
 
-        self.params_to_disable = [key for key in rcParams if 'keymap' in key]
-
         self.text = initial
         self.label = ax.text(-label_pad, 0.5, label,
                              verticalalignment='center',
@@ -845,10 +849,10 @@ def begin_typing(self, x):
         if self.ax.figure.canvas.manager.key_press_handler_id is not None:
             # disable command keys so that the user can type without
             # command keys causing figure to be saved, etc
-            self.reset_params = {}
-            for key in self.params_to_disable:
-                self.reset_params[key] = rcParams[key]
-                rcParams[key] = []
+            self._restore_keymap = ExitStack()
+            self._restore_keymap.enter_context(
+                mpl.rc_context(
+                    {k: [] for k in mpl.rcParams if k.startswith('keymap.')}))
         else:
             self.ax.figure.canvas.manager.toolmanager.keypresslock(self)
 
@@ -861,8 +865,7 @@ def stop_typing(self):
             if self.ax.figure.canvas.manager.key_press_handler_id is not None:
                 # since the user is no longer typing,
                 # reactivate the standard command keys
-                for key in self.params_to_disable:
-                    rcParams[key] = self.reset_params[key]
+                self._restore_keymap.close()
             else:
                 toolmanager = self.ax.figure.canvas.manager.toolmanager
                 toolmanager.keypresslock.release(self)
