doc/html/api/lxml.etree._Validator-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._Validator</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;_Validator
  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._Validator-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 _Validator</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">_Validator</strong>
  69 </pre>
  70
  71 <dl><dt>Known Subclasses:</dt>
  72 <dd>
  73       <ul class="subclass-list">
  74 <li><a href="lxml.etree.DTD-class.html">DTD</a></li><li>, <a href="lxml.etree.RelaxNG-class.html">RelaxNG</a></li><li>, <a href="lxml.etree.Schematron-class.html">Schematron</a></li><li>, <a href="lxml.isoschematron.Schematron-class.html">isoschematron.Schematron</a></li><li>, <a href="lxml.etree.XMLSchema-class.html">XMLSchema</a></li>  </ul>
  75 </dd></dl>
  76
  77 <hr />
  78 Base class for XML validators.
  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">a new object with type S, a subtype of T</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._Validator-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 104         <span class="summary-sig-arg">S</span>,
 105         <span class="summary-sig-arg">...</span>)</span></td>
 106           <td align="right" valign="top">
 107
 108
 109           </td>
 110         </tr>
 111       </table>
 112
 113     </td>
 114   </tr>
 115 <tr class="private">
 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 name="_append_log_message"></a><span class="summary-sig-name">_append_log_message</span>(<span class="summary-sig-arg">...</span>)</span></td>
 122           <td align="right" valign="top">
 123
 124
 125           </td>
 126         </tr>
 127       </table>
 128
 129     </td>
 130   </tr>
 131 <tr class="private">
 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 name="_clear_error_log"></a><span class="summary-sig-name">_clear_error_log</span>(<span class="summary-sig-arg">...</span>)</span></td>
 138           <td align="right" valign="top">
 139
 140
 141           </td>
 142         </tr>
 143       </table>
 144
 145     </td>
 146   </tr>
 147 <tr>
 148     <td width="15%" align="right" valign="top" class="summary">
 149       <span class="summary-type">&nbsp;</span>
 150     </td><td class="summary">
 151       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 152         <tr>
 153           <td><span class="summary-sig"><a name="assertValid"></a><span class="summary-sig-name">assertValid</span>(<span class="summary-sig-arg">self</span>,
 154         <span class="summary-sig-arg">etree</span>)</span><br />
 155       Raises <a href="lxml.etree.DocumentInvalid-class.html" class="link">DocumentInvalid</a> if the document does not comply with the schema.</td>
 156           <td align="right" valign="top">
 157
 158
 159           </td>
 160         </tr>
 161       </table>
 162
 163     </td>
 164   </tr>
 165 <tr>
 166     <td width="15%" align="right" valign="top" class="summary">
 167       <span class="summary-type">&nbsp;</span>
 168     </td><td class="summary">
 169       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 170         <tr>
 171           <td><span class="summary-sig"><a name="assert_"></a><span class="summary-sig-name">assert_</span>(<span class="summary-sig-arg">self</span>,
 172         <span class="summary-sig-arg">etree</span>)</span><br />
 173       Raises <code class="link">AssertionError</code> if the document does not comply with the schema.</td>
 174           <td align="right" valign="top">
 175
 176
 177           </td>
 178         </tr>
 179       </table>
 180
 181     </td>
 182   </tr>
 183 <tr>
 184     <td width="15%" align="right" valign="top" class="summary">
 185       <span class="summary-type">&nbsp;</span>
 186     </td><td class="summary">
 187       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 188         <tr>
 189           <td><span class="summary-sig"><a href="lxml.etree._Validator-class.html#validate" class="summary-sig-name">validate</a>(<span class="summary-sig-arg">self</span>,
 190         <span class="summary-sig-arg">etree</span>)</span><br />
 191       Validate the document using this schema.</td>
 192           <td align="right" valign="top">
 193
 194
 195           </td>
 196         </tr>
 197       </table>
 198
 199     </td>
 200   </tr>
 201   <tr>
 202     <td colspan="2" class="summary">
 203     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 204       <code>__delattr__</code>,
 205       <code>__format__</code>,
 206       <code>__getattribute__</code>,
 207       <code>__hash__</code>,
 208       <code>__init__</code>,
 209       <code>__reduce__</code>,
 210       <code>__reduce_ex__</code>,
 211       <code>__repr__</code>,
 212       <code>__setattr__</code>,
 213       <code>__sizeof__</code>,
 214       <code>__str__</code>,
 215       <code>__subclasshook__</code>
 216       </p>
 217     </td>
 218   </tr>
 219 </table>
 220 <!-- ==================== PROPERTIES ==================== -->
 221 <a name="section-Properties"></a>
 222 <table class="summary" border="1" cellpadding="3"
 223        cellspacing="0" width="100%" bgcolor="white">
 224 <tr bgcolor="#70b0f0" class="table-header">
 225   <td colspan="2" class="table-header">
 226     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 227       <tr valign="top">
 228         <td align="left"><span class="table-header">Properties</span></td>
 229         <td align="right" valign="top"
 230          ><span class="options">[<a href="#section-Properties"
 231          class="privatelink" onclick="toggle_private();"
 232          >hide private</a>]</span></td>
 233       </tr>
 234     </table>
 235   </td>
 236 </tr>
 237 <tr>
 238     <td width="15%" align="right" valign="top" class="summary">
 239       <span class="summary-type">&nbsp;</span>
 240     </td><td class="summary">
 241         <a name="error_log"></a><span class="summary-name">error_log</span><br />
 242       The log of validation errors and warnings.
 243     </td>
 244   </tr>
 245   <tr>
 246     <td colspan="2" class="summary">
 247     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 248       <code>__class__</code>
 249       </p>
 250     </td>
 251   </tr>
 252 </table>
 253 <!-- ==================== METHOD DETAILS ==================== -->
 254 <a name="section-MethodDetails"></a>
 255 <table class="details" border="1" cellpadding="3"
 256        cellspacing="0" width="100%" bgcolor="white">
 257 <tr bgcolor="#70b0f0" class="table-header">
 258   <td colspan="2" class="table-header">
 259     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 260       <tr valign="top">
 261         <td align="left"><span class="table-header">Method Details</span></td>
 262         <td align="right" valign="top"
 263          ><span class="options">[<a href="#section-MethodDetails"
 264          class="privatelink" onclick="toggle_private();"
 265          >hide private</a>]</span></td>
 266       </tr>
 267     </table>
 268   </td>
 269 </tr>
 270 </table>
 271 <a name="__new__"></a>
 272 <div>
 273 <table class="details" border="1" cellpadding="3"
 274        cellspacing="0" width="100%" bgcolor="white">
 275 <tr><td>
 276   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 277   <tr valign="top"><td>
 278   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 279         <span class="sig-arg">S</span>,
 280         <span class="sig-arg">...</span>)</span>
 281   </h3>
 282   </td><td align="right" valign="top"
 283     >&nbsp;
 284     </td>
 285   </tr></table>
 286
 287
 288   <dl class="fields">
 289     <dt>Returns: a new object with type S, a subtype of T</dt>
 290     <dt>Overrides:
 291         object.__new__
 292     </dt>
 293   </dl>
 294 </td></tr></table>
 295 </div>
 296 <a name="validate"></a>
 297 <div>
 298 <table class="details" border="1" cellpadding="3"
 299        cellspacing="0" width="100%" bgcolor="white">
 300 <tr><td>
 301   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 302   <tr valign="top"><td>
 303   <h3 class="epydoc"><span class="sig"><span class="sig-name">validate</span>(<span class="sig-arg">self</span>,
 304         <span class="sig-arg">etree</span>)</span>
 305   </h3>
 306   </td><td align="right" valign="top"
 307     >&nbsp;
 308     </td>
 309   </tr></table>
 310
 311   <p>Validate the document using this schema.</p>
 312 <p>Returns true if document is valid, false if not.</p>
 313   <dl class="fields">
 314   </dl>
 315 </td></tr></table>
 316 </div>
 317 <br />
 318 <!-- ==================== NAVIGATION BAR ==================== -->
 319 <table class="navbar" border="0" width="100%" cellpadding="0"
 320        bgcolor="#a0c0ff" cellspacing="0">
 321   <tr valign="middle">
 322   <!-- Home link -->
 323       <th>&nbsp;&nbsp;&nbsp;<a
 324         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 325
 326   <!-- Tree link -->
 327       <th>&nbsp;&nbsp;&nbsp;<a
 328         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 329
 330   <!-- Index link -->
 331       <th>&nbsp;&nbsp;&nbsp;<a
 332         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 333
 334   <!-- Help link -->
 335       <th>&nbsp;&nbsp;&nbsp;<a
 336         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 337
 338   <!-- Project homepage -->
 339       <th class="navbar" align="right" width="100%">
 340         <table border="0" cellpadding="0" cellspacing="0">
 341           <tr><th class="navbar" align="center"
 342             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 343           </tr></table></th>
 344   </tr>
 345 </table>
 346 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 347   <tr>
 348     <td align="left" class="footer">
 349     Generated by Epydoc 3.0.1
 350     on Wed Jan 29 12:26:21 2020
 351     </td>
 352     <td align="right" class="footer">
 353       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 354         >http://epydoc.sourceforge.net</a>
 355     </td>
 356   </tr>
 357 </table>
 358
 359 <script type="text/javascript">
 360   <!--
 361   // Private objects are initially displayed (because if
 362   // javascript is turned off then we want them to be
 363   // visible); but by default, we want to hide them.  So hide
 364   // them unless we have a cookie that says to show them.
 365   checkCookie();
 366   // -->
 367 </script>
 368 </body>
 369 </html>