Navigation

Source code for doctest

# Module doctest.# Released to the public domain 16-Jan-2001, by Tim Peters (tim@python.org).# 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 thedocstrings to get executed and verified:python M.pyThis won't display anything unless an example fails, in which case thefailing 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 finalline of output is "Test failed.".Run it with the -v switch instead:python M.py -vand a detailed report of all examples tried is printed to stdout, alongwith assorted summaries at the end.You can force verbose mode by passing "verbose=True" to testmod, or prohibitit by passing "verbose=False". In either of those cases, sys.argv is notexamined by testmod.There are a variety of other ways to run doctests, including integrationwith the unittest framework, and support for running non-Python textfiles containing doctests. There are also many ways to override partsof doctest's default behaviors. See the Library Reference Manual fordetails."""__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__importargparseimportdifflibimportinspectimportlinecacheimportosimportpdbimportreimportsysimporttracebackimportunittestfromioimportStringIOfromcollectionsimportnamedtupleTestResults=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={}

[docs]defregister_optionflag(name):# Create a new flag unless `name` is already known.returnOPTIONFLAGS_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=0forfnamein__future__.all_feature_names:feature=globs.get(fname,None)iffeatureisgetattr(__future__,fname):flags|=feature.compiler_flagreturnflagsdef_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. """ifinspect.ismodule(module):returnmoduleelifisinstance(module,str):return__import__(module,globals(),locals(),["*"])elifmoduleisNone:returnsys.modules[sys._getframe(depth).f_globals['__name__']]else:raiseTypeError("Expected a module, string, or None")def_load_testfile(filename,package,module_relative,encoding):ifmodule_relative:package=_normalize_module(package,3)filename=_module_relative_path(package,filename)ifgetattr(package,'__loader__',None)isnotNone:ifhasattr(package.__loader__,'get_data'):file_contents=package.__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.returnfile_contents.replace(os.linesep,'\n'),filenamewithopen(filename,encoding=encoding)asf:returnf.read(),filenamedef_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:returnre.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_infotraceback.print_exception(exc_type,exc_val,exc_tb,file=excout)returnexcout.getvalue()# Override some StringIO methods.class_SpoofOut(StringIO):defgetvalue(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.ifresultandnotresult.endswith("\n"):result+="\n"returnresultdeftruncate(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 """ifELLIPSIS_MARKERnotinwant:returnwant==got# Find "the real" strings.ws=want.split(ELLIPSIS_MARKER)assertlen(ws)>=2# Deal with exact matches possibly needed at one or both ends.startpos,endpos=0,len(got)w=ws[0]ifw:# starts with exact matchifgot.startswith(w):startpos=len(w)delws[0]else:returnFalsew=ws[-1]ifw:# ends with exact matchifgot.endswith(w):endpos-=len(w)delws[-1]else:returnFalseifstartpos>endpos:# Exact end matches required more characters than we have, as in# _ellipsis_match('aa...aa', 'aaa')returnFalse# 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.forwinws:# 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)ifstartpos<0:returnFalsestartpos+=len(w)returnTruedef_comment_line(line):"Return a commented form of the given line"line=line.rstrip()ifline:return'# '+lineelse: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")ifi>=0:end=i# retain up to the first colon (if any)i=msg.find(':',0,end)ifi>=0:end=i# retain just the exception namei=msg.rfind('.',0,end)ifi>=0:start=i+1returnmsg[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=outself.__debugger_used=False# do not play signal games in the pdbpdb.Pdb.__init__(self,stdout=out,nosigint=True)# still use input() to get user inputself.use_rawinput=1defset_trace(self,frame=None):self.__debugger_used=TrueifframeisNone:frame=sys._getframe().f_backpdb.Pdb.set_trace(self,frame)defset_continue(self):# Calling set_continue unconditionally would break unit test# coverage reporting, as Bdb.set_continue calls sys.settrace(None).ifself.__debugger_used:pdb.Pdb.set_continue(self)deftrace_dispatch(self,*args):# Redirect stdout to the given stream.save_stdout=sys.stdoutsys.stdout=self.__out# Call Pdb's trace dispatch method.try:returnpdb.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):ifnotinspect.ismodule(module):raiseTypeError('Expected a module: %r'%module)iftest_path.startswith('/'):raiseValueError('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.ifhasattr(module,'__file__'):# A normal module/packagebasedir=os.path.split(module.__file__)[0]elifmodule.__name__=='__main__':# An interactive session.iflen(sys.argv)>0andsys.argv[0]!='':basedir=os.path.split(sys.argv[0])[0]else:basedir=os.curdirelse:ifhasattr(module,'__path__'):fordirectoryinmodule.__path__:fullpath=os.path.join(directory,test_path)ifos.path.exists(fullpath):returnfullpath# A module w/o __file__ (this includes builtins)raiseValueError("Can't resolve paths relative to the module ""%r (it has no __file__)"%module.__name__)# Combine the base directory and the test path.returnos.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.

