# Module doctest.

# Released to the public domain 16-Jan-2001, by Tim Peters ([email protected]).

# Major enhancements and refactoring by:

# Jim Fulton

# Edward Loper

# Provided as-is; use at your own risk; no warranty; no promises; enjoy!

r"""Module doctest -- a framework for running examples in docstrings.

In simplest use, end each module M to be tested with:

def _test():

import doctest

doctest.testmod()

if __name__ == "__main__":

_test()

Then running the module as a script will cause the examples in the

docstrings to get executed and verified:

python M.py

This won't display anything unless an example fails, in which case the

failing example(s) and the cause(s) of the failure(s) are printed to stdout

(why not stderr? because stderr is a lame hack <0.2 wink>), and the final

line of output is "Test failed.".

Run it with the -v switch instead:

python M.py -v

and a detailed report of all examples tried is printed to stdout, along

with assorted summaries at the end.

You can force verbose mode by passing "verbose=True" to testmod, or prohibit

it by passing "verbose=False". In either of those cases, sys.argv is not

examined by testmod.

There are a variety of other ways to run doctests, including integration

with the unittest framework, and support for running non-Python text

files containing doctests. There are also many ways to override parts

of doctest's default behaviors. See the Library Reference Manual for

details.

"""

__docformat__ = 'reStructuredText en'

__all__ = [

# 0, Option Flags

'register_optionflag',

'DONT_ACCEPT_TRUE_FOR_1',

'DONT_ACCEPT_BLANKLINE',

'NORMALIZE_WHITESPACE',

'ELLIPSIS',

'SKIP',

'IGNORE_EXCEPTION_DETAIL',

'COMPARISON_FLAGS',

'REPORT_UDIFF',

'REPORT_CDIFF',

'REPORT_NDIFF',

'REPORT_ONLY_FIRST_FAILURE',

'REPORTING_FLAGS',

'FAIL_FAST',

# 1. Utility Functions

# 2. Example & DocTest

'Example',

'DocTest',

# 3. Doctest Parser

'DocTestParser',

# 4. Doctest Finder

'DocTestFinder',

# 5. Doctest Runner

'DocTestRunner',

'OutputChecker',

'DocTestFailure',

'UnexpectedException',

'DebugRunner',

# 6. Test Functions

'testmod',

'testfile',

'run_docstring_examples',

# 7. Unittest Support

'DocTestSuite',

'DocFileSuite',

'set_unittest_reportflags',

# 8. Debugging Support

'script_from_examples',

'testsource',

'debug_src',

'debug',

]

import __future__

import difflib

import inspect

import linecache

import os

import pdb

import re

import sys

import traceback

import unittest

from io import StringIO, IncrementalNewlineDecoder

from collections import namedtuple

TestResults = namedtuple('TestResults', 'failed attempted')

# There are 4 basic classes:

# - Example: a <source, want> pair, plus an intra-docstring line number.

# - DocTest: a collection of examples, parsed from a docstring, plus

# info about where the docstring came from (name, filename, lineno).

# - DocTestFinder: extracts DocTests from a given object's docstring and

# its contained objects' docstrings.

# - DocTestRunner: runs DocTest cases, and accumulates statistics.

#

# So the basic picture is:

#

# list of:

# +------+ +---------+ +-------+

# |object| --DocTestFinder-> | DocTest | --DocTestRunner-> |results|

# +------+ +---------+ +-------+

# | Example |

# | ... |

# | Example |

# +---------+

# Option constants.

OPTIONFLAGS_BY_NAME = {}

def register_optionflag(name):

# Create a new flag unless `name` is already known.

return OPTIONFLAGS_BY_NAME.setdefault(name, 1 << len(OPTIONFLAGS_BY_NAME))

DONT_ACCEPT_TRUE_FOR_1 = register_optionflag('DONT_ACCEPT_TRUE_FOR_1')

