doc/html/api/lxml.isoschematron-module.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.isoschematron</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         Package&nbsp;isoschematron
  47       </span>
  48     </td>
  49     <td>
  50       <table cellpadding="0" cellspacing="0">
  51         <!-- hide/show private -->
  52         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  53     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  54         <tr><td align="right"><span class="options"
  55             >[<a href="frames.html" target="_top">frames</a
  56             >]&nbsp;|&nbsp;<a href="lxml.isoschematron-module.html"
  57             target="_top">no&nbsp;frames</a>]</span></td></tr>
  58       </table>
  59     </td>
  60   </tr>
  61 </table>
  62 <!-- ==================== PACKAGE DESCRIPTION ==================== -->
  63 <h1 class="epydoc">Package isoschematron</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.isoschematron-pysrc.html">source&nbsp;code</a></span></p>
  64 The <tt class="rst-docutils literal">lxml.isoschematron</tt> package implements ISO Schematron support on top
  65 of the pure-xslt 'skeleton' implementation.
  66
  67 <!-- ==================== CLASSES ==================== -->
  68 <a name="section-Classes"></a>
  69 <table class="summary" border="1" cellpadding="3"
  70        cellspacing="0" width="100%" bgcolor="white">
  71 <tr bgcolor="#70b0f0" class="table-header">
  72   <td colspan="2" class="table-header">
  73     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  74       <tr valign="top">
  75         <td align="left"><span class="table-header">Classes</span></td>
  76         <td align="right" valign="top"
  77          ><span class="options">[<a href="#section-Classes"
  78          class="privatelink" onclick="toggle_private();"
  79          >hide private</a>]</span></td>
  80       </tr>
  81     </table>
  82   </td>
  83 </tr>
  84 <tr class="private">
  85     <td width="15%" align="right" valign="top" class="summary">
  86       <span class="summary-type">&nbsp;</span>
  87     </td><td class="summary">
  88         <a href="str-class.html" class="summary-name" onclick="show_private();">unicode</a><br />
  89       str(object='') -&gt; string
  90     </td>
  91   </tr>
  92 <tr class="private">
  93     <td width="15%" align="right" valign="top" class="summary">
  94       <span class="summary-type">&nbsp;</span>
  95     </td><td class="summary">
  96         <a href="str-class.html" class="summary-name" onclick="show_private();">basestring</a><br />
  97       str(object='') -&gt; string
  98     </td>
  99   </tr>
 100 <tr>
 101     <td width="15%" align="right" valign="top" class="summary">
 102       <span class="summary-type">&nbsp;</span>
 103     </td><td class="summary">
 104         <a href="lxml.isoschematron.Schematron-class.html" class="summary-name">Schematron</a><br />
 105       An ISO Schematron validator.
 106     </td>
 107   </tr>
 108 </table>
 109 <!-- ==================== FUNCTIONS ==================== -->
 110 <a name="section-Functions"></a>
 111 <table class="summary" border="1" cellpadding="3"
 112        cellspacing="0" width="100%" bgcolor="white">
 113 <tr bgcolor="#70b0f0" class="table-header">
 114   <td colspan="2" class="table-header">
 115     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 116       <tr valign="top">
 117         <td align="left"><span class="table-header">Functions</span></td>
 118         <td align="right" valign="top"
 119          ><span class="options">[<a href="#section-Functions"
 120          class="privatelink" onclick="toggle_private();"
 121          >hide private</a>]</span></td>
 122       </tr>
 123     </table>
 124   </td>
 125 </tr>
 126 <tr>
 127     <td width="15%" align="right" valign="top" class="summary">
 128       <span class="summary-type">&nbsp;</span>
 129     </td><td class="summary">
 130       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 131         <tr>
 132           <td><span class="summary-sig"><a href="lxml.isoschematron-module.html#stylesheet_params" class="summary-sig-name">stylesheet_params</a>(<span class="summary-sig-arg">**kwargs</span>)</span><br />
 133       Convert keyword args to a dictionary of stylesheet parameters.
 134 XSL stylesheet parameters must be XPath expressions, i.e.:</td>
 135           <td align="right" valign="top">
 136             <span class="codelink"><a href="lxml.isoschematron-pysrc.html#stylesheet_params">source&nbsp;code</a></span>
 137
 138           </td>
 139         </tr>
 140       </table>
 141
 142     </td>
 143   </tr>
 144 <tr class="private">
 145     <td width="15%" align="right" valign="top" class="summary">
 146       <span class="summary-type">&nbsp;</span>
 147     </td><td class="summary">
 148       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 149         <tr>
 150           <td><span class="summary-sig"><a name="_stylesheet_param_dict"></a><span class="summary-sig-name">_stylesheet_param_dict</span>(<span class="summary-sig-arg">paramsDict</span>,
 151         <span class="summary-sig-arg">kwargsDict</span>)</span><br />
 152       Return a copy of paramsDict, updated with kwargsDict entries, wrapped as
 153 stylesheet arguments.
 154 kwargsDict entries with a value of None are ignored.</td>
 155           <td align="right" valign="top">
 156             <span class="codelink"><a href="lxml.isoschematron-pysrc.html#_stylesheet_param_dict">source&nbsp;code</a></span>
 157
 158           </td>
 159         </tr>
 160       </table>
 161
 162     </td>
 163   </tr>
 164 </table>
 165 <!-- ==================== VARIABLES ==================== -->
 166 <a name="section-Variables"></a>
 167 <table class="summary" border="1" cellpadding="3"
 168        cellspacing="0" width="100%" bgcolor="white">
 169 <tr bgcolor="#70b0f0" class="table-header">
 170   <td colspan="2" class="table-header">
 171     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 172       <tr valign="top">
 173         <td align="left"><span class="table-header">Variables</span></td>
 174         <td align="right" valign="top"
 175          ><span class="options">[<a href="#section-Variables"
 176          class="privatelink" onclick="toggle_private();"
 177          >hide private</a>]</span></td>
 178       </tr>
 179     </table>
 180   </td>
 181 </tr>
 182 <tr class="private">
 183     <td width="15%" align="right" valign="top" class="summary">
 184       <span class="summary-type">&nbsp;</span>
 185     </td><td class="summary">
 186         <a name="XML_SCHEMA_NS"></a><span class="summary-name">XML_SCHEMA_NS</span> = <code title="'http://www.w3.org/2001/XMLSchema'"><code class="variable-quote">'</code><code class="variable-string">http://www.w3.org/2001/XMLSchema</code><code class="variable-quote">'</code></code>
 187     </td>
 188   </tr>
 189 <tr class="private">
 190     <td width="15%" align="right" valign="top" class="summary">
 191       <span class="summary-type">&nbsp;</span>
 192     </td><td class="summary">
 193         <a name="RELAXNG_NS"></a><span class="summary-name">RELAXNG_NS</span> = <code title="'http://relaxng.org/ns/structure/1.0'"><code class="variable-quote">'</code><code class="variable-string">http://relaxng.org/ns/structure/1.0</code><code class="variable-quote">'</code></code>
 194     </td>
 195   </tr>
 196 <tr class="private">
 197     <td width="15%" align="right" valign="top" class="summary">
 198       <span class="summary-type">&nbsp;</span>
 199     </td><td class="summary">
 200         <a name="SCHEMATRON_NS"></a><span class="summary-name">SCHEMATRON_NS</span> = <code title="'http://purl.oclc.org/dsdl/schematron'"><code class="variable-quote">'</code><code class="variable-string">http://purl.oclc.org/dsdl/schematron</code><code class="variable-quote">'</code></code>
 201     </td>
 202   </tr>
 203 <tr class="private">
 204     <td width="15%" align="right" valign="top" class="summary">
 205       <span class="summary-type">&nbsp;</span>
 206     </td><td class="summary">
 207         <a name="SVRL_NS"></a><span class="summary-name">SVRL_NS</span> = <code title="'http://purl.oclc.org/dsdl/svrl'"><code class="variable-quote">'</code><code class="variable-string">http://purl.oclc.org/dsdl/svrl</code><code class="variable-quote">'</code></code>
 208     </td>
 209   </tr>
 210 <tr class="private">
 211     <td width="15%" align="right" valign="top" class="summary">
 212       <span class="summary-type">&nbsp;</span>
 213     </td><td class="summary">
 214         <a name="_schematron_root"></a><span class="summary-name">_schematron_root</span> = <code title="'{http://purl.oclc.org/dsdl/schematron}schema'"><code class="variable-quote">'</code><code class="variable-string">{http://purl.oclc.org/dsdl/schematron}schema</code><code class="variable-quote">'</code></code>
 215     </td>
 216   </tr>
 217 <tr class="private">
 218     <td width="15%" align="right" valign="top" class="summary">
 219       <span class="summary-type">&nbsp;</span>
 220     </td><td class="summary">
 221         <a name="_xml_schema_root"></a><span class="summary-name">_xml_schema_root</span> = <code title="'{http://www.w3.org/2001/XMLSchema}schema'"><code class="variable-quote">'</code><code class="variable-string">{http://www.w3.org/2001/XMLSchema}schema</code><code class="variable-quote">'</code></code>
 222     </td>
 223   </tr>
 224 <tr class="private">
 225     <td width="15%" align="right" valign="top" class="summary">
 226       <span class="summary-type">&nbsp;</span>
 227     </td><td class="summary">
 228         <a href="lxml.isoschematron-module.html#_resources_dir" class="summary-name" onclick="show_private();">_resources_dir</a> = <code title="'/home/stefan/source/Python/lxml/lxml-release/src/lxml/isoschematron/r\
 229 esources'"><code class="variable-quote">'</code><code class="variable-string">/home/stefan/source/Python/lxml/lxml-release</code><code class="variable-ellipsis">...</code></code>
 230     </td>
 231   </tr>
 232 <tr>
 233     <td width="15%" align="right" valign="top" class="summary">
 234       <span class="summary-type">&nbsp;</span>
 235     </td><td class="summary">
 236         <a name="extract_xsd"></a><span class="summary-name">extract_xsd</span> = <code title="&lt;lxml.etree.XSLT object&gt;">&lt;lxml.etree.XSLT object&gt;</code>
 237     </td>
 238   </tr>
 239 <tr>
 240     <td width="15%" align="right" valign="top" class="summary">
 241       <span class="summary-type">&nbsp;</span>
 242     </td><td class="summary">
 243         <a name="extract_rng"></a><span class="summary-name">extract_rng</span> = <code title="&lt;lxml.etree.XSLT object&gt;">&lt;lxml.etree.XSLT object&gt;</code>
 244     </td>
 245   </tr>
 246 <tr>
 247     <td width="15%" align="right" valign="top" class="summary">
 248       <span class="summary-type">&nbsp;</span>
 249     </td><td class="summary">
 250         <a name="iso_dsdl_include"></a><span class="summary-name">iso_dsdl_include</span> = <code title="&lt;lxml.etree.XSLT object&gt;">&lt;lxml.etree.XSLT object&gt;</code>
 251     </td>
 252   </tr>
 253 <tr>
 254     <td width="15%" align="right" valign="top" class="summary">
 255       <span class="summary-type">&nbsp;</span>
 256     </td><td class="summary">
 257         <a name="iso_abstract_expand"></a><span class="summary-name">iso_abstract_expand</span> = <code title="&lt;lxml.etree.XSLT object&gt;">&lt;lxml.etree.XSLT object&gt;</code>
 258     </td>
 259   </tr>
 260 <tr>
 261     <td width="15%" align="right" valign="top" class="summary">
 262       <span class="summary-type">&nbsp;</span>
 263     </td><td class="summary">
 264         <a name="iso_svrl_for_xslt1"></a><span class="summary-name">iso_svrl_for_xslt1</span> = <code title="&lt;lxml.etree.XSLT object&gt;">&lt;lxml.etree.XSLT object&gt;</code>
 265     </td>
 266   </tr>
 267 <tr>
 268     <td width="15%" align="right" valign="top" class="summary">
 269       <span class="summary-type">&nbsp;</span>
 270     </td><td class="summary">
 271         <a name="svrl_validation_errors"></a><span class="summary-name">svrl_validation_errors</span> = <code title="//svrl:failed-assert">//svrl:failed-assert</code>
 272     </td>
 273   </tr>
 274 <tr>
 275     <td width="15%" align="right" valign="top" class="summary">
 276       <span class="summary-type">&nbsp;</span>
 277     </td><td class="summary">
 278         <a name="schematron_schema_valid"></a><span class="summary-name">schematron_schema_valid</span> = <code title="&lt;lxml.etree.RelaxNG object&gt;">&lt;lxml.etree.RelaxNG object&gt;</code>
 279     </td>
 280   </tr>
 281 <tr class="private">
 282     <td width="15%" align="right" valign="top" class="summary">
 283       <span class="summary-type">&nbsp;</span>
 284     </td><td class="summary">
 285         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'lxml.isoschematron'"><code class="variable-quote">'</code><code class="variable-string">lxml.isoschematron</code><code class="variable-quote">'</code></code>
 286     </td>
 287   </tr>
 288 </table>
 289 <!-- ==================== FUNCTION DETAILS ==================== -->
 290 <a name="section-FunctionDetails"></a>
 291 <table class="details" border="1" cellpadding="3"
 292        cellspacing="0" width="100%" bgcolor="white">
 293 <tr bgcolor="#70b0f0" class="table-header">
 294   <td colspan="2" class="table-header">
 295     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 296       <tr valign="top">
 297         <td align="left"><span class="table-header">Function Details</span></td>
 298         <td align="right" valign="top"
 299          ><span class="options">[<a href="#section-FunctionDetails"
 300          class="privatelink" onclick="toggle_private();"
 301          >hide private</a>]</span></td>
 302       </tr>
 303     </table>
 304   </td>
 305 </tr>
 306 </table>
 307 <a name="stylesheet_params"></a>
 308 <div>
 309 <table class="details" border="1" cellpadding="3"
 310        cellspacing="0" width="100%" bgcolor="white">
 311 <tr><td>
 312   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 313   <tr valign="top"><td>
 314   <h3 class="epydoc"><span class="sig"><span class="sig-name">stylesheet_params</span>(<span class="sig-arg">**kwargs</span>)</span>
 315   </h3>
 316   </td><td align="right" valign="top"
 317     ><span class="codelink"><a href="lxml.isoschematron-pysrc.html#stylesheet_params">source&nbsp;code</a></span>&nbsp;
 318     </td>
 319   </tr></table>
 320
 321   <p>Convert keyword args to a dictionary of stylesheet parameters.
 322 XSL stylesheet parameters must be XPath expressions, i.e.:</p>
 323 <ul class="rst-simple">
 324 <li>string expressions, like &quot;'5'&quot;</li>
 325 <li>simple (number) expressions, like &quot;5&quot;</li>
 326 <li>valid XPath expressions, like &quot;/a/b/text()&quot;</li>
 327 </ul>
 328 <p>This function converts native Python keyword arguments to stylesheet
 329 parameters following these rules:
 330 If an arg is a string wrap it with XSLT.strparam().
 331 If an arg is an XPath object use its path string.
 332 If arg is None raise TypeError.
 333 Else convert arg to string.</p>
 334   <dl class="fields">
 335   </dl>
 336 </td></tr></table>
 337 </div>
 338 <br />
 339 <!-- ==================== VARIABLES DETAILS ==================== -->
 340 <a name="section-VariablesDetails"></a>
 341 <table class="details" border="1" cellpadding="3"
 342        cellspacing="0" width="100%" bgcolor="white">
 343 <tr bgcolor="#70b0f0" class="table-header">
 344   <td colspan="2" class="table-header">
 345     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 346       <tr valign="top">
 347         <td align="left"><span class="table-header">Variables Details</span></td>
 348         <td align="right" valign="top"
 349          ><span class="options">[<a href="#section-VariablesDetails"
 350          class="privatelink" onclick="toggle_private();"
 351          >hide private</a>]</span></td>
 352       </tr>
 353     </table>
 354   </td>
 355 </tr>
 356 </table>
 357 <a name="_resources_dir"></a>
 358 <div class="private">
 359 <table class="details" border="1" cellpadding="3"
 360        cellspacing="0" width="100%" bgcolor="white">
 361 <tr><td>
 362   <h3 class="epydoc">_resources_dir</h3>
 363
 364   <dl class="fields">
 365   </dl>
 366   <dl class="fields">
 367     <dt>Value:</dt>
 368       <dd><table><tr><td><pre class="variable">
 369 <code class="variable-quote">'</code><code class="variable-string">/home/stefan/source/Python/lxml/lxml-release/src/lxml/isoschematron/r</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 370 <code class="variable-string">esources</code><code class="variable-quote">'</code>
 371 </pre></td></tr></table>
 372 </dd>
 373   </dl>
 374 </td></tr></table>
 375 </div>
 376 <br />
 377 <!-- ==================== NAVIGATION BAR ==================== -->
 378 <table class="navbar" border="0" width="100%" cellpadding="0"
 379        bgcolor="#a0c0ff" cellspacing="0">
 380   <tr valign="middle">
 381   <!-- Home link -->
 382       <th>&nbsp;&nbsp;&nbsp;<a
 383         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 384
 385   <!-- Tree link -->
 386       <th>&nbsp;&nbsp;&nbsp;<a
 387         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 388
 389   <!-- Index link -->
 390       <th>&nbsp;&nbsp;&nbsp;<a
 391         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 392
 393   <!-- Help link -->
 394       <th>&nbsp;&nbsp;&nbsp;<a
 395         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 396
 397   <!-- Project homepage -->
 398       <th class="navbar" align="right" width="100%">
 399         <table border="0" cellpadding="0" cellspacing="0">
 400           <tr><th class="navbar" align="center"
 401             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 402           </tr></table></th>
 403   </tr>
 404 </table>
 405 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 406   <tr>
 407     <td align="left" class="footer">
 408     Generated by Epydoc 3.0.1
 409     on Thu Jul  9 18:29:53 2020
 410     </td>
 411     <td align="right" class="footer">
 412       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 413         >http://epydoc.sourceforge.net</a>
 414     </td>
 415   </tr>
 416 </table>
 417
 418 <script type="text/javascript">
 419   <!--
 420   // Private objects are initially displayed (because if
 421   // javascript is turned off then we want them to be
 422   // visible); but by default, we want to hide them.  So hide
 423   // them unless we have a cookie that says to show them.
 424   checkCookie();
 425   // -->
 426 </script>
 427 </body>
 428 </html>