add validation submodule

Author: phobson

probscale/tests/test_probscale/test_validate.py

@@ -0,0 +1,72 @@
+from matplotlib import pyplot
+
+import nose.tools as nt
+from matplotlib.testing.decorators import cleanup
+
+from probscale import validate
+
+
+class Test_axes_object(object):
+    @nt.raises(ValueError)
+    def test_bad_value(self):
+        validate.axes_object('junk')
+
+    @cleanup
+    def test_with_ax(self):
+        fig, ax = pyplot.subplots()
+        fig1, ax1 = validate.axes_object(ax)
+        nt.assert_true(isinstance(ax1, pyplot.Axes))
+        nt.assert_true(isinstance(fig1, pyplot.Figure))
+        nt.assert_true(ax1 is ax)
+        nt.assert_true(fig1 is fig)
+
+    @cleanup
+    def test_with_None(self):
+        fig1, ax1 = validate.axes_object(None)
+        nt.assert_true(isinstance(ax1, pyplot.Axes))
+        nt.assert_true(isinstance(fig1, pyplot.Figure))
+
+
+class Test_fit_argument(object):
+    @nt.raises(ValueError)
+    def test_bad_fitarg(self):
+        validate.fit_argument('junk', 'fitprobs')
+
+    def test_x(self):
+        nt.assert_equal('x', validate.fit_argument('x', 'fitprobs'))
+        nt.assert_equal('x', validate.fit_argument('x', 'fitlogs'))
+
+    def test_y(self):
+        nt.assert_equal('y', validate.fit_argument('y', 'fitprobs'))
+        nt.assert_equal('y', validate.fit_argument('y', 'fitlogs'))
+
+    def test_both(self):
+        nt.assert_equal('both', validate.fit_argument('both', 'fitprobs'))
+        nt.assert_equal('both', validate.fit_argument('both', 'fitlogs'))
+
+    def test_None(self):
+        nt.assert_true(validate.fit_argument(None, 'fitprobs') is None)
+        nt.assert_true(validate.fit_argument(None, 'fitlogs') is None)
+
+
+class Test_axis_name(object):
+    @nt.raises(ValueError)
+    def test_bad_name(self):
+        validate.axis_name('junk', 'axname')
+
+    def test_x(self):
+        nt.assert_equal('x', validate.axis_name('x', 'axname'))
+
+    def test_y(self):
+        nt.assert_equal('y', validate.axis_name('y', 'axname'))
+
+
+class Test_axis_type(object):
+    @nt.raises(ValueError)
+    def test_bad_value(self):
+        validate.axis_type("JUNK")
+
+    def test_upper(self):
+        nt.assert_equal('pp', validate.axis_type('PP'))
+        nt.assert_equal('qq', validate.axis_type('QQ'))
+        nt.assert_equal('prob', validate.axis_type('ProB'))

probscale/validate.py

@@ -0,0 +1,44 @@
+from matplotlib import pyplot
+
+
+def axes_object(ax):
+    """ Checks if a value if an Axes. If None, a new one is created.
+
+    """
+
+    if ax is None:
+        fig, ax = pyplot.subplots()
+    elif isinstance(ax, pyplot.Axes):
+        fig = ax.figure
+    else:
+        msg = "`ax` must be a matplotlib Axes instance or None"
+        raise ValueError(msg)
+
+    return fig, ax
+
+
+def axis_name(axname, argname):
+    valid_args = ['x', 'y']
+    if axname.lower() not in valid_args:
+        msg = 'Invalid value for {} ({}). Must be on of {}.'
+        raise ValueError(msg.format(argname, axname, valid_args))
+
+    return axname.lower()
+
+
+def fit_argument(arg, argname):
+    valid_args = ['x', 'y', 'both', None]
+    if arg not in valid_args:
+        msg = 'Invalid value for {} ({}). Must be on of {}.'
+        raise ValueError(msg.format(argname, arg, valid_args))
+
+    return arg
+
+
+def axis_type(axtype):
+    if axtype.lower() not in ['pp', 'qq', 'prob']:
+        raise ValueError("invalid axtype: {}".format(axtype))
+    return axtype.lower()
+
+
+