<!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-DocTestFinder.html" />
<link rel=
"prev" href=
"doctest-DocTest.html" />
<link rel=
"parent" href=
"doctest-advanced-api.html" />
<link rel=
"next" href=
"doctest-DocTestFinder.html" />
<meta name='aesop' content='information'
/>
<title>5.2.6.2 Example 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.1 DocTest Objects"
href=
"doctest-DocTest.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.3 DocTestFinder objects"
href=
"doctest-DocTestFinder.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-DocTest.html">5.2.6.1 DocTest Objects
</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-DocTestFinder.html">5.2.6.3 DocTestFinder objects
</A>
<!--End of Navigation Panel-->
<H3><A NAME=
"SECTION007262000000000000000"></A><A NAME=
"doctest-Example"></A>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
1087' xml:id='l2h-
1087'
class=
"class">Example
</tt></b>(
</nobr></td>
<td><var>source, want
</var><big>[
</big><var>,
exc_msg
</var><big>]
</big><var></var><big>[
</big><var>, lineno
</var><big>]
</big><var></var><big>[
</big><var>,
indent
</var><big>]
</big><var></var><big>[
</big><var>, options
</var><big>]
</big><var></var>)
</td></tr></table></dt> 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.
<span class=
"versionnote">New in version
2.4.
</span>
<tt class=
"class">Example
</tt> defines the following member variables. They are
initialized by the constructor, and should not be modified directly.
<dl><dt><b><tt id='l2h-
1088' xml:id='l2h-
1088'
class=
"member">source
</tt></b></dt>
A string containing the example'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.
<dl><dt><b><tt id='l2h-
1089' xml:id='l2h-
1089'
class=
"member">want
</tt></b></dt>
The expected output from running the example's source code (either
from stdout, or a traceback in case of exception).
<tt class=
"member">want
</tt> ends with a newline unless no output is expected, in which case
it's an empty string. The constructor adds a newline when
<dl><dt><b><tt id='l2h-
1090' xml:id='l2h-
1090'
class=
"member">exc_msg
</tt></b></dt>
The exception message generated by the example, if the example is
expected to generate an exception; or
<code>None
</code> if it is not
expected to generate an exception. This exception message is
compared against the return value of
<tt class=
"function">traceback.format_exception_only()
</tt>.
<tt class=
"member">exc_msg
</tt>
ends with a newline unless it's
<code>None
</code>. The constructor adds
<dl><dt><b><tt id='l2h-
1091' xml:id='l2h-
1091'
class=
"member">lineno
</tt></b></dt>
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.
<dl><dt><b><tt id='l2h-
1092' xml:id='l2h-
1092'
class=
"member">indent
</tt></b></dt>
The example's indentation in the containing string, i.e., the
number of space characters that precede the example's first
<dl><dt><b><tt id='l2h-
1093' xml:id='l2h-
1093'
class=
"member">options
</tt></b></dt>
A dictionary mapping from option flags to
<code>True
</code> or
<code>False
</code>, 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
<tt class=
"class">DocTestRunner
</tt>'s
<tt class=
"member">optionflags
</tt>).
By default, no options are set.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"5.2.6.1 DocTest Objects"
href=
"doctest-DocTest.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.3 DocTestFinder objects"
href=
"doctest-DocTestFinder.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-DocTest.html">5.2.6.1 DocTest Objects
</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-DocTestFinder.html">5.2.6.3 DocTestFinder 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.
projects / OpenSPARC-T2-SAM / blob