[docs]classExample:""" 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.ifnotsource.endswith('\n'):source+='\n'ifwantandnotwant.endswith('\n'):want+='\n'ifexc_msgisnotNoneandnotexc_msg.endswith('\n'):exc_msg+='\n'# Store properties.self.source=sourceself.want=wantself.lineno=linenoself.indent=indentifoptionsisNone:options={}self.options=optionsself.exc_msg=exc_msgdef__eq__(self,other):iftype(self)isnottype(other):returnNotImplementedreturnself.source==other.sourceand \
self.want==other.wantand \
self.lineno==other.linenoand \
self.indent==other.indentand \
self.options==other.optionsand \
self.exc_msg==other.exc_msgdef__hash__(self):returnhash((self.source,self.want,self.lineno,self.indent,self.exc_msg))

[docs]classDocTest:""" 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`. """assertnotisinstance(examples,str), \
"DocTest no longer accepts str; use DocTestParser instead"self.examples=examplesself.docstring=docstringself.globs=globs.copy()self.name=nameself.filename=filenameself.lineno=linenodef__repr__(self):iflen(self.examples)==0:examples='no examples'eliflen(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):iftype(self)isnottype(other):returnNotImplementedreturnself.examples==other.examplesand \
self.docstring==other.docstringand \
self.globs==other.globsand \
self.name==other.nameand \
self.filename==other.filenameand \
self.lineno==other.linenodef__hash__(self):returnhash((self.docstring,self.name,self.filename,self.lineno))# This lets us sort tests by name:def__lt__(self,other):ifnotisinstance(other,DocTest):returnNotImplementedreturn((self.name,self.filename,self.lineno,id(self))<(other.name,other.filename,other.lineno,id(other)))

[docs]classDocTestParser:""" 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

[docs]defparse(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)ifmin_indent>0:string='\n'.join([l[min_indent:]forlinstring.split('\n')])output=[]charno,lineno=0,0# Find all doctest examples in the string:forminself._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.ifnotself._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:])returnoutput

[docs]defget_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. """returnDocTest(self.get_examples(string,name),globs,name,filename,lineno,string)

[docs]defget_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[xforxinself.parse(string,name)ifisinstance(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:]forslinsource_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')iflen(want_lines)>1andre.match(r' *$',want_lines[-1]):delwant_lines[-1]# forget final newline & spaces after itself._check_prefix(want_lines,' '*indent,name,lineno+len(source_lines))want='\n'.join([wl[indent:]forwlinwant_lines])# If `want` contains a traceback message, then extract it.m=self._EXCEPTION_RE.match(want)ifm:exc_msg=m.group('msg')else:exc_msg=None# Extract options from the source.options=self._find_options(source,name,lineno)returnsource,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:)forminself._OPTION_DIRECTIVE_RE.finditer(source):option_strings=m.group(1).replace(',',' ').split()foroptioninoption_strings:if(option[0]notin'+-'oroption[1:]notinOPTIONFLAGS_BY_NAME):raiseValueError('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]=='+')ifoptionsandself._IS_BLANK_OR_COMMENT(source):raiseValueError('line %r of the doctest for %s has an option ''directive on a line with no example: %r'%(lineno,name,source))returnoptions# 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)forindentinself._INDENT_RE.findall(s)]iflen(indents)>0:returnmin(indents)else:return0def_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. """fori,lineinenumerate(lines):iflen(line)>=indent+4andline[indent+3]!=' ':raiseValueError('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. """fori,lineinenumerate(lines):iflineandnotline.startswith(prefix):raiseValueError('line %r of the docstring for %s has ''inconsistent leading whitespace: %r'%(lineno+i+1,name,line))

[docs]classDocTestFinder:""" 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=parserself._verbose=verboseself._recurse=recurseself._exclude_empty=exclude_empty

[docs]deffind(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.ifnameisNone:name=getattr(obj,'__name__',None)ifnameisNone:raiseValueError("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.ifmoduleisFalse:module=NoneelifmoduleisNone: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)exceptTypeError:source_lines=Noneelse:ifnotfile:# Check to see if it's one of our special internal "files"# (see __patched_linecache_getlines).file=inspect.getfile(obj)ifnotfile[0]+file[-2:]=='<]>':file=NoneiffileisNone:source_lines=Noneelse:ifmoduleisnotNone:# Supply the module globals in case the module was# originally loaded via a PEP 302 loader and# file is not a valid filesystem pathsource_lines=linecache.getlines(file,module.__dict__)else:# No access to a loader, so assume it's a normal# filesystem pathsource_lines=linecache.getlines(file)ifnotsource_lines:source_lines=None# Initialize globals, and merge in extraglobs.ifglobsisNone:ifmoduleisNone:globs={}else:globs=module.__dict__.copy()else:globs=globs.copy()ifextraglobsisnotNone:globs.update(extraglobs)if'__name__'notinglobs: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()returntests

def_from_module(self,module,object):""" Return true if the given object is defined in the given module. """ifmoduleisNone:returnTrueelifinspect.getmodule(object)isnotNone:returnmoduleisinspect.getmodule(object)elifinspect.isfunction(object):returnmodule.__dict__isobject.__globals__elifinspect.ismethoddescriptor(object):ifhasattr(object,'__objclass__'):obj_mod=object.__objclass__.__module__elifhasattr(object,'__module__'):obj_mod=object.__module__else:returnTrue# [XX] no easy way to tell otherwisereturnmodule.__name__==obj_modelifinspect.isclass(object):returnmodule.__name__==object.__module__elifhasattr(object,'__module__'):returnmodule.__name__==object.__module__elifisinstance(object,property):returnTrue# [XX] no way not be sure.else:raiseValueError("object must be a class or function")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`. """ifself._verbose:print('Finding tests in %s'%name)# If we've already processed this object, then ignore it.ifid(obj)inseen:returnseen[id(obj)]=1# Find a test for this object, and add it to the list of tests.test=self._get_test(obj,name,module,globs,source_lines)iftestisnotNone:tests.append(test)# Look for tests in a module's contained objects.ifinspect.ismodule(obj)andself._recurse:forvalname,valinobj.__dict__.items():valname='%s.%s'%(name,valname)# Recurse to functions & classes.if((inspect.isroutine(inspect.unwrap(val))orinspect.isclass(val))andself._from_module(module,val)):self._find(tests,val,valname,module,source_lines,globs,seen)# Look for tests in a module's __test__ dictionary.ifinspect.ismodule(obj)andself._recurse:forvalname,valingetattr(obj,'__test__',{}).items():ifnotisinstance(valname,str):raiseValueError("DocTestFinder.find: __test__ keys ""must be strings: %r"%(type(valname),))ifnot(inspect.isroutine(val)orinspect.isclass(val)orinspect.ismodule(val)orisinstance(val,str)):raiseValueError("DocTestFinder.find: __test__ values ""must be strings, functions, methods, ""classes, or modules: %r"%(type(val),))valname='%s.__test__.%s'%(name,valname)self._find(tests,val,valname,module,source_lines,globs,seen)# Look for tests in a class's contained objects.ifinspect.isclass(obj)andself._recurse:forvalname,valinobj.__dict__.items():# Special handling for staticmethod/classmethod.ifisinstance(val,staticmethod):val=getattr(obj,valname)ifisinstance(val,classmethod):val=getattr(obj,valname).__func__# Recurse to methods, properties, and nested classes.if((inspect.isroutine(val)orinspect.isclass(val)orisinstance(val,property))andself._from_module(module,val)):valname='%s.%s'%(name,valname)self._find(tests,val,valname,module,source_lines,globs,seen)def_get_test(self,obj,name,module,globs,source_lines):""" Return a DocTest for the given object, if it defines a docstring; otherwise, return None. """# Extract the object's docstring. If it doesn't have one,# then return None (no test for this object).ifisinstance(obj,str):docstring=objelse:try:ifobj.__doc__isNone:docstring=''else:docstring=obj.__doc__ifnotisinstance(docstring,str):docstring=str(docstring)except(TypeError,AttributeError):docstring=''# Find the docstring's location in the file.lineno=self._find_lineno(obj,source_lines)# Don't bother if the docstring is empty.ifself._exclude_emptyandnotdocstring:returnNone# Return a DocTest for this object.ifmoduleisNone:filename=Noneelse:filename=getattr(module,'__file__',module.__name__)iffilename[-4:]==".pyc":filename=filename[:-1]returnself._parser.get_doctest(docstring,globs,name,filename,lineno)def_find_lineno(self,obj,source_lines):""" Return a line number of the given object's docstring. Note: this method assumes that the object has a docstring. """lineno=None# Find the line number for modules.ifinspect.ismodule(obj):lineno=0# Find the line number for classes.# Note: this could be fooled if a class is defined multiple# times in a single file.ifinspect.isclass(obj):ifsource_linesisNone:returnNonepat=re.compile(r'^\s*class\s*%s\b'%getattr(obj,'__name__','-'))fori,lineinenumerate(source_lines):ifpat.match(line):lineno=ibreak# Find the line number for functions & methods.ifinspect.ismethod(obj):obj=obj.__func__ifinspect.isfunction(obj):obj=obj.__code__ifinspect.istraceback(obj):obj=obj.tb_frameifinspect.isframe(obj):obj=obj.f_codeifinspect.iscode(obj):lineno=getattr(obj,'co_firstlineno',None)-1# Find the line number where the docstring starts. Assume# that it's the first line that begins with a quote mark.# Note: this could be fooled by a multiline function# signature, where a continuation line begins with a quote# mark.iflinenoisnotNone:ifsource_linesisNone:returnlineno+1pat=re.compile(r'(^|.*:)\s*\w*("|\')')forlinenoinrange(lineno,len(source_lines)):ifpat.match(source_lines[lineno]):returnlineno# We couldn't find the line number.returnNone

