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