Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | ## vim:ts=4:et:nowrap |
| 3 | """A user-defined wrapper around string objects |
| 4 | |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 5 | Note: string objects have grown methods in Python 1.6 |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 6 | This module requires Python 1.6 or later. |
| 7 | """ |
Michael W. Hudson | f207277 | 2002-05-20 14:48:16 +0000 | [diff] [blame] | 8 | from types import StringTypes |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 9 | import sys |
| 10 | |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 11 | __all__ = ["UserString","MutableString"] |
| 12 | |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 13 | class UserString: |
| 14 | def __init__(self, seq): |
Michael W. Hudson | f207277 | 2002-05-20 14:48:16 +0000 | [diff] [blame] | 15 | if isinstance(seq, StringTypes): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 16 | self.data = seq |
| 17 | elif isinstance(seq, UserString): |
| 18 | self.data = seq.data[:] |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 19 | else: |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 20 | self.data = str(seq) |
| 21 | def __str__(self): return str(self.data) |
| 22 | def __repr__(self): return repr(self.data) |
| 23 | def __int__(self): return int(self.data) |
| 24 | def __long__(self): return long(self.data) |
| 25 | def __float__(self): return float(self.data) |
| 26 | def __complex__(self): return complex(self.data) |
| 27 | def __hash__(self): return hash(self.data) |
| 28 | |
| 29 | def __cmp__(self, string): |
| 30 | if isinstance(string, UserString): |
| 31 | return cmp(self.data, string.data) |
| 32 | else: |
| 33 | return cmp(self.data, string) |
| 34 | def __contains__(self, char): |
| 35 | return char in self.data |
| 36 | |
| 37 | def __len__(self): return len(self.data) |
| 38 | def __getitem__(self, index): return self.__class__(self.data[index]) |
| 39 | def __getslice__(self, start, end): |
| 40 | start = max(start, 0); end = max(end, 0) |
| 41 | return self.__class__(self.data[start:end]) |
| 42 | |
| 43 | def __add__(self, other): |
| 44 | if isinstance(other, UserString): |
| 45 | return self.__class__(self.data + other.data) |
Michael W. Hudson | f207277 | 2002-05-20 14:48:16 +0000 | [diff] [blame] | 46 | elif isinstance(other, StringTypes): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 47 | return self.__class__(self.data + other) |
| 48 | else: |
| 49 | return self.__class__(self.data + str(other)) |
| 50 | def __radd__(self, other): |
Michael W. Hudson | f207277 | 2002-05-20 14:48:16 +0000 | [diff] [blame] | 51 | if isinstance(other, StringTypes): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 52 | return self.__class__(other + self.data) |
| 53 | else: |
| 54 | return self.__class__(str(other) + self.data) |
| 55 | def __mul__(self, n): |
| 56 | return self.__class__(self.data*n) |
| 57 | __rmul__ = __mul__ |
Neil Schemenauer | fe4f769 | 2002-11-18 16:12:54 +0000 | [diff] [blame] | 58 | def __mod__(self, args): |
| 59 | return self.__class__(self.data % args) |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 60 | |
| 61 | # the following methods are defined in alphabetical order: |
| 62 | def capitalize(self): return self.__class__(self.data.capitalize()) |
| 63 | def center(self, width): return self.__class__(self.data.center(width)) |
| 64 | def count(self, sub, start=0, end=sys.maxint): |
| 65 | return self.data.count(sub, start, end) |
Marc-André Lemburg | 2d92041 | 2001-05-15 12:00:02 +0000 | [diff] [blame] | 66 | def decode(self, encoding=None, errors=None): # XXX improve this? |
| 67 | if encoding: |
| 68 | if errors: |
| 69 | return self.__class__(self.data.decode(encoding, errors)) |
| 70 | else: |
| 71 | return self.__class__(self.data.decode(encoding)) |
| 72 | else: |
| 73 | return self.__class__(self.data.decode()) |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 74 | def encode(self, encoding=None, errors=None): # XXX improve this? |
| 75 | if encoding: |
| 76 | if errors: |
| 77 | return self.__class__(self.data.encode(encoding, errors)) |
| 78 | else: |
| 79 | return self.__class__(self.data.encode(encoding)) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 80 | else: |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 81 | return self.__class__(self.data.encode()) |
| 82 | def endswith(self, suffix, start=0, end=sys.maxint): |
| 83 | return self.data.endswith(suffix, start, end) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 84 | def expandtabs(self, tabsize=8): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 85 | return self.__class__(self.data.expandtabs(tabsize)) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 86 | def find(self, sub, start=0, end=sys.maxint): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 87 | return self.data.find(sub, start, end) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 88 | def index(self, sub, start=0, end=sys.maxint): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 89 | return self.data.index(sub, start, end) |
Jeremy Hylton | fd54757 | 2000-07-10 17:07:17 +0000 | [diff] [blame] | 90 | def isalpha(self): return self.data.isalpha() |
| 91 | def isalnum(self): return self.data.isalnum() |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 92 | def isdecimal(self): return self.data.isdecimal() |
| 93 | def isdigit(self): return self.data.isdigit() |
| 94 | def islower(self): return self.data.islower() |
| 95 | def isnumeric(self): return self.data.isnumeric() |
| 96 | def isspace(self): return self.data.isspace() |
| 97 | def istitle(self): return self.data.istitle() |
| 98 | def isupper(self): return self.data.isupper() |
| 99 | def join(self, seq): return self.data.join(seq) |
| 100 | def ljust(self, width): return self.__class__(self.data.ljust(width)) |
| 101 | def lower(self): return self.__class__(self.data.lower()) |
Neal Norwitz | ffe33b7 | 2003-04-10 22:35:32 +0000 | [diff] [blame^] | 102 | def lstrip(self, chars=None): return self.__class__(self.data.lstrip(chars)) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 103 | def replace(self, old, new, maxsplit=-1): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 104 | return self.__class__(self.data.replace(old, new, maxsplit)) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 105 | def rfind(self, sub, start=0, end=sys.maxint): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 106 | return self.data.rfind(sub, start, end) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 107 | def rindex(self, sub, start=0, end=sys.maxint): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 108 | return self.data.rindex(sub, start, end) |
| 109 | def rjust(self, width): return self.__class__(self.data.rjust(width)) |
Neal Norwitz | ffe33b7 | 2003-04-10 22:35:32 +0000 | [diff] [blame^] | 110 | def rstrip(self, chars=None): return self.__class__(self.data.rstrip(chars)) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 111 | def split(self, sep=None, maxsplit=-1): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 112 | return self.data.split(sep, maxsplit) |
Guido van Rossum | 8666291 | 2000-04-11 15:38:46 +0000 | [diff] [blame] | 113 | def splitlines(self, keepends=0): return self.data.splitlines(keepends) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 114 | def startswith(self, prefix, start=0, end=sys.maxint): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 115 | return self.data.startswith(prefix, start, end) |
Neal Norwitz | ffe33b7 | 2003-04-10 22:35:32 +0000 | [diff] [blame^] | 116 | def strip(self, chars=None): return self.__class__(self.data.strip(chars)) |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 117 | def swapcase(self): return self.__class__(self.data.swapcase()) |
| 118 | def title(self): return self.__class__(self.data.title()) |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 119 | def translate(self, *args): |
Fred Drake | a893957 | 2000-08-21 21:47:20 +0000 | [diff] [blame] | 120 | return self.__class__(self.data.translate(*args)) |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 121 | def upper(self): return self.__class__(self.data.upper()) |
Walter Dörwald | 068325e | 2002-04-15 13:36:47 +0000 | [diff] [blame] | 122 | def zfill(self, width): return self.__class__(self.data.zfill(width)) |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 123 | |
| 124 | class MutableString(UserString): |
| 125 | """mutable string objects |
| 126 | |
| 127 | Python strings are immutable objects. This has the advantage, that |
| 128 | strings may be used as dictionary keys. If this property isn't needed |
| 129 | and you insist on changing string values in place instead, you may cheat |
| 130 | and use MutableString. |
| 131 | |
| 132 | But the purpose of this class is an educational one: to prevent |
| 133 | people from inventing their own mutable string class derived |
| 134 | from UserString and than forget thereby to remove (override) the |
| 135 | __hash__ method inherited from ^UserString. This would lead to |
| 136 | errors that would be very hard to track down. |
| 137 | |
| 138 | A faster and better solution is to rewrite your program using lists.""" |
| 139 | def __init__(self, string=""): |
| 140 | self.data = string |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 141 | def __hash__(self): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 142 | raise TypeError, "unhashable type (it is mutable)" |
| 143 | def __setitem__(self, index, sub): |
| 144 | if index < 0 or index >= len(self.data): raise IndexError |
| 145 | self.data = self.data[:index] + sub + self.data[index+1:] |
| 146 | def __delitem__(self, index): |
| 147 | if index < 0 or index >= len(self.data): raise IndexError |
| 148 | self.data = self.data[:index] + self.data[index+1:] |
| 149 | def __setslice__(self, start, end, sub): |
| 150 | start = max(start, 0); end = max(end, 0) |
| 151 | if isinstance(sub, UserString): |
| 152 | self.data = self.data[:start]+sub.data+self.data[end:] |
Michael W. Hudson | f207277 | 2002-05-20 14:48:16 +0000 | [diff] [blame] | 153 | elif isinstance(sub, StringTypes): |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 154 | self.data = self.data[:start]+sub+self.data[end:] |
| 155 | else: |
| 156 | self.data = self.data[:start]+str(sub)+self.data[end:] |
| 157 | def __delslice__(self, start, end): |
| 158 | start = max(start, 0); end = max(end, 0) |
| 159 | self.data = self.data[:start] + self.data[end:] |
| 160 | def immutable(self): |
| 161 | return UserString(self.data) |
Raymond Hettinger | c35491e | 2002-08-09 01:37:06 +0000 | [diff] [blame] | 162 | def __iadd__(self, other): |
| 163 | if isinstance(other, UserString): |
| 164 | self.data += other.data |
| 165 | elif isinstance(other, StringTypes): |
| 166 | self.data += other |
| 167 | else: |
| 168 | self.data += str(other) |
| 169 | return self |
| 170 | def __imul__(self, n): |
| 171 | self.data *= n |
| 172 | return self |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 173 | |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 174 | if __name__ == "__main__": |
| 175 | # execute the regression test to stdout, if called as a script: |
| 176 | import os |
| 177 | called_in_dir, called_as = os.path.split(sys.argv[0]) |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 178 | called_as, py = os.path.splitext(called_as) |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 179 | if '-q' in sys.argv: |
Barry Warsaw | 408b6d3 | 2002-07-30 23:27:12 +0000 | [diff] [blame] | 180 | from test import test_support |
Fred Drake | a22b576 | 2000-04-03 03:51:50 +0000 | [diff] [blame] | 181 | test_support.verbose = 0 |
Barry Warsaw | 408b6d3 | 2002-07-30 23:27:12 +0000 | [diff] [blame] | 182 | __import__('test.test_' + called_as.lower()) |