[docs]classDocTestRunner:""" A class used to run DocTest test cases, and accumulate statistics. The `run` method is used to process a single DocTest case. It returns a tuple `(f, t)`, where `t` is the number of test cases tried, and `f` is the number of test cases that failed. >>> tests = DocTestFinder().find(_TestClass) >>> runner = DocTestRunner(verbose=False) >>> tests.sort(key = lambda test: test.name) >>> for test in tests: ... print(test.name, '->', runner.run(test)) _TestClass -> TestResults(failed=0, attempted=2) _TestClass.__init__ -> TestResults(failed=0, attempted=2) _TestClass.get -> TestResults(failed=0, attempted=2) _TestClass.square -> TestResults(failed=0, attempted=1) The `summarize` method prints a summary of all the test cases that have been run by the runner, and returns an aggregated `(f, t)` tuple: >>> runner.summarize(verbose=1) 4 items passed all tests: 2 tests in _TestClass 2 tests in _TestClass.__init__ 2 tests in _TestClass.get 1 tests in _TestClass.square 7 tests in 4 items. 7 passed and 0 failed. Test passed. TestResults(failed=0, attempted=7) The aggregated number of tried examples and failed examples is also available via the `tries` and `failures` attributes: >>> runner.tries 7 >>> runner.failures 0 The comparison between expected outputs and actual outputs is done by an `OutputChecker`. This comparison may be customized with a number of option flags; see the documentation for `testmod` for more information. If the option flags are insufficient, then the comparison may also be customized by passing a subclass of `OutputChecker` to the constructor. The test runner's display output can be controlled in two ways. First, an output function (`out) can be passed to `TestRunner.run`; this function will be called with strings that should be displayed. It defaults to `sys.stdout.write`. If capturing the output is not sufficient, then the display output can be also customized by subclassing DocTestRunner, and overriding the methods `report_start`, `report_success`, `report_unexpected_exception`, and `report_failure`. """# This divider string is used to separate failure messages, and to# separate sections of the summary.DIVIDER="*"*70def__init__(self,checker=None,verbose=None,optionflags=0):""" Create a new test runner. Optional keyword arg `checker` is the `OutputChecker` that should be used to compare the expected outputs and actual outputs of doctest examples. Optional keyword arg 'verbose' prints lots of stuff if true, only failures if false; by default, it's true iff '-v' is in sys.argv. Optional argument `optionflags` can be used to control how the test runner compares expected output to actual output, and how it displays failures. See the documentation for `testmod` for more information. """self._checker=checkerorOutputChecker()ifverboseisNone:verbose='-v'insys.argvself._verbose=verboseself.optionflags=optionflagsself.original_optionflags=optionflags# Keep track of the examples we've run.self.tries=0self.failures=0self._name2ft={}# Create a fake output target for capturing doctest output.self._fakeout=_SpoofOut()#/////////////////////////////////////////////////////////////////# Reporting methods#/////////////////////////////////////////////////////////////////

[docs]defreport_start(self,out,test,example):""" Report that the test runner is about to process the given example. (Only displays a message if verbose=True) """ifself._verbose:ifexample.want:out('Trying:\n'+_indent(example.source)+'Expecting:\n'+_indent(example.want))else:out('Trying:\n'+_indent(example.source)+'Expecting nothing\n')

[docs]defreport_success(self,out,test,example,got):""" Report that the given example ran successfully. (Only displays a message if verbose=True) """ifself._verbose:out("ok\n")

[docs]defreport_failure(self,out,test,example,got):""" Report that the given example failed. """out(self._failure_header(test,example)+self._checker.output_difference(example,got,self.optionflags))

[docs]defreport_unexpected_exception(self,out,test,example,exc_info):""" Report that the given example raised an unexpected exception. """out(self._failure_header(test,example)+'Exception raised:\n'+_indent(_exception_traceback(exc_info)))

