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