DONT_ACCEPT_BLANKLINE = register_optionflag('DONT_ACCEPT_BLANKLINE')

NORMALIZE_WHITESPACE = register_optionflag('NORMALIZE_WHITESPACE')

ELLIPSIS = register_optionflag('ELLIPSIS')

SKIP = register_optionflag('SKIP')

IGNORE_EXCEPTION_DETAIL = register_optionflag('IGNORE_EXCEPTION_DETAIL')

COMPARISON_FLAGS = (DONT_ACCEPT_TRUE_FOR_1 |

DONT_ACCEPT_BLANKLINE |

NORMALIZE_WHITESPACE |

ELLIPSIS |

SKIP |

IGNORE_EXCEPTION_DETAIL)

REPORT_UDIFF = register_optionflag('REPORT_UDIFF')

REPORT_CDIFF = register_optionflag('REPORT_CDIFF')

REPORT_NDIFF = register_optionflag('REPORT_NDIFF')

REPORT_ONLY_FIRST_FAILURE = register_optionflag('REPORT_ONLY_FIRST_FAILURE')

FAIL_FAST = register_optionflag('FAIL_FAST')

REPORTING_FLAGS = (REPORT_UDIFF |

REPORT_CDIFF |

REPORT_NDIFF |

REPORT_ONLY_FIRST_FAILURE |

FAIL_FAST)

# Special string markers for use in `want` strings:

BLANKLINE_MARKER = '<BLANKLINE>'

ELLIPSIS_MARKER = '...'

######################################################################

## Table of Contents

######################################################################

# 1. Utility Functions

# 2. Example & DocTest -- store test cases

# 3. DocTest Parser -- extracts examples from strings

# 4. DocTest Finder -- extracts test cases from objects

# 5. DocTest Runner -- runs test cases

# 6. Test Functions -- convenient wrappers for testing

# 7. Unittest Support

# 8. Debugging Support

# 9. Example Usage

######################################################################

## 1. Utility Functions

######################################################################

def _extract_future_flags(globs):

"""

Return the compiler-flags associated with the future features that

have been imported into the given namespace (globs).

"""

flags = 0

for fname in __future__.all_feature_names:

feature = globs.get(fname, None)

if feature is getattr(__future__, fname):

flags |= feature.compiler_flag

return flags

def _normalize_module(module, depth=2):

"""

Return the module specified by `module`. In particular:

- If `module` is a module, then return module.

- If `module` is a string, then import and return the

module with that name.

- If `module` is None, then return the calling module.

The calling module is assumed to be the module of

the stack frame at the given depth in the call stack.

"""

if inspect.ismodule(module):

return module

elif isinstance(module, str):

return __import__(module, globals(), locals(), ["*"])

elif module is None:

return sys.modules[sys._getframe(depth).f_globals['__name__']]

else:

raise TypeError("Expected a module, string, or None")

def _newline_convert(data):

# The IO module provides a handy decoder for universal newline conversion

return IncrementalNewlineDecoder(None, True).decode(data, True)

def _load_testfile(filename, package, module_relative, encoding):

if module_relative:

package = _normalize_module(package, 3)

filename = _module_relative_path(package, filename)

if (loader := getattr(package, '__loader__', None)) is None:

try:

loader = package.__spec__.loader

except AttributeError:

pass

if hasattr(loader, 'get_data'):

file_contents = loader.get_data(filename)

file_contents = file_contents.decode(encoding)

# get_data() opens files as 'rb', so one must do the equivalent

# conversion as universal newlines would do.

return _newline_convert(file_contents), filename

with open(filename, encoding=encoding) as f:

return f.read(), filename

def _indent(s, indent=4):

"""

Add the given number of space characters to the beginning of

every non-blank line in `s`, and return the result.

"""

# This regexp matches the start of non-blank lines:

return re.sub('(?m)^(?!$)', indent*' ', s)

def _exception_traceback(exc_info):

