<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"doctest-Example.html" />
<link rel=
"prev" href=
"doctest-advanced-api.html" />
<link rel=
"parent" href=
"doctest-advanced-api.html" />
<link rel=
"next" href=
"doctest-Example.html" />
<meta name='aesop' content='information'
/>
<title>5.2.6.1 DocTest Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"5.2.6 Advanced API"
href=
"doctest-advanced-api.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"5.2.6 Advanced API"
href=
"doctest-advanced-api.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"5.2.6.2 Example Objects"
href=
"doctest-Example.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"doctest-advanced-api.html">5.2.6 Advanced API
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"doctest-advanced-api.html">5.2.6 Advanced API
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"doctest-Example.html">5.2.6.2 Example Objects
</A>
<!--End of Navigation Panel-->
<H3><A NAME=
"SECTION007261000000000000000"></A><A NAME=
"doctest-DocTest"></A>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
1080' xml:id='l2h-
1080'
class=
"class">DocTest
</tt></b>(
</nobr></td>
<td><var>examples, globs, name, filename, lineno,
docstring
</var>)
</td></tr></table></dt>
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.
<span class=
"versionnote">New in version
2.4.
</span>
<tt class=
"class">DocTest
</tt> defines the following member variables. They are
initialized by the constructor, and should not be modified directly.
<dl><dt><b><tt id='l2h-
1081' xml:id='l2h-
1081'
class=
"member">examples
</tt></b></dt>
A list of
<tt class=
"class">Example
</tt> objects encoding the individual
interactive Python examples that should be run by this test.
<dl><dt><b><tt id='l2h-
1082' xml:id='l2h-
1082'
class=
"member">globs
</tt></b></dt>
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
<tt class=
"member">globs
</tt> after the test is run.
<dl><dt><b><tt id='l2h-
1083' xml:id='l2h-
1083'
class=
"member">name
</tt></b></dt>
A string name identifying the
<tt class=
"class">DocTest
</tt>. Typically, this is
the name of the object or file that the test was extracted from.
<dl><dt><b><tt id='l2h-
1084' xml:id='l2h-
1084'
class=
"member">filename
</tt></b></dt>
The name of the file that this
<tt class=
"class">DocTest
</tt> was extracted from;
or
<code>None
</code> if the filename is unknown, or if the
<tt class=
"class">DocTest
</tt> was not extracted from a file.
<dl><dt><b><tt id='l2h-
1085' xml:id='l2h-
1085'
class=
"member">lineno
</tt></b></dt>
The line number within
<tt class=
"member">filename
</tt> where this
<tt class=
"class">DocTest
</tt> begins, or
<code>None
</code> if the line number is
unavailable. This line number is zero-based with respect to the
<dl><dt><b><tt id='l2h-
1086' xml:id='l2h-
1086'
class=
"member">docstring
</tt></b></dt>
The string that the test was extracted from, or `None` if the
string is unavailable, or if the test was not extracted from a
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"5.2.6 Advanced API"
href=
"doctest-advanced-api.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"5.2.6 Advanced API"
href=
"doctest-advanced-api.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"5.2.6.2 Example Objects"
href=
"doctest-Example.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"doctest-advanced-api.html">5.2.6 Advanced API
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"doctest-advanced-api.html">5.2.6 Advanced API
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"doctest-Example.html">5.2.6.2 Example Objects
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.