doc/html/api/lxml.etree.QName-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.QName</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;QName
  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.QName-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 QName</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">QName</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>QName(text_or_uri_or_element, tag=None)</p>
  73 <p>QName wrapper for qualified XML names.</p>
  74 <p>Pass a tag name by itself or a namespace URI and a tag name to
  75 create a qualified name.  Alternatively, pass an Element to
  76 extract its tag name.  <tt class="rst-docutils literal">None</tt> as first argument is ignored in
  77 order to allow for generic 2-argument usage.</p>
  78 <p>The <tt class="rst-docutils literal">text</tt> property holds the qualified name in
  79 <tt class="rst-docutils literal">{namespace}tagname</tt> notation.  The <tt class="rst-docutils literal">namespace</tt> and
  80 <tt class="rst-docutils literal">localname</tt> properties hold the respective parts of the tag
  81 name.</p>
  82 <p>You can pass QName objects wherever a tag name is expected.  Also,
  83 setting Element text from a QName will resolve the namespace prefix
  84 on assignment and set a qualified text value.  This is helpful in XML
  85 languages like SOAP or XML-Schema that use prefixed tag names in
  86 their text content.</p>
  87
  88 <!-- ==================== INSTANCE METHODS ==================== -->
  89 <a name="section-InstanceMethods"></a>
  90 <table class="summary" border="1" cellpadding="3"
  91        cellspacing="0" width="100%" bgcolor="white">
  92 <tr bgcolor="#70b0f0" class="table-header">
  93   <td colspan="2" class="table-header">
  94     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  95       <tr valign="top">
  96         <td align="left"><span class="table-header">Instance Methods</span></td>
  97         <td align="right" valign="top"
  98          ><span class="options">[<a href="#section-InstanceMethods"
  99          class="privatelink" onclick="toggle_private();"
 100          >hide private</a>]</span></td>
 101       </tr>
 102     </table>
 103   </td>
 104 </tr>
 105 <tr>
 106     <td width="15%" align="right" valign="top" class="summary">
 107       <span class="summary-type">&nbsp;</span>
 108     </td><td class="summary">
 109       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 110         <tr>
 111           <td><span class="summary-sig"><a name="__eq__"></a><span class="summary-sig-name">__eq__</span>(<span class="summary-sig-arg">x</span>,
 112         <span class="summary-sig-arg">y</span>)</span><br />
 113       x==y</td>
 114           <td align="right" valign="top">
 115
 116
 117           </td>
 118         </tr>
 119       </table>
 120
 121     </td>
 122   </tr>
 123 <tr>
 124     <td width="15%" align="right" valign="top" class="summary">
 125       <span class="summary-type">&nbsp;</span>
 126     </td><td class="summary">
 127       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 128         <tr>
 129           <td><span class="summary-sig"><a name="__ge__"></a><span class="summary-sig-name">__ge__</span>(<span class="summary-sig-arg">x</span>,
 130         <span class="summary-sig-arg">y</span>)</span><br />
 131       x&gt;=y</td>
 132           <td align="right" valign="top">
 133
 134
 135           </td>
 136         </tr>
 137       </table>
 138
 139     </td>
 140   </tr>
 141 <tr>
 142     <td width="15%" align="right" valign="top" class="summary">
 143       <span class="summary-type">&nbsp;</span>
 144     </td><td class="summary">
 145       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 146         <tr>
 147           <td><span class="summary-sig"><a name="__gt__"></a><span class="summary-sig-name">__gt__</span>(<span class="summary-sig-arg">x</span>,
 148         <span class="summary-sig-arg">y</span>)</span><br />
 149       x&gt;y</td>
 150           <td align="right" valign="top">
 151
 152
 153           </td>
 154         </tr>
 155       </table>
 156
 157     </td>
 158   </tr>
 159 <tr>
 160     <td width="15%" align="right" valign="top" class="summary">
 161       <span class="summary-type">&nbsp;</span>
 162     </td><td class="summary">
 163       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 164         <tr>
 165           <td><span class="summary-sig"><a href="lxml.etree.QName-class.html#__hash__" class="summary-sig-name">__hash__</a>(<span class="summary-sig-arg">x</span>)</span><br />
 166       hash(x)</td>
 167           <td align="right" valign="top">
 168
 169
 170           </td>
 171         </tr>
 172       </table>
 173
 174     </td>
 175   </tr>
 176 <tr>
 177     <td width="15%" align="right" valign="top" class="summary">
 178       <span class="summary-type">&nbsp;</span>
 179     </td><td class="summary">
 180       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 181         <tr>
 182           <td><span class="summary-sig"><a href="lxml.etree.QName-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">text_or_uri_or_element</span>,
 183         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span><br />
 184       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 185           <td align="right" valign="top">
 186
 187
 188           </td>
 189         </tr>
 190       </table>
 191
 192     </td>
 193   </tr>
 194 <tr>
 195     <td width="15%" align="right" valign="top" class="summary">
 196       <span class="summary-type">&nbsp;</span>
 197     </td><td class="summary">
 198       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 199         <tr>
 200           <td><span class="summary-sig"><a name="__le__"></a><span class="summary-sig-name">__le__</span>(<span class="summary-sig-arg">x</span>,
 201         <span class="summary-sig-arg">y</span>)</span><br />
 202       x&lt;=y</td>
 203           <td align="right" valign="top">
 204
 205
 206           </td>
 207         </tr>
 208       </table>
 209
 210     </td>
 211   </tr>
 212 <tr>
 213     <td width="15%" align="right" valign="top" class="summary">
 214       <span class="summary-type">&nbsp;</span>
 215     </td><td class="summary">
 216       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 217         <tr>
 218           <td><span class="summary-sig"><a name="__lt__"></a><span class="summary-sig-name">__lt__</span>(<span class="summary-sig-arg">x</span>,
 219         <span class="summary-sig-arg">y</span>)</span><br />
 220       x&lt;y</td>
 221           <td align="right" valign="top">
 222
 223
 224           </td>
 225         </tr>
 226       </table>
 227
 228     </td>
 229   </tr>
 230 <tr>
 231     <td width="15%" align="right" valign="top" class="summary">
 232       <span class="summary-type">&nbsp;</span>
 233     </td><td class="summary">
 234       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 235         <tr>
 236           <td><span class="summary-sig"><a name="__ne__"></a><span class="summary-sig-name">__ne__</span>(<span class="summary-sig-arg">x</span>,
 237         <span class="summary-sig-arg">y</span>)</span><br />
 238       x!=y</td>
 239           <td align="right" valign="top">
 240
 241
 242           </td>
 243         </tr>
 244       </table>
 245
 246     </td>
 247   </tr>
 248 <tr>
 249     <td width="15%" align="right" valign="top" class="summary">
 250       <span class="summary-type">a new object with type S, a subtype of T</span>
 251     </td><td class="summary">
 252       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 253         <tr>
 254           <td><span class="summary-sig"><a href="lxml.etree.QName-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 255         <span class="summary-sig-arg">S</span>,
 256         <span class="summary-sig-arg">...</span>)</span></td>
 257           <td align="right" valign="top">
 258
 259
 260           </td>
 261         </tr>
 262       </table>
 263
 264     </td>
 265   </tr>
 266 <tr>
 267     <td width="15%" align="right" valign="top" class="summary">
 268       <span class="summary-type">&nbsp;</span>
 269     </td><td class="summary">
 270       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 271         <tr>
 272           <td><span class="summary-sig"><a href="lxml.etree.QName-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">x</span>)</span><br />
 273       str(x)</td>
 274           <td align="right" valign="top">
 275
 276
 277           </td>
 278         </tr>
 279       </table>
 280
 281     </td>
 282   </tr>
 283   <tr>
 284     <td colspan="2" class="summary">
 285     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 286       <code>__delattr__</code>,
 287       <code>__format__</code>,
 288       <code>__getattribute__</code>,
 289       <code>__reduce__</code>,
 290       <code>__reduce_ex__</code>,
 291       <code>__repr__</code>,
 292       <code>__setattr__</code>,
 293       <code>__sizeof__</code>,
 294       <code>__subclasshook__</code>
 295       </p>
 296     </td>
 297   </tr>
 298 </table>
 299 <!-- ==================== PROPERTIES ==================== -->
 300 <a name="section-Properties"></a>
 301 <table class="summary" border="1" cellpadding="3"
 302        cellspacing="0" width="100%" bgcolor="white">
 303 <tr bgcolor="#70b0f0" class="table-header">
 304   <td colspan="2" class="table-header">
 305     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 306       <tr valign="top">
 307         <td align="left"><span class="table-header">Properties</span></td>
 308         <td align="right" valign="top"
 309          ><span class="options">[<a href="#section-Properties"
 310          class="privatelink" onclick="toggle_private();"
 311          >hide private</a>]</span></td>
 312       </tr>
 313     </table>
 314   </td>
 315 </tr>
 316 <tr>
 317     <td width="15%" align="right" valign="top" class="summary">
 318       <span class="summary-type">&nbsp;</span>
 319     </td><td class="summary">
 320         <a name="localname"></a><span class="summary-name">localname</span>
 321     </td>
 322   </tr>
 323 <tr>
 324     <td width="15%" align="right" valign="top" class="summary">
 325       <span class="summary-type">&nbsp;</span>
 326     </td><td class="summary">
 327         <a name="namespace"></a><span class="summary-name">namespace</span>
 328     </td>
 329   </tr>
 330 <tr>
 331     <td width="15%" align="right" valign="top" class="summary">
 332       <span class="summary-type">&nbsp;</span>
 333     </td><td class="summary">
 334         <a name="text"></a><span class="summary-name">text</span>
 335     </td>
 336   </tr>
 337   <tr>
 338     <td colspan="2" class="summary">
 339     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 340       <code>__class__</code>
 341       </p>
 342     </td>
 343   </tr>
 344 </table>
 345 <!-- ==================== METHOD DETAILS ==================== -->
 346 <a name="section-MethodDetails"></a>
 347 <table class="details" border="1" cellpadding="3"
 348        cellspacing="0" width="100%" bgcolor="white">
 349 <tr bgcolor="#70b0f0" class="table-header">
 350   <td colspan="2" class="table-header">
 351     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 352       <tr valign="top">
 353         <td align="left"><span class="table-header">Method Details</span></td>
 354         <td align="right" valign="top"
 355          ><span class="options">[<a href="#section-MethodDetails"
 356          class="privatelink" onclick="toggle_private();"
 357          >hide private</a>]</span></td>
 358       </tr>
 359     </table>
 360   </td>
 361 </tr>
 362 </table>
 363 <a name="__hash__"></a>
 364 <div>
 365 <table class="details" border="1" cellpadding="3"
 366        cellspacing="0" width="100%" bgcolor="white">
 367 <tr><td>
 368   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 369   <tr valign="top"><td>
 370   <h3 class="epydoc"><span class="sig"><span class="sig-name">__hash__</span>(<span class="sig-arg">x</span>)</span>
 371     <br /><em class="fname">(Hashing function)</em>
 372   </h3>
 373   </td><td align="right" valign="top"
 374     >&nbsp;
 375     </td>
 376   </tr></table>
 377
 378   hash(x)
 379   <dl class="fields">
 380     <dt>Overrides:
 381         object.__hash__
 382     </dt>
 383   </dl>
 384 </td></tr></table>
 385 </div>
 386 <a name="__init__"></a>
 387 <div>
 388 <table class="details" border="1" cellpadding="3"
 389        cellspacing="0" width="100%" bgcolor="white">
 390 <tr><td>
 391   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 392   <tr valign="top"><td>
 393   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">text_or_uri_or_element</span>,
 394         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>)</span>
 395     <br /><em class="fname">(Constructor)</em>
 396   </h3>
 397   </td><td align="right" valign="top"
 398     >&nbsp;
 399     </td>
 400   </tr></table>
 401
 402   x.__init__(...) initializes x; see help(type(x)) for signature
 403   <dl class="fields">
 404     <dt>Overrides:
 405         object.__init__
 406     </dt>
 407   </dl>
 408 </td></tr></table>
 409 </div>
 410 <a name="__new__"></a>
 411 <div>
 412 <table class="details" border="1" cellpadding="3"
 413        cellspacing="0" width="100%" bgcolor="white">
 414 <tr><td>
 415   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 416   <tr valign="top"><td>
 417   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 418         <span class="sig-arg">S</span>,
 419         <span class="sig-arg">...</span>)</span>
 420   </h3>
 421   </td><td align="right" valign="top"
 422     >&nbsp;
 423     </td>
 424   </tr></table>
 425
 426
 427   <dl class="fields">
 428     <dt>Returns: a new object with type S, a subtype of T</dt>
 429     <dt>Overrides:
 430         object.__new__
 431     </dt>
 432   </dl>
 433 </td></tr></table>
 434 </div>
 435 <a name="__str__"></a>
 436 <div>
 437 <table class="details" border="1" cellpadding="3"
 438        cellspacing="0" width="100%" bgcolor="white">
 439 <tr><td>
 440   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 441   <tr valign="top"><td>
 442   <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>
 443     <br /><em class="fname">(Informal representation operator)</em>
 444   </h3>
 445   </td><td align="right" valign="top"
 446     >&nbsp;
 447     </td>
 448   </tr></table>
 449
 450   str(x)
 451   <dl class="fields">
 452     <dt>Overrides:
 453         object.__str__
 454     </dt>
 455   </dl>
 456 </td></tr></table>
 457 </div>
 458 <br />
 459 <!-- ==================== NAVIGATION BAR ==================== -->
 460 <table class="navbar" border="0" width="100%" cellpadding="0"
 461        bgcolor="#a0c0ff" cellspacing="0">
 462   <tr valign="middle">
 463   <!-- Home link -->
 464       <th>&nbsp;&nbsp;&nbsp;<a
 465         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 466
 467   <!-- Tree link -->
 468       <th>&nbsp;&nbsp;&nbsp;<a
 469         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 470
 471   <!-- Index link -->
 472       <th>&nbsp;&nbsp;&nbsp;<a
 473         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 474
 475   <!-- Help link -->
 476       <th>&nbsp;&nbsp;&nbsp;<a
 477         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 478
 479   <!-- Project homepage -->
 480       <th class="navbar" align="right" width="100%">
 481         <table border="0" cellpadding="0" cellspacing="0">
 482           <tr><th class="navbar" align="center"
 483             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 484           </tr></table></th>
 485   </tr>
 486 </table>
 487 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 488   <tr>
 489     <td align="left" class="footer">
 490     Generated by Epydoc 3.0.1
 491     on Wed Jan 29 12:26:21 2020
 492     </td>
 493     <td align="right" class="footer">
 494       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 495         >http://epydoc.sourceforge.net</a>
 496     </td>
 497   </tr>
 498 </table>
 499
 500 <script type="text/javascript">
 501   <!--
 502   // Private objects are initially displayed (because if
 503   // javascript is turned off then we want them to be
 504   // visible); but by default, we want to hide them.  So hide
 505   // them unless we have a cookie that says to show them.
 506   checkCookie();
 507   // -->
 508 </script>
 509 </body>
 510 </html>