"""

Return a string containing a traceback message for the given

exc_info tuple (as returned by sys.exc_info()).

"""

# Get a traceback message.

excout = StringIO()

exc_type, exc_val, exc_tb = exc_info

traceback.print_exception(exc_type, exc_val, exc_tb, file=excout)

return excout.getvalue()

# Override some StringIO methods.

class _SpoofOut(StringIO):

def getvalue(self):

result = StringIO.getvalue(self)

# If anything at all was written, make sure there's a trailing

# newline. There's no way for the expected output to indicate

# that a trailing newline is missing.

if result and not result.endswith("\n"):

result += "\n"

return result

def truncate(self, size=None):

self.seek(size)

StringIO.truncate(self)

# Worst-case linear-time ellipsis matching.

def _ellipsis_match(want, got):

"""

Essentially the only subtle case:

>>> _ellipsis_match('aa...aa', 'aaa')

False

"""

if ELLIPSIS_MARKER not in want:

return want == got

# Find "the real" strings.

ws = want.split(ELLIPSIS_MARKER)

assert len(ws) >= 2

# Deal with exact matches possibly needed at one or both ends.

startpos, endpos = 0, len(got)

w = ws[0]

if w: # starts with exact match

if got.startswith(w):

startpos = len(w)

del ws[0]

else:

return False

w = ws[-1]

if w: # ends with exact match

if got.endswith(w):

endpos -= len(w)

del ws[-1]

else:

return False

if startpos > endpos:

# Exact end matches required more characters than we have, as in

# _ellipsis_match('aa...aa', 'aaa')

return False

# For the rest, we only need to find the leftmost non-overlapping

# match for each piece. If there's no overall match that way alone,

# there's no overall match period.

for w in ws:

# w may be '' at times, if there are consecutive ellipses, or

# due to an ellipsis at the start or end of `want`. That's OK.

# Search for an empty string succeeds, and doesn't change startpos.

startpos = got.find(w, startpos, endpos)

if startpos < 0:

return False

startpos += len(w)

return True

def _comment_line(line):

"Return a commented form of the given line"

line = line.rstrip()

if line:

return '# '+line

else:

return '#'

def _strip_exception_details(msg):

# Support for IGNORE_EXCEPTION_DETAIL.

# Get rid of everything except the exception name; in particular, drop

# the possibly dotted module path (if any) and the exception message (if

# any). We assume that a colon is never part of a dotted name, or of an

# exception name.

# E.g., given

# "foo.bar.MyError: la di da"

# return "MyError"

# Or for "abc.def" or "abc.def:\n" return "def".

start, end = 0, len(msg)

# The exception name must appear on the first line.

i = msg.find("\n")

if i >= 0:

end = i

# retain up to the first colon (if any)

i = msg.find(':', 0, end)

if i >= 0:

end = i

# retain just the exception name

i = msg.rfind('.', 0, end)

if i >= 0:

start = i+1

return msg[start: end]

class _OutputRedirectingPdb(pdb.Pdb):

"""

A specialized version of the python debugger that redirects stdout

to a given stream when interacting with the user. Stdout is *not*

redirected when traced code is executed.

"""

def __init__(self, out):

self.__out = out

self.__debugger_used = False

# do not play signal games in the pdb

pdb.Pdb.__init__(self, stdout=out, nosigint=True)

# still use input() to get user input

self.use_rawinput = 1

def set_trace(self, frame=None):

self.__debugger_used = True

if frame is None:

frame = sys._getframe().f_back

pdb.Pdb.set_trace(self, frame)

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:

pdb.Pdb.set_continue(self)

def trace_dispatch(self, *args):

# Redirect stdout to the given stream.

save_stdout = sys.stdout

sys.stdout = self.__out

# Call Pdb's trace dispatch method.

try:

return pdb.Pdb.trace_dispatch(self, *args)

finally:

