doc/html/api/lxml.etree.ElementNamespaceClassLookup-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.ElementNamespaceClassLookup</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;ElementNamespaceClassLookup
  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.ElementNamespaceClassLookup-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 ElementNamespaceClassLookup</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">ElementNamespaceClassLookup</strong>
  73 </pre>
  74
  75 <hr />
  76 <p>ElementNamespaceClassLookup(self, fallback=None)</p>
  77 <p>Element class lookup scheme that searches the Element class in the
  78 Namespace registry.</p>
  79 <p>Usage:</p>
  80 <pre class="py-doctest">
  81 <span class="py-prompt">&gt;&gt;&gt; </span>lookup = ElementNamespaceClassLookup()
  82 <span class="py-prompt">&gt;&gt;&gt; </span>ns_elements = lookup.get_namespace(<span class="py-string">&quot;http://schema.org/Movie&quot;</span>)</pre>
  83 <pre class="py-doctest">
  84 <span class="py-prompt">&gt;&gt;&gt; </span>@ns_elements
  85 <span class="py-more">... </span><span class="py-keyword">class</span> <span class="py-defname">movie</span>(ElementBase):
  86 <span class="py-more">... </span>    <span class="py-string">&quot;Element implementation for 'movie' tag (using class name) in schema namespace.&quot;</span></pre>
  87 <pre class="py-doctest">
  88 <span class="py-prompt">&gt;&gt;&gt; </span>@ns_elements(<span class="py-string">&quot;movie&quot;</span>)
  89 <span class="py-more">... </span><span class="py-keyword">class</span> <span class="py-defname">MovieElement</span>(ElementBase):
  90 <span class="py-more">... </span>    <span class="py-string">&quot;Element implementation for 'movie' tag (explicit tag name) in schema namespace.&quot;</span></pre>
  91
  92 <!-- ==================== INSTANCE METHODS ==================== -->
  93 <a name="section-InstanceMethods"></a>
  94 <table class="summary" border="1" cellpadding="3"
  95        cellspacing="0" width="100%" bgcolor="white">
  96 <tr bgcolor="#70b0f0" class="table-header">
  97   <td colspan="2" class="table-header">
  98     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  99       <tr valign="top">
 100         <td align="left"><span class="table-header">Instance Methods</span></td>
 101         <td align="right" valign="top"
 102          ><span class="options">[<a href="#section-InstanceMethods"
 103          class="privatelink" onclick="toggle_private();"
 104          >hide private</a>]</span></td>
 105       </tr>
 106     </table>
 107   </td>
 108 </tr>
 109 <tr>
 110     <td width="15%" align="right" valign="top" class="summary">
 111       <span class="summary-type">&nbsp;</span>
 112     </td><td class="summary">
 113       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 114         <tr>
 115           <td><span class="summary-sig"><a href="lxml.etree.ElementNamespaceClassLookup-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 116         <span class="summary-sig-arg">fallback</span>=<span class="summary-sig-default">None</span>)</span><br />
 117       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 118           <td align="right" valign="top">
 119
 120
 121           </td>
 122         </tr>
 123       </table>
 124
 125     </td>
 126   </tr>
 127 <tr>
 128     <td width="15%" align="right" valign="top" class="summary">
 129       <span class="summary-type">a new object with type S, a subtype of T</span>
 130     </td><td class="summary">
 131       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 132         <tr>
 133           <td><span class="summary-sig"><a href="lxml.etree.ElementNamespaceClassLookup-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 134         <span class="summary-sig-arg">S</span>,
 135         <span class="summary-sig-arg">...</span>)</span></td>
 136           <td align="right" valign="top">
 137
 138
 139           </td>
 140         </tr>
 141       </table>
 142
 143     </td>
 144   </tr>
 145 <tr>
 146     <td width="15%" align="right" valign="top" class="summary">
 147       <span class="summary-type">&nbsp;</span>
 148     </td><td class="summary">
 149       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 150         <tr>
 151           <td><span class="summary-sig"><a href="lxml.etree.ElementNamespaceClassLookup-class.html#get_namespace" class="summary-sig-name">get_namespace</a>(<span class="summary-sig-arg">self</span>,
 152         <span class="summary-sig-arg">ns_uri</span>)</span><br />
 153       Retrieve the namespace object associated with the given URI.
 154 Pass None for the empty namespace.</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><a href="lxml.etree.FallbackElementClassLookup-class.html">FallbackElementClassLookup</a></code></b>:
 167       <code><a href="lxml.etree.FallbackElementClassLookup-class.html#set_fallback">set_fallback</a></code>
 168       </p>
 169     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 170       <code>__delattr__</code>,
 171       <code>__format__</code>,
 172       <code>__getattribute__</code>,
 173       <code>__hash__</code>,
 174       <code>__reduce__</code>,
 175       <code>__reduce_ex__</code>,
 176       <code>__repr__</code>,
 177       <code>__setattr__</code>,
 178       <code>__sizeof__</code>,
 179       <code>__str__</code>,
 180       <code>__subclasshook__</code>
 181       </p>
 182     </td>
 183   </tr>
 184 </table>
 185 <!-- ==================== PROPERTIES ==================== -->
 186 <a name="section-Properties"></a>
 187 <table class="summary" border="1" cellpadding="3"
 188        cellspacing="0" width="100%" bgcolor="white">
 189 <tr bgcolor="#70b0f0" class="table-header">
 190   <td colspan="2" class="table-header">
 191     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 192       <tr valign="top">
 193         <td align="left"><span class="table-header">Properties</span></td>
 194         <td align="right" valign="top"
 195          ><span class="options">[<a href="#section-Properties"
 196          class="privatelink" onclick="toggle_private();"
 197          >hide private</a>]</span></td>
 198       </tr>
 199     </table>
 200   </td>
 201 </tr>
 202   <tr>
 203     <td colspan="2" class="summary">
 204     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.FallbackElementClassLookup-class.html">FallbackElementClassLookup</a></code></b>:
 205       <code><a href="lxml.etree.FallbackElementClassLookup-class.html#fallback">fallback</a></code>
 206       </p>
 207     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 208       <code>__class__</code>
 209       </p>
 210     </td>
 211   </tr>
 212 </table>
 213 <!-- ==================== METHOD DETAILS ==================== -->
 214 <a name="section-MethodDetails"></a>
 215 <table class="details" border="1" cellpadding="3"
 216        cellspacing="0" width="100%" bgcolor="white">
 217 <tr bgcolor="#70b0f0" class="table-header">
 218   <td colspan="2" class="table-header">
 219     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 220       <tr valign="top">
 221         <td align="left"><span class="table-header">Method Details</span></td>
 222         <td align="right" valign="top"
 223          ><span class="options">[<a href="#section-MethodDetails"
 224          class="privatelink" onclick="toggle_private();"
 225          >hide private</a>]</span></td>
 226       </tr>
 227     </table>
 228   </td>
 229 </tr>
 230 </table>
 231 <a name="__init__"></a>
 232 <div>
 233 <table class="details" border="1" cellpadding="3"
 234        cellspacing="0" width="100%" bgcolor="white">
 235 <tr><td>
 236   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 237   <tr valign="top"><td>
 238   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 239         <span class="sig-arg">fallback</span>=<span class="sig-default">None</span>)</span>
 240     <br /><em class="fname">(Constructor)</em>
 241   </h3>
 242   </td><td align="right" valign="top"
 243     >&nbsp;
 244     </td>
 245   </tr></table>
 246
 247   x.__init__(...) initializes x; see help(type(x)) for signature
 248   <dl class="fields">
 249     <dt>Overrides:
 250         object.__init__
 251     </dt>
 252   </dl>
 253 </td></tr></table>
 254 </div>
 255 <a name="__new__"></a>
 256 <div>
 257 <table class="details" border="1" cellpadding="3"
 258        cellspacing="0" width="100%" bgcolor="white">
 259 <tr><td>
 260   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 261   <tr valign="top"><td>
 262   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 263         <span class="sig-arg">S</span>,
 264         <span class="sig-arg">...</span>)</span>
 265   </h3>
 266   </td><td align="right" valign="top"
 267     >&nbsp;
 268     </td>
 269   </tr></table>
 270
 271
 272   <dl class="fields">
 273     <dt>Returns: a new object with type S, a subtype of T</dt>
 274     <dt>Overrides:
 275         object.__new__
 276     </dt>
 277   </dl>
 278 </td></tr></table>
 279 </div>
 280 <a name="get_namespace"></a>
 281 <div>
 282 <table class="details" border="1" cellpadding="3"
 283        cellspacing="0" width="100%" bgcolor="white">
 284 <tr><td>
 285   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 286   <tr valign="top"><td>
 287   <h3 class="epydoc"><span class="sig"><span class="sig-name">get_namespace</span>(<span class="sig-arg">self</span>,
 288         <span class="sig-arg">ns_uri</span>)</span>
 289   </h3>
 290   </td><td align="right" valign="top"
 291     >&nbsp;
 292     </td>
 293   </tr></table>
 294
 295   <p>Retrieve the namespace object associated with the given URI.
 296 Pass None for the empty namespace.</p>
 297 <p>Creates a new namespace object if it does not yet exist.</p>
 298   <dl class="fields">
 299   </dl>
 300 </td></tr></table>
 301 </div>
 302 <br />
 303 <!-- ==================== NAVIGATION BAR ==================== -->
 304 <table class="navbar" border="0" width="100%" cellpadding="0"
 305        bgcolor="#a0c0ff" cellspacing="0">
 306   <tr valign="middle">
 307   <!-- Home link -->
 308       <th>&nbsp;&nbsp;&nbsp;<a
 309         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 310
 311   <!-- Tree link -->
 312       <th>&nbsp;&nbsp;&nbsp;<a
 313         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 314
 315   <!-- Index link -->
 316       <th>&nbsp;&nbsp;&nbsp;<a
 317         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 318
 319   <!-- Help link -->
 320       <th>&nbsp;&nbsp;&nbsp;<a
 321         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 322
 323   <!-- Project homepage -->
 324       <th class="navbar" align="right" width="100%">
 325         <table border="0" cellpadding="0" cellspacing="0">
 326           <tr><th class="navbar" align="center"
 327             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 328           </tr></table></th>
 329   </tr>
 330 </table>
 331 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 332   <tr>
 333     <td align="left" class="footer">
 334     Generated by Epydoc 3.0.1
 335     on Thu Jul  9 18:29:53 2020
 336     </td>
 337     <td align="right" class="footer">
 338       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 339         >http://epydoc.sourceforge.net</a>
 340     </td>
 341   </tr>
 342 </table>
 343
 344 <script type="text/javascript">
 345   <!--
 346   // Private objects are initially displayed (because if
 347   // javascript is turned off then we want them to be
 348   // visible); but by default, we want to hide them.  So hide
 349   // them unless we have a cookie that says to show them.
 350   checkCookie();
 351   // -->
 352 </script>
 353 </body>
 354 </html>