def_failure_header(self,test,example):out=[self.DIVIDER]iftest.filename:iftest.linenoisnotNoneandexample.linenoisnotNone:lineno=test.lineno+example.lineno+1else:lineno='?'out.append('File "%s", line %s, in %s'%(test.filename,lineno,test.name))else:out.append('Line %s, in %s'%(example.lineno+1,test.name))out.append('Failed example:')source=example.sourceout.append(_indent(source))return'\n'.join(out)#/////////////////////////////////////////////////////////////////# DocTest Running#/////////////////////////////////////////////////////////////////def__run(self,test,compileflags,out):""" Run the examples in `test`. Write the outcome of each example with one of the `DocTestRunner.report_*` methods, using the writer function `out`. `compileflags` is the set of compiler flags that should be used to execute examples. Return a tuple `(f, t)`, where `t` is the number of examples tried, and `f` is the number of examples that failed. The examples are run in the namespace `test.globs`. """# Keep track of the number of failures and tries.failures=tries=0# Save the option flags (since option directives can be used# to modify them).original_optionflags=self.optionflagsSUCCESS,FAILURE,BOOM=range(3)# `outcome` statecheck=self._checker.check_output# Process each example.forexamplenum,exampleinenumerate(test.examples):# If REPORT_ONLY_FIRST_FAILURE is set, then suppress# reporting after the first failure.quiet=(self.optionflags&REPORT_ONLY_FIRST_FAILUREandfailures>0)# Merge in the example's options.self.optionflags=original_optionflagsifexample.options:for(optionflag,val)inexample.options.items():ifval:self.optionflags|=optionflagelse:self.optionflags&=~optionflag# If 'SKIP' is set, then skip this example.ifself.optionflags&SKIP:continue# Record that we started this example.tries+=1ifnotquiet:self.report_start(out,test,example)# Use a special filename for compile(), so we can retrieve# the source code during interactive debugging (see# __patched_linecache_getlines).filename='<doctest %s[%d]>'%(test.name,examplenum)# Run the example in the given context (globs), and record# any exception that gets raised. (But don't intercept# keyboard interrupts.)try:# Don't blink! This is where the user's code gets run.exec(compile(example.source,filename,"single",compileflags,1),test.globs)self.debugger.set_continue()# ==== Example Finished ====exception=NoneexceptKeyboardInterrupt:raiseexcept:exception=sys.exc_info()self.debugger.set_continue()# ==== Example Finished ====got=self._fakeout.getvalue()# the actual outputself._fakeout.truncate(0)outcome=FAILURE# guilty until proved innocent or insane# If the example executed without raising any exceptions,# verify its output.ifexceptionisNone:ifcheck(example.want,got,self.optionflags):outcome=SUCCESS# The example raised an exception: check if it was expected.else:exc_msg=traceback.format_exception_only(*exception[:2])[-1]ifnotquiet:got+=_exception_traceback(exception)# If `example.exc_msg` is None, then we weren't expecting# an exception.ifexample.exc_msgisNone:outcome=BOOM# We expected an exception: see whether it matches.elifcheck(example.exc_msg,exc_msg,self.optionflags):outcome=SUCCESS# Another chance if they didn't care about the detail.elifself.optionflags&IGNORE_EXCEPTION_DETAIL:ifcheck(_strip_exception_details(example.exc_msg),_strip_exception_details(exc_msg),self.optionflags):outcome=SUCCESS# Report the outcome.ifoutcomeisSUCCESS:ifnotquiet:self.report_success(out,test,example,got)elifoutcomeisFAILURE:ifnotquiet:self.report_failure(out,test,example,got)failures+=1elifoutcomeisBOOM:ifnotquiet:self.report_unexpected_exception(out,test,example,exception)failures+=1else:assertFalse,("unknown outcome",outcome)iffailuresandself.optionflags&FAIL_FAST:break# Restore the option flags (in case they were modified)self.optionflags=original_optionflags# Record and return the number of failures and tries.self.__record_outcome(test,failures,tries)returnTestResults(failures,tries)def__record_outcome(self,test,f,t):""" Record the fact that the given DocTest (`test`) generated `f` failures out of `t` tried examples. """f2,t2=self._name2ft.get(test.name,(0,0))self._name2ft[test.name]=(f+f2,t+t2)self.failures+=fself.tries+=t__LINECACHE_FILENAME_RE=re.compile(r'<doctest 'r'(?P<name>.+)'r'\[(?P<examplenum>\d+)\]>$')def__patched_linecache_getlines(self,filename,module_globals=None):m=self.__LINECACHE_FILENAME_RE.match(filename)ifmandm.group('name')==self.test.name:example=self.test.examples[int(m.group('examplenum'))]returnexample.source.splitlines(keepends=True)else:returnself.save_linecache_getlines(filename,module_globals)

[docs]defrun(self,test,compileflags=None,out=None,clear_globs=True):""" Run the examples in `test`, and display the results using the writer function `out`. The examples are run in the namespace `test.globs`. If `clear_globs` is true (the default), then this namespace will be cleared after the test runs, to help with garbage collection. If you would like to examine the namespace after the test completes, then use `clear_globs=False`. `compileflags` gives the set of flags that should be used by the Python compiler when running the examples. If not specified, then it will default to the set of future-import flags that apply to `globs`. The output of each example is checked using `DocTestRunner.check_output`, and the results are formatted by the `DocTestRunner.report_*` methods. """self.test=testifcompileflagsisNone:compileflags=_extract_future_flags(test.globs)save_stdout=sys.stdoutifoutisNone:encoding=save_stdout.encodingifencodingisNoneorencoding.lower()=='utf-8':out=save_stdout.writeelse:# Use backslashreplace error handling on writedefout(s):s=str(s.encode(encoding,'backslashreplace'),encoding)save_stdout.write(s)sys.stdout=self._fakeout# Patch pdb.set_trace to restore sys.stdout during interactive# debugging (so it's not still redirected to self._fakeout).# Note that the interactive output will go to *our*# save_stdout, even if that's not the real sys.stdout; this# allows us to write test cases for the set_trace behavior.save_trace=sys.gettrace()save_set_trace=pdb.set_traceself.debugger=_OutputRedirectingPdb(save_stdout)self.debugger.reset()pdb.set_trace=self.debugger.set_trace# Patch linecache.getlines, so we can see the example's source# when we're inside the debugger.self.save_linecache_getlines=linecache.getlineslinecache.getlines=self.__patched_linecache_getlines# Make sure sys.displayhook just prints the value to stdoutsave_displayhook=sys.displayhooksys.displayhook=sys.__displayhook__try:returnself.__run(test,compileflags,out)finally:sys.stdout=save_stdoutpdb.set_trace=save_set_tracesys.settrace(save_trace)linecache.getlines=self.save_linecache_getlinessys.displayhook=save_displayhookifclear_globs:test.globs.clear()importbuiltinsbuiltins._=None

