doc/html/api/lxml.tests.common_imports-module.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.tests.common_imports</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.tests-module.html">Package&nbsp;tests</a> ::
  47         Module&nbsp;common_imports
  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.tests.common_imports-module.html"
  58             target="_top">no&nbsp;frames</a>]</span></td></tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <!-- ==================== MODULE DESCRIPTION ==================== -->
  64 <h1 class="epydoc">Module common_imports</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.tests.common_imports-pysrc.html">source&nbsp;code</a></span></p>
  65 <!-- ==================== CLASSES ==================== -->
  66 <a name="section-Classes"></a>
  67 <table class="summary" border="1" cellpadding="3"
  68        cellspacing="0" width="100%" bgcolor="white">
  69 <tr bgcolor="#70b0f0" class="table-header">
  70   <td colspan="2" class="table-header">
  71     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  72       <tr valign="top">
  73         <td align="left"><span class="table-header">Classes</span></td>
  74         <td align="right" valign="top"
  75          ><span class="options">[<a href="#section-Classes"
  76          class="privatelink" onclick="toggle_private();"
  77          >hide private</a>]</span></td>
  78       </tr>
  79     </table>
  80   </td>
  81 </tr>
  82 <tr>
  83     <td width="15%" align="right" valign="top" class="summary">
  84       <span class="summary-type">&nbsp;</span>
  85     </td><td class="summary">
  86         <a href="lxml.tests.common_imports.HelperTestCase-class.html" class="summary-name">HelperTestCase</a>
  87     </td>
  88   </tr>
  89 <tr>
  90     <td width="15%" align="right" valign="top" class="summary">
  91       <span class="summary-type">&nbsp;</span>
  92     </td><td class="summary">
  93         <a href="lxml.tests.common_imports.SillyFileLike-class.html" class="summary-name">SillyFileLike</a>
  94     </td>
  95   </tr>
  96 <tr>
  97     <td width="15%" align="right" valign="top" class="summary">
  98       <span class="summary-type">&nbsp;</span>
  99     </td><td class="summary">
 100         <a href="lxml.tests.common_imports.LargeFileLike-class.html" class="summary-name">LargeFileLike</a>
 101     </td>
 102   </tr>
 103 <tr>
 104     <td width="15%" align="right" valign="top" class="summary">
 105       <span class="summary-type">&nbsp;</span>
 106     </td><td class="summary">
 107         <a href="lxml.tests.common_imports.LargeFileLikeUnicode-class.html" class="summary-name">LargeFileLikeUnicode</a>
 108     </td>
 109   </tr>
 110 </table>
 111 <!-- ==================== FUNCTIONS ==================== -->
 112 <a name="section-Functions"></a>
 113 <table class="summary" border="1" cellpadding="3"
 114        cellspacing="0" width="100%" bgcolor="white">
 115 <tr bgcolor="#70b0f0" class="table-header">
 116   <td colspan="2" class="table-header">
 117     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 118       <tr valign="top">
 119         <td align="left"><span class="table-header">Functions</span></td>
 120         <td align="right" valign="top"
 121          ><span class="options">[<a href="#section-Functions"
 122          class="privatelink" onclick="toggle_private();"
 123          >hide private</a>]</span></td>
 124       </tr>
 125     </table>
 126   </td>
 127 </tr>
 128 <tr>
 129     <td width="15%" align="right" valign="top" class="summary">
 130       <span class="summary-type">&nbsp;</span>
 131     </td><td class="summary">
 132       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 133         <tr>
 134           <td><span class="summary-sig"><a name="make_version_tuple"></a><span class="summary-sig-name">make_version_tuple</span>(<span class="summary-sig-arg">version_string</span>)</span></td>
 135           <td align="right" valign="top">
 136             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#make_version_tuple">source&nbsp;code</a></span>
 137
 138           </td>
 139         </tr>
 140       </table>
 141
 142     </td>
 143   </tr>
 144 <tr>
 145     <td width="15%" align="right" valign="top" class="summary">
 146       <span class="summary-type">&nbsp;</span>
 147     </td><td class="summary">
 148       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 149         <tr>
 150           <td><span class="summary-sig"><a name="filter_by_version"></a><span class="summary-sig-name">filter_by_version</span>(<span class="summary-sig-arg">test_class</span>,
 151         <span class="summary-sig-arg">version_dict</span>,
 152         <span class="summary-sig-arg">current_version</span>)</span><br />
 153       Remove test methods that do not work with the current lib version.</td>
 154           <td align="right" valign="top">
 155             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#filter_by_version">source&nbsp;code</a></span>
 156
 157           </td>
 158         </tr>
 159       </table>
 160
 161     </td>
 162   </tr>
 163 <tr class="private">
 164     <td width="15%" align="right" valign="top" class="summary">
 165       <span class="summary-type">&nbsp;</span>
 166     </td><td class="summary">
 167       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 168         <tr>
 169           <td><span class="summary-sig"><a name="_get_caller_relative_path"></a><span class="summary-sig-name">_get_caller_relative_path</span>(<span class="summary-sig-arg">filename</span>,
 170         <span class="summary-sig-arg">frame_depth</span>=<span class="summary-sig-default">2</span>)</span></td>
 171           <td align="right" valign="top">
 172             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#_get_caller_relative_path">source&nbsp;code</a></span>
 173
 174           </td>
 175         </tr>
 176       </table>
 177
 178     </td>
 179   </tr>
 180 <tr class="private">
 181     <td width="15%" align="right" valign="top" class="summary">
 182       <span class="summary-type">&nbsp;</span>
 183     </td><td class="summary">
 184       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 185         <tr>
 186           <td><span class="summary-sig"><a name="_str"></a><span class="summary-sig-name">_str</span>(<span class="summary-sig-arg">s</span>,
 187         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">UTF-8</code><code class="variable-quote">'</code></span>)</span></td>
 188           <td align="right" valign="top">
 189             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#_str">source&nbsp;code</a></span>
 190
 191           </td>
 192         </tr>
 193       </table>
 194
 195     </td>
 196   </tr>
 197 <tr class="private">
 198     <td width="15%" align="right" valign="top" class="summary">
 199       <span class="summary-type">&nbsp;</span>
 200     </td><td class="summary">
 201       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 202         <tr>
 203           <td><span class="summary-sig"><a name="_bytes"></a><span class="summary-sig-name">_bytes</span>(<span class="summary-sig-arg">s</span>,
 204         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">UTF-8</code><code class="variable-quote">'</code></span>)</span></td>
 205           <td align="right" valign="top">
 206             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#_bytes">source&nbsp;code</a></span>
 207
 208           </td>
 209         </tr>
 210       </table>
 211
 212     </td>
 213   </tr>
 214 <tr class="private">
 215     <td width="15%" align="right" valign="top" class="summary">
 216       <span class="summary-type">&nbsp;</span>
 217     </td><td class="summary">
 218       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 219         <tr>
 220           <td><span class="summary-sig"><a name="_fix_traceback"></a><span class="summary-sig-name">_fix_traceback</span>(<span class="summary-sig-arg">...</span>)</span><br />
 221       sub(repl, string[, count = 0]) --&gt; newstring
 222 Return the string obtained by replacing the leftmost non-overlapping
 223 occurrences of pattern in string by the replacement repl.</td>
 224           <td align="right" valign="top">
 225             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#_fix_traceback">source&nbsp;code</a></span>
 226
 227           </td>
 228         </tr>
 229       </table>
 230
 231     </td>
 232   </tr>
 233 <tr class="private">
 234     <td width="15%" align="right" valign="top" class="summary">
 235       <span class="summary-type">&nbsp;</span>
 236     </td><td class="summary">
 237       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 238         <tr>
 239           <td><span class="summary-sig"><a name="_fix_exceptions"></a><span class="summary-sig-name">_fix_exceptions</span>(<span class="summary-sig-arg">...</span>)</span><br />
 240       sub(repl, string[, count = 0]) --&gt; newstring
 241 Return the string obtained by replacing the leftmost non-overlapping
 242 occurrences of pattern in string by the replacement repl.</td>
 243           <td align="right" valign="top">
 244             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#_fix_exceptions">source&nbsp;code</a></span>
 245
 246           </td>
 247         </tr>
 248       </table>
 249
 250     </td>
 251   </tr>
 252 <tr class="private">
 253     <td width="15%" align="right" valign="top" class="summary">
 254       <span class="summary-type">&nbsp;</span>
 255     </td><td class="summary">
 256       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 257         <tr>
 258           <td><span class="summary-sig"><a name="_fix_bytes"></a><span class="summary-sig-name">_fix_bytes</span>(<span class="summary-sig-arg">...</span>)</span><br />
 259       sub(repl, string[, count = 0]) --&gt; newstring
 260 Return the string obtained by replacing the leftmost non-overlapping
 261 occurrences of pattern in string by the replacement repl.</td>
 262           <td align="right" valign="top">
 263             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#_fix_bytes">source&nbsp;code</a></span>
 264
 265           </td>
 266         </tr>
 267       </table>
 268
 269     </td>
 270   </tr>
 271 <tr>
 272     <td width="15%" align="right" valign="top" class="summary">
 273       <span class="summary-type">&nbsp;</span>
 274     </td><td class="summary">
 275       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 276         <tr>
 277           <td><span class="summary-sig"><a name="make_doctest"></a><span class="summary-sig-name">make_doctest</span>(<span class="summary-sig-arg">filename</span>)</span></td>
 278           <td align="right" valign="top">
 279             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#make_doctest">source&nbsp;code</a></span>
 280
 281           </td>
 282         </tr>
 283       </table>
 284
 285     </td>
 286   </tr>
 287 <tr>
 288     <td width="15%" align="right" valign="top" class="summary">
 289       <span class="summary-type">&nbsp;</span>
 290     </td><td class="summary">
 291       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 292         <tr>
 293           <td><span class="summary-sig"><a name="fileInTestDir"></a><span class="summary-sig-name">fileInTestDir</span>(<span class="summary-sig-arg">name</span>)</span></td>
 294           <td align="right" valign="top">
 295             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#fileInTestDir">source&nbsp;code</a></span>
 296
 297           </td>
 298         </tr>
 299       </table>
 300
 301     </td>
 302   </tr>
 303 <tr>
 304     <td width="15%" align="right" valign="top" class="summary">
 305       <span class="summary-type">&nbsp;</span>
 306     </td><td class="summary">
 307       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 308         <tr>
 309           <td><span class="summary-sig"><a name="read_file"></a><span class="summary-sig-name">read_file</span>(<span class="summary-sig-arg">name</span>,
 310         <span class="summary-sig-arg">mode</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">r</code><code class="variable-quote">'</code></span>)</span></td>
 311           <td align="right" valign="top">
 312             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#read_file">source&nbsp;code</a></span>
 313
 314           </td>
 315         </tr>
 316       </table>
 317
 318     </td>
 319   </tr>
 320 <tr>
 321     <td width="15%" align="right" valign="top" class="summary">
 322       <span class="summary-type">&nbsp;</span>
 323     </td><td class="summary">
 324       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 325         <tr>
 326           <td><span class="summary-sig"><a name="write_to_file"></a><span class="summary-sig-name">write_to_file</span>(<span class="summary-sig-arg">name</span>,
 327         <span class="summary-sig-arg">data</span>,
 328         <span class="summary-sig-arg">mode</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">w</code><code class="variable-quote">'</code></span>)</span></td>
 329           <td align="right" valign="top">
 330             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#write_to_file">source&nbsp;code</a></span>
 331
 332           </td>
 333         </tr>
 334       </table>
 335
 336     </td>
 337   </tr>
 338 <tr>
 339     <td width="15%" align="right" valign="top" class="summary">
 340       <span class="summary-type">&nbsp;</span>
 341     </td><td class="summary">
 342       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 343         <tr>
 344           <td><span class="summary-sig"><a name="readFileInTestDir"></a><span class="summary-sig-name">readFileInTestDir</span>(<span class="summary-sig-arg">name</span>,
 345         <span class="summary-sig-arg">mode</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">r</code><code class="variable-quote">'</code></span>)</span></td>
 346           <td align="right" valign="top">
 347             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#readFileInTestDir">source&nbsp;code</a></span>
 348
 349           </td>
 350         </tr>
 351       </table>
 352
 353     </td>
 354   </tr>
 355 <tr>
 356     <td width="15%" align="right" valign="top" class="summary">
 357       <span class="summary-type">&nbsp;</span>
 358     </td><td class="summary">
 359       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 360         <tr>
 361           <td><span class="summary-sig"><a name="canonicalize"></a><span class="summary-sig-name">canonicalize</span>(<span class="summary-sig-arg">xml</span>)</span></td>
 362           <td align="right" valign="top">
 363             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#canonicalize">source&nbsp;code</a></span>
 364
 365           </td>
 366         </tr>
 367       </table>
 368
 369     </td>
 370   </tr>
 371 <tr>
 372     <td width="15%" align="right" valign="top" class="summary">
 373       <span class="summary-type">&nbsp;</span>
 374     </td><td class="summary">
 375       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 376         <tr>
 377           <td><span class="summary-sig"><a name="unentitify"></a><span class="summary-sig-name">unentitify</span>(<span class="summary-sig-arg">xml</span>)</span></td>
 378           <td align="right" valign="top">
 379             <span class="codelink"><a href="lxml.tests.common_imports-pysrc.html#unentitify">source&nbsp;code</a></span>
 380
 381           </td>
 382         </tr>
 383       </table>
 384
 385     </td>
 386   </tr>
 387 </table>
 388 <!-- ==================== VARIABLES ==================== -->
 389 <a name="section-Variables"></a>
 390 <table class="summary" border="1" cellpadding="3"
 391        cellspacing="0" width="100%" bgcolor="white">
 392 <tr bgcolor="#70b0f0" class="table-header">
 393   <td colspan="2" class="table-header">
 394     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 395       <tr valign="top">
 396         <td align="left"><span class="table-header">Variables</span></td>
 397         <td align="right" valign="top"
 398          ><span class="options">[<a href="#section-Variables"
 399          class="privatelink" onclick="toggle_private();"
 400          >hide private</a>]</span></td>
 401       </tr>
 402     </table>
 403   </td>
 404 </tr>
 405 <tr>
 406     <td width="15%" align="right" valign="top" class="summary">
 407       <span class="summary-type">&nbsp;</span>
 408     </td><td class="summary">
 409         <a name="ET_VERSION"></a><span class="summary-name">ET_VERSION</span> = <code title="(1, 3, 0)"><code class="variable-group">(</code>1<code class="variable-op">, </code>3<code class="variable-op">, </code>0<code class="variable-group">)</code></code>
 410     </td>
 411   </tr>
 412 <tr>
 413     <td width="15%" align="right" valign="top" class="summary">
 414       <span class="summary-type">&nbsp;</span>
 415     </td><td class="summary">
 416         <a name="CET_VERSION"></a><span class="summary-name">CET_VERSION</span> = <code title="(1, 0, 6)"><code class="variable-group">(</code>1<code class="variable-op">, </code>0<code class="variable-op">, </code>6<code class="variable-group">)</code></code>
 417     </td>
 418   </tr>
 419 <tr class="private">
 420     <td width="15%" align="right" valign="top" class="summary">
 421       <span class="summary-type">&nbsp;</span>
 422     </td><td class="summary">
 423         <a name="_fix_unicode"></a><span class="summary-name">_fix_unicode</span> = <code title="re.compile(r'(\s+)u([&quot;\'])').sub">re.compile(r'(\s+)u([&quot;\'])').sub</code>
 424     </td>
 425   </tr>
 426 <tr>
 427     <td width="15%" align="right" valign="top" class="summary">
 428       <span class="summary-type">&nbsp;</span>
 429     </td><td class="summary">
 430         <a name="doctest_parser"></a><span class="summary-name">doctest_parser</span> = <code title="doctest.DocTestParser()">doctest.DocTestParser()</code>
 431     </td>
 432   </tr>
 433 <tr>
 434     <td width="15%" align="right" valign="top" class="summary">
 435       <span class="summary-type">&nbsp;</span>
 436     </td><td class="summary">
 437         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'lxml.tests'"><code class="variable-quote">'</code><code class="variable-string">lxml.tests</code><code class="variable-quote">'</code></code>
 438     </td>
 439   </tr>
 440 </table>
 441 <!-- ==================== NAVIGATION BAR ==================== -->
 442 <table class="navbar" border="0" width="100%" cellpadding="0"
 443        bgcolor="#a0c0ff" cellspacing="0">
 444   <tr valign="middle">
 445   <!-- Home link -->
 446       <th>&nbsp;&nbsp;&nbsp;<a
 447         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 448
 449   <!-- Tree link -->
 450       <th>&nbsp;&nbsp;&nbsp;<a
 451         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 452
 453   <!-- Index link -->
 454       <th>&nbsp;&nbsp;&nbsp;<a
 455         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 456
 457   <!-- Help link -->
 458       <th>&nbsp;&nbsp;&nbsp;<a
 459         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 460
 461   <!-- Project homepage -->
 462       <th class="navbar" align="right" width="100%">
 463         <table border="0" cellpadding="0" cellspacing="0">
 464           <tr><th class="navbar" align="center"
 465             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 466           </tr></table></th>
 467   </tr>
 468 </table>
 469 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 470   <tr>
 471     <td align="left" class="footer">
 472     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:17 2012
 473     </td>
 474     <td align="right" class="footer">
 475       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 476         >http://epydoc.sourceforge.net</a>
 477     </td>
 478   </tr>
 479 </table>
 480
 481 <script type="text/javascript">
 482   <!--
 483   // Private objects are initially displayed (because if
 484   // javascript is turned off then we want them to be
 485   // visible); but by default, we want to hide them.  So hide
 486   // them unless we have a cookie that says to show them.
 487   checkCookie();
 488   // -->
 489 </script>
 490 </body>
 491 </html>