Integrate doctests with pytest

Author: Jake-Moss

src/flint/test/__main__.py

@@ -8,15 +8,10 @@
 import doctest
 import traceback
 import argparse
-import pkgutil
-import importlib
-import re
 
 import flint
 from flint.test.test_all import all_tests
-
-
-dunder_test_regex = re.compile(r'^(.*?)__test__\..*?\.(.*) \(line (\d+)\)$')
+from flint.test.test_docstrings import find_doctests
 
 
 def run_tests(verbose=None):
@@ -54,29 +49,6 @@ def run_tests(verbose=None):
     return failed, total
 
 
-def find_doctests(module):
-    finder = doctest.DocTestFinder()
-    tests = []
-    for module_info in pkgutil.walk_packages(module.__path__, flint.__name__ + "."):
-        try:
-            module = importlib.import_module(module_info.name)
-
-            res = []
-            for test in filter(lambda x: bool(x.examples), finder.find(module)):
-                m = dunder_test_regex.match(test.name)
-                if m is not None:
-                    groups = m.groups()
-                    test.name = groups[0] + groups[1]
-                    test.lineno = int(groups[2])
-                    res.append(test)
-
-            tests.append((module_info.name, res))
-
-        except Exception as e:
-            print(f"Error importing {module_info.name}: {e}")
-    return tests
-
-
 def run_doctests(tests, verbose=False):
     runner = doctest.DocTestRunner()
     for module, test_set in tests:

src/flint/test/meson.build

@@ -4,6 +4,7 @@ pyfiles = [
   '__init__.py',
   '__main__.py',
   'test_all.py',
+  'test_docstrings.py',
 ]
 
 py.install_sources(

src/flint/test/test_docstrings.py

@@ -0,0 +1,55 @@
+import doctest
+import importlib
+import pkgutil
+import pytest
+import re
+
+import flint
+
+dunder_test_regex = re.compile(r'^(.*?)__test__\..*?\.(.*) \(line (\d+)\)$')
+
+
+def find_doctests(module):
+    finder = doctest.DocTestFinder()
+    tests = []
+    for module_info in pkgutil.walk_packages(module.__path__, flint.__name__ + "."):
+        try:
+            module = importlib.import_module(module_info.name)
+
+            res = []
+            for test in filter(lambda x: bool(x.examples), finder.find(module)):
+                m = dunder_test_regex.match(test.name)
+                if m is not None:
+                    groups = m.groups()
+                    test.name = groups[0] + groups[1]
+                    test.lineno = int(groups[2])
+                    res.append(test)
+
+            tests.append((module_info.name, res))
+
+        except Exception as e:
+            print(f"Error importing {module_info.name}: {e}")
+    return tests
+
+
+class PyTestDocTestRunner(doctest.DocTestRunner):
+    def report_failure(self, out, test, example, got):
+        pytest.fail(
+            "\n".join([
+                f"Failed: {test.name}, line: {test.lineno}",
+                "Failed example:",
+                f"\t{example.source.strip()}",
+                "Expected:",
+                f"\t{example.want.strip()}",
+                "Got:",
+                f"\t{got.strip()}"
+            ]),
+            pytrace=False,
+        )
+
+
+runner = PyTestDocTestRunner()
+
+@pytest.mark.parametrize("module,test", [(module, test) for module, test_set in find_doctests(flint) for test in test_set])
+def test_docstrings(module, test):
+    runner.run(test)

src/flint/types/fmpz_poly.pyx

@@ -644,7 +644,7 @@ cdef class fmpz_poly(flint_poly):
         here. The returned monomial allows the undo-ing of the deflation.
 
             >>> f = fmpz_poly([1, 0, 1])
-            >>> f.deflation()
+            >>> f.deflation_monom()
             (1, x)
         """
         n, m = self.deflation_index()
@@ -663,7 +663,7 @@ cdef class fmpz_poly(flint_poly):
         ``deflation_monom``.
 
             >>> f = fmpz_poly([1, 0, 1])
-            >>> f.deflation()
+            >>> f.deflation_index()
             (1, 1)
         """
         cdef fmpz_poly res = fmpz_poly.__new__(fmpz_poly)