Merge pull request #196 from effigies/enh/catch-skips

ENH: Report doctests raising skip exceptions as skipped

CHANGES.rst

@@ -1,6 +1,8 @@
 0.12.2 (unreleased)
 ===================
 
+- Report doctests raising skip exceptions as skipped. [#196]
+
 0.12.1 (2022-09-26)
 ===================
 

pytest_doctestplus/plugin.py

@@ -11,8 +11,10 @@
 import warnings
 from pathlib import Path
 from textwrap import indent
+from unittest import SkipTest
 
 import pytest
+from _pytest.outcomes import OutcomeException  # Private API, but been around since 3.7
 from packaging.version import Version
 
 from pytest_doctestplus.utils import ModuleChecker
@@ -258,7 +260,7 @@ def collect(self):
 
             # uses internal doctest module parsing mechanism
             finder = DocTestFinderPlus(doctest_ufunc=use_doctest_ufunc)
-            runner = doctest.DebugRunner(
+            runner = DebugRunnerPlus(
                 verbose=False, optionflags=options, checker=OutputChecker())
 
             for test in finder.find(module):
@@ -320,7 +322,7 @@ def collect(self):
 
             optionflags = get_optionflags(self) | FIX
 
-            runner = doctest.DebugRunner(
+            runner = DebugRunnerPlus(
                 verbose=False, optionflags=optionflags, checker=OutputChecker())
 
             parser = DocTestParserPlus()
@@ -707,3 +709,11 @@ def test_filter(test):
             tests = list(filter(test_filter, tests))
 
         return tests
+
+
+class DebugRunnerPlus(doctest.DebugRunner):
+    def report_unexpected_exception(self, out, test, example, exc_info):
+        cls, exception, traceback = exc_info
+        if isinstance(exception, (OutcomeException, SkipTest)):
+            raise exception
+        super().report_unexpected_exception(out, test, example, exc_info)

tests/test_doctestplus.py

@@ -965,6 +965,28 @@ def test_remote_data_ignore_warnings(testdir):
     testdir.inline_run(p, '--doctest-plus', '--doctest-rst').assertoutcome(skipped=1)
 
 
+def test_skiptest(testdir):
+    testdir.makeini(
+        """
+        [pytest]
+        doctestplus = enabled
+    """
+    )
+    p = testdir.makepyfile(
+        """
+        class MyClass:
+            '''
+            >>> import pytest
+            >>> pytest.skip("I changed my mind")
+            >>> assert False, "This should not be reached"
+            '''
+            pass
+    """
+    )
+    reprec = testdir.inline_run(p, "--doctest-plus")
+    reprec.assertoutcome(skipped=1, failed=0)
+
+
 def test_ufunc(testdir):
     pytest.importorskip('numpy')