[docs]defsummarize(self,verbose=None):""" Print a summary of all the test cases that have been run by this DocTestRunner, and return a tuple `(f, t)`, where `f` is the total number of failed examples, and `t` is the total number of tried examples. The optional `verbose` argument controls how detailed the summary is. If the verbosity is not specified, then the DocTestRunner's verbosity is used. """ifverboseisNone:verbose=self._verbosenotests=[]passed=[]failed=[]totalt=totalf=0forxinself._name2ft.items():name,(f,t)=xassertf<=ttotalt+=ttotalf+=fift==0:notests.append(name)eliff==0:passed.append((name,t))else:failed.append(x)ifverbose:ifnotests:print(len(notests),"items had no tests:")notests.sort()forthinginnotests:print(" ",thing)ifpassed:print(len(passed),"items passed all tests:")passed.sort()forthing,countinpassed:print(" %3d tests in %s"%(count,thing))iffailed:print(self.DIVIDER)print(len(failed),"items had failures:")failed.sort()forthing,(f,t)infailed:print(" %3d of %3d in %s"%(f,t,thing))ifverbose:print(totalt,"tests in",len(self._name2ft),"items.")print(totalt-totalf,"passed and",totalf,"failed.")iftotalf:print("***Test Failed***",totalf,"failures.")elifverbose:print("Test passed.")returnTestResults(totalf,totalt)

[docs]classOutputChecker:""" A class used to check the whether the actual output from a doctest example matches the expected output. `OutputChecker` defines two methods: `check_output`, which compares a given pair of outputs, and returns true if they match; and `output_difference`, which returns a string describing the differences between two outputs. """def_toAscii(self,s):""" Convert string to hex-escaped ASCII string. """returnstr(s.encode('ASCII','backslashreplace'),"ASCII")

[docs]defcheck_output(self,want,got,optionflags):""" Return True iff the actual output from an example (`got`) matches the expected output (`want`). These strings are always considered to match if they are identical; but depending on what option flags the test runner is using, several non-exact match types are also possible. See the documentation for `TestRunner` for more information about option flags. """# If `want` contains hex-escaped character such as "\u1234",# then `want` is a string of six characters(e.g. [\,u,1,2,3,4]).# On the other hand, `got` could be another sequence of# characters such as [\u1234], so `want` and `got` should# be folded to hex-escaped ASCII string to compare.got=self._toAscii(got)want=self._toAscii(want)# Handle the common case first, for efficiency:# if they're string-identical, always return true.ifgot==want:returnTrue# The values True and False replaced 1 and 0 as the return# value for boolean comparisons in Python 2.3.ifnot(optionflags&DONT_ACCEPT_TRUE_FOR_1):if(got,want)==("True\n","1\n"):returnTrueif(got,want)==("False\n","0\n"):returnTrue# <BLANKLINE> can be used as a special sequence to signify a# blank line, unless the DONT_ACCEPT_BLANKLINE flag is used.ifnot(optionflags&DONT_ACCEPT_BLANKLINE):# Replace <BLANKLINE> in want with a blank line.want=re.sub(r'(?m)^%s\s*?$'%re.escape(BLANKLINE_MARKER),'',want)# If a line in got contains only spaces, then remove the# spaces.got=re.sub(r'(?m)^\s*?$','',got)ifgot==want:returnTrue# This flag causes doctest to ignore any differences in the# contents of whitespace strings. Note that this can be used# in conjunction with the ELLIPSIS flag.ifoptionflags&NORMALIZE_WHITESPACE:got=' '.join(got.split())want=' '.join(want.split())ifgot==want:returnTrue# The ELLIPSIS flag says to let the sequence "..." in `want`# match any substring in `got`.ifoptionflags&ELLIPSIS:if_ellipsis_match(want,got):returnTrue# We didn't find any match; return false.returnFalse

# Should we do a fancy diff?def_do_a_fancy_diff(self,want,got,optionflags):# Not unless they asked for a fancy diff.ifnotoptionflags&(REPORT_UDIFF|REPORT_CDIFF|REPORT_NDIFF):returnFalse# If expected output uses ellipsis, a meaningful fancy diff is# too hard ... or maybe not. In two real-life failures Tim saw,# a diff was a major help anyway, so this is commented out.# [todo] _ellipsis_match() knows which pieces do and don't match,# and could be the basis for a kick-ass diff in this case.##if optionflags & ELLIPSIS and ELLIPSIS_MARKER in want:## return False# ndiff does intraline difference marking, so can be useful even# for 1-line differences.ifoptionflags&REPORT_NDIFF:returnTrue# The other diff types need at least a few lines to be helpful.returnwant.count('\n')>2andgot.count('\n')>2

[docs]defoutput_difference(self,example,got,optionflags):""" Return a string describing the differences between the expected output for a given example (`example`) and the actual output (`got`). `optionflags` is the set of option flags used to compare `want` and `got`. """want=example.want# If <BLANKLINE>s are being used, then replace blank lines# with <BLANKLINE> in the actual output string.ifnot(optionflags&DONT_ACCEPT_BLANKLINE):got=re.sub('(?m)^[ ]*(?=\n)',BLANKLINE_MARKER,got)# Check if we should use diff.ifself._do_a_fancy_diff(want,got,optionflags):# Split want & got into lines.want_lines=want.splitlines(keepends=True)got_lines=got.splitlines(keepends=True)# Use difflib to find their differences.ifoptionflags&REPORT_UDIFF:diff=difflib.unified_diff(want_lines,got_lines,n=2)diff=list(diff)[2:]# strip the diff headerkind='unified diff with -expected +actual'elifoptionflags&REPORT_CDIFF:diff=difflib.context_diff(want_lines,got_lines,n=2)diff=list(diff)[2:]# strip the diff headerkind='context diff with expected followed by actual'elifoptionflags&REPORT_NDIFF:engine=difflib.Differ(charjunk=difflib.IS_CHARACTER_JUNK)diff=list(engine.compare(want_lines,got_lines))kind='ndiff with -expected +actual'else:assert0,'Bad diff option'# Remove trailing whitespace on diff output.diff=[line.rstrip()+'\n'forlineindiff]return'Differences (%s):\n'%kind+_indent(''.join(diff))# If we're not using diff, then simply list the expected# output followed by the actual output.ifwantandgot:return'Expected:\n%sGot:\n%s'%(_indent(want),_indent(got))elifwant:return'Expected:\n%sGot nothing\n'%_indent(want)elifgot:return'Expected nothing\nGot:\n%s'%_indent(got)else:return'Expected nothing\nGot nothing\n'

