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