FIX: add custom validator for hist.bins

tacaswell · tacaswell · commit 5e0ca92178f6 · 2015-11-23T22:23:00.000-05:00
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -770,6 +770,23 @@ def validate_cycler(s):
     return cycler_inst
 
 
+def validate_hist_bins(s):
+    if isinstance(s, six.text_type) and s == 'auto':
+        return s
+    try:
+        return int(s)
+    except (TypeError, ValueError):
+        pass
+
+    try:
+        return validate_floatlist(s)
+    except ValueError:
+        pass
+
+    raise ValueError("'hist.bins' must be 'auto', an int or " +
+                     "a sequence of floats")
+
+
 # a map from key -> value, converter
 defaultParams = {
     'backend':           ['Agg', validate_backend],  # agg is certainly
@@ -814,7 +831,7 @@ def validate_cycler(s):
     'patch.antialiased': [True, validate_bool],  # antialiased (no jaggies)
 
     ## Histogram properties
-    'hist.bins': [10, validate_any],
+    'hist.bins': [10, validate_hist_bins],
 
     ## Boxplot properties
     'boxplot.notch': [False, validate_bool],
diff --git a/lib/matplotlib/tests/test_rcparams.py b/lib/matplotlib/tests/test_rcparams.py
@@ -27,7 +27,8 @@
                                 validate_nseq_int,
                                 validate_nseq_float,
                                 validate_cycler,
-                                validate_hatch)
+                                validate_hatch,
+                                validate_hist_bins)
 
 
 mpl.rc('text', usetex=False)
@@ -363,7 +364,17 @@ def test_validators():
                     ),
          'fail': (('fish', ValueError),
                  ),
-        }
+        },
+        {'validator': validate_hist_bins,
+         'success': (('auto', 'auto'),
+                     ('10', 10),
+                     ('1, 2, 3', [1, 2, 3]),
+                     ([1, 2, 3], [1, 2, 3]),
+                     (np.arange(15), np.arange(15))
+                     ),
+         'fail': (('aardvark', ValueError),
+                  )
+         }
     )
 
     for validator_dict in validation_tests:
