Edit File - File Manager

Edit File: doctest.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
 <title>25.2. doctest — Test interactive Python examples &mdash; Python v2.6.6 documentation</title>
 <link rel="stylesheet" href="../_static/default.css" type="text/css" />
 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 <script type="text/javascript">
 var DOCUMENTATION_OPTIONS = {
 URL_ROOT: '../',
 VERSION: '2.6.6',
 COLLAPSE_MODINDEX: false,
 FILE_SUFFIX: '.html',
 HAS_SOURCE: true
 };
 </script>
 <script type="text/javascript" src="../_static/jquery.js"></script>
 <script type="text/javascript" src="../_static/doctools.js"></script>
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python v2.6.6 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="top" title="Python v2.6.6 documentation" href="../index.html" />
 <link rel="up" title="25. Development Tools" href="development.html" />
 <link rel="next" title="25.3. unittest — Unit testing framework" href="unittest.html" />
 <link rel="prev" title="25.1. pydoc — Documentation generator and online help system" href="pydoc.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />

</head>
 <body>
 <div class="related">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../modindex.html" title="Global Module Index"
 accesskey="M">modules</a> |</li>
 <li class="right" >
 <a href="unittest.html" title="25.3. unittest — Unit testing framework"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="pydoc.html" title="25.1. pydoc — Documentation generator and online help system"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="../index.html">Python v2.6.6 documentation</a> &raquo;</li>

<li><a href="index.html" >The Python Standard Library</a> &raquo;</li>
 <li><a href="development.html" accesskey="U">25. Development Tools</a> &raquo;</li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body">
 
 <div class="section" id="module-doctest">
<h1>25.2. <tt class="xref docutils literal">doctest</tt> &#8212; Test interactive Python examples<a class="headerlink" href="#module-doctest" title="Permalink to this headline">¶</a></h1>
The <tt class="xref docutils literal">doctest</tt> module searches for pieces of text that look like interactive
Python sessions, and then executes those sessions to verify that they work
exactly as shown. There are several common ways to use doctest:
<ul class="simple">
<li>To check that a module&#8217;s docstrings are up-to-date by verifying that all
interactive examples still work as documented.</li>
<li>To perform regression testing by verifying that interactive examples from a
test file or a test object work as expected.</li>
<li>To write tutorial documentation for a package, liberally illustrated with
input-output examples. Depending on whether the examples or the expository text
are emphasized, this has the flavor of &#8220;literate testing&#8221; or &#8220;executable
documentation&#8221;.</li>
</ul>
Here&#8217;s a complete but small example module:
<div class="highlight-python"><div class="highlight"><pre>&quot;&quot;&quot;
This is the &quot;example&quot; module.

The example module supplies one function, factorial(). For example,

&gt;&gt;&gt; factorial(5)
120
&quot;&quot;&quot;

def factorial(n):
 &quot;&quot;&quot;Return the factorial of n, an exact integer &gt;= 0.

If the result is small enough to fit in an int, return an int.
 Else return a long.

&gt;&gt;&gt; [factorial(n) for n in range(6)]
 [1, 1, 2, 6, 24, 120]
 &gt;&gt;&gt; [factorial(long(n)) for n in range(6)]
 [1, 1, 2, 6, 24, 120]
 &gt;&gt;&gt; factorial(30)
 265252859812191058636308480000000L
 &gt;&gt;&gt; factorial(30L)
 265252859812191058636308480000000L
 &gt;&gt;&gt; factorial(-1)
 Traceback (most recent call last):
 ...
 ValueError: n must be &gt;= 0

Factorials of floats are OK, but the float must be an exact integer:
 &gt;&gt;&gt; factorial(30.1)
 Traceback (most recent call last):
 ...
 ValueError: n must be exact integer
 &gt;&gt;&gt; factorial(30.0)
 265252859812191058636308480000000L

It must also not be ridiculously large:
 &gt;&gt;&gt; factorial(1e100)
 Traceback (most recent call last):
 ...
 OverflowError: n too large
 &quot;&quot;&quot;

import math
 if not n &gt;= 0:
 raise ValueError(&quot;n must be &gt;= 0&quot;)
 if math.floor(n) != n:
 raise ValueError(&quot;n must be exact integer&quot;)
 if n+1 == n: # catch a value like 1e300
 raise OverflowError(&quot;n too large&quot;)
 result = 1
 factor = 2
 while factor &lt;= n:
 result *= factor
 factor += 1
 return result

if __name__ == &quot;__main__&quot;:
 import doctest
 doctest.testmod()
</pre></div>
</div>
If you run <tt class="docutils literal">example.py</tt> directly from the command line, <tt class="xref docutils literal">doctest</tt>
works its magic:
<div class="highlight-python"><pre>$ python example.py
$</pre>
</div>
There&#8217;s no output! That&#8217;s normal, and it means all the examples worked. Pass
<a class="reference external" href="../using/cmdline.html#cmdoption-v">-v</a> to the script, and <tt class="xref docutils literal">doctest</tt> prints a detailed log of what
it&#8217;s trying, and prints a summary at the end:
<div class="highlight-python"><pre>$ python example.py -v
Trying:
 factorial(5)
Expecting:
 120
ok
Trying:
 [factorial(n) for n in range(6)]
Expecting:
 [1, 1, 2, 6, 24, 120]
ok
Trying:
 [factorial(long(n)) for n in range(6)]
Expecting:
 [1, 1, 2, 6, 24, 120]
ok</pre>
</div>
And so on, eventually ending with:
<div class="highlight-python"><pre>Trying:
 factorial(1e100)
Expecting:
 Traceback (most recent call last):
 ...
 OverflowError: n too large
ok
2 items passed all tests:
 1 tests in __main__
 8 tests in __main__.factorial
9 tests in 2 items.
9 passed and 0 failed.
Test passed.
$</pre>
</div>
That&#8217;s all you need to know to start making productive use of <tt class="xref docutils literal">doctest</tt>!
Jump in. The following sections provide full details. Note that there are many
examples of doctests in the standard Python test suite and libraries.
Especially useful examples can be found in the standard test file
<tt class="docutils literal">Lib/test/test_doctest.py</tt>.
<div class="section" id="simple-usage-checking-examples-in-docstrings">
<h2>25.2.1. Simple Usage: Checking Examples in Docstrings<a class="headerlink" href="#simple-usage-checking-examples-in-docstrings" title="Permalink to this headline">¶</a></h2>
The simplest way to start using doctest (but not necessarily the way you&#8217;ll
continue to do it) is to end each module <tt class="xref docutils literal">M</tt> with:
<div class="highlight-python"><div class="highlight"><pre>if __name__ == &quot;__main__&quot;:
 import doctest
 doctest.testmod()
</pre></div>
</div>
<tt class="xref docutils literal">doctest</tt> then examines docstrings in module <tt class="xref docutils literal">M</tt>.
Running the module as a script causes the examples in the docstrings to get
executed and verified:
<div class="highlight-python"><pre>python M.py</pre>
</div>
This won&#8217;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, and the
final line of output is <tt class="docutils literal">***Test Failed*** N failures.</tt>, where N is the
number of examples that failed.
Run it with the <a class="reference external" href="../using/cmdline.html#cmdoption-v">-v</a> switch instead:
<div class="highlight-python"><pre>python M.py -v</pre>
</div>
and a detailed report of all examples tried is printed to standard output, along
with assorted summaries at the end.
You can force verbose mode by passing <tt class="docutils literal">verbose=True</tt> to <a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a>, or
prohibit it by passing <tt class="docutils literal">verbose=False</tt>. In either of those cases,
<tt class="docutils literal">sys.argv</tt> is not examined by <a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a> (so passing <a class="reference external" href="../using/cmdline.html#cmdoption-v">-v</a> or not
has no effect).
Since Python 2.6, there is also a command line shortcut for running
<a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a>. You can instruct the Python interpreter to run the doctest
module directly from the standard library and pass the module name(s) on the
command line:
<div class="highlight-python"><pre>python -m doctest -v example.py</pre>
</div>
This will import <tt class="docutils literal">example.py</tt> as a standalone module and run
<a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a> on it. Note that this may not work correctly if the file is
part of a package and imports other submodules from that package.
For more information on <a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a>, see section <a class="reference internal" href="#doctest-basic-api">Basic API</a>.
</div>
<div class="section" id="simple-usage-checking-examples-in-a-text-file">
<h2>25.2.2. Simple Usage: Checking Examples in a Text File<a class="headerlink" href="#simple-usage-checking-examples-in-a-text-file" title="Permalink to this headline">¶</a></h2>
Another simple application of doctest is testing interactive examples in a text
file. This can be done with the <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a> function:
<div class="highlight-python"><div class="highlight"><pre>import doctest
doctest.testfile(&quot;example.txt&quot;)
</pre></div>
</div>
That short script executes and verifies any interactive Python examples
contained in the file <tt class="docutils literal">example.txt</tt>. The file content is treated as if it
were a single giant docstring; the file doesn&#8217;t need to contain a Python
program! For example, perhaps <tt class="docutils literal">example.txt</tt> contains this:
<div class="highlight-python"><pre>The ``example`` module
======================

Using ``factorial``
-------------------

This is an example text file in reStructuredText format.  First import
``factorial`` from the ``example`` module:

&gt;&gt;&gt; from example import factorial

Now use it:

&gt;&gt;&gt; factorial(6)
 120</pre>
</div>
Running <tt class="docutils literal">doctest.testfile(&quot;example.txt&quot;)</tt> then finds the error in this
documentation:
<div class="highlight-python"><pre>File "./example.txt", line 14, in example.txt
Failed example:
 factorial(6)
Expected:
 120
Got:
 720</pre>
</div>
As with <a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a>, <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a> won&#8217;t display anything unless an
example fails. If an example does fail, then the failing example(s) and the
cause(s) of the failure(s) are printed to stdout, using the same format as
<a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a>.
By default, <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a> looks for files in the calling module&#8217;s directory.
See section <a class="reference internal" href="#doctest-basic-api">Basic API</a> for a description of the optional arguments
that can be used to tell it to look for files in other locations.
Like <a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a>, <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a>&#8216;s verbosity can be set with the
<a class="reference external" href="../using/cmdline.html#cmdoption-v">-v</a> command-line switch or with the optional keyword argument
verbose.
Since Python 2.6, there is also a command line shortcut for running
<a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a>. You can instruct the Python interpreter to run the doctest
module directly from the standard library and pass the file name(s) on the
command line:
<div class="highlight-python"><pre>python -m doctest -v example.txt</pre>
</div>
Because the file name does not end with <tt class="docutils literal">.py</tt>, <tt class="xref docutils literal">doctest</tt> infers that
it must be run with <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a>, not <a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a>.
For more information on <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a>, see section <a class="reference internal" href="#doctest-basic-api">Basic API</a>.
</div>
<div class="section" id="how-it-works">
<h2>25.2.3. How It Works<a class="headerlink" href="#how-it-works" title="Permalink to this headline">¶</a></h2>
This section examines in detail how doctest works: which docstrings it looks at,
how it finds interactive examples, what execution context it uses, how it
handles exceptions, and how option flags can be used to control its behavior.
This is the information that you need to know to write doctest examples; for
information about actually running doctest on these examples, see the following
sections.
<div class="section" id="which-docstrings-are-examined">
<h3>25.2.3.1. Which Docstrings Are Examined?<a class="headerlink" href="#which-docstrings-are-examined" title="Permalink to this headline">¶</a></h3>
The module docstring, and all function, class and method docstrings are
searched. Objects imported into the module are not searched.
In addition, if <tt class="docutils literal">M.__test__</tt> exists and &#8220;is true&#8221;, it must be a dict, and each
entry maps a (string) name to a function object, class object, or string.
Function and class object docstrings found from <tt class="docutils literal">M.__test__</tt> are searched, and
strings are treated as if they were docstrings. In output, a key <tt class="docutils literal">K</tt> in
<tt class="docutils literal">M.__test__</tt> appears with name
<div class="highlight-python"><pre>&lt;name of M&gt;.__test__.K</pre>
</div>
Any classes found are recursively searched similarly, to test docstrings in
their contained methods and nested classes.

Changed in version 2.4: A &#8220;private name&#8221; concept is deprecated and no longer documented.
</div>
<div class="section" id="how-are-docstring-examples-recognized">
<h3>25.2.3.2. How are Docstring Examples Recognized?<a class="headerlink" href="#how-are-docstring-examples-recognized" title="Permalink to this headline">¶</a></h3>
In most cases a copy-and-paste of an interactive console session works fine,
but doctest isn&#8217;t trying to do an exact emulation of any specific Python shell.
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; # comments are ignored
&gt;&gt;&gt; x = 12
&gt;&gt;&gt; x
12
&gt;&gt;&gt; if x == 13:
... print &quot;yes&quot;
... else:
... print &quot;no&quot;
... print &quot;NO&quot;
... print &quot;NO!!!&quot;
...
no
NO
NO!!!
&gt;&gt;&gt;
</pre></div>
</div>
Any expected output must immediately follow the final <tt class="docutils literal">'&gt;&gt;&gt; '</tt> or <tt class="docutils literal">'... '</tt>
line containing the code, and the expected output (if any) extends to the next
<tt class="docutils literal">'&gt;&gt;&gt; '</tt> or all-whitespace line.
The fine print:
<ul>
<li>Expected output cannot contain an all-whitespace line, since such a line is
taken to signal the end of expected output. If expected output does contain a
blank line, put <tt class="docutils literal">&lt;BLANKLINE&gt;</tt> in your doctest example each place a blank line
is expected.

