Kill _string_to_bool.

anntzer · dstansby · commit 6823d102d3e7 · 2018-10-06T16:27:37.000+01:00
diff --git a/doc/api/next_api_changes/2018-09-18-AL-removals.rst b/doc/api/next_api_changes/2018-09-18-AL-removals.rst
@@ -19,3 +19,6 @@ The following deprecated APIs were removed:
   ``GridSpecFromSubplotSpec.get_subplot_params``,
 - svgfont support (in :rc:`svg.fonttype`),
 - passing 'box-forced' to `axes.Axes.set_adjustable`,
+- support for the strings 'on'/'true'/'off'/'false' to mean True/False (the
+  following functions are affected: `Axes.grid`, `Axes3D.grid`,
+  `Axis.set_tick_params`, `pyplot.box`),
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -12,8 +12,7 @@
 import matplotlib
 
 from matplotlib import cbook, rcParams
-from matplotlib.cbook import (
-    _OrderedSet, _check_1d, _string_to_bool, index_of, get_label)
+from matplotlib.cbook import _OrderedSet, _check_1d, index_of, get_label
 from matplotlib import docstring
 import matplotlib.colors as mcolors
 import matplotlib.lines as mlines
@@ -2729,9 +2728,6 @@ def grid(self, b=None, which='major', axis='both', **kwargs):
         """
         if len(kwargs):
             b = True
-        elif b is not None:
-            b = _string_to_bool(b)
-
         if axis not in ['x', 'y', 'both']:
             raise ValueError("The argument 'axis' must be one of 'x', 'y' or "
                              "'both'.")
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -11,7 +11,6 @@
 from matplotlib import rcParams
 import matplotlib.artist as martist
 import matplotlib.cbook as cbook
-from matplotlib.cbook import _string_to_bool
 import matplotlib.font_manager as font_manager
 import matplotlib.lines as mlines
 import matplotlib.patches as mpatches
@@ -845,8 +844,7 @@ def set_tick_params(self, which='major', reset=False, **kw):
 
     @staticmethod
     def _translate_tick_kw(kw):
-        # The following lists may be moved to a more
-        # accessible location.
+        # The following lists may be moved to a more accessible location.
         kwkeys = ['size', 'width', 'color', 'tickdir', 'pad',
                   'labelsize', 'labelcolor', 'zorder', 'gridOn',
                   'tick1On', 'tick2On', 'label1On', 'label2On',
@@ -861,21 +859,21 @@ def _translate_tick_kw(kw):
         if 'rotation' in kw:
             kwtrans['labelrotation'] = kw.pop('rotation')
         if 'left' in kw:
-            kwtrans['tick1On'] = _string_to_bool(kw.pop('left'))
+            kwtrans['tick1On'] = kw.pop('left')
         if 'bottom' in kw:
-            kwtrans['tick1On'] = _string_to_bool(kw.pop('bottom'))
+            kwtrans['tick1On'] = kw.pop('bottom')
         if 'right' in kw:
-            kwtrans['tick2On'] = _string_to_bool(kw.pop('right'))
+            kwtrans['tick2On'] = kw.pop('right')
         if 'top' in kw:
-            kwtrans['tick2On'] = _string_to_bool(kw.pop('top'))
+            kwtrans['tick2On'] = kw.pop('top')
         if 'labelleft' in kw:
-            kwtrans['label1On'] = _string_to_bool(kw.pop('labelleft'))
+            kwtrans['label1On'] = kw.pop('labelleft')
         if 'labelbottom' in kw:
-            kwtrans['label1On'] = _string_to_bool(kw.pop('labelbottom'))
+            kwtrans['label1On'] = kw.pop('labelbottom')
         if 'labelright' in kw:
-            kwtrans['label2On'] = _string_to_bool(kw.pop('labelright'))
+            kwtrans['label2On'] = kw.pop('labelright')
         if 'labeltop' in kw:
-            kwtrans['label2On'] = _string_to_bool(kw.pop('labeltop'))
+            kwtrans['label2On'] = kw.pop('labeltop')
         if 'colors' in kw:
             c = kw.pop('colors')
             kwtrans['color'] = c
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -416,21 +416,6 @@ def is_scalar_or_string(val):
     return isinstance(val, str) or not np.iterable(val)
 
 
-def _string_to_bool(s):
-    """Parses the string argument as a boolean"""
-    if not isinstance(s, str):
-        return bool(s)
-    warn_deprecated("2.2", "Passing one of 'on', 'true', 'off', 'false' as a "
-                    "boolean is deprecated; use an actual boolean "
-                    "(True/False) instead.")
-    if s.lower() in ['on', 'true']:
-        return True
-    if s.lower() in ['off', 'false']:
-        return False
-    raise ValueError('String "%s" must be one of: '
-                     '"on", "off", "true", or "false"' % s)
-
-
 def get_sample_data(fname, asfileobj=True):
     """
     Return a sample data file.  *fname* is a path relative to the
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -33,8 +33,7 @@
 import matplotlib.image
 from matplotlib import rcsetup, style
 from matplotlib import _pylab_helpers, interactive
-from matplotlib.cbook import (
-    dedent, deprecated, silent_list, warn_deprecated, _string_to_bool)
+from matplotlib.cbook import dedent, deprecated, silent_list, warn_deprecated
 from matplotlib import docstring
 from matplotlib.backend_bases import FigureCanvasBase
 from matplotlib.figure import Figure, figaspect
@@ -1358,7 +1357,6 @@ def box(on=None):
     ax = gca()
     if on is None:
         on = not ax.get_frame_on()
-    on = _string_to_bool(on)
     ax.set_frame_on(on)
 
 ## Axis ##
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -1300,7 +1300,7 @@ def grid(self, b=True, **kwargs):
         # TODO: Operate on each axes separately
         if len(kwargs):
             b = True
-        self._draw_grid = cbook._string_to_bool(b)
+        self._draw_grid = b
         self.stale = True
 
     def ticklabel_format(