[docs]classDocTestFailure(Exception):"""A DocTest example has failed in debugging mode. The exception instance has variables: - test: the DocTest object being run - example: the Example object that failed - got: the actual output """def__init__(self,test,example,got):self.test=testself.example=exampleself.got=gotdef__str__(self):returnstr(self.test)

[docs]classUnexpectedException(Exception):"""A DocTest example has encountered an unexpected exception The exception instance has variables: - test: the DocTest object being run - example: the Example object that failed - exc_info: the exception info """def__init__(self,test,example,exc_info):self.test=testself.example=exampleself.exc_info=exc_infodef__str__(self):returnstr(self.test)

######################################################################## 6. Test Functions####################################################################### These should be backwards compatible.# For backward compatibility, a global instance of a DocTestRunner# class, updated by testmod.master=None

[docs]deftestmod(m=None,name=None,globs=None,verbose=None,report=True,optionflags=0,extraglobs=None,raise_on_error=False,exclude_empty=False):"""m=None, name=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, exclude_empty=False Test examples in docstrings in functions and classes reachable from module m (or the current module if m is not supplied), starting with m.__doc__. Also test examples reachable from dict m.__test__ if it exists and is not None. m.__test__ maps names to functions, classes and strings; function and class docstrings are tested even if the name is private; strings are tested directly, as if they were docstrings. Return (#failures, #tests). See help(doctest) for an overview. Optional keyword arg "name" gives the name of the module; by default use m.__name__. Optional keyword arg "globs" gives a dict to be used as the globals when executing examples; by default, use m.__dict__. A copy of this dict is actually used for each docstring, so that each docstring's examples start with a clean slate. Optional keyword arg "extraglobs" gives a dictionary that should be merged into the globals that are used to execute examples. By default, no extra globals are used. This is new in 2.4. Optional keyword arg "verbose" prints lots of stuff if true, prints only failures if false; by default, it's true iff "-v" is in sys.argv. Optional keyword arg "report" prints a summary at the end when true, else prints nothing at the end. In verbose mode, the summary is detailed, else very brief (in fact, empty if all tests passed). Optional keyword arg "optionflags" or's together module constants, and defaults to 0. This is new in 2.3. Possible values (see the docs for details): DONT_ACCEPT_TRUE_FOR_1 DONT_ACCEPT_BLANKLINE NORMALIZE_WHITESPACE ELLIPSIS SKIP IGNORE_EXCEPTION_DETAIL REPORT_UDIFF REPORT_CDIFF REPORT_NDIFF REPORT_ONLY_FIRST_FAILURE Optional keyword arg "raise_on_error" raises an exception on the first unexpected exception or failure. This allows failures to be post-mortem debugged. Advanced tomfoolery: testmod runs methods of a local instance of class doctest.Tester, then merges the results into (or creates) global Tester instance doctest.master. Methods of doctest.master can be called directly too, if you want to do something unusual. Passing report=0 to testmod is especially useful then, to delay displaying a summary. Invoke doctest.master.summarize(verbose) when you're done fiddling. """globalmaster# If no module was given, then use __main__.ifmisNone:# DWA - m will still be None if this wasn't invoked from the command# line, in which case the following TypeError is about as good an error# as we should expectm=sys.modules.get('__main__')# Check that we were actually given a module.ifnotinspect.ismodule(m):raiseTypeError("testmod: module required; %r"%(m,))# If no name was given, then use the module's name.ifnameisNone:name=m.__name__# Find, parse, and run all tests in the given module.finder=DocTestFinder(exclude_empty=exclude_empty)ifraise_on_error:runner=DebugRunner(verbose=verbose,optionflags=optionflags)else:runner=DocTestRunner(verbose=verbose,optionflags=optionflags)fortestinfinder.find(m,name,globs=globs,extraglobs=extraglobs):runner.run(test)ifreport:runner.summarize()ifmasterisNone:master=runnerelse:master.merge(runner)returnTestResults(runner.failures,runner.tries)

