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">
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
18 <th> <a
19 href="lxml-module.html">Home</a> </th>
22 <th> <a
23 href="module-tree.html">Trees</a> </th>
26 <th> <a
27 href="identifier-index.html">Indices</a> </th>
30 <th> <a
31 href="help.html">Help</a> </th>
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>
41 <table width="100%" cellpadding="0" cellspacing="0">
44 <span class="breadcrumbs">
50 <table cellpadding="0" cellspacing="0">
51 <!-- hide/show private -->
52 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
53 onclick="toggle_private();">hide private</a>]</span></td></tr>
54 <tr><td align="right"><span class="options"
55 >[<a href="frames.html" target="_top">frames</a
56 >] | <a href="str-class.html"
57 target="_top">no frames</a>]</span></td></tr>
62 <!-- ==================== CLASS DESCRIPTION ==================== -->
63 <h1 class="epydoc">Class str</h1><p class="nomargin-top"></p>
64 <pre class="base-tree">
69 <strong class="uidshort">str</strong>
72 <dl><dt>Known Subclasses:</dt>
74 <ul class="subclass-list">
75 <li class="private"><a href="lxml.etree._ElementStringResult-class.html" onclick="show_private();">lxml.etree._ElementStringResult</a></li><li>, <a href="lxml.html.diff.token-class.html">lxml.html.diff.token</a></li> </ul>
79 <p>str(object='') -> string</p>
80 <p>Return a nice string representation of the object.
81 If the argument is a string, the return value is the same object.</p>
83 <!-- ==================== INSTANCE METHODS ==================== -->
84 <a name="section-InstanceMethods"></a>
85 <table class="summary" border="1" cellpadding="3"
86 cellspacing="0" width="100%" bgcolor="white">
87 <tr bgcolor="#70b0f0" class="table-header">
88 <td colspan="2" class="table-header">
89 <table border="0" cellpadding="0" cellspacing="0" width="100%">
91 <td align="left"><span class="table-header">Instance Methods</span></td>
92 <td align="right" valign="top"
93 ><span class="options">[<a href="#section-InstanceMethods"
94 class="privatelink" onclick="toggle_private();"
95 >hide private</a>]</span></td>
101 <td width="15%" align="right" valign="top" class="summary">
102 <span class="summary-type"> </span>
103 </td><td class="summary">
104 <table width="100%" cellpadding="0" cellspacing="0" border="0">
106 <td><span class="summary-sig"><a name="__add__"></a><span class="summary-sig-name">__add__</span>(<span class="summary-sig-arg">x</span>,
107 <span class="summary-sig-arg">y</span>)</span><br />
109 <td align="right" valign="top">
119 <td width="15%" align="right" valign="top" class="summary">
120 <span class="summary-type"> </span>
121 </td><td class="summary">
122 <table width="100%" cellpadding="0" cellspacing="0" border="0">
124 <td><span class="summary-sig"><a name="__contains__"></a><span class="summary-sig-name">__contains__</span>(<span class="summary-sig-arg">x</span>,
125 <span class="summary-sig-arg">y</span>)</span><br />
127 <td align="right" valign="top">
137 <td width="15%" align="right" valign="top" class="summary">
138 <span class="summary-type"> </span>
139 </td><td class="summary">
140 <table width="100%" cellpadding="0" cellspacing="0" border="0">
142 <td><span class="summary-sig"><a name="__eq__"></a><span class="summary-sig-name">__eq__</span>(<span class="summary-sig-arg">x</span>,
143 <span class="summary-sig-arg">y</span>)</span><br />
145 <td align="right" valign="top">
155 <td width="15%" align="right" valign="top" class="summary">
156 <span class="summary-type">string</span>
157 </td><td class="summary">
158 <table width="100%" cellpadding="0" cellspacing="0" border="0">
160 <td><span class="summary-sig"><a href="str-class.html#__format__" class="summary-sig-name">__format__</a>(<span class="summary-sig-arg">S</span>,
161 <span class="summary-sig-arg">format_spec</span>)</span><br />
162 Return a formatted version of S as described by format_spec.</td>
163 <td align="right" valign="top">
173 <td width="15%" align="right" valign="top" class="summary">
174 <span class="summary-type"> </span>
175 </td><td class="summary">
176 <table width="100%" cellpadding="0" cellspacing="0" border="0">
178 <td><span class="summary-sig"><a name="__ge__"></a><span class="summary-sig-name">__ge__</span>(<span class="summary-sig-arg">x</span>,
179 <span class="summary-sig-arg">y</span>)</span><br />
181 <td align="right" valign="top">
191 <td width="15%" align="right" valign="top" class="summary">
192 <span class="summary-type"> </span>
193 </td><td class="summary">
194 <table width="100%" cellpadding="0" cellspacing="0" border="0">
196 <td><span class="summary-sig"><a href="str-class.html#__getattribute__" class="summary-sig-name">__getattribute__</a>(<span class="summary-sig-arg">...</span>)</span><br />
197 x.__getattribute__('name') <==> x.name</td>
198 <td align="right" valign="top">
208 <td width="15%" align="right" valign="top" class="summary">
209 <span class="summary-type"> </span>
210 </td><td class="summary">
211 <table width="100%" cellpadding="0" cellspacing="0" border="0">
213 <td><span class="summary-sig"><a name="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">x</span>,
214 <span class="summary-sig-arg">y</span>)</span><br />
216 <td align="right" valign="top">
226 <td width="15%" align="right" valign="top" class="summary">
227 <span class="summary-type"> </span>
228 </td><td class="summary">
229 <table width="100%" cellpadding="0" cellspacing="0" border="0">
231 <td><span class="summary-sig"><a name="__getnewargs__"></a><span class="summary-sig-name">__getnewargs__</span>(<span class="summary-sig-arg">...</span>)</span></td>
232 <td align="right" valign="top">
242 <td width="15%" align="right" valign="top" class="summary">
243 <span class="summary-type"> </span>
244 </td><td class="summary">
245 <table width="100%" cellpadding="0" cellspacing="0" border="0">
247 <td><span class="summary-sig"><a href="str-class.html#__getslice__" class="summary-sig-name">__getslice__</a>(<span class="summary-sig-arg">x</span>,
248 <span class="summary-sig-arg">i</span>,
249 <span class="summary-sig-arg">j</span>)</span><br />
251 <td align="right" valign="top">
261 <td width="15%" align="right" valign="top" class="summary">
262 <span class="summary-type"> </span>
263 </td><td class="summary">
264 <table width="100%" cellpadding="0" cellspacing="0" border="0">
266 <td><span class="summary-sig"><a name="__gt__"></a><span class="summary-sig-name">__gt__</span>(<span class="summary-sig-arg">x</span>,
267 <span class="summary-sig-arg">y</span>)</span><br />
269 <td align="right" valign="top">
279 <td width="15%" align="right" valign="top" class="summary">
280 <span class="summary-type"> </span>
281 </td><td class="summary">
282 <table width="100%" cellpadding="0" cellspacing="0" border="0">
284 <td><span class="summary-sig"><a href="str-class.html#__hash__" class="summary-sig-name">__hash__</a>(<span class="summary-sig-arg">x</span>)</span><br />
286 <td align="right" valign="top">
296 <td width="15%" align="right" valign="top" class="summary">
297 <span class="summary-type"> </span>
298 </td><td class="summary">
299 <table width="100%" cellpadding="0" cellspacing="0" border="0">
301 <td><span class="summary-sig"><a name="__le__"></a><span class="summary-sig-name">__le__</span>(<span class="summary-sig-arg">x</span>,
302 <span class="summary-sig-arg">y</span>)</span><br />
304 <td align="right" valign="top">
314 <td width="15%" align="right" valign="top" class="summary">
315 <span class="summary-type"> </span>
316 </td><td class="summary">
317 <table width="100%" cellpadding="0" cellspacing="0" border="0">
319 <td><span class="summary-sig"><a name="__len__"></a><span class="summary-sig-name">__len__</span>(<span class="summary-sig-arg">x</span>)</span><br />
321 <td align="right" valign="top">
331 <td width="15%" align="right" valign="top" class="summary">
332 <span class="summary-type"> </span>
333 </td><td class="summary">
334 <table width="100%" cellpadding="0" cellspacing="0" border="0">
336 <td><span class="summary-sig"><a name="__lt__"></a><span class="summary-sig-name">__lt__</span>(<span class="summary-sig-arg">x</span>,
337 <span class="summary-sig-arg">y</span>)</span><br />
339 <td align="right" valign="top">
349 <td width="15%" align="right" valign="top" class="summary">
350 <span class="summary-type"> </span>
351 </td><td class="summary">
352 <table width="100%" cellpadding="0" cellspacing="0" border="0">
354 <td><span class="summary-sig"><a name="__mod__"></a><span class="summary-sig-name">__mod__</span>(<span class="summary-sig-arg">x</span>,
355 <span class="summary-sig-arg">y</span>)</span><br />
357 <td align="right" valign="top">
367 <td width="15%" align="right" valign="top" class="summary">
368 <span class="summary-type"> </span>
369 </td><td class="summary">
370 <table width="100%" cellpadding="0" cellspacing="0" border="0">
372 <td><span class="summary-sig"><a name="__mul__"></a><span class="summary-sig-name">__mul__</span>(<span class="summary-sig-arg">x</span>,
373 <span class="summary-sig-arg">n</span>)</span><br />
375 <td align="right" valign="top">
385 <td width="15%" align="right" valign="top" class="summary">
386 <span class="summary-type"> </span>
387 </td><td class="summary">
388 <table width="100%" cellpadding="0" cellspacing="0" border="0">
390 <td><span class="summary-sig"><a name="__ne__"></a><span class="summary-sig-name">__ne__</span>(<span class="summary-sig-arg">x</span>,
391 <span class="summary-sig-arg">y</span>)</span><br />
393 <td align="right" valign="top">
403 <td width="15%" align="right" valign="top" class="summary">
404 <span class="summary-type">a new object with type S, a subtype of T</span>
405 </td><td class="summary">
406 <table width="100%" cellpadding="0" cellspacing="0" border="0">
408 <td><span class="summary-sig"><a href="str-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
409 <span class="summary-sig-arg">S</span>,
410 <span class="summary-sig-arg">...</span>)</span></td>
411 <td align="right" valign="top">
421 <td width="15%" align="right" valign="top" class="summary">
422 <span class="summary-type"> </span>
423 </td><td class="summary">
424 <table width="100%" cellpadding="0" cellspacing="0" border="0">
426 <td><span class="summary-sig"><a href="str-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">x</span>)</span><br />
428 <td align="right" valign="top">
438 <td width="15%" align="right" valign="top" class="summary">
439 <span class="summary-type"> </span>
440 </td><td class="summary">
441 <table width="100%" cellpadding="0" cellspacing="0" border="0">
443 <td><span class="summary-sig"><a name="__rmod__"></a><span class="summary-sig-name">__rmod__</span>(<span class="summary-sig-arg">x</span>,
444 <span class="summary-sig-arg">y</span>)</span><br />
446 <td align="right" valign="top">
456 <td width="15%" align="right" valign="top" class="summary">
457 <span class="summary-type"> </span>
458 </td><td class="summary">
459 <table width="100%" cellpadding="0" cellspacing="0" border="0">
461 <td><span class="summary-sig"><a name="__rmul__"></a><span class="summary-sig-name">__rmul__</span>(<span class="summary-sig-arg">x</span>,
462 <span class="summary-sig-arg">n</span>)</span><br />
464 <td align="right" valign="top">
474 <td width="15%" align="right" valign="top" class="summary">
475 <span class="summary-type">size of S in memory, in bytes</span>
476 </td><td class="summary">
477 <table width="100%" cellpadding="0" cellspacing="0" border="0">
479 <td><span class="summary-sig"><a href="str-class.html#__sizeof__" class="summary-sig-name">__sizeof__</a>(<span class="summary-sig-arg">S</span>)</span><br />
480 size of object in memory, in bytes</td>
481 <td align="right" valign="top">
491 <td width="15%" align="right" valign="top" class="summary">
492 <span class="summary-type"> </span>
493 </td><td class="summary">
494 <table width="100%" cellpadding="0" cellspacing="0" border="0">
496 <td><span class="summary-sig"><a href="str-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">x</span>)</span><br />
498 <td align="right" valign="top">
508 <td width="15%" align="right" valign="top" class="summary">
509 <span class="summary-type"> </span>
510 </td><td class="summary">
511 <table width="100%" cellpadding="0" cellspacing="0" border="0">
513 <td><span class="summary-sig"><a name="_formatter_field_name_split"></a><span class="summary-sig-name">_formatter_field_name_split</span>(<span class="summary-sig-arg">...</span>)</span></td>
514 <td align="right" valign="top">
524 <td width="15%" align="right" valign="top" class="summary">
525 <span class="summary-type"> </span>
526 </td><td class="summary">
527 <table width="100%" cellpadding="0" cellspacing="0" border="0">
529 <td><span class="summary-sig"><a name="_formatter_parser"></a><span class="summary-sig-name">_formatter_parser</span>(<span class="summary-sig-arg">...</span>)</span></td>
530 <td align="right" valign="top">
540 <td width="15%" align="right" valign="top" class="summary">
541 <span class="summary-type">string</span>
542 </td><td class="summary">
543 <table width="100%" cellpadding="0" cellspacing="0" border="0">
545 <td><span class="summary-sig"><a name="capitalize"></a><span class="summary-sig-name">capitalize</span>(<span class="summary-sig-arg">S</span>)</span><br />
546 Return a copy of the string S with only its first character
548 <td align="right" valign="top">
558 <td width="15%" align="right" valign="top" class="summary">
559 <span class="summary-type">string</span>
560 </td><td class="summary">
561 <table width="100%" cellpadding="0" cellspacing="0" border="0">
563 <td><span class="summary-sig"><a name="center"></a><span class="summary-sig-name">center</span>(<span class="summary-sig-arg">S</span>,
564 <span class="summary-sig-arg">width</span>,
565 <span class="summary-sig-arg">fillchar</span>=<span class="summary-sig-default">...</span>)</span><br />
566 Return S centered in a string of length width. Padding is
567 done using the specified fill character (default is a space)</td>
568 <td align="right" valign="top">
578 <td width="15%" align="right" valign="top" class="summary">
579 <span class="summary-type">int</span>
580 </td><td class="summary">
581 <table width="100%" cellpadding="0" cellspacing="0" border="0">
583 <td><span class="summary-sig"><a name="count"></a><span class="summary-sig-name">count</span>(<span class="summary-sig-arg">S</span>,
584 <span class="summary-sig-arg">sub</span>,
585 <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">...</span>,
586 <span class="summary-sig-arg">end</span>=<span class="summary-sig-default">...</span>)</span><br />
587 Return the number of non-overlapping occurrences of substring sub in
588 string S[start:end]. Optional arguments start and end are interpreted
589 as in slice notation.</td>
590 <td align="right" valign="top">
600 <td width="15%" align="right" valign="top" class="summary">
601 <span class="summary-type">object</span>
602 </td><td class="summary">
603 <table width="100%" cellpadding="0" cellspacing="0" border="0">
605 <td><span class="summary-sig"><a name="decode"></a><span class="summary-sig-name">decode</span>(<span class="summary-sig-arg">S</span>,
606 <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">...</span>,
607 <span class="summary-sig-arg">errors</span>=<span class="summary-sig-default">...</span>)</span><br />
608 Decodes S using the codec registered for encoding. encoding defaults
609 to the default encoding. errors may be given to set a different error
610 handling scheme. Default is 'strict' meaning that encoding errors raise
611 a UnicodeDecodeError. Other possible values are 'ignore' and 'replace'
612 as well as any other name registered with codecs.register_error that is
613 able to handle UnicodeDecodeErrors.</td>
614 <td align="right" valign="top">
624 <td width="15%" align="right" valign="top" class="summary">
625 <span class="summary-type">object</span>
626 </td><td class="summary">
627 <table width="100%" cellpadding="0" cellspacing="0" border="0">
629 <td><span class="summary-sig"><a name="encode"></a><span class="summary-sig-name">encode</span>(<span class="summary-sig-arg">S</span>,
630 <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">...</span>,
631 <span class="summary-sig-arg">errors</span>=<span class="summary-sig-default">...</span>)</span><br />
632 Encodes S using the codec registered for encoding. encoding defaults
633 to the default encoding. errors may be given to set a different error
634 handling scheme. Default is 'strict' meaning that encoding errors raise
635 a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
636 'xmlcharrefreplace' as well as any other name registered with
637 codecs.register_error that is able to handle UnicodeEncodeErrors.</td>
638 <td align="right" valign="top">
648 <td width="15%" align="right" valign="top" class="summary">
649 <span class="summary-type">bool</span>
650 </td><td class="summary">
651 <table width="100%" cellpadding="0" cellspacing="0" border="0">
653 <td><span class="summary-sig"><a name="endswith"></a><span class="summary-sig-name">endswith</span>(<span class="summary-sig-arg">S</span>,
654 <span class="summary-sig-arg">suffix</span>,
655 <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">...</span>,
656 <span class="summary-sig-arg">end</span>=<span class="summary-sig-default">...</span>)</span><br />
657 Return True if S ends with the specified suffix, False otherwise.
658 With optional start, test S beginning at that position.
659 With optional end, stop comparing S at that position.
660 suffix can also be a tuple of strings to try.</td>
661 <td align="right" valign="top">
671 <td width="15%" align="right" valign="top" class="summary">
672 <span class="summary-type">string</span>
673 </td><td class="summary">
674 <table width="100%" cellpadding="0" cellspacing="0" border="0">
676 <td><span class="summary-sig"><a name="expandtabs"></a><span class="summary-sig-name">expandtabs</span>(<span class="summary-sig-arg">S</span>,
677 <span class="summary-sig-arg">tabsize</span>=<span class="summary-sig-default">...</span>)</span><br />
678 Return a copy of S where all tab characters are expanded using spaces.
679 If tabsize is not given, a tab size of 8 characters is assumed.</td>
680 <td align="right" valign="top">
690 <td width="15%" align="right" valign="top" class="summary">
691 <span class="summary-type">int</span>
692 </td><td class="summary">
693 <table width="100%" cellpadding="0" cellspacing="0" border="0">
695 <td><span class="summary-sig"><a href="str-class.html#find" class="summary-sig-name">find</a>(<span class="summary-sig-arg">S</span>,
696 <span class="summary-sig-arg">sub</span>,
697 <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">... </span>,
698 <span class="summary-sig-arg">end</span>=<span class="summary-sig-default">...</span>)</span><br />
699 Return the lowest index in S where substring sub is found,
700 such that sub is contained within S[start:end]. Optional
701 arguments start and end are interpreted as in slice notation.</td>
702 <td align="right" valign="top">
712 <td width="15%" align="right" valign="top" class="summary">
713 <span class="summary-type">string</span>
714 </td><td class="summary">
715 <table width="100%" cellpadding="0" cellspacing="0" border="0">
717 <td><span class="summary-sig"><a name="format"></a><span class="summary-sig-name">format</span>(<span class="summary-sig-arg">S</span>,
718 <span class="summary-sig-arg">*args</span>,
719 <span class="summary-sig-arg">**kwargs</span>)</span><br />
720 Return a formatted version of S, using substitutions from args and kwargs.
721 The substitutions are identified by braces ('{' and '}').</td>
722 <td align="right" valign="top">
732 <td width="15%" align="right" valign="top" class="summary">
733 <span class="summary-type">int</span>
734 </td><td class="summary">
735 <table width="100%" cellpadding="0" cellspacing="0" border="0">
737 <td><span class="summary-sig"><a name="index"></a><span class="summary-sig-name">index</span>(<span class="summary-sig-arg">S</span>,
738 <span class="summary-sig-arg">sub</span>,
739 <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">... </span>,
740 <span class="summary-sig-arg">end</span>=<span class="summary-sig-default">...</span>)</span><br />
741 Like S.find() but raise ValueError when the substring is not found.</td>
742 <td align="right" valign="top">
752 <td width="15%" align="right" valign="top" class="summary">
753 <span class="summary-type">bool</span>
754 </td><td class="summary">
755 <table width="100%" cellpadding="0" cellspacing="0" border="0">
757 <td><span class="summary-sig"><a name="isalnum"></a><span class="summary-sig-name">isalnum</span>(<span class="summary-sig-arg">S</span>)</span><br />
758 Return True if all characters in S are alphanumeric
759 and there is at least one character in S, False otherwise.</td>
760 <td align="right" valign="top">
770 <td width="15%" align="right" valign="top" class="summary">
771 <span class="summary-type">bool</span>
772 </td><td class="summary">
773 <table width="100%" cellpadding="0" cellspacing="0" border="0">
775 <td><span class="summary-sig"><a name="isalpha"></a><span class="summary-sig-name">isalpha</span>(<span class="summary-sig-arg">S</span>)</span><br />
776 Return True if all characters in S are alphabetic
777 and there is at least one character in S, False otherwise.</td>
778 <td align="right" valign="top">
788 <td width="15%" align="right" valign="top" class="summary">
789 <span class="summary-type">bool</span>
790 </td><td class="summary">
791 <table width="100%" cellpadding="0" cellspacing="0" border="0">
793 <td><span class="summary-sig"><a name="isdigit"></a><span class="summary-sig-name">isdigit</span>(<span class="summary-sig-arg">S</span>)</span><br />
794 Return True if all characters in S are digits
795 and there is at least one character in S, False otherwise.</td>
796 <td align="right" valign="top">
806 <td width="15%" align="right" valign="top" class="summary">
807 <span class="summary-type">bool</span>
808 </td><td class="summary">
809 <table width="100%" cellpadding="0" cellspacing="0" border="0">
811 <td><span class="summary-sig"><a name="islower"></a><span class="summary-sig-name">islower</span>(<span class="summary-sig-arg">S</span>)</span><br />
812 Return True if all cased characters in S are lowercase and there is
813 at least one cased character in S, False otherwise.</td>
814 <td align="right" valign="top">
824 <td width="15%" align="right" valign="top" class="summary">
825 <span class="summary-type">bool</span>
826 </td><td class="summary">
827 <table width="100%" cellpadding="0" cellspacing="0" border="0">
829 <td><span class="summary-sig"><a name="isspace"></a><span class="summary-sig-name">isspace</span>(<span class="summary-sig-arg">S</span>)</span><br />
830 Return True if all characters in S are whitespace
831 and there is at least one character in S, False otherwise.</td>
832 <td align="right" valign="top">
842 <td width="15%" align="right" valign="top" class="summary">
843 <span class="summary-type">bool</span>
844 </td><td class="summary">
845 <table width="100%" cellpadding="0" cellspacing="0" border="0">
847 <td><span class="summary-sig"><a name="istitle"></a><span class="summary-sig-name">istitle</span>(<span class="summary-sig-arg">S</span>)</span><br />
848 Return True if S is a titlecased string and there is at least one
849 character in S, i.e. uppercase characters may only follow uncased
850 characters and lowercase characters only cased ones. Return False
852 <td align="right" valign="top">
862 <td width="15%" align="right" valign="top" class="summary">
863 <span class="summary-type">bool</span>
864 </td><td class="summary">
865 <table width="100%" cellpadding="0" cellspacing="0" border="0">
867 <td><span class="summary-sig"><a name="isupper"></a><span class="summary-sig-name">isupper</span>(<span class="summary-sig-arg">S</span>)</span><br />
868 Return True if all cased characters in S are uppercase and there is
869 at least one cased character in S, False otherwise.</td>
870 <td align="right" valign="top">
880 <td width="15%" align="right" valign="top" class="summary">
881 <span class="summary-type">string</span>
882 </td><td class="summary">
883 <table width="100%" cellpadding="0" cellspacing="0" border="0">
885 <td><span class="summary-sig"><a name="join"></a><span class="summary-sig-name">join</span>(<span class="summary-sig-arg">S</span>,
886 <span class="summary-sig-arg">iterable</span>)</span><br />
887 Return a string which is the concatenation of the strings in the
888 iterable. The separator between elements is S.</td>
889 <td align="right" valign="top">
899 <td width="15%" align="right" valign="top" class="summary">
900 <span class="summary-type">string</span>
901 </td><td class="summary">
902 <table width="100%" cellpadding="0" cellspacing="0" border="0">
904 <td><span class="summary-sig"><a name="ljust"></a><span class="summary-sig-name">ljust</span>(<span class="summary-sig-arg">S</span>,
905 <span class="summary-sig-arg">width</span>,
906 <span class="summary-sig-arg">fillchar</span>=<span class="summary-sig-default">...</span>)</span><br />
907 Return S left-justified in a string of length width. Padding is
908 done using the specified fill character (default is a space).</td>
909 <td align="right" valign="top">
919 <td width="15%" align="right" valign="top" class="summary">
920 <span class="summary-type">string</span>
921 </td><td class="summary">
922 <table width="100%" cellpadding="0" cellspacing="0" border="0">
924 <td><span class="summary-sig"><a name="lower"></a><span class="summary-sig-name">lower</span>(<span class="summary-sig-arg">S</span>)</span><br />
925 Return a copy of the string S converted to lowercase.</td>
926 <td align="right" valign="top">
936 <td width="15%" align="right" valign="top" class="summary">
937 <span class="summary-type">string or unicode</span>
938 </td><td class="summary">
939 <table width="100%" cellpadding="0" cellspacing="0" border="0">
941 <td><span class="summary-sig"><a name="lstrip"></a><span class="summary-sig-name">lstrip</span>(<span class="summary-sig-arg">S</span>,
942 <span class="summary-sig-arg">chars</span>=<span class="summary-sig-default">...</span>)</span><br />
943 Return a copy of the string S with leading whitespace removed.
944 If chars is given and not None, remove characters in chars instead.
945 If chars is unicode, S will be converted to unicode before stripping</td>
946 <td align="right" valign="top">
956 <td width="15%" align="right" valign="top" class="summary">
957 <span class="summary-type">(head, sep, tail)</span>
958 </td><td class="summary">
959 <table width="100%" cellpadding="0" cellspacing="0" border="0">
961 <td><span class="summary-sig"><a name="partition"></a><span class="summary-sig-name">partition</span>(<span class="summary-sig-arg">S</span>,
962 <span class="summary-sig-arg">sep</span>)</span><br />
963 Search for the separator sep in S, and return the part before it,
964 the separator itself, and the part after it. If the separator is not
965 found, return S and two empty strings.</td>
966 <td align="right" valign="top">
976 <td width="15%" align="right" valign="top" class="summary">
977 <span class="summary-type">string</span>
978 </td><td class="summary">
979 <table width="100%" cellpadding="0" cellspacing="0" border="0">
981 <td><span class="summary-sig"><a name="replace"></a><span class="summary-sig-name">replace</span>(<span class="summary-sig-arg">S</span>,
982 <span class="summary-sig-arg">old</span>,
983 <span class="summary-sig-arg">new</span>,
984 <span class="summary-sig-arg">count</span>=<span class="summary-sig-default">...</span>)</span><br />
985 Return a copy of string S with all occurrences of substring
986 old replaced by new. If the optional argument count is
987 given, only the first count occurrences are replaced.</td>
988 <td align="right" valign="top">
998 <td width="15%" align="right" valign="top" class="summary">
999 <span class="summary-type">int</span>
1000 </td><td class="summary">
1001 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1003 <td><span class="summary-sig"><a href="str-class.html#rfind" class="summary-sig-name">rfind</a>(<span class="summary-sig-arg">S</span>,
1004 <span class="summary-sig-arg">sub</span>,
1005 <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">... </span>,
1006 <span class="summary-sig-arg">end</span>=<span class="summary-sig-default">...</span>)</span><br />
1007 Return the highest index in S where substring sub is found,
1008 such that sub is contained within S[start:end]. Optional
1009 arguments start and end are interpreted as in slice notation.</td>
1010 <td align="right" valign="top">
1020 <td width="15%" align="right" valign="top" class="summary">
1021 <span class="summary-type">int</span>
1022 </td><td class="summary">
1023 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1025 <td><span class="summary-sig"><a name="rindex"></a><span class="summary-sig-name">rindex</span>(<span class="summary-sig-arg">S</span>,
1026 <span class="summary-sig-arg">sub</span>,
1027 <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">... </span>,
1028 <span class="summary-sig-arg">end</span>=<span class="summary-sig-default">...</span>)</span><br />
1029 Like S.rfind() but raise ValueError when the substring is not found.</td>
1030 <td align="right" valign="top">
1040 <td width="15%" align="right" valign="top" class="summary">
1041 <span class="summary-type">string</span>
1042 </td><td class="summary">
1043 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1045 <td><span class="summary-sig"><a name="rjust"></a><span class="summary-sig-name">rjust</span>(<span class="summary-sig-arg">S</span>,
1046 <span class="summary-sig-arg">width</span>,
1047 <span class="summary-sig-arg">fillchar</span>=<span class="summary-sig-default">...</span>)</span><br />
1048 Return S right-justified in a string of length width. Padding is
1049 done using the specified fill character (default is a space)</td>
1050 <td align="right" valign="top">
1060 <td width="15%" align="right" valign="top" class="summary">
1061 <span class="summary-type">(head, sep, tail)</span>
1062 </td><td class="summary">
1063 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1065 <td><span class="summary-sig"><a name="rpartition"></a><span class="summary-sig-name">rpartition</span>(<span class="summary-sig-arg">S</span>,
1066 <span class="summary-sig-arg">sep</span>)</span><br />
1067 Search for the separator sep in S, starting at the end of S, and return
1068 the part before it, the separator itself, and the part after it. If the
1069 separator is not found, return two empty strings and S.</td>
1070 <td align="right" valign="top">
1080 <td width="15%" align="right" valign="top" class="summary">
1081 <span class="summary-type">list of strings</span>
1082 </td><td class="summary">
1083 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1085 <td><span class="summary-sig"><a name="rsplit"></a><span class="summary-sig-name">rsplit</span>(<span class="summary-sig-arg">S</span>,
1086 <span class="summary-sig-arg">sep</span>=<span class="summary-sig-default">... </span>,
1087 <span class="summary-sig-arg">maxsplit</span>=<span class="summary-sig-default">...</span>)</span><br />
1088 Return a list of the words in the string S, using sep as the
1089 delimiter string, starting at the end of the string and working
1090 to the front. If maxsplit is given, at most maxsplit splits are
1091 done. If sep is not specified or is None, any whitespace string
1092 is a separator.</td>
1093 <td align="right" valign="top">
1103 <td width="15%" align="right" valign="top" class="summary">
1104 <span class="summary-type">string or unicode</span>
1105 </td><td class="summary">
1106 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1108 <td><span class="summary-sig"><a name="rstrip"></a><span class="summary-sig-name">rstrip</span>(<span class="summary-sig-arg">S</span>,
1109 <span class="summary-sig-arg">chars</span>=<span class="summary-sig-default">...</span>)</span><br />
1110 Return a copy of the string S with trailing whitespace removed.
1111 If chars is given and not None, remove characters in chars instead.
1112 If chars is unicode, S will be converted to unicode before stripping</td>
1113 <td align="right" valign="top">
1123 <td width="15%" align="right" valign="top" class="summary">
1124 <span class="summary-type">list of strings</span>
1125 </td><td class="summary">
1126 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1128 <td><span class="summary-sig"><a name="split"></a><span class="summary-sig-name">split</span>(<span class="summary-sig-arg">S</span>,
1129 <span class="summary-sig-arg">sep</span>=<span class="summary-sig-default">... </span>,
1130 <span class="summary-sig-arg">maxsplit</span>=<span class="summary-sig-default">...</span>)</span><br />
1131 Return a list of the words in the string S, using sep as the
1132 delimiter string. If maxsplit is given, at most maxsplit
1133 splits are done. If sep is not specified or is None, any
1134 whitespace string is a separator and empty strings are removed
1135 from the result.</td>
1136 <td align="right" valign="top">
1146 <td width="15%" align="right" valign="top" class="summary">
1147 <span class="summary-type">list of strings</span>
1148 </td><td class="summary">
1149 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1151 <td><span class="summary-sig"><a name="splitlines"></a><span class="summary-sig-name">splitlines</span>(<span class="summary-sig-arg">S</span>,
1152 <span class="summary-sig-arg">keepends</span>=<span class="summary-sig-default">False</span>)</span><br />
1153 Return a list of the lines in S, breaking at line boundaries.
1154 Line breaks are not included in the resulting list unless keepends
1155 is given and true.</td>
1156 <td align="right" valign="top">
1166 <td width="15%" align="right" valign="top" class="summary">
1167 <span class="summary-type">bool</span>
1168 </td><td class="summary">
1169 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1171 <td><span class="summary-sig"><a name="startswith"></a><span class="summary-sig-name">startswith</span>(<span class="summary-sig-arg">S</span>,
1172 <span class="summary-sig-arg">prefix</span>,
1173 <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">...</span>,
1174 <span class="summary-sig-arg">end</span>=<span class="summary-sig-default">...</span>)</span><br />
1175 Return True if S starts with the specified prefix, False otherwise.
1176 With optional start, test S beginning at that position.
1177 With optional end, stop comparing S at that position.
1178 prefix can also be a tuple of strings to try.</td>
1179 <td align="right" valign="top">
1189 <td width="15%" align="right" valign="top" class="summary">
1190 <span class="summary-type">string or unicode</span>
1191 </td><td class="summary">
1192 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1194 <td><span class="summary-sig"><a name="strip"></a><span class="summary-sig-name">strip</span>(<span class="summary-sig-arg">S</span>,
1195 <span class="summary-sig-arg">chars</span>=<span class="summary-sig-default">...</span>)</span><br />
1196 Return a copy of the string S with leading and trailing
1198 If chars is given and not None, remove characters in chars instead.
1199 If chars is unicode, S will be converted to unicode before stripping</td>
1200 <td align="right" valign="top">
1210 <td width="15%" align="right" valign="top" class="summary">
1211 <span class="summary-type">string</span>
1212 </td><td class="summary">
1213 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1215 <td><span class="summary-sig"><a name="swapcase"></a><span class="summary-sig-name">swapcase</span>(<span class="summary-sig-arg">S</span>)</span><br />
1216 Return a copy of the string S with uppercase characters
1217 converted to lowercase and vice versa.</td>
1218 <td align="right" valign="top">
1228 <td width="15%" align="right" valign="top" class="summary">
1229 <span class="summary-type">string</span>
1230 </td><td class="summary">
1231 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1233 <td><span class="summary-sig"><a name="title"></a><span class="summary-sig-name">title</span>(<span class="summary-sig-arg">S</span>)</span><br />
1234 Return a titlecased version of S, i.e. words start with uppercase
1235 characters, all remaining cased characters have lowercase.</td>
1236 <td align="right" valign="top">
1246 <td width="15%" align="right" valign="top" class="summary">
1247 <span class="summary-type">string</span>
1248 </td><td class="summary">
1249 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1251 <td><span class="summary-sig"><a name="translate"></a><span class="summary-sig-name">translate</span>(<span class="summary-sig-arg">S</span>,
1252 <span class="summary-sig-arg">table</span>,
1253 <span class="summary-sig-arg">deletechars</span>=<span class="summary-sig-default">...</span>)</span><br />
1254 Return a copy of the string S, where all characters occurring
1255 in the optional argument deletechars are removed, and the
1256 remaining characters have been mapped through the given
1257 translation table, which must be a string of length 256 or None.
1258 If the table argument is None, no translation is applied and
1259 the operation simply removes the characters in deletechars.</td>
1260 <td align="right" valign="top">
1270 <td width="15%" align="right" valign="top" class="summary">
1271 <span class="summary-type">string</span>
1272 </td><td class="summary">
1273 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1275 <td><span class="summary-sig"><a name="upper"></a><span class="summary-sig-name">upper</span>(<span class="summary-sig-arg">S</span>)</span><br />
1276 Return a copy of the string S converted to uppercase.</td>
1277 <td align="right" valign="top">
1287 <td width="15%" align="right" valign="top" class="summary">
1288 <span class="summary-type">string</span>
1289 </td><td class="summary">
1290 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1292 <td><span class="summary-sig"><a name="zfill"></a><span class="summary-sig-name">zfill</span>(<span class="summary-sig-arg">S</span>,
1293 <span class="summary-sig-arg">width</span>)</span><br />
1294 Pad a numeric string S with zeros on the left, to fill a field
1295 of the specified width. The string S is never truncated.</td>
1296 <td align="right" valign="top">
1306 <td colspan="2" class="summary">
1307 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
1308 <code>__delattr__</code>,
1309 <code>__init__</code>,
1310 <code>__reduce__</code>,
1311 <code>__reduce_ex__</code>,
1312 <code>__setattr__</code>,
1313 <code>__subclasshook__</code>
1318 <!-- ==================== PROPERTIES ==================== -->
1319 <a name="section-Properties"></a>
1320 <table class="summary" border="1" cellpadding="3"
1321 cellspacing="0" width="100%" bgcolor="white">
1322 <tr bgcolor="#70b0f0" class="table-header">
1323 <td colspan="2" class="table-header">
1324 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1326 <td align="left"><span class="table-header">Properties</span></td>
1327 <td align="right" valign="top"
1328 ><span class="options">[<a href="#section-Properties"
1329 class="privatelink" onclick="toggle_private();"
1330 >hide private</a>]</span></td>
1336 <td colspan="2" class="summary">
1337 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
1338 <code>__class__</code>
1343 <!-- ==================== METHOD DETAILS ==================== -->
1344 <a name="section-MethodDetails"></a>
1345 <table class="details" border="1" cellpadding="3"
1346 cellspacing="0" width="100%" bgcolor="white">
1347 <tr bgcolor="#70b0f0" class="table-header">
1348 <td colspan="2" class="table-header">
1349 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1351 <td align="left"><span class="table-header">Method Details</span></td>
1352 <td align="right" valign="top"
1353 ><span class="options">[<a href="#section-MethodDetails"
1354 class="privatelink" onclick="toggle_private();"
1355 >hide private</a>]</span></td>
1361 <a name="__format__"></a>
1363 <table class="details" border="1" cellpadding="3"
1364 cellspacing="0" width="100%" bgcolor="white">
1366 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1367 <tr valign="top"><td>
1368 <h3 class="epydoc"><span class="sig"><span class="sig-name">__format__</span>(<span class="sig-arg">S</span>,
1369 <span class="sig-arg">format_spec</span>)</span>
1371 </td><td align="right" valign="top"
1376 Return a formatted version of S as described by format_spec.
1378 <dt>Returns: string</dt>
1385 <a name="__getattribute__"></a>
1387 <table class="details" border="1" cellpadding="3"
1388 cellspacing="0" width="100%" bgcolor="white">
1390 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1391 <tr valign="top"><td>
1392 <h3 class="epydoc"><span class="sig"><span class="sig-name">__getattribute__</span>(<span class="sig-arg">...</span>)</span>
1394 </td><td align="right" valign="top"
1399 x.__getattribute__('name') <==> x.name
1402 object.__getattribute__
1407 <a name="__getslice__"></a>
1409 <table class="details" border="1" cellpadding="3"
1410 cellspacing="0" width="100%" bgcolor="white">
1412 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1413 <tr valign="top"><td>
1414 <h3 class="epydoc"><span class="sig"><span class="sig-name">__getslice__</span>(<span class="sig-arg">x</span>,
1415 <span class="sig-arg">i</span>,
1416 <span class="sig-arg">j</span>)</span>
1417 <br /><em class="fname">(Slicling operator)</em>
1419 </td><td align="right" valign="top"
1425 <p>Use of negative indices is not supported.</p>
1430 <a name="__hash__"></a>
1432 <table class="details" border="1" cellpadding="3"
1433 cellspacing="0" width="100%" bgcolor="white">
1435 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1436 <tr valign="top"><td>
1437 <h3 class="epydoc"><span class="sig"><span class="sig-name">__hash__</span>(<span class="sig-arg">x</span>)</span>
1438 <br /><em class="fname">(Hashing function)</em>
1440 </td><td align="right" valign="top"
1453 <a name="__new__"></a>
1455 <table class="details" border="1" cellpadding="3"
1456 cellspacing="0" width="100%" bgcolor="white">
1458 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1459 <tr valign="top"><td>
1460 <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
1461 <span class="sig-arg">S</span>,
1462 <span class="sig-arg">...</span>)</span>
1464 </td><td align="right" valign="top"
1471 <dt>Returns: a new object with type S, a subtype of T</dt>
1478 <a name="__repr__"></a>
1480 <table class="details" border="1" cellpadding="3"
1481 cellspacing="0" width="100%" bgcolor="white">
1483 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1484 <tr valign="top"><td>
1485 <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>
1486 <br /><em class="fname">(Representation operator)</em>
1488 </td><td align="right" valign="top"
1501 <a name="__sizeof__"></a>
1503 <table class="details" border="1" cellpadding="3"
1504 cellspacing="0" width="100%" bgcolor="white">
1506 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1507 <tr valign="top"><td>
1508 <h3 class="epydoc"><span class="sig"><span class="sig-name">__sizeof__</span>(<span class="sig-arg">S</span>)</span>
1510 </td><td align="right" valign="top"
1515 size of object in memory, in bytes
1517 <dt>Returns: size of S in memory, in bytes</dt>
1524 <a name="__str__"></a>
1526 <table class="details" border="1" cellpadding="3"
1527 cellspacing="0" width="100%" bgcolor="white">
1529 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1530 <tr valign="top"><td>
1531 <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>
1532 <br /><em class="fname">(Informal representation operator)</em>
1534 </td><td align="right" valign="top"
1549 <table class="details" border="1" cellpadding="3"
1550 cellspacing="0" width="100%" bgcolor="white">
1552 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1553 <tr valign="top"><td>
1554 <h3 class="epydoc"><span class="sig"><span class="sig-name">find</span>(<span class="sig-arg">S</span>,
1555 <span class="sig-arg">sub</span>,
1556 <span class="sig-arg">start</span>=<span class="sig-default">... </span>,
1557 <span class="sig-arg">end</span>=<span class="sig-default">...</span>)</span>
1559 </td><td align="right" valign="top"
1564 <p>Return the lowest index in S where substring sub is found,
1565 such that sub is contained within S[start:end]. Optional
1566 arguments start and end are interpreted as in slice notation.</p>
1567 <p>Return -1 on failure.</p>
1569 <dt>Returns: int</dt>
1573 <a name="rfind"></a>
1575 <table class="details" border="1" cellpadding="3"
1576 cellspacing="0" width="100%" bgcolor="white">
1578 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1579 <tr valign="top"><td>
1580 <h3 class="epydoc"><span class="sig"><span class="sig-name">rfind</span>(<span class="sig-arg">S</span>,
1581 <span class="sig-arg">sub</span>,
1582 <span class="sig-arg">start</span>=<span class="sig-default">... </span>,
1583 <span class="sig-arg">end</span>=<span class="sig-default">...</span>)</span>
1585 </td><td align="right" valign="top"
1590 <p>Return the highest index in S where substring sub is found,
1591 such that sub is contained within S[start:end]. Optional
1592 arguments start and end are interpreted as in slice notation.</p>
1593 <p>Return -1 on failure.</p>
1595 <dt>Returns: int</dt>
1600 <!-- ==================== NAVIGATION BAR ==================== -->
1601 <table class="navbar" border="0" width="100%" cellpadding="0"
1602 bgcolor="#a0c0ff" cellspacing="0">
1603 <tr valign="middle">
1605 <th> <a
1606 href="lxml-module.html">Home</a> </th>
1609 <th> <a
1610 href="module-tree.html">Trees</a> </th>
1613 <th> <a
1614 href="identifier-index.html">Indices</a> </th>
1617 <th> <a
1618 href="help.html">Help</a> </th>
1620 <!-- Project homepage -->
1621 <th class="navbar" align="right" width="100%">
1622 <table border="0" cellpadding="0" cellspacing="0">
1623 <tr><th class="navbar" align="center"
1624 ><a class="navbar" target="_top" href="/">lxml API</a></th>
1628 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
1630 <td align="left" class="footer">
1631 Generated by Epydoc 3.0.1
1632 on Thu Jul 9 18:29:53 2020
1634 <td align="right" class="footer">
1635 <a target="mainFrame" href="http://epydoc.sourceforge.net"
1636 >http://epydoc.sourceforge.net</a>
1641 <script type="text/javascript">
1643 // Private objects are initially displayed (because if
1644 // javascript is turned off then we want them to be
1645 // visible); but by default, we want to hide them. So hide
1646 // them unless we have a cookie that says to show them.