doc/html/api/lxml.etree.C14NWriterTarget-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.etree.C14NWriterTarget</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.etree-module.html">Module&nbsp;etree</a> ::
  47         Class&nbsp;C14NWriterTarget
  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.etree.C14NWriterTarget-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 C14NWriterTarget</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">C14NWriterTarget</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>Canonicalization writer target for the XMLParser.</p>
  73 <p>Serialises parse events to XML C14N 2.0.</p>
  74 <p>Configuration options:</p>
  75 <ul class="rst-simple">
  76 <li><em>with_comments</em>: set to true to include comments</li>
  77 <li><em>strip_text</em>: set to true to strip whitespace before and after text content</li>
  78 <li><em>rewrite_prefixes</em>: set to true to replace namespace prefixes by &quot;n{number}&quot;</li>
  79 <li><dl class="rst-first rst-docutils">
  80 <dt><em>qname_aware_tags</em>: a set of qname aware tag names in which prefixes</dt>
  81 <dd>should be replaced in text content</dd>
  82 </dl>
  83 </li>
  84 <li><dl class="rst-first rst-docutils">
  85 <dt><em>qname_aware_attrs</em>: a set of qname aware attribute names in which prefixes</dt>
  86 <dd>should be replaced in text content</dd>
  87 </dl>
  88 </li>
  89 <li><em>exclude_attrs</em>: a set of attribute names that should not be serialised</li>
  90 <li><em>exclude_tags</em>: a set of tag names that should not be serialised</li>
  91 </ul>
  92
  93 <!-- ==================== INSTANCE METHODS ==================== -->
  94 <a name="section-InstanceMethods"></a>
  95 <table class="summary" border="1" cellpadding="3"
  96        cellspacing="0" width="100%" bgcolor="white">
  97 <tr bgcolor="#70b0f0" class="table-header">
  98   <td colspan="2" class="table-header">
  99     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 100       <tr valign="top">
 101         <td align="left"><span class="table-header">Instance Methods</span></td>
 102         <td align="right" valign="top"
 103          ><span class="options">[<a href="#section-InstanceMethods"
 104          class="privatelink" onclick="toggle_private();"
 105          >hide private</a>]</span></td>
 106       </tr>
 107     </table>
 108   </td>
 109 </tr>
 110 <tr>
 111     <td width="15%" align="right" valign="top" class="summary">
 112       <span class="summary-type">&nbsp;</span>
 113     </td><td class="summary">
 114       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 115         <tr>
 116           <td><span class="summary-sig"><a href="lxml.etree.C14NWriterTarget-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</span>)</span><br />
 117       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 118           <td align="right" valign="top">
 119
 120
 121           </td>
 122         </tr>
 123       </table>
 124
 125     </td>
 126   </tr>
 127 <tr>
 128     <td width="15%" align="right" valign="top" class="summary">
 129       <span class="summary-type">a new object with type S, a subtype of T</span>
 130     </td><td class="summary">
 131       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 132         <tr>
 133           <td><span class="summary-sig"><a href="lxml.etree.C14NWriterTarget-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 134         <span class="summary-sig-arg">S</span>,
 135         <span class="summary-sig-arg">...</span>)</span></td>
 136           <td align="right" valign="top">
 137
 138
 139           </td>
 140         </tr>
 141       </table>
 142
 143     </td>
 144   </tr>
 145 <tr class="private">
 146     <td width="15%" align="right" valign="top" class="summary">
 147       <span class="summary-type">&nbsp;</span>
 148     </td><td class="summary">
 149       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 150         <tr>
 151           <td><span class="summary-sig"><a name="_iter_namespaces"></a><span class="summary-sig-name">_iter_namespaces</span>(<span class="summary-sig-arg">...</span>)</span></td>
 152           <td align="right" valign="top">
 153
 154
 155           </td>
 156         </tr>
 157       </table>
 158
 159     </td>
 160   </tr>
 161 <tr>
 162     <td width="15%" align="right" valign="top" class="summary">
 163       <span class="summary-type">&nbsp;</span>
 164     </td><td class="summary">
 165       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 166         <tr>
 167           <td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">...</span>)</span></td>
 168           <td align="right" valign="top">
 169
 170
 171           </td>
 172         </tr>
 173       </table>
 174
 175     </td>
 176   </tr>
 177 <tr>
 178     <td width="15%" align="right" valign="top" class="summary">
 179       <span class="summary-type">&nbsp;</span>
 180     </td><td class="summary">
 181       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 182         <tr>
 183           <td><span class="summary-sig"><a name="comment"></a><span class="summary-sig-name">comment</span>(<span class="summary-sig-arg">...</span>)</span></td>
 184           <td align="right" valign="top">
 185
 186
 187           </td>
 188         </tr>
 189       </table>
 190
 191     </td>
 192   </tr>
 193 <tr>
 194     <td width="15%" align="right" valign="top" class="summary">
 195       <span class="summary-type">&nbsp;</span>
 196     </td><td class="summary">
 197       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 198         <tr>
 199           <td><span class="summary-sig"><a name="data"></a><span class="summary-sig-name">data</span>(<span class="summary-sig-arg">...</span>)</span></td>
 200           <td align="right" valign="top">
 201
 202
 203           </td>
 204         </tr>
 205       </table>
 206
 207     </td>
 208   </tr>
 209 <tr>
 210     <td width="15%" align="right" valign="top" class="summary">
 211       <span class="summary-type">&nbsp;</span>
 212     </td><td class="summary">
 213       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 214         <tr>
 215           <td><span class="summary-sig"><a name="end"></a><span class="summary-sig-name">end</span>(<span class="summary-sig-arg">...</span>)</span></td>
 216           <td align="right" valign="top">
 217
 218
 219           </td>
 220         </tr>
 221       </table>
 222
 223     </td>
 224   </tr>
 225 <tr>
 226     <td width="15%" align="right" valign="top" class="summary">
 227       <span class="summary-type">&nbsp;</span>
 228     </td><td class="summary">
 229       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 230         <tr>
 231           <td><span class="summary-sig"><a name="pi"></a><span class="summary-sig-name">pi</span>(<span class="summary-sig-arg">...</span>)</span></td>
 232           <td align="right" valign="top">
 233
 234
 235           </td>
 236         </tr>
 237       </table>
 238
 239     </td>
 240   </tr>
 241 <tr>
 242     <td width="15%" align="right" valign="top" class="summary">
 243       <span class="summary-type">&nbsp;</span>
 244     </td><td class="summary">
 245       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 246         <tr>
 247           <td><span class="summary-sig"><a name="start"></a><span class="summary-sig-name">start</span>(<span class="summary-sig-arg">...</span>)</span></td>
 248           <td align="right" valign="top">
 249
 250
 251           </td>
 252         </tr>
 253       </table>
 254
 255     </td>
 256   </tr>
 257 <tr>
 258     <td width="15%" align="right" valign="top" class="summary">
 259       <span class="summary-type">&nbsp;</span>
 260     </td><td class="summary">
 261       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 262         <tr>
 263           <td><span class="summary-sig"><a name="start_ns"></a><span class="summary-sig-name">start_ns</span>(<span class="summary-sig-arg">...</span>)</span></td>
 264           <td align="right" valign="top">
 265
 266
 267           </td>
 268         </tr>
 269       </table>
 270
 271     </td>
 272   </tr>
 273   <tr>
 274     <td colspan="2" class="summary">
 275     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 276       <code>__delattr__</code>,
 277       <code>__format__</code>,
 278       <code>__getattribute__</code>,
 279       <code>__hash__</code>,
 280       <code>__reduce__</code>,
 281       <code>__reduce_ex__</code>,
 282       <code>__repr__</code>,
 283       <code>__setattr__</code>,
 284       <code>__sizeof__</code>,
 285       <code>__str__</code>,
 286       <code>__subclasshook__</code>
 287       </p>
 288     </td>
 289   </tr>
 290 </table>
 291 <!-- ==================== PROPERTIES ==================== -->
 292 <a name="section-Properties"></a>
 293 <table class="summary" border="1" cellpadding="3"
 294        cellspacing="0" width="100%" bgcolor="white">
 295 <tr bgcolor="#70b0f0" class="table-header">
 296   <td colspan="2" class="table-header">
 297     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 298       <tr valign="top">
 299         <td align="left"><span class="table-header">Properties</span></td>
 300         <td align="right" valign="top"
 301          ><span class="options">[<a href="#section-Properties"
 302          class="privatelink" onclick="toggle_private();"
 303          >hide private</a>]</span></td>
 304       </tr>
 305     </table>
 306   </td>
 307 </tr>
 308   <tr>
 309     <td colspan="2" class="summary">
 310     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 311       <code>__class__</code>
 312       </p>
 313     </td>
 314   </tr>
 315 </table>
 316 <!-- ==================== METHOD DETAILS ==================== -->
 317 <a name="section-MethodDetails"></a>
 318 <table class="details" border="1" cellpadding="3"
 319        cellspacing="0" width="100%" bgcolor="white">
 320 <tr bgcolor="#70b0f0" class="table-header">
 321   <td colspan="2" class="table-header">
 322     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 323       <tr valign="top">
 324         <td align="left"><span class="table-header">Method Details</span></td>
 325         <td align="right" valign="top"
 326          ><span class="options">[<a href="#section-MethodDetails"
 327          class="privatelink" onclick="toggle_private();"
 328          >hide private</a>]</span></td>
 329       </tr>
 330     </table>
 331   </td>
 332 </tr>
 333 </table>
 334 <a name="__init__"></a>
 335 <div>
 336 <table class="details" border="1" cellpadding="3"
 337        cellspacing="0" width="100%" bgcolor="white">
 338 <tr><td>
 339   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 340   <tr valign="top"><td>
 341   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">...</span>)</span>
 342     <br /><em class="fname">(Constructor)</em>
 343   </h3>
 344   </td><td align="right" valign="top"
 345     >&nbsp;
 346     </td>
 347   </tr></table>
 348
 349   x.__init__(...) initializes x; see help(type(x)) for signature
 350   <dl class="fields">
 351     <dt>Overrides:
 352         object.__init__
 353     </dt>
 354   </dl>
 355 </td></tr></table>
 356 </div>
 357 <a name="__new__"></a>
 358 <div>
 359 <table class="details" border="1" cellpadding="3"
 360        cellspacing="0" width="100%" bgcolor="white">
 361 <tr><td>
 362   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 363   <tr valign="top"><td>
 364   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 365         <span class="sig-arg">S</span>,
 366         <span class="sig-arg">...</span>)</span>
 367   </h3>
 368   </td><td align="right" valign="top"
 369     >&nbsp;
 370     </td>
 371   </tr></table>
 372
 373
 374   <dl class="fields">
 375     <dt>Returns: a new object with type S, a subtype of T</dt>
 376     <dt>Overrides:
 377         object.__new__
 378     </dt>
 379   </dl>
 380 </td></tr></table>
 381 </div>
 382 <br />
 383 <!-- ==================== NAVIGATION BAR ==================== -->
 384 <table class="navbar" border="0" width="100%" cellpadding="0"
 385        bgcolor="#a0c0ff" cellspacing="0">
 386   <tr valign="middle">
 387   <!-- Home link -->
 388       <th>&nbsp;&nbsp;&nbsp;<a
 389         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 390
 391   <!-- Tree link -->
 392       <th>&nbsp;&nbsp;&nbsp;<a
 393         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 394
 395   <!-- Index link -->
 396       <th>&nbsp;&nbsp;&nbsp;<a
 397         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 398
 399   <!-- Help link -->
 400       <th>&nbsp;&nbsp;&nbsp;<a
 401         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 402
 403   <!-- Project homepage -->
 404       <th class="navbar" align="right" width="100%">
 405         <table border="0" cellpadding="0" cellspacing="0">
 406           <tr><th class="navbar" align="center"
 407             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 408           </tr></table></th>
 409   </tr>
 410 </table>
 411 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 412   <tr>
 413     <td align="left" class="footer">
 414     Generated by Epydoc 3.0.1
 415     on Thu Jul  9 18:29:53 2020
 416     </td>
 417     <td align="right" class="footer">
 418       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 419         >http://epydoc.sourceforge.net</a>
 420     </td>
 421   </tr>
 422 </table>
 423
 424 <script type="text/javascript">
 425   <!--
 426   // Private objects are initially displayed (because if
 427   // javascript is turned off then we want them to be
 428   // visible); but by default, we want to hide them.  So hide
 429   // them unless we have a cookie that says to show them.
 430   checkCookie();
 431   // -->
 432 </script>
 433 </body>
 434 </html>