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 | b26a97a | 2003-01-28 22:29:13 +0000 | [diff] [blame] | 30 | from copy_reg import dispatch_table, _reconstructor |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 31 | from copy_reg import extension_registry, inverted_registry, extension_cache |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 32 | import marshal |
| 33 | import sys |
| 34 | import struct |
Skip Montanaro | 23bafc6 | 2001-02-18 03:10:09 +0000 | [diff] [blame] | 35 | import re |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 36 | import warnings |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 37 | |
Skip Montanaro | 352674d | 2001-02-07 23:14:30 +0000 | [diff] [blame] | 38 | __all__ = ["PickleError", "PicklingError", "UnpicklingError", "Pickler", |
| 39 | "Unpickler", "dump", "dumps", "load", "loads"] |
| 40 | |
Tim Peters | c0c12b5 | 2003-01-29 00:56:17 +0000 | [diff] [blame] | 41 | # These are purely informational; no code uses these. |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 42 | format_version = "2.0" # File format version we write |
| 43 | compatible_formats = ["1.0", # Original protocol 0 |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 44 | "1.1", # Protocol 0 with INST added |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 45 | "1.2", # Original protocol 1 |
| 46 | "1.3", # Protocol 1 with BINFLOAT added |
| 47 | "2.0", # Protocol 2 |
| 48 | ] # Old format versions we can read |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 49 | |
Guido van Rossum | e0b9042 | 2003-01-28 03:17:21 +0000 | [diff] [blame] | 50 | # Why use struct.pack() for pickling but marshal.loads() for |
Tim Peters | c0c12b5 | 2003-01-29 00:56:17 +0000 | [diff] [blame] | 51 | # unpickling? struct.pack() is 40% faster than marshal.dumps(), but |
Guido van Rossum | e0b9042 | 2003-01-28 03:17:21 +0000 | [diff] [blame] | 52 | # marshal.loads() is twice as fast as struct.unpack()! |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 53 | mloads = marshal.loads |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 54 | |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 55 | class PickleError(Exception): |
Neal Norwitz | efbb67b | 2002-05-30 12:12:04 +0000 | [diff] [blame] | 56 | """A common base class for the other pickling exceptions.""" |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 57 | pass |
| 58 | |
| 59 | class PicklingError(PickleError): |
| 60 | """This exception is raised when an unpicklable object is passed to the |
| 61 | dump() method. |
| 62 | |
| 63 | """ |
| 64 | pass |
| 65 | |
| 66 | class UnpicklingError(PickleError): |
| 67 | """This exception is raised when there is a problem unpickling an object, |
| 68 | such as a security violation. |
| 69 | |
| 70 | Note that other exceptions may also be raised during unpickling, including |
| 71 | (but not necessarily limited to) AttributeError, EOFError, ImportError, |
| 72 | and IndexError. |
| 73 | |
| 74 | """ |
| 75 | pass |
Guido van Rossum | 7849da8 | 1995-03-09 14:08:35 +0000 | [diff] [blame] | 76 | |
Tim Peters | c0c12b5 | 2003-01-29 00:56:17 +0000 | [diff] [blame] | 77 | # An instance of _Stop is raised by Unpickler.load_stop() in response to |
| 78 | # the STOP opcode, passing the object that is the result of unpickling. |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 79 | class _Stop(Exception): |
| 80 | def __init__(self, value): |
| 81 | self.value = value |
| 82 | |
Guido van Rossum | 533dbcf | 2003-01-28 17:55:05 +0000 | [diff] [blame] | 83 | # Jython has PyStringMap; it's a dict subclass with string keys |
Jeremy Hylton | 2b9d029 | 1998-05-27 22:38:22 +0000 | [diff] [blame] | 84 | try: |
| 85 | from org.python.core import PyStringMap |
| 86 | except ImportError: |
| 87 | PyStringMap = None |
| 88 | |
Guido van Rossum | 533dbcf | 2003-01-28 17:55:05 +0000 | [diff] [blame] | 89 | # UnicodeType may or may not be exported (normally imported from types) |
Guido van Rossum | dbb718f | 2001-09-21 19:22:34 +0000 | [diff] [blame] | 90 | try: |
| 91 | UnicodeType |
| 92 | except NameError: |
| 93 | UnicodeType = None |
| 94 | |
Tim Peters | 22a449a | 2003-01-27 20:16:36 +0000 | [diff] [blame] | 95 | # Pickle opcodes. See pickletools.py for extensive docs. The listing |
| 96 | # here is in kind-of alphabetical order of 1-character pickle code. |
| 97 | # pickletools groups them by purpose. |
Guido van Rossum | dbb718f | 2001-09-21 19:22:34 +0000 | [diff] [blame] | 98 | |
Tim Peters | 22a449a | 2003-01-27 20:16:36 +0000 | [diff] [blame] | 99 | MARK = '(' # push special markobject on stack |
| 100 | STOP = '.' # every pickle ends with STOP |
| 101 | POP = '0' # discard topmost stack item |
| 102 | POP_MARK = '1' # discard stack top through topmost markobject |
| 103 | DUP = '2' # duplicate top stack item |
| 104 | FLOAT = 'F' # push float object; decimal string argument |
| 105 | INT = 'I' # push integer or bool; decimal string argument |
| 106 | BININT = 'J' # push four-byte signed int |
| 107 | BININT1 = 'K' # push 1-byte unsigned int |
| 108 | LONG = 'L' # push long; decimal string argument |
| 109 | BININT2 = 'M' # push 2-byte unsigned int |
| 110 | NONE = 'N' # push None |
| 111 | PERSID = 'P' # push persistent object; id is taken from string arg |
| 112 | BINPERSID = 'Q' # " " " ; " " " " stack |
| 113 | REDUCE = 'R' # apply callable to argtuple, both on stack |
| 114 | STRING = 'S' # push string; NL-terminated string argument |
| 115 | BINSTRING = 'T' # push string; counted binary string argument |
| 116 | SHORT_BINSTRING = 'U' # " " ; " " " " < 256 bytes |
| 117 | UNICODE = 'V' # push Unicode string; raw-unicode-escaped'd argument |
| 118 | BINUNICODE = 'X' # " " " ; counted UTF-8 string argument |
| 119 | APPEND = 'a' # append stack top to list below it |
| 120 | BUILD = 'b' # call __setstate__ or __dict__.update() |
| 121 | GLOBAL = 'c' # push self.find_class(modname, name); 2 string args |
| 122 | DICT = 'd' # build a dict from stack items |
| 123 | EMPTY_DICT = '}' # push empty dict |
| 124 | APPENDS = 'e' # extend list on stack by topmost stack slice |
| 125 | GET = 'g' # push item from memo on stack; index is string arg |
| 126 | BINGET = 'h' # " " " " " " ; " " 1-byte arg |
| 127 | INST = 'i' # build & push class instance |
| 128 | LONG_BINGET = 'j' # push item from memo on stack; index is 4-byte arg |
| 129 | LIST = 'l' # build list from topmost stack items |
| 130 | EMPTY_LIST = ']' # push empty list |
| 131 | OBJ = 'o' # build & push class instance |
| 132 | PUT = 'p' # store stack top in memo; index is string arg |
| 133 | BINPUT = 'q' # " " " " " ; " " 1-byte arg |
| 134 | LONG_BINPUT = 'r' # " " " " " ; " " 4-byte arg |
| 135 | SETITEM = 's' # add key+value pair to dict |
| 136 | TUPLE = 't' # build tuple from topmost stack items |
| 137 | EMPTY_TUPLE = ')' # push empty tuple |
| 138 | SETITEMS = 'u' # modify dict by adding topmost key+value pairs |
| 139 | BINFLOAT = 'G' # push float; arg is 8-byte float encoding |
| 140 | |
| 141 | TRUE = 'I01\n' # not an opcode; see INT docs in pickletools.py |
| 142 | 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] | 143 | |
Guido van Rossum | 586c9e8 | 2003-01-29 06:16:12 +0000 | [diff] [blame] | 144 | # Protocol 2 |
Guido van Rossum | 5a2d8f5 | 2003-01-27 21:44:25 +0000 | [diff] [blame] | 145 | |
Tim Peters | e105478 | 2003-01-28 00:22:12 +0000 | [diff] [blame] | 146 | PROTO = '\x80' # identify pickle protocol |
| 147 | NEWOBJ = '\x81' # build object by applying cls.__new__ to argtuple |
| 148 | EXT1 = '\x82' # push object from extension registry; 1-byte index |
| 149 | EXT2 = '\x83' # ditto, but 2-byte index |
| 150 | EXT4 = '\x84' # ditto, but 4-byte index |
| 151 | TUPLE1 = '\x85' # build 1-tuple from stack top |
| 152 | TUPLE2 = '\x86' # build 2-tuple from two topmost stack items |
| 153 | TUPLE3 = '\x87' # build 3-tuple from three topmost stack items |
| 154 | NEWTRUE = '\x88' # push True |
| 155 | NEWFALSE = '\x89' # push False |
| 156 | LONG1 = '\x8a' # push long from < 256 bytes |
| 157 | LONG4 = '\x8b' # push really big long |
Guido van Rossum | 5a2d8f5 | 2003-01-27 21:44:25 +0000 | [diff] [blame] | 158 | |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 159 | _tuplesize2code = [EMPTY_TUPLE, TUPLE1, TUPLE2, TUPLE3] |
| 160 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 161 | |
Skip Montanaro | 23bafc6 | 2001-02-18 03:10:09 +0000 | [diff] [blame] | 162 | __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] | 163 | del x |
Skip Montanaro | 23bafc6 | 2001-02-18 03:10:09 +0000 | [diff] [blame] | 164 | |
Guido van Rossum | 1be3175 | 2003-01-28 15:19:53 +0000 | [diff] [blame] | 165 | |
| 166 | # Pickling machinery |
| 167 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 168 | class Pickler: |
| 169 | |
Guido van Rossum | 7eff63a | 2003-01-31 19:42:31 +0000 | [diff] [blame] | 170 | def __init__(self, file, proto=0): |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 171 | """This takes a file-like object for writing a pickle data stream. |
| 172 | |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 173 | The optional proto argument tells the pickler to use the given |
| 174 | protocol; supported protocols are 0, 1, 2. The default |
Guido van Rossum | 7eff63a | 2003-01-31 19:42:31 +0000 | [diff] [blame] | 175 | protocol is 0, to be backwards compatible. (Protocol 0 is the |
| 176 | only protocol that can be written to a file opened in text |
Tim Peters | 5bd2a79 | 2003-02-01 16:45:06 +0000 | [diff] [blame^] | 177 | mode and read back successfully. When using a protocol higher |
| 178 | than 0, make sure the file is opened in binary mode, both when |
| 179 | pickling and unpickling.) |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 180 | |
| 181 | Protocol 1 is more efficient than protocol 0; protocol 2 is |
Guido van Rossum | 7eff63a | 2003-01-31 19:42:31 +0000 | [diff] [blame] | 182 | more efficient than protocol 1. |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 183 | |
Guido van Rossum | 7eff63a | 2003-01-31 19:42:31 +0000 | [diff] [blame] | 184 | Specifying a negative protocol version selects the highest |
Tim Peters | 5bd2a79 | 2003-02-01 16:45:06 +0000 | [diff] [blame^] | 185 | protocol version supported. The higher the protocol used, the |
| 186 | more recent the version of Python needed to read the pickle |
| 187 | produced. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 188 | |
| 189 | The file parameter must have a write() method that accepts a single |
| 190 | string argument. It can thus be an open file object, a StringIO |
| 191 | object, or any other custom object that meets this interface. |
| 192 | |
| 193 | """ |
Guido van Rossum | 7eff63a | 2003-01-31 19:42:31 +0000 | [diff] [blame] | 194 | if proto < 0: |
| 195 | proto = 2 |
| 196 | elif proto not in (0, 1, 2): |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 197 | raise ValueError, "pickle protocol must be 0, 1 or 2" |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 198 | self.write = file.write |
| 199 | self.memo = {} |
Guido van Rossum | 1be3175 | 2003-01-28 15:19:53 +0000 | [diff] [blame] | 200 | self.proto = int(proto) |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 201 | self.bin = proto >= 1 |
Guido van Rossum | 5d9113d | 2003-01-29 17:58:45 +0000 | [diff] [blame] | 202 | self.fast = 0 |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 203 | |
Fred Drake | 7f781c9 | 2002-05-01 20:33:53 +0000 | [diff] [blame] | 204 | def clear_memo(self): |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 205 | """Clears the pickler's "memo". |
| 206 | |
| 207 | The memo is the data structure that remembers which objects the |
Tim Peters | b377f8a | 2003-01-28 00:23:36 +0000 | [diff] [blame] | 208 | pickler has already seen, so that shared or recursive objects are |
| 209 | pickled by reference and not by value. This method is useful when |
| 210 | re-using picklers. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 211 | |
| 212 | """ |
Fred Drake | 7f781c9 | 2002-05-01 20:33:53 +0000 | [diff] [blame] | 213 | self.memo.clear() |
| 214 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 215 | def dump(self, obj): |
Tim Peters | 5bd2a79 | 2003-02-01 16:45:06 +0000 | [diff] [blame^] | 216 | """Write a pickled representation of obj to the open file.""" |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 217 | if self.proto >= 2: |
| 218 | self.write(PROTO + chr(self.proto)) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 219 | self.save(obj) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 220 | self.write(STOP) |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 221 | |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 222 | def memoize(self, obj): |
| 223 | """Store an object in the memo.""" |
| 224 | |
Tim Peters | e46b73f | 2003-01-27 21:22:10 +0000 | [diff] [blame] | 225 | # The Pickler memo is a dictionary mapping object ids to 2-tuples |
| 226 | # that contain the Unpickler memo key and the object being memoized. |
| 227 | # The memo key is written to the pickle and will become |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 228 | # 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] | 229 | # Pickler memo so that transient objects are kept alive during |
| 230 | # pickling. |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 231 | |
Tim Peters | e46b73f | 2003-01-27 21:22:10 +0000 | [diff] [blame] | 232 | # The use of the Unpickler memo length as the memo key is just a |
| 233 | # convention. The only requirement is that the memo values be unique. |
| 234 | # But there appears no advantage to any other scheme, and this |
Tim Peters | cbd0a32 | 2003-01-28 00:24:43 +0000 | [diff] [blame] | 235 | # scheme allows the Unpickler memo to be implemented as a plain (but |
Tim Peters | e46b73f | 2003-01-27 21:22:10 +0000 | [diff] [blame] | 236 | # growable) array, indexed by memo key. |
Guido van Rossum | 5d9113d | 2003-01-29 17:58:45 +0000 | [diff] [blame] | 237 | if self.fast: |
| 238 | return |
Guido van Rossum | 9b40e80 | 2003-01-30 06:37:41 +0000 | [diff] [blame] | 239 | assert id(obj) not in self.memo |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 240 | memo_len = len(self.memo) |
| 241 | self.write(self.put(memo_len)) |
Tim Peters | 518df0d | 2003-01-28 01:00:38 +0000 | [diff] [blame] | 242 | self.memo[id(obj)] = memo_len, obj |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 243 | |
Tim Peters | bb38e30 | 2003-01-27 21:25:41 +0000 | [diff] [blame] | 244 | # Return a PUT (BINPUT, LONG_BINPUT) opcode string, with argument i. |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 245 | def put(self, i, pack=struct.pack): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 246 | if self.bin: |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 247 | if i < 256: |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 248 | return BINPUT + chr(i) |
| 249 | else: |
| 250 | return LONG_BINPUT + pack("<i", i) |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 251 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 252 | return PUT + `i` + '\n' |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 253 | |
Tim Peters | bb38e30 | 2003-01-27 21:25:41 +0000 | [diff] [blame] | 254 | # Return a GET (BINGET, LONG_BINGET) opcode string, with argument i. |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 255 | def get(self, i, pack=struct.pack): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 256 | if self.bin: |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 257 | if i < 256: |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 258 | return BINGET + chr(i) |
| 259 | else: |
| 260 | return LONG_BINGET + pack("<i", i) |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 261 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 262 | return GET + `i` + '\n' |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 263 | |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 264 | def save(self, obj): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 265 | # Check for persistent id (defined by a subclass) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 266 | pid = self.persistent_id(obj) |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 267 | if pid: |
Jeremy Hylton | 5e0f4e7 | 2002-11-13 22:01:27 +0000 | [diff] [blame] | 268 | self.save_pers(pid) |
| 269 | return |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 270 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 271 | # Check the memo |
| 272 | x = self.memo.get(id(obj)) |
| 273 | if x: |
| 274 | self.write(self.get(x[0])) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 275 | return |
| 276 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 277 | # Check the type dispatch table |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 278 | t = type(obj) |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 279 | f = self.dispatch.get(t) |
| 280 | if f: |
| 281 | f(self, obj) # Call unbound method with explicit self |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 282 | return |
| 283 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 284 | # Check for a class with a custom metaclass; treat as regular class |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 285 | try: |
| 286 | issc = issubclass(t, TypeType) |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 287 | except TypeError: # t is not a class (old Boost; see SF #502085) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 288 | issc = 0 |
| 289 | if issc: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 290 | self.save_global(obj) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 291 | return |
| 292 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 293 | # Check copy_reg.dispatch_table |
| 294 | reduce = dispatch_table.get(t) |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 295 | if not reduce: |
| 296 | # Check for a __reduce__ method. |
| 297 | # Subtle: get the unbound method from the class, so that |
| 298 | # protocol 2 can override the default __reduce__ that all |
| 299 | # classes inherit from object. This has the added |
| 300 | # advantage that the call always has the form reduce(obj) |
| 301 | reduce = getattr(t, "__reduce__", None) |
| 302 | if self.proto >= 2: |
| 303 | # Protocol 2 can do better than the default __reduce__ |
| 304 | if reduce is object.__reduce__: |
| 305 | reduce = None |
| 306 | if not reduce: |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 307 | self.save_newobj(obj) |
| 308 | return |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 309 | if not reduce: |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 310 | raise PicklingError("Can't pickle %r object: %r" % |
| 311 | (t.__name__, obj)) |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 312 | rv = reduce(obj) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 313 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 314 | # Check for string returned by reduce(), meaning "save as global" |
| 315 | if type(rv) is StringType: |
| 316 | self.save_global(obj, rv) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 317 | return |
| 318 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 319 | # Assert that reduce() returned a tuple |
| 320 | if type(rv) is not TupleType: |
| 321 | raise PicklingError("%s must return string or tuple" % reduce) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 322 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 323 | # Assert that it returned an appropriately sized tuple |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 324 | l = len(rv) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 325 | if not (2 <= l <= 5): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 326 | raise PicklingError("Tuple returned by %s must have " |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 327 | "two to five elements" % reduce) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 328 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 329 | # Save the reduce() output and finally memoize the object |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 330 | self.save_reduce(obj=obj, *rv) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 331 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 332 | def persistent_id(self, obj): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 333 | # This exists so a subclass can override it |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 334 | return None |
| 335 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 336 | def save_pers(self, pid): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 337 | # Save a persistent id reference |
Tim Peters | bd1cdb9 | 2003-01-28 01:03:10 +0000 | [diff] [blame] | 338 | if self.bin: |
Jeremy Hylton | 5e0f4e7 | 2002-11-13 22:01:27 +0000 | [diff] [blame] | 339 | self.save(pid) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 340 | self.write(BINPERSID) |
Tim Peters | bd1cdb9 | 2003-01-28 01:03:10 +0000 | [diff] [blame] | 341 | else: |
| 342 | self.write(PERSID + str(pid) + '\n') |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 343 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 344 | def save_reduce(self, func, args, state=None, |
| 345 | listitems=None, dictitems=None, obj=None): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 346 | # This API is be called by some subclasses |
| 347 | |
| 348 | # Assert that args is a tuple or None |
| 349 | if not isinstance(args, TupleType): |
| 350 | if args is None: |
| 351 | # A hack for Jim Fulton's ExtensionClass, now deprecated. |
| 352 | # See load_reduce() |
| 353 | warnings.warn("__basicnew__ special case is deprecated", |
| 354 | DeprecationWarning) |
| 355 | else: |
| 356 | raise PicklingError( |
| 357 | "args from reduce() should be a tuple") |
| 358 | |
| 359 | # Assert that func is callable |
| 360 | if not callable(func): |
| 361 | raise PicklingError("func from reduce should be callable") |
| 362 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 363 | save = self.save |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 364 | write = self.write |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 365 | |
Guido van Rossum | d053b4b | 2003-01-31 16:51:45 +0000 | [diff] [blame] | 366 | # Protocol 2 special case: if func's name is __newobj__, use NEWOBJ |
| 367 | if self.proto >= 2 and getattr(func, "__name__", "") == "__newobj__": |
| 368 | # A __reduce__ implementation can direct protocol 2 to |
| 369 | # use the more efficient NEWOBJ opcode, while still |
| 370 | # allowing protocol 0 and 1 to work normally. For this to |
| 371 | # work, the function returned by __reduce__ should be |
| 372 | # called __newobj__, and its first argument should be a |
| 373 | # new-style class. The implementation for __newobj__ |
| 374 | # should be as follows, although pickle has no way to |
| 375 | # verify this: |
| 376 | # |
| 377 | # def __newobj__(cls, *args): |
| 378 | # return cls.__new__(cls, *args) |
| 379 | # |
| 380 | # Protocols 0 and 1 will pickle a reference to __newobj__, |
| 381 | # while protocol 2 (and above) will pickle a reference to |
| 382 | # cls, the remaining args tuple, and the NEWOBJ code, |
| 383 | # which calls cls.__new__(cls, *args) at unpickling time |
| 384 | # (see load_newobj below). If __reduce__ returns a |
| 385 | # three-tuple, the state from the third tuple item will be |
| 386 | # pickled regardless of the protocol, calling __setstate__ |
| 387 | # at unpickling time (see load_build below). |
| 388 | # |
| 389 | # Note that no standard __newobj__ implementation exists; |
| 390 | # you have to provide your own. This is to enforce |
| 391 | # compatibility with Python 2.2 (pickles written using |
| 392 | # protocol 0 or 1 in Python 2.3 should be unpicklable by |
| 393 | # Python 2.2). |
| 394 | cls = args[0] |
| 395 | if not hasattr(cls, "__new__"): |
| 396 | raise PicklingError( |
| 397 | "args[0] from __newobj__ args has no __new__") |
Guido van Rossum | f7f4517 | 2003-01-31 17:17:49 +0000 | [diff] [blame] | 398 | if obj is not None and cls is not obj.__class__: |
| 399 | raise PicklingError( |
| 400 | "args[0] from __newobj__ args has the wrong class") |
Guido van Rossum | d053b4b | 2003-01-31 16:51:45 +0000 | [diff] [blame] | 401 | args = args[1:] |
| 402 | save(cls) |
| 403 | save(args) |
| 404 | write(NEWOBJ) |
| 405 | else: |
| 406 | save(func) |
| 407 | save(args) |
| 408 | write(REDUCE) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 409 | |
Guido van Rossum | f7f4517 | 2003-01-31 17:17:49 +0000 | [diff] [blame] | 410 | if obj is not None: |
| 411 | self.memoize(obj) |
| 412 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 413 | # More new special cases (that work with older protocols as |
| 414 | # well): when __reduce__ returns a tuple with 4 or 5 items, |
| 415 | # the 4th and 5th item should be iterators that provide list |
| 416 | # items and dict items (as (key, value) tuples), or None. |
| 417 | |
| 418 | if listitems is not None: |
| 419 | self._batch_appends(listitems) |
| 420 | |
| 421 | if dictitems is not None: |
| 422 | self._batch_setitems(dictitems) |
| 423 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 424 | if state is not None: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 425 | save(state) |
| 426 | write(BUILD) |
| 427 | |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 428 | def save_newobj(self, obj): |
| 429 | # Save a new-style class instance, using protocol 2. |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 430 | assert self.proto >= 2 # This only works for protocol 2 |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 431 | t = type(obj) |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 432 | getnewargs = getattr(obj, "__getnewargs__", None) |
| 433 | if getnewargs: |
Neal Norwitz | d174068 | 2003-01-31 04:04:23 +0000 | [diff] [blame] | 434 | args = getnewargs() # This better not reference obj |
Guido van Rossum | 3d8c01b | 2003-01-28 19:48:18 +0000 | [diff] [blame] | 435 | else: |
Guido van Rossum | 5d9113d | 2003-01-29 17:58:45 +0000 | [diff] [blame] | 436 | args = () |
Guido van Rossum | 3d8c01b | 2003-01-28 19:48:18 +0000 | [diff] [blame] | 437 | |
| 438 | save = self.save |
| 439 | write = self.write |
| 440 | |
Guido van Rossum | 9b40e80 | 2003-01-30 06:37:41 +0000 | [diff] [blame] | 441 | self.save(t) |
Guido van Rossum | 3d8c01b | 2003-01-28 19:48:18 +0000 | [diff] [blame] | 442 | save(args) |
| 443 | write(NEWOBJ) |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 444 | self.memoize(obj) |
Guido van Rossum | 3d8c01b | 2003-01-28 19:48:18 +0000 | [diff] [blame] | 445 | |
| 446 | if isinstance(obj, list): |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 447 | self._batch_appends(iter(obj)) |
Guido van Rossum | 3d8c01b | 2003-01-28 19:48:18 +0000 | [diff] [blame] | 448 | elif isinstance(obj, dict): |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 449 | self._batch_setitems(obj.iteritems()) |
Guido van Rossum | 3d8c01b | 2003-01-28 19:48:18 +0000 | [diff] [blame] | 450 | |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 451 | getstate = getattr(obj, "__getstate__", None) |
Guido van Rossum | 4548617 | 2003-01-30 05:39:04 +0000 | [diff] [blame] | 452 | |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 453 | if getstate: |
Guido van Rossum | 4fba220 | 2003-01-30 05:41:19 +0000 | [diff] [blame] | 454 | # A class may define both __getstate__ and __getnewargs__. |
| 455 | # If they are the same function, we ignore __getstate__. |
| 456 | # This is for the benefit of protocols 0 and 1, which don't |
| 457 | # use __getnewargs__. Note that the only way to make them |
| 458 | # the same function is something like this: |
| 459 | # |
| 460 | # class C(object): |
| 461 | # def __getstate__(self): |
| 462 | # return ... |
| 463 | # __getnewargs__ = __getstate__ |
| 464 | # |
| 465 | # No tricks are needed to ignore __setstate__; it simply |
| 466 | # won't be called when we don't generate BUILD. |
| 467 | # Also note that when __getnewargs__ and __getstate__ are |
| 468 | # the same function, we don't do the default thing of |
| 469 | # looking for __dict__ and slots either -- it is assumed |
| 470 | # that __getnewargs__ returns all the state there is |
| 471 | # (which should be a safe assumption since __getstate__ |
| 472 | # returns the *same* state). |
| 473 | if getstate == getnewargs: |
| 474 | return |
| 475 | |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 476 | try: |
| 477 | state = getstate() |
| 478 | except TypeError, err: |
| 479 | # XXX Catch generic exception caused by __slots__ |
| 480 | if str(err) != ("a class that defines __slots__ " |
| 481 | "without defining __getstate__ " |
| 482 | "cannot be pickled"): |
| 483 | print repr(str(err)) |
| 484 | raise # Not that specific exception |
| 485 | getstate = None |
Guido van Rossum | 4fba220 | 2003-01-30 05:41:19 +0000 | [diff] [blame] | 486 | |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 487 | if not getstate: |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 488 | state = getattr(obj, "__dict__", None) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 489 | if not state: |
| 490 | state = None |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 491 | # If there are slots, the state becomes a tuple of two |
| 492 | # items: the first item the regular __dict__ or None, and |
| 493 | # the second a dict mapping slot names to slot values |
| 494 | names = _slotnames(t) |
| 495 | if names: |
| 496 | slots = {} |
| 497 | nil = [] |
| 498 | for name in names: |
| 499 | value = getattr(obj, name, nil) |
| 500 | if value is not nil: |
| 501 | slots[name] = value |
| 502 | if slots: |
| 503 | state = (state, slots) |
| 504 | |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 505 | if state is not None: |
Guido van Rossum | 3d8c01b | 2003-01-28 19:48:18 +0000 | [diff] [blame] | 506 | save(state) |
| 507 | write(BUILD) |
Guido van Rossum | 54fb192 | 2003-01-28 18:22:35 +0000 | [diff] [blame] | 508 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 509 | # Methods below this point are dispatched through the dispatch table |
| 510 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 511 | dispatch = {} |
| 512 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 513 | def save_none(self, obj): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 514 | self.write(NONE) |
| 515 | dispatch[NoneType] = save_none |
| 516 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 517 | def save_bool(self, obj): |
Guido van Rossum | 7d97d31 | 2003-01-28 04:25:27 +0000 | [diff] [blame] | 518 | if self.proto >= 2: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 519 | self.write(obj and NEWTRUE or NEWFALSE) |
Guido van Rossum | 7d97d31 | 2003-01-28 04:25:27 +0000 | [diff] [blame] | 520 | else: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 521 | self.write(obj and TRUE or FALSE) |
Guido van Rossum | 77f6a65 | 2002-04-03 22:41:51 +0000 | [diff] [blame] | 522 | dispatch[bool] = save_bool |
| 523 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 524 | def save_int(self, obj, pack=struct.pack): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 525 | if self.bin: |
Tim Peters | 4471400 | 2001-04-10 05:02:52 +0000 | [diff] [blame] | 526 | # If the int is small enough to fit in a signed 4-byte 2's-comp |
| 527 | # format, we can store it more efficiently than the general |
| 528 | # case. |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 529 | # First one- and two-byte unsigned ints: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 530 | if obj >= 0: |
| 531 | if obj <= 0xff: |
| 532 | self.write(BININT1 + chr(obj)) |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 533 | return |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 534 | if obj <= 0xffff: |
Guido van Rossum | ba884f3 | 2003-01-29 20:14:23 +0000 | [diff] [blame] | 535 | self.write("%c%c%c" % (BININT2, obj&0xff, obj>>8)) |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 536 | return |
| 537 | # Next check for 4-byte signed ints: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 538 | high_bits = obj >> 31 # note that Python shift sign-extends |
Tim Peters | d95c2df | 2003-01-28 03:41:54 +0000 | [diff] [blame] | 539 | if high_bits == 0 or high_bits == -1: |
Tim Peters | 4471400 | 2001-04-10 05:02:52 +0000 | [diff] [blame] | 540 | # All high bits are copies of bit 2**31, so the value |
| 541 | # fits in a 4-byte signed int. |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 542 | self.write(BININT + pack("<i", obj)) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 543 | return |
Tim Peters | 4471400 | 2001-04-10 05:02:52 +0000 | [diff] [blame] | 544 | # Text pickle, or int too big to fit in signed 4-byte format. |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 545 | self.write(INT + `obj` + '\n') |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 546 | dispatch[IntType] = save_int |
| 547 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 548 | def save_long(self, obj, pack=struct.pack): |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 549 | if self.proto >= 2: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 550 | bytes = encode_long(obj) |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 551 | n = len(bytes) |
| 552 | if n < 256: |
| 553 | self.write(LONG1 + chr(n) + bytes) |
| 554 | else: |
| 555 | self.write(LONG4 + pack("<i", n) + bytes) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 556 | self.write(LONG + `obj` + '\n') |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 557 | dispatch[LongType] = save_long |
| 558 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 559 | def save_float(self, obj, pack=struct.pack): |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 560 | if self.bin: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 561 | self.write(BINFLOAT + pack('>d', obj)) |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 562 | else: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 563 | self.write(FLOAT + `obj` + '\n') |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 564 | dispatch[FloatType] = save_float |
| 565 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 566 | def save_string(self, obj, pack=struct.pack): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 567 | if self.bin: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 568 | n = len(obj) |
Tim Peters | bbf63cd | 2003-01-27 21:15:36 +0000 | [diff] [blame] | 569 | if n < 256: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 570 | self.write(SHORT_BINSTRING + chr(n) + obj) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 571 | else: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 572 | self.write(BINSTRING + pack("<i", n) + obj) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 573 | else: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 574 | self.write(STRING + `obj` + '\n') |
| 575 | self.memoize(obj) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 576 | dispatch[StringType] = save_string |
| 577 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 578 | def save_unicode(self, obj, pack=struct.pack): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 579 | if self.bin: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 580 | encoding = obj.encode('utf-8') |
Tim Peters | bbf63cd | 2003-01-27 21:15:36 +0000 | [diff] [blame] | 581 | n = len(encoding) |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 582 | self.write(BINUNICODE + pack("<i", n) + encoding) |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 583 | else: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 584 | obj = obj.replace("\\", "\\u005c") |
| 585 | obj = obj.replace("\n", "\\u000a") |
| 586 | self.write(UNICODE + obj.encode('raw-unicode-escape') + '\n') |
| 587 | self.memoize(obj) |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 588 | dispatch[UnicodeType] = save_unicode |
| 589 | |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 590 | if StringType == UnicodeType: |
| 591 | # This is true for Jython |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 592 | def save_string(self, obj, pack=struct.pack): |
| 593 | unicode = obj.isunicode() |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 594 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 595 | if self.bin: |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 596 | if unicode: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 597 | obj = obj.encode("utf-8") |
| 598 | l = len(obj) |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 599 | if l < 256 and not unicode: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 600 | self.write(SHORT_BINSTRING + chr(l) + obj) |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 601 | else: |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 602 | s = pack("<i", l) |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 603 | if unicode: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 604 | self.write(BINUNICODE + s + obj) |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 605 | else: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 606 | self.write(BINSTRING + s + obj) |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 607 | else: |
Tim Peters | 658cba6 | 2001-02-09 20:06:00 +0000 | [diff] [blame] | 608 | if unicode: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 609 | obj = obj.replace("\\", "\\u005c") |
| 610 | obj = obj.replace("\n", "\\u000a") |
| 611 | obj = obj.encode('raw-unicode-escape') |
| 612 | self.write(UNICODE + obj + '\n') |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 613 | else: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 614 | self.write(STRING + `obj` + '\n') |
| 615 | self.memoize(obj) |
Guido van Rossum | 31584cb | 2001-01-22 14:53:29 +0000 | [diff] [blame] | 616 | dispatch[StringType] = save_string |
Tim Peters | 658cba6 | 2001-02-09 20:06:00 +0000 | [diff] [blame] | 617 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 618 | def save_tuple(self, obj): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 619 | write = self.write |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 620 | proto = self.proto |
| 621 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 622 | n = len(obj) |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 623 | if n == 0 and proto: |
| 624 | write(EMPTY_TUPLE) |
| 625 | return |
| 626 | |
| 627 | save = self.save |
| 628 | memo = self.memo |
| 629 | if n <= 3 and proto >= 2: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 630 | for element in obj: |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 631 | save(element) |
| 632 | # Subtle. Same as in the big comment below. |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 633 | if id(obj) in memo: |
| 634 | get = self.get(memo[id(obj)][0]) |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 635 | write(POP * n + get) |
| 636 | else: |
| 637 | write(_tuplesize2code[n]) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 638 | self.memoize(obj) |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 639 | return |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 640 | |
Tim Peters | ff57bff | 2003-01-28 05:34:53 +0000 | [diff] [blame] | 641 | # proto 0, or proto 1 and tuple isn't empty, or proto > 1 and tuple |
| 642 | # has more than 3 elements. |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 643 | write(MARK) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 644 | for element in obj: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 645 | save(element) |
| 646 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 647 | if n and id(obj) in memo: |
Tim Peters | f558da0 | 2003-01-28 02:09:55 +0000 | [diff] [blame] | 648 | # Subtle. d was not in memo when we entered save_tuple(), so |
| 649 | # the process of saving the tuple's elements must have saved |
| 650 | # the tuple itself: the tuple is recursive. The proper action |
| 651 | # now is to throw away everything we put on the stack, and |
| 652 | # simply GET the tuple (it's already constructed). This check |
| 653 | # could have been done in the "for element" loop instead, but |
| 654 | # recursive tuples are a rare thing. |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 655 | get = self.get(memo[id(obj)][0]) |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 656 | if proto: |
Tim Peters | f558da0 | 2003-01-28 02:09:55 +0000 | [diff] [blame] | 657 | write(POP_MARK + get) |
| 658 | else: # proto 0 -- POP_MARK not available |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 659 | write(POP * (n+1) + get) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 660 | return |
| 661 | |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 662 | # No recursion (including the empty-tuple case for protocol 0). |
Tim Peters | 518df0d | 2003-01-28 01:00:38 +0000 | [diff] [blame] | 663 | self.write(TUPLE) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 664 | if obj: # No need to memoize empty tuple |
| 665 | self.memoize(obj) |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 666 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 667 | dispatch[TupleType] = save_tuple |
| 668 | |
Tim Peters | a6ae9a2 | 2003-01-28 16:58:41 +0000 | [diff] [blame] | 669 | # save_empty_tuple() isn't used by anything in Python 2.3. However, I |
| 670 | # found a Pickler subclass in Zope3 that calls it, so it's not harmless |
| 671 | # to remove it. |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 672 | def save_empty_tuple(self, obj): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 673 | self.write(EMPTY_TUPLE) |
| 674 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 675 | def save_list(self, obj): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 676 | write = self.write |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 677 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 678 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 679 | write(EMPTY_LIST) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 680 | else: # proto 0 -- can't use EMPTY_LIST |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 681 | write(MARK + LIST) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 682 | |
| 683 | self.memoize(obj) |
| 684 | self._batch_appends(iter(obj)) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 685 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 686 | dispatch[ListType] = save_list |
| 687 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 688 | _BATCHSIZE = 1000 |
| 689 | |
| 690 | def _batch_appends(self, items): |
| 691 | # Helper to batch up APPENDS sequences |
| 692 | save = self.save |
| 693 | write = self.write |
| 694 | |
| 695 | if not self.bin: |
| 696 | for x in items: |
| 697 | save(x) |
| 698 | write(APPEND) |
| 699 | return |
| 700 | |
| 701 | r = xrange(self._BATCHSIZE) |
| 702 | while items is not None: |
| 703 | tmp = [] |
| 704 | for i in r: |
| 705 | try: |
| 706 | tmp.append(items.next()) |
| 707 | except StopIteration: |
| 708 | items = None |
| 709 | break |
| 710 | n = len(tmp) |
| 711 | if n > 1: |
| 712 | write(MARK) |
| 713 | for x in tmp: |
| 714 | save(x) |
| 715 | write(APPENDS) |
| 716 | elif n: |
| 717 | save(tmp[0]) |
| 718 | write(APPEND) |
| 719 | # else tmp is empty, and we're done |
| 720 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 721 | def save_dict(self, obj): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 722 | write = self.write |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 723 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 724 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 725 | write(EMPTY_DICT) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 726 | else: # proto 0 -- can't use EMPTY_DICT |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 727 | write(MARK + DICT) |
| 728 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 729 | self.memoize(obj) |
| 730 | self._batch_setitems(obj.iteritems()) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 731 | |
| 732 | dispatch[DictionaryType] = save_dict |
Jeremy Hylton | 2b9d029 | 1998-05-27 22:38:22 +0000 | [diff] [blame] | 733 | if not PyStringMap is None: |
| 734 | dispatch[PyStringMap] = save_dict |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 735 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 736 | def _batch_setitems(self, items): |
| 737 | # Helper to batch up SETITEMS sequences; proto >= 1 only |
| 738 | save = self.save |
| 739 | write = self.write |
| 740 | |
| 741 | if not self.bin: |
| 742 | for k, v in items: |
| 743 | save(k) |
| 744 | save(v) |
| 745 | write(SETITEM) |
| 746 | return |
| 747 | |
| 748 | r = xrange(self._BATCHSIZE) |
| 749 | while items is not None: |
| 750 | tmp = [] |
| 751 | for i in r: |
| 752 | try: |
| 753 | tmp.append(items.next()) |
| 754 | except StopIteration: |
| 755 | items = None |
| 756 | break |
| 757 | n = len(tmp) |
| 758 | if n > 1: |
| 759 | write(MARK) |
| 760 | for k, v in tmp: |
| 761 | save(k) |
| 762 | save(v) |
| 763 | write(SETITEMS) |
| 764 | elif n: |
| 765 | k, v = tmp[0] |
| 766 | save(k) |
| 767 | save(v) |
| 768 | write(SETITEM) |
| 769 | # else tmp is empty, and we're done |
| 770 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 771 | def save_inst(self, obj): |
| 772 | cls = obj.__class__ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 773 | |
| 774 | memo = self.memo |
| 775 | write = self.write |
| 776 | save = self.save |
| 777 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 778 | if hasattr(obj, '__getinitargs__'): |
| 779 | args = obj.__getinitargs__() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 780 | len(args) # XXX Assert it's a sequence |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 781 | _keep_alive(args, memo) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 782 | else: |
| 783 | args = () |
| 784 | |
| 785 | write(MARK) |
| 786 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 787 | if self.bin: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 788 | save(cls) |
Tim Peters | 3b76983 | 2003-01-28 03:51:36 +0000 | [diff] [blame] | 789 | for arg in args: |
| 790 | save(arg) |
| 791 | write(OBJ) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 792 | else: |
Tim Peters | 3b76983 | 2003-01-28 03:51:36 +0000 | [diff] [blame] | 793 | for arg in args: |
| 794 | save(arg) |
| 795 | write(INST + cls.__module__ + '\n' + cls.__name__ + '\n') |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 796 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 797 | self.memoize(obj) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 798 | |
| 799 | try: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 800 | getstate = obj.__getstate__ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 801 | except AttributeError: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 802 | stuff = obj.__dict__ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 803 | else: |
| 804 | stuff = getstate() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 805 | _keep_alive(stuff, memo) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 806 | save(stuff) |
| 807 | write(BUILD) |
Tim Peters | 3b76983 | 2003-01-28 03:51:36 +0000 | [diff] [blame] | 808 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 809 | dispatch[InstanceType] = save_inst |
| 810 | |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 811 | def save_global(self, obj, name=None, pack=struct.pack): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 812 | write = self.write |
| 813 | memo = self.memo |
| 814 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 815 | if name is None: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 816 | name = obj.__name__ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 817 | |
Jeremy Hylton | 4f0dcc9 | 2003-01-31 18:33:18 +0000 | [diff] [blame] | 818 | module = getattr(obj, "__module__", None) |
| 819 | if module is None: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 820 | module = whichmodule(obj, name) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 821 | |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 822 | try: |
| 823 | __import__(module) |
| 824 | mod = sys.modules[module] |
| 825 | klass = getattr(mod, name) |
| 826 | except (ImportError, KeyError, AttributeError): |
| 827 | raise PicklingError( |
| 828 | "Can't pickle %r: it's not found as %s.%s" % |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 829 | (obj, module, name)) |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 830 | else: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 831 | if klass is not obj: |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 832 | raise PicklingError( |
| 833 | "Can't pickle %r: it's not the same object as %s.%s" % |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 834 | (obj, module, name)) |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 835 | |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 836 | if self.proto >= 2: |
| 837 | code = extension_registry.get((module, name)) |
| 838 | if code: |
| 839 | assert code > 0 |
| 840 | if code <= 0xff: |
| 841 | write(EXT1 + chr(code)) |
| 842 | elif code <= 0xffff: |
Guido van Rossum | ba884f3 | 2003-01-29 20:14:23 +0000 | [diff] [blame] | 843 | write("%c%c%c" % (EXT2, code&0xff, code>>8)) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 844 | else: |
| 845 | write(EXT4 + pack("<i", code)) |
| 846 | return |
| 847 | |
Tim Peters | 518df0d | 2003-01-28 01:00:38 +0000 | [diff] [blame] | 848 | write(GLOBAL + module + '\n' + name + '\n') |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 849 | self.memoize(obj) |
Tim Peters | 3b76983 | 2003-01-28 03:51:36 +0000 | [diff] [blame] | 850 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 851 | dispatch[ClassType] = save_global |
| 852 | dispatch[FunctionType] = save_global |
| 853 | dispatch[BuiltinFunctionType] = save_global |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 854 | dispatch[TypeType] = save_global |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 855 | |
Guido van Rossum | 1be3175 | 2003-01-28 15:19:53 +0000 | [diff] [blame] | 856 | # Pickling helpers |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 857 | |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 858 | def _slotnames(cls): |
| 859 | """Return a list of slot names for a given class. |
| 860 | |
| 861 | This needs to find slots defined by the class and its bases, so we |
| 862 | can't simply return the __slots__ attribute. We must walk down |
| 863 | the Method Resolution Order and concatenate the __slots__ of each |
| 864 | class found there. (This assumes classes don't modify their |
| 865 | __slots__ attribute to misrepresent their slots after the class is |
| 866 | defined.) |
| 867 | """ |
| 868 | if not hasattr(cls, "__slots__"): |
| 869 | return [] |
| 870 | names = [] |
| 871 | for c in cls.__mro__: |
| 872 | if "__slots__" in c.__dict__: |
| 873 | names += list(c.__dict__["__slots__"]) |
| 874 | return names |
| 875 | |
Guido van Rossum | 5ed5c4c | 1997-09-03 00:23:54 +0000 | [diff] [blame] | 876 | def _keep_alive(x, memo): |
| 877 | """Keeps a reference to the object x in the memo. |
| 878 | |
| 879 | Because we remember objects by their id, we have |
| 880 | to assure that possibly temporary objects are kept |
| 881 | alive by referencing them. |
| 882 | We store a reference at the id of the memo, which should |
| 883 | normally not be used unless someone tries to deepcopy |
| 884 | the memo itself... |
| 885 | """ |
| 886 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 887 | memo[id(memo)].append(x) |
Guido van Rossum | 5ed5c4c | 1997-09-03 00:23:54 +0000 | [diff] [blame] | 888 | except KeyError: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 889 | # aha, this is the first one :-) |
| 890 | memo[id(memo)]=[x] |
Guido van Rossum | 5ed5c4c | 1997-09-03 00:23:54 +0000 | [diff] [blame] | 891 | |
| 892 | |
Tim Peters | c0c12b5 | 2003-01-29 00:56:17 +0000 | [diff] [blame] | 893 | # A cache for whichmodule(), mapping a function object to the name of |
| 894 | # the module in which the function was found. |
| 895 | |
Jeremy Hylton | f0cfdf7 | 2002-09-19 23:00:12 +0000 | [diff] [blame] | 896 | classmap = {} # called classmap for backwards compatibility |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 897 | |
Jeremy Hylton | f0cfdf7 | 2002-09-19 23:00:12 +0000 | [diff] [blame] | 898 | def whichmodule(func, funcname): |
| 899 | """Figure out the module in which a function occurs. |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 900 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 901 | Search sys.modules for the module. |
| 902 | Cache in classmap. |
| 903 | Return a module name. |
Tim Peters | c0c12b5 | 2003-01-29 00:56:17 +0000 | [diff] [blame] | 904 | If the function cannot be found, return "__main__". |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 905 | """ |
Jeremy Hylton | 4f0dcc9 | 2003-01-31 18:33:18 +0000 | [diff] [blame] | 906 | # Python functions should always get an __module__ from their globals. |
| 907 | mod = getattr(func, "__module__", None) |
| 908 | if mod is not None: |
| 909 | return mod |
Jeremy Hylton | f0cfdf7 | 2002-09-19 23:00:12 +0000 | [diff] [blame] | 910 | if func in classmap: |
| 911 | return classmap[func] |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 912 | |
| 913 | for name, module in sys.modules.items(): |
Jeremy Hylton | f0cfdf7 | 2002-09-19 23:00:12 +0000 | [diff] [blame] | 914 | if module is None: |
Jeremy Hylton | 065a5ab | 2002-09-19 22:57:26 +0000 | [diff] [blame] | 915 | continue # skip dummy package entries |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 916 | if name != '__main__' and \ |
Jeremy Hylton | f0cfdf7 | 2002-09-19 23:00:12 +0000 | [diff] [blame] | 917 | hasattr(module, funcname) and \ |
| 918 | getattr(module, funcname) is func: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 919 | break |
| 920 | else: |
| 921 | name = '__main__' |
Jeremy Hylton | f0cfdf7 | 2002-09-19 23:00:12 +0000 | [diff] [blame] | 922 | classmap[func] = name |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 923 | return name |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 924 | |
| 925 | |
Guido van Rossum | 1be3175 | 2003-01-28 15:19:53 +0000 | [diff] [blame] | 926 | # Unpickling machinery |
| 927 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 928 | class Unpickler: |
| 929 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 930 | def __init__(self, file): |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 931 | """This takes a file-like object for reading a pickle data stream. |
| 932 | |
Tim Peters | 5bd2a79 | 2003-02-01 16:45:06 +0000 | [diff] [blame^] | 933 | The protocol version of the pickle is detected automatically, so no |
| 934 | proto argument is needed. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 935 | |
| 936 | The file-like object must have two methods, a read() method that |
| 937 | takes an integer argument, and a readline() method that requires no |
| 938 | arguments. Both methods should return a string. Thus file-like |
| 939 | object can be a file object opened for reading, a StringIO object, |
| 940 | or any other custom object that meets this interface. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 941 | """ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 942 | self.readline = file.readline |
| 943 | self.read = file.read |
| 944 | self.memo = {} |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 945 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 946 | def load(self): |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 947 | """Read a pickled object representation from the open file. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 948 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 949 | Return the reconstituted object hierarchy specified in the file. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 950 | """ |
Jeremy Hylton | 20747fa | 2001-11-09 16:15:04 +0000 | [diff] [blame] | 951 | self.mark = object() # any new unique object |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 952 | self.stack = [] |
| 953 | self.append = self.stack.append |
| 954 | read = self.read |
| 955 | dispatch = self.dispatch |
| 956 | try: |
| 957 | while 1: |
| 958 | key = read(1) |
| 959 | dispatch[key](self) |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 960 | except _Stop, stopinst: |
| 961 | return stopinst.value |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 962 | |
Tim Peters | c23d18a | 2003-01-28 01:41:51 +0000 | [diff] [blame] | 963 | # Return largest index k such that self.stack[k] is self.mark. |
| 964 | # If the stack doesn't contain a mark, eventually raises IndexError. |
| 965 | # This could be sped by maintaining another stack, of indices at which |
| 966 | # the mark appears. For that matter, the latter stack would suffice, |
| 967 | # and we wouldn't need to push mark objects on self.stack at all. |
| 968 | # Doing so is probably a good thing, though, since if the pickle is |
| 969 | # corrupt (or hostile) we may get a clue from finding self.mark embedded |
| 970 | # in unpickled objects. |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 971 | def marker(self): |
| 972 | stack = self.stack |
| 973 | mark = self.mark |
| 974 | k = len(stack)-1 |
| 975 | while stack[k] is not mark: k = k-1 |
| 976 | return k |
| 977 | |
| 978 | dispatch = {} |
| 979 | |
| 980 | def load_eof(self): |
| 981 | raise EOFError |
| 982 | dispatch[''] = load_eof |
| 983 | |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 984 | def load_proto(self): |
| 985 | proto = ord(self.read(1)) |
| 986 | if not 0 <= proto <= 2: |
| 987 | raise ValueError, "unsupported pickle protocol: %d" % proto |
| 988 | dispatch[PROTO] = load_proto |
| 989 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 990 | def load_persid(self): |
| 991 | pid = self.readline()[:-1] |
| 992 | self.append(self.persistent_load(pid)) |
| 993 | dispatch[PERSID] = load_persid |
| 994 | |
| 995 | def load_binpersid(self): |
Raymond Hettinger | 46ac8eb | 2002-06-30 03:39:14 +0000 | [diff] [blame] | 996 | pid = self.stack.pop() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 997 | self.append(self.persistent_load(pid)) |
| 998 | dispatch[BINPERSID] = load_binpersid |
| 999 | |
| 1000 | def load_none(self): |
| 1001 | self.append(None) |
| 1002 | dispatch[NONE] = load_none |
| 1003 | |
Guido van Rossum | 7d97d31 | 2003-01-28 04:25:27 +0000 | [diff] [blame] | 1004 | def load_false(self): |
| 1005 | self.append(False) |
| 1006 | dispatch[NEWFALSE] = load_false |
| 1007 | |
| 1008 | def load_true(self): |
| 1009 | self.append(True) |
| 1010 | dispatch[NEWTRUE] = load_true |
| 1011 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1012 | def load_int(self): |
Tim Peters | 19ef62d | 2001-08-28 22:21:18 +0000 | [diff] [blame] | 1013 | data = self.readline() |
Guido van Rossum | e276339 | 2002-04-05 19:30:08 +0000 | [diff] [blame] | 1014 | if data == FALSE[1:]: |
| 1015 | val = False |
| 1016 | elif data == TRUE[1:]: |
| 1017 | val = True |
| 1018 | else: |
| 1019 | try: |
| 1020 | val = int(data) |
| 1021 | except ValueError: |
| 1022 | val = long(data) |
| 1023 | self.append(val) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1024 | dispatch[INT] = load_int |
| 1025 | |
| 1026 | def load_binint(self): |
| 1027 | self.append(mloads('i' + self.read(4))) |
| 1028 | dispatch[BININT] = load_binint |
| 1029 | |
| 1030 | def load_binint1(self): |
Tim Peters | bbf63cd | 2003-01-27 21:15:36 +0000 | [diff] [blame] | 1031 | self.append(ord(self.read(1))) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1032 | dispatch[BININT1] = load_binint1 |
| 1033 | |
| 1034 | def load_binint2(self): |
| 1035 | self.append(mloads('i' + self.read(2) + '\000\000')) |
| 1036 | dispatch[BININT2] = load_binint2 |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 1037 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1038 | def load_long(self): |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 1039 | self.append(long(self.readline()[:-1], 0)) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1040 | dispatch[LONG] = load_long |
| 1041 | |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1042 | def load_long1(self): |
| 1043 | n = ord(self.read(1)) |
| 1044 | bytes = self.read(n) |
| 1045 | return decode_long(bytes) |
| 1046 | dispatch[LONG1] = load_long1 |
| 1047 | |
| 1048 | def load_long4(self): |
| 1049 | n = mloads('i' + self.read(4)) |
| 1050 | bytes = self.read(n) |
| 1051 | return decode_long(bytes) |
| 1052 | dispatch[LONG4] = load_long4 |
| 1053 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1054 | def load_float(self): |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 1055 | self.append(float(self.readline()[:-1])) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1056 | dispatch[FLOAT] = load_float |
| 1057 | |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 1058 | def load_binfloat(self, unpack=struct.unpack): |
| 1059 | self.append(unpack('>d', self.read(8))[0]) |
| 1060 | dispatch[BINFLOAT] = load_binfloat |
| 1061 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1062 | def load_string(self): |
Jeremy Hylton | be467e5 | 2000-09-15 15:14:51 +0000 | [diff] [blame] | 1063 | rep = self.readline()[:-1] |
Tim Peters | ad5a771 | 2003-01-28 16:23:33 +0000 | [diff] [blame] | 1064 | for q in "\"'": # double or single quote |
Martin v. Löwis | 8a8da79 | 2002-08-14 07:46:28 +0000 | [diff] [blame] | 1065 | if rep.startswith(q): |
| 1066 | if not rep.endswith(q): |
| 1067 | raise ValueError, "insecure string pickle" |
| 1068 | rep = rep[len(q):-len(q)] |
| 1069 | break |
| 1070 | else: |
Jeremy Hylton | be467e5 | 2000-09-15 15:14:51 +0000 | [diff] [blame] | 1071 | raise ValueError, "insecure string pickle" |
Martin v. Löwis | 8a8da79 | 2002-08-14 07:46:28 +0000 | [diff] [blame] | 1072 | self.append(rep.decode("string-escape")) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1073 | dispatch[STRING] = load_string |
| 1074 | |
| 1075 | def load_binstring(self): |
| 1076 | len = mloads('i' + self.read(4)) |
| 1077 | self.append(self.read(len)) |
| 1078 | dispatch[BINSTRING] = load_binstring |
| 1079 | |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 1080 | def load_unicode(self): |
| 1081 | self.append(unicode(self.readline()[:-1],'raw-unicode-escape')) |
| 1082 | dispatch[UNICODE] = load_unicode |
| 1083 | |
| 1084 | def load_binunicode(self): |
| 1085 | len = mloads('i' + self.read(4)) |
| 1086 | self.append(unicode(self.read(len),'utf-8')) |
| 1087 | dispatch[BINUNICODE] = load_binunicode |
| 1088 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1089 | def load_short_binstring(self): |
Tim Peters | bbf63cd | 2003-01-27 21:15:36 +0000 | [diff] [blame] | 1090 | len = ord(self.read(1)) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1091 | self.append(self.read(len)) |
| 1092 | dispatch[SHORT_BINSTRING] = load_short_binstring |
| 1093 | |
| 1094 | def load_tuple(self): |
| 1095 | k = self.marker() |
| 1096 | self.stack[k:] = [tuple(self.stack[k+1:])] |
| 1097 | dispatch[TUPLE] = load_tuple |
| 1098 | |
| 1099 | def load_empty_tuple(self): |
| 1100 | self.stack.append(()) |
| 1101 | dispatch[EMPTY_TUPLE] = load_empty_tuple |
| 1102 | |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 1103 | def load_tuple1(self): |
| 1104 | self.stack[-1] = (self.stack[-1],) |
| 1105 | dispatch[TUPLE1] = load_tuple1 |
| 1106 | |
| 1107 | def load_tuple2(self): |
| 1108 | self.stack[-2:] = [(self.stack[-2], self.stack[-1])] |
| 1109 | dispatch[TUPLE2] = load_tuple2 |
| 1110 | |
| 1111 | def load_tuple3(self): |
| 1112 | self.stack[-3:] = [(self.stack[-3], self.stack[-2], self.stack[-1])] |
| 1113 | dispatch[TUPLE3] = load_tuple3 |
| 1114 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1115 | def load_empty_list(self): |
| 1116 | self.stack.append([]) |
| 1117 | dispatch[EMPTY_LIST] = load_empty_list |
| 1118 | |
| 1119 | def load_empty_dictionary(self): |
| 1120 | self.stack.append({}) |
| 1121 | dispatch[EMPTY_DICT] = load_empty_dictionary |
| 1122 | |
| 1123 | def load_list(self): |
| 1124 | k = self.marker() |
| 1125 | self.stack[k:] = [self.stack[k+1:]] |
| 1126 | dispatch[LIST] = load_list |
| 1127 | |
| 1128 | def load_dict(self): |
| 1129 | k = self.marker() |
| 1130 | d = {} |
| 1131 | items = self.stack[k+1:] |
| 1132 | for i in range(0, len(items), 2): |
| 1133 | key = items[i] |
| 1134 | value = items[i+1] |
| 1135 | d[key] = value |
| 1136 | self.stack[k:] = [d] |
| 1137 | dispatch[DICT] = load_dict |
| 1138 | |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1139 | # INST and OBJ differ only in how they get a class object. It's not |
| 1140 | # only sensible to do the rest in a common routine, the two routines |
| 1141 | # previously diverged and grew different bugs. |
| 1142 | # klass is the class to instantiate, and k points to the topmost mark |
| 1143 | # object, following which are the arguments for klass.__init__. |
| 1144 | def _instantiate(self, klass, k): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1145 | args = tuple(self.stack[k+1:]) |
| 1146 | del self.stack[k:] |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1147 | instantiated = 0 |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1148 | if (not args and |
| 1149 | type(klass) is ClassType and |
| 1150 | not hasattr(klass, "__getinitargs__")): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1151 | try: |
| 1152 | value = _EmptyClass() |
| 1153 | value.__class__ = klass |
Guido van Rossum | b19e2a3 | 1998-04-13 18:08:45 +0000 | [diff] [blame] | 1154 | instantiated = 1 |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1155 | except RuntimeError: |
| 1156 | # In restricted execution, assignment to inst.__class__ is |
| 1157 | # prohibited |
| 1158 | pass |
| 1159 | if not instantiated: |
Guido van Rossum | 743d17e | 1998-09-15 20:25:57 +0000 | [diff] [blame] | 1160 | try: |
Guido van Rossum | b26a97a | 2003-01-28 22:29:13 +0000 | [diff] [blame] | 1161 | value = klass(*args) |
Guido van Rossum | 743d17e | 1998-09-15 20:25:57 +0000 | [diff] [blame] | 1162 | except TypeError, err: |
| 1163 | raise TypeError, "in constructor for %s: %s" % ( |
| 1164 | klass.__name__, str(err)), sys.exc_info()[2] |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1165 | self.append(value) |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1166 | |
| 1167 | def load_inst(self): |
| 1168 | module = self.readline()[:-1] |
| 1169 | name = self.readline()[:-1] |
| 1170 | klass = self.find_class(module, name) |
| 1171 | self._instantiate(klass, self.marker()) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1172 | dispatch[INST] = load_inst |
| 1173 | |
| 1174 | def load_obj(self): |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1175 | # Stack is ... markobject classobject arg1 arg2 ... |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1176 | k = self.marker() |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1177 | klass = self.stack.pop(k+1) |
| 1178 | self._instantiate(klass, k) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 1179 | dispatch[OBJ] = load_obj |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1180 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 1181 | def load_newobj(self): |
| 1182 | args = self.stack.pop() |
| 1183 | cls = self.stack[-1] |
| 1184 | obj = cls.__new__(cls, *args) |
Guido van Rossum | 533dbcf | 2003-01-28 17:55:05 +0000 | [diff] [blame] | 1185 | self.stack[-1] = obj |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 1186 | dispatch[NEWOBJ] = load_newobj |
| 1187 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1188 | def load_global(self): |
| 1189 | module = self.readline()[:-1] |
| 1190 | name = self.readline()[:-1] |
| 1191 | klass = self.find_class(module, name) |
| 1192 | self.append(klass) |
| 1193 | dispatch[GLOBAL] = load_global |
| 1194 | |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1195 | def load_ext1(self): |
| 1196 | code = ord(self.read(1)) |
| 1197 | self.get_extension(code) |
| 1198 | dispatch[EXT1] = load_ext1 |
| 1199 | |
| 1200 | def load_ext2(self): |
| 1201 | code = mloads('i' + self.read(2) + '\000\000') |
| 1202 | self.get_extension(code) |
| 1203 | dispatch[EXT2] = load_ext2 |
| 1204 | |
| 1205 | def load_ext4(self): |
| 1206 | code = mloads('i' + self.read(4)) |
| 1207 | self.get_extension(code) |
| 1208 | dispatch[EXT4] = load_ext4 |
| 1209 | |
| 1210 | def get_extension(self, code): |
| 1211 | nil = [] |
| 1212 | obj = extension_cache.get(code, nil) |
| 1213 | if obj is not nil: |
| 1214 | self.append(obj) |
| 1215 | return |
| 1216 | key = inverted_registry.get(code) |
| 1217 | if not key: |
| 1218 | raise ValueError("unregistered extension code %d" % code) |
| 1219 | obj = self.find_class(*key) |
| 1220 | extension_cache[code] = obj |
| 1221 | self.append(obj) |
| 1222 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1223 | def find_class(self, module, name): |
Guido van Rossum | b26a97a | 2003-01-28 22:29:13 +0000 | [diff] [blame] | 1224 | # Subclasses may override this |
Barry Warsaw | bf4d959 | 2001-11-15 23:42:58 +0000 | [diff] [blame] | 1225 | __import__(module) |
| 1226 | mod = sys.modules[module] |
| 1227 | klass = getattr(mod, name) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1228 | return klass |
| 1229 | |
| 1230 | def load_reduce(self): |
| 1231 | stack = self.stack |
Guido van Rossum | b26a97a | 2003-01-28 22:29:13 +0000 | [diff] [blame] | 1232 | args = stack.pop() |
| 1233 | func = stack[-1] |
| 1234 | if args is None: |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 1235 | # A hack for Jim Fulton's ExtensionClass, now deprecated |
| 1236 | warnings.warn("__basicnew__ special case is deprecated", |
Tim Peters | 8ac1495 | 2002-05-23 15:15:30 +0000 | [diff] [blame] | 1237 | DeprecationWarning) |
Guido van Rossum | b26a97a | 2003-01-28 22:29:13 +0000 | [diff] [blame] | 1238 | value = func.__basicnew__() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1239 | else: |
Guido van Rossum | b26a97a | 2003-01-28 22:29:13 +0000 | [diff] [blame] | 1240 | value = func(*args) |
| 1241 | stack[-1] = value |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1242 | dispatch[REDUCE] = load_reduce |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1243 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1244 | def load_pop(self): |
| 1245 | del self.stack[-1] |
| 1246 | dispatch[POP] = load_pop |
Guido van Rossum | 7b5430f | 1995-03-04 22:25:21 +0000 | [diff] [blame] | 1247 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1248 | def load_pop_mark(self): |
| 1249 | k = self.marker() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1250 | del self.stack[k:] |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1251 | dispatch[POP_MARK] = load_pop_mark |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1252 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1253 | def load_dup(self): |
Guido van Rossum | b1062fc | 1998-03-31 17:00:46 +0000 | [diff] [blame] | 1254 | self.append(self.stack[-1]) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1255 | dispatch[DUP] = load_dup |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1256 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1257 | def load_get(self): |
| 1258 | self.append(self.memo[self.readline()[:-1]]) |
| 1259 | dispatch[GET] = load_get |
Guido van Rossum | 7853647 | 1996-04-12 13:36:27 +0000 | [diff] [blame] | 1260 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1261 | def load_binget(self): |
Tim Peters | bbf63cd | 2003-01-27 21:15:36 +0000 | [diff] [blame] | 1262 | i = ord(self.read(1)) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1263 | self.append(self.memo[`i`]) |
| 1264 | dispatch[BINGET] = load_binget |
Guido van Rossum | 7853647 | 1996-04-12 13:36:27 +0000 | [diff] [blame] | 1265 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1266 | def load_long_binget(self): |
| 1267 | i = mloads('i' + self.read(4)) |
| 1268 | self.append(self.memo[`i`]) |
| 1269 | dispatch[LONG_BINGET] = load_long_binget |
Guido van Rossum | 7853647 | 1996-04-12 13:36:27 +0000 | [diff] [blame] | 1270 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1271 | def load_put(self): |
| 1272 | self.memo[self.readline()[:-1]] = self.stack[-1] |
| 1273 | dispatch[PUT] = load_put |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1274 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1275 | def load_binput(self): |
Tim Peters | bbf63cd | 2003-01-27 21:15:36 +0000 | [diff] [blame] | 1276 | i = ord(self.read(1)) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1277 | self.memo[`i`] = self.stack[-1] |
| 1278 | dispatch[BINPUT] = load_binput |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1279 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1280 | def load_long_binput(self): |
| 1281 | i = mloads('i' + self.read(4)) |
| 1282 | self.memo[`i`] = self.stack[-1] |
| 1283 | dispatch[LONG_BINPUT] = load_long_binput |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1284 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1285 | def load_append(self): |
| 1286 | stack = self.stack |
Raymond Hettinger | 46ac8eb | 2002-06-30 03:39:14 +0000 | [diff] [blame] | 1287 | value = stack.pop() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1288 | list = stack[-1] |
| 1289 | list.append(value) |
| 1290 | dispatch[APPEND] = load_append |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1291 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1292 | def load_appends(self): |
| 1293 | stack = self.stack |
| 1294 | mark = self.marker() |
| 1295 | list = stack[mark - 1] |
Tim Peters | 209ad95 | 2003-01-28 01:44:45 +0000 | [diff] [blame] | 1296 | list.extend(stack[mark + 1:]) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1297 | del stack[mark:] |
| 1298 | dispatch[APPENDS] = load_appends |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 1299 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1300 | def load_setitem(self): |
| 1301 | stack = self.stack |
Raymond Hettinger | 46ac8eb | 2002-06-30 03:39:14 +0000 | [diff] [blame] | 1302 | value = stack.pop() |
| 1303 | key = stack.pop() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1304 | dict = stack[-1] |
| 1305 | dict[key] = value |
| 1306 | dispatch[SETITEM] = load_setitem |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1307 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1308 | def load_setitems(self): |
| 1309 | stack = self.stack |
| 1310 | mark = self.marker() |
| 1311 | dict = stack[mark - 1] |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1312 | for i in range(mark + 1, len(stack), 2): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1313 | dict[stack[i]] = stack[i + 1] |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1314 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1315 | del stack[mark:] |
| 1316 | dispatch[SETITEMS] = load_setitems |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1317 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1318 | def load_build(self): |
| 1319 | stack = self.stack |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 1320 | state = stack.pop() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1321 | inst = stack[-1] |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 1322 | setstate = getattr(inst, "__setstate__", None) |
| 1323 | if setstate: |
| 1324 | setstate(state) |
| 1325 | return |
| 1326 | slotstate = None |
| 1327 | if isinstance(state, tuple) and len(state) == 2: |
| 1328 | state, slotstate = state |
| 1329 | if state: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1330 | try: |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 1331 | inst.__dict__.update(state) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1332 | except RuntimeError: |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 1333 | # XXX In restricted execution, the instance's __dict__ |
| 1334 | # is not accessible. Use the old way of unpickling |
| 1335 | # the instance variables. This is a semantic |
| 1336 | # difference when unpickling in restricted |
| 1337 | # vs. unrestricted modes. |
| 1338 | for k, v in state.items(): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1339 | setattr(inst, k, v) |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 1340 | if slotstate: |
| 1341 | for k, v in slotstate.items(): |
| 1342 | setattr(inst, k, v) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1343 | dispatch[BUILD] = load_build |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1344 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1345 | def load_mark(self): |
| 1346 | self.append(self.mark) |
| 1347 | dispatch[MARK] = load_mark |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1348 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1349 | def load_stop(self): |
Raymond Hettinger | 46ac8eb | 2002-06-30 03:39:14 +0000 | [diff] [blame] | 1350 | value = self.stack.pop() |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 1351 | raise _Stop(value) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1352 | dispatch[STOP] = load_stop |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1353 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 1354 | # Helper class for load_inst/load_obj |
| 1355 | |
| 1356 | class _EmptyClass: |
| 1357 | pass |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1358 | |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1359 | # Encode/decode longs in linear time. |
| 1360 | |
| 1361 | import binascii as _binascii |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1362 | |
| 1363 | def encode_long(x): |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1364 | r"""Encode a long to a two's complement little-endian binary string. |
Tim Peters | 4b23f2b | 2003-01-31 16:43:39 +0000 | [diff] [blame] | 1365 | Note that 0L is a special case, returning an empty string, to save a |
| 1366 | byte in the LONG1 pickling context. |
| 1367 | |
| 1368 | >>> encode_long(0L) |
| 1369 | '' |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1370 | >>> encode_long(255L) |
| 1371 | '\xff\x00' |
| 1372 | >>> encode_long(32767L) |
| 1373 | '\xff\x7f' |
| 1374 | >>> encode_long(-256L) |
| 1375 | '\x00\xff' |
| 1376 | >>> encode_long(-32768L) |
| 1377 | '\x00\x80' |
| 1378 | >>> encode_long(-128L) |
| 1379 | '\x80' |
| 1380 | >>> encode_long(127L) |
| 1381 | '\x7f' |
| 1382 | >>> |
| 1383 | """ |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1384 | |
| 1385 | if x == 0: |
Tim Peters | 4b23f2b | 2003-01-31 16:43:39 +0000 | [diff] [blame] | 1386 | return '' |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1387 | if x > 0: |
| 1388 | ashex = hex(x) |
| 1389 | assert ashex.startswith("0x") |
| 1390 | njunkchars = 2 + ashex.endswith('L') |
| 1391 | nibbles = len(ashex) - njunkchars |
| 1392 | if nibbles & 1: |
| 1393 | # need an even # of nibbles for unhexlify |
| 1394 | ashex = "0x0" + ashex[2:] |
Tim Peters | 4b23f2b | 2003-01-31 16:43:39 +0000 | [diff] [blame] | 1395 | elif int(ashex[2], 16) >= 8: |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1396 | # "looks negative", so need a byte of sign bits |
| 1397 | ashex = "0x00" + ashex[2:] |
| 1398 | else: |
| 1399 | # Build the 256's-complement: (1L << nbytes) + x. The trick is |
| 1400 | # to find the number of bytes in linear time (although that should |
| 1401 | # really be a constant-time task). |
| 1402 | ashex = hex(-x) |
| 1403 | assert ashex.startswith("0x") |
| 1404 | njunkchars = 2 + ashex.endswith('L') |
| 1405 | nibbles = len(ashex) - njunkchars |
| 1406 | if nibbles & 1: |
| 1407 | # need an even # of nibbles for unhexlify |
| 1408 | nibbles += 1 |
Tim Peters | 4b23f2b | 2003-01-31 16:43:39 +0000 | [diff] [blame] | 1409 | nbits = nibbles * 4 |
| 1410 | x += 1L << nbits |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1411 | assert x > 0 |
| 1412 | ashex = hex(x) |
Tim Peters | 4b23f2b | 2003-01-31 16:43:39 +0000 | [diff] [blame] | 1413 | if x >> (nbits - 1) == 0: |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1414 | # "looks positive", so need a byte of sign bits |
| 1415 | ashex = "0xff" + x[2:] |
| 1416 | |
| 1417 | if ashex.endswith('L'): |
| 1418 | ashex = ashex[2:-1] |
| 1419 | else: |
| 1420 | ashex = ashex[2:] |
| 1421 | assert len(ashex) & 1 == 0 |
| 1422 | binary = _binascii.unhexlify(ashex) |
| 1423 | return binary[::-1] |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1424 | |
| 1425 | def decode_long(data): |
| 1426 | r"""Decode a long from a two's complement little-endian binary string. |
Tim Peters | 4b23f2b | 2003-01-31 16:43:39 +0000 | [diff] [blame] | 1427 | |
| 1428 | >>> decode_long('') |
| 1429 | 0L |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1430 | >>> decode_long("\xff\x00") |
| 1431 | 255L |
| 1432 | >>> decode_long("\xff\x7f") |
| 1433 | 32767L |
| 1434 | >>> decode_long("\x00\xff") |
| 1435 | -256L |
| 1436 | >>> decode_long("\x00\x80") |
| 1437 | -32768L |
| 1438 | >>> decode_long("\x80") |
| 1439 | -128L |
| 1440 | >>> decode_long("\x7f") |
| 1441 | 127L |
| 1442 | """ |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1443 | |
Tim Peters | 4b23f2b | 2003-01-31 16:43:39 +0000 | [diff] [blame] | 1444 | nbytes = len(data) |
| 1445 | if nbytes == 0: |
| 1446 | return 0L |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1447 | ashex = _binascii.hexlify(data[::-1]) |
| 1448 | n = long(ashex, 16) |
| 1449 | if data[-1] >= '\x80': |
Tim Peters | 4b23f2b | 2003-01-31 16:43:39 +0000 | [diff] [blame] | 1450 | n -= 1L << (nbytes * 8) |
Tim Peters | 9114982 | 2003-01-31 03:43:58 +0000 | [diff] [blame] | 1451 | return n |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1452 | |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1453 | # Shorthands |
| 1454 | |
Jeremy Hylton | abe2c62 | 2001-10-15 21:29:28 +0000 | [diff] [blame] | 1455 | try: |
| 1456 | from cStringIO import StringIO |
| 1457 | except ImportError: |
| 1458 | from StringIO import StringIO |
Guido van Rossum | c7c5e69 | 1996-07-22 22:26:07 +0000 | [diff] [blame] | 1459 | |
Guido van Rossum | 7eff63a | 2003-01-31 19:42:31 +0000 | [diff] [blame] | 1460 | def dump(obj, file, proto=0): |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 1461 | Pickler(file, proto).dump(obj) |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1462 | |
Guido van Rossum | 7eff63a | 2003-01-31 19:42:31 +0000 | [diff] [blame] | 1463 | def dumps(obj, proto=0): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1464 | file = StringIO() |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 1465 | Pickler(file, proto).dump(obj) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1466 | return file.getvalue() |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1467 | |
| 1468 | def load(file): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1469 | return Unpickler(file).load() |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1470 | |
| 1471 | def loads(str): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1472 | file = StringIO(str) |
| 1473 | return Unpickler(file).load() |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1474 | |
| 1475 | # Doctest |
| 1476 | |
| 1477 | def _test(): |
| 1478 | import doctest |
| 1479 | return doctest.testmod() |
| 1480 | |
| 1481 | if __name__ == "__main__": |
| 1482 | _test() |