sam-t2/devtools/v9/html/python/lib/doctest-DocTestParser.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-DocTestRunner.html" />
<link rel="prev" href="doctest-DocTestFinder.html" />
<link rel="parent" href="doctest-advanced-api.html" />
<link rel="next" href="doctest-DocTestRunner.html" />
<meta name='aesop' content='information' />
<title>5.2.6.4 DocTestParser objects</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.6.3 DocTestFinder objects"
  href="doctest-DocTestFinder.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.5 DocTestRunner objects"
  href="doctest-DocTestRunner.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="doctest-DocTestFinder.html">5.2.6.3 DocTestFinder 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-DocTestRunner.html">5.2.6.5 DocTestRunner objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H3><A NAME="SECTION007264000000000000000"></A><A NAME="doctest-DocTestParser"></A>
<BR>
5.2.6.4 DocTestParser objects
</H3>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-1096' xml:id='l2h-1096' class="class">DocTestParser</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
    A processing class used to extract interactive examples from a
    string, and use them to create a <tt class="class">DocTest</tt> object.

<span class="versionnote">New in version 2.4.</span>

</dl>

<P>
<tt class="class">DocTestParser</tt> defines the following methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1097' xml:id='l2h-1097' class="method">get_doctest</tt></b>(</nobr></td>
  <td><var>string, globs, name, filename, lineno</var>)</td></tr></table></dt>
<dd>
    Extract all doctest examples from the given string, and collect
    them into a <tt class="class">DocTest</tt> object.

<P>
<var>globs</var>, <var>name</var>, <var>filename</var>, and <var>lineno</var> are
    attributes for the new <tt class="class">DocTest</tt> object.  See the
    documentation for <tt class="class">DocTest</tt> for more information.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1098' xml:id='l2h-1098' class="method">get_examples</tt></b>(</nobr></td>
  <td><var>string</var><big>[</big><var>, name</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
    Extract all doctest examples from the given string, and return
    them as a list of <tt class="class">Example</tt> objects.  Line numbers are
    0-based.  The optional argument <var>name</var> is a name identifying
    this string, and is only used for error messages.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1099' xml:id='l2h-1099' class="method">parse</tt></b>(</nobr></td>
  <td><var>string</var><big>[</big><var>, name</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
    Divide the given string into examples and intervening text, and
    return them as a list of alternating <tt class="class">Example</tt>s and strings.
    Line numbers for the <tt class="class">Example</tt>s are 0-based.  The optional
    argument <var>name</var> is a name identifying this string, and is only
    used for error messages.
</dl>

<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.6.3 DocTestFinder objects"
  href="doctest-DocTestFinder.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.5 DocTestRunner objects"
  href="doctest-DocTestRunner.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="doctest-DocTestFinder.html">5.2.6.3 DocTestFinder 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-DocTestRunner.html">5.2.6.5 DocTestRunner objects</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>