sys.stdout = save_stdout

# [XX] Normalize with respect to os.path.pardir?

def _module_relative_path(module, test_path):

if not inspect.ismodule(module):

raise TypeError('Expected a module: %r' % module)

if test_path.startswith('/'):

raise ValueError('Module-relative files may not have absolute paths')

# Normalize the path. On Windows, replace "/" with "\".

test_path = os.path.join(*(test_path.split('/')))

# Find the base directory for the path.

if hasattr(module, '__file__'):

# A normal module/package

basedir = os.path.split(module.__file__)[0]

elif module.__name__ == '__main__':

# An interactive session.

if len(sys.argv)>0 and sys.argv[0] != '':

basedir = os.path.split(sys.argv[0])[0]

else:

basedir = os.curdir

else:

if hasattr(module, '__path__'):

for directory in module.__path__:

fullpath = os.path.join(directory, test_path)

if os.path.exists(fullpath):

return fullpath

# A module w/o __file__ (this includes builtins)

raise ValueError("Can't resolve paths relative to the module "

"%r (it has no __file__)"

% module.__name__)

# Combine the base directory and the test path.

return os.path.join(basedir, test_path)

######################################################################

## 2. Example & DocTest

######################################################################

## - An "example" is a <source, want> pair, where "source" is a

## fragment of source code, and "want" is the expected output for

## "source." The Example class also includes information about

## where the example was extracted from.

##

## - A "doctest" is a collection of examples, typically extracted from

## a string (such as an object's docstring). The DocTest class also

## includes information about where the string was extracted from.

class Example:

"""

A single doctest example, consisting of source code and expected

output. `Example` defines the following attributes:

- source: A single Python statement, always ending with a newline.

The constructor adds a newline if needed.

- want: The expected output from running the source code (either

from stdout, or a traceback in case of exception). `want` ends

with a newline unless it's empty, in which case it's an empty

string. The constructor adds a newline if needed.

- exc_msg: The exception message generated by the example, if

the example is expected to generate an exception; or `None` if

it is not expected to generate an exception. This exception

message is compared against the return value of

`traceback.format_exception_only()`. `exc_msg` ends with a

newline unless it's `None`. The constructor adds a newline

if needed.

- lineno: The line number within the DocTest string containing

this Example where the Example begins. This line number is

zero-based, with respect to the beginning of the DocTest.

- indent: The example's indentation in the DocTest string.

I.e., the number of space characters that precede the

example's first prompt.

- options: A dictionary mapping from option flags to True or

False, which is used to override default options for this

example. Any option flags not contained in this dictionary

are left at their default value (as specified by the

DocTestRunner's optionflags). By default, no options are set.

"""

def __init__(self, source, want, exc_msg=None, lineno=0, indent=0,

options=None):

# Normalize inputs.

if not source.endswith('\n'):

source += '\n'

if want and not want.endswith('\n'):

want += '\n'

if exc_msg is not None and not exc_msg.endswith('\n'):

exc_msg += '\n'

# Store properties.

self.source = source

self.want = want

self.lineno = lineno

self.indent = indent

if options is None: options = {}

self.options = options

self.exc_msg = exc_msg

def __eq__(self, other):

if type(self) is not type(other):

return NotImplemented

return self.source == other.source and \

self.want == other.want and \

self.lineno == other.lineno and \

self.indent == other.indent and \

self.options == other.options and \

self.exc_msg == other.exc_msg

def __hash__(self):

return hash((self.source, self.want, self.lineno, self.indent,

self.exc_msg))

class DocTest:

"""

A collection of doctest examples that should be run in a single

namespace. Each `DocTest` defines the following attributes:

- examples: the list of examples.

- globs: The namespace (aka globals) that the examples should

be run in.

- name: A name identifying the DocTest (typically, the name of

the object whose docstring this DocTest was extracted from).

- filename: The name of the file that this DocTest was extracted

from, or `None` if the filename is unknown.

- lineno: The line number within filename where this DocTest

begins, or `None` if the line number is unavailable. This

line number is zero-based, with respect to the beginning of

the file.

- docstring: The string that the examples were extracted from,

or `None` if the string is unavailable.

"""

