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