Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 1 | """Create portable serialized representations of Python objects. |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 3 | See module cPickle for a (much) faster implementation. |
| 4 | See module copy_reg for a mechanism for registering custom picklers. |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 5 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 6 | Classes: |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 7 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 8 | Pickler |
| 9 | Unpickler |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 10 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 11 | Functions: |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 13 | dump(object, file) |
| 14 | dumps(object) -> string |
| 15 | load(file) -> object |
| 16 | loads(string) -> object |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 17 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 18 | Misc variables: |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 19 | |
Fred Drake | fe82acc | 1998-02-13 03:24:48 +0000 | [diff] [blame] | 20 | __version__ |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 21 | format_version |
| 22 | compatible_formats |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 23 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 24 | """ |
| 25 | |
Guido van Rossum | 743d17e | 1998-09-15 20:25:57 +0000 | [diff] [blame] | 26 | __version__ = "$Revision$" # Code version |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 27 | |
| 28 | from types import * |
Guido van Rossum | 4fb5b28 | 1997-09-12 20:07:24 +0000 | [diff] [blame] | 29 | from copy_reg import dispatch_table, safe_constructors |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 30 | import marshal |
| 31 | import sys |
| 32 | import struct |
Skip Montanaro | 23bafc6 | 2001-02-18 03:10:09 +0000 | [diff] [blame] | 33 | import re |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 34 | |
Skip Montanaro | 352674d | 2001-02-07 23:14:30 +0000 | [diff] [blame] | 35 | __all__ = ["PickleError", "PicklingError", "UnpicklingError", "Pickler", |
| 36 | "Unpickler", "dump", "dumps", "load", "loads"] |
| 37 | |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 38 | format_version = "1.3" # File format version we write |
| 39 | compatible_formats = ["1.0", "1.1", "1.2"] # Old format versions we can read |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 40 | |
| 41 | mdumps = marshal.dumps |
| 42 | mloads = marshal.loads |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 43 | |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame^] | 44 | class PickleError(Exception): |
| 45 | """A common base class for the other pickling exceptions. |
| 46 | |
| 47 | Inherits from \exception{Exception}. |
| 48 | |
| 49 | """ |
| 50 | pass |
| 51 | |
| 52 | class PicklingError(PickleError): |
| 53 | """This exception is raised when an unpicklable object is passed to the |
| 54 | dump() method. |
| 55 | |
| 56 | """ |
| 57 | pass |
| 58 | |
| 59 | class UnpicklingError(PickleError): |
| 60 | """This exception is raised when there is a problem unpickling an object, |
| 61 | such as a security violation. |
| 62 | |
| 63 | Note that other exceptions may also be raised during unpickling, including |
| 64 | (but not necessarily limited to) AttributeError, EOFError, ImportError, |
| 65 | and IndexError. |
| 66 | |
| 67 | """ |
| 68 | pass |
Guido van Rossum | 7849da8 | 1995-03-09 14:08:35 +0000 | [diff] [blame] | 69 | |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 70 | class _Stop(Exception): |
| 71 | def __init__(self, value): |
| 72 | self.value = value |
| 73 | |
Jeremy Hylton | 2b9d029 | 1998-05-27 22:38:22 +0000 | [diff] [blame] | 74 | try: |
| 75 | from org.python.core import PyStringMap |
| 76 | except ImportError: |
| 77 | PyStringMap = None |
| 78 | |
Guido van Rossum | dbb718f | 2001-09-21 19:22:34 +0000 | [diff] [blame] | 79 | try: |
| 80 | UnicodeType |
| 81 | except NameError: |
| 82 | UnicodeType = None |
| 83 | |
| 84 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 85 | MARK = '(' |
| 86 | STOP = '.' |
| 87 | POP = '0' |
| 88 | POP_MARK = '1' |
| 89 | DUP = '2' |
| 90 | FLOAT = 'F' |
| 91 | INT = 'I' |
| 92 | BININT = 'J' |
| 93 | BININT1 = 'K' |
| 94 | LONG = 'L' |
| 95 | BININT2 = 'M' |
| 96 | NONE = 'N' |
| 97 | PERSID = 'P' |
| 98 | BINPERSID = 'Q' |
| 99 | REDUCE = 'R' |
| 100 | STRING = 'S' |
| 101 | BINSTRING = 'T' |
| 102 | SHORT_BINSTRING = 'U' |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 103 | UNICODE = 'V' |
| 104 | BINUNICODE = 'X' |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 105 | APPEND = 'a' |
| 106 | BUILD = 'b' |
| 107 | GLOBAL = 'c' |
| 108 | DICT = 'd' |
| 109 | EMPTY_DICT = '}' |
| 110 | APPENDS = 'e' |
| 111 | GET = 'g' |
| 112 | BINGET = 'h' |
| 113 | INST = 'i' |
| 114 | LONG_BINGET = 'j' |
| 115 | LIST = 'l' |
| 116 | EMPTY_LIST = ']' |
| 117 | OBJ = 'o' |
| 118 | PUT = 'p' |
| 119 | BINPUT = 'q' |
| 120 | LONG_BINPUT = 'r' |
| 121 | SETITEM = 's' |
| 122 | TUPLE = 't' |
| 123 | EMPTY_TUPLE = ')' |
| 124 | SETITEMS = 'u' |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 125 | BINFLOAT = 'G' |
Guido van Rossum | e276339 | 2002-04-05 19:30:08 +0000 | [diff] [blame] | 126 | TRUE = 'I01\n' |
| 127 | FALSE = 'I00\n' |
Guido van Rossum | 77f6a65 | 2002-04-03 22:41:51 +0000 | [diff] [blame] | 128 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 129 | |
Skip Montanaro | 23bafc6 | 2001-02-18 03:10:09 +0000 | [diff] [blame] | 130 | __all__.extend([x for x in dir() if re.match("[A-Z][A-Z0-9_]+$",x)]) |
Neal Norwitz | d5ba4ae | 2002-02-11 18:12:06 +0000 | [diff] [blame] | 131 | del x |
Skip Montanaro | 23bafc6 | 2001-02-18 03:10:09 +0000 | [diff] [blame] | 132 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 133 | class Pickler: |
| 134 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 135 | def __init__(self, file, bin = 0): |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame^] | 136 | """This takes a file-like object for writing a pickle data stream. |
| 137 | |
| 138 | The optional bin parameter if true, tells the pickler to use the more |
| 139 | efficient binary pickle format, otherwise the ASCII format is used |
| 140 | (this is the default). |
| 141 | |
| 142 | The file parameter must have a write() method that accepts a single |
| 143 | string argument. It can thus be an open file object, a StringIO |
| 144 | object, or any other custom object that meets this interface. |
| 145 | |
| 146 | """ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 147 | self.write = file.write |
| 148 | self.memo = {} |
| 149 | self.bin = bin |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 150 | |
Fred Drake | 7f781c9 | 2002-05-01 20:33:53 +0000 | [diff] [blame] | 151 | def clear_memo(self): |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame^] | 152 | """Clears the pickler's "memo". |
| 153 | |
| 154 | The memo is the data structure that remembers which objects the |
| 155 | pickler has already seen, so that shared or recursive objects pickled |
| 156 | by reference and not by value. This method is useful when re-using |
| 157 | picklers. |
| 158 | |
| 159 | """ |
Fred Drake | 7f781c9 | 2002-05-01 20:33:53 +0000 | [diff] [blame] | 160 | self.memo.clear() |
| 161 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 162 | def dump(self, object): |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame^] | 163 | """Write a pickled representation of object to the open file object. |
| 164 | |
| 165 | Either the binary or ASCII format will be used, depending on the |
| 166 | value of the bin flag passed to the constructor. |
| 167 | |
| 168 | """ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 169 | self.save(object) |
| 170 | self.write(STOP) |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 171 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 172 | def put(self, i): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 173 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 174 | s = mdumps(i)[1:] |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 175 | if i < 256: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 176 | return BINPUT + s[0] |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 177 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 178 | return LONG_BINPUT + s |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 179 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 180 | return PUT + `i` + '\n' |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 181 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 182 | def get(self, i): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 183 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 184 | s = mdumps(i)[1:] |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 185 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 186 | if i < 256: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 187 | return BINGET + s[0] |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 188 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 189 | return LONG_BINGET + s |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 190 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 191 | return GET + `i` + '\n' |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 192 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 193 | def save(self, object, pers_save = 0): |
| 194 | memo = self.memo |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 195 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 196 | if not pers_save: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 197 | pid = self.persistent_id(object) |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 198 | if pid is not None: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 199 | self.save_pers(pid) |
| 200 | return |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 201 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 202 | d = id(object) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 203 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 204 | t = type(object) |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 205 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 206 | if (t is TupleType) and (len(object) == 0): |
| 207 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 208 | self.save_empty_tuple(object) |
| 209 | else: |
| 210 | self.save_tuple(object) |
| 211 | return |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 212 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 213 | if memo.has_key(d): |
| 214 | self.write(self.get(memo[d][0])) |
| 215 | return |
| 216 | |
| 217 | try: |
| 218 | f = self.dispatch[t] |
| 219 | except KeyError: |
Guido van Rossum | 85ee491 | 2002-03-26 00:51:56 +0000 | [diff] [blame] | 220 | try: |
| 221 | issc = issubclass(t, TypeType) |
| 222 | except TypeError: # t is not a class |
| 223 | issc = 0 |
| 224 | if issc: |
Guido van Rossum | f048a8f | 2001-12-19 16:55:02 +0000 | [diff] [blame] | 225 | self.save_global(object) |
| 226 | return |
| 227 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 228 | pid = self.inst_persistent_id(object) |
| 229 | if pid is not None: |
| 230 | self.save_pers(pid) |
| 231 | return |
| 232 | |
| 233 | try: |
| 234 | reduce = dispatch_table[t] |
| 235 | except KeyError: |
| 236 | try: |
| 237 | reduce = object.__reduce__ |
| 238 | except AttributeError: |
| 239 | raise PicklingError, \ |
Guido van Rossum | 08a92cb | 1999-10-10 21:14:25 +0000 | [diff] [blame] | 240 | "can't pickle %s object: %s" % (`t.__name__`, |
| 241 | `object`) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 242 | else: |
| 243 | tup = reduce() |
| 244 | else: |
| 245 | tup = reduce(object) |
| 246 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 247 | if type(tup) is StringType: |
| 248 | self.save_global(object, tup) |
| 249 | return |
Guido van Rossum | d1f4984 | 1997-12-10 23:40:18 +0000 | [diff] [blame] | 250 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 251 | if type(tup) is not TupleType: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 252 | raise PicklingError, "Value returned by %s must be a " \ |
| 253 | "tuple" % reduce |
| 254 | |
| 255 | l = len(tup) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 256 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 257 | if (l != 2) and (l != 3): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 258 | raise PicklingError, "tuple returned by %s must contain " \ |
| 259 | "only two or three elements" % reduce |
| 260 | |
| 261 | callable = tup[0] |
| 262 | arg_tup = tup[1] |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 263 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 264 | if l > 2: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 265 | state = tup[2] |
| 266 | else: |
| 267 | state = None |
| 268 | |
Guido van Rossum | d1f4984 | 1997-12-10 23:40:18 +0000 | [diff] [blame] | 269 | if type(arg_tup) is not TupleType and arg_tup is not None: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 270 | raise PicklingError, "Second element of tuple returned " \ |
| 271 | "by %s must be a tuple" % reduce |
| 272 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 273 | self.save_reduce(callable, arg_tup, state) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 274 | memo_len = len(memo) |
| 275 | self.write(self.put(memo_len)) |
| 276 | memo[d] = (memo_len, object) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 277 | return |
| 278 | |
| 279 | f(self, object) |
| 280 | |
| 281 | def persistent_id(self, object): |
| 282 | return None |
| 283 | |
| 284 | def inst_persistent_id(self, object): |
| 285 | return None |
| 286 | |
| 287 | def save_pers(self, pid): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 288 | if not self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 289 | self.write(PERSID + str(pid) + '\n') |
| 290 | else: |
| 291 | self.save(pid, 1) |
| 292 | self.write(BINPERSID) |
| 293 | |
| 294 | def save_reduce(self, callable, arg_tup, state = None): |
| 295 | write = self.write |
| 296 | save = self.save |
| 297 | |
| 298 | save(callable) |
| 299 | save(arg_tup) |
| 300 | write(REDUCE) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 301 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 302 | if state is not None: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 303 | save(state) |
| 304 | write(BUILD) |
| 305 | |
| 306 | dispatch = {} |
| 307 | |
| 308 | def save_none(self, object): |
| 309 | self.write(NONE) |
| 310 | dispatch[NoneType] = save_none |
| 311 | |
Guido van Rossum | 77f6a65 | 2002-04-03 22:41:51 +0000 | [diff] [blame] | 312 | def save_bool(self, object): |
| 313 | if object: |
| 314 | self.write(TRUE) |
| 315 | else: |
| 316 | self.write(FALSE) |
| 317 | dispatch[bool] = save_bool |
| 318 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 319 | def save_int(self, object): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 320 | if self.bin: |
Tim Peters | 4471400 | 2001-04-10 05:02:52 +0000 | [diff] [blame] | 321 | # If the int is small enough to fit in a signed 4-byte 2's-comp |
| 322 | # format, we can store it more efficiently than the general |
| 323 | # case. |
| 324 | high_bits = object >> 31 # note that Python shift sign-extends |
| 325 | if high_bits == 0 or high_bits == -1: |
| 326 | # All high bits are copies of bit 2**31, so the value |
| 327 | # fits in a 4-byte signed int. |
| 328 | i = mdumps(object)[1:] |
| 329 | assert len(i) == 4 |
| 330 | if i[-2:] == '\000\000': # fits in 2-byte unsigned int |
| 331 | if i[-3] == '\000': # fits in 1-byte unsigned int |
| 332 | self.write(BININT1 + i[0]) |
| 333 | else: |
| 334 | self.write(BININT2 + i[:2]) |
| 335 | else: |
| 336 | self.write(BININT + i) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 337 | return |
Tim Peters | 4471400 | 2001-04-10 05:02:52 +0000 | [diff] [blame] | 338 | # Text pickle, or int too big to fit in signed 4-byte format. |
| 339 | self.write(INT + `object` + '\n') |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 340 | dispatch[IntType] = save_int |
| 341 | |
| 342 | def save_long(self, object): |
| 343 | self.write(LONG + `object` + '\n') |
| 344 | dispatch[LongType] = save_long |
| 345 | |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 346 | def save_float(self, object, pack=struct.pack): |
| 347 | if self.bin: |
| 348 | self.write(BINFLOAT + pack('>d', object)) |
| 349 | else: |
| 350 | self.write(FLOAT + `object` + '\n') |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 351 | dispatch[FloatType] = save_float |
| 352 | |
| 353 | def save_string(self, object): |
| 354 | d = id(object) |
| 355 | memo = self.memo |
| 356 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 357 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 358 | l = len(object) |
| 359 | s = mdumps(l)[1:] |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 360 | if l < 256: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 361 | self.write(SHORT_BINSTRING + s[0] + object) |
| 362 | else: |
| 363 | self.write(BINSTRING + s + object) |
| 364 | else: |
| 365 | self.write(STRING + `object` + '\n') |
| 366 | |
| 367 | memo_len = len(memo) |
| 368 | self.write(self.put(memo_len)) |
| 369 | memo[d] = (memo_len, object) |
| 370 | dispatch[StringType] = save_string |
| 371 | |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 372 | def save_unicode(self, object): |
| 373 | d = id(object) |
| 374 | memo = self.memo |
| 375 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 376 | if self.bin: |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 377 | encoding = object.encode('utf-8') |
| 378 | l = len(encoding) |
| 379 | s = mdumps(l)[1:] |
| 380 | self.write(BINUNICODE + s + encoding) |
| 381 | else: |
Guido van Rossum | dbb718f | 2001-09-21 19:22:34 +0000 | [diff] [blame] | 382 | object = object.replace("\\", "\\u005c") |
| 383 | object = object.replace("\n", "\\u000a") |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 384 | self.write(UNICODE + object.encode('raw-unicode-escape') + '\n') |
| 385 | |
| 386 | memo_len = len(memo) |
| 387 | self.write(self.put(memo_len)) |
| 388 | memo[d] = (memo_len, object) |
| 389 | dispatch[UnicodeType] = save_unicode |
| 390 | |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 391 | if StringType == UnicodeType: |
| 392 | # This is true for Jython |
| 393 | def save_string(self, object): |
| 394 | d = id(object) |
| 395 | memo = self.memo |
| 396 | unicode = object.isunicode() |
| 397 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 398 | if self.bin: |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 399 | if unicode: |
| 400 | object = object.encode("utf-8") |
| 401 | l = len(object) |
| 402 | s = mdumps(l)[1:] |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 403 | if l < 256 and not unicode: |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 404 | self.write(SHORT_BINSTRING + s[0] + object) |
| 405 | else: |
| 406 | if unicode: |
| 407 | self.write(BINUNICODE + s + object) |
| 408 | else: |
| 409 | self.write(BINSTRING + s + object) |
| 410 | else: |
Tim Peters | 658cba6 | 2001-02-09 20:06:00 +0000 | [diff] [blame] | 411 | if unicode: |
Guido van Rossum | dbb718f | 2001-09-21 19:22:34 +0000 | [diff] [blame] | 412 | object = object.replace("\\", "\\u005c") |
| 413 | object = object.replace("\n", "\\u000a") |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 414 | object = object.encode('raw-unicode-escape') |
| 415 | self.write(UNICODE + object + '\n') |
| 416 | else: |
| 417 | self.write(STRING + `object` + '\n') |
| 418 | |
| 419 | memo_len = len(memo) |
| 420 | self.write(self.put(memo_len)) |
| 421 | memo[d] = (memo_len, object) |
| 422 | dispatch[StringType] = save_string |
Tim Peters | 658cba6 | 2001-02-09 20:06:00 +0000 | [diff] [blame] | 423 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 424 | def save_tuple(self, object): |
| 425 | |
| 426 | write = self.write |
| 427 | save = self.save |
| 428 | memo = self.memo |
| 429 | |
| 430 | d = id(object) |
| 431 | |
| 432 | write(MARK) |
| 433 | |
| 434 | for element in object: |
| 435 | save(element) |
| 436 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 437 | if len(object) and memo.has_key(d): |
| 438 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 439 | write(POP_MARK + self.get(memo[d][0])) |
| 440 | return |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 441 | |
Guido van Rossum | 599174f | 1998-03-31 16:30:28 +0000 | [diff] [blame] | 442 | write(POP * (len(object) + 1) + self.get(memo[d][0])) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 443 | return |
| 444 | |
| 445 | memo_len = len(memo) |
| 446 | self.write(TUPLE + self.put(memo_len)) |
| 447 | memo[d] = (memo_len, object) |
| 448 | dispatch[TupleType] = save_tuple |
| 449 | |
| 450 | def save_empty_tuple(self, object): |
| 451 | self.write(EMPTY_TUPLE) |
| 452 | |
| 453 | def save_list(self, object): |
| 454 | d = id(object) |
| 455 | |
| 456 | write = self.write |
| 457 | save = self.save |
| 458 | memo = self.memo |
| 459 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 460 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 461 | write(EMPTY_LIST) |
| 462 | else: |
| 463 | write(MARK + LIST) |
| 464 | |
| 465 | memo_len = len(memo) |
| 466 | write(self.put(memo_len)) |
| 467 | memo[d] = (memo_len, object) |
| 468 | |
| 469 | using_appends = (self.bin and (len(object) > 1)) |
| 470 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 471 | if using_appends: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 472 | write(MARK) |
| 473 | |
| 474 | for element in object: |
| 475 | save(element) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 476 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 477 | if not using_appends: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 478 | write(APPEND) |
| 479 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 480 | if using_appends: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 481 | write(APPENDS) |
| 482 | dispatch[ListType] = save_list |
| 483 | |
| 484 | def save_dict(self, object): |
| 485 | d = id(object) |
| 486 | |
| 487 | write = self.write |
| 488 | save = self.save |
| 489 | memo = self.memo |
| 490 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 491 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 492 | write(EMPTY_DICT) |
| 493 | else: |
| 494 | write(MARK + DICT) |
| 495 | |
| 496 | memo_len = len(memo) |
| 497 | self.write(self.put(memo_len)) |
| 498 | memo[d] = (memo_len, object) |
| 499 | |
| 500 | using_setitems = (self.bin and (len(object) > 1)) |
| 501 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 502 | if using_setitems: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 503 | write(MARK) |
| 504 | |
| 505 | items = object.items() |
| 506 | for key, value in items: |
| 507 | save(key) |
| 508 | save(value) |
| 509 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 510 | if not using_setitems: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 511 | write(SETITEM) |
| 512 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 513 | if using_setitems: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 514 | write(SETITEMS) |
| 515 | |
| 516 | dispatch[DictionaryType] = save_dict |
Jeremy Hylton | 2b9d029 | 1998-05-27 22:38:22 +0000 | [diff] [blame] | 517 | if not PyStringMap is None: |
| 518 | dispatch[PyStringMap] = save_dict |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 519 | |
| 520 | def save_inst(self, object): |
| 521 | d = id(object) |
| 522 | cls = object.__class__ |
| 523 | |
| 524 | memo = self.memo |
| 525 | write = self.write |
| 526 | save = self.save |
| 527 | |
| 528 | if hasattr(object, '__getinitargs__'): |
| 529 | args = object.__getinitargs__() |
| 530 | len(args) # XXX Assert it's a sequence |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 531 | _keep_alive(args, memo) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 532 | else: |
| 533 | args = () |
| 534 | |
| 535 | write(MARK) |
| 536 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 537 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 538 | save(cls) |
| 539 | |
| 540 | for arg in args: |
| 541 | save(arg) |
| 542 | |
| 543 | memo_len = len(memo) |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 544 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 545 | write(OBJ + self.put(memo_len)) |
| 546 | else: |
Guido van Rossum | 4fb5b28 | 1997-09-12 20:07:24 +0000 | [diff] [blame] | 547 | write(INST + cls.__module__ + '\n' + cls.__name__ + '\n' + |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 548 | self.put(memo_len)) |
| 549 | |
| 550 | memo[d] = (memo_len, object) |
| 551 | |
| 552 | try: |
| 553 | getstate = object.__getstate__ |
| 554 | except AttributeError: |
| 555 | stuff = object.__dict__ |
| 556 | else: |
| 557 | stuff = getstate() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 558 | _keep_alive(stuff, memo) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 559 | save(stuff) |
| 560 | write(BUILD) |
| 561 | dispatch[InstanceType] = save_inst |
| 562 | |
| 563 | def save_global(self, object, name = None): |
| 564 | write = self.write |
| 565 | memo = self.memo |
| 566 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 567 | if name is None: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 568 | name = object.__name__ |
| 569 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 570 | try: |
| 571 | module = object.__module__ |
| 572 | except AttributeError: |
| 573 | module = whichmodule(object, name) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 574 | |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 575 | try: |
| 576 | __import__(module) |
| 577 | mod = sys.modules[module] |
| 578 | klass = getattr(mod, name) |
| 579 | except (ImportError, KeyError, AttributeError): |
| 580 | raise PicklingError( |
| 581 | "Can't pickle %r: it's not found as %s.%s" % |
| 582 | (object, module, name)) |
| 583 | else: |
| 584 | if klass is not object: |
| 585 | raise PicklingError( |
| 586 | "Can't pickle %r: it's not the same object as %s.%s" % |
| 587 | (object, module, name)) |
| 588 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 589 | memo_len = len(memo) |
| 590 | write(GLOBAL + module + '\n' + name + '\n' + |
| 591 | self.put(memo_len)) |
| 592 | memo[id(object)] = (memo_len, object) |
| 593 | dispatch[ClassType] = save_global |
| 594 | dispatch[FunctionType] = save_global |
| 595 | dispatch[BuiltinFunctionType] = save_global |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 596 | dispatch[TypeType] = save_global |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 597 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 598 | |
Guido van Rossum | 5ed5c4c | 1997-09-03 00:23:54 +0000 | [diff] [blame] | 599 | def _keep_alive(x, memo): |
| 600 | """Keeps a reference to the object x in the memo. |
| 601 | |
| 602 | Because we remember objects by their id, we have |
| 603 | to assure that possibly temporary objects are kept |
| 604 | alive by referencing them. |
| 605 | We store a reference at the id of the memo, which should |
| 606 | normally not be used unless someone tries to deepcopy |
| 607 | the memo itself... |
| 608 | """ |
| 609 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 610 | memo[id(memo)].append(x) |
Guido van Rossum | 5ed5c4c | 1997-09-03 00:23:54 +0000 | [diff] [blame] | 611 | except KeyError: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 612 | # aha, this is the first one :-) |
| 613 | memo[id(memo)]=[x] |
Guido van Rossum | 5ed5c4c | 1997-09-03 00:23:54 +0000 | [diff] [blame] | 614 | |
| 615 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 616 | classmap = {} |
| 617 | |
Guido van Rossum | 4fb5b28 | 1997-09-12 20:07:24 +0000 | [diff] [blame] | 618 | # This is no longer used to find classes, but still for functions |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 619 | def whichmodule(cls, clsname): |
| 620 | """Figure out the module in which a class occurs. |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 621 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 622 | Search sys.modules for the module. |
| 623 | Cache in classmap. |
| 624 | Return a module name. |
| 625 | If the class cannot be found, return __main__. |
| 626 | """ |
| 627 | if classmap.has_key(cls): |
| 628 | return classmap[cls] |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 629 | |
| 630 | for name, module in sys.modules.items(): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 631 | if name != '__main__' and \ |
| 632 | hasattr(module, clsname) and \ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 633 | getattr(module, clsname) is cls: |
| 634 | break |
| 635 | else: |
| 636 | name = '__main__' |
| 637 | classmap[cls] = name |
| 638 | return name |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 639 | |
| 640 | |
| 641 | class Unpickler: |
| 642 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 643 | def __init__(self, file): |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame^] | 644 | """This takes a file-like object for reading a pickle data stream. |
| 645 | |
| 646 | This class automatically determines whether the data stream was |
| 647 | written in binary mode or not, so it does not need a flag as in |
| 648 | the Pickler class factory. |
| 649 | |
| 650 | The file-like object must have two methods, a read() method that |
| 651 | takes an integer argument, and a readline() method that requires no |
| 652 | arguments. Both methods should return a string. Thus file-like |
| 653 | object can be a file object opened for reading, a StringIO object, |
| 654 | or any other custom object that meets this interface. |
| 655 | |
| 656 | """ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 657 | self.readline = file.readline |
| 658 | self.read = file.read |
| 659 | self.memo = {} |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 660 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 661 | def load(self): |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame^] | 662 | """Read a pickled object representation from the open file object. |
| 663 | |
| 664 | Return the reconstituted object hierarchy specified in the file |
| 665 | object. |
| 666 | |
| 667 | """ |
Jeremy Hylton | 20747fa | 2001-11-09 16:15:04 +0000 | [diff] [blame] | 668 | self.mark = object() # any new unique object |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 669 | self.stack = [] |
| 670 | self.append = self.stack.append |
| 671 | read = self.read |
| 672 | dispatch = self.dispatch |
| 673 | try: |
| 674 | while 1: |
| 675 | key = read(1) |
| 676 | dispatch[key](self) |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 677 | except _Stop, stopinst: |
| 678 | return stopinst.value |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 679 | |
| 680 | def marker(self): |
| 681 | stack = self.stack |
| 682 | mark = self.mark |
| 683 | k = len(stack)-1 |
| 684 | while stack[k] is not mark: k = k-1 |
| 685 | return k |
| 686 | |
| 687 | dispatch = {} |
| 688 | |
| 689 | def load_eof(self): |
| 690 | raise EOFError |
| 691 | dispatch[''] = load_eof |
| 692 | |
| 693 | def load_persid(self): |
| 694 | pid = self.readline()[:-1] |
| 695 | self.append(self.persistent_load(pid)) |
| 696 | dispatch[PERSID] = load_persid |
| 697 | |
| 698 | def load_binpersid(self): |
| 699 | stack = self.stack |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 700 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 701 | pid = stack[-1] |
| 702 | del stack[-1] |
| 703 | |
| 704 | self.append(self.persistent_load(pid)) |
| 705 | dispatch[BINPERSID] = load_binpersid |
| 706 | |
| 707 | def load_none(self): |
| 708 | self.append(None) |
| 709 | dispatch[NONE] = load_none |
| 710 | |
| 711 | def load_int(self): |
Tim Peters | 19ef62d | 2001-08-28 22:21:18 +0000 | [diff] [blame] | 712 | data = self.readline() |
Guido van Rossum | e276339 | 2002-04-05 19:30:08 +0000 | [diff] [blame] | 713 | if data == FALSE[1:]: |
| 714 | val = False |
| 715 | elif data == TRUE[1:]: |
| 716 | val = True |
| 717 | else: |
| 718 | try: |
| 719 | val = int(data) |
| 720 | except ValueError: |
| 721 | val = long(data) |
| 722 | self.append(val) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 723 | dispatch[INT] = load_int |
| 724 | |
| 725 | def load_binint(self): |
| 726 | self.append(mloads('i' + self.read(4))) |
| 727 | dispatch[BININT] = load_binint |
| 728 | |
| 729 | def load_binint1(self): |
| 730 | self.append(mloads('i' + self.read(1) + '\000\000\000')) |
| 731 | dispatch[BININT1] = load_binint1 |
| 732 | |
| 733 | def load_binint2(self): |
| 734 | self.append(mloads('i' + self.read(2) + '\000\000')) |
| 735 | dispatch[BININT2] = load_binint2 |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 736 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 737 | def load_long(self): |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 738 | self.append(long(self.readline()[:-1], 0)) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 739 | dispatch[LONG] = load_long |
| 740 | |
| 741 | def load_float(self): |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 742 | self.append(float(self.readline()[:-1])) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 743 | dispatch[FLOAT] = load_float |
| 744 | |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 745 | def load_binfloat(self, unpack=struct.unpack): |
| 746 | self.append(unpack('>d', self.read(8))[0]) |
| 747 | dispatch[BINFLOAT] = load_binfloat |
| 748 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 749 | def load_string(self): |
Jeremy Hylton | be467e5 | 2000-09-15 15:14:51 +0000 | [diff] [blame] | 750 | rep = self.readline()[:-1] |
| 751 | if not self._is_string_secure(rep): |
| 752 | raise ValueError, "insecure string pickle" |
| 753 | self.append(eval(rep, |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 754 | {'__builtins__': {}})) # Let's be careful |
| 755 | dispatch[STRING] = load_string |
| 756 | |
Jeremy Hylton | be467e5 | 2000-09-15 15:14:51 +0000 | [diff] [blame] | 757 | def _is_string_secure(self, s): |
| 758 | """Return true if s contains a string that is safe to eval |
| 759 | |
| 760 | The definition of secure string is based on the implementation |
| 761 | in cPickle. s is secure as long as it only contains a quoted |
| 762 | string and optional trailing whitespace. |
| 763 | """ |
| 764 | q = s[0] |
| 765 | if q not in ("'", '"'): |
| 766 | return 0 |
| 767 | # find the closing quote |
| 768 | offset = 1 |
| 769 | i = None |
| 770 | while 1: |
| 771 | try: |
| 772 | i = s.index(q, offset) |
| 773 | except ValueError: |
| 774 | # if there is an error the first time, there is no |
| 775 | # close quote |
| 776 | if offset == 1: |
| 777 | return 0 |
| 778 | if s[i-1] != '\\': |
| 779 | break |
| 780 | # check to see if this one is escaped |
| 781 | nslash = 0 |
| 782 | j = i - 1 |
| 783 | while j >= offset and s[j] == '\\': |
| 784 | j = j - 1 |
| 785 | nslash = nslash + 1 |
| 786 | if nslash % 2 == 0: |
| 787 | break |
| 788 | offset = i + 1 |
| 789 | for c in s[i+1:]: |
| 790 | if ord(c) > 32: |
| 791 | return 0 |
| 792 | return 1 |
| 793 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 794 | def load_binstring(self): |
| 795 | len = mloads('i' + self.read(4)) |
| 796 | self.append(self.read(len)) |
| 797 | dispatch[BINSTRING] = load_binstring |
| 798 | |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 799 | def load_unicode(self): |
| 800 | self.append(unicode(self.readline()[:-1],'raw-unicode-escape')) |
| 801 | dispatch[UNICODE] = load_unicode |
| 802 | |
| 803 | def load_binunicode(self): |
| 804 | len = mloads('i' + self.read(4)) |
| 805 | self.append(unicode(self.read(len),'utf-8')) |
| 806 | dispatch[BINUNICODE] = load_binunicode |
| 807 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 808 | def load_short_binstring(self): |
| 809 | len = mloads('i' + self.read(1) + '\000\000\000') |
| 810 | self.append(self.read(len)) |
| 811 | dispatch[SHORT_BINSTRING] = load_short_binstring |
| 812 | |
| 813 | def load_tuple(self): |
| 814 | k = self.marker() |
| 815 | self.stack[k:] = [tuple(self.stack[k+1:])] |
| 816 | dispatch[TUPLE] = load_tuple |
| 817 | |
| 818 | def load_empty_tuple(self): |
| 819 | self.stack.append(()) |
| 820 | dispatch[EMPTY_TUPLE] = load_empty_tuple |
| 821 | |
| 822 | def load_empty_list(self): |
| 823 | self.stack.append([]) |
| 824 | dispatch[EMPTY_LIST] = load_empty_list |
| 825 | |
| 826 | def load_empty_dictionary(self): |
| 827 | self.stack.append({}) |
| 828 | dispatch[EMPTY_DICT] = load_empty_dictionary |
| 829 | |
| 830 | def load_list(self): |
| 831 | k = self.marker() |
| 832 | self.stack[k:] = [self.stack[k+1:]] |
| 833 | dispatch[LIST] = load_list |
| 834 | |
| 835 | def load_dict(self): |
| 836 | k = self.marker() |
| 837 | d = {} |
| 838 | items = self.stack[k+1:] |
| 839 | for i in range(0, len(items), 2): |
| 840 | key = items[i] |
| 841 | value = items[i+1] |
| 842 | d[key] = value |
| 843 | self.stack[k:] = [d] |
| 844 | dispatch[DICT] = load_dict |
| 845 | |
| 846 | def load_inst(self): |
| 847 | k = self.marker() |
| 848 | args = tuple(self.stack[k+1:]) |
| 849 | del self.stack[k:] |
| 850 | module = self.readline()[:-1] |
| 851 | name = self.readline()[:-1] |
| 852 | klass = self.find_class(module, name) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 853 | instantiated = 0 |
| 854 | if (not args and type(klass) is ClassType and |
| 855 | not hasattr(klass, "__getinitargs__")): |
| 856 | try: |
| 857 | value = _EmptyClass() |
| 858 | value.__class__ = klass |
Guido van Rossum | b19e2a3 | 1998-04-13 18:08:45 +0000 | [diff] [blame] | 859 | instantiated = 1 |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 860 | except RuntimeError: |
| 861 | # In restricted execution, assignment to inst.__class__ is |
| 862 | # prohibited |
| 863 | pass |
| 864 | if not instantiated: |
Guido van Rossum | 743d17e | 1998-09-15 20:25:57 +0000 | [diff] [blame] | 865 | try: |
Barry Warsaw | bf4d959 | 2001-11-15 23:42:58 +0000 | [diff] [blame] | 866 | if not hasattr(klass, '__safe_for_unpickling__'): |
| 867 | raise UnpicklingError('%s is not safe for unpickling' % |
| 868 | klass) |
Guido van Rossum | 743d17e | 1998-09-15 20:25:57 +0000 | [diff] [blame] | 869 | value = apply(klass, args) |
| 870 | except TypeError, err: |
| 871 | raise TypeError, "in constructor for %s: %s" % ( |
| 872 | klass.__name__, str(err)), sys.exc_info()[2] |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 873 | self.append(value) |
| 874 | dispatch[INST] = load_inst |
| 875 | |
| 876 | def load_obj(self): |
| 877 | stack = self.stack |
| 878 | k = self.marker() |
| 879 | klass = stack[k + 1] |
| 880 | del stack[k + 1] |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 881 | args = tuple(stack[k + 1:]) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 882 | del stack[k:] |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 883 | instantiated = 0 |
| 884 | if (not args and type(klass) is ClassType and |
| 885 | not hasattr(klass, "__getinitargs__")): |
| 886 | try: |
| 887 | value = _EmptyClass() |
| 888 | value.__class__ = klass |
| 889 | instantiated = 1 |
| 890 | except RuntimeError: |
| 891 | # In restricted execution, assignment to inst.__class__ is |
| 892 | # prohibited |
| 893 | pass |
| 894 | if not instantiated: |
| 895 | value = apply(klass, args) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 896 | self.append(value) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 897 | dispatch[OBJ] = load_obj |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 898 | |
| 899 | def load_global(self): |
| 900 | module = self.readline()[:-1] |
| 901 | name = self.readline()[:-1] |
| 902 | klass = self.find_class(module, name) |
| 903 | self.append(klass) |
| 904 | dispatch[GLOBAL] = load_global |
| 905 | |
| 906 | def find_class(self, module, name): |
Barry Warsaw | bf4d959 | 2001-11-15 23:42:58 +0000 | [diff] [blame] | 907 | __import__(module) |
| 908 | mod = sys.modules[module] |
| 909 | klass = getattr(mod, name) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 910 | return klass |
| 911 | |
| 912 | def load_reduce(self): |
| 913 | stack = self.stack |
| 914 | |
| 915 | callable = stack[-2] |
| 916 | arg_tup = stack[-1] |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 917 | del stack[-2:] |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 918 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 919 | if type(callable) is not ClassType: |
| 920 | if not safe_constructors.has_key(callable): |
| 921 | try: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 922 | safe = callable.__safe_for_unpickling__ |
| 923 | except AttributeError: |
| 924 | safe = None |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 925 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 926 | if not safe: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 927 | raise UnpicklingError, "%s is not safe for " \ |
| 928 | "unpickling" % callable |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 929 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 930 | if arg_tup is None: |
Raymond Hettinger | 97394bc | 2002-05-21 17:22:02 +0000 | [diff] [blame] | 931 | import warnings |
| 932 | warnings.warn("The None return argument form of __reduce__ is " |
| 933 | "deprecated. Return a tuple of arguments instead.", |
Tim Peters | 8ac1495 | 2002-05-23 15:15:30 +0000 | [diff] [blame] | 934 | DeprecationWarning) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 935 | value = callable.__basicnew__() |
| 936 | else: |
| 937 | value = apply(callable, arg_tup) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 938 | self.append(value) |
| 939 | dispatch[REDUCE] = load_reduce |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 940 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 941 | def load_pop(self): |
| 942 | del self.stack[-1] |
| 943 | dispatch[POP] = load_pop |
Guido van Rossum | 7b5430f | 1995-03-04 22:25:21 +0000 | [diff] [blame] | 944 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 945 | def load_pop_mark(self): |
| 946 | k = self.marker() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 947 | del self.stack[k:] |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 948 | dispatch[POP_MARK] = load_pop_mark |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 949 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 950 | def load_dup(self): |
Guido van Rossum | b1062fc | 1998-03-31 17:00:46 +0000 | [diff] [blame] | 951 | self.append(self.stack[-1]) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 952 | dispatch[DUP] = load_dup |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 953 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 954 | def load_get(self): |
| 955 | self.append(self.memo[self.readline()[:-1]]) |
| 956 | dispatch[GET] = load_get |
Guido van Rossum | 7853647 | 1996-04-12 13:36:27 +0000 | [diff] [blame] | 957 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 958 | def load_binget(self): |
| 959 | i = mloads('i' + self.read(1) + '\000\000\000') |
| 960 | self.append(self.memo[`i`]) |
| 961 | dispatch[BINGET] = load_binget |
Guido van Rossum | 7853647 | 1996-04-12 13:36:27 +0000 | [diff] [blame] | 962 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 963 | def load_long_binget(self): |
| 964 | i = mloads('i' + self.read(4)) |
| 965 | self.append(self.memo[`i`]) |
| 966 | dispatch[LONG_BINGET] = load_long_binget |
Guido van Rossum | 7853647 | 1996-04-12 13:36:27 +0000 | [diff] [blame] | 967 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 968 | def load_put(self): |
| 969 | self.memo[self.readline()[:-1]] = self.stack[-1] |
| 970 | dispatch[PUT] = load_put |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 971 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 972 | def load_binput(self): |
| 973 | i = mloads('i' + self.read(1) + '\000\000\000') |
| 974 | self.memo[`i`] = self.stack[-1] |
| 975 | dispatch[BINPUT] = load_binput |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 976 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 977 | def load_long_binput(self): |
| 978 | i = mloads('i' + self.read(4)) |
| 979 | self.memo[`i`] = self.stack[-1] |
| 980 | dispatch[LONG_BINPUT] = load_long_binput |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 981 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 982 | def load_append(self): |
| 983 | stack = self.stack |
| 984 | value = stack[-1] |
| 985 | del stack[-1] |
| 986 | list = stack[-1] |
| 987 | list.append(value) |
| 988 | dispatch[APPEND] = load_append |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 989 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 990 | def load_appends(self): |
| 991 | stack = self.stack |
| 992 | mark = self.marker() |
| 993 | list = stack[mark - 1] |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 994 | for i in range(mark + 1, len(stack)): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 995 | list.append(stack[i]) |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 996 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 997 | del stack[mark:] |
| 998 | dispatch[APPENDS] = load_appends |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 999 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1000 | def load_setitem(self): |
| 1001 | stack = self.stack |
| 1002 | value = stack[-1] |
| 1003 | key = stack[-2] |
| 1004 | del stack[-2:] |
| 1005 | dict = stack[-1] |
| 1006 | dict[key] = value |
| 1007 | dispatch[SETITEM] = load_setitem |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1008 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1009 | def load_setitems(self): |
| 1010 | stack = self.stack |
| 1011 | mark = self.marker() |
| 1012 | dict = stack[mark - 1] |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1013 | for i in range(mark + 1, len(stack), 2): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1014 | dict[stack[i]] = stack[i + 1] |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1015 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1016 | del stack[mark:] |
| 1017 | dispatch[SETITEMS] = load_setitems |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1018 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1019 | def load_build(self): |
| 1020 | stack = self.stack |
| 1021 | value = stack[-1] |
| 1022 | del stack[-1] |
| 1023 | inst = stack[-1] |
| 1024 | try: |
| 1025 | setstate = inst.__setstate__ |
| 1026 | except AttributeError: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1027 | try: |
| 1028 | inst.__dict__.update(value) |
| 1029 | except RuntimeError: |
| 1030 | # XXX In restricted execution, the instance's __dict__ is not |
| 1031 | # accessible. Use the old way of unpickling the instance |
| 1032 | # variables. This is a semantic different when unpickling in |
| 1033 | # restricted vs. unrestricted modes. |
| 1034 | for k, v in value.items(): |
| 1035 | setattr(inst, k, v) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1036 | else: |
| 1037 | setstate(value) |
| 1038 | dispatch[BUILD] = load_build |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1039 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1040 | def load_mark(self): |
| 1041 | self.append(self.mark) |
| 1042 | dispatch[MARK] = load_mark |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1043 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1044 | def load_stop(self): |
| 1045 | value = self.stack[-1] |
| 1046 | del self.stack[-1] |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 1047 | raise _Stop(value) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1048 | dispatch[STOP] = load_stop |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1049 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 1050 | # Helper class for load_inst/load_obj |
| 1051 | |
| 1052 | class _EmptyClass: |
| 1053 | pass |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1054 | |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1055 | # Shorthands |
| 1056 | |
Jeremy Hylton | abe2c62 | 2001-10-15 21:29:28 +0000 | [diff] [blame] | 1057 | try: |
| 1058 | from cStringIO import StringIO |
| 1059 | except ImportError: |
| 1060 | from StringIO import StringIO |
Guido van Rossum | c7c5e69 | 1996-07-22 22:26:07 +0000 | [diff] [blame] | 1061 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1062 | def dump(object, file, bin = 0): |
| 1063 | Pickler(file, bin).dump(object) |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1064 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1065 | def dumps(object, bin = 0): |
| 1066 | file = StringIO() |
| 1067 | Pickler(file, bin).dump(object) |
| 1068 | return file.getvalue() |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1069 | |
| 1070 | def load(file): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1071 | return Unpickler(file).load() |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1072 | |
| 1073 | def loads(str): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1074 | file = StringIO(str) |
| 1075 | return Unpickler(file).load() |