[docs]deftestfile(filename,module_relative=True,name=None,package=None,globs=None,verbose=None,report=True,optionflags=0,extraglobs=None,raise_on_error=False,parser=DocTestParser(),encoding=None):""" Test examples in the given file. Return (#failures, #tests). Optional keyword arg "module_relative" specifies how filenames should be interpreted: - If "module_relative" is True (the default), then "filename" specifies a module-relative path. By default, this path is relative to the calling module's directory; but if the "package" argument is specified, then it is relative to that package. To ensure os-independence, "filename" should use "/" characters to separate path segments, and should not be an absolute path (i.e., it may not begin with "/"). - If "module_relative" is False, then "filename" specifies an os-specific path. The path may be absolute or relative (to the current working directory). Optional keyword arg "name" gives the name of the test; by default use the file's basename. Optional keyword argument "package" is a Python package or the name of a Python package whose directory should be used as the base directory for a module relative filename. If no package is specified, then the calling module's directory is used as the base directory for module relative filenames. It is an error to specify "package" if "module_relative" is False. Optional keyword arg "globs" gives a dict to be used as the globals when executing examples; by default, use {}. A copy of this dict is actually used for each docstring, so that each docstring's examples start with a clean slate. Optional keyword arg "extraglobs" gives a dictionary that should be merged into the globals that are used to execute examples. By default, no extra globals are used. Optional keyword arg "verbose" prints lots of stuff if true, prints only failures if false; by default, it's true iff "-v" is in sys.argv. Optional keyword arg "report" prints a summary at the end when true, else prints nothing at the end. In verbose mode, the summary is detailed, else very brief (in fact, empty if all tests passed). Optional keyword arg "optionflags" or's together module constants, and defaults to 0. Possible values (see the docs for details): DONT_ACCEPT_TRUE_FOR_1 DONT_ACCEPT_BLANKLINE NORMALIZE_WHITESPACE ELLIPSIS SKIP IGNORE_EXCEPTION_DETAIL REPORT_UDIFF REPORT_CDIFF REPORT_NDIFF REPORT_ONLY_FIRST_FAILURE Optional keyword arg "raise_on_error" raises an exception on the first unexpected exception or failure. This allows failures to be post-mortem debugged. Optional keyword arg "parser" specifies a DocTestParser (or subclass) that should be used to extract tests from the files. Optional keyword arg "encoding" specifies an encoding that should be used to convert the file to unicode. Advanced tomfoolery: testmod runs methods of a local instance of class doctest.Tester, then merges the results into (or creates) global Tester instance doctest.master. Methods of doctest.master can be called directly too, if you want to do something unusual. Passing report=0 to testmod is especially useful then, to delay displaying a summary. Invoke doctest.master.summarize(verbose) when you're done fiddling. """globalmasterifpackageandnotmodule_relative:raiseValueError("Package may only be specified for module-""relative paths.")# Relativize the pathtext,filename=_load_testfile(filename,package,module_relative,encodingor"utf-8")# If no name was given, then use the file's name.ifnameisNone:name=os.path.basename(filename)# Assemble the globals.ifglobsisNone:globs={}else:globs=globs.copy()ifextraglobsisnotNone:globs.update(extraglobs)if'__name__'notinglobs:globs['__name__']='__main__'ifraise_on_error:runner=DebugRunner(verbose=verbose,optionflags=optionflags)else:runner=DocTestRunner(verbose=verbose,optionflags=optionflags)# Read the file, convert it to a test, and run it.test=parser.get_doctest(text,globs,name,filename,0)runner.run(test)ifreport:runner.summarize()ifmasterisNone:master=runnerelse:master.merge(runner)returnTestResults(runner.failures,runner.tries)

[docs]defrun_docstring_examples(f,globs,verbose=False,name="NoName",compileflags=None,optionflags=0):""" Test examples in the given object's docstring (`f`), using `globs` as globals. Optional argument `name` is used in failure messages. If the optional argument `verbose` is true, then generate output even if there are no failures. `compileflags` gives the set of flags that should be used by the Python compiler when running the examples. If not specified, then it will default to the set of future-import flags that apply to `globs`. Optional keyword arg `optionflags` specifies options for the testing and output. See the documentation for `testmod` for more information. """# Find, parse, and run all tests in the given module.finder=DocTestFinder(verbose=verbose,recurse=False)runner=DocTestRunner(verbose=verbose,optionflags=optionflags)fortestinfinder.find(f,name,globs=globs):runner.run(test,compileflags=compileflags)