def __init__(self, examples, globs, name, filename, lineno, docstring):

"""

Create a new DocTest containing the given examples. The

DocTest's globals are initialized with a copy of `globs`.

"""

assert not isinstance(examples, str), \

"DocTest no longer accepts str; use DocTestParser instead"

self.examples = examples

self.docstring = docstring

self.globs = globs.copy()

self.name = name

self.filename = filename

self.lineno = lineno

def __repr__(self):

if len(self.examples) == 0:

examples = 'no examples'

elif len(self.examples) == 1:

examples = '1 example'

else:

examples = '%d examples' % len(self.examples)

return ('<%s %s from %s:%s (%s)>' %

(self.__class__.__name__,

self.name, self.filename, self.lineno, examples))

def __eq__(self, other):

if type(self) is not type(other):

return NotImplemented

return self.examples == other.examples and \

self.docstring == other.docstring and \

self.globs == other.globs and \

self.name == other.name and \

self.filename == other.filename and \

self.lineno == other.lineno

def __hash__(self):

return hash((self.docstring, self.name, self.filename, self.lineno))

# This lets us sort tests by name:

def __lt__(self, other):

if not isinstance(other, DocTest):

return NotImplemented

return ((self.name, self.filename, self.lineno, id(self))

<

(other.name, other.filename, other.lineno, id(other)))

######################################################################

## 3. DocTestParser

######################################################################

class DocTestParser:

"""

A class used to parse strings containing doctest examples.

"""

# This regular expression is used to find doctest examples in a

# string. It defines three groups: `source` is the source code

# (including leading indentation and prompts); `indent` is the

# indentation of the first (PS1) line of the source code; and

# `want` is the expected output (including leading indentation).

_EXAMPLE_RE = re.compile(r'''

# Source consists of a PS1 line followed by zero or more PS2 lines.

(?P<source>

(?:^(?P<indent> [ ]*) >>> .*) # PS1 line

(?:\n [ ]* \.\.\. .*)*) # PS2 lines

\n?

# Want consists of any non-blank lines that do not start with PS1.

(?P<want> (?:(?![ ]*$) # Not a blank line

(?![ ]*>>>) # Not a line starting with PS1

.+$\n? # But any other line

)*)

''', re.MULTILINE | re.VERBOSE)

# A regular expression for handling `want` strings that contain

# expected exceptions. It divides `want` into three pieces:

# - the traceback header line (`hdr`)

# - the traceback stack (`stack`)

# - the exception message (`msg`), as generated by

# traceback.format_exception_only()

# `msg` may have multiple lines. We assume/require that the

# exception message is the first non-indented line starting with a word

# character following the traceback header line.

_EXCEPTION_RE = re.compile(r"""

# Grab the traceback header. Different versions of Python have

# said different things on the first traceback line.

^(?P<hdr> Traceback\ \(

(?: most\ recent\ call\ last

| innermost\ last

) \) :

)

\s* $ # toss trailing whitespace on the header.

(?P<stack> .*?) # don't blink: absorb stuff until...

^ (?P<msg> \w+ .*) # a line *starts* with alphanum.

""", re.VERBOSE | re.MULTILINE | re.DOTALL)

# A callable returning a true value iff its argument is a blank line

# or contains a single comment.

_IS_BLANK_OR_COMMENT = re.compile(r'^[ ]*(#.*)?$').match

def parse(self, string, name='<string>'):

"""

Divide the given string into examples and intervening text,

and return them as a list of alternating Examples and strings.

Line numbers for the Examples are 0-based. The optional

argument `name` is a name identifying this string, and is only

used for error messages.

"""

