[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / html / python / lib / doctest-simple-testmod.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<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-simple-testfile.html" />
<link rel="prev" href="module-doctest.html" />
<link rel="parent" href="module-doctest.html" />
<link rel="next" href="doctest-simple-testfile.html" />
<meta name='aesop' content='information' />
<title>5.2.1 Simple Usage: Checking Examples in Docstrings</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="5.2 doctest  "
  href="module-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 doctest  "
  href="module-doctest.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.2 Simple Usage: Checking"
  href="doctest-simple-testfile.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-doctest.html">5.2 doctest  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-doctest.html">5.2 doctest  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="doctest-simple-testfile.html">5.2.2 Simple Usage: Checking</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION007210000000000000000"></A><A NAME="doctest-simple-testmod"></A>
<BR>
5.2.1 Simple Usage: Checking Examples in
            Docstrings
</H2>

<P>
The simplest way to start using doctest (but not necessarily the way
you'll continue to do it) is to end each module <tt class="module">M</tt> with:

<P>
<div class="verbatim"><pre>
def _test():
    import doctest
    doctest.testmod()

if __name__ == "__main__":
    _test()
</pre></div>

<P>
<tt class="module"><a href="module-doctest.html">doctest</a></tt> then examines docstrings in module <tt class="module">M</tt>.

<P>
Running the module as a script causes the examples in the docstrings
to get executed and verified:

<P>
<div class="verbatim"><pre>
python M.py
</pre></div>

<P>
This won't display anything unless an example fails, in which case the
failing example(s) and the cause(s) of the failure(s) are printed to stdout,
and the final line of output is
"<tt class="samp">***Test Failed*** <var>N</var> failures.</tt>", where <var>N</var> is the
number of examples that failed.

<P>
Run it with the <b class="programopt">-v</b> switch instead:

<P>
<div class="verbatim"><pre>
python M.py -v
</pre></div>

<P>
and a detailed report of all examples tried is printed to standard
output, along with assorted summaries at the end.

<P>
You can force verbose mode by passing <code>verbose=True</code> to
<tt class="function">testmod()</tt>, or
prohibit it by passing <code>verbose=False</code>.  In either of those cases,
<code>sys.argv</code> is not examined by <tt class="function">testmod()</tt> (so passing
<b class="programopt">-v</b> or not has no effect).

<P>
For more information on <tt class="function">testmod()</tt>, see
section&nbsp;<A href="doctest-basic-api.html#doctest-basic-api">5.2.4</A>.

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="5.2 doctest  "
  href="module-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 doctest  "
  href="module-doctest.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.2 Simple Usage: Checking"
  href="doctest-simple-testfile.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-doctest.html">5.2 doctest  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-doctest.html">5.2 doctest  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="doctest-simple-testfile.html">5.2.2 Simple Usage: Checking</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
920dae64 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="lib.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="lib.html" title='Python Library Reference' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="doctest-simple-testfile.html" />
	13	<link rel="prev" href="module-doctest.html" />
	14	<link rel="parent" href="module-doctest.html" />
	15	<link rel="next" href="doctest-simple-testfile.html" />
	16	<meta name='aesop' content='information' />
	17	<title>5.2.1 Simple Usage: Checking Examples in Docstrings</title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="5.2 doctest "
	25	href="module-doctest.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="5.2 doctest "
	28	href="module-doctest.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="5.2.2 Simple Usage: Checking"
	31	href="doctest-simple-testfile.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python Library Reference</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
	38	border='0' height='32' alt='Module Index' width='32' /></a></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="module-doctest.html">5.2 doctest </A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="module-doctest.html">5.2 doctest </A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="doctest-simple-testfile.html">5.2.2 Simple Usage: Checking</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H2><A NAME="SECTION007210000000000000000"></A><A NAME="doctest-simple-testmod"></A>
	56	<BR>
	57	5.2.1 Simple Usage: Checking Examples in
	58	Docstrings
	59	</H2>
	60
	61	<P>
	62	The simplest way to start using doctest (but not necessarily the way
	63	you'll continue to do it) is to end each module <tt class="module">M</tt> with:
	64
65	<P>
66	<div class="verbatim"><pre>
67	def _test():
68	import doctest
69	doctest.testmod()
70
71	if __name__ == "__main__":
72	_test()
73	</pre></div>
74
75	<P>
76	<tt class="module"><a href="module-doctest.html">doctest</a></tt> then examines docstrings in module <tt class="module">M</tt>.
77
78	<P>
79	Running the module as a script causes the examples in the docstrings
80	to get executed and verified:
81
82	<P>
83	<div class="verbatim"><pre>
84	python M.py
85	</pre></div>
86
87	<P>
88	This won't display anything unless an example fails, in which case the
89	failing example(s) and the cause(s) of the failure(s) are printed to stdout,
90	and the final line of output is
91	"<tt class="samp">*Test Failed* <var>N</var> failures.</tt>", where <var>N</var> is the
92	number of examples that failed.
93
94	<P>
95	Run it with the <b class="programopt">-v</b> switch instead:
96
97	<P>
98	<div class="verbatim"><pre>
99	python M.py -v
100	</pre></div>
101
102	<P>
103	and a detailed report of all examples tried is printed to standard
104	output, along with assorted summaries at the end.
105
106	<P>
107	You can force verbose mode by passing <code>verbose=True</code> to
108	<tt class="function">testmod()</tt>, or
109	prohibit it by passing <code>verbose=False</code>. In either of those cases,
110	<code>sys.argv</code> is not examined by <tt class="function">testmod()</tt> (so passing
111	<b class="programopt">-v</b> or not has no effect).
112
113	<P>
114	For more information on <tt class="function">testmod()</tt>, see
115	section <A href="doctest-basic-api.html#doctest-basic-api">5.2.4</A>.
116
117	<P>
118
119	<DIV CLASS="navigation">
120	<div class='online-navigation'>
121	<p></p><hr />
122	<table align="center" width="100%" cellpadding="0" cellspacing="2">
123	<tr>
124	<td class='online-navigation'><a rel="prev" title="5.2 doctest "
125	href="module-doctest.html"><img src='../icons/previous.png'
126	border='0' height='32' alt='Previous Page' width='32' /></A></td>
127	<td class='online-navigation'><a rel="parent" title="5.2 doctest "
128	href="module-doctest.html"><img src='../icons/up.png'
129	border='0' height='32' alt='Up One Level' width='32' /></A></td>
130	<td class='online-navigation'><a rel="next" title="5.2.2 Simple Usage: Checking"
131	href="doctest-simple-testfile.html"><img src='../icons/next.png'
132	border='0' height='32' alt='Next Page' width='32' /></A></td>
133	<td align="center" width="100%">Python Library Reference</td>
134	<td class='online-navigation'><a rel="contents" title="Table of Contents"
135	href="contents.html"><img src='../icons/contents.png'
136	border='0' height='32' alt='Contents' width='32' /></A></td>
137	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
138	border='0' height='32' alt='Module Index' width='32' /></a></td>
139	<td class='online-navigation'><a rel="index" title="Index"
140	href="genindex.html"><img src='../icons/index.png'
141	border='0' height='32' alt='Index' width='32' /></A></td>
142	</tr></table>
143	<div class='online-navigation'>
144	<b class="navlabel">Previous:</b>
145	<a class="sectref" rel="prev" href="module-doctest.html">5.2 doctest </A>
146	<b class="navlabel">Up:</b>
147	<a class="sectref" rel="parent" href="module-doctest.html">5.2 doctest </A>
148	<b class="navlabel">Next:</b>
149	<a class="sectref" rel="next" href="doctest-simple-testfile.html">5.2.2 Simple Usage: Checking</A>
150	</div>
151	</div>
152	<hr />
153	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
154	</DIV>
155	<!--End of Navigation Panel-->
156	<ADDRESS>
157	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
158	</ADDRESS>
159	</BODY>
160	</HTML>