classDocTestCase(unittest.TestCase):def__init__(self,test,optionflags=0,setUp=None,tearDown=None,checker=None):unittest.TestCase.__init__(self)self._dt_optionflags=optionflagsself._dt_checker=checkerself._dt_test=testself._dt_setUp=setUpself._dt_tearDown=tearDowndefsetUp(self):test=self._dt_testifself._dt_setUpisnotNone:self._dt_setUp(test)deftearDown(self):test=self._dt_testifself._dt_tearDownisnotNone:self._dt_tearDown(test)test.globs.clear()defrunTest(self):test=self._dt_testold=sys.stdoutnew=StringIO()optionflags=self._dt_optionflagsifnot(optionflags&REPORTING_FLAGS):# The option flags don't include any reporting flags,# so add the default reporting flagsoptionflags|=_unittest_reportflagsrunner=DocTestRunner(optionflags=optionflags,checker=self._dt_checker,verbose=False)try:runner.DIVIDER="-"*70failures,tries=runner.run(test,out=new.write,clear_globs=False)finally:sys.stdout=oldiffailures:raiseself.failureException(self.format_failure(new.getvalue()))defformat_failure(self,err):test=self._dt_testiftest.linenoisNone:lineno='unknown line number'else:lineno='%s'%test.linenolname='.'.join(test.name.split('.')[-1:])return('Failed doctest test for %s\n'' File "%s", line %s, in %s\n\n%s'%(test.name,test.filename,lineno,lname,err))defdebug(self):r"""Run the test case without results and without catching exceptions The unit test framework includes a debug method on test cases and test suites to support post-mortem debugging. The test code is run in such a way that errors are not caught. This way a caller can catch the errors and initiate post-mortem debugging. The DocTestCase provides a debug method that raises UnexpectedException errors if there is an unexpected exception: >>> test = DocTestParser().get_doctest('>>> raise KeyError\n42', ... {}, 'foo', 'foo.py', 0) >>> case = DocTestCase(test) >>> try: ... case.debug() ... except UnexpectedException as f: ... failure = f The UnexpectedException contains the test, the example, and the original exception: >>> failure.test is test True >>> failure.example.want '42\n' >>> exc_info = failure.exc_info >>> raise exc_info[1] # Already has the traceback Traceback (most recent call last): ... KeyError If the output doesn't match, then a DocTestFailure is raised: >>> test = DocTestParser().get_doctest(''' ... >>> x = 1 ... >>> x ... 2 ... ''', {}, 'foo', 'foo.py', 0) >>> case = DocTestCase(test) >>> try: ... case.debug() ... except DocTestFailure as f: ... failure = f DocTestFailure objects provide access to the test: >>> failure.test is test True As well as to the example: >>> failure.example.want '2\n' and the actual output: >>> failure.got '1\n' """self.setUp()runner=DebugRunner(optionflags=self._dt_optionflags,checker=self._dt_checker,verbose=False)runner.run(self._dt_test,clear_globs=False)self.tearDown()defid(self):returnself._dt_test.namedef__eq__(self,other):iftype(self)isnottype(other):returnNotImplementedreturnself._dt_test==other._dt_testand \
self._dt_optionflags==other._dt_optionflagsand \
self._dt_setUp==other._dt_setUpand \
self._dt_tearDown==other._dt_tearDownand \
self._dt_checker==other._dt_checkerdef__hash__(self):returnhash((self._dt_optionflags,self._dt_setUp,self._dt_tearDown,self._dt_checker))def__repr__(self):name=self._dt_test.name.split('.')return"%s (%s)"%(name[-1],'.'.join(name[:-1]))__str__=__repr__defshortDescription(self):return"Doctest: "+self._dt_test.nameclassSkipDocTestCase(DocTestCase):def__init__(self,module):self.module=moduleDocTestCase.__init__(self,None)defsetUp(self):self.skipTest("DocTestSuite will not work with -O2 and above")deftest_skip(self):passdefshortDescription(self):return"Skipping tests from %s"%self.module.__name____str__=shortDescriptionclass_DocTestSuite(unittest.TestSuite):def_removeTestAtIndex(self,index):passdefDocTestSuite(module=None,globs=None,extraglobs=None,test_finder=None,**options):""" Convert doctest tests for a module to a unittest test suite. This converts each documentation string in a module that contains doctest tests to a unittest test case. If any of the tests in a doc string fail, then the test case fails. An exception is raised showing the name of the file containing the test and a (sometimes approximate) line number. The `module` argument provides the module to be tested. The argument can be either a module or a module name. If no argument is given, the calling module is used. A number of options may be provided as keyword arguments: setUp A set-up function. This is called before running the tests in each file. The setUp function will be passed a DocTest object. The setUp function can access the test globals as the globs attribute of the test passed. tearDown A tear-down function. This is called after running the tests in each file. The tearDown function will be passed a DocTest object. The tearDown function can access the test globals as the globs attribute of the test passed. globs A dictionary containing initial global variables for the tests. optionflags A set of doctest option flags expressed as an integer. """iftest_finderisNone:test_finder=DocTestFinder()module=_normalize_module(module)tests=test_finder.find(module,globs=globs,extraglobs=extraglobs)ifnottestsandsys.flags.optimize>=2:# Skip doctests when running with -O2suite=_DocTestSuite()suite.addTest(SkipDocTestCase(module))returnsuitetests.sort()suite=_DocTestSuite()fortestintests:iflen(test.examples)==0:continueifnottest.filename:filename=module.__file__iffilename[-4:]==".pyc":filename=filename[:-1]test.filename=filenamesuite.addTest(DocTestCase(test,**options))returnsuiteclassDocFileCase(DocTestCase):defid(self):return'_'.join(self._dt_test.name.split('.'))def__repr__(self):returnself._dt_test.filename__str__=__repr__defformat_failure(self,err):return('Failed doctest test for %s\n File "%s", line 0\n\n%s'%(self._dt_test.name,self._dt_test.filename,err))defDocFileTest(path,module_relative=True,package=None,globs=None,parser=DocTestParser(),encoding=None,**options):ifglobsisNone:globs={}else:globs=globs.copy()ifpackageandnotmodule_relative:raiseValueError("Package may only be specified for module-""relative paths.")# Relativize the path.doc,path=_load_testfile(path,package,module_relative,encodingor"utf-8")if"__file__"notinglobs:globs["__file__"]=path# Find the file and read it.name=os.path.basename(path)# Convert it to a test, and wrap it in a DocFileCase.test=parser.get_doctest(doc,globs,name,path,0)returnDocFileCase(test,**options)defDocFileSuite(*paths,**kw):"""A unittest suite for one or more doctest files. The path to each doctest file is given as a string; the interpretation of that string depends on the keyword argument "module_relative". A number of options may be provided as keyword arguments: module_relative If "module_relative" is True, then the given file paths are interpreted as os-independent module-relative paths. By default, these paths are relative to the calling module's directory; but if the "package" argument is specified, then they are relative to that package. To ensure os-independence, "filename" should use "/" characters to separate path segments, and may not be an absolute path (i.e., it may not begin with "/"). If "module_relative" is False, then the given file paths are interpreted as os-specific paths. These paths may be absolute or relative (to the current working directory). package A Python package or the name of a Python package whose directory should be used as the base directory for module relative paths. If "package" is not specified, then the calling module's directory is used as the base directory for module relative filenames. It is an error to specify "package" if "module_relative" is False. setUp A set-up function. This is called before running the tests in each file. The setUp function will be passed a DocTest object. The setUp function can access the test globals as the globs attribute of the test passed. tearDown A tear-down function. This is called after running the tests in each file. The tearDown function will be passed a DocTest object. The tearDown function can access the test globals as the globs attribute of the test passed. globs A dictionary containing initial global variables for the tests. optionflags A set of doctest option flags expressed as an integer. parser A DocTestParser (or subclass) that should be used to extract tests from the files. encoding An encoding that will be used to convert the files to unicode. """suite=_DocTestSuite()# We do this here so that _normalize_module is called at the right# level. If it were called in DocFileTest, then this function# would be the caller and we might guess the package incorrectly.ifkw.get('module_relative',True):kw['package']=_normalize_module(kw.get('package'))forpathinpaths:suite.addTest(DocFileTest(path,**kw))returnsuite######################################################################## 8. Debugging Support######################################################################

[docs]deftestsource(module,name):"""Extract the test sources from a doctest docstring as a script. Provide the module (or dotted name of the module) containing the test to be debugged and the name (within the module) of the object with the doc string with tests to be debugged. """module=_normalize_module(module)tests=DocTestFinder().find(module)test=[tfortintestsift.name==name]ifnottest:raiseValueError(name,"not found in tests")test=test[0]testsrc=script_from_examples(test.docstring)returntestsrc

[docs]defdebug_src(src,pm=False,globs=None):"""Debug a single doctest docstring, in argument `src`'"""testsrc=script_from_examples(src)debug_script(testsrc,pm,globs)

defdebug_script(src,pm=False,globs=None):"Debug a test script. `src` is the script, as a string."importpdbifglobs:globs=globs.copy()else:globs={}ifpm:try:exec(src,globs,globs)except:print(sys.exc_info()[1])p=pdb.Pdb(nosigint=True)p.reset()p.interaction(None,sys.exc_info()[2])else:pdb.Pdb(nosigint=True).run("exec(%r)"%src,globs,globs)

[docs]defdebug(module,name,pm=False):"""Debug a single doctest docstring. Provide the module (or dotted name of the module) containing the test to be debugged and the name (within the module) of the object with the docstring with tests to be debugged. """module=_normalize_module(module)testsrc=testsource(module,name)debug_script(testsrc,pm,module.__dict__)