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="/">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">file</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 help(type(x)) 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     <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):
 159       <code><a href="lxml.etree._Validator-class.html#_append_log_message" onclick="show_private();">_append_log_message</a></code>,
 160       <code><a href="lxml.etree._Validator-class.html#_clear_error_log" onclick="show_private();">_clear_error_log</a></code>
 161       </p></div>
 162     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 163       <code>__delattr__</code>,
 164       <code>__format__</code>,
 165       <code>__getattribute__</code>,
 166       <code>__hash__</code>,
 167       <code>__reduce__</code>,
 168       <code>__reduce_ex__</code>,
 169       <code>__repr__</code>,
 170       <code>__setattr__</code>,
 171       <code>__sizeof__</code>,
 172       <code>__str__</code>,
 173       <code>__subclasshook__</code>
 174       </p>
 175     </td>
 176   </tr>
 177 </table>
 178 <!-- ==================== PROPERTIES ==================== -->
 179 <a name="section-Properties"></a>
 180 <table class="summary" border="1" cellpadding="3"
 181        cellspacing="0" width="100%" bgcolor="white">
 182 <tr bgcolor="#70b0f0" class="table-header">
 183   <td colspan="2" class="table-header">
 184     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 185       <tr valign="top">
 186         <td align="left"><span class="table-header">Properties</span></td>
 187         <td align="right" valign="top"
 188          ><span class="options">[<a href="#section-Properties"
 189          class="privatelink" onclick="toggle_private();"
 190          >hide private</a>]</span></td>
 191       </tr>
 192     </table>
 193   </td>
 194 </tr>
 195   <tr>
 196     <td colspan="2" class="summary">
 197     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Validator-class.html" onclick="show_private();">_Validator</a></code></b>:
 198       <code><a href="lxml.etree._Validator-class.html#error_log">error_log</a></code>
 199       </p>
 200     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 201       <code>__class__</code>
 202       </p>
 203     </td>
 204   </tr>
 205 </table>
 206 <!-- ==================== METHOD DETAILS ==================== -->
 207 <a name="section-MethodDetails"></a>
 208 <table class="details" border="1" cellpadding="3"
 209        cellspacing="0" width="100%" bgcolor="white">
 210 <tr bgcolor="#70b0f0" class="table-header">
 211   <td colspan="2" class="table-header">
 212     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 213       <tr valign="top">
 214         <td align="left"><span class="table-header">Method Details</span></td>
 215         <td align="right" valign="top"
 216          ><span class="options">[<a href="#section-MethodDetails"
 217          class="privatelink" onclick="toggle_private();"
 218          >hide private</a>]</span></td>
 219       </tr>
 220     </table>
 221   </td>
 222 </tr>
 223 </table>
 224 <a name="__call__"></a>
 225 <div>
 226 <table class="details" border="1" cellpadding="3"
 227        cellspacing="0" width="100%" bgcolor="white">
 228 <tr><td>
 229   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 230   <tr valign="top"><td>
 231   <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
 232         <span class="sig-arg">etree</span>)</span>
 233     <br /><em class="fname">(Call operator)</em>
 234   </h3>
 235   </td><td align="right" valign="top"
 236     >&nbsp;
 237     </td>
 238   </tr></table>
 239
 240   <p>Validate doc using Relax NG.</p>
 241 <p>Returns true if document is valid, false if not.</p>
 242   <dl class="fields">
 243   </dl>
 244 </td></tr></table>
 245 </div>
 246 <a name="__init__"></a>
 247 <div>
 248 <table class="details" border="1" cellpadding="3"
 249        cellspacing="0" width="100%" bgcolor="white">
 250 <tr><td>
 251   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 252   <tr valign="top"><td>
 253   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 254         <span class="sig-arg">etree</span>=<span class="sig-default">None</span>,
 255         <span class="sig-arg">file</span>=<span class="sig-default">None</span>)</span>
 256     <br /><em class="fname">(Constructor)</em>
 257   </h3>
 258   </td><td align="right" valign="top"
 259     >&nbsp;
 260     </td>
 261   </tr></table>
 262
 263   x.__init__(...) initializes x; see help(type(x)) for signature
 264   <dl class="fields">
 265     <dt>Overrides:
 266         object.__init__
 267     </dt>
 268   </dl>
 269 </td></tr></table>
 270 </div>
 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 <br />
 297 <!-- ==================== NAVIGATION BAR ==================== -->
 298 <table class="navbar" border="0" width="100%" cellpadding="0"
 299        bgcolor="#a0c0ff" cellspacing="0">
 300   <tr valign="middle">
 301   <!-- Home link -->
 302       <th>&nbsp;&nbsp;&nbsp;<a
 303         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 304
 305   <!-- Tree link -->
 306       <th>&nbsp;&nbsp;&nbsp;<a
 307         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 308
 309   <!-- Index link -->
 310       <th>&nbsp;&nbsp;&nbsp;<a
 311         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 312
 313   <!-- Help link -->
 314       <th>&nbsp;&nbsp;&nbsp;<a
 315         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 316
 317   <!-- Project homepage -->
 318       <th class="navbar" align="right" width="100%">
 319         <table border="0" cellpadding="0" cellspacing="0">
 320           <tr><th class="navbar" align="center"
 321             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 322           </tr></table></th>
 323   </tr>
 324 </table>
 325 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 326   <tr>
 327     <td align="left" class="footer">
 328     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 329     </td>
 330     <td align="right" class="footer">
 331       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 332         >http://epydoc.sourceforge.net</a>
 333     </td>
 334   </tr>
 335 </table>
 336
 337 <script type="text/javascript">
 338   <!--
 339   // Private objects are initially displayed (because if
 340   // javascript is turned off then we want them to be
 341   // visible); but by default, we want to hide them.  So hide
 342   // them unless we have a cookie that says to show them.
 343   checkCookie();
 344   // -->
 345 </script>
 346 </body>
 347 </html>