doc/html/api/lxml.etree.XSLTAccessControl-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.XSLTAccessControl</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;XSLTAccessControl
  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.XSLTAccessControl-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 XSLTAccessControl</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">XSLTAccessControl</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>XSLTAccessControl(self, read_file=True, write_file=True, create_dir=True, read_network=True, write_network=True)</p>
  73 <p>Access control for XSLT: reading/writing files, directories and
  74 network I/O.  Access to a type of resource is granted or denied by
  75 passing any of the following boolean keyword arguments.  All of
  76 them default to True to allow access.</p>
  77 <ul class="rst-simple">
  78 <li>read_file</li>
  79 <li>write_file</li>
  80 <li>create_dir</li>
  81 <li>read_network</li>
  82 <li>write_network</li>
  83 </ul>
  84 <p>For convenience, there is also a class member <a href="lxml.etree.XSLTAccessControl-class.html#DENY_ALL" class="link">DENY_ALL</a> that
  85 provides an XSLTAccessControl instance that is readily configured
  86 to deny everything, and a <a href="lxml.etree.XSLTAccessControl-class.html#DENY_WRITE" class="link">DENY_WRITE</a> member that denies all
  87 write access but allows read access.</p>
  88 <p>See <a href="lxml.etree.XSLT-class.html" class="link">XSLT</a>.</p>
  89
  90 <!-- ==================== INSTANCE METHODS ==================== -->
  91 <a name="section-InstanceMethods"></a>
  92 <table class="summary" border="1" cellpadding="3"
  93        cellspacing="0" width="100%" bgcolor="white">
  94 <tr bgcolor="#70b0f0" class="table-header">
  95   <td colspan="2" class="table-header">
  96     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  97       <tr valign="top">
  98         <td align="left"><span class="table-header">Instance Methods</span></td>
  99         <td align="right" valign="top"
 100          ><span class="options">[<a href="#section-InstanceMethods"
 101          class="privatelink" onclick="toggle_private();"
 102          >hide private</a>]</span></td>
 103       </tr>
 104     </table>
 105   </td>
 106 </tr>
 107 <tr>
 108     <td width="15%" align="right" valign="top" class="summary">
 109       <span class="summary-type">a new object with type S, a subtype of T</span>
 110     </td><td class="summary">
 111       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 112         <tr>
 113           <td><span class="summary-sig"><a href="lxml.etree.XSLTAccessControl-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 114         <span class="summary-sig-arg">S</span>,
 115         <span class="summary-sig-arg">...</span>)</span></td>
 116           <td align="right" valign="top">
 117
 118
 119           </td>
 120         </tr>
 121       </table>
 122
 123     </td>
 124   </tr>
 125 <tr>
 126     <td width="15%" align="right" valign="top" class="summary">
 127       <span class="summary-type">&nbsp;</span>
 128     </td><td class="summary">
 129       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 130         <tr>
 131           <td><span class="summary-sig"><a href="lxml.etree.XSLTAccessControl-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">x</span>)</span><br />
 132       repr(x)</td>
 133           <td align="right" valign="top">
 134
 135
 136           </td>
 137         </tr>
 138       </table>
 139
 140     </td>
 141   </tr>
 142   <tr>
 143     <td colspan="2" class="summary">
 144     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 145       <code>__delattr__</code>,
 146       <code>__format__</code>,
 147       <code>__getattribute__</code>,
 148       <code>__hash__</code>,
 149       <code>__init__</code>,
 150       <code>__reduce__</code>,
 151       <code>__reduce_ex__</code>,
 152       <code>__setattr__</code>,
 153       <code>__sizeof__</code>,
 154       <code>__str__</code>,
 155       <code>__subclasshook__</code>
 156       </p>
 157     </td>
 158   </tr>
 159 </table>
 160 <!-- ==================== CLASS VARIABLES ==================== -->
 161 <a name="section-ClassVariables"></a>
 162 <table class="summary" border="1" cellpadding="3"
 163        cellspacing="0" width="100%" bgcolor="white">
 164 <tr bgcolor="#70b0f0" class="table-header">
 165   <td colspan="2" class="table-header">
 166     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 167       <tr valign="top">
 168         <td align="left"><span class="table-header">Class Variables</span></td>
 169         <td align="right" valign="top"
 170          ><span class="options">[<a href="#section-ClassVariables"
 171          class="privatelink" onclick="toggle_private();"
 172          >hide private</a>]</span></td>
 173       </tr>
 174     </table>
 175   </td>
 176 </tr>
 177 <tr>
 178     <td width="15%" align="right" valign="top" class="summary">
 179       <span class="summary-type">&nbsp;</span>
 180     </td><td class="summary">
 181         <a href="lxml.etree.XSLTAccessControl-class.html#DENY_ALL" class="summary-name">DENY_ALL</a> = <code title="XSLTAccessControl(create_dir=False, read_file=False, read_network=Fals\
 182 e, write_file=False, write_network=False)">XSLTAccessControl(create_dir=False, read_file=False<code class="variable-ellipsis">...</code></code>
 183     </td>
 184   </tr>
 185 <tr>
 186     <td width="15%" align="right" valign="top" class="summary">
 187       <span class="summary-type">&nbsp;</span>
 188     </td><td class="summary">
 189         <a href="lxml.etree.XSLTAccessControl-class.html#DENY_WRITE" class="summary-name">DENY_WRITE</a> = <code title="XSLTAccessControl(create_dir=False, read_file=True, read_network=True,\
 190  write_file=False, write_network=False)">XSLTAccessControl(create_dir=False, read_file=Tru<code class="variable-ellipsis">...</code></code>
 191     </td>
 192   </tr>
 193 </table>
 194 <!-- ==================== PROPERTIES ==================== -->
 195 <a name="section-Properties"></a>
 196 <table class="summary" border="1" cellpadding="3"
 197        cellspacing="0" width="100%" bgcolor="white">
 198 <tr bgcolor="#70b0f0" class="table-header">
 199   <td colspan="2" class="table-header">
 200     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 201       <tr valign="top">
 202         <td align="left"><span class="table-header">Properties</span></td>
 203         <td align="right" valign="top"
 204          ><span class="options">[<a href="#section-Properties"
 205          class="privatelink" onclick="toggle_private();"
 206          >hide private</a>]</span></td>
 207       </tr>
 208     </table>
 209   </td>
 210 </tr>
 211 <tr>
 212     <td width="15%" align="right" valign="top" class="summary">
 213       <span class="summary-type">&nbsp;</span>
 214     </td><td class="summary">
 215         <a name="options"></a><span class="summary-name">options</span><br />
 216       The access control configuration as a map of options.
 217     </td>
 218   </tr>
 219   <tr>
 220     <td colspan="2" class="summary">
 221     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 222       <code>__class__</code>
 223       </p>
 224     </td>
 225   </tr>
 226 </table>
 227 <!-- ==================== METHOD DETAILS ==================== -->
 228 <a name="section-MethodDetails"></a>
 229 <table class="details" border="1" cellpadding="3"
 230        cellspacing="0" width="100%" bgcolor="white">
 231 <tr bgcolor="#70b0f0" class="table-header">
 232   <td colspan="2" class="table-header">
 233     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 234       <tr valign="top">
 235         <td align="left"><span class="table-header">Method Details</span></td>
 236         <td align="right" valign="top"
 237          ><span class="options">[<a href="#section-MethodDetails"
 238          class="privatelink" onclick="toggle_private();"
 239          >hide private</a>]</span></td>
 240       </tr>
 241     </table>
 242   </td>
 243 </tr>
 244 </table>
 245 <a name="__new__"></a>
 246 <div>
 247 <table class="details" border="1" cellpadding="3"
 248        cellspacing="0" width="100%" bgcolor="white">
 249 <tr><td>
 250   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 251   <tr valign="top"><td>
 252   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 253         <span class="sig-arg">S</span>,
 254         <span class="sig-arg">...</span>)</span>
 255   </h3>
 256   </td><td align="right" valign="top"
 257     >&nbsp;
 258     </td>
 259   </tr></table>
 260
 261
 262   <dl class="fields">
 263     <dt>Returns: a new object with type S, a subtype of T</dt>
 264     <dt>Overrides:
 265         object.__new__
 266     </dt>
 267   </dl>
 268 </td></tr></table>
 269 </div>
 270 <a name="__repr__"></a>
 271 <div>
 272 <table class="details" border="1" cellpadding="3"
 273        cellspacing="0" width="100%" bgcolor="white">
 274 <tr><td>
 275   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 276   <tr valign="top"><td>
 277   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>
 278     <br /><em class="fname">(Representation operator)</em>
 279   </h3>
 280   </td><td align="right" valign="top"
 281     >&nbsp;
 282     </td>
 283   </tr></table>
 284
 285   repr(x)
 286   <dl class="fields">
 287     <dt>Overrides:
 288         object.__repr__
 289     </dt>
 290   </dl>
 291 </td></tr></table>
 292 </div>
 293 <br />
 294 <!-- ==================== CLASS VARIABLE DETAILS ==================== -->
 295 <a name="section-ClassVariableDetails"></a>
 296 <table class="details" border="1" cellpadding="3"
 297        cellspacing="0" width="100%" bgcolor="white">
 298 <tr bgcolor="#70b0f0" class="table-header">
 299   <td colspan="2" class="table-header">
 300     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 301       <tr valign="top">
 302         <td align="left"><span class="table-header">Class Variable Details</span></td>
 303         <td align="right" valign="top"
 304          ><span class="options">[<a href="#section-ClassVariableDetails"
 305          class="privatelink" onclick="toggle_private();"
 306          >hide private</a>]</span></td>
 307       </tr>
 308     </table>
 309   </td>
 310 </tr>
 311 </table>
 312 <a name="DENY_ALL"></a>
 313 <div>
 314 <table class="details" border="1" cellpadding="3"
 315        cellspacing="0" width="100%" bgcolor="white">
 316 <tr><td>
 317   <h3 class="epydoc">DENY_ALL</h3>
 318
 319   <dl class="fields">
 320   </dl>
 321   <dl class="fields">
 322     <dt>Value:</dt>
 323       <dd><table><tr><td><pre class="variable">
 324 XSLTAccessControl(create_dir=False, read_file=False, read_network=Fals<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 325 e, write_file=False, write_network=False)
 326 </pre></td></tr></table>
 327 </dd>
 328   </dl>
 329 </td></tr></table>
 330 </div>
 331 <a name="DENY_WRITE"></a>
 332 <div>
 333 <table class="details" border="1" cellpadding="3"
 334        cellspacing="0" width="100%" bgcolor="white">
 335 <tr><td>
 336   <h3 class="epydoc">DENY_WRITE</h3>
 337
 338   <dl class="fields">
 339   </dl>
 340   <dl class="fields">
 341     <dt>Value:</dt>
 342       <dd><table><tr><td><pre class="variable">
 343 XSLTAccessControl(create_dir=False, read_file=True, read_network=True,<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 344  write_file=False, write_network=False)
 345 </pre></td></tr></table>
 346 </dd>
 347   </dl>
 348 </td></tr></table>
 349 </div>
 350 <br />
 351 <!-- ==================== NAVIGATION BAR ==================== -->
 352 <table class="navbar" border="0" width="100%" cellpadding="0"
 353        bgcolor="#a0c0ff" cellspacing="0">
 354   <tr valign="middle">
 355   <!-- Home link -->
 356       <th>&nbsp;&nbsp;&nbsp;<a
 357         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 358
 359   <!-- Tree link -->
 360       <th>&nbsp;&nbsp;&nbsp;<a
 361         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 362
 363   <!-- Index link -->
 364       <th>&nbsp;&nbsp;&nbsp;<a
 365         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 366
 367   <!-- Help link -->
 368       <th>&nbsp;&nbsp;&nbsp;<a
 369         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 370
 371   <!-- Project homepage -->
 372       <th class="navbar" align="right" width="100%">
 373         <table border="0" cellpadding="0" cellspacing="0">
 374           <tr><th class="navbar" align="center"
 375             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 376           </tr></table></th>
 377   </tr>
 378 </table>
 379 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 380   <tr>
 381     <td align="left" class="footer">
 382     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 383     </td>
 384     <td align="right" class="footer">
 385       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 386         >http://epydoc.sourceforge.net</a>
 387     </td>
 388   </tr>
 389 </table>
 390
 391 <script type="text/javascript">
 392   <!--
 393   // Private objects are initially displayed (because if
 394   // javascript is turned off then we want them to be
 395   // visible); but by default, we want to hide them.  So hide
 396   // them unless we have a cookie that says to show them.
 397   checkCookie();
 398   // -->
 399 </script>
 400 </body>
 401 </html>