string -- Python library reference



Next: regex Prev: String Services Up: String Services Top: Top

4.1. Standard Module string

This module defines some constants useful for checking character classes and some useful string functions. See the modules regex and regsub for string functions based on regular expressions.

The constants defined in this module are are:

digits -- data of module string
The string '0123456789'.
hexdigits -- data of module string
The string '0123456789abcdefABCDEF'.
letters -- data of module string
The concatenation of the strings lowercase and uppercase described below.
lowercase -- data of module string
A string containing all the characters that are considered lowercase letters. On most systems this is the string 'abcdefghijklmnopqrstuvwxyz'. Do not change its definition --- the effect on the routines upper and swapcase is undefined.
octdigits -- data of module string
The string '01234567'.
uppercase -- data of module string
A string containing all the characters that are considered uppercase letters. On most systems this is the string 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'. Do not change its definition --- the effect on the routines lower and swapcase is undefined.
whitespace -- data of module string
A string containing all characters that are considered whitespace. On most systems this includes the characters space, tab, linefeed, return, formfeed, and vertical tab. Do not change its definition --- the effect on the routines strip and split is undefined.
The functions defined in this module are:

atof (s) -- function of module string
Convert a string to a floating point number. The string must have the standard syntax for a floating point literal in Python, optionally preceded by a sign (`+' or `-').
atoi (s[, base]) -- function of module string
Convert string s to an integer in the given base. The string must consist of one or more digits, optionally preceded by a sign (`+' or `-'). The base defaults to 10. If it is 0, a default base is chosen depending on the leading characters of the string (after stripping the sign): `0x' or `0X' means 16, `0' means 8, anything else means 10. If base is 16, a leading `0x' or `0X' is always accepted. (Note: for a more flexible interpretation of numeric literals, use the built-in function eval().)
atol (s[, base]) -- function of module string
Convert string s to a long integer in the given base. The string must consist of one or more digits, optionally preceded by a sign (`+' or `-'). The base argument has the same meaning as for atoi(). A trailing `l' or `L' is not allowed.
expandtabs (s, tabsize) -- function of module string
Expand tabs in a string, i.e. replace them by one or more spaces, depending on the current column and the given tab size. The column number is reset to zero after each newline occurring in the string. This doesn't understand other non-printing characters or escape sequences.
find (s, sub[, start]) -- function of module string
Return the lowest index in s not smaller than start where the substring sub is found. Return -1 when sub does not occur as a substring of s with index at least start. If start is omitted, it defaults to 0. If start is negative, len(s) is added.
rfind (s, sub[, start]) -- function of module string
Like find but find the highest index.
index (s, sub[, start]) -- function of module string
Like find but raise ValueError when the substring is not found.
rindex (s, sub[, start]) -- function of module string
Like rfind but raise ValueError when the substring is not found.
count (s, sub[, start]) -- function of module string
Return the number of (non-overlapping) occurrences of substring sub in string s with index at least start. If start is omitted, it defaults to 0. If start is negative, len(s) is added.
lower (s) -- function of module string
Convert letters to lower case.
split (s) -- function of module string
Return a list of the whitespace-delimited words of the string s.
splitfields (s, sep) -- function of module string
Return a list containing the fields of the string s, using the string sep as a separator. The list will have one more items than the number of non-overlapping occurrences of the separator in the string. Thus, string.splitfields(s, ' ') is not the same as string.split(s), as the latter only returns non-empty words. As a special case, splitfields(s, '') returns [s], for any string s. (See also regsub.split().)
join (words) -- function of module string
Concatenate a list or tuple of words with intervening spaces.
joinfields (words, sep) -- function of module string
Concatenate a list or tuple of words with intervening separators. It is always true that string.joinfields(string.splitfields(t, sep), sep) equals t.
strip (s) -- function of module string
Remove leading and trailing whitespace from the string s.
swapcase (s) -- function of module string
Convert lower case letters to upper case and vice versa.
translate (s, table) -- function of module string
Translate the characters from s using table, which must be a 256-character string giving the translation for each character value, indexed by its ordinal.
upper (s) -- function of module string
Convert letters to upper case.
ljust (s, width) -- function of module string
rjust (s, width) -- function of module string
center (s, width) -- function of module string
These functions respectively left-justify, right-justify and center a string in a field of given width. They return a string that is at least width characters wide, created by padding the string s with spaces until the given width on the right, left or both sides. The string is never truncated.
zfill (s, width) -- function of module string
Pad a numeric string on the left with zero digits until the given width is reached. Strings starting with a sign are handled correctly.
This module is implemented in Python. Much of its functionality has been reimplemented in the built-in module strop. However, you should never import the latter module directly. When string discovers that strop exists, it transparently replaces parts of itself with the implementation from strop. After initialization, there is no overhead in using string instead of strop.

Next: regex Prev: String Services Up: String Services Top: Top