fc4f72cb1f
unexpected exceptions are now reported within the doctest failure representation context.
88 lines
3.4 KiB
Python
88 lines
3.4 KiB
Python
""" discover and run doctests in modules and test files."""
|
|
|
|
import pytest, py
|
|
from py._code.code import TerminalRepr, ReprFileLocation
|
|
|
|
def pytest_addoption(parser):
|
|
group = parser.getgroup("collect")
|
|
group.addoption("--doctest-modules",
|
|
action="store_true", default=False,
|
|
help="run doctests in all .py modules",
|
|
dest="doctestmodules")
|
|
group.addoption("--doctest-glob",
|
|
action="store", default="test*.txt", metavar="pat",
|
|
help="doctests file matching pattern, default: test*.txt",
|
|
dest="doctestglob")
|
|
|
|
def pytest_collect_file(path, parent):
|
|
config = parent.config
|
|
if path.ext == ".py":
|
|
if config.option.doctestmodules:
|
|
return DoctestModule(path, parent)
|
|
elif (path.ext in ('.txt', '.rst') and parent.session.isinitpath(path)) or \
|
|
path.check(fnmatch=config.getvalue("doctestglob")):
|
|
return DoctestTextfile(path, parent)
|
|
|
|
class ReprFailDoctest(TerminalRepr):
|
|
def __init__(self, reprlocation, lines):
|
|
self.reprlocation = reprlocation
|
|
self.lines = lines
|
|
def toterminal(self, tw):
|
|
for line in self.lines:
|
|
tw.line(line)
|
|
self.reprlocation.toterminal(tw)
|
|
|
|
class DoctestItem(pytest.Item):
|
|
def repr_failure(self, excinfo):
|
|
doctest = py.std.doctest
|
|
if excinfo.errisinstance((doctest.DocTestFailure,
|
|
doctest.UnexpectedException)):
|
|
doctestfailure = excinfo.value
|
|
example = doctestfailure.example
|
|
test = doctestfailure.test
|
|
filename = test.filename
|
|
lineno = test.lineno + example.lineno + 1
|
|
message = excinfo.type.__name__
|
|
reprlocation = ReprFileLocation(filename, lineno, message)
|
|
checker = py.std.doctest.OutputChecker()
|
|
REPORT_UDIFF = py.std.doctest.REPORT_UDIFF
|
|
filelines = py.path.local(filename).readlines(cr=0)
|
|
i = max(test.lineno, max(0, lineno - 10)) # XXX?
|
|
lines = []
|
|
for line in filelines[i:lineno]:
|
|
lines.append("%03d %s" % (i+1, line))
|
|
i += 1
|
|
if excinfo.errisinstance(doctest.DocTestFailure):
|
|
lines += checker.output_difference(example,
|
|
doctestfailure.got, REPORT_UDIFF).split("\n")
|
|
else:
|
|
inner_excinfo = py.code.ExceptionInfo(excinfo.value.exc_info)
|
|
lines += ["UNEXPECTED EXCEPTION: %s" %
|
|
repr(inner_excinfo.value)]
|
|
|
|
return ReprFailDoctest(reprlocation, lines)
|
|
else:
|
|
return super(DoctestItem, self).repr_failure(excinfo)
|
|
|
|
def reportinfo(self):
|
|
return self.fspath, None, "[doctest]"
|
|
|
|
class DoctestTextfile(DoctestItem, pytest.File):
|
|
def runtest(self):
|
|
doctest = py.std.doctest
|
|
failed, tot = doctest.testfile(
|
|
str(self.fspath), module_relative=False,
|
|
optionflags=doctest.ELLIPSIS,
|
|
raise_on_error=True, verbose=0)
|
|
|
|
class DoctestModule(DoctestItem, pytest.File):
|
|
def runtest(self):
|
|
doctest = py.std.doctest
|
|
if self.fspath.basename == "conftest.py":
|
|
module = self.config._conftest.importconftest(self.fspath)
|
|
else:
|
|
module = self.fspath.pyimport()
|
|
failed, tot = doctest.testmod(
|
|
module, raise_on_error=True, verbose=0,
|
|
optionflags=doctest.ELLIPSIS)
|