string = string.expandtabs()

# If all lines begin with the same indentation, then strip it.

min_indent = self._min_indent(string)

if min_indent > 0:

string = '\n'.join([l[min_indent:] for l in string.split('\n')])

output = []

charno, lineno = 0, 0

# Find all doctest examples in the string:

for m in self._EXAMPLE_RE.finditer(string):

# Add the pre-example text to `output`.

output.append(string[charno:m.start()])

# Update lineno (lines before this example)

lineno += string.count('\n', charno, m.start())

# Extract info from the regexp match.

(source, options, want, exc_msg) = \

self._parse_example(m, name, lineno)

# Create an Example, and add it to the list.

if not self._IS_BLANK_OR_COMMENT(source):

output.append( Example(source, want, exc_msg,

lineno=lineno,

indent=min_indent+len(m.group('indent')),

options=options) )

# Update lineno (lines inside this example)

lineno += string.count('\n', m.start(), m.end())

# Update charno.

charno = m.end()

# Add any remaining post-example text to `output`.

output.append(string[charno:])

return output

def get_doctest(self, string, globs, name, filename, lineno):

"""

Extract all doctest examples from the given string, and

collect them into a `DocTest` object.

`globs`, `name`, `filename`, and `lineno` are attributes for

the new `DocTest` object. See the documentation for `DocTest`

for more information.

"""

return DocTest(self.get_examples(string, name), globs,

name, filename, lineno, string)

def get_examples(self, string, name='<string>'):

"""

Extract all doctest examples from the given string, and return

them as a list of `Example` objects. Line numbers are

0-based, because it's most common in doctests that nothing

interesting appears on the same line as opening triple-quote,

and so the first interesting line is called \"line 1\" then.

The optional argument `name` is a name identifying this

string, and is only used for error messages.

"""

return [x for x in self.parse(string, name)

if isinstance(x, Example)]

def _parse_example(self, m, name, lineno):

"""

Given a regular expression match from `_EXAMPLE_RE` (`m`),

return a pair `(source, want)`, where `source` is the matched

example's source code (with prompts and indentation stripped);

and `want` is the example's expected output (with indentation

stripped).

`name` is the string's name, and `lineno` is the line number

where the example starts; both are used for error messages.

"""

# Get the example's indentation level.

indent = len(m.group('indent'))

# Divide source into lines; check that they're properly

# indented; and then strip their indentation & prompts.

source_lines = m.group('source').split('\n')

self._check_prompt_blank(source_lines, indent, name, lineno)

self._check_prefix(source_lines[1:], ' '*indent + '.', name, lineno)

source = '\n'.join([sl[indent+4:] for sl in source_lines])

# Divide want into lines; check that it's properly indented; and

# then strip the indentation. Spaces before the last newline should

# be preserved, so plain rstrip() isn't good enough.

want = m.group('want')

want_lines = want.split('\n')

if len(want_lines) > 1 and re.match(r' *$', want_lines[-1]):

del want_lines[-1] # forget final newline & spaces after it

self._check_prefix(want_lines, ' '*indent, name,

lineno + len(source_lines))

want = '\n'.join([wl[indent:] for wl in want_lines])

# If `want` contains a traceback message, then extract it.

m = self._EXCEPTION_RE.match(want)

if m:

exc_msg = m.group('msg')

else:

exc_msg = None

# Extract options from the source.

options = self._find_options(source, name, lineno)

return source, options, want, exc_msg

# This regular expression looks for option directives in the

# source code of an example. Option directives are comments

# starting with "doctest:". Warning: this may give false

# positives for string-literals that contain the string

# "#doctest:". Eliminating these false positives would require

# actually parsing the string; but we limit them by ignoring any

# line containing "#doctest:" that is *followed* by a quote mark.

_OPTION_DIRECTIVE_RE = re.compile(r'#\s*doctest:\s*([^\n\'"]*)$',

re.MULTILINE)

