"""Use the Doctest plugin with ``--with-doctest`` or the NOSE_WITH_DOCTEST environment variable to enable collection and execution of :mod:`doctests `. Because doctests are usually included in the tested package (instead of being grouped into packages or modules of their own), nose only looks for them in the non-test packages it discovers in the working directory. Doctests may also be placed into files other than python modules, in which case they can be collected and executed by using the ``--doctest-extension`` switch or NOSE_DOCTEST_EXTENSION environment variable to indicate which file extension(s) to load. When loading doctests from non-module files, use the ``--doctest-fixtures`` switch to specify how to find modules containing fixtures for the tests. A module name will be produced by appending the value of that switch to the base name of each doctest file loaded. For example, a doctest file "widgets.rst" with the switch ``--doctest_fixtures=_fixt`` will load fixtures from the module ``widgets_fixt.py``. A fixtures module may define any or all of the following functions: * setup([module]) or setup_module([module]) Called before the test runs. You may raise SkipTest to skip all tests. * teardown([module]) or teardown_module([module]) Called after the test runs, if setup/setup_module did not raise an unhandled exception. * setup_test(test) Called before the test. NOTE: the argument passed is a doctest.DocTest instance, *not* a unittest.TestCase. * teardown_test(test) Called after the test, if setup_test did not raise an exception. NOTE: the argument passed is a doctest.DocTest instance, *not* a unittest.TestCase. Doctests are run like any other test, with the exception that output capture does not work; doctest does its own output capture while running a test.""" import doctest import logging import os import sys import unittest from inspect import getmodule from nose.plugins.base import Plugin from nose.suite import ContextList from nose.util import anyp, getpackage, test_address, resolve_name from nose.util import src, tolist, isproperty import builtins as builtin_mod log = logging.getLogger(__name__) _orp = doctest._OutputRedirectingPdb # Doctest/coverage report monkeypatch class NoseOutputRedirectingPdb(_orp): def __init__(self, out): self.__debugger_used = False _orp.__init__(self, out) def set_trace(self): self.__debugger_used = True _orp.set_trace(self, sys._getframe().f_back) def set_continue(self): # Calling set_continue unconditionally would break unit test # coverage reporting, as Bdb.set_continue calls sys.settrace(None). if self.__debugger_used: _orp.set_continue(self) doctest._OutputRedirectingPdb = NoseOutputRedirectingPdb class DoctestSuite(unittest.TestSuite): """Doctest suites are parallelizable at the module or file level only, since they may be attached to objects that are not individually addressable (like properties). This suite subclass is used when loading doctests from a module to ensure that behavior. This class is used only if the plugin is not fully prepared; in normal use, the loader's suiteClass is used.""" can_split = False def __init__(self, tests=(), context=None, can_split=False): self.context = context self.can_split = can_split unittest.TestSuite.__init__(self, tests=tests) def address(self): return test_address(self.context) def __iter__(self): return iter(self._tests) def __str__(self): return str(self._tests) class Doctest(Plugin): """Activate doctest plugin to find and run doctests in non-test modules.""" extension = None suiteClass = DoctestSuite def options(self, parser, env): """Register commandline options.""" Plugin.options(self, parser, env) parser.add_option( '--doctest-tests', action='store_true', dest='doctest_tests', default=env.get('NOSE_DOCTEST_TESTS'), help="Also look for doctests in test modules. " "Note that classes, methods and functions should have either " "doctests or non-doctest tests, not both. [NOSE_DOCTEST_TESTS]") parser.add_option( '--doctest-extension', action="append", dest="doctestExtension", metavar="EXT", help="Also look for doctests in files with " "this extension [NOSE_DOCTEST_EXTENSION]") parser.add_option( '--doctest-result-variable', dest='doctest_result_var', default=env.get('NOSE_DOCTEST_RESULT_VAR'), metavar="VAR", help="Change the variable name set to the result of " "the last interpreter command from the default '_'. " "Can be used to avoid conflicts with the _() " "function used for text translation. [NOSE_DOCTEST_RESULT_VAR]") parser.add_option( '--doctest-fixtures', action="store", dest="doctestFixtures", metavar="SUFFIX", help="Find fixtures for a doctest file in module " "with this name appended to the base name of the doctest file") parser.add_option( '--doctest-options', action="append", dest="doctestOptions", metavar="OPTIONS", help="Specify options to pass to doctest. " "Eg. '+ELLIPSIS,+NORMALIZE_WHITESPACE'") env_setting = env.get('NOSE_DOCTEST_EXTENSION') if env_setting is not None: parser.set_defaults(doctestExtension=tolist(env_setting)) def configure(self, options, config): """Configure plugin.""" Plugin.configure(self, options, config) self.doctest_result_var = options.doctest_result_var self.doctest_tests = options.doctest_tests self.extension = tolist(options.doctestExtension) self.fixtures = options.doctestFixtures self.finder = doctest.DocTestFinder() self.optionflags = 0 if options.doctestOptions: flags = ",".join(options.doctestOptions).split(',') for flag in flags: if not flag or flag[0] not in '+-': raise ValueError( "Must specify doctest options with starting " + "'+' or '-'. Got %s" % (flag,) ) mode, option_name = flag[0], flag[1:] option_flag = doctest.OPTIONFLAGS_BY_NAME.get(option_name) if not option_flag: raise ValueError( "Unknown doctest option %s" % (option_name,) ) if mode == '+': self.optionflags |= option_flag elif mode == '-': self.optionflags &= ~option_flag def prepareTestLoader(self, loader): """Capture loader's suiteClass. This is used to create test suites from doctest files.""" self.suiteClass = loader.suiteClass def loadTestsFromModule(self, module): """Load doctests from the module.""" log.debug("loading from %s", module) if not self.matches(module.__name__): log.debug("Doctest doesn't want module %s", module) return try: tests = self.finder.find(module) except AttributeError: log.exception("Attribute error loading from %s", module) return if not tests: log.debug("No tests found in %s", module) return tests.sort() module_file = src(module.__file__) cases = [] for test in tests: if not test.examples: continue if not test.filename: test.filename = module_file cases.append(DocTestCase(test, optionflags=self.optionflags, result_var=self.doctest_result_var)) if cases: yield self.suiteClass(cases, context=module, can_split=False) def loadTestsFromFile(self, filename): """Load doctests from the file. Tests are loaded only if filename's extension matches configured doctest extension.""" if self.extension and anyp(filename.endswith, self.extension): name = os.path.basename(filename) dh = open(filename) try: doc = dh.read() finally: dh.close() fixture_context = None globs = {'__file__': filename} if self.fixtures: base, ext = os.path.splitext(name) dirname = os.path.dirname(filename) sys.path.append(dirname) fixt_mod = base + self.fixtures try: fixture_context = __import__( fixt_mod, globals(), locals(), ["nop"]) except ImportError as e: log.debug( "Could not import %s: %s (%s)", fixt_mod, e, sys.path) log.debug("Fixture module %s resolved to %s", fixt_mod, fixture_context) if hasattr(fixture_context, 'globs'): globs = fixture_context.globs(globs) parser = doctest.DocTestParser() test = parser.get_doctest( doc, globs=globs, name=name, filename=filename, lineno=0) if test.examples: case = DocFileCase( test, optionflags=self.optionflags, setUp=getattr(fixture_context, 'setup_test', None), tearDown=getattr(fixture_context, 'teardown_test', None), result_var=self.doctest_result_var) if fixture_context: yield ContextList((case,), context=fixture_context) else: yield case else: yield False # no tests to load def makeTest(self, obj, parent): """Look for doctests in the given object, which will be a function, method or class.""" name = getattr(obj, '__name__', 'Unnammed %s' % type(obj)) doctests = self.finder.find(obj, module=getmodule(parent), name=name) if doctests: for test in doctests: if len(test.examples) == 0: continue yield DocTestCase(test, obj=obj, optionflags=self.optionflags, result_var=self.doctest_result_var) def matches(self, name): if name == '__init__.py': return False return ( ( self.doctest_tests or not self.conf.testMatch.search(name) or ( self.conf.include and [ _f for _f in [ inc.search(name) for inc in self.conf.include ] if _f ] ) ) and ( not self.conf.exclude or not [ _f for _f in [ exc.search(name) for exc in self.conf.exclude ] if _f ] ) ) def wantFile(self, file): """Override to select all modules and any file ending with configured doctest extension.""" # always want .py files if file.endswith('.py'): return True # also want files that match my extension if ( self.extension and anyp(file.endswith, self.extension) and ( not self.conf.exclude or not [ _f for _f in [ exc.search(file) for exc in self.conf.exclude ] if _f ] ) ): return True return None class DocTestCase(doctest.DocTestCase): """Overrides DocTestCase to provide an address() method that returns the correct address for the doctest case. To provide hints for address(), an obj may also be passed -- this will be used as the test object for purposes of determining the test address, if it is provided.""" def __init__(self, test, optionflags=0, setUp=None, tearDown=None, checker=None, obj=None, result_var='_'): self._result_var = result_var self._nose_obj = obj super(DocTestCase, self).__init__( test, optionflags=optionflags, setUp=setUp, tearDown=tearDown, checker=checker) def address(self): if self._nose_obj is not None: return test_address(self._nose_obj) obj = resolve_name(self._dt_test.name) if isproperty(obj): # properties have no connection to the class they are in # so we can't just look 'em up, we have to first look up # the class, then stick the prop on the end parts = self._dt_test.name.split('.') class_name = '.'.join(parts[:-1]) cls = resolve_name(class_name) base_addr = test_address(cls) return (base_addr[0], base_addr[1], '.'.join([base_addr[2], parts[-1]])) else: return test_address(obj) # doctests loaded via find(obj) omit the module name # so we need to override id, __repr__ and shortDescription # bonus: this will squash a 2.3 vs 2.4 incompatibility def id(self): name = self._dt_test.name filename = self._dt_test.filename if filename is not None: pk = getpackage(filename) if pk is None: return name if not name.startswith(pk): name = "%s.%s" % (pk, name) return name def __repr__(self): name = self.id() name = name.split('.') return "%s (%s)" % (name[-1], '.'.join(name[:-1])) __str__ = __repr__ def shortDescription(self): return 'Doctest: %s' % self.id() def setUp(self): if self._result_var is not None: self._old_displayhook = sys.displayhook sys.displayhook = self._displayhook super(DocTestCase, self).setUp() def _displayhook(self, value): if value is None: return setattr(builtin_mod, self._result_var, value) print(repr(value)) def tearDown(self): super(DocTestCase, self).tearDown() if self._result_var is not None: sys.displayhook = self._old_displayhook delattr(builtin_mod, self._result_var) class DocFileCase(doctest.DocFileCase): """Overrides to provide address() method that returns the correct address for the doc file case.""" def __init__(self, test, optionflags=0, setUp=None, tearDown=None, checker=None, result_var='_'): self._result_var = result_var super(DocFileCase, self).__init__( test, optionflags=optionflags, setUp=setUp, tearDown=tearDown, checker=None) def address(self): return (self._dt_test.filename, None, None) def setUp(self): if self._result_var is not None: self._old_displayhook = sys.displayhook sys.displayhook = self._displayhook super(DocFileCase, self).setUp() def _displayhook(self, value): if value is None: return setattr(builtin_mod, self._result_var, value) print(repr(value)) def tearDown(self): super(DocFileCase, self).tearDown() if self._result_var is not None: sys.displayhook = self._old_displayhook delattr(builtin_mod, self._result_var)