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