doc/html/api/lxml.etree.AttributeBasedElementClassLookup-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.AttributeBasedElementClassLookup</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;AttributeBasedElementClassLookup
  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.AttributeBasedElementClassLookup-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 AttributeBasedElementClassLookup</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66             object --+
  67                      |
  68     <a href="lxml.etree.ElementClassLookup-class.html">ElementClassLookup</a> --+
  69                          |
  70 <a href="lxml.etree.FallbackElementClassLookup-class.html">FallbackElementClassLookup</a> --+
  71                              |
  72                             <strong class="uidshort">AttributeBasedElementClassLookup</strong>
  73 </pre>
  74
  75 <hr />
  76 <p>AttributeBasedElementClassLookup(self, attribute_name, class_mapping, fallback=None)
  77 Checks an attribute of an Element and looks up the value in a
  78 class dictionary.</p>
  79 <dl class="rst-docutils">
  80 <dt>Arguments:</dt>
  81 <dd><ul class="rst-first rst-last rst-simple">
  82 <li>attribute name - '{ns}name' style string</li>
  83 <li>class mapping  - Python dict mapping attribute values to Element classes</li>
  84 <li>fallback       - optional fallback lookup mechanism</li>
  85 </ul>
  86 </dd>
  87 </dl>
  88 <p>A None key in the class mapping will be checked if the attribute is
  89 missing.</p>
  90
  91 <!-- ==================== INSTANCE METHODS ==================== -->
  92 <a name="section-InstanceMethods"></a>
  93 <table class="summary" border="1" cellpadding="3"
  94        cellspacing="0" width="100%" bgcolor="white">
  95 <tr bgcolor="#70b0f0" class="table-header">
  96   <td colspan="2" class="table-header">
  97     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  98       <tr valign="top">
  99         <td align="left"><span class="table-header">Instance Methods</span></td>
 100         <td align="right" valign="top"
 101          ><span class="options">[<a href="#section-InstanceMethods"
 102          class="privatelink" onclick="toggle_private();"
 103          >hide private</a>]</span></td>
 104       </tr>
 105     </table>
 106   </td>
 107 </tr>
 108 <tr>
 109     <td width="15%" align="right" valign="top" class="summary">
 110       <span class="summary-type">&nbsp;</span>
 111     </td><td class="summary">
 112       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 113         <tr>
 114           <td><span class="summary-sig"><a href="lxml.etree.AttributeBasedElementClassLookup-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 115         <span class="summary-sig-arg">attribute_name</span>,
 116         <span class="summary-sig-arg">class_mapping</span>,
 117         <span class="summary-sig-arg">fallback</span>=<span class="summary-sig-default">None</span>)</span><br />
 118       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 119           <td align="right" valign="top">
 120
 121
 122           </td>
 123         </tr>
 124       </table>
 125
 126     </td>
 127   </tr>
 128 <tr>
 129     <td width="15%" align="right" valign="top" class="summary">
 130       <span class="summary-type">a new object with type S, a subtype of T</span>
 131     </td><td class="summary">
 132       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 133         <tr>
 134           <td><span class="summary-sig"><a href="lxml.etree.AttributeBasedElementClassLookup-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 135         <span class="summary-sig-arg">S</span>,
 136         <span class="summary-sig-arg">...</span>)</span></td>
 137           <td align="right" valign="top">
 138
 139
 140           </td>
 141         </tr>
 142       </table>
 143
 144     </td>
 145   </tr>
 146   <tr>
 147     <td colspan="2" class="summary">
 148     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.FallbackElementClassLookup-class.html">FallbackElementClassLookup</a></code></b>:
 149       <code><a href="lxml.etree.FallbackElementClassLookup-class.html#set_fallback">set_fallback</a></code>
 150       </p>
 151     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 152       <code>__delattr__</code>,
 153       <code>__format__</code>,
 154       <code>__getattribute__</code>,
 155       <code>__hash__</code>,
 156       <code>__reduce__</code>,
 157       <code>__reduce_ex__</code>,
 158       <code>__repr__</code>,
 159       <code>__setattr__</code>,
 160       <code>__sizeof__</code>,
 161       <code>__str__</code>,
 162       <code>__subclasshook__</code>
 163       </p>
 164     </td>
 165   </tr>
 166 </table>
 167 <!-- ==================== PROPERTIES ==================== -->
 168 <a name="section-Properties"></a>
 169 <table class="summary" border="1" cellpadding="3"
 170        cellspacing="0" width="100%" bgcolor="white">
 171 <tr bgcolor="#70b0f0" class="table-header">
 172   <td colspan="2" class="table-header">
 173     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 174       <tr valign="top">
 175         <td align="left"><span class="table-header">Properties</span></td>
 176         <td align="right" valign="top"
 177          ><span class="options">[<a href="#section-Properties"
 178          class="privatelink" onclick="toggle_private();"
 179          >hide private</a>]</span></td>
 180       </tr>
 181     </table>
 182   </td>
 183 </tr>
 184   <tr>
 185     <td colspan="2" class="summary">
 186     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.FallbackElementClassLookup-class.html">FallbackElementClassLookup</a></code></b>:
 187       <code><a href="lxml.etree.FallbackElementClassLookup-class.html#fallback">fallback</a></code>
 188       </p>
 189     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 190       <code>__class__</code>
 191       </p>
 192     </td>
 193   </tr>
 194 </table>
 195 <!-- ==================== METHOD DETAILS ==================== -->
 196 <a name="section-MethodDetails"></a>
 197 <table class="details" border="1" cellpadding="3"
 198        cellspacing="0" width="100%" bgcolor="white">
 199 <tr bgcolor="#70b0f0" class="table-header">
 200   <td colspan="2" class="table-header">
 201     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 202       <tr valign="top">
 203         <td align="left"><span class="table-header">Method Details</span></td>
 204         <td align="right" valign="top"
 205          ><span class="options">[<a href="#section-MethodDetails"
 206          class="privatelink" onclick="toggle_private();"
 207          >hide private</a>]</span></td>
 208       </tr>
 209     </table>
 210   </td>
 211 </tr>
 212 </table>
 213 <a name="__init__"></a>
 214 <div>
 215 <table class="details" border="1" cellpadding="3"
 216        cellspacing="0" width="100%" bgcolor="white">
 217 <tr><td>
 218   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 219   <tr valign="top"><td>
 220   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 221         <span class="sig-arg">attribute_name</span>,
 222         <span class="sig-arg">class_mapping</span>,
 223         <span class="sig-arg">fallback</span>=<span class="sig-default">None</span>)</span>
 224     <br /><em class="fname">(Constructor)</em>
 225   </h3>
 226   </td><td align="right" valign="top"
 227     >&nbsp;
 228     </td>
 229   </tr></table>
 230
 231   x.__init__(...) initializes x; see help(type(x)) for signature
 232   <dl class="fields">
 233     <dt>Overrides:
 234         object.__init__
 235     </dt>
 236   </dl>
 237 </td></tr></table>
 238 </div>
 239 <a name="__new__"></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">__new__</span>(<span class="sig-arg">T</span>,
 247         <span class="sig-arg">S</span>,
 248         <span class="sig-arg">...</span>)</span>
 249   </h3>
 250   </td><td align="right" valign="top"
 251     >&nbsp;
 252     </td>
 253   </tr></table>
 254
 255
 256   <dl class="fields">
 257     <dt>Returns: a new object with type S, a subtype of T</dt>
 258     <dt>Overrides:
 259         object.__new__
 260     </dt>
 261   </dl>
 262 </td></tr></table>
 263 </div>
 264 <br />
 265 <!-- ==================== NAVIGATION BAR ==================== -->
 266 <table class="navbar" border="0" width="100%" cellpadding="0"
 267        bgcolor="#a0c0ff" cellspacing="0">
 268   <tr valign="middle">
 269   <!-- Home link -->
 270       <th>&nbsp;&nbsp;&nbsp;<a
 271         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 272
 273   <!-- Tree link -->
 274       <th>&nbsp;&nbsp;&nbsp;<a
 275         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 276
 277   <!-- Index link -->
 278       <th>&nbsp;&nbsp;&nbsp;<a
 279         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 280
 281   <!-- Help link -->
 282       <th>&nbsp;&nbsp;&nbsp;<a
 283         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 284
 285   <!-- Project homepage -->
 286       <th class="navbar" align="right" width="100%">
 287         <table border="0" cellpadding="0" cellspacing="0">
 288           <tr><th class="navbar" align="center"
 289             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 290           </tr></table></th>
 291   </tr>
 292 </table>
 293 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 294   <tr>
 295     <td align="left" class="footer">
 296     Generated by Epydoc 3.0.1
 297     on Wed Jan 29 12:26:21 2020
 298     </td>
 299     <td align="right" class="footer">
 300       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 301         >http://epydoc.sourceforge.net</a>
 302     </td>
 303   </tr>
 304 </table>
 305
 306 <script type="text/javascript">
 307   <!--
 308   // Private objects are initially displayed (because if
 309   // javascript is turned off then we want them to be
 310   // visible); but by default, we want to hide them.  So hide
 311   // them unless we have a cookie that says to show them.
 312   checkCookie();
 313   // -->
 314 </script>
 315 </body>
 316 </html>