doc/html/api/lxml.html.diff.token-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.html.diff.token</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.html-module.html">Package&nbsp;html</a> ::
  47         <a href="lxml.html.diff-module.html">Module&nbsp;diff</a> ::
  48         Class&nbsp;token
  49       </span>
  50     </td>
  51     <td>
  52       <table cellpadding="0" cellspacing="0">
  53         <!-- hide/show private -->
  54         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  55     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  56         <tr><td align="right"><span class="options"
  57             >[<a href="frames.html" target="_top">frames</a
  58             >]&nbsp;|&nbsp;<a href="lxml.html.diff.token-class.html"
  59             target="_top">no&nbsp;frames</a>]</span></td></tr>
  60       </table>
  61     </td>
  62   </tr>
  63 </table>
  64 <!-- ==================== CLASS DESCRIPTION ==================== -->
  65 <h1 class="epydoc">Class token</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html.diff-pysrc.html#token">source&nbsp;code</a></span></p>
  66 <pre class="base-tree">
  67 object --+
  68          |
  69 basestring --+
  70              |
  71        unicode --+
  72                  |
  73                 <strong class="uidshort">token</strong>
  74 </pre>
  75
  76 <dl><dt>Known Subclasses:</dt>
  77 <dd>
  78       <ul class="subclass-list">
  79 <li class="private"><a href="lxml.html.diff.href_token-class.html" onclick="show_private();">href_token</a></li><li class="private">, <a href="lxml.html.diff.tag_token-class.html" onclick="show_private();">tag_token</a></li>  </ul>
  80 </dd></dl>
  81
  82 <hr />
  83 <p>Represents a diffable token, generally a word that is displayed to
  84 the user.  Opening tags are attached to this token when they are
  85 adjacent (pre_tags) and closing tags that follow the word
  86 (post_tags).  Some exceptions occur when there are empty tags
  87 adjacent to a word, so there may be close tags in pre_tags, or
  88 open tags in post_tags.</p>
  89 <p>We also keep track of whether the word was originally followed by
  90 whitespace, even though we do not want to treat the word as
  91 equivalent to a similar word that does not have a trailing
  92 space.</p>
  93
  94 <!-- ==================== INSTANCE METHODS ==================== -->
  95 <a name="section-InstanceMethods"></a>
  96 <table class="summary" border="1" cellpadding="3"
  97        cellspacing="0" width="100%" bgcolor="white">
  98 <tr bgcolor="#70b0f0" class="table-header">
  99   <td colspan="2" class="table-header">
 100     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 101       <tr valign="top">
 102         <td align="left"><span class="table-header">Instance Methods</span></td>
 103         <td align="right" valign="top"
 104          ><span class="options">[<a href="#section-InstanceMethods"
 105          class="privatelink" onclick="toggle_private();"
 106          >hide private</a>]</span></td>
 107       </tr>
 108     </table>
 109   </td>
 110 </tr>
 111 <tr>
 112     <td width="15%" align="right" valign="top" class="summary">
 113       <span class="summary-type">a new object with type S, a subtype of T</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.html.diff.token-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">cls</span>,
 118         <span class="summary-sig-arg">text</span>,
 119         <span class="summary-sig-arg">pre_tags</span>=<span class="summary-sig-default">None</span>,
 120         <span class="summary-sig-arg">post_tags</span>=<span class="summary-sig-default">None</span>,
 121         <span class="summary-sig-arg">trailing_whitespace</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span></td>
 122           <td align="right" valign="top">
 123             <span class="codelink"><a href="lxml.html.diff-pysrc.html#token.__new__">source&nbsp;code</a></span>
 124
 125           </td>
 126         </tr>
 127       </table>
 128
 129     </td>
 130   </tr>
 131 <tr>
 132     <td width="15%" align="right" valign="top" class="summary">
 133       <span class="summary-type">&nbsp;</span>
 134     </td><td class="summary">
 135       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 136         <tr>
 137           <td><span class="summary-sig"><a href="lxml.html.diff.token-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 138       repr(x)</td>
 139           <td align="right" valign="top">
 140             <span class="codelink"><a href="lxml.html.diff-pysrc.html#token.__repr__">source&nbsp;code</a></span>
 141
 142           </td>
 143         </tr>
 144       </table>
 145
 146     </td>
 147   </tr>
 148 <tr>
 149     <td width="15%" align="right" valign="top" class="summary">
 150       <span class="summary-type">&nbsp;</span>
 151     </td><td class="summary">
 152       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 153         <tr>
 154           <td><span class="summary-sig"><a name="html"></a><span class="summary-sig-name">html</span>(<span class="summary-sig-arg">self</span>)</span></td>
 155           <td align="right" valign="top">
 156             <span class="codelink"><a href="lxml.html.diff-pysrc.html#token.html">source&nbsp;code</a></span>
 157
 158           </td>
 159         </tr>
 160       </table>
 161
 162     </td>
 163   </tr>
 164   <tr>
 165     <td colspan="2" class="summary">
 166     <p class="indent-wrapped-lines"><b>Inherited from <code>unicode</code></b>:
 167       <code>__add__</code>,
 168       <code>__contains__</code>,
 169       <code>__eq__</code>,
 170       <code>__format__</code>,
 171       <code>__ge__</code>,
 172       <code>__getattribute__</code>,
 173       <code>__getitem__</code>,
 174       <code>__getnewargs__</code>,
 175       <code>__getslice__</code>,
 176       <code>__gt__</code>,
 177       <code>__hash__</code>,
 178       <code>__le__</code>,
 179       <code>__len__</code>,
 180       <code>__lt__</code>,
 181       <code>__mod__</code>,
 182       <code>__mul__</code>,
 183       <code>__ne__</code>,
 184       <code>__rmod__</code>,
 185       <code>__rmul__</code>,
 186       <code>__sizeof__</code>,
 187       <code>__str__</code>,
 188       <code>capitalize</code>,
 189       <code>center</code>,
 190       <code>count</code>,
 191       <code>decode</code>,
 192       <code>encode</code>,
 193       <code>endswith</code>,
 194       <code>expandtabs</code>,
 195       <code>find</code>,
 196       <code>format</code>,
 197       <code>index</code>,
 198       <code>isalnum</code>,
 199       <code>isalpha</code>,
 200       <code>isdecimal</code>,
 201       <code>isdigit</code>,
 202       <code>islower</code>,
 203       <code>isnumeric</code>,
 204       <code>isspace</code>,
 205       <code>istitle</code>,
 206       <code>isupper</code>,
 207       <code>join</code>,
 208       <code>ljust</code>,
 209       <code>lower</code>,
 210       <code>lstrip</code>,
 211       <code>partition</code>,
 212       <code>replace</code>,
 213       <code>rfind</code>,
 214       <code>rindex</code>,
 215       <code>rjust</code>,
 216       <code>rpartition</code>,
 217       <code>rsplit</code>,
 218       <code>rstrip</code>,
 219       <code>split</code>,
 220       <code>splitlines</code>,
 221       <code>startswith</code>,
 222       <code>strip</code>,
 223       <code>swapcase</code>,
 224       <code>title</code>,
 225       <code>translate</code>,
 226       <code>upper</code>,
 227       <code>zfill</code>
 228       </p>
 229     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code>unicode</code></b> (private):
 230       <code>_formatter_field_name_split</code>,
 231       <code>_formatter_parser</code>
 232       </p></div>
 233     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 234       <code>__delattr__</code>,
 235       <code>__init__</code>,
 236       <code>__reduce__</code>,
 237       <code>__reduce_ex__</code>,
 238       <code>__setattr__</code>,
 239       <code>__subclasshook__</code>
 240       </p>
 241     </td>
 242   </tr>
 243 </table>
 244 <!-- ==================== CLASS VARIABLES ==================== -->
 245 <a name="section-ClassVariables"></a>
 246 <table class="summary" border="1" cellpadding="3"
 247        cellspacing="0" width="100%" bgcolor="white">
 248 <tr bgcolor="#70b0f0" class="table-header">
 249   <td colspan="2" class="table-header">
 250     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 251       <tr valign="top">
 252         <td align="left"><span class="table-header">Class Variables</span></td>
 253         <td align="right" valign="top"
 254          ><span class="options">[<a href="#section-ClassVariables"
 255          class="privatelink" onclick="toggle_private();"
 256          >hide private</a>]</span></td>
 257       </tr>
 258     </table>
 259   </td>
 260 </tr>
 261 <tr>
 262     <td width="15%" align="right" valign="top" class="summary">
 263       <span class="summary-type">&nbsp;</span>
 264     </td><td class="summary">
 265         <a name="hide_when_equal"></a><span class="summary-name">hide_when_equal</span> = <code title="False">False</code>
 266     </td>
 267   </tr>
 268 <tr>
 269     <td width="15%" align="right" valign="top" class="summary">
 270       <span class="summary-type">&nbsp;</span>
 271     </td><td class="summary">
 272         <a name="__qualname__"></a><span class="summary-name">__qualname__</span> = <code title="'token'"><code class="variable-quote">'</code><code class="variable-string">token</code><code class="variable-quote">'</code></code>
 273     </td>
 274   </tr>
 275 </table>
 276 <!-- ==================== PROPERTIES ==================== -->
 277 <a name="section-Properties"></a>
 278 <table class="summary" border="1" cellpadding="3"
 279        cellspacing="0" width="100%" bgcolor="white">
 280 <tr bgcolor="#70b0f0" class="table-header">
 281   <td colspan="2" class="table-header">
 282     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 283       <tr valign="top">
 284         <td align="left"><span class="table-header">Properties</span></td>
 285         <td align="right" valign="top"
 286          ><span class="options">[<a href="#section-Properties"
 287          class="privatelink" onclick="toggle_private();"
 288          >hide private</a>]</span></td>
 289       </tr>
 290     </table>
 291   </td>
 292 </tr>
 293   <tr>
 294     <td colspan="2" class="summary">
 295     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 296       <code>__class__</code>
 297       </p>
 298     </td>
 299   </tr>
 300 </table>
 301 <!-- ==================== METHOD DETAILS ==================== -->
 302 <a name="section-MethodDetails"></a>
 303 <table class="details" border="1" cellpadding="3"
 304        cellspacing="0" width="100%" bgcolor="white">
 305 <tr bgcolor="#70b0f0" class="table-header">
 306   <td colspan="2" class="table-header">
 307     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 308       <tr valign="top">
 309         <td align="left"><span class="table-header">Method Details</span></td>
 310         <td align="right" valign="top"
 311          ><span class="options">[<a href="#section-MethodDetails"
 312          class="privatelink" onclick="toggle_private();"
 313          >hide private</a>]</span></td>
 314       </tr>
 315     </table>
 316   </td>
 317 </tr>
 318 </table>
 319 <a name="__new__"></a>
 320 <div>
 321 <table class="details" border="1" cellpadding="3"
 322        cellspacing="0" width="100%" bgcolor="white">
 323 <tr><td>
 324   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 325   <tr valign="top"><td>
 326   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">cls</span>,
 327         <span class="sig-arg">text</span>,
 328         <span class="sig-arg">pre_tags</span>=<span class="sig-default">None</span>,
 329         <span class="sig-arg">post_tags</span>=<span class="sig-default">None</span>,
 330         <span class="sig-arg">trailing_whitespace</span>=<span class="sig-default">&quot;&quot;</span>)</span>
 331   </h3>
 332   </td><td align="right" valign="top"
 333     ><span class="codelink"><a href="lxml.html.diff-pysrc.html#token.__new__">source&nbsp;code</a></span>&nbsp;
 334     </td>
 335   </tr></table>
 336
 337
 338   <dl class="fields">
 339     <dt>Returns: a new object with type S, a subtype of T</dt>
 340     <dt>Overrides:
 341         object.__new__
 342         <dd><em class="note">(inherited documentation)</em></dd>
 343     </dt>
 344   </dl>
 345 </td></tr></table>
 346 </div>
 347 <a name="__repr__"></a>
 348 <div>
 349 <table class="details" border="1" cellpadding="3"
 350        cellspacing="0" width="100%" bgcolor="white">
 351 <tr><td>
 352   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 353   <tr valign="top"><td>
 354   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
 355     <br /><em class="fname">(Representation operator)</em>
 356   </h3>
 357   </td><td align="right" valign="top"
 358     ><span class="codelink"><a href="lxml.html.diff-pysrc.html#token.__repr__">source&nbsp;code</a></span>&nbsp;
 359     </td>
 360   </tr></table>
 361
 362   repr(x)
 363   <dl class="fields">
 364     <dt>Overrides:
 365         object.__repr__
 366         <dd><em class="note">(inherited documentation)</em></dd>
 367     </dt>
 368   </dl>
 369 </td></tr></table>
 370 </div>
 371 <br />
 372 <!-- ==================== NAVIGATION BAR ==================== -->
 373 <table class="navbar" border="0" width="100%" cellpadding="0"
 374        bgcolor="#a0c0ff" cellspacing="0">
 375   <tr valign="middle">
 376   <!-- Home link -->
 377       <th>&nbsp;&nbsp;&nbsp;<a
 378         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 379
 380   <!-- Tree link -->
 381       <th>&nbsp;&nbsp;&nbsp;<a
 382         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 383
 384   <!-- Index link -->
 385       <th>&nbsp;&nbsp;&nbsp;<a
 386         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 387
 388   <!-- Help link -->
 389       <th>&nbsp;&nbsp;&nbsp;<a
 390         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 391
 392   <!-- Project homepage -->
 393       <th class="navbar" align="right" width="100%">
 394         <table border="0" cellpadding="0" cellspacing="0">
 395           <tr><th class="navbar" align="center"
 396             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 397           </tr></table></th>
 398   </tr>
 399 </table>
 400 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 401   <tr>
 402     <td align="left" class="footer">
 403     Generated by Epydoc 3.0.1
 404     on Thu Jul  9 18:29:53 2020
 405     </td>
 406     <td align="right" class="footer">
 407       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 408         >http://epydoc.sourceforge.net</a>
 409     </td>
 410   </tr>
 411 </table>
 412
 413 <script type="text/javascript">
 414   <!--
 415   // Private objects are initially displayed (because if
 416   // javascript is turned off then we want them to be
 417   // visible); but by default, we want to hide them.  So hide
 418   // them unless we have a cookie that says to show them.
 419   checkCookie();
 420   // -->
 421 </script>
 422 </body>
 423 </html>