def _find_options(self, source, name, lineno):

"""

Return a dictionary containing option overrides extracted from

option directives in the given source string.

`name` is the string's name, and `lineno` is the line number

where the example starts; both are used for error messages.

"""

options = {}

# (note: with the current regexp, this will match at most once:)

for m in self._OPTION_DIRECTIVE_RE.finditer(source):

option_strings = m.group(1).replace(',', ' ').split()

for option in option_strings:

if (option[0] not in '+-' or

option[1:] not in OPTIONFLAGS_BY_NAME):

raise ValueError('line %r of the doctest for %s '

'has an invalid option: %r' %

(lineno+1, name, option))

flag = OPTIONFLAGS_BY_NAME[option[1:]]

options[flag] = (option[0] == '+')

if options and self._IS_BLANK_OR_COMMENT(source):

raise ValueError('line %r of the doctest for %s has an option '

'directive on a line with no example: %r' %

(lineno, name, source))

return options

# This regular expression finds the indentation of every non-blank

# line in a string.

_INDENT_RE = re.compile(r'^([ ]*)(?=\S)', re.MULTILINE)

def _min_indent(self, s):

"Return the minimum indentation of any non-blank line in `s`"

indents = [len(indent) for indent in self._INDENT_RE.findall(s)]

if len(indents) > 0:

return min(indents)

else:

return 0

def _check_prompt_blank(self, lines, indent, name, lineno):

"""

Given the lines of a source string (including prompts and

leading indentation), check to make sure that every prompt is

followed by a space character. If any line is not followed by

a space character, then raise ValueError.

"""

for i, line in enumerate(lines):

if len(line) >= indent+4 and line[indent+3] != ' ':

raise ValueError('line %r of the docstring for %s '

'lacks blank after %s: %r' %

(lineno+i+1, name,

line[indent:indent+3], line))

def _check_prefix(self, lines, prefix, name, lineno):

"""

Check that every line in the given list starts with the given

prefix; if any line does not, then raise a ValueError.

"""

for i, line in enumerate(lines):

if line and not line.startswith(prefix):

raise ValueError('line %r of the docstring for %s has '

'inconsistent leading whitespace: %r' %

(lineno+i+1, name, line))

######################################################################

## 4. DocTest Finder

######################################################################

class DocTestFinder:

"""

A class used to extract the DocTests that are relevant to a given

object, from its docstring and the docstrings of its contained

objects. Doctests can currently be extracted from the following

object types: modules, functions, classes, methods, staticmethods,

classmethods, and properties.

"""

def __init__(self, verbose=False, parser=DocTestParser(),

recurse=True, exclude_empty=True):

"""

Create a new doctest finder.

The optional argument `parser` specifies a class or

function that should be used to create new DocTest objects (or

objects that implement the same interface as DocTest). The

signature for this factory function should match the signature

of the DocTest constructor.

If the optional argument `recurse` is false, then `find` will

only examine the given object, and not any contained objects.

If the optional argument `exclude_empty` is false, then `find`

will include tests for objects with empty docstrings.

"""

self._parser = parser

self._verbose = verbose

self._recurse = recurse

self._exclude_empty = exclude_empty

def find(self, obj, name=None, module=None, globs=None, extraglobs=None):

"""

Return a list of the DocTests that are defined by the given

object's docstring, or by any of its contained objects'

docstrings.

The optional parameter `module` is the module that contains

the given object. If the module is not specified or is None, then

the test finder will attempt to automatically determine the

correct module. The object's module is used:

- As a default namespace, if `globs` is not specified.

- To prevent the DocTestFinder from extracting DocTests

from objects that are imported from other modules.

- To find the name of the file containing the object.

- To help find the line number of the object within its

file.

Contained objects whose module does not match `module` are ignored.

If `module` is False, no attempt to find the module will be made.

This is obscure, of use mostly in tests: if `module` is False, or

is None but cannot be found automatically, then all objects are

considered to belong to the (non-existent) module, so all contained

objects will (recursively) be searched for doctests.

The globals for each DocTest is formed by combining `globs`

and `extraglobs` (bindings in `extraglobs` override bindings

in `globs`). A new copy of the globals dictionary is created

for each DocTest. If `globs` is not specified, then it

defaults to the module's `__dict__`, if specified, or {}

otherwise. If `extraglobs` is not specified, then it defaults

to {}.

"""

