mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
387 lines
14 KiB
Python
387 lines
14 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
sphinx.ext.doctest
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
Mimic doctest by automatically executing code snippets and checking
|
|
their results.
|
|
|
|
:copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import re
|
|
import sys
|
|
import time
|
|
import codecs
|
|
import StringIO
|
|
from os import path
|
|
# circumvent relative import
|
|
doctest = __import__('doctest')
|
|
|
|
from docutils import nodes
|
|
from docutils.parsers.rst import directives
|
|
|
|
from sphinx.builders import Builder
|
|
from sphinx.util.compat import Directive
|
|
from sphinx.util.console import bold
|
|
|
|
blankline_re = re.compile(r'^\s*<BLANKLINE>', re.MULTILINE)
|
|
doctestopt_re = re.compile(r'#\s*doctest:.+$', re.MULTILINE)
|
|
|
|
# set up the necessary directives
|
|
|
|
class TestDirective(Directive):
|
|
"""
|
|
Base class for doctest-related directives.
|
|
"""
|
|
|
|
has_content = True
|
|
required_arguments = 0
|
|
optional_arguments = 1
|
|
final_argument_whitespace = True
|
|
|
|
def run(self):
|
|
# use ordinary docutils nodes for test code: they get special attributes
|
|
# so that our builder recognizes them, and the other builders are happy.
|
|
code = '\n'.join(self.content)
|
|
test = None
|
|
if self.name == 'doctest':
|
|
if '<BLANKLINE>' in code:
|
|
# convert <BLANKLINE>s to ordinary blank lines for presentation
|
|
test = code
|
|
code = blankline_re.sub('', code)
|
|
if doctestopt_re.search(code):
|
|
if not test:
|
|
test = code
|
|
code = doctestopt_re.sub('', code)
|
|
nodetype = nodes.literal_block
|
|
if self.name == 'testsetup' or 'hide' in self.options:
|
|
nodetype = nodes.comment
|
|
if self.arguments:
|
|
groups = [x.strip() for x in self.arguments[0].split(',')]
|
|
else:
|
|
groups = ['default']
|
|
node = nodetype(code, code, testnodetype=self.name, groups=groups)
|
|
node.line = self.lineno
|
|
if test is not None:
|
|
# only save if it differs from code
|
|
node['test'] = test
|
|
if self.name == 'testoutput':
|
|
# don't try to highlight output
|
|
node['language'] = 'none'
|
|
node['options'] = {}
|
|
if self.name in ('doctest', 'testoutput') and 'options' in self.options:
|
|
# parse doctest-like output comparison flags
|
|
option_strings = self.options['options'].replace(',', ' ').split()
|
|
for option in option_strings:
|
|
if (option[0] not in '+-' or option[1:] not in
|
|
doctest.OPTIONFLAGS_BY_NAME):
|
|
# XXX warn?
|
|
continue
|
|
flag = doctest.OPTIONFLAGS_BY_NAME[option[1:]]
|
|
node['options'][flag] = (option[0] == '+')
|
|
return [node]
|
|
|
|
class TestsetupDirective(TestDirective):
|
|
option_spec = {}
|
|
|
|
class DoctestDirective(TestDirective):
|
|
option_spec = {
|
|
'hide': directives.flag,
|
|
'options': directives.unchanged,
|
|
}
|
|
|
|
class TestcodeDirective(TestDirective):
|
|
option_spec = {
|
|
'hide': directives.flag,
|
|
}
|
|
|
|
class TestoutputDirective(TestDirective):
|
|
option_spec = {
|
|
'hide': directives.flag,
|
|
'options': directives.unchanged,
|
|
}
|
|
|
|
|
|
parser = doctest.DocTestParser()
|
|
|
|
# helper classes
|
|
|
|
class TestGroup(object):
|
|
def __init__(self, name):
|
|
self.name = name
|
|
self.setup = []
|
|
self.tests = []
|
|
|
|
def add_code(self, code, prepend=False):
|
|
if code.type == 'testsetup':
|
|
if prepend:
|
|
self.setup.insert(0, code)
|
|
else:
|
|
self.setup.append(code)
|
|
elif code.type == 'doctest':
|
|
self.tests.append([code])
|
|
elif code.type == 'testcode':
|
|
self.tests.append([code, None])
|
|
elif code.type == 'testoutput':
|
|
if self.tests and len(self.tests[-1]) == 2:
|
|
self.tests[-1][1] = code
|
|
else:
|
|
raise RuntimeError('invalid TestCode type')
|
|
|
|
def __repr__(self):
|
|
return 'TestGroup(name=%r, setup=%r, tests=%r)' % (
|
|
self.name, self.setup, self.tests)
|
|
|
|
|
|
class TestCode(object):
|
|
def __init__(self, code, type, lineno, options=None):
|
|
self.code = code
|
|
self.type = type
|
|
self.lineno = lineno
|
|
self.options = options or {}
|
|
|
|
def __repr__(self):
|
|
return 'TestCode(%r, %r, %r, options=%r)' % (
|
|
self.code, self.type, self.lineno, self.options)
|
|
|
|
|
|
class SphinxDocTestRunner(doctest.DocTestRunner):
|
|
def summarize(self, out, verbose=None):
|
|
io = StringIO.StringIO()
|
|
old_stdout = sys.stdout
|
|
sys.stdout = io
|
|
try:
|
|
res = doctest.DocTestRunner.summarize(self, verbose)
|
|
finally:
|
|
sys.stdout = old_stdout
|
|
out(io.getvalue())
|
|
return res
|
|
|
|
def _DocTestRunner__patched_linecache_getlines(self, filename,
|
|
module_globals=None):
|
|
# this is overridden from DocTestRunner adding the try-except below
|
|
m = self._DocTestRunner__LINECACHE_FILENAME_RE.match(filename)
|
|
if m and m.group('name') == self.test.name:
|
|
try:
|
|
example = self.test.examples[int(m.group('examplenum'))]
|
|
# because we compile multiple doctest blocks with the same name
|
|
# (viz. the group name) this might, for outer stack frames in a
|
|
# traceback, get the wrong test which might not have enough examples
|
|
except IndexError:
|
|
pass
|
|
else:
|
|
return example.source.splitlines(True)
|
|
return self.save_linecache_getlines(filename, module_globals)
|
|
|
|
|
|
# the new builder -- use sphinx-build.py -b doctest to run
|
|
|
|
class DocTestBuilder(Builder):
|
|
"""
|
|
Runs test snippets in the documentation.
|
|
"""
|
|
name = 'doctest'
|
|
|
|
def init(self):
|
|
# default options
|
|
self.opt = doctest.DONT_ACCEPT_TRUE_FOR_1 | doctest.ELLIPSIS | \
|
|
doctest.IGNORE_EXCEPTION_DETAIL
|
|
|
|
# HACK HACK HACK
|
|
# doctest compiles its snippets with type 'single'. That is nice
|
|
# for doctest examples but unusable for multi-statement code such
|
|
# as setup code -- to be able to use doctest error reporting with
|
|
# that code nevertheless, we monkey-patch the "compile" it uses.
|
|
doctest.compile = self.compile
|
|
|
|
self.type = 'single'
|
|
|
|
self.total_failures = 0
|
|
self.total_tries = 0
|
|
self.setup_failures = 0
|
|
self.setup_tries = 0
|
|
|
|
date = time.strftime('%Y-%m-%d %H:%M:%S')
|
|
|
|
self.outfile = codecs.open(path.join(self.outdir, 'output.txt'),
|
|
'w', encoding='utf-8')
|
|
self.outfile.write('''\
|
|
Results of doctest builder run on %s
|
|
==================================%s
|
|
''' % (date, '='*len(date)))
|
|
|
|
def _out(self, text):
|
|
self.info(text, nonl=True)
|
|
self.outfile.write(text)
|
|
|
|
def _warn_out(self, text):
|
|
self.info(text, nonl=True)
|
|
if self.app.quiet:
|
|
self.warn(text)
|
|
self.outfile.write(text)
|
|
|
|
def get_target_uri(self, docname, typ=None):
|
|
return ''
|
|
|
|
def get_outdated_docs(self):
|
|
return self.env.found_docs
|
|
|
|
def finish(self):
|
|
# write executive summary
|
|
def s(v):
|
|
return v != 1 and 's' or ''
|
|
self._out('''
|
|
Doctest summary
|
|
===============
|
|
%5d test%s
|
|
%5d failure%s in tests
|
|
%5d failure%s in setup code
|
|
''' % (self.total_tries, s(self.total_tries),
|
|
self.total_failures, s(self.total_failures),
|
|
self.setup_failures, s(self.setup_failures)))
|
|
self.outfile.close()
|
|
|
|
if self.total_failures or self.setup_failures:
|
|
self.app.statuscode = 1
|
|
|
|
sys.path[0:0] = self.config.doctest_path
|
|
|
|
def write(self, build_docnames, updated_docnames, method='update'):
|
|
if build_docnames is None:
|
|
build_docnames = sorted(self.env.all_docs)
|
|
|
|
self.info(bold('running tests...'))
|
|
for docname in build_docnames:
|
|
# no need to resolve the doctree
|
|
doctree = self.env.get_doctree(docname)
|
|
self.test_doc(docname, doctree)
|
|
|
|
def test_doc(self, docname, doctree):
|
|
groups = {}
|
|
add_to_all_groups = []
|
|
self.setup_runner = SphinxDocTestRunner(verbose=False,
|
|
optionflags=self.opt)
|
|
self.test_runner = SphinxDocTestRunner(verbose=False,
|
|
optionflags=self.opt)
|
|
if self.config.doctest_test_doctest_blocks:
|
|
def condition(node):
|
|
return (isinstance(node, (nodes.literal_block, nodes.comment))
|
|
and node.has_key('testnodetype')) or \
|
|
isinstance(node, nodes.doctest_block)
|
|
else:
|
|
def condition(node):
|
|
return isinstance(node, (nodes.literal_block, nodes.comment)) \
|
|
and node.has_key('testnodetype')
|
|
for node in doctree.traverse(condition):
|
|
source = node.has_key('test') and node['test'] or node.astext()
|
|
if not source:
|
|
self.warn('no code/output in %s block at %s:%s' %
|
|
(node.get('testnodetype', 'doctest'),
|
|
self.env.doc2path(docname), node.line))
|
|
code = TestCode(source, type=node.get('testnodetype', 'doctest'),
|
|
lineno=node.line, options=node.get('options'))
|
|
node_groups = node.get('groups', ['default'])
|
|
if '*' in node_groups:
|
|
add_to_all_groups.append(code)
|
|
continue
|
|
for groupname in node_groups:
|
|
if groupname not in groups:
|
|
groups[groupname] = TestGroup(groupname)
|
|
groups[groupname].add_code(code)
|
|
for code in add_to_all_groups:
|
|
for group in groups.itervalues():
|
|
group.add_code(code)
|
|
if self.config.doctest_global_setup:
|
|
code = TestCode(self.config.doctest_global_setup,
|
|
'testsetup', lineno=0)
|
|
for group in groups.itervalues():
|
|
group.add_code(code, prepend=True)
|
|
if not groups:
|
|
return
|
|
|
|
self._out('\nDocument: %s\n----------%s\n' %
|
|
(docname, '-'*len(docname)))
|
|
for group in groups.itervalues():
|
|
self.test_group(group, self.env.doc2path(docname, base=None))
|
|
# Separately count results from setup code
|
|
res_f, res_t = self.setup_runner.summarize(self._out, verbose=False)
|
|
self.setup_failures += res_f
|
|
self.setup_tries += res_t
|
|
if self.test_runner.tries:
|
|
res_f, res_t = self.test_runner.summarize(self._out, verbose=True)
|
|
self.total_failures += res_f
|
|
self.total_tries += res_t
|
|
|
|
def compile(self, code, name, type, flags, dont_inherit):
|
|
return compile(code, name, self.type, flags, dont_inherit)
|
|
|
|
def test_group(self, group, filename):
|
|
ns = {}
|
|
setup_examples = []
|
|
for setup in group.setup:
|
|
setup_examples.append(doctest.Example(setup.code, '',
|
|
lineno=setup.lineno))
|
|
if setup_examples:
|
|
# simulate a doctest with the setup code
|
|
setup_doctest = doctest.DocTest(setup_examples, {},
|
|
'%s (setup code)' % group.name,
|
|
filename, 0, None)
|
|
setup_doctest.globs = ns
|
|
old_f = self.setup_runner.failures
|
|
self.type = 'exec' # the snippet may contain multiple statements
|
|
self.setup_runner.run(setup_doctest, out=self._warn_out,
|
|
clear_globs=False)
|
|
if self.setup_runner.failures > old_f:
|
|
# don't run the group
|
|
return
|
|
for code in group.tests:
|
|
if len(code) == 1:
|
|
# ordinary doctests (code/output interleaved)
|
|
test = parser.get_doctest(code[0].code, {}, group.name,
|
|
filename, code[0].lineno)
|
|
if not test.examples:
|
|
continue
|
|
for example in test.examples:
|
|
# apply directive's comparison options
|
|
new_opt = code[0].options.copy()
|
|
new_opt.update(example.options)
|
|
example.options = new_opt
|
|
self.type = 'single' # as for ordinary doctests
|
|
else:
|
|
# testcode and output separate
|
|
output = code[1] and code[1].code or ''
|
|
options = code[1] and code[1].options or {}
|
|
# disable <BLANKLINE> processing as it is not needed
|
|
options[doctest.DONT_ACCEPT_BLANKLINE] = True
|
|
# find out if we're testing an exception
|
|
m = parser._EXCEPTION_RE.match(output)
|
|
if m:
|
|
exc_msg = m.group('msg')
|
|
else:
|
|
exc_msg = None
|
|
example = doctest.Example(code[0].code, output,
|
|
exc_msg=exc_msg,
|
|
lineno=code[0].lineno,
|
|
options=options)
|
|
test = doctest.DocTest([example], {}, group.name,
|
|
filename, code[0].lineno, None)
|
|
self.type = 'exec' # multiple statements again
|
|
# DocTest.__init__ copies the globs namespace, which we don't want
|
|
test.globs = ns
|
|
# also don't clear the globs namespace after running the doctest
|
|
self.test_runner.run(test, out=self._warn_out, clear_globs=False)
|
|
|
|
|
|
def setup(app):
|
|
app.add_directive('testsetup', TestsetupDirective)
|
|
app.add_directive('doctest', DoctestDirective)
|
|
app.add_directive('testcode', TestcodeDirective)
|
|
app.add_directive('testoutput', TestoutputDirective)
|
|
app.add_builder(DocTestBuilder)
|
|
# this config value adds to sys.path
|
|
app.add_config_value('doctest_path', [], False)
|
|
app.add_config_value('doctest_test_doctest_blocks', 'default', False)
|
|
app.add_config_value('doctest_global_setup', '', False)
|