pystring (OpScript)¶

pystring.capitalize(string)¶

Return a copy of the string with its first character capitalized and the rest lowercased.

pystring.center(string str, int width)¶

Return new string centered in a string of length width. Padding is done with spaces.

pystring.count(string str, string substr, string substr[, int start, int end])¶

Return the number of non-overlapping occurrences of substring sub in the range [start, end]. Optional arguments start and end are interpreted as in slice notation.

pystring.endswith(string str, string suffix[, int start, int end])¶

Return true if the string ends with the specified suffix, otherwise return false. With optional start, test beginning at that position. With optional end, stop comparing at that position.

pystring.expandtabs(string str[, int tabsize])¶

Return a copy of the string where all tab characters are replaced by one or more spaces, depending on the current column and the given tab size. Tab positions occur every tabsize characters (default is 8, giving tab positions at columns 0, 8, 16 and so on).

pystring.find(string str, string sub[, int start, int end])¶

Return the lowest index in the string where substring sub is found, such that sub is contained in the slice s[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 if sub is not found.

pystring.index(string str, string sub[, int start, int end])¶

Same as find. Does not throw exception on failure (unlike Python).

pystring.isalnum(string str)¶

Return true if all characters in the string are alphanumeric and there is at least one character, false otherwise.

pystring.isalpha(string str)¶

Return true if all characters in the string are alphabetic and there is at least one character, false otherwise.

pystring.isdigit(string str)¶

Return true if all characters in the string are digits and there is at least one character, false otherwise.

pystring.islower(string str)¶

Return true if all cased characters in the string are lowercase and there is at least one cased character, false otherwise.

pystring.isspace(string str)¶

Return true if there are only whitespace characters in the string and there is at least one character, false otherwise

pystring.istitle(string str)¶

Return true if the string is a titlecased string and there is at least one character, for example uppercase characters may only follow uncased characters and lowercase characters only cased ones. Return false otherwise.

pystring.isupper(string str)¶

Return true if all cased characters [in the string are uppercase and there is at least one cased character, false otherwise.

pystring.join(string separator, list seq)¶

Return a string which is the concatenation of the strings in seq. The separator between elements is given by the separator argument.

pystring.ljust(string str, int width)¶

Return the string left justified in a string of length width. Padding is done with spaces.

pystring.lower(string str)¶

Return a copy of the string with all the cased characters converted to lowercase.

pystring.lstrip(string str, string chars)¶

Return a copy of the string with leading characters removed. The chars argument is a string specifying the set of characters to be removed. If omitted, the chars argument defaults to removing whitespace. The chars argument is not a prefix; rather, all combinations of its values are stripped.

pystring.mul(string str, int n)¶

Return a new string with the str argument concatenated n times.

pystring.partition(string str, int sep)¶

Split the string at the first occurrence of sep, and return a list table with three values containing the part before the separator, the separator itself, and the part after the separator. If the separator is not found, return a list table containing the string itself, followed by two empty strings.

pystring.replace(string str, string oldstr, string newstr[, int count = -1])¶

Return a copy of the string with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

pystring.rfind(string str, string sub[, int start, int end])¶

Return the highest index in the string where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

pystring.rindex(string str, string sub[, int start, int end])¶

Like pystring.rfind().

pystring.rjust(string str, int width)¶

Return the string right justified in a string of length width. Padding is done with spaces. The original string is returned if width is less than or equal to #s.

pystring.rpartition(string str, string sep)¶

Split the string at the last occurrence of sep, and return a list table with three values containing the part before the separator, the separator itself, and the part after the separator. If the separator is not found, return a list table containing two empty strings, followed by the string itself.

pystring.rsplit(string str[, string sep = "", int maxsplits = -1])¶

Return a list of the words in the string, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done, the rightmost ones. If sep is not specified, any whitespace string is a separator. Except for splitting from the right, rsplit() behaves like split() which is described in detail below.

pystring.rstrip(string str[, string chars = ""])¶

Return a copy of the string with trailing characters removed. The chars argument is a string specifying the set of characters to be removed. If omitted, the chars argument defaults to removing whitespace. The chars argument is not a suffix; rather, all combinations of its values are stripped.

pystring.slice(string str[, int start, int end])¶

Return substring of str using equivalent of python slice str[start:end].

pystring.split(string str[, string sep = "", int maxsplits = -1])¶

Return a list of the words in the string, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done (thus, the list will have at most maxsplit+1 elements). If maxsplit is not specified or -1, then there is no limit on the number of splits (all possible splits are made).

If sep is given, consecutive delimiters are not grouped together and are deemed to delimit empty strings (for example, pystring.split('1,,2', ',') returns {'1', '', '2'}). The sep argument may consist of multiple characters (for example, pystring.split('123', '') returns {'1', '2', '3'}). Splitting an empty string with a specified separator returns {''}.

If sep is not specified, a different splitting algorithm is applied: runs of consecutive whitespace are regarded as a single separator, and the result will contain no empty strings at the start or end if the string has leading or trailing whitespace. Consequently, splitting an empty string or a string consisting of just whitespace with no separator returns {}.

pystring.splitlines(string str[, boolean keepends = false])¶

Return a list of the lines in str, breaking at line boundaries. This method uses the universal newlines approach to splitting lines. Line breaks are not included in the resulting list unless keepends is given and true.

For example, pystring.splitlines('ab c\n\nde fg\rkl\r\n') returns {'ab c', '', 'de fg', 'kl'}, while the same call with keepends=true returns {'ab c\n', '\n', 'de fg\r', 'kl\r\n'}.

Unlike split() when a delimiter string sep is given, this method returns an empty list for the empty string, and a terminal line break does not result in an extra line.

pystring.startswith(string str, string prefix[, int start, int end])¶

Return true if str starts with the prefix, otherwise return false. With optional start, test string beginning at that position. With optional end, stop comparing string at that position.

pystring.strip(string str[, string chars])¶

Return a copy of str with the leading and trailing characters removed. The chars argument is a string specifying the set of characters to be removed. If omitted, the chars argument defaults to removing whitespace. The chars argument is not a prefix or suffix; rather, all combinations of its values are stripped:

pystring.swapcase(string str)¶

Return a copy of the string with uppercase characters converted to lowercase and vice versa.

pystring.title(string str)¶

Return a titlecased version of the string where words start with an uppercase character and the remaining characters are lowercase.

The algorithm uses a simple language-independent definition of a word as groups of consecutive letters. The definition works in many contexts but it means that apostrophes in contractions and possessives form word boundaries, which may not be the desired result.

pystring.translate(string str, string chartable[, string deletechars])¶

Return a copy of the string where all characters occurring in the optional argument deletechars are removed, and the remaining characters have been mapped through the given translation table, which must be a string of length 256.

pystring.upper(string str)¶

Return a copy of the string with all the cased characters converted to uppercase. Note that pystring.isupper(pystring.upper(str)) might be false if s contains uncased characters

pystring.zfill(string str, int width)¶

Return a copy of the numeric str left filled with zeros in a string of length width. A sign prefix is handled correctly. A copy of the original string is returned if width is less than or equal to #str.