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">&nbsp;</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#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 114         <span class="summary-sig-arg">read_file</span>=<span class="summary-sig-default">True</span>,
 115         <span class="summary-sig-arg">write_file</span>=<span class="summary-sig-default">True</span>,
 116         <span class="summary-sig-arg">create_dir</span>=<span class="summary-sig-default">True</span>,
 117         <span class="summary-sig-arg">read_network</span>=<span class="summary-sig-default">True</span>,
 118         <span class="summary-sig-arg">write_network</span>=<span class="summary-sig-default">True</span>)</span><br />
 119       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 120           <td align="right" valign="top">
 121
 122
 123           </td>
 124         </tr>
 125       </table>
 126
 127     </td>
 128   </tr>
 129 <tr>
 130     <td width="15%" align="right" valign="top" class="summary">
 131       <span class="summary-type">a new object with type S, a subtype of T</span>
 132     </td><td class="summary">
 133       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 134         <tr>
 135           <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>,
 136         <span class="summary-sig-arg">S</span>,
 137         <span class="summary-sig-arg">...</span>)</span></td>
 138           <td align="right" valign="top">
 139
 140
 141           </td>
 142         </tr>
 143       </table>
 144
 145     </td>
 146   </tr>
 147 <tr>
 148     <td width="15%" align="right" valign="top" class="summary">
 149       <span class="summary-type">&nbsp;</span>
 150     </td><td class="summary">
 151       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 152         <tr>
 153           <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 />
 154       repr(x)</td>
 155           <td align="right" valign="top">
 156
 157
 158           </td>
 159         </tr>
 160       </table>
 161
 162     </td>
 163   </tr>
 164   <tr>
 165     <td colspan="2" class="summary">
 166     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 167       <code>__delattr__</code>,
 168       <code>__format__</code>,
 169       <code>__getattribute__</code>,
 170       <code>__hash__</code>,
 171       <code>__reduce__</code>,
 172       <code>__reduce_ex__</code>,
 173       <code>__setattr__</code>,
 174       <code>__sizeof__</code>,
 175       <code>__str__</code>,
 176       <code>__subclasshook__</code>
 177       </p>
 178     </td>
 179   </tr>
 180 </table>
 181 <!-- ==================== CLASS VARIABLES ==================== -->
 182 <a name="section-ClassVariables"></a>
 183 <table class="summary" border="1" cellpadding="3"
 184        cellspacing="0" width="100%" bgcolor="white">
 185 <tr bgcolor="#70b0f0" class="table-header">
 186   <td colspan="2" class="table-header">
 187     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 188       <tr valign="top">
 189         <td align="left"><span class="table-header">Class Variables</span></td>
 190         <td align="right" valign="top"
 191          ><span class="options">[<a href="#section-ClassVariables"
 192          class="privatelink" onclick="toggle_private();"
 193          >hide private</a>]</span></td>
 194       </tr>
 195     </table>
 196   </td>
 197 </tr>
 198 <tr>
 199     <td width="15%" align="right" valign="top" class="summary">
 200       <span class="summary-type">&nbsp;</span>
 201     </td><td class="summary">
 202         <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\
 203 e, write_file=False, write_network=False)">XSLTAccessControl(create_dir=False, read_file=False<code class="variable-ellipsis">...</code></code>
 204     </td>
 205   </tr>
 206 <tr>
 207     <td width="15%" align="right" valign="top" class="summary">
 208       <span class="summary-type">&nbsp;</span>
 209     </td><td class="summary">
 210         <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,\
 211  write_file=False, write_network=False)">XSLTAccessControl(create_dir=False, read_file=Tru<code class="variable-ellipsis">...</code></code>
 212     </td>
 213   </tr>
 214 </table>
 215 <!-- ==================== PROPERTIES ==================== -->
 216 <a name="section-Properties"></a>
 217 <table class="summary" border="1" cellpadding="3"
 218        cellspacing="0" width="100%" bgcolor="white">
 219 <tr bgcolor="#70b0f0" class="table-header">
 220   <td colspan="2" class="table-header">
 221     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 222       <tr valign="top">
 223         <td align="left"><span class="table-header">Properties</span></td>
 224         <td align="right" valign="top"
 225          ><span class="options">[<a href="#section-Properties"
 226          class="privatelink" onclick="toggle_private();"
 227          >hide private</a>]</span></td>
 228       </tr>
 229     </table>
 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="options"></a><span class="summary-name">options</span><br />
 237       The access control configuration as a map of options.
 238     </td>
 239   </tr>
 240   <tr>
 241     <td colspan="2" class="summary">
 242     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 243       <code>__class__</code>
 244       </p>
 245     </td>
 246   </tr>
 247 </table>
 248 <!-- ==================== METHOD DETAILS ==================== -->
 249 <a name="section-MethodDetails"></a>
 250 <table class="details" border="1" cellpadding="3"
 251        cellspacing="0" width="100%" bgcolor="white">
 252 <tr bgcolor="#70b0f0" class="table-header">
 253   <td colspan="2" class="table-header">
 254     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 255       <tr valign="top">
 256         <td align="left"><span class="table-header">Method Details</span></td>
 257         <td align="right" valign="top"
 258          ><span class="options">[<a href="#section-MethodDetails"
 259          class="privatelink" onclick="toggle_private();"
 260          >hide private</a>]</span></td>
 261       </tr>
 262     </table>
 263   </td>
 264 </tr>
 265 </table>
 266 <a name="__init__"></a>
 267 <div>
 268 <table class="details" border="1" cellpadding="3"
 269        cellspacing="0" width="100%" bgcolor="white">
 270 <tr><td>
 271   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 272   <tr valign="top"><td>
 273   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 274         <span class="sig-arg">read_file</span>=<span class="sig-default">True</span>,
 275         <span class="sig-arg">write_file</span>=<span class="sig-default">True</span>,
 276         <span class="sig-arg">create_dir</span>=<span class="sig-default">True</span>,
 277         <span class="sig-arg">read_network</span>=<span class="sig-default">True</span>,
 278         <span class="sig-arg">write_network</span>=<span class="sig-default">True</span>)</span>
 279     <br /><em class="fname">(Constructor)</em>
 280   </h3>
 281   </td><td align="right" valign="top"
 282     >&nbsp;
 283     </td>
 284   </tr></table>
 285
 286   x.__init__(...) initializes x; see help(type(x)) for signature
 287   <dl class="fields">
 288     <dt>Overrides:
 289         object.__init__
 290     </dt>
 291   </dl>
 292 </td></tr></table>
 293 </div>
 294 <a name="__new__"></a>
 295 <div>
 296 <table class="details" border="1" cellpadding="3"
 297        cellspacing="0" width="100%" bgcolor="white">
 298 <tr><td>
 299   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 300   <tr valign="top"><td>
 301   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 302         <span class="sig-arg">S</span>,
 303         <span class="sig-arg">...</span>)</span>
 304   </h3>
 305   </td><td align="right" valign="top"
 306     >&nbsp;
 307     </td>
 308   </tr></table>
 309
 310
 311   <dl class="fields">
 312     <dt>Returns: a new object with type S, a subtype of T</dt>
 313     <dt>Overrides:
 314         object.__new__
 315     </dt>
 316   </dl>
 317 </td></tr></table>
 318 </div>
 319 <a name="__repr__"></a>
 320 <div>
 321 <table class="details" border="1" cellpadding="3"
 322        cellspacing="0" width="100%" bgcolor="white">
 323 <tr><td>
 324   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 325   <tr valign="top"><td>
 326   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>
 327     <br /><em class="fname">(Representation operator)</em>
 328   </h3>
 329   </td><td align="right" valign="top"
 330     >&nbsp;
 331     </td>
 332   </tr></table>
 333
 334   repr(x)
 335   <dl class="fields">
 336     <dt>Overrides:
 337         object.__repr__
 338     </dt>
 339   </dl>
 340 </td></tr></table>
 341 </div>
 342 <br />
 343 <!-- ==================== CLASS VARIABLE DETAILS ==================== -->
 344 <a name="section-ClassVariableDetails"></a>
 345 <table class="details" border="1" cellpadding="3"
 346        cellspacing="0" width="100%" bgcolor="white">
 347 <tr bgcolor="#70b0f0" class="table-header">
 348   <td colspan="2" class="table-header">
 349     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 350       <tr valign="top">
 351         <td align="left"><span class="table-header">Class Variable Details</span></td>
 352         <td align="right" valign="top"
 353          ><span class="options">[<a href="#section-ClassVariableDetails"
 354          class="privatelink" onclick="toggle_private();"
 355          >hide private</a>]</span></td>
 356       </tr>
 357     </table>
 358   </td>
 359 </tr>
 360 </table>
 361 <a name="DENY_ALL"></a>
 362 <div>
 363 <table class="details" border="1" cellpadding="3"
 364        cellspacing="0" width="100%" bgcolor="white">
 365 <tr><td>
 366   <h3 class="epydoc">DENY_ALL</h3>
 367
 368   <dl class="fields">
 369   </dl>
 370   <dl class="fields">
 371     <dt>Value:</dt>
 372       <dd><table><tr><td><pre class="variable">
 373 XSLTAccessControl(create_dir=False, read_file=False, read_network=Fals<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 374 e, write_file=False, write_network=False)
 375 </pre></td></tr></table>
 376 </dd>
 377   </dl>
 378 </td></tr></table>
 379 </div>
 380 <a name="DENY_WRITE"></a>
 381 <div>
 382 <table class="details" border="1" cellpadding="3"
 383        cellspacing="0" width="100%" bgcolor="white">
 384 <tr><td>
 385   <h3 class="epydoc">DENY_WRITE</h3>
 386
 387   <dl class="fields">
 388   </dl>
 389   <dl class="fields">
 390     <dt>Value:</dt>
 391       <dd><table><tr><td><pre class="variable">
 392 XSLTAccessControl(create_dir=False, read_file=True, read_network=True,<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 393  write_file=False, write_network=False)
 394 </pre></td></tr></table>
 395 </dd>
 396   </dl>
 397 </td></tr></table>
 398 </div>
 399 <br />
 400 <!-- ==================== NAVIGATION BAR ==================== -->
 401 <table class="navbar" border="0" width="100%" cellpadding="0"
 402        bgcolor="#a0c0ff" cellspacing="0">
 403   <tr valign="middle">
 404   <!-- Home link -->
 405       <th>&nbsp;&nbsp;&nbsp;<a
 406         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 407
 408   <!-- Tree link -->
 409       <th>&nbsp;&nbsp;&nbsp;<a
 410         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 411
 412   <!-- Index link -->
 413       <th>&nbsp;&nbsp;&nbsp;<a
 414         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 415
 416   <!-- Help link -->
 417       <th>&nbsp;&nbsp;&nbsp;<a
 418         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 419
 420   <!-- Project homepage -->
 421       <th class="navbar" align="right" width="100%">
 422         <table border="0" cellpadding="0" cellspacing="0">
 423           <tr><th class="navbar" align="center"
 424             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 425           </tr></table></th>
 426   </tr>
 427 </table>
 428 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 429   <tr>
 430     <td align="left" class="footer">
 431     Generated by Epydoc 3.0.1
 432     on Wed Jan 29 12:26:21 2020
 433     </td>
 434     <td align="right" class="footer">
 435       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 436         >http://epydoc.sourceforge.net</a>
 437     </td>
 438   </tr>
 439 </table>
 440
 441 <script type="text/javascript">
 442   <!--
 443   // Private objects are initially displayed (because if
 444   // javascript is turned off then we want them to be
 445   // visible); but by default, we want to hide them.  So hide
 446   // them unless we have a cookie that says to show them.
 447   checkCookie();
 448   // -->
 449 </script>
 450 </body>
 451 </html>