doc/html/api/lxml.etree.DTD-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.DTD</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;DTD
  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.DTD-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 DTD</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68 <a href="lxml.etree._Validator-class.html" onclick="show_private();">_Validator</a> --+
  69              |
  70             <strong class="uidshort">DTD</strong>
  71 </pre>
  72
  73 <hr />
  74 <p>DTD(self, file=None, external_id=None)
  75 A DTD validator.</p>
  76 <p>Can load from filesystem directly given a filename or file-like object.
  77 Alternatively, pass the keyword parameter <tt class="rst-docutils literal">external_id</tt> to load from a
  78 catalog.</p>
  79
  80 <!-- ==================== INSTANCE METHODS ==================== -->
  81 <a name="section-InstanceMethods"></a>
  82 <table class="summary" border="1" cellpadding="3"
  83        cellspacing="0" width="100%" bgcolor="white">
  84 <tr bgcolor="#70b0f0" class="table-header">
  85   <td colspan="2" class="table-header">
  86     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  87       <tr valign="top">
  88         <td align="left"><span class="table-header">Instance Methods</span></td>
  89         <td align="right" valign="top"
  90          ><span class="options">[<a href="#section-InstanceMethods"
  91          class="privatelink" onclick="toggle_private();"
  92          >hide private</a>]</span></td>
  93       </tr>
  94     </table>
  95   </td>
  96 </tr>
  97 <tr>
  98     <td width="15%" align="right" valign="top" class="summary">
  99       <span class="summary-type">&nbsp;</span>
 100     </td><td class="summary">
 101       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 102         <tr>
 103           <td><span class="summary-sig"><a href="lxml.etree.DTD-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
 104         <span class="summary-sig-arg">etree</span>)</span><br />
 105       Validate doc using the DTD.</td>
 106           <td align="right" valign="top">
 107
 108
 109           </td>
 110         </tr>
 111       </table>
 112
 113     </td>
 114   </tr>
 115 <tr>
 116     <td width="15%" align="right" valign="top" class="summary">
 117       <span class="summary-type">&nbsp;</span>
 118     </td><td class="summary">
 119       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 120         <tr>
 121           <td><span class="summary-sig"><a href="lxml.etree.DTD-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 122         <span class="summary-sig-arg">file</span>=<span class="summary-sig-default">None</span>,
 123         <span class="summary-sig-arg">external_id</span>=<span class="summary-sig-default">None</span>)</span><br />
 124       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 125           <td align="right" valign="top">
 126
 127
 128           </td>
 129         </tr>
 130       </table>
 131
 132     </td>
 133   </tr>
 134 <tr>
 135     <td width="15%" align="right" valign="top" class="summary">
 136       <span class="summary-type">a new object with type S, a subtype of T</span>
 137     </td><td class="summary">
 138       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 139         <tr>
 140           <td><span class="summary-sig"><a href="lxml.etree.DTD-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 141         <span class="summary-sig-arg">S</span>,
 142         <span class="summary-sig-arg">...</span>)</span></td>
 143           <td align="right" valign="top">
 144
 145
 146           </td>
 147         </tr>
 148       </table>
 149
 150     </td>
 151   </tr>
 152   <tr>
 153     <td colspan="2" class="summary">
 154     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Validator-class.html" onclick="show_private();">_Validator</a></code></b>:
 155       <code><a href="lxml.etree._Validator-class.html#assertValid">assertValid</a></code>,
 156       <code><a href="lxml.etree._Validator-class.html#assert_">assert_</a></code>,
 157       <code><a href="lxml.etree._Validator-class.html#validate">validate</a></code>
 158       </p>
 159     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Validator-class.html" onclick="show_private();">_Validator</a></code></b> (private):
 160       <code><a href="lxml.etree._Validator-class.html#_append_log_message" onclick="show_private();">_append_log_message</a></code>,
 161       <code><a href="lxml.etree._Validator-class.html#_clear_error_log" onclick="show_private();">_clear_error_log</a></code>
 162       </p></div>
 163     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 164       <code>__delattr__</code>,
 165       <code>__format__</code>,
 166       <code>__getattribute__</code>,
 167       <code>__hash__</code>,
 168       <code>__reduce__</code>,
 169       <code>__reduce_ex__</code>,
 170       <code>__repr__</code>,
 171       <code>__setattr__</code>,
 172       <code>__sizeof__</code>,
 173       <code>__str__</code>,
 174       <code>__subclasshook__</code>
 175       </p>
 176     </td>
 177   </tr>
 178 </table>
 179 <!-- ==================== PROPERTIES ==================== -->
 180 <a name="section-Properties"></a>
 181 <table class="summary" border="1" cellpadding="3"
 182        cellspacing="0" width="100%" bgcolor="white">
 183 <tr bgcolor="#70b0f0" class="table-header">
 184   <td colspan="2" class="table-header">
 185     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 186       <tr valign="top">
 187         <td align="left"><span class="table-header">Properties</span></td>
 188         <td align="right" valign="top"
 189          ><span class="options">[<a href="#section-Properties"
 190          class="privatelink" onclick="toggle_private();"
 191          >hide private</a>]</span></td>
 192       </tr>
 193     </table>
 194   </td>
 195 </tr>
 196   <tr>
 197     <td colspan="2" class="summary">
 198     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Validator-class.html" onclick="show_private();">_Validator</a></code></b>:
 199       <code><a href="lxml.etree._Validator-class.html#error_log">error_log</a></code>
 200       </p>
 201     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 202       <code>__class__</code>
 203       </p>
 204     </td>
 205   </tr>
 206 </table>
 207 <!-- ==================== METHOD DETAILS ==================== -->
 208 <a name="section-MethodDetails"></a>
 209 <table class="details" border="1" cellpadding="3"
 210        cellspacing="0" width="100%" bgcolor="white">
 211 <tr bgcolor="#70b0f0" class="table-header">
 212   <td colspan="2" class="table-header">
 213     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 214       <tr valign="top">
 215         <td align="left"><span class="table-header">Method Details</span></td>
 216         <td align="right" valign="top"
 217          ><span class="options">[<a href="#section-MethodDetails"
 218          class="privatelink" onclick="toggle_private();"
 219          >hide private</a>]</span></td>
 220       </tr>
 221     </table>
 222   </td>
 223 </tr>
 224 </table>
 225 <a name="__call__"></a>
 226 <div>
 227 <table class="details" border="1" cellpadding="3"
 228        cellspacing="0" width="100%" bgcolor="white">
 229 <tr><td>
 230   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 231   <tr valign="top"><td>
 232   <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
 233         <span class="sig-arg">etree</span>)</span>
 234     <br /><em class="fname">(Call operator)</em>
 235   </h3>
 236   </td><td align="right" valign="top"
 237     >&nbsp;
 238     </td>
 239   </tr></table>
 240
 241   <p>Validate doc using the DTD.</p>
 242 <p>Returns true if the document is valid, false if not.</p>
 243   <dl class="fields">
 244   </dl>
 245 </td></tr></table>
 246 </div>
 247 <a name="__init__"></a>
 248 <div>
 249 <table class="details" border="1" cellpadding="3"
 250        cellspacing="0" width="100%" bgcolor="white">
 251 <tr><td>
 252   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 253   <tr valign="top"><td>
 254   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 255         <span class="sig-arg">file</span>=<span class="sig-default">None</span>,
 256         <span class="sig-arg">external_id</span>=<span class="sig-default">None</span>)</span>
 257     <br /><em class="fname">(Constructor)</em>
 258   </h3>
 259   </td><td align="right" valign="top"
 260     >&nbsp;
 261     </td>
 262   </tr></table>
 263
 264   x.__init__(...) initializes x; see help(type(x)) for signature
 265   <dl class="fields">
 266     <dt>Overrides:
 267         object.__init__
 268     </dt>
 269   </dl>
 270 </td></tr></table>
 271 </div>
 272 <a name="__new__"></a>
 273 <div>
 274 <table class="details" border="1" cellpadding="3"
 275        cellspacing="0" width="100%" bgcolor="white">
 276 <tr><td>
 277   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 278   <tr valign="top"><td>
 279   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 280         <span class="sig-arg">S</span>,
 281         <span class="sig-arg">...</span>)</span>
 282   </h3>
 283   </td><td align="right" valign="top"
 284     >&nbsp;
 285     </td>
 286   </tr></table>
 287
 288
 289   <dl class="fields">
 290     <dt>Returns: a new object with type S, a subtype of T</dt>
 291     <dt>Overrides:
 292         object.__new__
 293     </dt>
 294   </dl>
 295 </td></tr></table>
 296 </div>
 297 <br />
 298 <!-- ==================== NAVIGATION BAR ==================== -->
 299 <table class="navbar" border="0" width="100%" cellpadding="0"
 300        bgcolor="#a0c0ff" cellspacing="0">
 301   <tr valign="middle">
 302   <!-- Home link -->
 303       <th>&nbsp;&nbsp;&nbsp;<a
 304         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 305
 306   <!-- Tree link -->
 307       <th>&nbsp;&nbsp;&nbsp;<a
 308         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 309
 310   <!-- Index link -->
 311       <th>&nbsp;&nbsp;&nbsp;<a
 312         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 313
 314   <!-- Help link -->
 315       <th>&nbsp;&nbsp;&nbsp;<a
 316         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 317
 318   <!-- Project homepage -->
 319       <th class="navbar" align="right" width="100%">
 320         <table border="0" cellpadding="0" cellspacing="0">
 321           <tr><th class="navbar" align="center"
 322             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 323           </tr></table></th>
 324   </tr>
 325 </table>
 326 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 327   <tr>
 328     <td align="left" class="footer">
 329     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 330     </td>
 331     <td align="right" class="footer">
 332       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 333         >http://epydoc.sourceforge.net</a>
 334     </td>
 335   </tr>
 336 </table>
 337
 338 <script type="text/javascript">
 339   <!--
 340   // Private objects are initially displayed (because if
 341   // javascript is turned off then we want them to be
 342   // visible); but by default, we want to hide them.  So hide
 343   // them unless we have a cookie that says to show them.
 344   checkCookie();
 345   // -->
 346 </script>
 347 </body>
 348 </html>