projects / OpenSPARC-T2-SAM / blame
| 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-DocTestRunner.html" /> | |
| 13 | <link rel="prev" href="doctest-DocTestFinder.html" /> | |
| 14 | <link rel="parent" href="doctest-advanced-api.html" /> | |
| 15 | <link rel="next" href="doctest-DocTestRunner.html" /> | |
| 16 | <meta name='aesop' content='information' /> | |
| 17 | <title>5.2.6.4 DocTestParser objects</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.6.3 DocTestFinder objects" | |
| 25 | href="doctest-DocTestFinder.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.6 Advanced API" | |
| 28 | href="doctest-advanced-api.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.6.5 DocTestRunner objects" | |
| 31 | href="doctest-DocTestRunner.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="doctest-DocTestFinder.html">5.2.6.3 DocTestFinder objects</A> | |
| 46 | <b class="navlabel">Up:</b> | |
| 47 | <a class="sectref" rel="parent" href="doctest-advanced-api.html">5.2.6 Advanced API</A> | |
| 48 | <b class="navlabel">Next:</b> | |
| 49 | <a class="sectref" rel="next" href="doctest-DocTestRunner.html">5.2.6.5 DocTestRunner objects</A> | |
| 50 | </div> | |
| 51 | <hr /></div> | |
| 52 | </DIV> | |
| 53 | <!--End of Navigation Panel--> | |
| 54 | ||
| 55 | <H3><A NAME="SECTION007264000000000000000"></A><A NAME="doctest-DocTestParser"></A> | |
| 56 | <BR> | |
| 57 | 5.2.6.4 DocTestParser objects | |
| 58 | </H3> | |
| 59 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
| 60 | <td><nobr><b><span class="typelabel">class</span> <tt id='l2h-1096' xml:id='l2h-1096' class="class">DocTestParser</tt></b>(</nobr></td> | |
| 61 | <td><var></var>)</td></tr></table></dt> | |
| 62 | <dd> | |
| 63 | A processing class used to extract interactive examples from a | |
| 64 | string, and use them to create a <tt class="class">DocTest</tt> object. | |
| 65 | ||
| 66 | <span class="versionnote">New in version 2.4.</span> | |
| 67 | ||
| 68 | </dl> | |
| 69 | ||
| 70 | <P> | |
| 71 | <tt class="class">DocTestParser</tt> defines the following methods: | |
| 72 | ||
| 73 | <P> | |
| 74 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
| 75 | <td><nobr><b><tt id='l2h-1097' xml:id='l2h-1097' class="method">get_doctest</tt></b>(</nobr></td> | |
| 76 | <td><var>string, globs, name, filename, lineno</var>)</td></tr></table></dt> | |
| 77 | <dd> | |
| 78 | Extract all doctest examples from the given string, and collect | |
| 79 | them into a <tt class="class">DocTest</tt> object. | |
| 80 | ||
| 81 | <P> | |
| 82 | <var>globs</var>, <var>name</var>, <var>filename</var>, and <var>lineno</var> are | |
| 83 | attributes for the new <tt class="class">DocTest</tt> object. See the | |
| 84 | documentation for <tt class="class">DocTest</tt> for more information. | |
| 85 | </dl> | |
| 86 | ||
| 87 | <P> | |
| 88 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
| 89 | <td><nobr><b><tt id='l2h-1098' xml:id='l2h-1098' class="method">get_examples</tt></b>(</nobr></td> | |
| 90 | <td><var>string</var><big>[</big><var>, name</var><big>]</big><var></var>)</td></tr></table></dt> | |
| 91 | <dd> | |
| 92 | Extract all doctest examples from the given string, and return | |
| 93 | them as a list of <tt class="class">Example</tt> objects. Line numbers are | |
| 94 | 0-based. The optional argument <var>name</var> is a name identifying | |
| 95 | this string, and is only used for error messages. | |
| 96 | </dl> | |
| 97 | ||
| 98 | <P> | |
| 99 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
| 100 | <td><nobr><b><tt id='l2h-1099' xml:id='l2h-1099' class="method">parse</tt></b>(</nobr></td> | |
| 101 | <td><var>string</var><big>[</big><var>, name</var><big>]</big><var></var>)</td></tr></table></dt> | |
| 102 | <dd> | |
| 103 | Divide the given string into examples and intervening text, and | |
| 104 | return them as a list of alternating <tt class="class">Example</tt>s and strings. | |
| 105 | Line numbers for the <tt class="class">Example</tt>s are 0-based. The optional | |
| 106 | argument <var>name</var> is a name identifying this string, and is only | |
| 107 | used for error messages. | |
| 108 | </dl> | |
| 109 | ||
| 110 | <P> | |
| 111 | ||
| 112 | <DIV CLASS="navigation"> | |
| 113 | <div class='online-navigation'> | |
| 114 | <p></p><hr /> | |
| 115 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
| 116 | <tr> | |
| 117 | <td class='online-navigation'><a rel="prev" title="5.2.6.3 DocTestFinder objects" | |
| 118 | href="doctest-DocTestFinder.html"><img src='../icons/previous.png' | |
| 119 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
| 120 | <td class='online-navigation'><a rel="parent" title="5.2.6 Advanced API" | |
| 121 | href="doctest-advanced-api.html"><img src='../icons/up.png' | |
| 122 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
| 123 | <td class='online-navigation'><a rel="next" title="5.2.6.5 DocTestRunner objects" | |
| 124 | href="doctest-DocTestRunner.html"><img src='../icons/next.png' | |
| 125 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
| 126 | <td align="center" width="100%">Python Library Reference</td> | |
| 127 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
| 128 | href="contents.html"><img src='../icons/contents.png' | |
| 129 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
| 130 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
| 131 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
| 132 | <td class='online-navigation'><a rel="index" title="Index" | |
| 133 | href="genindex.html"><img src='../icons/index.png' | |
| 134 | border='0' height='32' alt='Index' width='32' /></A></td> | |
| 135 | </tr></table> | |
| 136 | <div class='online-navigation'> | |
| 137 | <b class="navlabel">Previous:</b> | |
| 138 | <a class="sectref" rel="prev" href="doctest-DocTestFinder.html">5.2.6.3 DocTestFinder objects</A> | |
| 139 | <b class="navlabel">Up:</b> | |
| 140 | <a class="sectref" rel="parent" href="doctest-advanced-api.html">5.2.6 Advanced API</A> | |
| 141 | <b class="navlabel">Next:</b> | |
| 142 | <a class="sectref" rel="next" href="doctest-DocTestRunner.html">5.2.6.5 DocTestRunner objects</A> | |
| 143 | </div> | |
| 144 | </div> | |
| 145 | <hr /> | |
| 146 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
| 147 | </DIV> | |
| 148 | <!--End of Navigation Panel--> | |
| 149 | <ADDRESS> | |
| 150 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
| 151 | </ADDRESS> | |
| 152 | </BODY> | |
| 153 | </HTML> |