Changed in version 2.4: <tt class="docutils literal">&lt;BLANKLINE&gt;</tt> was added; there was no way to use expected output containing
empty lines in previous versions.
</li>
<li>All hard tab characters are expanded to spaces, using 8-column tab stops.
Tabs in output generated by the tested code are not modified. Because any
hard tabs in the sample output are expanded, this means that if the code
output includes hard tabs, the only way the doctest can pass is if the
<a title="doctest.NORMALIZE_WHITESPACE" class="reference internal" href="#doctest.NORMALIZE_WHITESPACE"><tt class="xref docutils literal">NORMALIZE_WHITESPACE</tt></a> option or directive is in effect.
Alternatively, the test can be rewritten to capture the output and compare it
to an expected value as part of the test. This handling of tabs in the
source was arrived at through trial and error, and has proven to be the least
error prone way of handling them. It is possible to use a different
algorithm for handling tabs by writing a custom <a title="doctest.DocTestParser" class="reference internal" href="#doctest.DocTestParser"><tt class="xref docutils literal">DocTestParser</tt></a> class.

Changed in version 2.4: Expanding tabs to spaces is new; previous versions tried to preserve hard tabs,
with confusing results.
</li>
<li>Output to stdout is captured, but not output to stderr (exception tracebacks
are captured via a different means).
</li>
<li>If you continue a line via backslashing in an interactive session, or for any
other reason use a backslash, you should use a raw docstring, which will
preserve your backslashes exactly as you type them:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; def f(x):
... r&#39;&#39;&#39;Backslashes in a raw docstring: m\n&#39;&#39;&#39;
&gt;&gt;&gt; print f.__doc__
Backslashes in a raw docstring: m\n
</pre></div>
</div>
Otherwise, the backslash will be interpreted as part of the string. For example,
the &#8220;\&#8221; above would be interpreted as a newline character. Alternatively, you
can double each backslash in the doctest version (and not use a raw string):
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; def f(x):
... &#39;&#39;&#39;Backslashes in a raw docstring: m\\n&#39;&#39;&#39;
&gt;&gt;&gt; print f.__doc__
Backslashes in a raw docstring: m\n
</pre></div>
</div>
</li>
<li>The starting column doesn&#8217;t matter:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; assert &quot;Easy!&quot;
 &gt;&gt;&gt; import math
 &gt;&gt;&gt; math.floor(1.9)
 1.0
</pre></div>
</div>
and as many leading whitespace characters are stripped from the expected output
as appeared in the initial <tt class="docutils literal">'&gt;&gt;&gt; '</tt> line that started the example.
</li>
</ul>
</div>
<div class="section" id="what-s-the-execution-context">
<h3>25.2.3.3. What&#8217;s the Execution Context?<a class="headerlink" href="#what-s-the-execution-context" title="Permalink to this headline">¶</a></h3>
By default, each time <tt class="xref docutils literal">doctest</tt> finds a docstring to test, it uses a
shallow copy of <tt class="xref docutils literal">M</tt>&#8216;s globals, so that running tests doesn&#8217;t change the
module&#8217;s real globals, and so that one test in <tt class="xref docutils literal">M</tt> can&#8217;t leave behind
crumbs that accidentally allow another test to work. This means examples can
freely use any names defined at top-level in <tt class="xref docutils literal">M</tt>, and names defined earlier
in the docstring being run. Examples cannot see names defined in other
docstrings.
You can force use of your own dict as the execution context by passing
<tt class="docutils literal">globs=your_dict</tt> to <a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a> or <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a> instead.
</div>
<div class="section" id="what-about-exceptions">
<h3>25.2.3.4. What About Exceptions?<a class="headerlink" href="#what-about-exceptions" title="Permalink to this headline">¶</a></h3>
No problem, provided that the traceback is the only output produced by the
example: just paste in the traceback. <a class="footnote-reference" href="#id2" id="id1">[1]</a> Since tracebacks contain details
that are likely to change rapidly (for example, exact file paths and line
numbers), this is one case where doctest works hard to be flexible in what it
accepts.
Simple example:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; [1, 2, 3].remove(42)
Traceback (most recent call last):
 File &quot;&lt;stdin&gt;&quot;, line 1, in ?
