ENH: Add doctest_skip_parser allowing conditional skipping of doctests

2026-08-18 12:30:14 +08:00 · 2013-11-20 11:20:42 -06:00
parent 6239ab23b1
commit d398b43051
4 changed files with 163 additions and 11 deletions
@@ -0,0 +1,87 @@
+""" Testing decorators module
+"""
+
+import numpy as np
+from nose.tools import (assert_true, assert_raises, assert_equal)
+from skimage._shared.testing import doctest_skip_parser
+
+
+def test_skipper():
+    def f():
+        pass
+
+    class c():
+        def __init__(self):
+            self.me = "I think, therefore..."
+
+    docstring = \
+        """ Header
+
+        >>> something # skip if not HAVE_AMODULE
+        >>> something + else
+        >>> a = 1 # skip if not HAVE_BMODULE
+        >>> something2   # skip if HAVE_AMODULE
+        """
+    f.__doc__ = docstring
+    c.__doc__ = docstring
+
+    global HAVE_AMODULE, HAVE_BMODULE
+    HAVE_AMODULE = False
+    HAVE_BMODULE = True
+
+    f2 = doctest_skip_parser(f)
+    c2 = doctest_skip_parser(c)
+    assert_true(f is f2)
+    assert_true(c is c2)
+
+    assert_equal(f2.__doc__,
+                 """ Header
+
+                 >>> something # doctest: +SKIP
+                 >>> something + else
+                 >>> a = 1
+                 >>> something2
+                 """)
+    assert_equal(c2.__doc__,
+                 """ Header
+
+                 >>> something # doctest: +SKIP
+                 >>> something + else
+                 >>> a = 1
+                 >>> something2
+                 """)
+
+    HAVE_AMODULE = True
+    HAVE_BMODULE = False
+    f.__doc__ = docstring
+    c.__doc__ = docstring
+    f2 = doctest_skip_parser(f)
+    c2 = doctest_skip_parser(c)
+
+    assert_true(f is f2)
+    assert_equal(f2.__doc__,
+                 """ Header
+
+                 >>> something
+                 >>> something + else
+                 >>> a = 1 # doctest: +SKIP
+                 >>> something2   # doctest: +SKIP
+                 """)
+    assert_equal(c2.__doc__,
+                 """ Header
+
+                 >>> something
+                 >>> something + else
+                 >>> a = 1 # doctest: +SKIP
+                 >>> something2   # doctest: +SKIP
+                 """)
+
+    del HAVE_AMODULE
+    f.__doc__ = docstring
+    c.__doc__ = docstring
+    assert_raises(NameError, doctest_skip_parser, f)
+    assert_raises(NameError, doctest_skip_parser, c)
+
+
+if __name__ == '__main__':
+    np.testing.run_module_suite()