# If name was not specified, then extract it from the object.

if name is None:

name = getattr(obj, '__name__', None)

if name is None:

raise ValueError("DocTestFinder.find: name must be given "

"when obj.__name__ doesn't exist: %r" %

(type(obj),))

# Find the module that contains the given object (if obj is

# a module, then module=obj.). Note: this may fail, in which

# case module will be None.

if module is False:

module = None

elif module is None:

module = inspect.getmodule(obj)

# Read the module's source code. This is used by

# DocTestFinder._find_lineno to find the line number for a

# given object's docstring.

try:

file = inspect.getsourcefile(obj)

except TypeError:

source_lines = None

else:

if not file:

# Check to see if it's one of our special internal "files"

# (see __patched_linecache_getlines).

file = inspect.getfile(obj)

if not file[0]+file[-2:] == '<]>': file = None

if file is None:

source_lines = None

else:

if module is not None:

# Supply the module globals in case the module was

# originally loaded via a PEP 302 loader and

# file is not a valid filesystem path

source_lines = linecache.getlines(file, module.__dict__)

else:

# No access to a loader, so assume it's a normal

# filesystem path

source_lines = linecache.getlines(file)

if not source_lines:

source_lines = None

# Initialize globals, and merge in extraglobs.

if globs is None:

if module is None:

globs = {}

else:

globs = module.__dict__.copy()

else:

globs = globs.copy()

if extraglobs is not None:

globs.update(extraglobs)

if '__name__' not in globs:

globs['__name__'] = '__main__' # provide a default module name

# Recursively explore `obj`, extracting DocTests.

tests = []

self._find(tests, obj, name, module, source_lines, globs, {})

# Sort the tests by alpha order of names, for consistency in

# verbose-mode output. This was a feature of doctest in Pythons

# <= 2.3 that got lost by accident in 2.4. It was repaired in

# 2.4.4 and 2.5.

tests.sort()

return tests

def _from_module(self, module, object):

"""

Return true if the given object is defined in the given

module.

"""

if module is None:

return True

elif inspect.getmodule(object) is not None:

return module is inspect.getmodule(object)

elif inspect.isfunction(object):

return module.__dict__ is object.__globals__

elif inspect.ismethoddescriptor(object):

if hasattr(object, '__objclass__'):

obj_mod = object.__objclass__.__module__

elif hasattr(object, '__module__'):

obj_mod = object.__module__

else:

return True # [XX] no easy way to tell otherwise

return module.__name__ == obj_mod

elif inspect.isclass(object):

return module.__name__ == object.__module__

elif hasattr(object, '__module__'):

return module.__name__ == object.__module__

elif isinstance(object, property):

return True # [XX] no way not be sure.

else:

raise ValueError("object must be a class or function")

def _is_routine(self, obj):

"""

Safely unwrap objects and determine if they are functions.

"""

maybe_routine = obj

try:

maybe_routine = inspect.unwrap(maybe_routine)

except ValueError:

pass

return inspect.isroutine(maybe_routine)

def _find(self, tests, obj, name, module, source_lines, globs, seen):

"""

Find tests for the given object and any contained objects, and

add them to `tests`.

"""

if self._verbose:

print('Finding tests in %s' % name)

# If we've already processed this object, then ignore it.

if id(obj) in seen:

return

seen[id(obj)] = 1

# Find a test for this object, and add it to the list of tests.