doc/html/api/lxml.doctestcompare.LXMLOutputChecker-class.html

   1 <?xml version="1.0" encoding="ascii"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3           "DTD/xhtml1-transitional.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6   <title>lxml.doctestcompare.LXMLOutputChecker</title>
   7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
   8   <script type="text/javascript" src="epydoc.js"></script>
   9 </head>
  10
  11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
  12       alink="#204080">
  13 <!-- ==================== NAVIGATION BAR ==================== -->
  14 <table class="navbar" border="0" width="100%" cellpadding="0"
  15        bgcolor="#a0c0ff" cellspacing="0">
  16   <tr valign="middle">
  17   <!-- Home link -->
  18       <th>&nbsp;&nbsp;&nbsp;<a
  19         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  20
  21   <!-- Tree link -->
  22       <th>&nbsp;&nbsp;&nbsp;<a
  23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  24
  25   <!-- Index link -->
  26       <th>&nbsp;&nbsp;&nbsp;<a
  27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  28
  29   <!-- Help link -->
  30       <th>&nbsp;&nbsp;&nbsp;<a
  31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  32
  33   <!-- Project homepage -->
  34       <th class="navbar" align="right" width="100%">
  35         <table border="0" cellpadding="0" cellspacing="0">
  36           <tr><th class="navbar" align="center"
  37             ><a class="navbar" target="_top" href="/">lxml API</a></th>
  38           </tr></table></th>
  39   </tr>
  40 </table>
  41 <table width="100%" cellpadding="0" cellspacing="0">
  42   <tr valign="top">
  43     <td width="100%">
  44       <span class="breadcrumbs">
  45         <a href="lxml-module.html">Package&nbsp;lxml</a> ::
  46         <a href="lxml.doctestcompare-module.html">Module&nbsp;doctestcompare</a> ::
  47         Class&nbsp;LXMLOutputChecker
  48       </span>
  49     </td>
  50     <td>
  51       <table cellpadding="0" cellspacing="0">
  52         <!-- hide/show private -->
  53         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  54     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  55         <tr><td align="right"><span class="options"
  56             >[<a href="frames.html" target="_top">frames</a
  57             >]&nbsp;|&nbsp;<a href="lxml.doctestcompare.LXMLOutputChecker-class.html"
  58             target="_top">no&nbsp;frames</a>]</span></td></tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <!-- ==================== CLASS DESCRIPTION ==================== -->
  64 <h1 class="epydoc">Class LXMLOutputChecker</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker">source&nbsp;code</a></span></p>
  65 <pre class="base-tree">
  66 doctest.OutputChecker --+
  67                         |
  68                        <strong class="uidshort">LXMLOutputChecker</strong>
  69 </pre>
  70
  71 <dl><dt>Known Subclasses:</dt>
  72 <dd>
  73       <ul class="subclass-list">
  74 <li><a href="lxml.doctestcompare.LHTMLOutputChecker-class.html">LHTMLOutputChecker</a></li>  </ul>
  75 </dd></dl>
  76
  77 <hr />
  78 <!-- ==================== INSTANCE METHODS ==================== -->
  79 <a name="section-InstanceMethods"></a>
  80 <table class="summary" border="1" cellpadding="3"
  81        cellspacing="0" width="100%" bgcolor="white">
  82 <tr bgcolor="#70b0f0" class="table-header">
  83   <td colspan="2" class="table-header">
  84     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  85       <tr valign="top">
  86         <td align="left"><span class="table-header">Instance Methods</span></td>
  87         <td align="right" valign="top"
  88          ><span class="options">[<a href="#section-InstanceMethods"
  89          class="privatelink" onclick="toggle_private();"
  90          >hide private</a>]</span></td>
  91       </tr>
  92     </table>
  93   </td>
  94 </tr>
  95 <tr>
  96     <td width="15%" align="right" valign="top" class="summary">
  97       <span class="summary-type">&nbsp;</span>
  98     </td><td class="summary">
  99       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 100         <tr>
 101           <td><span class="summary-sig"><a name="get_default_parser"></a><span class="summary-sig-name">get_default_parser</span>(<span class="summary-sig-arg">self</span>)</span></td>
 102           <td align="right" valign="top">
 103             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.get_default_parser">source&nbsp;code</a></span>
 104
 105           </td>
 106         </tr>
 107       </table>
 108
 109     </td>
 110   </tr>
 111 <tr>
 112     <td width="15%" align="right" valign="top" class="summary">
 113       <span class="summary-type">&nbsp;</span>
 114     </td><td class="summary">
 115       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 116         <tr>
 117           <td><span class="summary-sig"><a href="lxml.doctestcompare.LXMLOutputChecker-class.html#check_output" class="summary-sig-name">check_output</a>(<span class="summary-sig-arg">self</span>,
 118         <span class="summary-sig-arg">want</span>,
 119         <span class="summary-sig-arg">got</span>,
 120         <span class="summary-sig-arg">optionflags</span>)</span><br />
 121       Return True iff the actual output from an example (<code class="link">got</code>)
 122 matches the expected output (<code class="link">want</code>).  These strings are
 123 always considered to match if they are identical; but
 124 depending on what option flags the test runner is using,
 125 several non-exact match types are also possible.  See the
 126 documentation for <code class="link">TestRunner</code> for more information about
 127 option flags.</td>
 128           <td align="right" valign="top">
 129             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.check_output">source&nbsp;code</a></span>
 130
 131           </td>
 132         </tr>
 133       </table>
 134
 135     </td>
 136   </tr>
 137 <tr>
 138     <td width="15%" align="right" valign="top" class="summary">
 139       <span class="summary-type">&nbsp;</span>
 140     </td><td class="summary">
 141       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 142         <tr>
 143           <td><span class="summary-sig"><a name="get_parser"></a><span class="summary-sig-name">get_parser</span>(<span class="summary-sig-arg">self</span>,
 144         <span class="summary-sig-arg">want</span>,
 145         <span class="summary-sig-arg">got</span>,
 146         <span class="summary-sig-arg">optionflags</span>)</span></td>
 147           <td align="right" valign="top">
 148             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.get_parser">source&nbsp;code</a></span>
 149
 150           </td>
 151         </tr>
 152       </table>
 153
 154     </td>
 155   </tr>
 156 <tr class="private">
 157     <td width="15%" align="right" valign="top" class="summary">
 158       <span class="summary-type">&nbsp;</span>
 159     </td><td class="summary">
 160       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 161         <tr>
 162           <td><span class="summary-sig"><a name="_looks_like_markup"></a><span class="summary-sig-name">_looks_like_markup</span>(<span class="summary-sig-arg">self</span>,
 163         <span class="summary-sig-arg">s</span>)</span></td>
 164           <td align="right" valign="top">
 165             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker._looks_like_markup">source&nbsp;code</a></span>
 166
 167           </td>
 168         </tr>
 169       </table>
 170
 171     </td>
 172   </tr>
 173 <tr>
 174     <td width="15%" align="right" valign="top" class="summary">
 175       <span class="summary-type">&nbsp;</span>
 176     </td><td class="summary">
 177       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 178         <tr>
 179           <td><span class="summary-sig"><a name="compare_docs"></a><span class="summary-sig-name">compare_docs</span>(<span class="summary-sig-arg">self</span>,
 180         <span class="summary-sig-arg">want</span>,
 181         <span class="summary-sig-arg">got</span>)</span></td>
 182           <td align="right" valign="top">
 183             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.compare_docs">source&nbsp;code</a></span>
 184
 185           </td>
 186         </tr>
 187       </table>
 188
 189     </td>
 190   </tr>
 191 <tr>
 192     <td width="15%" align="right" valign="top" class="summary">
 193       <span class="summary-type">&nbsp;</span>
 194     </td><td class="summary">
 195       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 196         <tr>
 197           <td><span class="summary-sig"><a name="text_compare"></a><span class="summary-sig-name">text_compare</span>(<span class="summary-sig-arg">self</span>,
 198         <span class="summary-sig-arg">want</span>,
 199         <span class="summary-sig-arg">got</span>,
 200         <span class="summary-sig-arg">strip</span>)</span></td>
 201           <td align="right" valign="top">
 202             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.text_compare">source&nbsp;code</a></span>
 203
 204           </td>
 205         </tr>
 206       </table>
 207
 208     </td>
 209   </tr>
 210 <tr>
 211     <td width="15%" align="right" valign="top" class="summary">
 212       <span class="summary-type">&nbsp;</span>
 213     </td><td class="summary">
 214       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 215         <tr>
 216           <td><span class="summary-sig"><a name="tag_compare"></a><span class="summary-sig-name">tag_compare</span>(<span class="summary-sig-arg">self</span>,
 217         <span class="summary-sig-arg">want</span>,
 218         <span class="summary-sig-arg">got</span>)</span></td>
 219           <td align="right" valign="top">
 220             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.tag_compare">source&nbsp;code</a></span>
 221
 222           </td>
 223         </tr>
 224       </table>
 225
 226     </td>
 227   </tr>
 228 <tr>
 229     <td width="15%" align="right" valign="top" class="summary">
 230       <span class="summary-type">&nbsp;</span>
 231     </td><td class="summary">
 232       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 233         <tr>
 234           <td><span class="summary-sig"><a href="lxml.doctestcompare.LXMLOutputChecker-class.html#output_difference" class="summary-sig-name">output_difference</a>(<span class="summary-sig-arg">self</span>,
 235         <span class="summary-sig-arg">example</span>,
 236         <span class="summary-sig-arg">got</span>,
 237         <span class="summary-sig-arg">optionflags</span>)</span><br />
 238       Return a string describing the differences between the
 239 expected output for a given example (<code class="link">example</code>) and the actual
 240 output (<code class="link">got</code>).  <code class="link">optionflags</code> is the set of option flags used
 241 to compare <code class="link">want</code> and <code class="link">got</code>.</td>
 242           <td align="right" valign="top">
 243             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.output_difference">source&nbsp;code</a></span>
 244
 245           </td>
 246         </tr>
 247       </table>
 248
 249     </td>
 250   </tr>
 251 <tr>
 252     <td width="15%" align="right" valign="top" class="summary">
 253       <span class="summary-type">&nbsp;</span>
 254     </td><td class="summary">
 255       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 256         <tr>
 257           <td><span class="summary-sig"><a name="html_empty_tag"></a><span class="summary-sig-name">html_empty_tag</span>(<span class="summary-sig-arg">self</span>,
 258         <span class="summary-sig-arg">el</span>,
 259         <span class="summary-sig-arg">html</span>=<span class="summary-sig-default">True</span>)</span></td>
 260           <td align="right" valign="top">
 261             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.html_empty_tag">source&nbsp;code</a></span>
 262
 263           </td>
 264         </tr>
 265       </table>
 266
 267     </td>
 268   </tr>
 269 <tr>
 270     <td width="15%" align="right" valign="top" class="summary">
 271       <span class="summary-type">&nbsp;</span>
 272     </td><td class="summary">
 273       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 274         <tr>
 275           <td><span class="summary-sig"><a name="format_doc"></a><span class="summary-sig-name">format_doc</span>(<span class="summary-sig-arg">self</span>,
 276         <span class="summary-sig-arg">doc</span>,
 277         <span class="summary-sig-arg">html</span>,
 278         <span class="summary-sig-arg">indent</span>,
 279         <span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span></td>
 280           <td align="right" valign="top">
 281             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.format_doc">source&nbsp;code</a></span>
 282
 283           </td>
 284         </tr>
 285       </table>
 286
 287     </td>
 288   </tr>
 289 <tr>
 290     <td width="15%" align="right" valign="top" class="summary">
 291       <span class="summary-type">&nbsp;</span>
 292     </td><td class="summary">
 293       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 294         <tr>
 295           <td><span class="summary-sig"><a name="format_text"></a><span class="summary-sig-name">format_text</span>(<span class="summary-sig-arg">self</span>,
 296         <span class="summary-sig-arg">text</span>,
 297         <span class="summary-sig-arg">strip</span>=<span class="summary-sig-default">True</span>)</span></td>
 298           <td align="right" valign="top">
 299             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.format_text">source&nbsp;code</a></span>
 300
 301           </td>
 302         </tr>
 303       </table>
 304
 305     </td>
 306   </tr>
 307 <tr>
 308     <td width="15%" align="right" valign="top" class="summary">
 309       <span class="summary-type">&nbsp;</span>
 310     </td><td class="summary">
 311       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 312         <tr>
 313           <td><span class="summary-sig"><a name="format_tag"></a><span class="summary-sig-name">format_tag</span>(<span class="summary-sig-arg">self</span>,
 314         <span class="summary-sig-arg">el</span>)</span></td>
 315           <td align="right" valign="top">
 316             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.format_tag">source&nbsp;code</a></span>
 317
 318           </td>
 319         </tr>
 320       </table>
 321
 322     </td>
 323   </tr>
 324 <tr>
 325     <td width="15%" align="right" valign="top" class="summary">
 326       <span class="summary-type">&nbsp;</span>
 327     </td><td class="summary">
 328       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 329         <tr>
 330           <td><span class="summary-sig"><a name="format_end_tag"></a><span class="summary-sig-name">format_end_tag</span>(<span class="summary-sig-arg">self</span>,
 331         <span class="summary-sig-arg">el</span>)</span></td>
 332           <td align="right" valign="top">
 333             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.format_end_tag">source&nbsp;code</a></span>
 334
 335           </td>
 336         </tr>
 337       </table>
 338
 339     </td>
 340   </tr>
 341 <tr>
 342     <td width="15%" align="right" valign="top" class="summary">
 343       <span class="summary-type">&nbsp;</span>
 344     </td><td class="summary">
 345       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 346         <tr>
 347           <td><span class="summary-sig"><a name="collect_diff"></a><span class="summary-sig-name">collect_diff</span>(<span class="summary-sig-arg">self</span>,
 348         <span class="summary-sig-arg">want</span>,
 349         <span class="summary-sig-arg">got</span>,
 350         <span class="summary-sig-arg">html</span>,
 351         <span class="summary-sig-arg">indent</span>)</span></td>
 352           <td align="right" valign="top">
 353             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.collect_diff">source&nbsp;code</a></span>
 354
 355           </td>
 356         </tr>
 357       </table>
 358
 359     </td>
 360   </tr>
 361 <tr>
 362     <td width="15%" align="right" valign="top" class="summary">
 363       <span class="summary-type">&nbsp;</span>
 364     </td><td class="summary">
 365       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 366         <tr>
 367           <td><span class="summary-sig"><a name="collect_diff_tag"></a><span class="summary-sig-name">collect_diff_tag</span>(<span class="summary-sig-arg">self</span>,
 368         <span class="summary-sig-arg">want</span>,
 369         <span class="summary-sig-arg">got</span>)</span></td>
 370           <td align="right" valign="top">
 371             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.collect_diff_tag">source&nbsp;code</a></span>
 372
 373           </td>
 374         </tr>
 375       </table>
 376
 377     </td>
 378   </tr>
 379 <tr>
 380     <td width="15%" align="right" valign="top" class="summary">
 381       <span class="summary-type">&nbsp;</span>
 382     </td><td class="summary">
 383       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 384         <tr>
 385           <td><span class="summary-sig"><a name="collect_diff_end_tag"></a><span class="summary-sig-name">collect_diff_end_tag</span>(<span class="summary-sig-arg">self</span>,
 386         <span class="summary-sig-arg">want</span>,
 387         <span class="summary-sig-arg">got</span>)</span></td>
 388           <td align="right" valign="top">
 389             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.collect_diff_end_tag">source&nbsp;code</a></span>
 390
 391           </td>
 392         </tr>
 393       </table>
 394
 395     </td>
 396   </tr>
 397 <tr>
 398     <td width="15%" align="right" valign="top" class="summary">
 399       <span class="summary-type">&nbsp;</span>
 400     </td><td class="summary">
 401       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 402         <tr>
 403           <td><span class="summary-sig"><a name="collect_diff_text"></a><span class="summary-sig-name">collect_diff_text</span>(<span class="summary-sig-arg">self</span>,
 404         <span class="summary-sig-arg">want</span>,
 405         <span class="summary-sig-arg">got</span>,
 406         <span class="summary-sig-arg">strip</span>=<span class="summary-sig-default">True</span>)</span></td>
 407           <td align="right" valign="top">
 408             <span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.collect_diff_text">source&nbsp;code</a></span>
 409
 410           </td>
 411         </tr>
 412       </table>
 413
 414     </td>
 415   </tr>
 416   <tr>
 417     <td colspan="2" class="summary">
 418     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code>doctest.OutputChecker</code></b> (private):
 419       <code>_do_a_fancy_diff</code>
 420       </p></div>
 421     </td>
 422   </tr>
 423 </table>
 424 <!-- ==================== CLASS VARIABLES ==================== -->
 425 <a name="section-ClassVariables"></a>
 426 <table class="summary" border="1" cellpadding="3"
 427        cellspacing="0" width="100%" bgcolor="white">
 428 <tr bgcolor="#70b0f0" class="table-header">
 429   <td colspan="2" class="table-header">
 430     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 431       <tr valign="top">
 432         <td align="left"><span class="table-header">Class Variables</span></td>
 433         <td align="right" valign="top"
 434          ><span class="options">[<a href="#section-ClassVariables"
 435          class="privatelink" onclick="toggle_private();"
 436          >hide private</a>]</span></td>
 437       </tr>
 438     </table>
 439   </td>
 440 </tr>
 441 <tr>
 442     <td width="15%" align="right" valign="top" class="summary">
 443       <span class="summary-type">&nbsp;</span>
 444     </td><td class="summary">
 445         <a href="lxml.doctestcompare.LXMLOutputChecker-class.html#empty_tags" class="summary-name">empty_tags</a> = <code title="('param',
 446  'img',
 447  'area',
 448  'br',
 449  'basefont',
 450  'input',
 451  'base',
 452  'meta',
 453 ..."><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">param</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">img</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">area</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">br</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">basefont</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">input</code><code class="variable-ellipsis">...</code></code>
 454     </td>
 455   </tr>
 456 </table>
 457 <!-- ==================== METHOD DETAILS ==================== -->
 458 <a name="section-MethodDetails"></a>
 459 <table class="details" border="1" cellpadding="3"
 460        cellspacing="0" width="100%" bgcolor="white">
 461 <tr bgcolor="#70b0f0" class="table-header">
 462   <td colspan="2" class="table-header">
 463     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 464       <tr valign="top">
 465         <td align="left"><span class="table-header">Method Details</span></td>
 466         <td align="right" valign="top"
 467          ><span class="options">[<a href="#section-MethodDetails"
 468          class="privatelink" onclick="toggle_private();"
 469          >hide private</a>]</span></td>
 470       </tr>
 471     </table>
 472   </td>
 473 </tr>
 474 </table>
 475 <a name="check_output"></a>
 476 <div>
 477 <table class="details" border="1" cellpadding="3"
 478        cellspacing="0" width="100%" bgcolor="white">
 479 <tr><td>
 480   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 481   <tr valign="top"><td>
 482   <h3 class="epydoc"><span class="sig"><span class="sig-name">check_output</span>(<span class="sig-arg">self</span>,
 483         <span class="sig-arg">want</span>,
 484         <span class="sig-arg">got</span>,
 485         <span class="sig-arg">optionflags</span>)</span>
 486   </h3>
 487   </td><td align="right" valign="top"
 488     ><span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.check_output">source&nbsp;code</a></span>&nbsp;
 489     </td>
 490   </tr></table>
 491
 492   Return True iff the actual output from an example (<code class="link">got</code>)
 493 matches the expected output (<code class="link">want</code>).  These strings are
 494 always considered to match if they are identical; but
 495 depending on what option flags the test runner is using,
 496 several non-exact match types are also possible.  See the
 497 documentation for <code class="link">TestRunner</code> for more information about
 498 option flags.
 499   <dl class="fields">
 500     <dt>Overrides:
 501         doctest.OutputChecker.check_output
 502         <dd><em class="note">(inherited documentation)</em></dd>
 503     </dt>
 504   </dl>
 505 </td></tr></table>
 506 </div>
 507 <a name="output_difference"></a>
 508 <div>
 509 <table class="details" border="1" cellpadding="3"
 510        cellspacing="0" width="100%" bgcolor="white">
 511 <tr><td>
 512   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 513   <tr valign="top"><td>
 514   <h3 class="epydoc"><span class="sig"><span class="sig-name">output_difference</span>(<span class="sig-arg">self</span>,
 515         <span class="sig-arg">example</span>,
 516         <span class="sig-arg">got</span>,
 517         <span class="sig-arg">optionflags</span>)</span>
 518   </h3>
 519   </td><td align="right" valign="top"
 520     ><span class="codelink"><a href="lxml.doctestcompare-pysrc.html#LXMLOutputChecker.output_difference">source&nbsp;code</a></span>&nbsp;
 521     </td>
 522   </tr></table>
 523
 524   Return a string describing the differences between the
 525 expected output for a given example (<code class="link">example</code>) and the actual
 526 output (<code class="link">got</code>).  <code class="link">optionflags</code> is the set of option flags used
 527 to compare <code class="link">want</code> and <code class="link">got</code>.
 528   <dl class="fields">
 529     <dt>Overrides:
 530         doctest.OutputChecker.output_difference
 531         <dd><em class="note">(inherited documentation)</em></dd>
 532     </dt>
 533   </dl>
 534 </td></tr></table>
 535 </div>
 536 <br />
 537 <!-- ==================== CLASS VARIABLE DETAILS ==================== -->
 538 <a name="section-ClassVariableDetails"></a>
 539 <table class="details" border="1" cellpadding="3"
 540        cellspacing="0" width="100%" bgcolor="white">
 541 <tr bgcolor="#70b0f0" class="table-header">
 542   <td colspan="2" class="table-header">
 543     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 544       <tr valign="top">
 545         <td align="left"><span class="table-header">Class Variable Details</span></td>
 546         <td align="right" valign="top"
 547          ><span class="options">[<a href="#section-ClassVariableDetails"
 548          class="privatelink" onclick="toggle_private();"
 549          >hide private</a>]</span></td>
 550       </tr>
 551     </table>
 552   </td>
 553 </tr>
 554 </table>
 555 <a name="empty_tags"></a>
 556 <div>
 557 <table class="details" border="1" cellpadding="3"
 558        cellspacing="0" width="100%" bgcolor="white">
 559 <tr><td>
 560   <h3 class="epydoc">empty_tags</h3>
 561
 562   <dl class="fields">
 563   </dl>
 564   <dl class="fields">
 565     <dt>Value:</dt>
 566       <dd><table><tr><td><pre class="variable">
 567 <code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">param</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 568  <code class="variable-quote">'</code><code class="variable-string">img</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 569  <code class="variable-quote">'</code><code class="variable-string">area</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 570  <code class="variable-quote">'</code><code class="variable-string">br</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 571  <code class="variable-quote">'</code><code class="variable-string">basefont</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 572  <code class="variable-quote">'</code><code class="variable-string">input</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 573  <code class="variable-quote">'</code><code class="variable-string">base</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 574  <code class="variable-quote">'</code><code class="variable-string">meta</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 575 <code class="variable-ellipsis">...</code>
 576 </pre></td></tr></table>
 577 </dd>
 578   </dl>
 579 </td></tr></table>
 580 </div>
 581 <br />
 582 <!-- ==================== NAVIGATION BAR ==================== -->
 583 <table class="navbar" border="0" width="100%" cellpadding="0"
 584        bgcolor="#a0c0ff" cellspacing="0">
 585   <tr valign="middle">
 586   <!-- Home link -->
 587       <th>&nbsp;&nbsp;&nbsp;<a
 588         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 589
 590   <!-- Tree link -->
 591       <th>&nbsp;&nbsp;&nbsp;<a
 592         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 593
 594   <!-- Index link -->
 595       <th>&nbsp;&nbsp;&nbsp;<a
 596         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 597
 598   <!-- Help link -->
 599       <th>&nbsp;&nbsp;&nbsp;<a
 600         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 601
 602   <!-- Project homepage -->
 603       <th class="navbar" align="right" width="100%">
 604         <table border="0" cellpadding="0" cellspacing="0">
 605           <tr><th class="navbar" align="center"
 606             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 607           </tr></table></th>
 608   </tr>
 609 </table>
 610 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 611   <tr>
 612     <td align="left" class="footer">
 613     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 614     </td>
 615     <td align="right" class="footer">
 616       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 617         >http://epydoc.sourceforge.net</a>
 618     </td>
 619   </tr>
 620 </table>
 621
 622 <script type="text/javascript">
 623   <!--
 624   // Private objects are initially displayed (because if
 625   // javascript is turned off then we want them to be
 626   // visible); but by default, we want to hide them.  So hide
 627   // them unless we have a cookie that says to show them.
 628   checkCookie();
 629   // -->
 630 </script>
 631 </body>
 632 </html>