Move ToolManager warnings to rcParam validator

EBenkler · web-flow · commit 435273334dcb · 2021-02-10T18:40:57.000-05:00
Applies patch from #15284 (comment)
diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py
@@ -1,11 +1,7 @@
-import logging
-
 from matplotlib import _api, cbook, widgets
 from matplotlib.rcsetup import validate_stringlist
 import matplotlib.backend_tools as tools
 
-_log = logging.getLogger(__name__)
-
 
 class ToolEvent:
     """Event for tool manipulation (add/remove)."""
@@ -50,9 +46,6 @@ class ToolManager:
     """
 
     def __init__(self, figure=None):
-        _log.warning('Treat the new Tool classes introduced in v1.5 as '
-                     'experimental for now, the API will likely change in '
-                     'version 2.1 and perhaps the rcParam as well')
 
         self._key_press_handler_id = None
 
diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -12,7 +12,6 @@
 """
 
 from enum import IntEnum
-import logging
 import re
 import time
 from types import SimpleNamespace
@@ -25,8 +24,6 @@
 from matplotlib._pylab_helpers import Gcf
 from matplotlib import _api, cbook
 
-_log = logging.getLogger(__name__)
-
 
 class Cursors(IntEnum):  # Must subclass int for the macOS backend.
     """Backend-independent cursor types."""
@@ -80,9 +77,6 @@ class ToolBase:
     """
 
     def __init__(self, toolmanager, name):
-        _api.warn_external(
-            'The new Tool classes introduced in v1.5 are experimental; their '
-            'API (including names) will likely change in future versions.')
         self._name = name
         self._toolmanager = toolmanager
         self._figure = None
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -15,7 +15,6 @@
 
 import ast
 from functools import lru_cache, reduce
-import logging
 from numbers import Number
 import operator
 import re
@@ -32,7 +31,6 @@
 from cycler import Cycler, cycler as ccycler
 
 
-_log = logging.getLogger(__name__)
 # The capitalized forms are needed for ipython at present; this may
 # change for later versions.
 interactive_bk = ['GTK3Agg', 'GTK3Cairo',
@@ -310,6 +308,16 @@ def validate_backend(s):
     _deprecated_since="3.3")
 
 
+def _validate_toolbar(s):
+    s = ValidateInStrings(
+        'toolbar', ['None', 'toolbar2', 'toolmanager'], ignorecase=True)(s)
+    if s == 'toolmanager':
+        _api.warn_external(
+            "Treat the new Tool classes introduced in v1.5 as experimental "
+            "for now; the API and rcParam may change in future versions.")
+    return s
+
+
 @_api.deprecated("3.3")
 def _make_nseq_validator(cls, n=None, allow_none=False):
 
@@ -984,7 +992,7 @@ def _convert_validator_spec(key, conv):
 _validators = {
     "backend":           validate_backend,
     "backend_fallback":  validate_bool,
-    "toolbar":           _ignorecase(["none", "toolbar2", "toolmanager"]),
+    "toolbar":           _validate_toolbar,
     "interactive":       validate_bool,
     "timezone":          validate_string,
 
diff --git a/lib/matplotlib/tests/test_backend_bases.py b/lib/matplotlib/tests/test_backend_bases.py
@@ -167,21 +167,23 @@ def test_interactive_zoom():
 
 
 def test_toolbar_zoompan():
-    plt.rcParams['toolbar'] = 'toolmanager'
+    expected_warning_regex = (
+        r"Treat the new Tool classes introduced in "
+        r"v[0-9]*.[0-9]* as experimental for now; "
+        "the API and rcParam may change in future versions.")
+    with pytest.warns(UserWarning, match=expected_warning_regex):
+        plt.rcParams['toolbar'] = 'toolmanager'
     ax = plt.gca()
     assert ax.get_navigate_mode() is None
-    expected_warning_regex = (r"The new Tool classes introduced in "
-                              r"v[0-9]*.[0-9]* are experimental")
-    with pytest.warns(UserWarning, match=expected_warning_regex) as rec:
-        ax.figure.canvas.manager.toolmanager.add_tool(name="zoom",
-                                                      tool=ToolZoom)
-        ax.figure.canvas.manager.toolmanager.add_tool(name="pan",
-                                                      tool=ToolPan)
-        ax.figure.canvas.manager.toolmanager.add_tool(name=_views_positions,
-                                                      tool=ToolViewsPositions)
-        ax.figure.canvas.manager.toolmanager.add_tool(name='rubberband',
-                                                      tool=RubberbandBase)
-        ax.figure.canvas.manager.toolmanager.trigger_tool('zoom')
-        assert ax.get_navigate_mode() == "ZOOM"
-        ax.figure.canvas.manager.toolmanager.trigger_tool('pan')
-        assert ax.get_navigate_mode() == "PAN"
+    ax.figure.canvas.manager.toolmanager.add_tool(name="zoom",
+                                                  tool=ToolZoom)
+    ax.figure.canvas.manager.toolmanager.add_tool(name="pan",
+                                                  tool=ToolPan)
+    ax.figure.canvas.manager.toolmanager.add_tool(name=_views_positions,
+                                                  tool=ToolViewsPositions)
+    ax.figure.canvas.manager.toolmanager.add_tool(name='rubberband',
+                                                  tool=RubberbandBase)
+    ax.figure.canvas.manager.toolmanager.trigger_tool('zoom')
+    assert ax.get_navigate_mode() == "ZOOM"
+    ax.figure.canvas.manager.toolmanager.trigger_tool('pan')
+    assert ax.get_navigate_mode() == "PAN"
