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