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 | |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 3 | See module copyreg for a mechanism for registering custom picklers. |
Tim Peters | 22a449a | 2003-01-27 20:16:36 +0000 | [diff] [blame] | 4 | See module pickletools source for extensive comments. |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 5 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 6 | Classes: |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 7 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 8 | Pickler |
| 9 | Unpickler |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 10 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 11 | Functions: |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 13 | dump(object, file) |
| 14 | dumps(object) -> string |
| 15 | load(file) -> object |
| 16 | loads(string) -> object |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 17 | |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 18 | Misc variables: |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 19 | |
Fred Drake | fe82acc | 1998-02-13 03:24:48 +0000 | [diff] [blame] | 20 | __version__ |
Guido van Rossum | e467be6 | 1997-12-05 19:42:42 +0000 | [diff] [blame] | 21 | format_version |
| 22 | compatible_formats |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 23 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 24 | """ |
| 25 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 26 | from types import FunctionType, BuiltinFunctionType, ModuleType |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 27 | from copyreg import dispatch_table |
| 28 | from copyreg import _extension_registry, _inverted_registry, _extension_cache |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 29 | from itertools import islice |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 30 | import sys |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 31 | from sys import maxsize |
| 32 | from struct import pack, unpack |
Skip Montanaro | 23bafc6 | 2001-02-18 03:10:09 +0000 | [diff] [blame] | 33 | import re |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 34 | import io |
Walter Dörwald | 42748a8 | 2007-06-12 16:40:17 +0000 | [diff] [blame] | 35 | import codecs |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 36 | import _compat_pickle |
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 | |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 41 | # Shortcut for use in isinstance testing |
Alexandre Vassalotti | 8cb02b6 | 2008-05-03 01:42:49 +0000 | [diff] [blame] | 42 | bytes_types = (bytes, bytearray) |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 43 | |
Tim Peters | c0c12b5 | 2003-01-29 00:56:17 +0000 | [diff] [blame] | 44 | # These are purely informational; no code uses these. |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 45 | format_version = "4.0" # File format version we write |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 46 | compatible_formats = ["1.0", # Original protocol 0 |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 47 | "1.1", # Protocol 0 with INST added |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 48 | "1.2", # Original protocol 1 |
| 49 | "1.3", # Protocol 1 with BINFLOAT added |
| 50 | "2.0", # Protocol 2 |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 51 | "3.0", # Protocol 3 |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 52 | "4.0", # Protocol 4 |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 53 | ] # Old format versions we can read |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 54 | |
Guido van Rossum | 99603b0 | 2007-07-20 00:22:32 +0000 | [diff] [blame] | 55 | # This is the highest protocol number we know how to read. |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 56 | HIGHEST_PROTOCOL = 4 |
Tim Peters | 8587b3c | 2003-02-13 15:44:41 +0000 | [diff] [blame] | 57 | |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 58 | # The protocol we write by default. May be less than HIGHEST_PROTOCOL. |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 59 | # We intentionally write a protocol that Python 2.x cannot read; |
| 60 | # there are too many issues with that. |
| 61 | DEFAULT_PROTOCOL = 3 |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 62 | |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 63 | class PickleError(Exception): |
Neal Norwitz | efbb67b | 2002-05-30 12:12:04 +0000 | [diff] [blame] | 64 | """A common base class for the other pickling exceptions.""" |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 65 | pass |
| 66 | |
| 67 | class PicklingError(PickleError): |
| 68 | """This exception is raised when an unpicklable object is passed to the |
| 69 | dump() method. |
| 70 | |
| 71 | """ |
| 72 | pass |
| 73 | |
| 74 | class UnpicklingError(PickleError): |
| 75 | """This exception is raised when there is a problem unpickling an object, |
| 76 | such as a security violation. |
| 77 | |
| 78 | Note that other exceptions may also be raised during unpickling, including |
| 79 | (but not necessarily limited to) AttributeError, EOFError, ImportError, |
| 80 | and IndexError. |
| 81 | |
| 82 | """ |
| 83 | pass |
Guido van Rossum | 7849da8 | 1995-03-09 14:08:35 +0000 | [diff] [blame] | 84 | |
Tim Peters | c0c12b5 | 2003-01-29 00:56:17 +0000 | [diff] [blame] | 85 | # An instance of _Stop is raised by Unpickler.load_stop() in response to |
| 86 | # 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] | 87 | class _Stop(Exception): |
| 88 | def __init__(self, value): |
| 89 | self.value = value |
| 90 | |
Guido van Rossum | 533dbcf | 2003-01-28 17:55:05 +0000 | [diff] [blame] | 91 | # Jython has PyStringMap; it's a dict subclass with string keys |
Jeremy Hylton | 2b9d029 | 1998-05-27 22:38:22 +0000 | [diff] [blame] | 92 | try: |
| 93 | from org.python.core import PyStringMap |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 94 | except ImportError: |
Jeremy Hylton | 2b9d029 | 1998-05-27 22:38:22 +0000 | [diff] [blame] | 95 | PyStringMap = None |
| 96 | |
Tim Peters | 22a449a | 2003-01-27 20:16:36 +0000 | [diff] [blame] | 97 | # Pickle opcodes. See pickletools.py for extensive docs. The listing |
| 98 | # here is in kind-of alphabetical order of 1-character pickle code. |
| 99 | # pickletools groups them by purpose. |
Guido van Rossum | dbb718f | 2001-09-21 19:22:34 +0000 | [diff] [blame] | 100 | |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 101 | MARK = b'(' # push special markobject on stack |
| 102 | STOP = b'.' # every pickle ends with STOP |
| 103 | POP = b'0' # discard topmost stack item |
| 104 | POP_MARK = b'1' # discard stack top through topmost markobject |
| 105 | DUP = b'2' # duplicate top stack item |
| 106 | FLOAT = b'F' # push float object; decimal string argument |
| 107 | INT = b'I' # push integer or bool; decimal string argument |
| 108 | BININT = b'J' # push four-byte signed int |
| 109 | BININT1 = b'K' # push 1-byte unsigned int |
| 110 | LONG = b'L' # push long; decimal string argument |
| 111 | BININT2 = b'M' # push 2-byte unsigned int |
| 112 | NONE = b'N' # push None |
| 113 | PERSID = b'P' # push persistent object; id is taken from string arg |
| 114 | BINPERSID = b'Q' # " " " ; " " " " stack |
| 115 | REDUCE = b'R' # apply callable to argtuple, both on stack |
| 116 | STRING = b'S' # push string; NL-terminated string argument |
| 117 | BINSTRING = b'T' # push string; counted binary string argument |
| 118 | SHORT_BINSTRING= b'U' # " " ; " " " " < 256 bytes |
| 119 | UNICODE = b'V' # push Unicode string; raw-unicode-escaped'd argument |
| 120 | BINUNICODE = b'X' # " " " ; counted UTF-8 string argument |
| 121 | APPEND = b'a' # append stack top to list below it |
| 122 | BUILD = b'b' # call __setstate__ or __dict__.update() |
| 123 | GLOBAL = b'c' # push self.find_class(modname, name); 2 string args |
| 124 | DICT = b'd' # build a dict from stack items |
| 125 | EMPTY_DICT = b'}' # push empty dict |
| 126 | APPENDS = b'e' # extend list on stack by topmost stack slice |
| 127 | GET = b'g' # push item from memo on stack; index is string arg |
| 128 | BINGET = b'h' # " " " " " " ; " " 1-byte arg |
| 129 | INST = b'i' # build & push class instance |
| 130 | LONG_BINGET = b'j' # push item from memo on stack; index is 4-byte arg |
| 131 | LIST = b'l' # build list from topmost stack items |
| 132 | EMPTY_LIST = b']' # push empty list |
| 133 | OBJ = b'o' # build & push class instance |
| 134 | PUT = b'p' # store stack top in memo; index is string arg |
| 135 | BINPUT = b'q' # " " " " " ; " " 1-byte arg |
| 136 | LONG_BINPUT = b'r' # " " " " " ; " " 4-byte arg |
| 137 | SETITEM = b's' # add key+value pair to dict |
| 138 | TUPLE = b't' # build tuple from topmost stack items |
| 139 | EMPTY_TUPLE = b')' # push empty tuple |
| 140 | SETITEMS = b'u' # modify dict by adding topmost key+value pairs |
| 141 | BINFLOAT = b'G' # push float; arg is 8-byte float encoding |
Tim Peters | 22a449a | 2003-01-27 20:16:36 +0000 | [diff] [blame] | 142 | |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 143 | TRUE = b'I01\n' # not an opcode; see INT docs in pickletools.py |
| 144 | FALSE = b'I00\n' # not an opcode; see INT docs in pickletools.py |
Guido van Rossum | 77f6a65 | 2002-04-03 22:41:51 +0000 | [diff] [blame] | 145 | |
Guido van Rossum | 586c9e8 | 2003-01-29 06:16:12 +0000 | [diff] [blame] | 146 | # Protocol 2 |
Guido van Rossum | 5a2d8f5 | 2003-01-27 21:44:25 +0000 | [diff] [blame] | 147 | |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 148 | PROTO = b'\x80' # identify pickle protocol |
| 149 | NEWOBJ = b'\x81' # build object by applying cls.__new__ to argtuple |
| 150 | EXT1 = b'\x82' # push object from extension registry; 1-byte index |
| 151 | EXT2 = b'\x83' # ditto, but 2-byte index |
| 152 | EXT4 = b'\x84' # ditto, but 4-byte index |
| 153 | TUPLE1 = b'\x85' # build 1-tuple from stack top |
| 154 | TUPLE2 = b'\x86' # build 2-tuple from two topmost stack items |
| 155 | TUPLE3 = b'\x87' # build 3-tuple from three topmost stack items |
| 156 | NEWTRUE = b'\x88' # push True |
| 157 | NEWFALSE = b'\x89' # push False |
| 158 | LONG1 = b'\x8a' # push long from < 256 bytes |
| 159 | LONG4 = b'\x8b' # push really big long |
Guido van Rossum | 5a2d8f5 | 2003-01-27 21:44:25 +0000 | [diff] [blame] | 160 | |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 161 | _tuplesize2code = [EMPTY_TUPLE, TUPLE1, TUPLE2, TUPLE3] |
| 162 | |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 163 | # Protocol 3 (Python 3.x) |
| 164 | |
| 165 | BINBYTES = b'B' # push bytes; counted binary string argument |
| 166 | SHORT_BINBYTES = b'C' # " " ; " " " " < 256 bytes |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 167 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 168 | # Protocol 4 |
| 169 | SHORT_BINUNICODE = b'\x8c' # push short string; UTF-8 length < 256 bytes |
| 170 | BINUNICODE8 = b'\x8d' # push very long string |
| 171 | BINBYTES8 = b'\x8e' # push very long bytes string |
| 172 | EMPTY_SET = b'\x8f' # push empty set on the stack |
| 173 | ADDITEMS = b'\x90' # modify set by adding topmost stack items |
| 174 | FROZENSET = b'\x91' # build frozenset from topmost stack items |
| 175 | NEWOBJ_EX = b'\x92' # like NEWOBJ but work with keyword only arguments |
| 176 | STACK_GLOBAL = b'\x93' # same as GLOBAL but using names on the stacks |
| 177 | MEMOIZE = b'\x94' # store top of the stack in memo |
| 178 | FRAME = b'\x95' # indicate the beginning of a new frame |
| 179 | |
| 180 | __all__.extend([x for x in dir() if re.match("[A-Z][A-Z0-9_]+$", x)]) |
| 181 | |
| 182 | |
| 183 | class _Framer: |
| 184 | |
| 185 | _FRAME_SIZE_TARGET = 64 * 1024 |
| 186 | |
| 187 | def __init__(self, file_write): |
| 188 | self.file_write = file_write |
| 189 | self.current_frame = None |
| 190 | |
| 191 | def _commit_frame(self): |
| 192 | f = self.current_frame |
| 193 | with f.getbuffer() as data: |
| 194 | n = len(data) |
| 195 | write = self.file_write |
| 196 | write(FRAME) |
| 197 | write(pack("<Q", n)) |
| 198 | write(data) |
| 199 | f.seek(0) |
| 200 | f.truncate() |
| 201 | |
| 202 | def start_framing(self): |
| 203 | self.current_frame = io.BytesIO() |
| 204 | |
| 205 | def end_framing(self): |
| 206 | if self.current_frame is not None: |
| 207 | self._commit_frame() |
| 208 | self.current_frame = None |
| 209 | |
| 210 | def write(self, data): |
| 211 | f = self.current_frame |
| 212 | if f is None: |
| 213 | return self.file_write(data) |
| 214 | else: |
| 215 | n = len(data) |
| 216 | if f.tell() >= self._FRAME_SIZE_TARGET: |
| 217 | self._commit_frame() |
| 218 | return f.write(data) |
| 219 | |
| 220 | class _Unframer: |
| 221 | |
| 222 | def __init__(self, file_read, file_readline, file_tell=None): |
| 223 | self.file_read = file_read |
| 224 | self.file_readline = file_readline |
| 225 | self.file_tell = file_tell |
| 226 | self.framing_enabled = False |
| 227 | self.current_frame = None |
| 228 | self.frame_start = None |
| 229 | |
| 230 | def read(self, n): |
| 231 | if n == 0: |
| 232 | return b'' |
| 233 | _file_read = self.file_read |
| 234 | if not self.framing_enabled: |
| 235 | return _file_read(n) |
| 236 | f = self.current_frame |
| 237 | if f is not None: |
| 238 | data = f.read(n) |
| 239 | if data: |
| 240 | if len(data) < n: |
| 241 | raise UnpicklingError( |
| 242 | "pickle exhausted before end of frame") |
| 243 | return data |
| 244 | frame_opcode = _file_read(1) |
| 245 | if frame_opcode != FRAME: |
| 246 | raise UnpicklingError( |
| 247 | "expected a FRAME opcode, got {} instead".format(frame_opcode)) |
| 248 | frame_size, = unpack("<Q", _file_read(8)) |
| 249 | if frame_size > sys.maxsize: |
| 250 | raise ValueError("frame size > sys.maxsize: %d" % frame_size) |
| 251 | if self.file_tell is not None: |
| 252 | self.frame_start = self.file_tell() |
| 253 | f = self.current_frame = io.BytesIO(_file_read(frame_size)) |
| 254 | self.readline = f.readline |
| 255 | data = f.read(n) |
| 256 | assert len(data) == n, (len(data), n) |
| 257 | return data |
| 258 | |
| 259 | def readline(self): |
| 260 | if not self.framing_enabled: |
| 261 | return self.file_readline() |
| 262 | else: |
| 263 | return self.current_frame.readline() |
| 264 | |
| 265 | def tell(self): |
| 266 | if self.file_tell is None: |
| 267 | return None |
| 268 | elif self.current_frame is None: |
| 269 | return self.file_tell() |
| 270 | else: |
| 271 | return self.frame_start + self.current_frame.tell() |
| 272 | |
| 273 | |
| 274 | # Tools used for pickling. |
| 275 | |
| 276 | def _getattribute(obj, name, allow_qualname=False): |
| 277 | dotted_path = name.split(".") |
| 278 | if not allow_qualname and len(dotted_path) > 1: |
| 279 | raise AttributeError("Can't get qualified attribute {!r} on {!r}; " + |
| 280 | "use protocols >= 4 to enable support" |
| 281 | .format(name, obj)) |
| 282 | for subpath in dotted_path: |
| 283 | if subpath == '<locals>': |
| 284 | raise AttributeError("Can't get local attribute {!r} on {!r}" |
| 285 | .format(name, obj)) |
| 286 | try: |
| 287 | obj = getattr(obj, subpath) |
| 288 | except AttributeError: |
| 289 | raise AttributeError("Can't get attribute {!r} on {!r}" |
| 290 | .format(name, obj)) |
| 291 | return obj |
| 292 | |
| 293 | def whichmodule(obj, name, allow_qualname=False): |
| 294 | """Find the module an object belong to.""" |
| 295 | module_name = getattr(obj, '__module__', None) |
| 296 | if module_name is not None: |
| 297 | return module_name |
| 298 | for module_name, module in sys.modules.items(): |
| 299 | if module_name == '__main__' or module is None: |
| 300 | continue |
| 301 | try: |
| 302 | if _getattribute(module, name, allow_qualname) is obj: |
| 303 | return module_name |
| 304 | except AttributeError: |
| 305 | pass |
| 306 | return '__main__' |
| 307 | |
| 308 | def encode_long(x): |
| 309 | r"""Encode a long to a two's complement little-endian binary string. |
| 310 | Note that 0 is a special case, returning an empty string, to save a |
| 311 | byte in the LONG1 pickling context. |
| 312 | |
| 313 | >>> encode_long(0) |
| 314 | b'' |
| 315 | >>> encode_long(255) |
| 316 | b'\xff\x00' |
| 317 | >>> encode_long(32767) |
| 318 | b'\xff\x7f' |
| 319 | >>> encode_long(-256) |
| 320 | b'\x00\xff' |
| 321 | >>> encode_long(-32768) |
| 322 | b'\x00\x80' |
| 323 | >>> encode_long(-128) |
| 324 | b'\x80' |
| 325 | >>> encode_long(127) |
| 326 | b'\x7f' |
| 327 | >>> |
| 328 | """ |
| 329 | if x == 0: |
| 330 | return b'' |
| 331 | nbytes = (x.bit_length() >> 3) + 1 |
| 332 | result = x.to_bytes(nbytes, byteorder='little', signed=True) |
| 333 | if x < 0 and nbytes > 1: |
| 334 | if result[-1] == 0xff and (result[-2] & 0x80) != 0: |
| 335 | result = result[:-1] |
| 336 | return result |
| 337 | |
| 338 | def decode_long(data): |
| 339 | r"""Decode a long from a two's complement little-endian binary string. |
| 340 | |
| 341 | >>> decode_long(b'') |
| 342 | 0 |
| 343 | >>> decode_long(b"\xff\x00") |
| 344 | 255 |
| 345 | >>> decode_long(b"\xff\x7f") |
| 346 | 32767 |
| 347 | >>> decode_long(b"\x00\xff") |
| 348 | -256 |
| 349 | >>> decode_long(b"\x00\x80") |
| 350 | -32768 |
| 351 | >>> decode_long(b"\x80") |
| 352 | -128 |
| 353 | >>> decode_long(b"\x7f") |
| 354 | 127 |
| 355 | """ |
| 356 | return int.from_bytes(data, byteorder='little', signed=True) |
| 357 | |
Skip Montanaro | 23bafc6 | 2001-02-18 03:10:09 +0000 | [diff] [blame] | 358 | |
Guido van Rossum | 1be3175 | 2003-01-28 15:19:53 +0000 | [diff] [blame] | 359 | # Pickling machinery |
| 360 | |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 361 | class _Pickler: |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 362 | |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 363 | def __init__(self, file, protocol=None, *, fix_imports=True): |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 364 | """This takes a binary file for writing a pickle data stream. |
| 365 | |
Guido van Rossum | cf117b0 | 2003-02-09 17:19:41 +0000 | [diff] [blame] | 366 | The optional protocol argument tells the pickler to use the |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 367 | given protocol; supported protocols are 0, 1, 2, 3 and 4. The |
| 368 | default protocol is 3; a backward-incompatible protocol designed for |
| 369 | Python 3. |
Guido van Rossum | f29d3d6 | 2003-01-27 22:47:53 +0000 | [diff] [blame] | 370 | |
Guido van Rossum | 7eff63a | 2003-01-31 19:42:31 +0000 | [diff] [blame] | 371 | Specifying a negative protocol version selects the highest |
Tim Peters | 5bd2a79 | 2003-02-01 16:45:06 +0000 | [diff] [blame] | 372 | protocol version supported. The higher the protocol used, the |
| 373 | more recent the version of Python needed to read the pickle |
| 374 | produced. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 375 | |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 376 | The file argument must have a write() method that accepts a single |
| 377 | bytes argument. It can thus be a file object opened for binary |
| 378 | writing, a io.BytesIO instance, or any other custom object that |
| 379 | meets this interface. |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 380 | |
| 381 | If fix_imports is True and protocol is less than 3, pickle will try to |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 382 | map the new Python 3 names to the old module names used in Python 2, |
| 383 | so that the pickle data stream is readable with Python 2. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 384 | """ |
Guido van Rossum | cf117b0 | 2003-02-09 17:19:41 +0000 | [diff] [blame] | 385 | if protocol is None: |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 386 | protocol = DEFAULT_PROTOCOL |
Guido van Rossum | cf117b0 | 2003-02-09 17:19:41 +0000 | [diff] [blame] | 387 | if protocol < 0: |
Tim Peters | 8587b3c | 2003-02-13 15:44:41 +0000 | [diff] [blame] | 388 | protocol = HIGHEST_PROTOCOL |
| 389 | elif not 0 <= protocol <= HIGHEST_PROTOCOL: |
| 390 | raise ValueError("pickle protocol must be <= %d" % HIGHEST_PROTOCOL) |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 391 | try: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 392 | self._file_write = file.write |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 393 | except AttributeError: |
| 394 | raise TypeError("file must have a 'write' attribute") |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 395 | self.memo = {} |
Guido van Rossum | cf117b0 | 2003-02-09 17:19:41 +0000 | [diff] [blame] | 396 | self.proto = int(protocol) |
| 397 | self.bin = protocol >= 1 |
Guido van Rossum | 5d9113d | 2003-01-29 17:58:45 +0000 | [diff] [blame] | 398 | self.fast = 0 |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 399 | self.fix_imports = fix_imports and protocol < 3 |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 400 | |
Fred Drake | 7f781c9 | 2002-05-01 20:33:53 +0000 | [diff] [blame] | 401 | def clear_memo(self): |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 402 | """Clears the pickler's "memo". |
| 403 | |
| 404 | The memo is the data structure that remembers which objects the |
Tim Peters | b377f8a | 2003-01-28 00:23:36 +0000 | [diff] [blame] | 405 | pickler has already seen, so that shared or recursive objects are |
| 406 | pickled by reference and not by value. This method is useful when |
| 407 | re-using picklers. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 408 | |
| 409 | """ |
Fred Drake | 7f781c9 | 2002-05-01 20:33:53 +0000 | [diff] [blame] | 410 | self.memo.clear() |
| 411 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 412 | def dump(self, obj): |
Tim Peters | 5bd2a79 | 2003-02-01 16:45:06 +0000 | [diff] [blame] | 413 | """Write a pickled representation of obj to the open file.""" |
Alexandre Vassalotti | 3cfcab9 | 2008-12-27 09:30:39 +0000 | [diff] [blame] | 414 | # Check whether Pickler was initialized correctly. This is |
| 415 | # only needed to mimic the behavior of _pickle.Pickler.dump(). |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 416 | if not hasattr(self, "_file_write"): |
Alexandre Vassalotti | 3cfcab9 | 2008-12-27 09:30:39 +0000 | [diff] [blame] | 417 | raise PicklingError("Pickler.__init__() was not called by " |
| 418 | "%s.__init__()" % (self.__class__.__name__,)) |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 419 | if self.proto >= 2: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 420 | self._file_write(PROTO + pack("<B", self.proto)) |
| 421 | if self.proto >= 4: |
| 422 | framer = _Framer(self._file_write) |
| 423 | framer.start_framing() |
| 424 | self.write = framer.write |
| 425 | else: |
| 426 | framer = None |
| 427 | self.write = self._file_write |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 428 | self.save(obj) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 429 | self.write(STOP) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 430 | if framer is not None: |
| 431 | framer.end_framing() |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 432 | |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 433 | def memoize(self, obj): |
| 434 | """Store an object in the memo.""" |
| 435 | |
Tim Peters | e46b73f | 2003-01-27 21:22:10 +0000 | [diff] [blame] | 436 | # The Pickler memo is a dictionary mapping object ids to 2-tuples |
| 437 | # that contain the Unpickler memo key and the object being memoized. |
| 438 | # The memo key is written to the pickle and will become |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 439 | # 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] | 440 | # Pickler memo so that transient objects are kept alive during |
| 441 | # pickling. |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 442 | |
Tim Peters | e46b73f | 2003-01-27 21:22:10 +0000 | [diff] [blame] | 443 | # The use of the Unpickler memo length as the memo key is just a |
| 444 | # convention. The only requirement is that the memo values be unique. |
| 445 | # But there appears no advantage to any other scheme, and this |
Tim Peters | cbd0a32 | 2003-01-28 00:24:43 +0000 | [diff] [blame] | 446 | # scheme allows the Unpickler memo to be implemented as a plain (but |
Tim Peters | e46b73f | 2003-01-27 21:22:10 +0000 | [diff] [blame] | 447 | # growable) array, indexed by memo key. |
Guido van Rossum | 5d9113d | 2003-01-29 17:58:45 +0000 | [diff] [blame] | 448 | if self.fast: |
| 449 | return |
Guido van Rossum | 9b40e80 | 2003-01-30 06:37:41 +0000 | [diff] [blame] | 450 | assert id(obj) not in self.memo |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 451 | idx = len(self.memo) |
| 452 | self.write(self.put(idx)) |
| 453 | self.memo[id(obj)] = idx, obj |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 454 | |
Tim Peters | bb38e30 | 2003-01-27 21:25:41 +0000 | [diff] [blame] | 455 | # Return a PUT (BINPUT, LONG_BINPUT) opcode string, with argument i. |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 456 | def put(self, idx): |
| 457 | if self.proto >= 4: |
| 458 | return MEMOIZE |
| 459 | elif self.bin: |
| 460 | if idx < 256: |
| 461 | return BINPUT + pack("<B", idx) |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 462 | else: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 463 | return LONG_BINPUT + pack("<I", idx) |
| 464 | else: |
| 465 | return PUT + repr(idx).encode("ascii") + b'\n' |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 466 | |
Tim Peters | bb38e30 | 2003-01-27 21:25:41 +0000 | [diff] [blame] | 467 | # Return a GET (BINGET, LONG_BINGET) opcode string, with argument i. |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 468 | def get(self, i): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 469 | if self.bin: |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 470 | if i < 256: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 471 | return BINGET + pack("<B", i) |
Guido van Rossum | 5c938d0 | 2003-01-28 03:03:08 +0000 | [diff] [blame] | 472 | else: |
Antoine Pitrou | bf6ecf9 | 2012-11-24 20:40:21 +0100 | [diff] [blame] | 473 | return LONG_BINGET + pack("<I", i) |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 474 | |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 475 | return GET + repr(i).encode("ascii") + b'\n' |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 476 | |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 477 | def save(self, obj, save_persistent_id=True): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 478 | # Check for persistent id (defined by a subclass) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 479 | pid = self.persistent_id(obj) |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 480 | if pid is not None and save_persistent_id: |
Jeremy Hylton | 5e0f4e7 | 2002-11-13 22:01:27 +0000 | [diff] [blame] | 481 | self.save_pers(pid) |
| 482 | return |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 483 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 484 | # Check the memo |
| 485 | x = self.memo.get(id(obj)) |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 486 | if x is not None: |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 487 | self.write(self.get(x[0])) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 488 | return |
| 489 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 490 | # Check the type dispatch table |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 491 | t = type(obj) |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 492 | f = self.dispatch.get(t) |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 493 | if f is not None: |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 494 | f(self, obj) # Call unbound method with explicit self |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 495 | return |
| 496 | |
Antoine Pitrou | 8d3c290 | 2012-03-04 18:31:48 +0100 | [diff] [blame] | 497 | # Check private dispatch table if any, or else copyreg.dispatch_table |
| 498 | reduce = getattr(self, 'dispatch_table', dispatch_table).get(t) |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 499 | if reduce is not None: |
Guido van Rossum | c53f009 | 2003-02-18 22:05:12 +0000 | [diff] [blame] | 500 | rv = reduce(obj) |
| 501 | else: |
Antoine Pitrou | ffd41d9 | 2011-10-04 09:23:04 +0200 | [diff] [blame] | 502 | # Check for a class with a custom metaclass; treat as regular class |
| 503 | try: |
| 504 | issc = issubclass(t, type) |
| 505 | except TypeError: # t is not a class (old Boost; see SF #502085) |
| 506 | issc = False |
| 507 | if issc: |
| 508 | self.save_global(obj) |
| 509 | return |
| 510 | |
Guido van Rossum | c53f009 | 2003-02-18 22:05:12 +0000 | [diff] [blame] | 511 | # Check for a __reduce_ex__ method, fall back to __reduce__ |
| 512 | reduce = getattr(obj, "__reduce_ex__", None) |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 513 | if reduce is not None: |
Guido van Rossum | c53f009 | 2003-02-18 22:05:12 +0000 | [diff] [blame] | 514 | rv = reduce(self.proto) |
| 515 | else: |
| 516 | reduce = getattr(obj, "__reduce__", None) |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 517 | if reduce is not None: |
Guido van Rossum | c53f009 | 2003-02-18 22:05:12 +0000 | [diff] [blame] | 518 | rv = reduce() |
| 519 | else: |
| 520 | raise PicklingError("Can't pickle %r object: %r" % |
| 521 | (t.__name__, obj)) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 522 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 523 | # Check for string returned by reduce(), meaning "save as global" |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 524 | if isinstance(rv, str): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 525 | self.save_global(obj, rv) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 526 | return |
| 527 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 528 | # Assert that reduce() returned a tuple |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 529 | if not isinstance(rv, tuple): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 530 | raise PicklingError("%s must return string or tuple" % reduce) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 531 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 532 | # Assert that it returned an appropriately sized tuple |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 533 | l = len(rv) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 534 | if not (2 <= l <= 5): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 535 | raise PicklingError("Tuple returned by %s must have " |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 536 | "two to five elements" % reduce) |
Tim Peters | b32a831 | 2003-01-28 00:48:09 +0000 | [diff] [blame] | 537 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 538 | # Save the reduce() output and finally memoize the object |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 539 | self.save_reduce(obj=obj, *rv) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 540 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 541 | def persistent_id(self, obj): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 542 | # This exists so a subclass can override it |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 543 | return None |
| 544 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 545 | def save_pers(self, pid): |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 546 | # Save a persistent id reference |
Tim Peters | bd1cdb9 | 2003-01-28 01:03:10 +0000 | [diff] [blame] | 547 | if self.bin: |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 548 | self.save(pid, save_persistent_id=False) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 549 | self.write(BINPERSID) |
Tim Peters | bd1cdb9 | 2003-01-28 01:03:10 +0000 | [diff] [blame] | 550 | else: |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 551 | self.write(PERSID + str(pid).encode("ascii") + b'\n') |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 552 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 553 | def save_reduce(self, func, args, state=None, listitems=None, |
| 554 | dictitems=None, obj=None): |
Jeremy Hylton | e3a565e | 2003-06-29 16:59:59 +0000 | [diff] [blame] | 555 | # This API is called by some subclasses |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 556 | |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 557 | if not isinstance(args, tuple): |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 558 | raise PicklingError("args from save_reduce() must be a tuple") |
Florent Xicluna | 5d1155c | 2011-10-28 14:45:05 +0200 | [diff] [blame] | 559 | if not callable(func): |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 560 | raise PicklingError("func from save_reduce() must be callable") |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 561 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 562 | save = self.save |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 563 | write = self.write |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 564 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 565 | func_name = getattr(func, "__name__", "") |
| 566 | if self.proto >= 4 and func_name == "__newobj_ex__": |
| 567 | cls, args, kwargs = args |
| 568 | if not hasattr(cls, "__new__"): |
| 569 | raise PicklingError("args[0] from {} args has no __new__" |
| 570 | .format(func_name)) |
| 571 | if obj is not None and cls is not obj.__class__: |
| 572 | raise PicklingError("args[0] from {} args has the wrong class" |
| 573 | .format(func_name)) |
| 574 | save(cls) |
| 575 | save(args) |
| 576 | save(kwargs) |
| 577 | write(NEWOBJ_EX) |
| 578 | elif self.proto >= 2 and func_name == "__newobj__": |
| 579 | # A __reduce__ implementation can direct protocol 2 or newer to |
Guido van Rossum | d053b4b | 2003-01-31 16:51:45 +0000 | [diff] [blame] | 580 | # use the more efficient NEWOBJ opcode, while still |
| 581 | # allowing protocol 0 and 1 to work normally. For this to |
| 582 | # work, the function returned by __reduce__ should be |
| 583 | # called __newobj__, and its first argument should be a |
Florent Xicluna | aa6c1d2 | 2011-12-12 18:54:29 +0100 | [diff] [blame] | 584 | # class. The implementation for __newobj__ |
Guido van Rossum | d053b4b | 2003-01-31 16:51:45 +0000 | [diff] [blame] | 585 | # should be as follows, although pickle has no way to |
| 586 | # verify this: |
| 587 | # |
| 588 | # def __newobj__(cls, *args): |
| 589 | # return cls.__new__(cls, *args) |
| 590 | # |
| 591 | # Protocols 0 and 1 will pickle a reference to __newobj__, |
| 592 | # while protocol 2 (and above) will pickle a reference to |
| 593 | # cls, the remaining args tuple, and the NEWOBJ code, |
| 594 | # which calls cls.__new__(cls, *args) at unpickling time |
| 595 | # (see load_newobj below). If __reduce__ returns a |
| 596 | # three-tuple, the state from the third tuple item will be |
| 597 | # pickled regardless of the protocol, calling __setstate__ |
| 598 | # at unpickling time (see load_build below). |
| 599 | # |
| 600 | # Note that no standard __newobj__ implementation exists; |
| 601 | # you have to provide your own. This is to enforce |
| 602 | # compatibility with Python 2.2 (pickles written using |
| 603 | # protocol 0 or 1 in Python 2.3 should be unpicklable by |
| 604 | # Python 2.2). |
| 605 | cls = args[0] |
| 606 | if not hasattr(cls, "__new__"): |
| 607 | raise PicklingError( |
| 608 | "args[0] from __newobj__ args has no __new__") |
Guido van Rossum | f7f4517 | 2003-01-31 17:17:49 +0000 | [diff] [blame] | 609 | if obj is not None and cls is not obj.__class__: |
| 610 | raise PicklingError( |
| 611 | "args[0] from __newobj__ args has the wrong class") |
Guido van Rossum | d053b4b | 2003-01-31 16:51:45 +0000 | [diff] [blame] | 612 | args = args[1:] |
| 613 | save(cls) |
| 614 | save(args) |
| 615 | write(NEWOBJ) |
| 616 | else: |
| 617 | save(func) |
| 618 | save(args) |
| 619 | write(REDUCE) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 620 | |
Guido van Rossum | f7f4517 | 2003-01-31 17:17:49 +0000 | [diff] [blame] | 621 | if obj is not None: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 622 | # If the object is already in the memo, this means it is |
| 623 | # recursive. In this case, throw away everything we put on the |
| 624 | # stack, and fetch the object back from the memo. |
| 625 | if id(obj) in self.memo: |
| 626 | write(POP + self.get(self.memo[id(obj)][0])) |
| 627 | else: |
| 628 | self.memoize(obj) |
Guido van Rossum | f7f4517 | 2003-01-31 17:17:49 +0000 | [diff] [blame] | 629 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 630 | # More new special cases (that work with older protocols as |
| 631 | # well): when __reduce__ returns a tuple with 4 or 5 items, |
| 632 | # the 4th and 5th item should be iterators that provide list |
| 633 | # items and dict items (as (key, value) tuples), or None. |
| 634 | |
| 635 | if listitems is not None: |
| 636 | self._batch_appends(listitems) |
| 637 | |
| 638 | if dictitems is not None: |
| 639 | self._batch_setitems(dictitems) |
| 640 | |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 641 | if state is not None: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 642 | save(state) |
| 643 | write(BUILD) |
| 644 | |
Guido van Rossum | bc64e22 | 2003-01-28 16:34:19 +0000 | [diff] [blame] | 645 | # Methods below this point are dispatched through the dispatch table |
| 646 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 647 | dispatch = {} |
| 648 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 649 | def save_none(self, obj): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 650 | self.write(NONE) |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 651 | dispatch[type(None)] = save_none |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 652 | |
Łukasz Langa | f3078fb | 2012-03-12 19:46:12 +0100 | [diff] [blame] | 653 | def save_ellipsis(self, obj): |
| 654 | self.save_global(Ellipsis, 'Ellipsis') |
| 655 | dispatch[type(Ellipsis)] = save_ellipsis |
| 656 | |
| 657 | def save_notimplemented(self, obj): |
| 658 | self.save_global(NotImplemented, 'NotImplemented') |
| 659 | dispatch[type(NotImplemented)] = save_notimplemented |
| 660 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 661 | def save_bool(self, obj): |
Guido van Rossum | 7d97d31 | 2003-01-28 04:25:27 +0000 | [diff] [blame] | 662 | if self.proto >= 2: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 663 | self.write(NEWTRUE if obj else NEWFALSE) |
Guido van Rossum | 7d97d31 | 2003-01-28 04:25:27 +0000 | [diff] [blame] | 664 | else: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 665 | self.write(TRUE if obj else FALSE) |
Guido van Rossum | 77f6a65 | 2002-04-03 22:41:51 +0000 | [diff] [blame] | 666 | dispatch[bool] = save_bool |
| 667 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 668 | def save_long(self, obj): |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 669 | if self.bin: |
| 670 | # If the int is small enough to fit in a signed 4-byte 2's-comp |
| 671 | # format, we can store it more efficiently than the general |
| 672 | # case. |
| 673 | # First one- and two-byte unsigned ints: |
| 674 | if obj >= 0: |
| 675 | if obj <= 0xff: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 676 | self.write(BININT1 + pack("<B", obj)) |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 677 | return |
| 678 | if obj <= 0xffff: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 679 | self.write(BININT2 + pack("<H", obj)) |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 680 | return |
| 681 | # Next check for 4-byte signed ints: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 682 | if -0x80000000 <= obj <= 0x7fffffff: |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 683 | self.write(BININT + pack("<i", obj)) |
| 684 | return |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 685 | if self.proto >= 2: |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 686 | encoded = encode_long(obj) |
| 687 | n = len(encoded) |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 688 | if n < 256: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 689 | self.write(LONG1 + pack("<B", n) + encoded) |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 690 | else: |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 691 | self.write(LONG4 + pack("<i", n) + encoded) |
Tim Peters | ee1a53c | 2003-02-02 02:57:53 +0000 | [diff] [blame] | 692 | return |
Mark Dickinson | 8dd0514 | 2009-01-20 20:43:58 +0000 | [diff] [blame] | 693 | self.write(LONG + repr(obj).encode("ascii") + b'L\n') |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 694 | dispatch[int] = save_long |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 695 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 696 | def save_float(self, obj): |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 697 | if self.bin: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 698 | self.write(BINFLOAT + pack('>d', obj)) |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 699 | else: |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 700 | self.write(FLOAT + repr(obj).encode("ascii") + b'\n') |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 701 | dispatch[float] = save_float |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 702 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 703 | def save_bytes(self, obj): |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 704 | if self.proto < 3: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 705 | if not obj: # bytes object is empty |
Alexandre Vassalotti | 3bfc65a | 2011-12-13 13:08:09 -0500 | [diff] [blame] | 706 | self.save_reduce(bytes, (), obj=obj) |
| 707 | else: |
| 708 | self.save_reduce(codecs.encode, |
| 709 | (str(obj, 'latin1'), 'latin1'), obj=obj) |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 710 | return |
| 711 | n = len(obj) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 712 | if n <= 0xff: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 713 | self.write(SHORT_BINBYTES + pack("<B", n) + obj) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 714 | elif n > 0xffffffff and self.proto >= 4: |
| 715 | self.write(BINBYTES8 + pack("<Q", n) + obj) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 716 | else: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 717 | self.write(BINBYTES + pack("<I", n) + obj) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 718 | self.memoize(obj) |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 719 | dispatch[bytes] = save_bytes |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 720 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 721 | def save_str(self, obj): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 722 | if self.bin: |
Victor Stinner | 485fb56 | 2010-04-13 11:07:24 +0000 | [diff] [blame] | 723 | encoded = obj.encode('utf-8', 'surrogatepass') |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 724 | n = len(encoded) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 725 | if n <= 0xff and self.proto >= 4: |
| 726 | self.write(SHORT_BINUNICODE + pack("<B", n) + encoded) |
| 727 | elif n > 0xffffffff and self.proto >= 4: |
| 728 | self.write(BINUNICODE8 + pack("<Q", n) + encoded) |
| 729 | else: |
| 730 | self.write(BINUNICODE + pack("<I", n) + encoded) |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 731 | else: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 732 | obj = obj.replace("\\", "\\u005c") |
| 733 | obj = obj.replace("\n", "\\u000a") |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 734 | self.write(UNICODE + obj.encode('raw-unicode-escape') + |
| 735 | b'\n') |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 736 | self.memoize(obj) |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 737 | dispatch[str] = save_str |
Tim Peters | 658cba6 | 2001-02-09 20:06:00 +0000 | [diff] [blame] | 738 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 739 | def save_tuple(self, obj): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 740 | if not obj: # tuple is empty |
| 741 | if self.bin: |
| 742 | self.write(EMPTY_TUPLE) |
Tim Peters | 1d63c9f | 2003-02-02 20:29:39 +0000 | [diff] [blame] | 743 | else: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 744 | self.write(MARK + TUPLE) |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 745 | return |
| 746 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 747 | n = len(obj) |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 748 | save = self.save |
| 749 | memo = self.memo |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 750 | if n <= 3 and self.proto >= 2: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 751 | for element in obj: |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 752 | save(element) |
| 753 | # Subtle. Same as in the big comment below. |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 754 | if id(obj) in memo: |
| 755 | get = self.get(memo[id(obj)][0]) |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 756 | self.write(POP * n + get) |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 757 | else: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 758 | self.write(_tuplesize2code[n]) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 759 | self.memoize(obj) |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 760 | return |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 761 | |
Tim Peters | 1d63c9f | 2003-02-02 20:29:39 +0000 | [diff] [blame] | 762 | # proto 0 or proto 1 and tuple isn't empty, or proto > 1 and tuple |
Tim Peters | ff57bff | 2003-01-28 05:34:53 +0000 | [diff] [blame] | 763 | # has more than 3 elements. |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 764 | write = self.write |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 765 | write(MARK) |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 766 | for element in obj: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 767 | save(element) |
| 768 | |
Tim Peters | 1d63c9f | 2003-02-02 20:29:39 +0000 | [diff] [blame] | 769 | if id(obj) in memo: |
Tim Peters | f558da0 | 2003-01-28 02:09:55 +0000 | [diff] [blame] | 770 | # Subtle. d was not in memo when we entered save_tuple(), so |
| 771 | # the process of saving the tuple's elements must have saved |
| 772 | # the tuple itself: the tuple is recursive. The proper action |
| 773 | # now is to throw away everything we put on the stack, and |
| 774 | # simply GET the tuple (it's already constructed). This check |
| 775 | # could have been done in the "for element" loop instead, but |
| 776 | # recursive tuples are a rare thing. |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 777 | get = self.get(memo[id(obj)][0]) |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 778 | if self.bin: |
Tim Peters | f558da0 | 2003-01-28 02:09:55 +0000 | [diff] [blame] | 779 | write(POP_MARK + get) |
| 780 | else: # proto 0 -- POP_MARK not available |
Tim Peters | d97da80 | 2003-01-28 05:48:29 +0000 | [diff] [blame] | 781 | write(POP * (n+1) + get) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 782 | return |
| 783 | |
Tim Peters | 1d63c9f | 2003-02-02 20:29:39 +0000 | [diff] [blame] | 784 | # No recursion. |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 785 | write(TUPLE) |
Tim Peters | 1d63c9f | 2003-02-02 20:29:39 +0000 | [diff] [blame] | 786 | self.memoize(obj) |
Jeremy Hylton | 3422c99 | 2003-01-24 19:29:52 +0000 | [diff] [blame] | 787 | |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 788 | dispatch[tuple] = save_tuple |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 789 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 790 | def save_list(self, obj): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 791 | if self.bin: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 792 | self.write(EMPTY_LIST) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 793 | else: # proto 0 -- can't use EMPTY_LIST |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 794 | self.write(MARK + LIST) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 795 | |
| 796 | self.memoize(obj) |
Alexandre Vassalotti | c7db1d6 | 2008-05-14 21:57:18 +0000 | [diff] [blame] | 797 | self._batch_appends(obj) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 798 | |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 799 | dispatch[list] = save_list |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 800 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 801 | _BATCHSIZE = 1000 |
| 802 | |
| 803 | def _batch_appends(self, items): |
| 804 | # Helper to batch up APPENDS sequences |
| 805 | save = self.save |
| 806 | write = self.write |
| 807 | |
| 808 | if not self.bin: |
| 809 | for x in items: |
| 810 | save(x) |
| 811 | write(APPEND) |
| 812 | return |
| 813 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 814 | it = iter(items) |
| 815 | while True: |
| 816 | tmp = list(islice(it, self._BATCHSIZE)) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 817 | n = len(tmp) |
| 818 | if n > 1: |
| 819 | write(MARK) |
| 820 | for x in tmp: |
| 821 | save(x) |
| 822 | write(APPENDS) |
| 823 | elif n: |
| 824 | save(tmp[0]) |
| 825 | write(APPEND) |
| 826 | # else tmp is empty, and we're done |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 827 | if n < self._BATCHSIZE: |
| 828 | return |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 829 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 830 | def save_dict(self, obj): |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 831 | if self.bin: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 832 | self.write(EMPTY_DICT) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 833 | else: # proto 0 -- can't use EMPTY_DICT |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 834 | self.write(MARK + DICT) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 835 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 836 | self.memoize(obj) |
Alexandre Vassalotti | c7db1d6 | 2008-05-14 21:57:18 +0000 | [diff] [blame] | 837 | self._batch_setitems(obj.items()) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 838 | |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 839 | dispatch[dict] = save_dict |
| 840 | if PyStringMap is not None: |
Jeremy Hylton | 2b9d029 | 1998-05-27 22:38:22 +0000 | [diff] [blame] | 841 | dispatch[PyStringMap] = save_dict |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 842 | |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 843 | def _batch_setitems(self, items): |
| 844 | # Helper to batch up SETITEMS sequences; proto >= 1 only |
| 845 | save = self.save |
| 846 | write = self.write |
| 847 | |
| 848 | if not self.bin: |
| 849 | for k, v in items: |
| 850 | save(k) |
| 851 | save(v) |
| 852 | write(SETITEM) |
| 853 | return |
| 854 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 855 | it = iter(items) |
| 856 | while True: |
| 857 | tmp = list(islice(it, self._BATCHSIZE)) |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 858 | n = len(tmp) |
| 859 | if n > 1: |
| 860 | write(MARK) |
| 861 | for k, v in tmp: |
| 862 | save(k) |
| 863 | save(v) |
| 864 | write(SETITEMS) |
| 865 | elif n: |
| 866 | k, v = tmp[0] |
| 867 | save(k) |
| 868 | save(v) |
| 869 | write(SETITEM) |
| 870 | # else tmp is empty, and we're done |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 871 | if n < self._BATCHSIZE: |
| 872 | return |
Guido van Rossum | 25cb7df | 2003-01-31 18:53:21 +0000 | [diff] [blame] | 873 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 874 | def save_set(self, obj): |
| 875 | save = self.save |
| 876 | write = self.write |
| 877 | |
| 878 | if self.proto < 4: |
| 879 | self.save_reduce(set, (list(obj),), obj=obj) |
| 880 | return |
| 881 | |
| 882 | write(EMPTY_SET) |
| 883 | self.memoize(obj) |
| 884 | |
| 885 | it = iter(obj) |
| 886 | while True: |
| 887 | batch = list(islice(it, self._BATCHSIZE)) |
| 888 | n = len(batch) |
| 889 | if n > 0: |
| 890 | write(MARK) |
| 891 | for item in batch: |
| 892 | save(item) |
| 893 | write(ADDITEMS) |
| 894 | if n < self._BATCHSIZE: |
| 895 | return |
| 896 | dispatch[set] = save_set |
| 897 | |
| 898 | def save_frozenset(self, obj): |
| 899 | save = self.save |
| 900 | write = self.write |
| 901 | |
| 902 | if self.proto < 4: |
| 903 | self.save_reduce(frozenset, (list(obj),), obj=obj) |
| 904 | return |
| 905 | |
| 906 | write(MARK) |
| 907 | for item in obj: |
| 908 | save(item) |
| 909 | |
| 910 | if id(obj) in self.memo: |
| 911 | # If the object is already in the memo, this means it is |
| 912 | # recursive. In this case, throw away everything we put on the |
| 913 | # stack, and fetch the object back from the memo. |
| 914 | write(POP_MARK + self.get(self.memo[id(obj)][0])) |
| 915 | return |
| 916 | |
| 917 | write(FROZENSET) |
| 918 | self.memoize(obj) |
| 919 | dispatch[frozenset] = save_frozenset |
| 920 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 921 | def save_global(self, obj, name=None): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 922 | write = self.write |
| 923 | memo = self.memo |
| 924 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 925 | if name is None and self.proto >= 4: |
| 926 | name = getattr(obj, '__qualname__', None) |
Tim Peters | c32d824 | 2001-04-10 02:48:53 +0000 | [diff] [blame] | 927 | if name is None: |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 928 | name = obj.__name__ |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 929 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 930 | module_name = whichmodule(obj, name, allow_qualname=self.proto >= 4) |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 931 | try: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 932 | __import__(module_name, level=0) |
| 933 | module = sys.modules[module_name] |
| 934 | obj2 = _getattribute(module, name, allow_qualname=self.proto >= 4) |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 935 | except (ImportError, KeyError, AttributeError): |
| 936 | raise PicklingError( |
| 937 | "Can't pickle %r: it's not found as %s.%s" % |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 938 | (obj, module_name, name)) |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 939 | else: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 940 | if obj2 is not obj: |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 941 | raise PicklingError( |
| 942 | "Can't pickle %r: it's not the same object as %s.%s" % |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 943 | (obj, module_name, name)) |
Guido van Rossum | b0a98e9 | 2001-08-17 18:49:52 +0000 | [diff] [blame] | 944 | |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 945 | if self.proto >= 2: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 946 | code = _extension_registry.get((module_name, name)) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 947 | if code: |
| 948 | assert code > 0 |
| 949 | if code <= 0xff: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 950 | write(EXT1 + pack("<B", code)) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 951 | elif code <= 0xffff: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 952 | write(EXT2 + pack("<H", code)) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 953 | else: |
| 954 | write(EXT4 + pack("<i", code)) |
| 955 | return |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 956 | # Non-ASCII identifiers are supported only with protocols >= 3. |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 957 | if self.proto >= 4: |
| 958 | self.save(module_name) |
| 959 | self.save(name) |
| 960 | write(STACK_GLOBAL) |
| 961 | elif self.proto >= 3: |
| 962 | write(GLOBAL + bytes(module_name, "utf-8") + b'\n' + |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 963 | bytes(name, "utf-8") + b'\n') |
| 964 | else: |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 965 | if self.fix_imports: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 966 | r_name_mapping = _compat_pickle.REVERSE_NAME_MAPPING |
| 967 | r_import_mapping = _compat_pickle.REVERSE_IMPORT_MAPPING |
| 968 | if (module_name, name) in r_name_mapping: |
| 969 | module_name, name = r_name_mapping[(module_name, name)] |
| 970 | if module_name in r_import_mapping: |
| 971 | module_name = r_import_mapping[module_name] |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 972 | try: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 973 | write(GLOBAL + bytes(module_name, "ascii") + b'\n' + |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 974 | bytes(name, "ascii") + b'\n') |
| 975 | except UnicodeEncodeError: |
| 976 | raise PicklingError( |
| 977 | "can't pickle global identifier '%s.%s' using " |
| 978 | "pickle protocol %i" % (module, name, self.proto)) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 979 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 980 | self.memoize(obj) |
Tim Peters | 3b76983 | 2003-01-28 03:51:36 +0000 | [diff] [blame] | 981 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 982 | def save_method(self, obj): |
| 983 | if obj.__self__ is None or type(obj.__self__) is ModuleType: |
| 984 | self.save_global(obj) |
| 985 | else: |
| 986 | self.save_reduce(getattr, (obj.__self__, obj.__name__), obj=obj) |
| 987 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 988 | dispatch[FunctionType] = save_global |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 989 | dispatch[BuiltinFunctionType] = save_method |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 990 | dispatch[type] = save_global |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 991 | |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 992 | |
Guido van Rossum | 1be3175 | 2003-01-28 15:19:53 +0000 | [diff] [blame] | 993 | # Unpickling machinery |
| 994 | |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 995 | class _Unpickler: |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 996 | |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 997 | def __init__(self, file, *, fix_imports=True, |
| 998 | encoding="ASCII", errors="strict"): |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 999 | """This takes a binary file for reading a pickle data stream. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 1000 | |
Tim Peters | 5bd2a79 | 2003-02-01 16:45:06 +0000 | [diff] [blame] | 1001 | The protocol version of the pickle is detected automatically, so no |
| 1002 | proto argument is needed. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 1003 | |
Guido van Rossum | feea078 | 2007-10-10 18:00:50 +0000 | [diff] [blame] | 1004 | The file-like object must have two methods, a read() method |
| 1005 | that takes an integer argument, and a readline() method that |
| 1006 | requires no arguments. Both methods should return bytes. |
| 1007 | Thus file-like object can be a binary file object opened for |
| 1008 | reading, a BytesIO object, or any other custom object that |
| 1009 | meets this interface. |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 1010 | |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 1011 | Optional keyword arguments are *fix_imports*, *encoding* and *errors*, |
| 1012 | which are used to control compatiblity support for pickle stream |
| 1013 | generated by Python 2.x. If *fix_imports* is True, pickle will try to |
| 1014 | map the old Python 2.x names to the new names used in Python 3.x. The |
| 1015 | *encoding* and *errors* tell pickle how to decode 8-bit string |
| 1016 | instances pickled by Python 2.x; these default to 'ASCII' and |
| 1017 | 'strict', respectively. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 1018 | """ |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1019 | self._file_readline = file.readline |
| 1020 | self._file_read = file.read |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1021 | self.memo = {} |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 1022 | self.encoding = encoding |
| 1023 | self.errors = errors |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 1024 | self.proto = 0 |
| 1025 | self.fix_imports = fix_imports |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1026 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1027 | def load(self): |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 1028 | """Read a pickled object representation from the open file. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 1029 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 1030 | Return the reconstituted object hierarchy specified in the file. |
Raymond Hettinger | aef22fb | 2002-05-29 16:18:42 +0000 | [diff] [blame] | 1031 | """ |
Alexandre Vassalotti | 3cfcab9 | 2008-12-27 09:30:39 +0000 | [diff] [blame] | 1032 | # Check whether Unpickler was initialized correctly. This is |
| 1033 | # only needed to mimic the behavior of _pickle.Unpickler.dump(). |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1034 | if not hasattr(self, "_file_read"): |
Alexandre Vassalotti | 3cfcab9 | 2008-12-27 09:30:39 +0000 | [diff] [blame] | 1035 | raise UnpicklingError("Unpickler.__init__() was not called by " |
| 1036 | "%s.__init__()" % (self.__class__.__name__,)) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1037 | self._unframer = _Unframer(self._file_read, self._file_readline) |
| 1038 | self.read = self._unframer.read |
| 1039 | self.readline = self._unframer.readline |
Jeremy Hylton | 20747fa | 2001-11-09 16:15:04 +0000 | [diff] [blame] | 1040 | self.mark = object() # any new unique object |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1041 | self.stack = [] |
| 1042 | self.append = self.stack.append |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1043 | self.proto = 0 |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1044 | read = self.read |
| 1045 | dispatch = self.dispatch |
| 1046 | try: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1047 | while True: |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1048 | key = read(1) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1049 | if not key: |
| 1050 | raise EOFError |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 1051 | assert isinstance(key, bytes_types) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1052 | dispatch[key[0]](self) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 1053 | except _Stop as stopinst: |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 1054 | return stopinst.value |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1055 | |
Tim Peters | c23d18a | 2003-01-28 01:41:51 +0000 | [diff] [blame] | 1056 | # Return largest index k such that self.stack[k] is self.mark. |
| 1057 | # If the stack doesn't contain a mark, eventually raises IndexError. |
| 1058 | # This could be sped by maintaining another stack, of indices at which |
| 1059 | # the mark appears. For that matter, the latter stack would suffice, |
| 1060 | # and we wouldn't need to push mark objects on self.stack at all. |
| 1061 | # Doing so is probably a good thing, though, since if the pickle is |
| 1062 | # corrupt (or hostile) we may get a clue from finding self.mark embedded |
| 1063 | # in unpickled objects. |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1064 | def marker(self): |
| 1065 | stack = self.stack |
| 1066 | mark = self.mark |
| 1067 | k = len(stack)-1 |
| 1068 | while stack[k] is not mark: k = k-1 |
| 1069 | return k |
| 1070 | |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1071 | def persistent_load(self, pid): |
Benjamin Peterson | 49956b2 | 2009-01-10 17:05:44 +0000 | [diff] [blame] | 1072 | raise UnpicklingError("unsupported persistent id encountered") |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1073 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1074 | dispatch = {} |
| 1075 | |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1076 | def load_proto(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1077 | proto = self.read(1)[0] |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 1078 | if not 0 <= proto <= HIGHEST_PROTOCOL: |
Guido van Rossum | 26d95c3 | 2007-08-27 23:18:54 +0000 | [diff] [blame] | 1079 | raise ValueError("unsupported pickle protocol: %d" % proto) |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 1080 | self.proto = proto |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1081 | if proto >= 4: |
| 1082 | self._unframer.framing_enabled = True |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1083 | dispatch[PROTO[0]] = load_proto |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1084 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1085 | def load_persid(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1086 | pid = self.readline()[:-1].decode("ascii") |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1087 | self.append(self.persistent_load(pid)) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1088 | dispatch[PERSID[0]] = load_persid |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1089 | |
| 1090 | def load_binpersid(self): |
Raymond Hettinger | 46ac8eb | 2002-06-30 03:39:14 +0000 | [diff] [blame] | 1091 | pid = self.stack.pop() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1092 | self.append(self.persistent_load(pid)) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1093 | dispatch[BINPERSID[0]] = load_binpersid |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1094 | |
| 1095 | def load_none(self): |
| 1096 | self.append(None) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1097 | dispatch[NONE[0]] = load_none |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1098 | |
Guido van Rossum | 7d97d31 | 2003-01-28 04:25:27 +0000 | [diff] [blame] | 1099 | def load_false(self): |
| 1100 | self.append(False) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1101 | dispatch[NEWFALSE[0]] = load_false |
Guido van Rossum | 7d97d31 | 2003-01-28 04:25:27 +0000 | [diff] [blame] | 1102 | |
| 1103 | def load_true(self): |
| 1104 | self.append(True) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1105 | dispatch[NEWTRUE[0]] = load_true |
Guido van Rossum | 7d97d31 | 2003-01-28 04:25:27 +0000 | [diff] [blame] | 1106 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1107 | def load_int(self): |
Tim Peters | 19ef62d | 2001-08-28 22:21:18 +0000 | [diff] [blame] | 1108 | data = self.readline() |
Guido van Rossum | e276339 | 2002-04-05 19:30:08 +0000 | [diff] [blame] | 1109 | if data == FALSE[1:]: |
| 1110 | val = False |
| 1111 | elif data == TRUE[1:]: |
| 1112 | val = True |
| 1113 | else: |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1114 | val = int(data, 0) |
Guido van Rossum | e276339 | 2002-04-05 19:30:08 +0000 | [diff] [blame] | 1115 | self.append(val) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1116 | dispatch[INT[0]] = load_int |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1117 | |
| 1118 | def load_binint(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1119 | self.append(unpack('<i', self.read(4))[0]) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1120 | dispatch[BININT[0]] = load_binint |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1121 | |
| 1122 | def load_binint1(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1123 | self.append(self.read(1)[0]) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1124 | dispatch[BININT1[0]] = load_binint1 |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1125 | |
| 1126 | def load_binint2(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1127 | self.append(unpack('<H', self.read(2))[0]) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1128 | dispatch[BININT2[0]] = load_binint2 |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 1129 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1130 | def load_long(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1131 | val = self.readline()[:-1] |
| 1132 | if val and val[-1] == b'L'[0]: |
Mark Dickinson | 8dd0514 | 2009-01-20 20:43:58 +0000 | [diff] [blame] | 1133 | val = val[:-1] |
Guido van Rossum | feea078 | 2007-10-10 18:00:50 +0000 | [diff] [blame] | 1134 | self.append(int(val, 0)) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1135 | dispatch[LONG[0]] = load_long |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1136 | |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1137 | def load_long1(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1138 | n = self.read(1)[0] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1139 | data = self.read(n) |
| 1140 | self.append(decode_long(data)) |
| 1141 | dispatch[LONG1[0]] = load_long1 |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1142 | |
| 1143 | def load_long4(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1144 | n, = unpack('<i', self.read(4)) |
Antoine Pitrou | bf6ecf9 | 2012-11-24 20:40:21 +0100 | [diff] [blame] | 1145 | if n < 0: |
| 1146 | # Corrupt or hostile pickle -- we never write one like this |
Alexandre Vassalotti | cc75717 | 2013-04-14 02:25:10 -0700 | [diff] [blame] | 1147 | raise UnpicklingError("LONG pickle has negative byte count") |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1148 | data = self.read(n) |
| 1149 | self.append(decode_long(data)) |
| 1150 | dispatch[LONG4[0]] = load_long4 |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1151 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1152 | def load_float(self): |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 1153 | self.append(float(self.readline()[:-1])) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1154 | dispatch[FLOAT[0]] = load_float |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1155 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1156 | def load_binfloat(self): |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 1157 | self.append(unpack('>d', self.read(8))[0]) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1158 | dispatch[BINFLOAT[0]] = load_binfloat |
Guido van Rossum | d370379 | 1998-10-22 20:15:36 +0000 | [diff] [blame] | 1159 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1160 | def load_string(self): |
Alexandre Vassalotti | 7c5e094 | 2013-04-15 23:14:55 -0700 | [diff] [blame] | 1161 | data = self.readline()[:-1] |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1162 | # Strip outermost quotes |
Alexandre Vassalotti | 7c5e094 | 2013-04-15 23:14:55 -0700 | [diff] [blame] | 1163 | if len(data) >= 2 and data[0] == data[-1] and data[0] in b'"\'': |
| 1164 | data = data[1:-1] |
Martin v. Löwis | 8a8da79 | 2002-08-14 07:46:28 +0000 | [diff] [blame] | 1165 | else: |
Alexandre Vassalotti | 7c5e094 | 2013-04-15 23:14:55 -0700 | [diff] [blame] | 1166 | raise UnpicklingError("the STRING opcode argument must be quoted") |
| 1167 | self.append(codecs.escape_decode(data)[0] |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1168 | .decode(self.encoding, self.errors)) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1169 | dispatch[STRING[0]] = load_string |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1170 | |
| 1171 | def load_binstring(self): |
Antoine Pitrou | bf6ecf9 | 2012-11-24 20:40:21 +0100 | [diff] [blame] | 1172 | # Deprecated BINSTRING uses signed 32-bit length |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1173 | len, = unpack('<i', self.read(4)) |
Antoine Pitrou | bf6ecf9 | 2012-11-24 20:40:21 +0100 | [diff] [blame] | 1174 | if len < 0: |
Alexandre Vassalotti | cc75717 | 2013-04-14 02:25:10 -0700 | [diff] [blame] | 1175 | raise UnpicklingError("BINSTRING pickle has negative byte count") |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 1176 | data = self.read(len) |
| 1177 | value = str(data, self.encoding, self.errors) |
| 1178 | self.append(value) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1179 | dispatch[BINSTRING[0]] = load_binstring |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1180 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1181 | def load_binbytes(self): |
Antoine Pitrou | bf6ecf9 | 2012-11-24 20:40:21 +0100 | [diff] [blame] | 1182 | len, = unpack('<I', self.read(4)) |
| 1183 | if len > maxsize: |
Alexandre Vassalotti | cc75717 | 2013-04-14 02:25:10 -0700 | [diff] [blame] | 1184 | raise UnpicklingError("BINBYTES exceeds system's maximum size " |
| 1185 | "of %d bytes" % maxsize) |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 1186 | self.append(self.read(len)) |
| 1187 | dispatch[BINBYTES[0]] = load_binbytes |
| 1188 | |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 1189 | def load_unicode(self): |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1190 | self.append(str(self.readline()[:-1], 'raw-unicode-escape')) |
| 1191 | dispatch[UNICODE[0]] = load_unicode |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 1192 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1193 | def load_binunicode(self): |
Antoine Pitrou | bf6ecf9 | 2012-11-24 20:40:21 +0100 | [diff] [blame] | 1194 | len, = unpack('<I', self.read(4)) |
| 1195 | if len > maxsize: |
Alexandre Vassalotti | cc75717 | 2013-04-14 02:25:10 -0700 | [diff] [blame] | 1196 | raise UnpicklingError("BINUNICODE exceeds system's maximum size " |
| 1197 | "of %d bytes" % maxsize) |
Victor Stinner | 485fb56 | 2010-04-13 11:07:24 +0000 | [diff] [blame] | 1198 | self.append(str(self.read(len), 'utf-8', 'surrogatepass')) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1199 | dispatch[BINUNICODE[0]] = load_binunicode |
Guido van Rossum | b5f2f1b | 2000-03-10 23:20:09 +0000 | [diff] [blame] | 1200 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1201 | def load_binunicode8(self): |
| 1202 | len, = unpack('<Q', self.read(8)) |
| 1203 | if len > maxsize: |
| 1204 | raise UnpicklingError("BINUNICODE8 exceeds system's maximum size " |
| 1205 | "of %d bytes" % maxsize) |
| 1206 | self.append(str(self.read(len), 'utf-8', 'surrogatepass')) |
| 1207 | dispatch[BINUNICODE8[0]] = load_binunicode8 |
| 1208 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1209 | def load_short_binstring(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1210 | len = self.read(1)[0] |
| 1211 | data = self.read(len) |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 1212 | value = str(data, self.encoding, self.errors) |
| 1213 | self.append(value) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1214 | dispatch[SHORT_BINSTRING[0]] = load_short_binstring |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1215 | |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 1216 | def load_short_binbytes(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1217 | len = self.read(1)[0] |
| 1218 | self.append(self.read(len)) |
Guido van Rossum | f416981 | 2008-03-17 22:56:06 +0000 | [diff] [blame] | 1219 | dispatch[SHORT_BINBYTES[0]] = load_short_binbytes |
| 1220 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1221 | def load_short_binunicode(self): |
| 1222 | len = self.read(1)[0] |
| 1223 | self.append(str(self.read(len), 'utf-8', 'surrogatepass')) |
| 1224 | dispatch[SHORT_BINUNICODE[0]] = load_short_binunicode |
| 1225 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1226 | def load_tuple(self): |
| 1227 | k = self.marker() |
| 1228 | self.stack[k:] = [tuple(self.stack[k+1:])] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1229 | dispatch[TUPLE[0]] = load_tuple |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1230 | |
| 1231 | def load_empty_tuple(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1232 | self.append(()) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1233 | dispatch[EMPTY_TUPLE[0]] = load_empty_tuple |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1234 | |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 1235 | def load_tuple1(self): |
| 1236 | self.stack[-1] = (self.stack[-1],) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1237 | dispatch[TUPLE1[0]] = load_tuple1 |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 1238 | |
| 1239 | def load_tuple2(self): |
| 1240 | self.stack[-2:] = [(self.stack[-2], self.stack[-1])] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1241 | dispatch[TUPLE2[0]] = load_tuple2 |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 1242 | |
| 1243 | def load_tuple3(self): |
| 1244 | self.stack[-3:] = [(self.stack[-3], self.stack[-2], self.stack[-1])] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1245 | dispatch[TUPLE3[0]] = load_tuple3 |
Guido van Rossum | 44f0ea5 | 2003-01-28 04:14:51 +0000 | [diff] [blame] | 1246 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1247 | def load_empty_list(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1248 | self.append([]) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1249 | dispatch[EMPTY_LIST[0]] = load_empty_list |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1250 | |
| 1251 | def load_empty_dictionary(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1252 | self.append({}) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1253 | dispatch[EMPTY_DICT[0]] = load_empty_dictionary |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1254 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1255 | def load_empty_set(self): |
| 1256 | self.append(set()) |
| 1257 | dispatch[EMPTY_SET[0]] = load_empty_set |
| 1258 | |
| 1259 | def load_frozenset(self): |
| 1260 | k = self.marker() |
| 1261 | self.stack[k:] = [frozenset(self.stack[k+1:])] |
| 1262 | dispatch[FROZENSET[0]] = load_frozenset |
| 1263 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1264 | def load_list(self): |
| 1265 | k = self.marker() |
| 1266 | self.stack[k:] = [self.stack[k+1:]] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1267 | dispatch[LIST[0]] = load_list |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1268 | |
| 1269 | def load_dict(self): |
| 1270 | k = self.marker() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1271 | items = self.stack[k+1:] |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1272 | d = {items[i]: items[i+1] |
| 1273 | for i in range(0, len(items), 2)} |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1274 | self.stack[k:] = [d] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1275 | dispatch[DICT[0]] = load_dict |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1276 | |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1277 | # INST and OBJ differ only in how they get a class object. It's not |
| 1278 | # only sensible to do the rest in a common routine, the two routines |
| 1279 | # previously diverged and grew different bugs. |
| 1280 | # klass is the class to instantiate, and k points to the topmost mark |
| 1281 | # object, following which are the arguments for klass.__init__. |
| 1282 | def _instantiate(self, klass, k): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1283 | args = tuple(self.stack[k+1:]) |
| 1284 | del self.stack[k:] |
Alexander Belopolsky | d92f040 | 2010-07-17 22:50:45 +0000 | [diff] [blame] | 1285 | if (args or not isinstance(klass, type) or |
| 1286 | hasattr(klass, "__getinitargs__")): |
Guido van Rossum | 743d17e | 1998-09-15 20:25:57 +0000 | [diff] [blame] | 1287 | try: |
Guido van Rossum | b26a97a | 2003-01-28 22:29:13 +0000 | [diff] [blame] | 1288 | value = klass(*args) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 1289 | except TypeError as err: |
Guido van Rossum | 26d95c3 | 2007-08-27 23:18:54 +0000 | [diff] [blame] | 1290 | raise TypeError("in constructor for %s: %s" % |
| 1291 | (klass.__name__, str(err)), sys.exc_info()[2]) |
Alexander Belopolsky | d92f040 | 2010-07-17 22:50:45 +0000 | [diff] [blame] | 1292 | else: |
| 1293 | value = klass.__new__(klass) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1294 | self.append(value) |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1295 | |
| 1296 | def load_inst(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1297 | module = self.readline()[:-1].decode("ascii") |
| 1298 | name = self.readline()[:-1].decode("ascii") |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1299 | klass = self.find_class(module, name) |
| 1300 | self._instantiate(klass, self.marker()) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1301 | dispatch[INST[0]] = load_inst |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1302 | |
| 1303 | def load_obj(self): |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1304 | # Stack is ... markobject classobject arg1 arg2 ... |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1305 | k = self.marker() |
Tim Peters | d01c1e9 | 2003-01-30 15:41:46 +0000 | [diff] [blame] | 1306 | klass = self.stack.pop(k+1) |
| 1307 | self._instantiate(klass, k) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1308 | dispatch[OBJ[0]] = load_obj |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1309 | |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 1310 | def load_newobj(self): |
| 1311 | args = self.stack.pop() |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1312 | cls = self.stack.pop() |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 1313 | obj = cls.__new__(cls, *args) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1314 | self.append(obj) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1315 | dispatch[NEWOBJ[0]] = load_newobj |
Guido van Rossum | 3a41c61 | 2003-01-28 15:10:22 +0000 | [diff] [blame] | 1316 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1317 | def load_newobj_ex(self): |
| 1318 | kwargs = self.stack.pop() |
| 1319 | args = self.stack.pop() |
| 1320 | cls = self.stack.pop() |
| 1321 | obj = cls.__new__(cls, *args, **kwargs) |
| 1322 | self.append(obj) |
| 1323 | dispatch[NEWOBJ_EX[0]] = load_newobj_ex |
| 1324 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1325 | def load_global(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1326 | module = self.readline()[:-1].decode("utf-8") |
| 1327 | name = self.readline()[:-1].decode("utf-8") |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1328 | klass = self.find_class(module, name) |
| 1329 | self.append(klass) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1330 | dispatch[GLOBAL[0]] = load_global |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1331 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1332 | def load_stack_global(self): |
| 1333 | name = self.stack.pop() |
| 1334 | module = self.stack.pop() |
| 1335 | if type(name) is not str or type(module) is not str: |
| 1336 | raise UnpicklingError("STACK_GLOBAL requires str") |
| 1337 | self.append(self.find_class(module, name)) |
| 1338 | dispatch[STACK_GLOBAL[0]] = load_stack_global |
| 1339 | |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1340 | def load_ext1(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1341 | code = self.read(1)[0] |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1342 | self.get_extension(code) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1343 | dispatch[EXT1[0]] = load_ext1 |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1344 | |
| 1345 | def load_ext2(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1346 | code, = unpack('<H', self.read(2)) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1347 | self.get_extension(code) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1348 | dispatch[EXT2[0]] = load_ext2 |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1349 | |
| 1350 | def load_ext4(self): |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1351 | code, = unpack('<i', self.read(4)) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1352 | self.get_extension(code) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1353 | dispatch[EXT4[0]] = load_ext4 |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1354 | |
| 1355 | def get_extension(self, code): |
| 1356 | nil = [] |
Guido van Rossum | d4b920c | 2003-02-04 01:54:49 +0000 | [diff] [blame] | 1357 | obj = _extension_cache.get(code, nil) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1358 | if obj is not nil: |
| 1359 | self.append(obj) |
| 1360 | return |
Guido van Rossum | d4b920c | 2003-02-04 01:54:49 +0000 | [diff] [blame] | 1361 | key = _inverted_registry.get(code) |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1362 | if not key: |
Antoine Pitrou | bf6ecf9 | 2012-11-24 20:40:21 +0100 | [diff] [blame] | 1363 | if code <= 0: # note that 0 is forbidden |
| 1364 | # Corrupt or hostile pickle. |
Alexandre Vassalotti | cc75717 | 2013-04-14 02:25:10 -0700 | [diff] [blame] | 1365 | raise UnpicklingError("EXT specifies code <= 0") |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1366 | raise ValueError("unregistered extension code %d" % code) |
| 1367 | obj = self.find_class(*key) |
Guido van Rossum | d4b920c | 2003-02-04 01:54:49 +0000 | [diff] [blame] | 1368 | _extension_cache[code] = obj |
Guido van Rossum | 255f3ee | 2003-01-29 06:14:11 +0000 | [diff] [blame] | 1369 | self.append(obj) |
| 1370 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1371 | def find_class(self, module, name): |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 1372 | # Subclasses may override this. |
| 1373 | if self.proto < 3 and self.fix_imports: |
| 1374 | if (module, name) in _compat_pickle.NAME_MAPPING: |
| 1375 | module, name = _compat_pickle.NAME_MAPPING[(module, name)] |
| 1376 | if module in _compat_pickle.IMPORT_MAPPING: |
| 1377 | module = _compat_pickle.IMPORT_MAPPING[module] |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1378 | __import__(module, level=0) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1379 | return _getattribute(sys.modules[module], name, |
| 1380 | allow_qualname=self.proto >= 4) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1381 | |
| 1382 | def load_reduce(self): |
| 1383 | stack = self.stack |
Guido van Rossum | b26a97a | 2003-01-28 22:29:13 +0000 | [diff] [blame] | 1384 | args = stack.pop() |
| 1385 | func = stack[-1] |
Guido van Rossum | 99603b0 | 2007-07-20 00:22:32 +0000 | [diff] [blame] | 1386 | try: |
| 1387 | value = func(*args) |
| 1388 | except: |
| 1389 | print(sys.exc_info()) |
| 1390 | print(func, args) |
| 1391 | raise |
Guido van Rossum | b26a97a | 2003-01-28 22:29:13 +0000 | [diff] [blame] | 1392 | stack[-1] = value |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1393 | dispatch[REDUCE[0]] = load_reduce |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1394 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1395 | def load_pop(self): |
| 1396 | del self.stack[-1] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1397 | dispatch[POP[0]] = load_pop |
Guido van Rossum | 7b5430f | 1995-03-04 22:25:21 +0000 | [diff] [blame] | 1398 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1399 | def load_pop_mark(self): |
| 1400 | k = self.marker() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1401 | del self.stack[k:] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1402 | dispatch[POP_MARK[0]] = load_pop_mark |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1403 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1404 | def load_dup(self): |
Guido van Rossum | b1062fc | 1998-03-31 17:00:46 +0000 | [diff] [blame] | 1405 | self.append(self.stack[-1]) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1406 | dispatch[DUP[0]] = load_dup |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1407 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1408 | def load_get(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1409 | i = int(self.readline()[:-1]) |
| 1410 | self.append(self.memo[i]) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1411 | dispatch[GET[0]] = load_get |
Guido van Rossum | 7853647 | 1996-04-12 13:36:27 +0000 | [diff] [blame] | 1412 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1413 | def load_binget(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1414 | i = self.read(1)[0] |
| 1415 | self.append(self.memo[i]) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1416 | dispatch[BINGET[0]] = load_binget |
Guido van Rossum | 7853647 | 1996-04-12 13:36:27 +0000 | [diff] [blame] | 1417 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1418 | def load_long_binget(self): |
Antoine Pitrou | bf6ecf9 | 2012-11-24 20:40:21 +0100 | [diff] [blame] | 1419 | i, = unpack('<I', self.read(4)) |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1420 | self.append(self.memo[i]) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1421 | dispatch[LONG_BINGET[0]] = load_long_binget |
Guido van Rossum | 7853647 | 1996-04-12 13:36:27 +0000 | [diff] [blame] | 1422 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1423 | def load_put(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1424 | i = int(self.readline()[:-1]) |
Antoine Pitrou | 55549ec | 2011-08-30 00:27:10 +0200 | [diff] [blame] | 1425 | if i < 0: |
| 1426 | raise ValueError("negative PUT argument") |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1427 | self.memo[i] = self.stack[-1] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1428 | dispatch[PUT[0]] = load_put |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1429 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1430 | def load_binput(self): |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1431 | i = self.read(1)[0] |
Antoine Pitrou | 55549ec | 2011-08-30 00:27:10 +0200 | [diff] [blame] | 1432 | if i < 0: |
| 1433 | raise ValueError("negative BINPUT argument") |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1434 | self.memo[i] = self.stack[-1] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1435 | dispatch[BINPUT[0]] = load_binput |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1436 | |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1437 | def load_long_binput(self): |
Antoine Pitrou | bf6ecf9 | 2012-11-24 20:40:21 +0100 | [diff] [blame] | 1438 | i, = unpack('<I', self.read(4)) |
| 1439 | if i > maxsize: |
Antoine Pitrou | 55549ec | 2011-08-30 00:27:10 +0200 | [diff] [blame] | 1440 | raise ValueError("negative LONG_BINPUT argument") |
Alexandre Vassalotti | ca2d610 | 2008-06-12 18:26:05 +0000 | [diff] [blame] | 1441 | self.memo[i] = self.stack[-1] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1442 | dispatch[LONG_BINPUT[0]] = load_long_binput |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1443 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1444 | def load_memoize(self): |
| 1445 | memo = self.memo |
| 1446 | memo[len(memo)] = self.stack[-1] |
| 1447 | dispatch[MEMOIZE[0]] = load_memoize |
| 1448 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1449 | def load_append(self): |
| 1450 | stack = self.stack |
Raymond Hettinger | 46ac8eb | 2002-06-30 03:39:14 +0000 | [diff] [blame] | 1451 | value = stack.pop() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1452 | list = stack[-1] |
| 1453 | list.append(value) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1454 | dispatch[APPEND[0]] = load_append |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1455 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1456 | def load_appends(self): |
| 1457 | stack = self.stack |
| 1458 | mark = self.marker() |
Alexandre Vassalotti | 1f7492c | 2013-04-20 13:19:46 -0700 | [diff] [blame] | 1459 | list_obj = stack[mark - 1] |
| 1460 | items = stack[mark + 1:] |
| 1461 | if isinstance(list_obj, list): |
| 1462 | list_obj.extend(items) |
| 1463 | else: |
| 1464 | append = list_obj.append |
| 1465 | for item in items: |
| 1466 | append(item) |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1467 | del stack[mark:] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1468 | dispatch[APPENDS[0]] = load_appends |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 1469 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1470 | def load_setitem(self): |
| 1471 | stack = self.stack |
Raymond Hettinger | 46ac8eb | 2002-06-30 03:39:14 +0000 | [diff] [blame] | 1472 | value = stack.pop() |
| 1473 | key = stack.pop() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1474 | dict = stack[-1] |
| 1475 | dict[key] = value |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1476 | dispatch[SETITEM[0]] = load_setitem |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1477 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1478 | def load_setitems(self): |
| 1479 | stack = self.stack |
| 1480 | mark = self.marker() |
| 1481 | dict = stack[mark - 1] |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 1482 | for i in range(mark + 1, len(stack), 2): |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1483 | dict[stack[i]] = stack[i + 1] |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1484 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1485 | del stack[mark:] |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1486 | dispatch[SETITEMS[0]] = load_setitems |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1487 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1488 | def load_additems(self): |
| 1489 | stack = self.stack |
| 1490 | mark = self.marker() |
| 1491 | set_obj = stack[mark - 1] |
| 1492 | items = stack[mark + 1:] |
| 1493 | if isinstance(set_obj, set): |
| 1494 | set_obj.update(items) |
| 1495 | else: |
| 1496 | add = set_obj.add |
| 1497 | for item in items: |
| 1498 | add(item) |
| 1499 | del stack[mark:] |
| 1500 | dispatch[ADDITEMS[0]] = load_additems |
| 1501 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1502 | def load_build(self): |
| 1503 | stack = self.stack |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 1504 | state = stack.pop() |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1505 | inst = stack[-1] |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 1506 | setstate = getattr(inst, "__setstate__", None) |
Serhiy Storchaka | a3e32c9 | 2013-04-14 13:37:02 +0300 | [diff] [blame] | 1507 | if setstate is not None: |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 1508 | setstate(state) |
| 1509 | return |
| 1510 | slotstate = None |
| 1511 | if isinstance(state, tuple) and len(state) == 2: |
| 1512 | state, slotstate = state |
| 1513 | if state: |
Alexandre Vassalotti | ebfecfd | 2009-05-25 18:50:33 +0000 | [diff] [blame] | 1514 | inst_dict = inst.__dict__ |
Antoine Pitrou | a9f48a0 | 2009-05-02 21:41:14 +0000 | [diff] [blame] | 1515 | intern = sys.intern |
Alexandre Vassalotti | ebfecfd | 2009-05-25 18:50:33 +0000 | [diff] [blame] | 1516 | for k, v in state.items(): |
| 1517 | if type(k) is str: |
| 1518 | inst_dict[intern(k)] = v |
| 1519 | else: |
| 1520 | inst_dict[k] = v |
Guido van Rossum | ac5b5d2 | 2003-01-28 22:01:16 +0000 | [diff] [blame] | 1521 | if slotstate: |
| 1522 | for k, v in slotstate.items(): |
| 1523 | setattr(inst, k, v) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1524 | dispatch[BUILD[0]] = load_build |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1525 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1526 | def load_mark(self): |
| 1527 | self.append(self.mark) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1528 | dispatch[MARK[0]] = load_mark |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1529 | |
Guido van Rossum | b72cf2d | 1997-04-09 17:32:51 +0000 | [diff] [blame] | 1530 | def load_stop(self): |
Raymond Hettinger | 46ac8eb | 2002-06-30 03:39:14 +0000 | [diff] [blame] | 1531 | value = self.stack.pop() |
Guido van Rossum | ff87174 | 2000-12-13 18:11:56 +0000 | [diff] [blame] | 1532 | raise _Stop(value) |
Guido van Rossum | 2e6a4b3 | 2007-05-04 19:56:22 +0000 | [diff] [blame] | 1533 | dispatch[STOP[0]] = load_stop |
Guido van Rossum | a48061a | 1995-01-10 00:31:14 +0000 | [diff] [blame] | 1534 | |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1535 | |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1536 | # Shorthands |
| 1537 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1538 | def _dump(obj, file, protocol=None, *, fix_imports=True): |
| 1539 | _Pickler(file, protocol, fix_imports=fix_imports).dump(obj) |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1540 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1541 | def _dumps(obj, protocol=None, *, fix_imports=True): |
Guido van Rossum | cfe5f20 | 2007-05-08 21:26:54 +0000 | [diff] [blame] | 1542 | f = io.BytesIO() |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1543 | _Pickler(f, protocol, fix_imports=fix_imports).dump(obj) |
Guido van Rossum | cfe5f20 | 2007-05-08 21:26:54 +0000 | [diff] [blame] | 1544 | res = f.getvalue() |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 1545 | assert isinstance(res, bytes_types) |
Guido van Rossum | cfe5f20 | 2007-05-08 21:26:54 +0000 | [diff] [blame] | 1546 | return res |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1547 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1548 | def _load(file, *, fix_imports=True, encoding="ASCII", errors="strict"): |
| 1549 | return _Unpickler(file, fix_imports=fix_imports, |
Antoine Pitrou | d9dfaa9 | 2009-06-04 20:32:06 +0000 | [diff] [blame] | 1550 | encoding=encoding, errors=errors).load() |
Guido van Rossum | 0c891ce | 1995-03-14 15:09:05 +0000 | [diff] [blame] | 1551 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1552 | def _loads(s, *, fix_imports=True, encoding="ASCII", errors="strict"): |
Guido van Rossum | cfe5f20 | 2007-05-08 21:26:54 +0000 | [diff] [blame] | 1553 | if isinstance(s, str): |
| 1554 | raise TypeError("Can't load pickle from unicode string") |
| 1555 | file = io.BytesIO(s) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1556 | return _Unpickler(file, fix_imports=fix_imports, |
| 1557 | encoding=encoding, errors=errors).load() |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1558 | |
Antoine Pitrou | ea99c5c | 2010-09-09 18:33:21 +0000 | [diff] [blame] | 1559 | # Use the faster _pickle if possible |
| 1560 | try: |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1561 | from _pickle import ( |
| 1562 | PickleError, |
| 1563 | PicklingError, |
| 1564 | UnpicklingError, |
| 1565 | Pickler, |
| 1566 | Unpickler, |
| 1567 | dump, |
| 1568 | dumps, |
| 1569 | load, |
| 1570 | loads |
| 1571 | ) |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 1572 | except ImportError: |
Antoine Pitrou | ea99c5c | 2010-09-09 18:33:21 +0000 | [diff] [blame] | 1573 | Pickler, Unpickler = _Pickler, _Unpickler |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1574 | dump, dumps, load, loads = _dump, _dumps, _load, _loads |
Antoine Pitrou | ea99c5c | 2010-09-09 18:33:21 +0000 | [diff] [blame] | 1575 | |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1576 | # Doctest |
Guido van Rossum | d6c9e63 | 2003-01-28 03:49:52 +0000 | [diff] [blame] | 1577 | def _test(): |
| 1578 | import doctest |
| 1579 | return doctest.testmod() |
| 1580 | |
| 1581 | if __name__ == "__main__": |
Florent Xicluna | 54540ec | 2011-11-04 08:29:17 +0100 | [diff] [blame] | 1582 | import argparse |
Alexander Belopolsky | 455f7bd | 2010-07-27 23:02:38 +0000 | [diff] [blame] | 1583 | parser = argparse.ArgumentParser( |
| 1584 | description='display contents of the pickle files') |
| 1585 | parser.add_argument( |
| 1586 | 'pickle_file', type=argparse.FileType('br'), |
| 1587 | nargs='*', help='the pickle file') |
| 1588 | parser.add_argument( |
| 1589 | '-t', '--test', action='store_true', |
| 1590 | help='run self-test suite') |
| 1591 | parser.add_argument( |
| 1592 | '-v', action='store_true', |
| 1593 | help='run verbosely; only affects self-test run') |
| 1594 | args = parser.parse_args() |
| 1595 | if args.test: |
| 1596 | _test() |
| 1597 | else: |
| 1598 | if not args.pickle_file: |
| 1599 | parser.print_help() |
| 1600 | else: |
| 1601 | import pprint |
| 1602 | for f in args.pickle_file: |
| 1603 | obj = load(f) |
| 1604 | pprint.pprint(obj) |