ValueError: list.remove(x): x not in list
</pre></div>
</div>
That doctest succeeds if <a title="exceptions.ValueError" class="reference external" href="exceptions.html#exceptions.ValueError"><tt class="xref docutils literal">ValueError</tt></a> is raised, with the <tt class="docutils literal">list.remove(x):
x not in list</tt> detail as shown.
The expected output for an exception must start with a traceback header, which
may be either of the following two lines, indented the same as the first line of
the example:
<div class="highlight-python"><pre>Traceback (most recent call last):
Traceback (innermost last):</pre>
</div>
The traceback header is followed by an optional traceback stack, whose contents
are ignored by doctest. The traceback stack is typically omitted, or copied
verbatim from an interactive session.
The traceback stack is followed by the most interesting part: the line(s)
containing the exception type and detail. This is usually the last line of a
traceback, but can extend across multiple lines if the exception has a
multi-line detail:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; raise ValueError(&#39;multi\n line\ndetail&#39;)
Traceback (most recent call last):
 File &quot;&lt;stdin&gt;&quot;, line 1, in ?
ValueError: multi
 line
detail
</pre></div>
</div>
The last three lines (starting with <a title="exceptions.ValueError" class="reference external" href="exceptions.html#exceptions.ValueError"><tt class="xref docutils literal">ValueError</tt></a>) are compared against the
exception&#8217;s type and detail, and the rest are ignored.
Best practice is to omit the traceback stack, unless it adds significant
documentation value to the example. So the last example is probably better as:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; raise ValueError(&#39;multi\n line\ndetail&#39;)
Traceback (most recent call last):
 ...
ValueError: multi
 line
detail
</pre></div>
</div>
Note that tracebacks are treated very specially. In particular, in the
rewritten example, the use of <tt class="docutils literal">...</tt> is independent of doctest&#8217;s
<a title="doctest.ELLIPSIS" class="reference internal" href="#doctest.ELLIPSIS"><tt class="xref docutils literal">ELLIPSIS</tt></a> option. The ellipsis in that example could be left out, or
could just as well be three (or three hundred) commas or digits, or an indented
transcript of a Monty Python skit.
Some details you should read once, but won&#8217;t need to remember:
<ul>
<li>Doctest can&#8217;t guess whether your expected output came from an exception
traceback or from ordinary printing. So, e.g., an example that expects
<tt class="docutils literal">ValueError: 42 is prime</tt> will pass whether <a title="exceptions.ValueError" class="reference external" href="exceptions.html#exceptions.ValueError"><tt class="xref docutils literal">ValueError</tt></a> is actually
raised or if the example merely prints that traceback text. In practice,
ordinary output rarely begins with a traceback header line, so this doesn&#8217;t
create real problems.
</li>
<li>Each line of the traceback stack (if present) must be indented further than
the first line of the example, or start with a non-alphanumeric character.
The first line following the traceback header indented the same and starting
with an alphanumeric is taken to be the start of the exception detail. Of
course this does the right thing for genuine tracebacks.
</li>
<li>When the <a title="doctest.IGNORE_EXCEPTION_DETAIL" class="reference internal" href="#doctest.IGNORE_EXCEPTION_DETAIL"><tt class="xref docutils literal">IGNORE_EXCEPTION_DETAIL</tt></a> doctest option is is specified,
everything following the leftmost colon is ignored.
</li>
<li>The interactive shell omits the traceback header line for some
<a title="exceptions.SyntaxError" class="reference external" href="exceptions.html#exceptions.SyntaxError"><tt class="xref docutils literal">SyntaxError</tt></a>s. But doctest uses the traceback header line to
distinguish exceptions from non-exceptions. So in the rare case where you need
to test a <a title="exceptions.SyntaxError" class="reference external" href="exceptions.html#exceptions.SyntaxError"><tt class="xref docutils literal">SyntaxError</tt></a> that omits the traceback header, you will need to
manually add the traceback header line to your test example.
</li>
<li>For some <a title="exceptions.SyntaxError" class="reference external" href="exceptions.html#exceptions.SyntaxError"><tt class="xref docutils literal">SyntaxError</tt></a>s, Python displays the character position of the
syntax error, using a <tt class="docutils literal">^</tt> marker:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; 1 1
 File &quot;&lt;stdin&gt;&quot;, line 1
 1 1
 ^
SyntaxError: invalid syntax
</pre></div>
</div>
Since the lines showing the position of the error come before the exception type
and detail, they are not checked by doctest. For example, the following test
would pass, even though it puts the <tt class="docutils literal">^</tt> marker in the wrong location:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; 1 1
 File &quot;&lt;stdin&gt;&quot;, line 1
 1 1
 ^
SyntaxError: invalid syntax
</pre></div>
</div>
</li>
</ul>

Changed in version 2.4: The ability to handle a multi-line exception detail, and the
<a title="doctest.IGNORE_EXCEPTION_DETAIL" class="reference internal" href="#doctest.IGNORE_EXCEPTION_DETAIL"><tt class="xref docutils literal">IGNORE_EXCEPTION_DETAIL</tt></a> doctest option, were added.
</div>
<div class="section" id="option-flags-and-directives">
<h3>25.2.3.5. Option Flags and Directives<a class="headerlink" href="#option-flags-and-directives" title="Permalink to this headline">¶</a></h3>
A number of option flags control various aspects of doctest&#8217;s behavior.
Symbolic names for the flags are supplied as module constants, which can be
or&#8217;ed together and passed to various functions. The names can also be used in
doctest directives (see below).
The first group of options define test semantics, controlling aspects of how
doctest decides whether actual output matches an example&#8217;s expected output:
<dl class="data">
<dt id="doctest.DONT_ACCEPT_TRUE_FOR_1">
<tt class="descclassname">doctest.</tt><tt class="descname">DONT_ACCEPT_TRUE_FOR_1</tt><a class="headerlink" href="#doctest.DONT_ACCEPT_TRUE_FOR_1" title="Permalink to this definition">¶</a></dt>
<dd>By default, if an expected output block contains just <tt class="docutils literal">1</tt>, an actual output
block containing just <tt class="docutils literal">1</tt> or just <tt class="xref docutils literal">True</tt> is considered to be a match, and
similarly for <tt class="docutils literal">0</tt> versus <tt class="xref docutils literal">False</tt>. When <a title="doctest.DONT_ACCEPT_TRUE_FOR_1" class="reference internal" href="#doctest.DONT_ACCEPT_TRUE_FOR_1"><tt class="xref docutils literal">DONT_ACCEPT_TRUE_FOR_1</tt></a> is
specified, neither substitution is allowed. The default behavior caters to that
Python changed the return type of many functions from integer to boolean;
doctests expecting &#8220;little integer&#8221; output still work in these cases. This
option will probably go away, but not for several years.</dd></dl>

<dl class="data">
<dt id="doctest.DONT_ACCEPT_BLANKLINE">
<tt class="descclassname">doctest.</tt><tt class="descname">DONT_ACCEPT_BLANKLINE</tt><a class="headerlink" href="#doctest.DONT_ACCEPT_BLANKLINE" title="Permalink to this definition">¶</a></dt>
<dd>By default, if an expected output block contains a line containing only the
string <tt class="docutils literal">&lt;BLANKLINE&gt;</tt>, then that line will match a blank line in the actual
output. Because a genuinely blank line delimits the expected output, this is
the only way to communicate that a blank line is expected. When
<a title="doctest.DONT_ACCEPT_BLANKLINE" class="reference internal" href="#doctest.DONT_ACCEPT_BLANKLINE"><tt class="xref docutils literal">DONT_ACCEPT_BLANKLINE</tt></a> is specified, this substitution is not allowed.</dd></dl>

<dl class="data">
<dt id="doctest.NORMALIZE_WHITESPACE">
<tt class="descclassname">doctest.</tt><tt class="descname">NORMALIZE_WHITESPACE</tt><a class="headerlink" href="#doctest.NORMALIZE_WHITESPACE" title="Permalink to this definition">¶</a></dt>
<dd>When specified, all sequences of whitespace (blanks and newlines) are treated as
equal. Any sequence of whitespace within the expected output will match any
sequence of whitespace within the actual output. By default, whitespace must
match exactly. <a title="doctest.NORMALIZE_WHITESPACE" class="reference internal" href="#doctest.NORMALIZE_WHITESPACE"><tt class="xref docutils literal">NORMALIZE_WHITESPACE</tt></a> is especially useful when a line of
expected output is very long, and you want to wrap it across multiple lines in
your source.</dd></dl>

<dl class="data">
<dt id="doctest.ELLIPSIS">
<tt class="descclassname">doctest.</tt><tt class="descname">ELLIPSIS</tt><a class="headerlink" href="#doctest.ELLIPSIS" title="Permalink to this definition">¶</a></dt>
<dd>When specified, an ellipsis marker (<tt class="docutils literal">...</tt>) in the expected output can match
any substring in the actual output. This includes substrings that span line
boundaries, and empty substrings, so it&#8217;s best to keep usage of this simple.
Complicated uses can lead to the same kinds of &#8220;oops, it matched too much!&#8221;
surprises that <tt class="docutils literal">.*</tt> is prone to in regular expressions.</dd></dl>

<dl class="data">
<dt id="doctest.IGNORE_EXCEPTION_DETAIL">
<tt class="descclassname">doctest.</tt><tt class="descname">IGNORE_EXCEPTION_DETAIL</tt><a class="headerlink" href="#doctest.IGNORE_EXCEPTION_DETAIL" title="Permalink to this definition">¶</a></dt>
<dd>When specified, an example that expects an exception passes if an exception of
the expected type is raised, even if the exception detail does not match. For
example, an example expecting <tt class="docutils literal">ValueError: 42</tt> will pass if the actual
exception raised is <tt class="docutils literal">ValueError: 3*14</tt>, but will fail, e.g., if
<a title="exceptions.TypeError" class="reference external" href="exceptions.html#exceptions.TypeError"><tt class="xref docutils literal">TypeError</tt></a> is raised.
Note that a similar effect can be obtained using <a title="doctest.ELLIPSIS" class="reference internal" href="#doctest.ELLIPSIS"><tt class="xref docutils literal">ELLIPSIS</tt></a>, and
<a title="doctest.IGNORE_EXCEPTION_DETAIL" class="reference internal" href="#doctest.IGNORE_EXCEPTION_DETAIL"><tt class="xref docutils literal">IGNORE_EXCEPTION_DETAIL</tt></a> may go away when Python releases prior to 2.4
become uninteresting. Until then, <a title="doctest.IGNORE_EXCEPTION_DETAIL" class="reference internal" href="#doctest.IGNORE_EXCEPTION_DETAIL"><tt class="xref docutils literal">IGNORE_EXCEPTION_DETAIL</tt></a> is the only
clear way to write a doctest that doesn&#8217;t care about the exception detail yet
continues to pass under Python releases prior to 2.4 (doctest directives appear
to be comments to them). For example,
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; (1, 2)[3] = &#39;moo&#39; #doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
 File &quot;&lt;stdin&gt;&quot;, line 1, in ?
TypeError: object doesn&#39;t support item assignment
</pre></div>
</div>
passes under Python 2.4 and Python 2.3. The detail changed in 2.4, to say &#8220;does
not&#8221; instead of &#8220;doesn&#8217;t&#8221;.
</dd></dl>

<dl class="data">
<dt id="doctest.SKIP">
<tt class="descclassname">doctest.</tt><tt class="descname">SKIP</tt><a class="headerlink" href="#doctest.SKIP" title="Permalink to this definition">¶</a></dt>
<dd>When specified, do not run the example at all. This can be useful in contexts
where doctest examples serve as both documentation and test cases, and an
example should be included for documentation purposes, but should not be
checked. E.g., the example&#8217;s output might be random; or the example might
depend on resources which would be unavailable to the test driver.
The SKIP flag can also be used for temporarily &#8220;commenting out&#8221; examples.
</dd></dl>

<dl class="data">
<dt id="doctest.COMPARISON_FLAGS">
<tt class="descclassname">doctest.</tt><tt class="descname">COMPARISON_FLAGS</tt><a class="headerlink" href="#doctest.COMPARISON_FLAGS" title="Permalink to this definition">¶</a></dt>
<dd>A bitmask or&#8217;ing together all the comparison flags above.</dd></dl>

The second group of options controls how test failures are reported:
<dl class="data">
<dt id="doctest.REPORT_UDIFF">
<tt class="descclassname">doctest.</tt><tt class="descname">REPORT_UDIFF</tt><a class="headerlink" href="#doctest.REPORT_UDIFF" title="Permalink to this definition">¶</a></dt>
<dd>When specified, failures that involve multi-line expected and actual outputs are
displayed using a unified diff.</dd></dl>

<dl class="data">
<dt id="doctest.REPORT_CDIFF">
<tt class="descclassname">doctest.</tt><tt class="descname">REPORT_CDIFF</tt><a class="headerlink" href="#doctest.REPORT_CDIFF" title="Permalink to this definition">¶</a></dt>
<dd>When specified, failures that involve multi-line expected and actual outputs
will be displayed using a context diff.</dd></dl>

<dl class="data">
<dt id="doctest.REPORT_NDIFF">
<tt class="descclassname">doctest.</tt><tt class="descname">REPORT_NDIFF</tt><a class="headerlink" href="#doctest.REPORT_NDIFF" title="Permalink to this definition">¶</a></dt>
<dd>When specified, differences are computed by <tt class="docutils literal">difflib.Differ</tt>, using the same
algorithm as the popular <tt class="docutils literal">ndiff.py</tt> utility. This is the only method that
marks differences within lines as well as across lines. For example, if a line
of expected output contains digit <tt class="docutils literal">1</tt> where actual output contains letter
<tt class="docutils literal">l</tt>, a line is inserted with a caret marking the mismatching column positions.</dd></dl>

<dl class="data">
<dt id="doctest.REPORT_ONLY_FIRST_FAILURE">
<tt class="descclassname">doctest.</tt><tt class="descname">REPORT_ONLY_FIRST_FAILURE</tt><a class="headerlink" href="#doctest.REPORT_ONLY_FIRST_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd>When specified, display the first failing example in each doctest, but suppress
output for all remaining examples. This will prevent doctest from reporting
correct examples that break because of earlier failures; but it might also hide
incorrect examples that fail independently of the first failure. When
<a title="doctest.REPORT_ONLY_FIRST_FAILURE" class="reference internal" href="#doctest.REPORT_ONLY_FIRST_FAILURE"><tt class="xref docutils literal">REPORT_ONLY_FIRST_FAILURE</tt></a> is specified, the remaining examples are
still run, and still count towards the total number of failures reported; only
the output is suppressed.</dd></dl>

<dl class="data">
<dt id="doctest.REPORTING_FLAGS">
<tt class="descclassname">doctest.</tt><tt class="descname">REPORTING_FLAGS</tt><a class="headerlink" href="#doctest.REPORTING_FLAGS" title="Permalink to this definition">¶</a></dt>
<dd>A bitmask or&#8217;ing together all the reporting flags above.</dd></dl>

&#8220;Doctest directives&#8221; may be used to modify the option flags for individual
examples. Doctest directives are expressed as a special Python comment
following an example&#8217;s source code:
<pre>
directive ::= &quot;#&quot; &quot;doctest:&quot; <a class="reference internal" href="#grammar-token-directive_options"><tt class="xref docutils literal">directive_options</tt></a>
directive_options ::= <a class="reference internal" href="#grammar-token-directive_option"><tt class="xref docutils literal">directive_option</tt></a> (&quot;,&quot; <a class="reference internal" href="#grammar-token-directive_option"><tt class="xref docutils literal">directive_option</tt></a>)\*
directive_option ::= <a class="reference internal" href="#grammar-token-on_or_off"><tt class="xref docutils literal">on_or_off</tt></a> <a class="reference internal" href="#grammar-token-directive_option_name"><tt class="xref docutils literal">directive_option_name</tt></a>
on_or_off ::= &quot;+&quot; \| &quot;-&quot;
directive_option_name ::= &quot;DONT_ACCEPT_BLANKLINE&quot; \| &quot;NORMALIZE_WHITESPACE&quot; \| ...
</pre>
Whitespace is not allowed between the <tt class="docutils literal">+</tt> or <tt class="docutils literal">-</tt> and the directive option
name. The directive option name can be any of the option flag names explained
above.
An example&#8217;s doctest directives modify doctest&#8217;s behavior for that single
example. Use <tt class="docutils literal">+</tt> to enable the named behavior, or <tt class="docutils literal">-</tt> to disable it.
For example, this test passes:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; print range(20) #doctest: +NORMALIZE_WHITESPACE
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9,
10, 11, 12, 13, 14, 15, 16, 17, 18, 19]
</pre></div>
</div>
Without the directive it would fail, both because the actual output doesn&#8217;t have
two blanks before the single-digit list elements, and because the actual output
is on a single line. This test also passes, and also requires a directive to do
so:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; print range(20) # doctest:+ELLIPSIS
[0, 1, ..., 18, 19]
</pre></div>
</div>
Multiple directives can be used on a single physical line, separated by commas:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; print range(20) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
[0, 1, ..., 18, 19]
</pre></div>
</div>
If multiple directive comments are used for a single example, then they are
combined:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; print range(20) # doctest: +ELLIPSIS
... # doctest: +NORMALIZE_WHITESPACE
[0, 1, ..., 18, 19]
</pre></div>
</div>
As the previous example shows, you can add <tt class="docutils literal">...</tt> lines to your example
containing only directives. This can be useful when an example is too long for
a directive to comfortably fit on the same line:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; print range(5) + range(10,20) + range(30,40) + range(50,60)
... # doctest: +ELLIPSIS
[0, ..., 4, 10, ..., 19, 30, ..., 39, 50, ..., 59]
</pre></div>
</div>
Note that since all options are disabled by default, and directives apply only
to the example they appear in, enabling options (via <tt class="docutils literal">+</tt> in a directive) is
usually the only meaningful choice. However, option flags can also be passed to
functions that run doctests, establishing different defaults. In such cases,
disabling an option via <tt class="docutils literal">-</tt> in a directive can be useful.

Changed in version 2.4: Constants <a title="doctest.DONT_ACCEPT_BLANKLINE" class="reference internal" href="#doctest.DONT_ACCEPT_BLANKLINE"><tt class="xref docutils literal">DONT_ACCEPT_BLANKLINE</tt></a>, <a title="doctest.NORMALIZE_WHITESPACE" class="reference internal" href="#doctest.NORMALIZE_WHITESPACE"><tt class="xref docutils literal">NORMALIZE_WHITESPACE</tt></a>,
<a title="doctest.ELLIPSIS" class="reference internal" href="#doctest.ELLIPSIS"><tt class="xref docutils literal">ELLIPSIS</tt></a>, <a title="doctest.IGNORE_EXCEPTION_DETAIL" class="reference internal" href="#doctest.IGNORE_EXCEPTION_DETAIL"><tt class="xref docutils literal">IGNORE_EXCEPTION_DETAIL</tt></a>, <a title="doctest.REPORT_UDIFF" class="reference internal" href="#doctest.REPORT_UDIFF"><tt class="xref docutils literal">REPORT_UDIFF</tt></a>,
<a title="doctest.REPORT_CDIFF" class="reference internal" href="#doctest.REPORT_CDIFF"><tt class="xref docutils literal">REPORT_CDIFF</tt></a>, <a title="doctest.REPORT_NDIFF" class="reference internal" href="#doctest.REPORT_NDIFF"><tt class="xref docutils literal">REPORT_NDIFF</tt></a>,
<a title="doctest.REPORT_ONLY_FIRST_FAILURE" class="reference internal" href="#doctest.REPORT_ONLY_FIRST_FAILURE"><tt class="xref docutils literal">REPORT_ONLY_FIRST_FAILURE</tt></a>, <a title="doctest.COMPARISON_FLAGS" class="reference internal" href="#doctest.COMPARISON_FLAGS"><tt class="xref docutils literal">COMPARISON_FLAGS</tt></a> and
<a title="doctest.REPORTING_FLAGS" class="reference internal" href="#doctest.REPORTING_FLAGS"><tt class="xref docutils literal">REPORTING_FLAGS</tt></a> were added; by default <tt class="docutils literal">&lt;BLANKLINE&gt;</tt> in expected
output matches an empty line in actual output; and doctest directives were
added.

Changed in version 2.5: Constant <a title="doctest.SKIP" class="reference internal" href="#doctest.SKIP"><tt class="xref docutils literal">SKIP</tt></a> was added.
There&#8217;s also a way to register new option flag names, although this isn&#8217;t useful
unless you intend to extend <tt class="xref docutils literal">doctest</tt> internals via subclassing:
<dl class="function">
<dt id="doctest.register_optionflag">
<tt class="descclassname">doctest.</tt><tt class="descname">register_optionflag</tt><big>(</big>name<big>)</big><a class="headerlink" href="#doctest.register_optionflag" title="Permalink to this definition">¶</a></dt>
<dd>Create a new option flag with a given name, and return the new flag&#8217;s integer
value. <a title="doctest.register_optionflag" class="reference internal" href="#doctest.register_optionflag"><tt class="xref docutils literal">register_optionflag()</tt></a> can be used when subclassing
<a title="doctest.OutputChecker" class="reference internal" href="#doctest.OutputChecker"><tt class="xref docutils literal">OutputChecker</tt></a> or <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> to create new options that are
supported by your subclasses. <a title="doctest.register_optionflag" class="reference internal" href="#doctest.register_optionflag"><tt class="xref docutils literal">register_optionflag()</tt></a> should always be
called using the following idiom:
<div class="highlight-python"><div class="highlight"><pre>MY_FLAG = register_optionflag(&#39;MY_FLAG&#39;)
</pre></div>
</div>

New in version 2.4.
</dd></dl>

</div>
<div class="section" id="warnings">
<h3>25.2.3.6. Warnings<a class="headerlink" href="#warnings" title="Permalink to this headline">¶</a></h3>
<tt class="xref docutils literal">doctest</tt> is serious about requiring exact matches in expected output. If
even a single character doesn&#8217;t match, the test fails. This will probably
surprise you a few times, as you learn exactly what Python does and doesn&#8217;t
guarantee about output. For example, when printing a dict, Python doesn&#8217;t
guarantee that the key-value pairs will be printed in any particular order, so a
test like
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; foo()
{&quot;Hermione&quot;: &quot;hippogryph&quot;, &quot;Harry&quot;: &quot;broomstick&quot;}
</pre></div>
</div>
is vulnerable! One workaround is to do
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; foo() == {&quot;Hermione&quot;: &quot;hippogryph&quot;, &quot;Harry&quot;: &quot;broomstick&quot;}
True
</pre></div>
</div>
instead. Another is to do
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; d = foo().items()
&gt;&gt;&gt; d.sort()
&gt;&gt;&gt; d
[(&#39;Harry&#39;, &#39;broomstick&#39;), (&#39;Hermione&#39;, &#39;hippogryph&#39;)]
</pre></div>
</div>
There are others, but you get the idea.
Another bad idea is to print things that embed an object address, like
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; id(1.0) # certain to fail some of the time
7948648
&gt;&gt;&gt; class C: pass
&gt;&gt;&gt; C() # the default repr() for instances embeds an address
&lt;__main__.C instance at 0x00AC18F0&gt;
</pre></div>
</div>
The <a title="doctest.ELLIPSIS" class="reference internal" href="#doctest.ELLIPSIS"><tt class="xref docutils literal">ELLIPSIS</tt></a> directive gives a nice approach for the last example:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; C() #doctest: +ELLIPSIS
&lt;__main__.C instance at 0x...&gt;
</pre></div>
</div>
Floating-point numbers are also subject to small output variations across
platforms, because Python defers to the platform C library for float formatting,
and C libraries vary widely in quality here.
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; 1./7 # risky
0.14285714285714285
&gt;&gt;&gt; print 1./7 # safer
0.142857142857
&gt;&gt;&gt; print round(1./7, 6) # much safer
0.142857
</pre></div>
</div>
Numbers of the form <tt class="docutils literal">I/2.**J</tt> are safe across all platforms, and I often
contrive doctest examples to produce numbers of that form:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; 3./4 # utterly safe
0.75
</pre></div>
</div>
Simple fractions are also easier for people to understand, and that makes for
better documentation.
</div>
</div>
<div class="section" id="basic-api">
<h2>25.2.4. Basic API<a class="headerlink" href="#basic-api" title="Permalink to this headline">¶</a></h2>
The functions <a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a> and <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a> provide a simple interface to
doctest that should be sufficient for most basic uses. For a less formal
introduction to these two functions, see sections <a class="reference internal" href="#doctest-simple-testmod">Simple Usage: Checking Examples in Docstrings</a>
and <a class="reference internal" href="#doctest-simple-testfile">Simple Usage: Checking Examples in a Text File</a>.
<dl class="function">
<dt id="doctest.testfile">
<tt class="descclassname">doctest.</tt><tt class="descname">testfile</tt><big>(</big>filename[, module_relative][, name][, package][, globs][, verbose][, report][, optionflags][, extraglobs][, raise_on_error][, parser][, encoding]<big>)</big><a class="headerlink" href="#doctest.testfile" title="Permalink to this definition">¶</a></dt>
<dd>All arguments except filename are optional, and should be specified in keyword
form.
Test examples in the file named filename. Return <tt class="docutils literal">(failure_count,
test_count)</tt>.
Optional argument module_relative specifies how the filename should be
interpreted:
<ul class="simple">
<li>If module_relative is <tt class="xref docutils literal">True</tt> (the default), then filename specifies an
OS-independent module-relative path. By default, this path is relative to the
calling module&#8217;s directory; but if the package argument is specified, then it
is relative to that package. To ensure OS-independence, filename should use
<tt class="docutils literal">/</tt> characters to separate path segments, and may not be an absolute path
(i.e., it may not begin with <tt class="docutils literal">/</tt>).</li>
<li>If module_relative is <tt class="xref docutils literal">False</tt>, then filename specifies an OS-specific
path. The path may be absolute or relative; relative paths are resolved with
respect to the current working directory.</li>
</ul>
Optional argument name gives the name of the test; by default, or if <tt class="xref docutils literal">None</tt>,
<tt class="docutils literal">os.path.basename(filename)</tt> is used.
Optional 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&#8217;s directory is
used as the base directory for module-relative filenames. It is an error to
specify package if module_relative is <tt class="xref docutils literal">False</tt>.
Optional argument globs gives a dict to be used as the globals when executing
examples. A new shallow copy of this dict is created for the doctest, so its
examples start with a clean slate. By default, or if <tt class="xref docutils literal">None</tt>, a new empty dict
is used.
Optional argument extraglobs gives a dict merged into the globals used to
execute examples. This works like <a title="dict.update" class="reference external" href="stdtypes.html#dict.update"><tt class="xref docutils literal">dict.update()</tt></a>: if globs and
extraglobs have a common key, the associated value in extraglobs appears in
the combined dict. By default, or if <tt class="xref docutils literal">None</tt>, no extra globals are used. This
is an advanced feature that allows parameterization of doctests. For example, a
doctest can be written for a base class, using a generic name for the class,
then reused to test any number of subclasses by passing an extraglobs dict
mapping the generic name to the subclass to be tested.
Optional argument verbose prints lots of stuff if true, and prints only
failures if false; by default, or if <tt class="xref docutils literal">None</tt>, it&#8217;s true if and only if <tt class="docutils literal">'-v'</tt>
is in <tt class="docutils literal">sys.argv</tt>.
Optional argument report prints a summary at the end when true, else prints
nothing at the end. In verbose mode, the summary is detailed, else the summary
is very brief (in fact, empty if all tests passed).
Optional argument optionflags or&#8217;s together option flags. See section
<a class="reference internal" href="#doctest-options">Option Flags and Directives</a>.
Optional argument raise_on_error defaults to false. If true, an exception is
raised upon the first failure or unexpected exception in an example. This
allows failures to be post-mortem debugged. Default behavior is to continue
running examples.
Optional argument parser specifies a <a title="doctest.DocTestParser" class="reference internal" href="#doctest.DocTestParser"><tt class="xref docutils literal">DocTestParser</tt></a> (or subclass) that
should be used to extract tests from the files. It defaults to a normal parser
(i.e., <tt class="docutils literal">DocTestParser()</tt>).
Optional argument encoding specifies an encoding that should be used to
convert the file to unicode.

New in version 2.4.

Changed in version 2.5: The parameter encoding was added.
</dd></dl>

<dl class="function">
<dt id="doctest.testmod">
<tt class="descclassname">doctest.</tt><tt class="descname">testmod</tt><big>(</big>[m][, name][, globs][, verbose][, report][, optionflags][, extraglobs][, raise_on_error][, exclude_empty]<big>)</big><a class="headerlink" href="#doctest.testmod" title="Permalink to this definition">¶</a></dt>
<dd>All arguments are optional, and all except for m should be specified in
keyword form.
Test examples in docstrings in functions and classes reachable from module m
(or module <a title="The environment where the top-level script is run." class="reference external" href="__main__.html#module-__main__"><tt class="xref docutils literal">__main__</tt></a> if m is not supplied or is <tt class="xref docutils literal">None</tt>), starting with
<tt class="docutils literal">m.__doc__</tt>.
Also test examples reachable from dict <tt class="docutils literal">m.__test__</tt>, if it exists and is not
<tt class="xref docutils literal">None</tt>. <tt class="docutils literal">m.__test__</tt> maps names (strings) to functions, classes and
strings; function and class docstrings are searched for examples; strings are
searched directly, as if they were docstrings.
Only docstrings attached to objects belonging to module m are searched.
Return <tt class="docutils literal">(failure_count, test_count)</tt>.
Optional argument name gives the name of the module; by default, or if
<tt class="xref docutils literal">None</tt>, <tt class="docutils literal">m.__name__</tt> is used.
Optional argument exclude_empty defaults to false. If true, objects for which
no doctests are found are excluded from consideration. The default is a backward
compatibility hack, so that code still using <tt class="xref docutils literal">doctest.master.summarize()</tt> in
conjunction with <a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a> continues to get output for objects with no
tests. The exclude_empty argument to the newer <a title="doctest.DocTestFinder" class="reference internal" href="#doctest.DocTestFinder"><tt class="xref docutils literal">DocTestFinder</tt></a>
constructor defaults to true.
Optional arguments extraglobs, verbose, report, optionflags,
raise_on_error, and globs are the same as for function <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a>
above, except that globs defaults to <tt class="docutils literal">m.__dict__</tt>.

Changed in version 2.3: The parameter optionflags was added.

Changed in version 2.4: The parameters extraglobs, raise_on_error and exclude_empty were added.

Changed in version 2.5: The optional argument isprivate, deprecated in 2.4, was removed.
</dd></dl>

There&#8217;s also a function to run the doctests associated with a single object.
This function is provided for backward compatibility. There are no plans to
deprecate it, but it&#8217;s rarely useful:
<dl class="function">
<dt id="doctest.run_docstring_examples">
<tt class="descclassname">doctest.</tt><tt class="descname">run_docstring_examples</tt><big>(</big>f, globs[, verbose][, name][, compileflags][, optionflags]<big>)</big><a class="headerlink" href="#doctest.run_docstring_examples" title="Permalink to this definition">¶</a></dt>
<dd>Test examples associated with object f; for example, f may be a module,
function, or class object.
A shallow copy of dictionary argument globs is used for the execution context.
Optional argument name is used in failure messages, and defaults to
<tt class="docutils literal">&quot;NoName&quot;</tt>.
If optional argument verbose is true, output is generated even if there are no
failures. By default, output is generated only in case of an example failure.
Optional argument compileflags gives the set of flags that should be used by
the Python compiler when running the examples. By default, or if <tt class="xref docutils literal">None</tt>,
flags are deduced corresponding to the set of future features found in globs.
Optional argument optionflags works as for function <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a> above.
</dd></dl>

</div>
<div class="section" id="unittest-api">
<h2>25.2.5. Unittest API<a class="headerlink" href="#unittest-api" title="Permalink to this headline">¶</a></h2>
As your collection of doctest&#8217;ed modules grows, you&#8217;ll want a way to run all
their doctests systematically. Prior to Python 2.4, <tt class="xref docutils literal">doctest</tt> had a barely
documented <tt class="xref docutils literal">Tester</tt> class that supplied a rudimentary way to combine
doctests from multiple modules. <tt class="xref docutils literal">Tester</tt> was feeble, and in practice most
serious Python testing frameworks build on the <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> module, which
supplies many flexible ways to combine tests from multiple sources. So, in
Python 2.4, <tt class="xref docutils literal">doctest</tt>&#8216;s <tt class="xref docutils literal">Tester</tt> class is deprecated, and
<tt class="xref docutils literal">doctest</tt> provides two functions that can be used to create <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a>
test suites from modules and text files containing doctests. These test suites
can then be run using <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> test runners:
<div class="highlight-python"><div class="highlight"><pre>import unittest
import doctest
import my_module_with_doctests, and_another

suite = unittest.TestSuite()
for mod in my_module_with_doctests, and_another:
 suite.addTest(doctest.DocTestSuite(mod))
runner = unittest.TextTestRunner()
runner.run(suite)
</pre></div>
</div>
There are two main functions for creating <a title="unittest.TestSuite" class="reference external" href="unittest.html#unittest.TestSuite"><tt class="xref docutils literal">unittest.TestSuite</tt></a> instances
from text files and modules with doctests:
<dl class="function">
<dt id="doctest.DocFileSuite">
<tt class="descclassname">doctest.</tt><tt class="descname">DocFileSuite</tt><big>(</big>*paths[, module_relative][, package][, setUp][, tearDown][, globs][, optionflags][, parser][, encoding]<big>)</big><a class="headerlink" href="#doctest.DocFileSuite" title="Permalink to this definition">¶</a></dt>
<dd>Convert doctest tests from one or more text files to a
<a title="unittest.TestSuite" class="reference external" href="unittest.html#unittest.TestSuite"><tt class="xref docutils literal">unittest.TestSuite</tt></a>.
The returned <a title="unittest.TestSuite" class="reference external" href="unittest.html#unittest.TestSuite"><tt class="xref docutils literal">unittest.TestSuite</tt></a> is to be run by the unittest framework
and runs the interactive examples in each file. If an example in any file
fails, then the synthesized unit test fails, and a <tt class="xref docutils literal">failureException</tt>
exception is raised showing the name of the file containing the test and a
(sometimes approximate) line number.
Pass one or more paths (as strings) to text files to be examined.
Options may be provided as keyword arguments:
Optional argument module_relative specifies how the filenames in paths
should be interpreted:
<ul class="simple">
<li>If module_relative is <tt class="xref docutils literal">True</tt> (the default), then each filename in
paths specifies an OS-independent module-relative path. By default, this
path is relative to the calling module&#8217;s directory; but if the package
argument is specified, then it is relative to that package. To ensure
OS-independence, each filename should use <tt class="docutils literal">/</tt> characters to separate path
segments, and may not be an absolute path (i.e., it may not begin with
<tt class="docutils literal">/</tt>).</li>
<li>If module_relative is <tt class="xref docutils literal">False</tt>, then each filename in paths specifies
an OS-specific path. The path may be absolute or relative; relative paths
are resolved with respect to the current working directory.</li>
</ul>
Optional argument package is a Python package or the name of a Python
package whose directory should be used as the base directory for
module-relative filenames in paths. If no package is specified, then the
calling module&#8217;s directory is used as the base directory for module-relative
filenames. It is an error to specify package if module_relative is
<tt class="xref docutils literal">False</tt>.
Optional argument setUp specifies a set-up function for the test suite.
This is called before running the tests in each file. The setUp function
will be passed a <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> object. The setUp function can access the
test globals as the globs attribute of the test passed.
Optional argument tearDown specifies a tear-down function for the test
suite. This is called after running the tests in each file. The tearDown
function will be passed a <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> object. The setUp function can
access the test globals as the globs attribute of the test passed.
Optional argument globs is a dictionary containing the initial global
variables for the tests. A new copy of this dictionary is created for each
test. By default, globs is a new empty dictionary.
Optional argument optionflags specifies the default doctest options for the
tests, created by or-ing together individual option flags. See section
<a class="reference internal" href="#doctest-options">Option Flags and Directives</a>. See function <a title="doctest.set_unittest_reportflags" class="reference internal" href="#doctest.set_unittest_reportflags"><tt class="xref docutils literal">set_unittest_reportflags()</tt></a> below
for a better way to set reporting options.
Optional argument parser specifies a <a title="doctest.DocTestParser" class="reference internal" href="#doctest.DocTestParser"><tt class="xref docutils literal">DocTestParser</tt></a> (or subclass)
that should be used to extract tests from the files. It defaults to a normal
parser (i.e., <tt class="docutils literal">DocTestParser()</tt>).
Optional argument encoding specifies an encoding that should be used to
convert the file to unicode.

New in version 2.4.

Changed in version 2.5: The global <tt class="docutils literal">__file__</tt> was added to the globals provided to doctests
loaded from a text file using <a title="doctest.DocFileSuite" class="reference internal" href="#doctest.DocFileSuite"><tt class="xref docutils literal">DocFileSuite()</tt></a>.

Changed in version 2.5: The parameter encoding was added.
</dd></dl>

<dl class="function">
<dt id="doctest.DocTestSuite">
<tt class="descclassname">doctest.</tt><tt class="descname">DocTestSuite</tt><big>(</big>[module][, globs][, extraglobs][, test_finder][, setUp][, tearDown][, checker]<big>)</big><a class="headerlink" href="#doctest.DocTestSuite" title="Permalink to this definition">¶</a></dt>
<dd>Convert doctest tests for a module to a <a title="unittest.TestSuite" class="reference external" href="unittest.html#unittest.TestSuite"><tt class="xref docutils literal">unittest.TestSuite</tt></a>.
The returned <a title="unittest.TestSuite" class="reference external" href="unittest.html#unittest.TestSuite"><tt class="xref docutils literal">unittest.TestSuite</tt></a> is to be run by the unittest framework
and runs each doctest in the module. If any of the doctests fail, then the
synthesized unit test fails, and a <tt class="xref docutils literal">failureException</tt> exception is raised
showing the name of the file containing the test and a (sometimes approximate)
line number.
Optional argument module provides the module to be tested. It can be a module
object or a (possibly dotted) module name. If not specified, the module calling
this function is used.
Optional argument globs is a dictionary containing the initial global
variables for the tests. A new copy of this dictionary is created for each
test. By default, globs is a new empty dictionary.
Optional argument extraglobs specifies an extra set of global variables, which
is merged into globs. By default, no extra globals are used.
Optional argument test_finder is the <a title="doctest.DocTestFinder" class="reference internal" href="#doctest.DocTestFinder"><tt class="xref docutils literal">DocTestFinder</tt></a> object (or a
drop-in replacement) that is used to extract doctests from the module.
Optional arguments setUp, tearDown, and optionflags are the same as for
function <a title="doctest.DocFileSuite" class="reference internal" href="#doctest.DocFileSuite"><tt class="xref docutils literal">DocFileSuite()</tt></a> above.

New in version 2.3.

Changed in version 2.4: The parameters globs, extraglobs, test_finder, setUp, tearDown, and
optionflags were added; this function now uses the same search technique as
<a title="doctest.testmod" class="reference internal" href="#doctest.testmod"><tt class="xref docutils literal">testmod()</tt></a>.
</dd></dl>

Under the covers, <a title="doctest.DocTestSuite" class="reference internal" href="#doctest.DocTestSuite"><tt class="xref docutils literal">DocTestSuite()</tt></a> creates a <a title="unittest.TestSuite" class="reference external" href="unittest.html#unittest.TestSuite"><tt class="xref docutils literal">unittest.TestSuite</tt></a> out
of <tt class="xref docutils literal">doctest.DocTestCase</tt> instances, and <tt class="xref docutils literal">DocTestCase</tt> is a
subclass of <a title="unittest.TestCase" class="reference external" href="unittest.html#unittest.TestCase"><tt class="xref docutils literal">unittest.TestCase</tt></a>. <tt class="xref docutils literal">DocTestCase</tt> isn&#8217;t documented
here (it&#8217;s an internal detail), but studying its code can answer questions about
the exact details of <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> integration.
Similarly, <a title="doctest.DocFileSuite" class="reference internal" href="#doctest.DocFileSuite"><tt class="xref docutils literal">DocFileSuite()</tt></a> creates a <a title="unittest.TestSuite" class="reference external" href="unittest.html#unittest.TestSuite"><tt class="xref docutils literal">unittest.TestSuite</tt></a> out of
<tt class="xref docutils literal">doctest.DocFileCase</tt> instances, and <tt class="xref docutils literal">DocFileCase</tt> is a subclass
of <tt class="xref docutils literal">DocTestCase</tt>.
So both ways of creating a <a title="unittest.TestSuite" class="reference external" href="unittest.html#unittest.TestSuite"><tt class="xref docutils literal">unittest.TestSuite</tt></a> run instances of
<tt class="xref docutils literal">DocTestCase</tt>. This is important for a subtle reason: when you run
<tt class="xref docutils literal">doctest</tt> functions yourself, you can control the <tt class="xref docutils literal">doctest</tt> options in
use directly, by passing option flags to <tt class="xref docutils literal">doctest</tt> functions. However, if
you&#8217;re writing a <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> framework, <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> ultimately controls
when and how tests get run. The framework author typically wants to control
<tt class="xref docutils literal">doctest</tt> reporting options (perhaps, e.g., specified by command line
options), but there&#8217;s no way to pass options through <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> to
<tt class="xref docutils literal">doctest</tt> test runners.
For this reason, <tt class="xref docutils literal">doctest</tt> also supports a notion of <tt class="xref docutils literal">doctest</tt>
reporting flags specific to <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> support, via this function:
<dl class="function">
<dt id="doctest.set_unittest_reportflags">
<tt class="descclassname">doctest.</tt><tt class="descname">set_unittest_reportflags</tt><big>(</big>flags<big>)</big><a class="headerlink" href="#doctest.set_unittest_reportflags" title="Permalink to this definition">¶</a></dt>
<dd>Set the <tt class="xref docutils literal">doctest</tt> reporting flags to use.
Argument flags or&#8217;s together option flags. See section
<a class="reference internal" href="#doctest-options">Option Flags and Directives</a>. Only &#8220;reporting flags&#8221; can be used.
This is a module-global setting, and affects all future doctests run by module
<a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a>: the <tt class="xref docutils literal">runTest()</tt> method of <tt class="xref docutils literal">DocTestCase</tt> looks at
the option flags specified for the test case when the <tt class="xref docutils literal">DocTestCase</tt>
instance was constructed. If no reporting flags were specified (which is the
typical and expected case), <tt class="xref docutils literal">doctest</tt>&#8216;s <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> reporting flags are
or&#8217;ed into the option flags, and the option flags so augmented are passed to the
<a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> instance created to run the doctest. If any reporting
flags were specified when the <tt class="xref docutils literal">DocTestCase</tt> instance was constructed,
<tt class="xref docutils literal">doctest</tt>&#8216;s <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> reporting flags are ignored.
The value of the <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> reporting flags in effect before the function
was called is returned by the function.

New in version 2.4.
</dd></dl>

</div>
<div class="section" id="advanced-api">
<h2>25.2.6. Advanced API<a class="headerlink" href="#advanced-api" title="Permalink to this headline">¶</a></h2>
The basic API is a simple wrapper that&#8217;s intended to make doctest easy to use.
It is fairly flexible, and should meet most users&#8217; needs; however, if you
require more fine-grained control over testing, or wish to extend doctest&#8217;s
capabilities, then you should use the advanced API.
The advanced API revolves around two container classes, which are used to store
the interactive examples extracted from doctest cases:
<ul class="simple">
<li><a title="doctest.Example" class="reference internal" href="#doctest.Example"><tt class="xref docutils literal">Example</tt></a>: A single Python <a class="reference external" href="../glossary.html#term-statement">statement</a>, paired with its expected
output.</li>
<li><a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a>: A collection of <a title="doctest.Example" class="reference internal" href="#doctest.Example"><tt class="xref docutils literal">Example</tt></a>s, typically extracted
from a single docstring or text file.</li>
</ul>
Additional processing classes are defined to find, parse, and run, and check
doctest examples:
<ul class="simple">
<li><a title="doctest.DocTestFinder" class="reference internal" href="#doctest.DocTestFinder"><tt class="xref docutils literal">DocTestFinder</tt></a>: Finds all docstrings in a given module, and uses a
<a title="doctest.DocTestParser" class="reference internal" href="#doctest.DocTestParser"><tt class="xref docutils literal">DocTestParser</tt></a> to create a <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> from every docstring that
contains interactive examples.</li>
<li><a title="doctest.DocTestParser" class="reference internal" href="#doctest.DocTestParser"><tt class="xref docutils literal">DocTestParser</tt></a>: Creates a <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> object from a string (such
as an object&#8217;s docstring).</li>
<li><a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a>: Executes the examples in a <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a>, and uses
an <a title="doctest.OutputChecker" class="reference internal" href="#doctest.OutputChecker"><tt class="xref docutils literal">OutputChecker</tt></a> to verify their output.</li>
<li><a title="doctest.OutputChecker" class="reference internal" href="#doctest.OutputChecker"><tt class="xref docutils literal">OutputChecker</tt></a>: Compares the actual output from a doctest example with
the expected output, and decides whether they match.</li>
</ul>
The relationships among these processing classes are summarized in the following
diagram:
<div class="highlight-python"><pre> list of:
+------+ +---------+
|module| --DocTestFinder-&gt; | DocTest | --DocTestRunner-&gt; results
+------+ | ^ +---------+ | ^ (printed)
 | | | Example | | |
 v | | ... | v |
 DocTestParser | Example | OutputChecker
 +---------+</pre>
</div>
<div class="section" id="doctest-objects">
<h3>25.2.6.1. DocTest Objects<a class="headerlink" href="#doctest-objects" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="doctest.DocTest">
class <tt class="descclassname">doctest.</tt><tt class="descname">DocTest</tt><big>(</big>examples, globs, name, filename, lineno, docstring<big>)</big><a class="headerlink" href="#doctest.DocTest" title="Permalink to this definition">¶</a></dt>
<dd>A collection of doctest examples that should be run in a single namespace. The
constructor arguments are used to initialize the member variables of the same
names.

New in version 2.4.
<a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> defines the following member variables. They are initialized by
the constructor, and should not be modified directly.
<dl class="attribute">
<dt id="doctest.DocTest.examples">
<tt class="descname">examples</tt><a class="headerlink" href="#doctest.DocTest.examples" title="Permalink to this definition">¶</a></dt>
<dd>A list of <a title="doctest.Example" class="reference internal" href="#doctest.Example"><tt class="xref docutils literal">Example</tt></a> objects encoding the individual interactive Python
examples that should be run by this test.</dd></dl>

<dl class="attribute">
<dt id="doctest.DocTest.globs">
<tt class="descname">globs</tt><a class="headerlink" href="#doctest.DocTest.globs" title="Permalink to this definition">¶</a></dt>
<dd>The namespace (aka globals) that the examples should be run in. This is a
dictionary mapping names to values. Any changes to the namespace made by the
examples (such as binding new variables) will be reflected in <a title="doctest.DocTest.globs" class="reference internal" href="#doctest.DocTest.globs"><tt class="xref docutils literal">globs</tt></a>
after the test is run.</dd></dl>

<dl class="attribute">
<dt id="doctest.DocTest.name">
<tt class="descname">name</tt><a class="headerlink" href="#doctest.DocTest.name" title="Permalink to this definition">¶</a></dt>
<dd>A string name identifying the <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a>. Typically, this is the name
of the object or file that the test was extracted from.</dd></dl>

<dl class="attribute">
<dt id="doctest.DocTest.filename">
<tt class="descname">filename</tt><a class="headerlink" href="#doctest.DocTest.filename" title="Permalink to this definition">¶</a></dt>
<dd>The name of the file that this <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> was extracted from; or
<tt class="xref docutils literal">None</tt> if the filename is unknown, or if the <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> was not
extracted from a file.</dd></dl>

<dl class="attribute">
<dt id="doctest.DocTest.lineno">
<tt class="descname">lineno</tt><a class="headerlink" href="#doctest.DocTest.lineno" title="Permalink to this definition">¶</a></dt>
<dd>The line number within <a title="doctest.DocTest.filename" class="reference internal" href="#doctest.DocTest.filename"><tt class="xref docutils literal">filename</tt></a> where this <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> begins, or
<tt class="xref docutils literal">None</tt> if the line number is unavailable. This line number is zero-based
with respect to the beginning of the file.</dd></dl>

<dl class="attribute">
<dt id="doctest.DocTest.docstring">
<tt class="descname">docstring</tt><a class="headerlink" href="#doctest.DocTest.docstring" title="Permalink to this definition">¶</a></dt>
<dd>The string that the test was extracted from, or &#8216;None&#8217; if the string is
unavailable, or if the test was not extracted from a string.</dd></dl>

</dd></dl>

</div>
<div class="section" id="example-objects">
<h3>25.2.6.2. Example Objects<a class="headerlink" href="#example-objects" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="doctest.Example">
class <tt class="descclassname">doctest.</tt><tt class="descname">Example</tt><big>(</big>source, want[, exc_msg][, lineno][, indent][, options]<big>)</big><a class="headerlink" href="#doctest.Example" title="Permalink to this definition">¶</a></dt>
<dd>A single interactive example, consisting of a Python statement and its expected
output. The constructor arguments are used to initialize the member variables
of the same names.

New in version 2.4.
<a title="doctest.Example" class="reference internal" href="#doctest.Example"><tt class="xref docutils literal">Example</tt></a> defines the following member variables. They are initialized by
the constructor, and should not be modified directly.
<dl class="attribute">
<dt id="doctest.Example.source">
<tt class="descname">source</tt><a class="headerlink" href="#doctest.Example.source" title="Permalink to this definition">¶</a></dt>
<dd>A string containing the example&#8217;s source code. This source code consists of a
single Python statement, and always ends with a newline; the constructor adds
a newline when necessary.</dd></dl>

<dl class="attribute">
<dt id="doctest.Example.want">
<tt class="descname">want</tt><a class="headerlink" href="#doctest.Example.want" title="Permalink to this definition">¶</a></dt>
<dd>The expected output from running the example&#8217;s source code (either from
stdout, or a traceback in case of exception). <a title="doctest.Example.want" class="reference internal" href="#doctest.Example.want"><tt class="xref docutils literal">want</tt></a> ends with a
newline unless no output is expected, in which case it&#8217;s an empty string. The
constructor adds a newline when necessary.</dd></dl>

<dl class="attribute">
<dt id="doctest.Example.exc_msg">
<tt class="descname">exc_msg</tt><a class="headerlink" href="#doctest.Example.exc_msg" title="Permalink to this definition">¶</a></dt>
<dd>The exception message generated by the example, if the example is expected to
generate an exception; or <tt class="xref docutils literal">None</tt> if it is not expected to generate an
exception. This exception message is compared against the return value of
<a title="traceback.format_exception_only" class="reference external" href="traceback.html#traceback.format_exception_only"><tt class="xref docutils literal">traceback.format_exception_only()</tt></a>. <a title="doctest.Example.exc_msg" class="reference internal" href="#doctest.Example.exc_msg"><tt class="xref docutils literal">exc_msg</tt></a> ends with a newline
unless it&#8217;s <tt class="xref docutils literal">None</tt>. The constructor adds a newline if needed.</dd></dl>

<dl class="attribute">
<dt id="doctest.Example.lineno">
<tt class="descname">lineno</tt><a class="headerlink" href="#doctest.Example.lineno" title="Permalink to this definition">¶</a></dt>
<dd>The line number within the string containing this example where the example
begins. This line number is zero-based with respect to the beginning of the
containing string.</dd></dl>

<dl class="attribute">
<dt id="doctest.Example.indent">
<tt class="descname">indent</tt><a class="headerlink" href="#doctest.Example.indent" title="Permalink to this definition">¶</a></dt>
<dd>The example&#8217;s indentation in the containing string, i.e., the number of space
characters that precede the example&#8217;s first prompt.</dd></dl>

<dl class="attribute">
<dt id="doctest.Example.options">
<tt class="descname">options</tt><a class="headerlink" href="#doctest.Example.options" title="Permalink to this definition">¶</a></dt>
<dd>A dictionary mapping from option flags to <tt class="xref docutils literal">True</tt> or <tt class="xref docutils literal">False</tt>, 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
<a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a>&#8216;s <tt class="xref docutils literal">optionflags</tt>). By default, no options are set.</dd></dl>

</dd></dl>

</div>
<div class="section" id="doctestfinder-objects">
<h3>25.2.6.3. DocTestFinder objects<a class="headerlink" href="#doctestfinder-objects" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="doctest.DocTestFinder">
class <tt class="descclassname">doctest.</tt><tt class="descname">DocTestFinder</tt><big>(</big>[verbose][, parser][, recurse][, exclude_empty]<big>)</big><a class="headerlink" href="#doctest.DocTestFinder" title="Permalink to this definition">¶</a></dt>
<dd>A processing class used to extract the <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a>s that are relevant to
a given object, from its docstring and the docstrings of its contained objects.
<a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a>s can currently be extracted from the following object types:
modules, functions, classes, methods, staticmethods, classmethods, and
properties.
The optional argument verbose can be used to display the objects searched by
the finder. It defaults to <tt class="xref docutils literal">False</tt> (no output).
The optional argument parser specifies the <a title="doctest.DocTestParser" class="reference internal" href="#doctest.DocTestParser"><tt class="xref docutils literal">DocTestParser</tt></a> object (or a
drop-in replacement) that is used to extract doctests from docstrings.
If the optional argument recurse is false, then <a title="doctest.DocTestFinder.find" class="reference internal" href="#doctest.DocTestFinder.find"><tt class="xref docutils literal">DocTestFinder.find()</tt></a>
will only examine the given object, and not any contained objects.
If the optional argument exclude_empty is false, then
<a title="doctest.DocTestFinder.find" class="reference internal" href="#doctest.DocTestFinder.find"><tt class="xref docutils literal">DocTestFinder.find()</tt></a> will include tests for objects with empty docstrings.

New in version 2.4.
<a title="doctest.DocTestFinder" class="reference internal" href="#doctest.DocTestFinder"><tt class="xref docutils literal">DocTestFinder</tt></a> defines the following method:
<dl class="method">
<dt id="doctest.DocTestFinder.find">
<tt class="descname">find</tt><big>(</big>obj[, name][, module][, globs][, extraglobs]<big>)</big><a class="headerlink" href="#doctest.DocTestFinder.find" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of the <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a>s that are defined by obj&#8216;s
docstring, or by any of its contained objects&#8217; docstrings.
The optional argument name specifies the object&#8217;s name; this name will be
used to construct names for the returned <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a>s. If name is
not specified, then <tt class="docutils literal">obj.__name__</tt> is used.
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&#8217;s module is used:
<ul class="simple">
<li>As a default namespace, if globs is not specified.</li>
<li>To prevent the DocTestFinder from extracting DocTests from objects that are
imported from other modules. (Contained objects with modules other than
module are ignored.)</li>
<li>To find the name of the file containing the object.</li>
<li>To help find the line number of the object within its file.</li>
</ul>
If module is <tt class="xref docutils literal">False</tt>, no attempt to find the module will be made. This is
obscure, of use mostly in testing doctest itself: if module is <tt class="xref docutils literal">False</tt>, or
is <tt class="xref docutils literal">None</tt> 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 <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> is formed by combining globs and
extraglobs (bindings in extraglobs override bindings in globs). A new
shallow copy of the globals dictionary is created for each <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a>.
If globs is not specified, then it defaults to the module&#8217;s __dict__, if
specified, or <tt class="docutils literal">{}</tt> otherwise. If extraglobs is not specified, then it
defaults to <tt class="docutils literal">{}</tt>.
</dd></dl>

</dd></dl>

</div>
<div class="section" id="doctestparser-objects">
<h3>25.2.6.4. DocTestParser objects<a class="headerlink" href="#doctestparser-objects" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="doctest.DocTestParser">
class <tt class="descclassname">doctest.</tt><tt class="descname">DocTestParser</tt><a class="headerlink" href="#doctest.DocTestParser" title="Permalink to this definition">¶</a></dt>
<dd>A processing class used to extract interactive examples from a string, and use
them to create a <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> object.

New in version 2.4.
<a title="doctest.DocTestParser" class="reference internal" href="#doctest.DocTestParser"><tt class="xref docutils literal">DocTestParser</tt></a> defines the following methods:
<dl class="method">
<dt id="doctest.DocTestParser.get_doctest">
<tt class="descname">get_doctest</tt><big>(</big>string, globs, name, filename, lineno<big>)</big><a class="headerlink" href="#doctest.DocTestParser.get_doctest" title="Permalink to this definition">¶</a></dt>
<dd>Extract all doctest examples from the given string, and collect them into a
<a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> object.
globs, name, filename, and lineno are attributes for the new
<a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> object. See the documentation for <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> for more
information.
</dd></dl>

<dl class="method">
<dt id="doctest.DocTestParser.get_examples">
<tt class="descname">get_examples</tt><big>(</big>string[, name]<big>)</big><a class="headerlink" href="#doctest.DocTestParser.get_examples" title="Permalink to this definition">¶</a></dt>
<dd>Extract all doctest examples from the given string, and return them as a list
of <a title="doctest.Example" class="reference internal" href="#doctest.Example"><tt class="xref docutils literal">Example</tt></a> objects. Line numbers are 0-based. The optional argument
name is a name identifying this string, and is only used for error messages.</dd></dl>

<dl class="method">
<dt id="doctest.DocTestParser.parse">
<tt class="descname">parse</tt><big>(</big>string[, name]<big>)</big><a class="headerlink" href="#doctest.DocTestParser.parse" title="Permalink to this definition">¶</a></dt>
<dd>Divide the given string into examples and intervening text, and return them as
a list of alternating <a title="doctest.Example" class="reference internal" href="#doctest.Example"><tt class="xref docutils literal">Example</tt></a>s and strings. Line numbers for the
<a title="doctest.Example" class="reference internal" href="#doctest.Example"><tt class="xref docutils literal">Example</tt></a>s are 0-based. The optional argument name is a name
identifying this string, and is only used for error messages.</dd></dl>

</dd></dl>

</div>
<div class="section" id="doctestrunner-objects">
<h3>25.2.6.5. DocTestRunner objects<a class="headerlink" href="#doctestrunner-objects" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="doctest.DocTestRunner">
class <tt class="descclassname">doctest.</tt><tt class="descname">DocTestRunner</tt><big>(</big>[checker][, verbose][, optionflags]<big>)</big><a class="headerlink" href="#doctest.DocTestRunner" title="Permalink to this definition">¶</a></dt>
<dd>A processing class used to execute and verify the interactive examples in a
<a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a>.
The comparison between expected outputs and actual outputs is done by an
<a title="doctest.OutputChecker" class="reference internal" href="#doctest.OutputChecker"><tt class="xref docutils literal">OutputChecker</tt></a>. This comparison may be customized with a number of
option flags; see section <a class="reference internal" href="#doctest-options">Option Flags and Directives</a> for more information. If the
option flags are insufficient, then the comparison may also be customized by
passing a subclass of <a title="doctest.OutputChecker" class="reference internal" href="#doctest.OutputChecker"><tt class="xref docutils literal">OutputChecker</tt></a> to the constructor.
The test runner&#8217;s display output can be controlled in two ways. First, an output
function can be passed to <tt class="xref docutils literal">TestRunner.run()</tt>; this function will be called
with strings that should be displayed. It defaults to <tt class="docutils literal">sys.stdout.write</tt>. If
capturing the output is not sufficient, then the display output can be also
customized by subclassing DocTestRunner, and overriding the methods
<a title="doctest.DocTestRunner.report_start" class="reference internal" href="#doctest.DocTestRunner.report_start"><tt class="xref docutils literal">report_start()</tt></a>, <a title="doctest.DocTestRunner.report_success" class="reference internal" href="#doctest.DocTestRunner.report_success"><tt class="xref docutils literal">report_success()</tt></a>,
<a title="doctest.DocTestRunner.report_unexpected_exception" class="reference internal" href="#doctest.DocTestRunner.report_unexpected_exception"><tt class="xref docutils literal">report_unexpected_exception()</tt></a>, and <a title="doctest.DocTestRunner.report_failure" class="reference internal" href="#doctest.DocTestRunner.report_failure"><tt class="xref docutils literal">report_failure()</tt></a>.
The optional keyword argument checker specifies the <a title="doctest.OutputChecker" class="reference internal" href="#doctest.OutputChecker"><tt class="xref docutils literal">OutputChecker</tt></a>
object (or drop-in replacement) that should be used to compare the expected
outputs to the actual outputs of doctest examples.
The optional keyword argument verbose controls the <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a>&#8216;s
verbosity. If verbose is <tt class="xref docutils literal">True</tt>, then information is printed about each
example, as it is run. If verbose is <tt class="xref docutils literal">False</tt>, then only failures are
printed. If verbose is unspecified, or <tt class="xref docutils literal">None</tt>, then verbose output is used
iff the command-line switch <a class="reference external" href="../using/cmdline.html#cmdoption-v">-v</a> is used.
The optional keyword argument optionflags can be used to control how the test
runner compares expected output to actual output, and how it displays failures.
For more information, see section <a class="reference internal" href="#doctest-options">Option Flags and Directives</a>.

New in version 2.4.
<a title="doctest.DocTestParser" class="reference internal" href="#doctest.DocTestParser"><tt class="xref docutils literal">DocTestParser</tt></a> defines the following methods:
<dl class="method">
<dt id="doctest.DocTestRunner.report_start">
<tt class="descname">report_start</tt><big>(</big>out, test, example<big>)</big><a class="headerlink" href="#doctest.DocTestRunner.report_start" title="Permalink to this definition">¶</a></dt>
<dd>Report that the test runner is about to process the given example. This method
is provided to allow subclasses of <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> to customize their
output; it should not be called directly.
example is the example about to be processed. test is the test
containing example. out is the output function that was passed to
<a title="doctest.DocTestRunner.run" class="reference internal" href="#doctest.DocTestRunner.run"><tt class="xref docutils literal">DocTestRunner.run()</tt></a>.
</dd></dl>

<dl class="method">
<dt id="doctest.DocTestRunner.report_success">
<tt class="descname">report_success</tt><big>(</big>out, test, example, got<big>)</big><a class="headerlink" href="#doctest.DocTestRunner.report_success" title="Permalink to this definition">¶</a></dt>
<dd>Report that the given example ran successfully. This method is provided to
allow subclasses of <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> to customize their output; it
should not be called directly.
example is the example about to be processed. got is the actual output
from the example. test is the test containing example. out is the
output function that was passed to <a title="doctest.DocTestRunner.run" class="reference internal" href="#doctest.DocTestRunner.run"><tt class="xref docutils literal">DocTestRunner.run()</tt></a>.
</dd></dl>

<dl class="method">
<dt id="doctest.DocTestRunner.report_failure">
<tt class="descname">report_failure</tt><big>(</big>out, test, example, got<big>)</big><a class="headerlink" href="#doctest.DocTestRunner.report_failure" title="Permalink to this definition">¶</a></dt>
<dd>Report that the given example failed. This method is provided to allow
subclasses of <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> to customize their output; it should not
be called directly.
example is the example about to be processed. got is the actual output
from the example. test is the test containing example. out is the
output function that was passed to <a title="doctest.DocTestRunner.run" class="reference internal" href="#doctest.DocTestRunner.run"><tt class="xref docutils literal">DocTestRunner.run()</tt></a>.
</dd></dl>

<dl class="method">
<dt id="doctest.DocTestRunner.report_unexpected_exception">
<tt class="descname">report_unexpected_exception</tt><big>(</big>out, test, example, exc_info<big>)</big><a class="headerlink" href="#doctest.DocTestRunner.report_unexpected_exception" title="Permalink to this definition">¶</a></dt>
<dd>Report that the given example raised an unexpected exception. This method is
provided to allow subclasses of <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> to customize their
output; it should not be called directly.
example is the example about to be processed. exc_info is a tuple
containing information about the unexpected exception (as returned by
<a title="sys.exc_info" class="reference external" href="sys.html#sys.exc_info"><tt class="xref docutils literal">sys.exc_info()</tt></a>). test is the test containing example. out is the
output function that was passed to <a title="doctest.DocTestRunner.run" class="reference internal" href="#doctest.DocTestRunner.run"><tt class="xref docutils literal">DocTestRunner.run()</tt></a>.
</dd></dl>

<dl class="method">
<dt id="doctest.DocTestRunner.run">
<tt class="descname">run</tt><big>(</big>test[, compileflags][, out][, clear_globs]<big>)</big><a class="headerlink" href="#doctest.DocTestRunner.run" title="Permalink to this definition">¶</a></dt>
<dd>Run the examples in test (a <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> object), and display the
results using the writer function out.
The examples are run in the namespace <tt class="docutils literal">test.globs</tt>. 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 the <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a>&#8216;s
output checker, and the results are formatted by the
<tt class="xref docutils literal">DocTestRunner.report_*()</tt> methods.
</dd></dl>

<dl class="method">
<dt id="doctest.DocTestRunner.summarize">
<tt class="descname">summarize</tt><big>(</big>[verbose]<big>)</big><a class="headerlink" href="#doctest.DocTestRunner.summarize" title="Permalink to this definition">¶</a></dt>
<dd>Print a summary of all the test cases that have been run by this DocTestRunner,
and return a <a class="reference external" href="../glossary.html#term-named-tuple">named tuple</a> <tt class="docutils literal">TestResults(failed, attempted)</tt>.
The optional verbose argument controls how detailed the summary is. If the
verbosity is not specified, then the <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a>&#8216;s verbosity is
used.

Changed in version 2.6: Use a named tuple.
</dd></dl>

</dd></dl>

</div>
<div class="section" id="outputchecker-objects">
<h3>25.2.6.6. OutputChecker objects<a class="headerlink" href="#outputchecker-objects" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="doctest.OutputChecker">
class <tt class="descclassname">doctest.</tt><tt class="descname">OutputChecker</tt><a class="headerlink" href="#doctest.OutputChecker" title="Permalink to this definition">¶</a></dt>
<dd>A class used to check the whether the actual output from a doctest example
matches the expected output. <a title="doctest.OutputChecker" class="reference internal" href="#doctest.OutputChecker"><tt class="xref docutils literal">OutputChecker</tt></a> defines two methods:
<a title="doctest.OutputChecker.check_output" class="reference internal" href="#doctest.OutputChecker.check_output"><tt class="xref docutils literal">check_output()</tt></a>, which compares a given pair of outputs, and returns true
if they match; and <a title="doctest.OutputChecker.output_difference" class="reference internal" href="#doctest.OutputChecker.output_difference"><tt class="xref docutils literal">output_difference()</tt></a>, which returns a string describing
the differences between two outputs.

New in version 2.4.
<a title="doctest.OutputChecker" class="reference internal" href="#doctest.OutputChecker"><tt class="xref docutils literal">OutputChecker</tt></a> defines the following methods:
<dl class="method">
<dt id="doctest.OutputChecker.check_output">
<tt class="descname">check_output</tt><big>(</big>want, got, optionflags<big>)</big><a class="headerlink" href="#doctest.OutputChecker.check_output" title="Permalink to this definition">¶</a></dt>
<dd>Return <tt class="xref docutils literal">True</tt> 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 section
<a class="reference internal" href="#doctest-options">Option Flags and Directives</a> for more information about option flags.</dd></dl>

<dl class="method">
<dt id="doctest.OutputChecker.output_difference">
<tt class="descname">output_difference</tt><big>(</big>example, got, optionflags<big>)</big><a class="headerlink" href="#doctest.OutputChecker.output_difference" title="Permalink to this definition">¶</a></dt>
<dd>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.</dd></dl>

</dd></dl>

</div>
</div>
<div class="section" id="debugging">
<h2>25.2.7. Debugging<a class="headerlink" href="#debugging" title="Permalink to this headline">¶</a></h2>
Doctest provides several mechanisms for debugging doctest examples:
<ul>
<li>Several functions convert doctests to executable Python programs, which can be
run under the Python debugger, <a title="The Python debugger for interactive interpreters." class="reference external" href="pdb.html#module-pdb"><tt class="xref docutils literal">pdb</tt></a>.
</li>
<li>The <a title="doctest.DebugRunner" class="reference internal" href="#doctest.DebugRunner"><tt class="xref docutils literal">DebugRunner</tt></a> class is a subclass of <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> that
raises an exception for the first failing example, containing information about
that example. This information can be used to perform post-mortem debugging on
the example.
</li>
<li>The <a title="Unit testing framework for Python." class="reference external" href="unittest.html#module-unittest"><tt class="xref docutils literal">unittest</tt></a> cases generated by <a title="doctest.DocTestSuite" class="reference internal" href="#doctest.DocTestSuite"><tt class="xref docutils literal">DocTestSuite()</tt></a> support the
<a title="doctest.debug" class="reference internal" href="#doctest.debug"><tt class="xref docutils literal">debug()</tt></a> method defined by <a title="unittest.TestCase" class="reference external" href="unittest.html#unittest.TestCase"><tt class="xref docutils literal">unittest.TestCase</tt></a>.
</li>
<li>You can add a call to <a title="pdb.set_trace" class="reference external" href="pdb.html#pdb.set_trace"><tt class="xref docutils literal">pdb.set_trace()</tt></a> in a doctest example, and you&#8217;ll
drop into the Python debugger when that line is executed. Then you can inspect
current values of variables, and so on. For example, suppose <tt class="docutils literal">a.py</tt>
contains just this module docstring:
<div class="highlight-python"><div class="highlight"><pre>&quot;&quot;&quot;
&gt;&gt;&gt; def f(x):
... g(x*2)
&gt;&gt;&gt; def g(x):
... print x+3
... import pdb; pdb.set_trace()
&gt;&gt;&gt; f(3)
9
&quot;&quot;&quot;
</pre></div>
</div>
Then an interactive Python session may look like this:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; import a, doctest
&gt;&gt;&gt; doctest.testmod(a)
--Return--
&gt; &lt;doctest a[1]&gt;(3)g()-&gt;None
-&gt; import pdb; pdb.set_trace()
(Pdb) list
 1 def g(x):
 2 print x+3
 3 -&gt; import pdb; pdb.set_trace()
[EOF]
(Pdb) print x
6
(Pdb) step
--Return--
&gt; &lt;doctest a[0]&gt;(2)f()-&gt;None
-&gt; g(x*2)
(Pdb) list
 1 def f(x):
 2 -&gt; g(x*2)
[EOF]
(Pdb) print x
3
(Pdb) step
--Return--
&gt; &lt;doctest a[2]&gt;(1)?()-&gt;None
-&gt; f(3)
(Pdb) cont
(0, 3)
&gt;&gt;&gt;
</pre></div>
</div>

Changed in version 2.4: The ability to use <a title="pdb.set_trace" class="reference external" href="pdb.html#pdb.set_trace"><tt class="xref docutils literal">pdb.set_trace()</tt></a> usefully inside doctests was added.
</li>
</ul>
Functions that convert doctests to Python code, and possibly run the synthesized
code under the debugger:
<dl class="function">
<dt id="doctest.script_from_examples">
<tt class="descclassname">doctest.</tt><tt class="descname">script_from_examples</tt><big>(</big>s<big>)</big><a class="headerlink" href="#doctest.script_from_examples" title="Permalink to this definition">¶</a></dt>
<dd>Convert text with examples to a script.
Argument s is a string containing doctest examples. The string is converted
to a Python script, where doctest examples in s are converted to regular code,
and everything else is converted to Python comments. The generated script is
returned as a string. For example,
<div class="highlight-python"><div class="highlight"><pre>import doctest
print doctest.script_from_examples(r&quot;&quot;&quot;
 Set x and y to 1 and 2.
 &gt;&gt;&gt; x, y = 1, 2

Print their sum:
 &gt;&gt;&gt; print x+y
 3
&quot;&quot;&quot;)
</pre></div>
</div>
displays:
<div class="highlight-python"><div class="highlight"><pre># Set x and y to 1 and 2.
x, y = 1, 2
#
# Print their sum:
print x+y
# Expected:
## 3
</pre></div>
</div>
This function is used internally by other functions (see below), but can also be
useful when you want to transform an interactive Python session into a Python
script.

New in version 2.4.
</dd></dl>

<dl class="function">
<dt id="doctest.testsource">
<tt class="descclassname">doctest.</tt><tt class="descname">testsource</tt><big>(</big>module, name<big>)</big><a class="headerlink" href="#doctest.testsource" title="Permalink to this definition">¶</a></dt>
<dd>Convert the doctest for an object to a script.
Argument module is a module object, or dotted name of a module, containing the
object whose doctests are of interest. Argument name is the name (within the
module) of the object with the doctests of interest. The result is a string,
containing the object&#8217;s docstring converted to a Python script, as described for
<a title="doctest.script_from_examples" class="reference internal" href="#doctest.script_from_examples"><tt class="xref docutils literal">script_from_examples()</tt></a> above. For example, if module <tt class="docutils literal">a.py</tt>
contains a top-level function <tt class="xref docutils literal">f()</tt>, then
<div class="highlight-python"><div class="highlight"><pre>import a, doctest
print doctest.testsource(a, &quot;a.f&quot;)
</pre></div>
</div>
prints a script version of function <tt class="xref docutils literal">f()</tt>&#8216;s docstring, with doctests
converted to code, and the rest placed in comments.

New in version 2.3.
</dd></dl>

<dl class="function">
<dt id="doctest.debug">
<tt class="descclassname">doctest.</tt><tt class="descname">debug</tt><big>(</big>module, name[, pm]<big>)</big><a class="headerlink" href="#doctest.debug" title="Permalink to this definition">¶</a></dt>
<dd>Debug the doctests for an object.
The module and name arguments are the same as for function
<a title="doctest.testsource" class="reference internal" href="#doctest.testsource"><tt class="xref docutils literal">testsource()</tt></a> above. The synthesized Python script for the named object&#8217;s
docstring is written to a temporary file, and then that file is run under the
control of the Python debugger, <a title="The Python debugger for interactive interpreters." class="reference external" href="pdb.html#module-pdb"><tt class="xref docutils literal">pdb</tt></a>.
A shallow copy of <tt class="docutils literal">module.__dict__</tt> is used for both local and global
execution context.
Optional argument pm controls whether post-mortem debugging is used. If pm
has a true value, the script file is run directly, and the debugger gets
involved only if the script terminates via raising an unhandled exception. If
it does, then post-mortem debugging is invoked, via <a title="pdb.post_mortem" class="reference external" href="pdb.html#pdb.post_mortem"><tt class="xref docutils literal">pdb.post_mortem()</tt></a>,
passing the traceback object from the unhandled exception. If pm is not
specified, or is false, the script is run under the debugger from the start, via
passing an appropriate <a title="execfile" class="reference external" href="functions.html#execfile"><tt class="xref docutils literal">execfile()</tt></a> call to <a title="pdb.run" class="reference external" href="pdb.html#pdb.run"><tt class="xref docutils literal">pdb.run()</tt></a>.

New in version 2.3.

Changed in version 2.4: The pm argument was added.
</dd></dl>

<dl class="function">
<dt id="doctest.debug_src">
<tt class="descclassname">doctest.</tt><tt class="descname">debug_src</tt><big>(</big>src[, pm][, globs]<big>)</big><a class="headerlink" href="#doctest.debug_src" title="Permalink to this definition">¶</a></dt>
<dd>Debug the doctests in a string.
This is like function <a title="doctest.debug" class="reference internal" href="#doctest.debug"><tt class="xref docutils literal">debug()</tt></a> above, except that a string containing
doctest examples is specified directly, via the src argument.
Optional argument pm has the same meaning as in function <a title="doctest.debug" class="reference internal" href="#doctest.debug"><tt class="xref docutils literal">debug()</tt></a> above.
Optional argument globs gives a dictionary to use as both local and global
execution context. If not specified, or <tt class="xref docutils literal">None</tt>, an empty dictionary is used.
If specified, a shallow copy of the dictionary is used.

New in version 2.4.
</dd></dl>

The <a title="doctest.DebugRunner" class="reference internal" href="#doctest.DebugRunner"><tt class="xref docutils literal">DebugRunner</tt></a> class, and the special exceptions it may raise, are of
most interest to testing framework authors, and will only be sketched here. See
the source code, and especially <a title="doctest.DebugRunner" class="reference internal" href="#doctest.DebugRunner"><tt class="xref docutils literal">DebugRunner</tt></a>&#8216;s docstring (which is a
doctest!) for more details:
<dl class="class">
<dt id="doctest.DebugRunner">
class <tt class="descclassname">doctest.</tt><tt class="descname">DebugRunner</tt><big>(</big>[checker][, verbose][, optionflags]<big>)</big><a class="headerlink" href="#doctest.DebugRunner" title="Permalink to this definition">¶</a></dt>
<dd>A subclass of <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> that raises an exception as soon as a
failure is encountered. If an unexpected exception occurs, an
<a title="doctest.UnexpectedException" class="reference internal" href="#doctest.UnexpectedException"><tt class="xref docutils literal">UnexpectedException</tt></a> exception is raised, containing the test, the
example, and the original exception. If the output doesn&#8217;t match, then a
<a title="doctest.DocTestFailure" class="reference internal" href="#doctest.DocTestFailure"><tt class="xref docutils literal">DocTestFailure</tt></a> exception is raised, containing the test, the example, and
the actual output.
For information about the constructor parameters and methods, see the
documentation for <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> in section <a class="reference internal" href="#doctest-advanced-api">Advanced API</a>.
</dd></dl>

There are two exceptions that may be raised by <a title="doctest.DebugRunner" class="reference internal" href="#doctest.DebugRunner"><tt class="xref docutils literal">DebugRunner</tt></a> instances:
<dl class="exception">
<dt id="doctest.DocTestFailure">
exception <tt class="descclassname">doctest.</tt><tt class="descname">DocTestFailure</tt><big>(</big>test, example, got<big>)</big><a class="headerlink" href="#doctest.DocTestFailure" title="Permalink to this definition">¶</a></dt>
<dd>An exception thrown by <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> to signal that a doctest example&#8217;s
actual output did not match its expected output. The constructor arguments are
used to initialize the member variables of the same names.</dd></dl>

<a title="doctest.DocTestFailure" class="reference internal" href="#doctest.DocTestFailure"><tt class="xref docutils literal">DocTestFailure</tt></a> defines the following member variables:
<dl class="attribute">
<dt id="doctest.DocTestFailure.test">
<tt class="descclassname">DocTestFailure.</tt><tt class="descname">test</tt><a class="headerlink" href="#doctest.DocTestFailure.test" title="Permalink to this definition">¶</a></dt>
<dd>The <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> object that was being run when the example failed.</dd></dl>

<dl class="attribute">
<dt id="doctest.DocTestFailure.example">
<tt class="descclassname">DocTestFailure.</tt><tt class="descname">example</tt><a class="headerlink" href="#doctest.DocTestFailure.example" title="Permalink to this definition">¶</a></dt>
<dd>The <a title="doctest.Example" class="reference internal" href="#doctest.Example"><tt class="xref docutils literal">Example</tt></a> that failed.</dd></dl>

<dl class="attribute">
<dt id="doctest.DocTestFailure.got">
<tt class="descclassname">DocTestFailure.</tt><tt class="descname">got</tt><a class="headerlink" href="#doctest.DocTestFailure.got" title="Permalink to this definition">¶</a></dt>
<dd>The example&#8217;s actual output.</dd></dl>

<dl class="exception">
<dt id="doctest.UnexpectedException">
exception <tt class="descclassname">doctest.</tt><tt class="descname">UnexpectedException</tt><big>(</big>test, example, exc_info<big>)</big><a class="headerlink" href="#doctest.UnexpectedException" title="Permalink to this definition">¶</a></dt>
<dd>An exception thrown by <a title="doctest.DocTestRunner" class="reference internal" href="#doctest.DocTestRunner"><tt class="xref docutils literal">DocTestRunner</tt></a> to signal that a doctest example
raised an unexpected exception. The constructor arguments are used to
initialize the member variables of the same names.</dd></dl>

<a title="doctest.UnexpectedException" class="reference internal" href="#doctest.UnexpectedException"><tt class="xref docutils literal">UnexpectedException</tt></a> defines the following member variables:
<dl class="attribute">
<dt id="doctest.UnexpectedException.test">
<tt class="descclassname">UnexpectedException.</tt><tt class="descname">test</tt><a class="headerlink" href="#doctest.UnexpectedException.test" title="Permalink to this definition">¶</a></dt>
<dd>The <a title="doctest.DocTest" class="reference internal" href="#doctest.DocTest"><tt class="xref docutils literal">DocTest</tt></a> object that was being run when the example failed.</dd></dl>

<dl class="attribute">
<dt id="doctest.UnexpectedException.example">
<tt class="descclassname">UnexpectedException.</tt><tt class="descname">example</tt><a class="headerlink" href="#doctest.UnexpectedException.example" title="Permalink to this definition">¶</a></dt>
<dd>The <a title="doctest.Example" class="reference internal" href="#doctest.Example"><tt class="xref docutils literal">Example</tt></a> that failed.</dd></dl>

<dl class="attribute">
<dt id="doctest.UnexpectedException.exc_info">
<tt class="descclassname">UnexpectedException.</tt><tt class="descname">exc_info</tt><a class="headerlink" href="#doctest.UnexpectedException.exc_info" title="Permalink to this definition">¶</a></dt>
<dd>A tuple containing information about the unexpected exception, as returned by
<a title="sys.exc_info" class="reference external" href="sys.html#sys.exc_info"><tt class="xref docutils literal">sys.exc_info()</tt></a>.</dd></dl>

</div>
<div class="section" id="soapbox">
<h2>25.2.8. Soapbox<a class="headerlink" href="#soapbox" title="Permalink to this headline">¶</a></h2>
As mentioned in the introduction, <tt class="xref docutils literal">doctest</tt> has grown to have three primary
uses:
<ol class="arabic simple">
<li>Checking examples in docstrings.</li>
<li>Regression testing.</li>
<li>Executable documentation / literate testing.</li>
</ol>
These uses have different requirements, and it is important to distinguish them.
In particular, filling your docstrings with obscure test cases makes for bad
documentation.
When writing a docstring, choose docstring examples with care. There&#8217;s an art to
this that needs to be learned&#8212;it may not be natural at first. Examples should
add genuine value to the documentation. A good example can often be worth many
words. If done with care, the examples will be invaluable for your users, and
will pay back the time it takes to collect them many times over as the years go
by and things change. I&#8217;m still amazed at how often one of my <tt class="xref docutils literal">doctest</tt>
examples stops working after a &#8220;harmless&#8221; change.
Doctest also makes an excellent tool for regression testing, especially if you
don&#8217;t skimp on explanatory text. By interleaving prose and examples, it becomes
much easier to keep track of what&#8217;s actually being tested, and why. When a test
fails, good prose can make it much easier to figure out what the problem is, and
how it should be fixed. It&#8217;s true that you could write extensive comments in
code-based testing, but few programmers do. Many have found that using doctest
approaches instead leads to much clearer tests. Perhaps this is simply because
doctest makes writing prose a little easier than writing code, while writing
comments in code is a little harder. I think it goes deeper than just that:
the natural attitude when writing a doctest-based test is that you want to
explain the fine points of your software, and illustrate them with examples.
This in turn naturally leads to test files that start with the simplest
features, and logically progress to complications and edge cases. A coherent
narrative is the result, instead of a collection of isolated functions that test
isolated bits of functionality seemingly at random. It&#8217;s a different attitude,
and produces different results, blurring the distinction between testing and
explaining.
Regression testing is best confined to dedicated objects or files. There are
several options for organizing tests:
<ul class="simple">
<li>Write text files containing test cases as interactive examples, and test the
files using <a title="doctest.testfile" class="reference internal" href="#doctest.testfile"><tt class="xref docutils literal">testfile()</tt></a> or <a title="doctest.DocFileSuite" class="reference internal" href="#doctest.DocFileSuite"><tt class="xref docutils literal">DocFileSuite()</tt></a>. This is recommended,
although is easiest to do for new projects, designed from the start to use
doctest.</li>
<li>Define functions named <tt class="docutils literal">_regrtest_topic</tt> that consist of single docstrings,
containing test cases for the named topics. These functions can be included in
the same file as the module, or separated out into a separate test file.</li>
<li>Define a <tt class="docutils literal">__test__</tt> dictionary mapping from regression test topics to
docstrings containing test cases.</li>
</ul>
Footnotes
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>Examples containing both expected output and an exception are not supported.
Trying to guess where one ends and the other begins is too error-prone, and that
also makes for a confusing test.</td></tr>
</tbody>
</table>
</div>
</div>

</div>
 </div>
 </div>
 <div class="sphinxsidebar">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table Of Contents</a></h3>
 <ul>
<li><a class="reference external" href="#">25.2. <tt class="docutils literal">doctest</tt> &#8212; Test interactive Python examples</a><ul>
<li><a class="reference external" href="#simple-usage-checking-examples-in-docstrings">25.2.1. Simple Usage: Checking Examples in Docstrings</a></li>
<li><a class="reference external" href="#simple-usage-checking-examples-in-a-text-file">25.2.2. Simple Usage: Checking Examples in a Text File</a></li>
<li><a class="reference external" href="#how-it-works">25.2.3. How It Works</a><ul>
<li><a class="reference external" href="#which-docstrings-are-examined">25.2.3.1. Which Docstrings Are Examined?</a></li>
<li><a class="reference external" href="#how-are-docstring-examples-recognized">25.2.3.2. How are Docstring Examples Recognized?</a></li>
<li><a class="reference external" href="#what-s-the-execution-context">25.2.3.3. What&#8217;s the Execution Context?</a></li>
<li><a class="reference external" href="#what-about-exceptions">25.2.3.4. What About Exceptions?</a></li>
<li><a class="reference external" href="#option-flags-and-directives">25.2.3.5. Option Flags and Directives</a></li>
<li><a class="reference external" href="#warnings">25.2.3.6. Warnings</a></li>
</ul>
</li>
<li><a class="reference external" href="#basic-api">25.2.4. Basic API</a></li>
<li><a class="reference external" href="#unittest-api">25.2.5. Unittest API</a></li>
<li><a class="reference external" href="#advanced-api">25.2.6. Advanced API</a><ul>
<li><a class="reference external" href="#doctest-objects">25.2.6.1. DocTest Objects</a></li>
<li><a class="reference external" href="#example-objects">25.2.6.2. Example Objects</a></li>
<li><a class="reference external" href="#doctestfinder-objects">25.2.6.3. DocTestFinder objects</a></li>
<li><a class="reference external" href="#doctestparser-objects">25.2.6.4. DocTestParser objects</a></li>
<li><a class="reference external" href="#doctestrunner-objects">25.2.6.5. DocTestRunner objects</a></li>
<li><a class="reference external" href="#outputchecker-objects">25.2.6.6. OutputChecker objects</a></li>
</ul>
</li>
<li><a class="reference external" href="#debugging">25.2.7. Debugging</a></li>
<li><a class="reference external" href="#soapbox">25.2.8. Soapbox</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="pydoc.html"
 title="previous chapter">25.1. <tt class="docutils literal docutils literal">pydoc</tt> &#8212; Documentation generator and online help system</a>
 <h4>Next topic</h4>
 <a href="unittest.html"
 title="next chapter">25.3. <tt class="docutils literal docutils literal">unittest</tt> &#8212; Unit testing framework</a>
<h3>This Page</h3>
<ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li><a href="../_sources/library/doctest.txt"
 rel="nofollow">Show Source</a></li>
</ul>

<div id="searchbox" style="display: none">
 <h3>Quick search</h3>
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" size="18" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 
 Enter search terms or a module, class or function name.
 
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../modindex.html" title="Global Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="unittest.html" title="25.3. unittest — Unit testing framework"
 >next</a> |</li>
 <li class="right" >
 <a href="pydoc.html" title="25.1. pydoc — Documentation generator and online help system"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="../index.html">Python v2.6.6 documentation</a> &raquo;</li>

<li><a href="index.html" >The Python Standard Library</a> &raquo;</li>
 <li><a href="development.html" >25. Development Tools</a> &raquo;</li> 
 </ul>
 </div>
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2011, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation. 
 <a href="http://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on Jul 20, 2011.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6.
 </div>

</body>
</html>

Back to File Manager