blob: c57149a393565a74e41c686277f31b683af5023e [file] [log] [blame]
Guido van Rossum54f22ed2000-02-04 15:10:34 +00001"""Create portable serialized representations of Python objects.
Guido van Rossuma48061a1995-01-10 00:31:14 +00002
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00003See module copyreg for a mechanism for registering custom picklers.
Tim Peters22a449a2003-01-27 20:16:36 +00004See module pickletools source for extensive comments.
Guido van Rossuma48061a1995-01-10 00:31:14 +00005
Guido van Rossume467be61997-12-05 19:42:42 +00006Classes:
Guido van Rossuma48061a1995-01-10 00:31:14 +00007
Guido van Rossume467be61997-12-05 19:42:42 +00008 Pickler
9 Unpickler
Guido van Rossuma48061a1995-01-10 00:31:14 +000010
Guido van Rossume467be61997-12-05 19:42:42 +000011Functions:
Guido van Rossuma48061a1995-01-10 00:31:14 +000012
Guido van Rossume467be61997-12-05 19:42:42 +000013 dump(object, file)
14 dumps(object) -> string
15 load(file) -> object
16 loads(string) -> object
Guido van Rossuma48061a1995-01-10 00:31:14 +000017
Guido van Rossume467be61997-12-05 19:42:42 +000018Misc variables:
Guido van Rossuma48061a1995-01-10 00:31:14 +000019
Fred Drakefe82acc1998-02-13 03:24:48 +000020 __version__
Guido van Rossume467be61997-12-05 19:42:42 +000021 format_version
22 compatible_formats
Guido van Rossuma48061a1995-01-10 00:31:14 +000023
Guido van Rossuma48061a1995-01-10 00:31:14 +000024"""
25
Alexandre Vassalotti4c05d3b2013-11-24 02:41:05 -080026from types import FunctionType, ModuleType
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +000027from copyreg import dispatch_table
28from copyreg import _extension_registry, _inverted_registry, _extension_cache
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +030029from itertools import islice
Guido van Rossumd3703791998-10-22 20:15:36 +000030import sys
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +030031from sys import maxsize
32from struct import pack, unpack
Skip Montanaro23bafc62001-02-18 03:10:09 +000033import re
Guido van Rossum2e6a4b32007-05-04 19:56:22 +000034import io
Walter Dörwald42748a82007-06-12 16:40:17 +000035import codecs
Antoine Pitroud9dfaa92009-06-04 20:32:06 +000036import _compat_pickle
Guido van Rossuma48061a1995-01-10 00:31:14 +000037
Skip Montanaro352674d2001-02-07 23:14:30 +000038__all__ = ["PickleError", "PicklingError", "UnpicklingError", "Pickler",
39 "Unpickler", "dump", "dumps", "load", "loads"]
40
Guido van Rossum98297ee2007-11-06 21:34:58 +000041# Shortcut for use in isinstance testing
Alexandre Vassalotti8cb02b62008-05-03 01:42:49 +000042bytes_types = (bytes, bytearray)
Guido van Rossum98297ee2007-11-06 21:34:58 +000043
Tim Petersc0c12b52003-01-29 00:56:17 +000044# These are purely informational; no code uses these.
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +010045format_version = "4.0" # File format version we write
Guido van Rossumf29d3d62003-01-27 22:47:53 +000046compatible_formats = ["1.0", # Original protocol 0
Guido van Rossumbc64e222003-01-28 16:34:19 +000047 "1.1", # Protocol 0 with INST added
Guido van Rossumf29d3d62003-01-27 22:47:53 +000048 "1.2", # Original protocol 1
49 "1.3", # Protocol 1 with BINFLOAT added
50 "2.0", # Protocol 2
Guido van Rossumf4169812008-03-17 22:56:06 +000051 "3.0", # Protocol 3
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +010052 "4.0", # Protocol 4
Guido van Rossumf29d3d62003-01-27 22:47:53 +000053 ] # Old format versions we can read
Guido van Rossumb72cf2d1997-04-09 17:32:51 +000054
Guido van Rossum99603b02007-07-20 00:22:32 +000055# This is the highest protocol number we know how to read.
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +010056HIGHEST_PROTOCOL = 4
Tim Peters8587b3c2003-02-13 15:44:41 +000057
Guido van Rossum2e6a4b32007-05-04 19:56:22 +000058# The protocol we write by default. May be less than HIGHEST_PROTOCOL.
Guido van Rossumf4169812008-03-17 22:56:06 +000059# We intentionally write a protocol that Python 2.x cannot read;
60# there are too many issues with that.
61DEFAULT_PROTOCOL = 3
Guido van Rossum2e6a4b32007-05-04 19:56:22 +000062
Raymond Hettingeraef22fb2002-05-29 16:18:42 +000063class PickleError(Exception):
Neal Norwitzefbb67b2002-05-30 12:12:04 +000064 """A common base class for the other pickling exceptions."""
Raymond Hettingeraef22fb2002-05-29 16:18:42 +000065 pass
66
67class PicklingError(PickleError):
68 """This exception is raised when an unpicklable object is passed to the
69 dump() method.
70
71 """
72 pass
73
74class 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 Rossum7849da81995-03-09 14:08:35 +000084
Tim Petersc0c12b52003-01-29 00:56:17 +000085# 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 Rossumff871742000-12-13 18:11:56 +000087class _Stop(Exception):
88 def __init__(self, value):
89 self.value = value
90
Guido van Rossum533dbcf2003-01-28 17:55:05 +000091# Jython has PyStringMap; it's a dict subclass with string keys
Jeremy Hylton2b9d0291998-05-27 22:38:22 +000092try:
93 from org.python.core import PyStringMap
Brett Cannoncd171c82013-07-04 17:43:24 -040094except ImportError:
Jeremy Hylton2b9d0291998-05-27 22:38:22 +000095 PyStringMap = None
96
Tim Peters22a449a2003-01-27 20:16:36 +000097# 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 Rossumdbb718f2001-09-21 19:22:34 +0000100
Guido van Rossum2e6a4b32007-05-04 19:56:22 +0000101MARK = b'(' # push special markobject on stack
102STOP = b'.' # every pickle ends with STOP
103POP = b'0' # discard topmost stack item
104POP_MARK = b'1' # discard stack top through topmost markobject
105DUP = b'2' # duplicate top stack item
106FLOAT = b'F' # push float object; decimal string argument
107INT = b'I' # push integer or bool; decimal string argument
108BININT = b'J' # push four-byte signed int
109BININT1 = b'K' # push 1-byte unsigned int
110LONG = b'L' # push long; decimal string argument
111BININT2 = b'M' # push 2-byte unsigned int
112NONE = b'N' # push None
113PERSID = b'P' # push persistent object; id is taken from string arg
114BINPERSID = b'Q' # " " " ; " " " " stack
115REDUCE = b'R' # apply callable to argtuple, both on stack
116STRING = b'S' # push string; NL-terminated string argument
117BINSTRING = b'T' # push string; counted binary string argument
118SHORT_BINSTRING= b'U' # " " ; " " " " < 256 bytes
119UNICODE = b'V' # push Unicode string; raw-unicode-escaped'd argument
120BINUNICODE = b'X' # " " " ; counted UTF-8 string argument
121APPEND = b'a' # append stack top to list below it
122BUILD = b'b' # call __setstate__ or __dict__.update()
123GLOBAL = b'c' # push self.find_class(modname, name); 2 string args
124DICT = b'd' # build a dict from stack items
125EMPTY_DICT = b'}' # push empty dict
126APPENDS = b'e' # extend list on stack by topmost stack slice
127GET = b'g' # push item from memo on stack; index is string arg
128BINGET = b'h' # " " " " " " ; " " 1-byte arg
129INST = b'i' # build & push class instance
130LONG_BINGET = b'j' # push item from memo on stack; index is 4-byte arg
131LIST = b'l' # build list from topmost stack items
132EMPTY_LIST = b']' # push empty list
133OBJ = b'o' # build & push class instance
134PUT = b'p' # store stack top in memo; index is string arg
135BINPUT = b'q' # " " " " " ; " " 1-byte arg
136LONG_BINPUT = b'r' # " " " " " ; " " 4-byte arg
137SETITEM = b's' # add key+value pair to dict
138TUPLE = b't' # build tuple from topmost stack items
139EMPTY_TUPLE = b')' # push empty tuple
140SETITEMS = b'u' # modify dict by adding topmost key+value pairs
141BINFLOAT = b'G' # push float; arg is 8-byte float encoding
Tim Peters22a449a2003-01-27 20:16:36 +0000142
Guido van Rossum2e6a4b32007-05-04 19:56:22 +0000143TRUE = b'I01\n' # not an opcode; see INT docs in pickletools.py
144FALSE = b'I00\n' # not an opcode; see INT docs in pickletools.py
Guido van Rossum77f6a652002-04-03 22:41:51 +0000145
Guido van Rossum586c9e82003-01-29 06:16:12 +0000146# Protocol 2
Guido van Rossum5a2d8f52003-01-27 21:44:25 +0000147
Guido van Rossum2e6a4b32007-05-04 19:56:22 +0000148PROTO = b'\x80' # identify pickle protocol
149NEWOBJ = b'\x81' # build object by applying cls.__new__ to argtuple
150EXT1 = b'\x82' # push object from extension registry; 1-byte index
151EXT2 = b'\x83' # ditto, but 2-byte index
152EXT4 = b'\x84' # ditto, but 4-byte index
153TUPLE1 = b'\x85' # build 1-tuple from stack top
154TUPLE2 = b'\x86' # build 2-tuple from two topmost stack items
155TUPLE3 = b'\x87' # build 3-tuple from three topmost stack items
156NEWTRUE = b'\x88' # push True
157NEWFALSE = b'\x89' # push False
158LONG1 = b'\x8a' # push long from < 256 bytes
159LONG4 = b'\x8b' # push really big long
Guido van Rossum5a2d8f52003-01-27 21:44:25 +0000160
Guido van Rossum44f0ea52003-01-28 04:14:51 +0000161_tuplesize2code = [EMPTY_TUPLE, TUPLE1, TUPLE2, TUPLE3]
162
Guido van Rossumf4169812008-03-17 22:56:06 +0000163# Protocol 3 (Python 3.x)
164
165BINBYTES = b'B' # push bytes; counted binary string argument
166SHORT_BINBYTES = b'C' # " " ; " " " " < 256 bytes
Guido van Rossuma48061a1995-01-10 00:31:14 +0000167
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100168# Protocol 4
169SHORT_BINUNICODE = b'\x8c' # push short string; UTF-8 length < 256 bytes
170BINUNICODE8 = b'\x8d' # push very long string
171BINBYTES8 = b'\x8e' # push very long bytes string
172EMPTY_SET = b'\x8f' # push empty set on the stack
173ADDITEMS = b'\x90' # modify set by adding topmost stack items
174FROZENSET = b'\x91' # build frozenset from topmost stack items
175NEWOBJ_EX = b'\x92' # like NEWOBJ but work with keyword only arguments
176STACK_GLOBAL = b'\x93' # same as GLOBAL but using names on the stacks
177MEMOIZE = b'\x94' # store top of the stack in memo
178FRAME = 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
183class _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 Pitrouc9dc4a22013-11-23 18:59:12 +0100191 def start_framing(self):
192 self.current_frame = io.BytesIO()
193
194 def end_framing(self):
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800195 if self.current_frame and self.current_frame.tell() > 0:
196 self.commit_frame(force=True)
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100197 self.current_frame = None
198
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800199 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 Pitrouc9dc4a22013-11-23 18:59:12 +0100212 def write(self, data):
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800213 if self.current_frame:
214 return self.current_frame.write(data)
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100215 else:
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800216 return self.file_write(data)
217
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100218
219class _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 Pitrouc9dc4a22013-11-23 18:59:12 +0100224 self.current_frame = None
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100225
226 def read(self, n):
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800227 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 Pitrouc9dc4a22013-11-23 18:59:12 +0100238
239 def readline(self):
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800240 if self.current_frame:
241 data = self.current_frame.readline()
242 if not data:
243 self.current_frame = None
244 return self.file_readline()
245 if data[-1] != b'\n':
246 raise UnpicklingError(
247 "pickle exhausted before end of frame")
248 return data
249 else:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100250 return self.file_readline()
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100251
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800252 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 Pitrouc9dc4a22013-11-23 18:59:12 +0100257
258
259# Tools used for pickling.
260
261def _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
278def 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
283 for module_name, module in sys.modules.items():
284 if module_name == '__main__' or module is None:
285 continue
286 try:
287 if _getattribute(module, name, allow_qualname) is obj:
288 return module_name
289 except AttributeError:
290 pass
291 return '__main__'
292
293def encode_long(x):
294 r"""Encode a long to a two's complement little-endian binary string.
295 Note that 0 is a special case, returning an empty string, to save a
296 byte in the LONG1 pickling context.
297
298 >>> encode_long(0)
299 b''
300 >>> encode_long(255)
301 b'\xff\x00'
302 >>> encode_long(32767)
303 b'\xff\x7f'
304 >>> encode_long(-256)
305 b'\x00\xff'
306 >>> encode_long(-32768)
307 b'\x00\x80'
308 >>> encode_long(-128)
309 b'\x80'
310 >>> encode_long(127)
311 b'\x7f'
312 >>>
313 """
314 if x == 0:
315 return b''
316 nbytes = (x.bit_length() >> 3) + 1
317 result = x.to_bytes(nbytes, byteorder='little', signed=True)
318 if x < 0 and nbytes > 1:
319 if result[-1] == 0xff and (result[-2] & 0x80) != 0:
320 result = result[:-1]
321 return result
322
323def decode_long(data):
324 r"""Decode a long from a two's complement little-endian binary string.
325
326 >>> decode_long(b'')
327 0
328 >>> decode_long(b"\xff\x00")
329 255
330 >>> decode_long(b"\xff\x7f")
331 32767
332 >>> decode_long(b"\x00\xff")
333 -256
334 >>> decode_long(b"\x00\x80")
335 -32768
336 >>> decode_long(b"\x80")
337 -128
338 >>> decode_long(b"\x7f")
339 127
340 """
341 return int.from_bytes(data, byteorder='little', signed=True)
342
Skip Montanaro23bafc62001-02-18 03:10:09 +0000343
Guido van Rossum1be31752003-01-28 15:19:53 +0000344# Pickling machinery
345
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000346class _Pickler:
Guido van Rossuma48061a1995-01-10 00:31:14 +0000347
Antoine Pitroud9dfaa92009-06-04 20:32:06 +0000348 def __init__(self, file, protocol=None, *, fix_imports=True):
Guido van Rossum2e6a4b32007-05-04 19:56:22 +0000349 """This takes a binary file for writing a pickle data stream.
350
Guido van Rossumcf117b02003-02-09 17:19:41 +0000351 The optional protocol argument tells the pickler to use the
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100352 given protocol; supported protocols are 0, 1, 2, 3 and 4. The
353 default protocol is 3; a backward-incompatible protocol designed for
354 Python 3.
Guido van Rossumf29d3d62003-01-27 22:47:53 +0000355
Guido van Rossum7eff63a2003-01-31 19:42:31 +0000356 Specifying a negative protocol version selects the highest
Tim Peters5bd2a792003-02-01 16:45:06 +0000357 protocol version supported. The higher the protocol used, the
358 more recent the version of Python needed to read the pickle
359 produced.
Raymond Hettingeraef22fb2002-05-29 16:18:42 +0000360
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000361 The file argument must have a write() method that accepts a single
362 bytes argument. It can thus be a file object opened for binary
363 writing, a io.BytesIO instance, or any other custom object that
364 meets this interface.
Antoine Pitroud9dfaa92009-06-04 20:32:06 +0000365
366 If fix_imports is True and protocol is less than 3, pickle will try to
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100367 map the new Python 3 names to the old module names used in Python 2,
368 so that the pickle data stream is readable with Python 2.
Raymond Hettingeraef22fb2002-05-29 16:18:42 +0000369 """
Guido van Rossumcf117b02003-02-09 17:19:41 +0000370 if protocol is None:
Guido van Rossum2e6a4b32007-05-04 19:56:22 +0000371 protocol = DEFAULT_PROTOCOL
Guido van Rossumcf117b02003-02-09 17:19:41 +0000372 if protocol < 0:
Tim Peters8587b3c2003-02-13 15:44:41 +0000373 protocol = HIGHEST_PROTOCOL
374 elif not 0 <= protocol <= HIGHEST_PROTOCOL:
375 raise ValueError("pickle protocol must be <= %d" % HIGHEST_PROTOCOL)
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000376 try:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100377 self._file_write = file.write
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000378 except AttributeError:
379 raise TypeError("file must have a 'write' attribute")
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800380 self.framer = _Framer(self._file_write)
381 self.write = self.framer.write
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000382 self.memo = {}
Guido van Rossumcf117b02003-02-09 17:19:41 +0000383 self.proto = int(protocol)
384 self.bin = protocol >= 1
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000385 self.fast = 0
Antoine Pitroud9dfaa92009-06-04 20:32:06 +0000386 self.fix_imports = fix_imports and protocol < 3
Guido van Rossuma48061a1995-01-10 00:31:14 +0000387
Fred Drake7f781c92002-05-01 20:33:53 +0000388 def clear_memo(self):
Raymond Hettingeraef22fb2002-05-29 16:18:42 +0000389 """Clears the pickler's "memo".
390
391 The memo is the data structure that remembers which objects the
Tim Petersb377f8a2003-01-28 00:23:36 +0000392 pickler has already seen, so that shared or recursive objects are
393 pickled by reference and not by value. This method is useful when
394 re-using picklers.
Raymond Hettingeraef22fb2002-05-29 16:18:42 +0000395
396 """
Fred Drake7f781c92002-05-01 20:33:53 +0000397 self.memo.clear()
398
Guido van Rossum3a41c612003-01-28 15:10:22 +0000399 def dump(self, obj):
Tim Peters5bd2a792003-02-01 16:45:06 +0000400 """Write a pickled representation of obj to the open file."""
Alexandre Vassalotti3cfcab92008-12-27 09:30:39 +0000401 # Check whether Pickler was initialized correctly. This is
402 # only needed to mimic the behavior of _pickle.Pickler.dump().
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100403 if not hasattr(self, "_file_write"):
Alexandre Vassalotti3cfcab92008-12-27 09:30:39 +0000404 raise PicklingError("Pickler.__init__() was not called by "
405 "%s.__init__()" % (self.__class__.__name__,))
Guido van Rossumd6c9e632003-01-28 03:49:52 +0000406 if self.proto >= 2:
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800407 self.write(PROTO + pack("<B", self.proto))
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100408 if self.proto >= 4:
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800409 self.framer.start_framing()
Guido van Rossum3a41c612003-01-28 15:10:22 +0000410 self.save(obj)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000411 self.write(STOP)
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800412 self.framer.end_framing()
Guido van Rossuma48061a1995-01-10 00:31:14 +0000413
Jeremy Hylton3422c992003-01-24 19:29:52 +0000414 def memoize(self, obj):
415 """Store an object in the memo."""
416
Tim Peterse46b73f2003-01-27 21:22:10 +0000417 # The Pickler memo is a dictionary mapping object ids to 2-tuples
418 # that contain the Unpickler memo key and the object being memoized.
419 # The memo key is written to the pickle and will become
Jeremy Hylton3422c992003-01-24 19:29:52 +0000420 # the key in the Unpickler's memo. The object is stored in the
Tim Peterse46b73f2003-01-27 21:22:10 +0000421 # Pickler memo so that transient objects are kept alive during
422 # pickling.
Jeremy Hylton3422c992003-01-24 19:29:52 +0000423
Tim Peterse46b73f2003-01-27 21:22:10 +0000424 # The use of the Unpickler memo length as the memo key is just a
425 # convention. The only requirement is that the memo values be unique.
426 # But there appears no advantage to any other scheme, and this
Tim Peterscbd0a322003-01-28 00:24:43 +0000427 # scheme allows the Unpickler memo to be implemented as a plain (but
Tim Peterse46b73f2003-01-27 21:22:10 +0000428 # growable) array, indexed by memo key.
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000429 if self.fast:
430 return
Guido van Rossum9b40e802003-01-30 06:37:41 +0000431 assert id(obj) not in self.memo
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100432 idx = len(self.memo)
433 self.write(self.put(idx))
434 self.memo[id(obj)] = idx, obj
Jeremy Hylton3422c992003-01-24 19:29:52 +0000435
Tim Petersbb38e302003-01-27 21:25:41 +0000436 # Return a PUT (BINPUT, LONG_BINPUT) opcode string, with argument i.
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100437 def put(self, idx):
438 if self.proto >= 4:
439 return MEMOIZE
440 elif self.bin:
441 if idx < 256:
442 return BINPUT + pack("<B", idx)
Guido van Rossum5c938d02003-01-28 03:03:08 +0000443 else:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100444 return LONG_BINPUT + pack("<I", idx)
445 else:
446 return PUT + repr(idx).encode("ascii") + b'\n'
Guido van Rossuma48061a1995-01-10 00:31:14 +0000447
Tim Petersbb38e302003-01-27 21:25:41 +0000448 # Return a GET (BINGET, LONG_BINGET) opcode string, with argument i.
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300449 def get(self, i):
Tim Petersc32d8242001-04-10 02:48:53 +0000450 if self.bin:
Tim Petersc32d8242001-04-10 02:48:53 +0000451 if i < 256:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300452 return BINGET + pack("<B", i)
Guido van Rossum5c938d02003-01-28 03:03:08 +0000453 else:
Antoine Pitroubf6ecf92012-11-24 20:40:21 +0100454 return LONG_BINGET + pack("<I", i)
Guido van Rossuma48061a1995-01-10 00:31:14 +0000455
Guido van Rossum39478e82007-08-27 17:23:59 +0000456 return GET + repr(i).encode("ascii") + b'\n'
Tim Peters2344fae2001-01-15 00:50:52 +0000457
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000458 def save(self, obj, save_persistent_id=True):
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -0800459 self.framer.commit_frame()
460
Guido van Rossumbc64e222003-01-28 16:34:19 +0000461 # Check for persistent id (defined by a subclass)
Guido van Rossum3a41c612003-01-28 15:10:22 +0000462 pid = self.persistent_id(obj)
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000463 if pid is not None and save_persistent_id:
Jeremy Hylton5e0f4e72002-11-13 22:01:27 +0000464 self.save_pers(pid)
465 return
Guido van Rossuma48061a1995-01-10 00:31:14 +0000466
Guido van Rossumbc64e222003-01-28 16:34:19 +0000467 # Check the memo
468 x = self.memo.get(id(obj))
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300469 if x is not None:
Guido van Rossumbc64e222003-01-28 16:34:19 +0000470 self.write(self.get(x[0]))
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000471 return
472
Guido van Rossumbc64e222003-01-28 16:34:19 +0000473 # Check the type dispatch table
Guido van Rossum3a41c612003-01-28 15:10:22 +0000474 t = type(obj)
Guido van Rossumbc64e222003-01-28 16:34:19 +0000475 f = self.dispatch.get(t)
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300476 if f is not None:
Guido van Rossumbc64e222003-01-28 16:34:19 +0000477 f(self, obj) # Call unbound method with explicit self
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000478 return
479
Antoine Pitrou8d3c2902012-03-04 18:31:48 +0100480 # Check private dispatch table if any, or else copyreg.dispatch_table
481 reduce = getattr(self, 'dispatch_table', dispatch_table).get(t)
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300482 if reduce is not None:
Guido van Rossumc53f0092003-02-18 22:05:12 +0000483 rv = reduce(obj)
484 else:
Antoine Pitrouffd41d92011-10-04 09:23:04 +0200485 # Check for a class with a custom metaclass; treat as regular class
486 try:
487 issc = issubclass(t, type)
488 except TypeError: # t is not a class (old Boost; see SF #502085)
489 issc = False
490 if issc:
491 self.save_global(obj)
492 return
493
Guido van Rossumc53f0092003-02-18 22:05:12 +0000494 # Check for a __reduce_ex__ method, fall back to __reduce__
495 reduce = getattr(obj, "__reduce_ex__", None)
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300496 if reduce is not None:
Guido van Rossumc53f0092003-02-18 22:05:12 +0000497 rv = reduce(self.proto)
498 else:
499 reduce = getattr(obj, "__reduce__", None)
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300500 if reduce is not None:
Guido van Rossumc53f0092003-02-18 22:05:12 +0000501 rv = reduce()
502 else:
503 raise PicklingError("Can't pickle %r object: %r" %
504 (t.__name__, obj))
Tim Petersb32a8312003-01-28 00:48:09 +0000505
Guido van Rossumbc64e222003-01-28 16:34:19 +0000506 # Check for string returned by reduce(), meaning "save as global"
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000507 if isinstance(rv, str):
Guido van Rossumbc64e222003-01-28 16:34:19 +0000508 self.save_global(obj, rv)
Tim Petersb32a8312003-01-28 00:48:09 +0000509 return
510
Guido van Rossumbc64e222003-01-28 16:34:19 +0000511 # Assert that reduce() returned a tuple
Guido van Rossum13257902007-06-07 23:15:56 +0000512 if not isinstance(rv, tuple):
Guido van Rossumbc64e222003-01-28 16:34:19 +0000513 raise PicklingError("%s must return string or tuple" % reduce)
Tim Petersb32a8312003-01-28 00:48:09 +0000514
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000515 # Assert that it returned an appropriately sized tuple
Guido van Rossumbc64e222003-01-28 16:34:19 +0000516 l = len(rv)
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000517 if not (2 <= l <= 5):
Guido van Rossumbc64e222003-01-28 16:34:19 +0000518 raise PicklingError("Tuple returned by %s must have "
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000519 "two to five elements" % reduce)
Tim Petersb32a8312003-01-28 00:48:09 +0000520
Guido van Rossumbc64e222003-01-28 16:34:19 +0000521 # Save the reduce() output and finally memoize the object
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000522 self.save_reduce(obj=obj, *rv)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000523
Guido van Rossum3a41c612003-01-28 15:10:22 +0000524 def persistent_id(self, obj):
Guido van Rossumbc64e222003-01-28 16:34:19 +0000525 # This exists so a subclass can override it
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000526 return None
527
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000528 def save_pers(self, pid):
Guido van Rossumbc64e222003-01-28 16:34:19 +0000529 # Save a persistent id reference
Tim Petersbd1cdb92003-01-28 01:03:10 +0000530 if self.bin:
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000531 self.save(pid, save_persistent_id=False)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000532 self.write(BINPERSID)
Tim Petersbd1cdb92003-01-28 01:03:10 +0000533 else:
Guido van Rossum39478e82007-08-27 17:23:59 +0000534 self.write(PERSID + str(pid).encode("ascii") + b'\n')
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000535
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100536 def save_reduce(self, func, args, state=None, listitems=None,
537 dictitems=None, obj=None):
Jeremy Hyltone3a565e2003-06-29 16:59:59 +0000538 # This API is called by some subclasses
Guido van Rossumbc64e222003-01-28 16:34:19 +0000539
Guido van Rossum13257902007-06-07 23:15:56 +0000540 if not isinstance(args, tuple):
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100541 raise PicklingError("args from save_reduce() must be a tuple")
Florent Xicluna5d1155c2011-10-28 14:45:05 +0200542 if not callable(func):
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100543 raise PicklingError("func from save_reduce() must be callable")
Guido van Rossumbc64e222003-01-28 16:34:19 +0000544
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000545 save = self.save
Guido van Rossumbc64e222003-01-28 16:34:19 +0000546 write = self.write
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000547
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100548 func_name = getattr(func, "__name__", "")
549 if self.proto >= 4 and func_name == "__newobj_ex__":
550 cls, args, kwargs = args
551 if not hasattr(cls, "__new__"):
552 raise PicklingError("args[0] from {} args has no __new__"
553 .format(func_name))
554 if obj is not None and cls is not obj.__class__:
555 raise PicklingError("args[0] from {} args has the wrong class"
556 .format(func_name))
557 save(cls)
558 save(args)
559 save(kwargs)
560 write(NEWOBJ_EX)
561 elif self.proto >= 2 and func_name == "__newobj__":
562 # A __reduce__ implementation can direct protocol 2 or newer to
Guido van Rossumd053b4b2003-01-31 16:51:45 +0000563 # use the more efficient NEWOBJ opcode, while still
564 # allowing protocol 0 and 1 to work normally. For this to
565 # work, the function returned by __reduce__ should be
566 # called __newobj__, and its first argument should be a
Florent Xiclunaaa6c1d22011-12-12 18:54:29 +0100567 # class. The implementation for __newobj__
Guido van Rossumd053b4b2003-01-31 16:51:45 +0000568 # should be as follows, although pickle has no way to
569 # verify this:
570 #
571 # def __newobj__(cls, *args):
572 # return cls.__new__(cls, *args)
573 #
574 # Protocols 0 and 1 will pickle a reference to __newobj__,
575 # while protocol 2 (and above) will pickle a reference to
576 # cls, the remaining args tuple, and the NEWOBJ code,
577 # which calls cls.__new__(cls, *args) at unpickling time
578 # (see load_newobj below). If __reduce__ returns a
579 # three-tuple, the state from the third tuple item will be
580 # pickled regardless of the protocol, calling __setstate__
581 # at unpickling time (see load_build below).
582 #
583 # Note that no standard __newobj__ implementation exists;
584 # you have to provide your own. This is to enforce
585 # compatibility with Python 2.2 (pickles written using
586 # protocol 0 or 1 in Python 2.3 should be unpicklable by
587 # Python 2.2).
588 cls = args[0]
589 if not hasattr(cls, "__new__"):
590 raise PicklingError(
591 "args[0] from __newobj__ args has no __new__")
Guido van Rossumf7f45172003-01-31 17:17:49 +0000592 if obj is not None and cls is not obj.__class__:
593 raise PicklingError(
594 "args[0] from __newobj__ args has the wrong class")
Guido van Rossumd053b4b2003-01-31 16:51:45 +0000595 args = args[1:]
596 save(cls)
597 save(args)
598 write(NEWOBJ)
599 else:
600 save(func)
601 save(args)
602 write(REDUCE)
Tim Peters2344fae2001-01-15 00:50:52 +0000603
Guido van Rossumf7f45172003-01-31 17:17:49 +0000604 if obj is not None:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100605 # If the object is already in the memo, this means it is
606 # recursive. In this case, throw away everything we put on the
607 # stack, and fetch the object back from the memo.
608 if id(obj) in self.memo:
609 write(POP + self.get(self.memo[id(obj)][0]))
610 else:
611 self.memoize(obj)
Guido van Rossumf7f45172003-01-31 17:17:49 +0000612
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000613 # More new special cases (that work with older protocols as
614 # well): when __reduce__ returns a tuple with 4 or 5 items,
615 # the 4th and 5th item should be iterators that provide list
616 # items and dict items (as (key, value) tuples), or None.
617
618 if listitems is not None:
619 self._batch_appends(listitems)
620
621 if dictitems is not None:
622 self._batch_setitems(dictitems)
623
Tim Petersc32d8242001-04-10 02:48:53 +0000624 if state is not None:
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000625 save(state)
626 write(BUILD)
627
Guido van Rossumbc64e222003-01-28 16:34:19 +0000628 # Methods below this point are dispatched through the dispatch table
629
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000630 dispatch = {}
631
Guido van Rossum3a41c612003-01-28 15:10:22 +0000632 def save_none(self, obj):
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000633 self.write(NONE)
Guido van Rossum13257902007-06-07 23:15:56 +0000634 dispatch[type(None)] = save_none
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000635
Guido van Rossum3a41c612003-01-28 15:10:22 +0000636 def save_bool(self, obj):
Guido van Rossum7d97d312003-01-28 04:25:27 +0000637 if self.proto >= 2:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300638 self.write(NEWTRUE if obj else NEWFALSE)
Guido van Rossum7d97d312003-01-28 04:25:27 +0000639 else:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300640 self.write(TRUE if obj else FALSE)
Guido van Rossum77f6a652002-04-03 22:41:51 +0000641 dispatch[bool] = save_bool
642
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300643 def save_long(self, obj):
Guido van Rossumddefaf32007-01-14 03:31:43 +0000644 if self.bin:
645 # If the int is small enough to fit in a signed 4-byte 2's-comp
646 # format, we can store it more efficiently than the general
647 # case.
648 # First one- and two-byte unsigned ints:
649 if obj >= 0:
650 if obj <= 0xff:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300651 self.write(BININT1 + pack("<B", obj))
Guido van Rossumddefaf32007-01-14 03:31:43 +0000652 return
653 if obj <= 0xffff:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300654 self.write(BININT2 + pack("<H", obj))
Guido van Rossumddefaf32007-01-14 03:31:43 +0000655 return
656 # Next check for 4-byte signed ints:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300657 if -0x80000000 <= obj <= 0x7fffffff:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000658 self.write(BININT + pack("<i", obj))
659 return
Guido van Rossumd6c9e632003-01-28 03:49:52 +0000660 if self.proto >= 2:
Guido van Rossum2e6a4b32007-05-04 19:56:22 +0000661 encoded = encode_long(obj)
662 n = len(encoded)
Guido van Rossumd6c9e632003-01-28 03:49:52 +0000663 if n < 256:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300664 self.write(LONG1 + pack("<B", n) + encoded)
Guido van Rossumd6c9e632003-01-28 03:49:52 +0000665 else:
Guido van Rossum2e6a4b32007-05-04 19:56:22 +0000666 self.write(LONG4 + pack("<i", n) + encoded)
Tim Petersee1a53c2003-02-02 02:57:53 +0000667 return
Mark Dickinson8dd05142009-01-20 20:43:58 +0000668 self.write(LONG + repr(obj).encode("ascii") + b'L\n')
Guido van Rossum13257902007-06-07 23:15:56 +0000669 dispatch[int] = save_long
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000670
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300671 def save_float(self, obj):
Guido van Rossumd3703791998-10-22 20:15:36 +0000672 if self.bin:
Guido van Rossum3a41c612003-01-28 15:10:22 +0000673 self.write(BINFLOAT + pack('>d', obj))
Guido van Rossumd3703791998-10-22 20:15:36 +0000674 else:
Guido van Rossum39478e82007-08-27 17:23:59 +0000675 self.write(FLOAT + repr(obj).encode("ascii") + b'\n')
Guido van Rossum13257902007-06-07 23:15:56 +0000676 dispatch[float] = save_float
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000677
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300678 def save_bytes(self, obj):
Guido van Rossumf4169812008-03-17 22:56:06 +0000679 if self.proto < 3:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300680 if not obj: # bytes object is empty
Alexandre Vassalotti3bfc65a2011-12-13 13:08:09 -0500681 self.save_reduce(bytes, (), obj=obj)
682 else:
683 self.save_reduce(codecs.encode,
684 (str(obj, 'latin1'), 'latin1'), obj=obj)
Guido van Rossumf4169812008-03-17 22:56:06 +0000685 return
686 n = len(obj)
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100687 if n <= 0xff:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300688 self.write(SHORT_BINBYTES + pack("<B", n) + obj)
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100689 elif n > 0xffffffff and self.proto >= 4:
690 self.write(BINBYTES8 + pack("<Q", n) + obj)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000691 else:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300692 self.write(BINBYTES + pack("<I", n) + obj)
Guido van Rossum3a41c612003-01-28 15:10:22 +0000693 self.memoize(obj)
Guido van Rossumf4169812008-03-17 22:56:06 +0000694 dispatch[bytes] = save_bytes
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000695
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300696 def save_str(self, obj):
Tim Petersc32d8242001-04-10 02:48:53 +0000697 if self.bin:
Victor Stinner485fb562010-04-13 11:07:24 +0000698 encoded = obj.encode('utf-8', 'surrogatepass')
Guido van Rossum2e6a4b32007-05-04 19:56:22 +0000699 n = len(encoded)
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100700 if n <= 0xff and self.proto >= 4:
701 self.write(SHORT_BINUNICODE + pack("<B", n) + encoded)
702 elif n > 0xffffffff and self.proto >= 4:
703 self.write(BINUNICODE8 + pack("<Q", n) + encoded)
704 else:
705 self.write(BINUNICODE + pack("<I", n) + encoded)
Guido van Rossumb5f2f1b2000-03-10 23:20:09 +0000706 else:
Guido van Rossum3a41c612003-01-28 15:10:22 +0000707 obj = obj.replace("\\", "\\u005c")
708 obj = obj.replace("\n", "\\u000a")
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100709 self.write(UNICODE + obj.encode('raw-unicode-escape') +
710 b'\n')
Guido van Rossum3a41c612003-01-28 15:10:22 +0000711 self.memoize(obj)
Guido van Rossumf4169812008-03-17 22:56:06 +0000712 dispatch[str] = save_str
Tim Peters658cba62001-02-09 20:06:00 +0000713
Guido van Rossum3a41c612003-01-28 15:10:22 +0000714 def save_tuple(self, obj):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300715 if not obj: # tuple is empty
716 if self.bin:
717 self.write(EMPTY_TUPLE)
Tim Peters1d63c9f2003-02-02 20:29:39 +0000718 else:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300719 self.write(MARK + TUPLE)
Tim Petersd97da802003-01-28 05:48:29 +0000720 return
721
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300722 n = len(obj)
Tim Petersd97da802003-01-28 05:48:29 +0000723 save = self.save
724 memo = self.memo
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300725 if n <= 3 and self.proto >= 2:
Guido van Rossum3a41c612003-01-28 15:10:22 +0000726 for element in obj:
Tim Petersd97da802003-01-28 05:48:29 +0000727 save(element)
728 # Subtle. Same as in the big comment below.
Guido van Rossum3a41c612003-01-28 15:10:22 +0000729 if id(obj) in memo:
730 get = self.get(memo[id(obj)][0])
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300731 self.write(POP * n + get)
Tim Petersd97da802003-01-28 05:48:29 +0000732 else:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300733 self.write(_tuplesize2code[n])
Guido van Rossum3a41c612003-01-28 15:10:22 +0000734 self.memoize(obj)
Tim Petersd97da802003-01-28 05:48:29 +0000735 return
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000736
Tim Peters1d63c9f2003-02-02 20:29:39 +0000737 # proto 0 or proto 1 and tuple isn't empty, or proto > 1 and tuple
Tim Petersff57bff2003-01-28 05:34:53 +0000738 # has more than 3 elements.
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300739 write = self.write
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000740 write(MARK)
Guido van Rossum3a41c612003-01-28 15:10:22 +0000741 for element in obj:
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000742 save(element)
743
Tim Peters1d63c9f2003-02-02 20:29:39 +0000744 if id(obj) in memo:
Tim Petersf558da02003-01-28 02:09:55 +0000745 # Subtle. d was not in memo when we entered save_tuple(), so
746 # the process of saving the tuple's elements must have saved
747 # the tuple itself: the tuple is recursive. The proper action
748 # now is to throw away everything we put on the stack, and
749 # simply GET the tuple (it's already constructed). This check
750 # could have been done in the "for element" loop instead, but
751 # recursive tuples are a rare thing.
Guido van Rossum3a41c612003-01-28 15:10:22 +0000752 get = self.get(memo[id(obj)][0])
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300753 if self.bin:
Tim Petersf558da02003-01-28 02:09:55 +0000754 write(POP_MARK + get)
755 else: # proto 0 -- POP_MARK not available
Tim Petersd97da802003-01-28 05:48:29 +0000756 write(POP * (n+1) + get)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000757 return
758
Tim Peters1d63c9f2003-02-02 20:29:39 +0000759 # No recursion.
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300760 write(TUPLE)
Tim Peters1d63c9f2003-02-02 20:29:39 +0000761 self.memoize(obj)
Jeremy Hylton3422c992003-01-24 19:29:52 +0000762
Guido van Rossum13257902007-06-07 23:15:56 +0000763 dispatch[tuple] = save_tuple
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000764
Guido van Rossum3a41c612003-01-28 15:10:22 +0000765 def save_list(self, obj):
Tim Petersc32d8242001-04-10 02:48:53 +0000766 if self.bin:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300767 self.write(EMPTY_LIST)
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000768 else: # proto 0 -- can't use EMPTY_LIST
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300769 self.write(MARK + LIST)
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000770
771 self.memoize(obj)
Alexandre Vassalottic7db1d62008-05-14 21:57:18 +0000772 self._batch_appends(obj)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000773
Guido van Rossum13257902007-06-07 23:15:56 +0000774 dispatch[list] = save_list
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000775
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000776 _BATCHSIZE = 1000
777
778 def _batch_appends(self, items):
779 # Helper to batch up APPENDS sequences
780 save = self.save
781 write = self.write
782
783 if not self.bin:
784 for x in items:
785 save(x)
786 write(APPEND)
787 return
788
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300789 it = iter(items)
790 while True:
791 tmp = list(islice(it, self._BATCHSIZE))
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000792 n = len(tmp)
793 if n > 1:
794 write(MARK)
795 for x in tmp:
796 save(x)
797 write(APPENDS)
798 elif n:
799 save(tmp[0])
800 write(APPEND)
801 # else tmp is empty, and we're done
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300802 if n < self._BATCHSIZE:
803 return
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000804
Guido van Rossum3a41c612003-01-28 15:10:22 +0000805 def save_dict(self, obj):
Tim Petersc32d8242001-04-10 02:48:53 +0000806 if self.bin:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300807 self.write(EMPTY_DICT)
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000808 else: # proto 0 -- can't use EMPTY_DICT
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300809 self.write(MARK + DICT)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000810
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000811 self.memoize(obj)
Alexandre Vassalottic7db1d62008-05-14 21:57:18 +0000812 self._batch_setitems(obj.items())
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000813
Guido van Rossum13257902007-06-07 23:15:56 +0000814 dispatch[dict] = save_dict
815 if PyStringMap is not None:
Jeremy Hylton2b9d0291998-05-27 22:38:22 +0000816 dispatch[PyStringMap] = save_dict
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000817
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000818 def _batch_setitems(self, items):
819 # Helper to batch up SETITEMS sequences; proto >= 1 only
820 save = self.save
821 write = self.write
822
823 if not self.bin:
824 for k, v in items:
825 save(k)
826 save(v)
827 write(SETITEM)
828 return
829
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300830 it = iter(items)
831 while True:
832 tmp = list(islice(it, self._BATCHSIZE))
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000833 n = len(tmp)
834 if n > 1:
835 write(MARK)
836 for k, v in tmp:
837 save(k)
838 save(v)
839 write(SETITEMS)
840 elif n:
841 k, v = tmp[0]
842 save(k)
843 save(v)
844 write(SETITEM)
845 # else tmp is empty, and we're done
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300846 if n < self._BATCHSIZE:
847 return
Guido van Rossum25cb7df2003-01-31 18:53:21 +0000848
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100849 def save_set(self, obj):
850 save = self.save
851 write = self.write
852
853 if self.proto < 4:
854 self.save_reduce(set, (list(obj),), obj=obj)
855 return
856
857 write(EMPTY_SET)
858 self.memoize(obj)
859
860 it = iter(obj)
861 while True:
862 batch = list(islice(it, self._BATCHSIZE))
863 n = len(batch)
864 if n > 0:
865 write(MARK)
866 for item in batch:
867 save(item)
868 write(ADDITEMS)
869 if n < self._BATCHSIZE:
870 return
871 dispatch[set] = save_set
872
873 def save_frozenset(self, obj):
874 save = self.save
875 write = self.write
876
877 if self.proto < 4:
878 self.save_reduce(frozenset, (list(obj),), obj=obj)
879 return
880
881 write(MARK)
882 for item in obj:
883 save(item)
884
885 if id(obj) in self.memo:
886 # If the object is already in the memo, this means it is
887 # recursive. In this case, throw away everything we put on the
888 # stack, and fetch the object back from the memo.
889 write(POP_MARK + self.get(self.memo[id(obj)][0]))
890 return
891
892 write(FROZENSET)
893 self.memoize(obj)
894 dispatch[frozenset] = save_frozenset
895
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300896 def save_global(self, obj, name=None):
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000897 write = self.write
898 memo = self.memo
899
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100900 if name is None and self.proto >= 4:
901 name = getattr(obj, '__qualname__', None)
Tim Petersc32d8242001-04-10 02:48:53 +0000902 if name is None:
Guido van Rossum3a41c612003-01-28 15:10:22 +0000903 name = obj.__name__
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000904
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100905 module_name = whichmodule(obj, name, allow_qualname=self.proto >= 4)
Guido van Rossumb0a98e92001-08-17 18:49:52 +0000906 try:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100907 __import__(module_name, level=0)
908 module = sys.modules[module_name]
909 obj2 = _getattribute(module, name, allow_qualname=self.proto >= 4)
Guido van Rossumb0a98e92001-08-17 18:49:52 +0000910 except (ImportError, KeyError, AttributeError):
911 raise PicklingError(
912 "Can't pickle %r: it's not found as %s.%s" %
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100913 (obj, module_name, name))
Guido van Rossumb0a98e92001-08-17 18:49:52 +0000914 else:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100915 if obj2 is not obj:
Guido van Rossumb0a98e92001-08-17 18:49:52 +0000916 raise PicklingError(
917 "Can't pickle %r: it's not the same object as %s.%s" %
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100918 (obj, module_name, name))
Guido van Rossumb0a98e92001-08-17 18:49:52 +0000919
Guido van Rossum255f3ee2003-01-29 06:14:11 +0000920 if self.proto >= 2:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100921 code = _extension_registry.get((module_name, name))
Guido van Rossum255f3ee2003-01-29 06:14:11 +0000922 if code:
923 assert code > 0
924 if code <= 0xff:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300925 write(EXT1 + pack("<B", code))
Guido van Rossum255f3ee2003-01-29 06:14:11 +0000926 elif code <= 0xffff:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +0300927 write(EXT2 + pack("<H", code))
Guido van Rossum255f3ee2003-01-29 06:14:11 +0000928 else:
929 write(EXT4 + pack("<i", code))
930 return
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000931 # Non-ASCII identifiers are supported only with protocols >= 3.
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100932 if self.proto >= 4:
933 self.save(module_name)
934 self.save(name)
935 write(STACK_GLOBAL)
936 elif self.proto >= 3:
937 write(GLOBAL + bytes(module_name, "utf-8") + b'\n' +
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000938 bytes(name, "utf-8") + b'\n')
939 else:
Antoine Pitroud9dfaa92009-06-04 20:32:06 +0000940 if self.fix_imports:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100941 r_name_mapping = _compat_pickle.REVERSE_NAME_MAPPING
942 r_import_mapping = _compat_pickle.REVERSE_IMPORT_MAPPING
943 if (module_name, name) in r_name_mapping:
944 module_name, name = r_name_mapping[(module_name, name)]
945 if module_name in r_import_mapping:
946 module_name = r_import_mapping[module_name]
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000947 try:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100948 write(GLOBAL + bytes(module_name, "ascii") + b'\n' +
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000949 bytes(name, "ascii") + b'\n')
950 except UnicodeEncodeError:
951 raise PicklingError(
952 "can't pickle global identifier '%s.%s' using "
953 "pickle protocol %i" % (module, name, self.proto))
Guido van Rossum255f3ee2003-01-29 06:14:11 +0000954
Guido van Rossum3a41c612003-01-28 15:10:22 +0000955 self.memoize(obj)
Tim Peters3b769832003-01-28 03:51:36 +0000956
Alexandre Vassalotti19b6fa62013-11-30 16:06:39 -0800957 def save_type(self, obj):
958 if obj is type(None):
959 return self.save_reduce(type, (None,), obj=obj)
960 elif obj is type(NotImplemented):
961 return self.save_reduce(type, (NotImplemented,), obj=obj)
962 elif obj is type(...):
963 return self.save_reduce(type, (...,), obj=obj)
964 return self.save_global(obj)
965
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000966 dispatch[FunctionType] = save_global
Alexandre Vassalotti19b6fa62013-11-30 16:06:39 -0800967 dispatch[type] = save_type
Guido van Rossum0c891ce1995-03-14 15:09:05 +0000968
Guido van Rossuma48061a1995-01-10 00:31:14 +0000969
Guido van Rossum1be31752003-01-28 15:19:53 +0000970# Unpickling machinery
971
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000972class _Unpickler:
Guido van Rossuma48061a1995-01-10 00:31:14 +0000973
Antoine Pitroud9dfaa92009-06-04 20:32:06 +0000974 def __init__(self, file, *, fix_imports=True,
975 encoding="ASCII", errors="strict"):
Guido van Rossum2e6a4b32007-05-04 19:56:22 +0000976 """This takes a binary file for reading a pickle data stream.
Raymond Hettingeraef22fb2002-05-29 16:18:42 +0000977
Tim Peters5bd2a792003-02-01 16:45:06 +0000978 The protocol version of the pickle is detected automatically, so no
979 proto argument is needed.
Raymond Hettingeraef22fb2002-05-29 16:18:42 +0000980
Guido van Rossumfeea0782007-10-10 18:00:50 +0000981 The file-like object must have two methods, a read() method
982 that takes an integer argument, and a readline() method that
983 requires no arguments. Both methods should return bytes.
984 Thus file-like object can be a binary file object opened for
985 reading, a BytesIO object, or any other custom object that
986 meets this interface.
Guido van Rossumf4169812008-03-17 22:56:06 +0000987
Antoine Pitroud9dfaa92009-06-04 20:32:06 +0000988 Optional keyword arguments are *fix_imports*, *encoding* and *errors*,
989 which are used to control compatiblity support for pickle stream
990 generated by Python 2.x. If *fix_imports* is True, pickle will try to
991 map the old Python 2.x names to the new names used in Python 3.x. The
992 *encoding* and *errors* tell pickle how to decode 8-bit string
993 instances pickled by Python 2.x; these default to 'ASCII' and
994 'strict', respectively.
Raymond Hettingeraef22fb2002-05-29 16:18:42 +0000995 """
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100996 self._file_readline = file.readline
997 self._file_read = file.read
Guido van Rossumb72cf2d1997-04-09 17:32:51 +0000998 self.memo = {}
Guido van Rossumf4169812008-03-17 22:56:06 +0000999 self.encoding = encoding
1000 self.errors = errors
Antoine Pitroud9dfaa92009-06-04 20:32:06 +00001001 self.proto = 0
1002 self.fix_imports = fix_imports
Guido van Rossuma48061a1995-01-10 00:31:14 +00001003
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001004 def load(self):
Guido van Rossum3a41c612003-01-28 15:10:22 +00001005 """Read a pickled object representation from the open file.
Raymond Hettingeraef22fb2002-05-29 16:18:42 +00001006
Guido van Rossum3a41c612003-01-28 15:10:22 +00001007 Return the reconstituted object hierarchy specified in the file.
Raymond Hettingeraef22fb2002-05-29 16:18:42 +00001008 """
Alexandre Vassalotti3cfcab92008-12-27 09:30:39 +00001009 # Check whether Unpickler was initialized correctly. This is
1010 # only needed to mimic the behavior of _pickle.Unpickler.dump().
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001011 if not hasattr(self, "_file_read"):
Alexandre Vassalotti3cfcab92008-12-27 09:30:39 +00001012 raise UnpicklingError("Unpickler.__init__() was not called by "
1013 "%s.__init__()" % (self.__class__.__name__,))
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001014 self._unframer = _Unframer(self._file_read, self._file_readline)
1015 self.read = self._unframer.read
1016 self.readline = self._unframer.readline
Jeremy Hylton20747fa2001-11-09 16:15:04 +00001017 self.mark = object() # any new unique object
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001018 self.stack = []
1019 self.append = self.stack.append
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001020 self.proto = 0
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001021 read = self.read
1022 dispatch = self.dispatch
1023 try:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001024 while True:
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001025 key = read(1)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001026 if not key:
1027 raise EOFError
Guido van Rossum98297ee2007-11-06 21:34:58 +00001028 assert isinstance(key, bytes_types)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001029 dispatch[key[0]](self)
Guido van Rossumb940e112007-01-10 16:19:56 +00001030 except _Stop as stopinst:
Guido van Rossumff871742000-12-13 18:11:56 +00001031 return stopinst.value
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001032
Tim Petersc23d18a2003-01-28 01:41:51 +00001033 # Return largest index k such that self.stack[k] is self.mark.
1034 # If the stack doesn't contain a mark, eventually raises IndexError.
1035 # This could be sped by maintaining another stack, of indices at which
1036 # the mark appears. For that matter, the latter stack would suffice,
1037 # and we wouldn't need to push mark objects on self.stack at all.
1038 # Doing so is probably a good thing, though, since if the pickle is
1039 # corrupt (or hostile) we may get a clue from finding self.mark embedded
1040 # in unpickled objects.
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001041 def marker(self):
1042 stack = self.stack
1043 mark = self.mark
1044 k = len(stack)-1
1045 while stack[k] is not mark: k = k-1
1046 return k
1047
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001048 def persistent_load(self, pid):
Benjamin Peterson49956b22009-01-10 17:05:44 +00001049 raise UnpicklingError("unsupported persistent id encountered")
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001050
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001051 dispatch = {}
1052
Guido van Rossumd6c9e632003-01-28 03:49:52 +00001053 def load_proto(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001054 proto = self.read(1)[0]
Guido van Rossumf4169812008-03-17 22:56:06 +00001055 if not 0 <= proto <= HIGHEST_PROTOCOL:
Guido van Rossum26d95c32007-08-27 23:18:54 +00001056 raise ValueError("unsupported pickle protocol: %d" % proto)
Antoine Pitroud9dfaa92009-06-04 20:32:06 +00001057 self.proto = proto
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001058 dispatch[PROTO[0]] = load_proto
Guido van Rossumd6c9e632003-01-28 03:49:52 +00001059
Alexandre Vassalottib6a2f2a2013-11-23 20:30:03 -08001060 def load_frame(self):
1061 frame_size, = unpack('<Q', self.read(8))
1062 if frame_size > sys.maxsize:
1063 raise ValueError("frame size > sys.maxsize: %d" % frame_size)
1064 self._unframer.load_frame(frame_size)
1065 dispatch[FRAME[0]] = load_frame
1066
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001067 def load_persid(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001068 pid = self.readline()[:-1].decode("ascii")
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001069 self.append(self.persistent_load(pid))
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001070 dispatch[PERSID[0]] = load_persid
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001071
1072 def load_binpersid(self):
Raymond Hettinger46ac8eb2002-06-30 03:39:14 +00001073 pid = self.stack.pop()
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001074 self.append(self.persistent_load(pid))
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001075 dispatch[BINPERSID[0]] = load_binpersid
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001076
1077 def load_none(self):
1078 self.append(None)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001079 dispatch[NONE[0]] = load_none
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001080
Guido van Rossum7d97d312003-01-28 04:25:27 +00001081 def load_false(self):
1082 self.append(False)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001083 dispatch[NEWFALSE[0]] = load_false
Guido van Rossum7d97d312003-01-28 04:25:27 +00001084
1085 def load_true(self):
1086 self.append(True)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001087 dispatch[NEWTRUE[0]] = load_true
Guido van Rossum7d97d312003-01-28 04:25:27 +00001088
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001089 def load_int(self):
Tim Peters19ef62d2001-08-28 22:21:18 +00001090 data = self.readline()
Guido van Rossume2763392002-04-05 19:30:08 +00001091 if data == FALSE[1:]:
1092 val = False
1093 elif data == TRUE[1:]:
1094 val = True
1095 else:
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001096 val = int(data, 0)
Guido van Rossume2763392002-04-05 19:30:08 +00001097 self.append(val)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001098 dispatch[INT[0]] = load_int
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001099
1100 def load_binint(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001101 self.append(unpack('<i', self.read(4))[0])
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001102 dispatch[BININT[0]] = load_binint
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001103
1104 def load_binint1(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001105 self.append(self.read(1)[0])
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001106 dispatch[BININT1[0]] = load_binint1
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001107
1108 def load_binint2(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001109 self.append(unpack('<H', self.read(2))[0])
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001110 dispatch[BININT2[0]] = load_binint2
Tim Peters2344fae2001-01-15 00:50:52 +00001111
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001112 def load_long(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001113 val = self.readline()[:-1]
1114 if val and val[-1] == b'L'[0]:
Mark Dickinson8dd05142009-01-20 20:43:58 +00001115 val = val[:-1]
Guido van Rossumfeea0782007-10-10 18:00:50 +00001116 self.append(int(val, 0))
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001117 dispatch[LONG[0]] = load_long
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001118
Guido van Rossumd6c9e632003-01-28 03:49:52 +00001119 def load_long1(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001120 n = self.read(1)[0]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001121 data = self.read(n)
1122 self.append(decode_long(data))
1123 dispatch[LONG1[0]] = load_long1
Guido van Rossumd6c9e632003-01-28 03:49:52 +00001124
1125 def load_long4(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001126 n, = unpack('<i', self.read(4))
Antoine Pitroubf6ecf92012-11-24 20:40:21 +01001127 if n < 0:
1128 # Corrupt or hostile pickle -- we never write one like this
Alexandre Vassalotticc757172013-04-14 02:25:10 -07001129 raise UnpicklingError("LONG pickle has negative byte count")
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001130 data = self.read(n)
1131 self.append(decode_long(data))
1132 dispatch[LONG4[0]] = load_long4
Guido van Rossumd6c9e632003-01-28 03:49:52 +00001133
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001134 def load_float(self):
Guido van Rossumff871742000-12-13 18:11:56 +00001135 self.append(float(self.readline()[:-1]))
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001136 dispatch[FLOAT[0]] = load_float
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001137
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001138 def load_binfloat(self):
Guido van Rossumd3703791998-10-22 20:15:36 +00001139 self.append(unpack('>d', self.read(8))[0])
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001140 dispatch[BINFLOAT[0]] = load_binfloat
Guido van Rossumd3703791998-10-22 20:15:36 +00001141
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001142 def load_string(self):
Alexandre Vassalotti7c5e0942013-04-15 23:14:55 -07001143 data = self.readline()[:-1]
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001144 # Strip outermost quotes
Alexandre Vassalotti7c5e0942013-04-15 23:14:55 -07001145 if len(data) >= 2 and data[0] == data[-1] and data[0] in b'"\'':
1146 data = data[1:-1]
Martin v. Löwis8a8da792002-08-14 07:46:28 +00001147 else:
Alexandre Vassalotti7c5e0942013-04-15 23:14:55 -07001148 raise UnpicklingError("the STRING opcode argument must be quoted")
1149 self.append(codecs.escape_decode(data)[0]
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001150 .decode(self.encoding, self.errors))
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001151 dispatch[STRING[0]] = load_string
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001152
1153 def load_binstring(self):
Antoine Pitroubf6ecf92012-11-24 20:40:21 +01001154 # Deprecated BINSTRING uses signed 32-bit length
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001155 len, = unpack('<i', self.read(4))
Antoine Pitroubf6ecf92012-11-24 20:40:21 +01001156 if len < 0:
Alexandre Vassalotticc757172013-04-14 02:25:10 -07001157 raise UnpicklingError("BINSTRING pickle has negative byte count")
Guido van Rossumf4169812008-03-17 22:56:06 +00001158 data = self.read(len)
1159 value = str(data, self.encoding, self.errors)
1160 self.append(value)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001161 dispatch[BINSTRING[0]] = load_binstring
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001162
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001163 def load_binbytes(self):
Antoine Pitroubf6ecf92012-11-24 20:40:21 +01001164 len, = unpack('<I', self.read(4))
1165 if len > maxsize:
Alexandre Vassalotticc757172013-04-14 02:25:10 -07001166 raise UnpicklingError("BINBYTES exceeds system's maximum size "
1167 "of %d bytes" % maxsize)
Guido van Rossumf4169812008-03-17 22:56:06 +00001168 self.append(self.read(len))
1169 dispatch[BINBYTES[0]] = load_binbytes
1170
Guido van Rossumb5f2f1b2000-03-10 23:20:09 +00001171 def load_unicode(self):
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001172 self.append(str(self.readline()[:-1], 'raw-unicode-escape'))
1173 dispatch[UNICODE[0]] = load_unicode
Guido van Rossumb5f2f1b2000-03-10 23:20:09 +00001174
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001175 def load_binunicode(self):
Antoine Pitroubf6ecf92012-11-24 20:40:21 +01001176 len, = unpack('<I', self.read(4))
1177 if len > maxsize:
Alexandre Vassalotticc757172013-04-14 02:25:10 -07001178 raise UnpicklingError("BINUNICODE exceeds system's maximum size "
1179 "of %d bytes" % maxsize)
Victor Stinner485fb562010-04-13 11:07:24 +00001180 self.append(str(self.read(len), 'utf-8', 'surrogatepass'))
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001181 dispatch[BINUNICODE[0]] = load_binunicode
Guido van Rossumb5f2f1b2000-03-10 23:20:09 +00001182
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001183 def load_binunicode8(self):
1184 len, = unpack('<Q', self.read(8))
1185 if len > maxsize:
1186 raise UnpicklingError("BINUNICODE8 exceeds system's maximum size "
1187 "of %d bytes" % maxsize)
1188 self.append(str(self.read(len), 'utf-8', 'surrogatepass'))
1189 dispatch[BINUNICODE8[0]] = load_binunicode8
1190
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001191 def load_short_binstring(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001192 len = self.read(1)[0]
1193 data = self.read(len)
Guido van Rossumf4169812008-03-17 22:56:06 +00001194 value = str(data, self.encoding, self.errors)
1195 self.append(value)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001196 dispatch[SHORT_BINSTRING[0]] = load_short_binstring
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001197
Guido van Rossumf4169812008-03-17 22:56:06 +00001198 def load_short_binbytes(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001199 len = self.read(1)[0]
1200 self.append(self.read(len))
Guido van Rossumf4169812008-03-17 22:56:06 +00001201 dispatch[SHORT_BINBYTES[0]] = load_short_binbytes
1202
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001203 def load_short_binunicode(self):
1204 len = self.read(1)[0]
1205 self.append(str(self.read(len), 'utf-8', 'surrogatepass'))
1206 dispatch[SHORT_BINUNICODE[0]] = load_short_binunicode
1207
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001208 def load_tuple(self):
1209 k = self.marker()
1210 self.stack[k:] = [tuple(self.stack[k+1:])]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001211 dispatch[TUPLE[0]] = load_tuple
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001212
1213 def load_empty_tuple(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001214 self.append(())
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001215 dispatch[EMPTY_TUPLE[0]] = load_empty_tuple
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001216
Guido van Rossum44f0ea52003-01-28 04:14:51 +00001217 def load_tuple1(self):
1218 self.stack[-1] = (self.stack[-1],)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001219 dispatch[TUPLE1[0]] = load_tuple1
Guido van Rossum44f0ea52003-01-28 04:14:51 +00001220
1221 def load_tuple2(self):
1222 self.stack[-2:] = [(self.stack[-2], self.stack[-1])]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001223 dispatch[TUPLE2[0]] = load_tuple2
Guido van Rossum44f0ea52003-01-28 04:14:51 +00001224
1225 def load_tuple3(self):
1226 self.stack[-3:] = [(self.stack[-3], self.stack[-2], self.stack[-1])]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001227 dispatch[TUPLE3[0]] = load_tuple3
Guido van Rossum44f0ea52003-01-28 04:14:51 +00001228
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001229 def load_empty_list(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001230 self.append([])
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001231 dispatch[EMPTY_LIST[0]] = load_empty_list
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001232
1233 def load_empty_dictionary(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001234 self.append({})
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001235 dispatch[EMPTY_DICT[0]] = load_empty_dictionary
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001236
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001237 def load_empty_set(self):
1238 self.append(set())
1239 dispatch[EMPTY_SET[0]] = load_empty_set
1240
1241 def load_frozenset(self):
1242 k = self.marker()
1243 self.stack[k:] = [frozenset(self.stack[k+1:])]
1244 dispatch[FROZENSET[0]] = load_frozenset
1245
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001246 def load_list(self):
1247 k = self.marker()
1248 self.stack[k:] = [self.stack[k+1:]]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001249 dispatch[LIST[0]] = load_list
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001250
1251 def load_dict(self):
1252 k = self.marker()
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001253 items = self.stack[k+1:]
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001254 d = {items[i]: items[i+1]
1255 for i in range(0, len(items), 2)}
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001256 self.stack[k:] = [d]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001257 dispatch[DICT[0]] = load_dict
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001258
Tim Petersd01c1e92003-01-30 15:41:46 +00001259 # INST and OBJ differ only in how they get a class object. It's not
1260 # only sensible to do the rest in a common routine, the two routines
1261 # previously diverged and grew different bugs.
1262 # klass is the class to instantiate, and k points to the topmost mark
1263 # object, following which are the arguments for klass.__init__.
1264 def _instantiate(self, klass, k):
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001265 args = tuple(self.stack[k+1:])
1266 del self.stack[k:]
Alexander Belopolskyd92f0402010-07-17 22:50:45 +00001267 if (args or not isinstance(klass, type) or
1268 hasattr(klass, "__getinitargs__")):
Guido van Rossum743d17e1998-09-15 20:25:57 +00001269 try:
Guido van Rossumb26a97a2003-01-28 22:29:13 +00001270 value = klass(*args)
Guido van Rossumb940e112007-01-10 16:19:56 +00001271 except TypeError as err:
Guido van Rossum26d95c32007-08-27 23:18:54 +00001272 raise TypeError("in constructor for %s: %s" %
1273 (klass.__name__, str(err)), sys.exc_info()[2])
Alexander Belopolskyd92f0402010-07-17 22:50:45 +00001274 else:
1275 value = klass.__new__(klass)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001276 self.append(value)
Tim Petersd01c1e92003-01-30 15:41:46 +00001277
1278 def load_inst(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001279 module = self.readline()[:-1].decode("ascii")
1280 name = self.readline()[:-1].decode("ascii")
Tim Petersd01c1e92003-01-30 15:41:46 +00001281 klass = self.find_class(module, name)
1282 self._instantiate(klass, self.marker())
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001283 dispatch[INST[0]] = load_inst
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001284
1285 def load_obj(self):
Tim Petersd01c1e92003-01-30 15:41:46 +00001286 # Stack is ... markobject classobject arg1 arg2 ...
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001287 k = self.marker()
Tim Petersd01c1e92003-01-30 15:41:46 +00001288 klass = self.stack.pop(k+1)
1289 self._instantiate(klass, k)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001290 dispatch[OBJ[0]] = load_obj
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001291
Guido van Rossum3a41c612003-01-28 15:10:22 +00001292 def load_newobj(self):
1293 args = self.stack.pop()
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001294 cls = self.stack.pop()
Guido van Rossum3a41c612003-01-28 15:10:22 +00001295 obj = cls.__new__(cls, *args)
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001296 self.append(obj)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001297 dispatch[NEWOBJ[0]] = load_newobj
Guido van Rossum3a41c612003-01-28 15:10:22 +00001298
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001299 def load_newobj_ex(self):
1300 kwargs = self.stack.pop()
1301 args = self.stack.pop()
1302 cls = self.stack.pop()
1303 obj = cls.__new__(cls, *args, **kwargs)
1304 self.append(obj)
1305 dispatch[NEWOBJ_EX[0]] = load_newobj_ex
1306
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001307 def load_global(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001308 module = self.readline()[:-1].decode("utf-8")
1309 name = self.readline()[:-1].decode("utf-8")
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001310 klass = self.find_class(module, name)
1311 self.append(klass)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001312 dispatch[GLOBAL[0]] = load_global
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001313
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001314 def load_stack_global(self):
1315 name = self.stack.pop()
1316 module = self.stack.pop()
1317 if type(name) is not str or type(module) is not str:
1318 raise UnpicklingError("STACK_GLOBAL requires str")
1319 self.append(self.find_class(module, name))
1320 dispatch[STACK_GLOBAL[0]] = load_stack_global
1321
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001322 def load_ext1(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001323 code = self.read(1)[0]
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001324 self.get_extension(code)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001325 dispatch[EXT1[0]] = load_ext1
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001326
1327 def load_ext2(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001328 code, = unpack('<H', self.read(2))
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001329 self.get_extension(code)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001330 dispatch[EXT2[0]] = load_ext2
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001331
1332 def load_ext4(self):
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001333 code, = unpack('<i', self.read(4))
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001334 self.get_extension(code)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001335 dispatch[EXT4[0]] = load_ext4
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001336
1337 def get_extension(self, code):
1338 nil = []
Guido van Rossumd4b920c2003-02-04 01:54:49 +00001339 obj = _extension_cache.get(code, nil)
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001340 if obj is not nil:
1341 self.append(obj)
1342 return
Guido van Rossumd4b920c2003-02-04 01:54:49 +00001343 key = _inverted_registry.get(code)
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001344 if not key:
Antoine Pitroubf6ecf92012-11-24 20:40:21 +01001345 if code <= 0: # note that 0 is forbidden
1346 # Corrupt or hostile pickle.
Alexandre Vassalotticc757172013-04-14 02:25:10 -07001347 raise UnpicklingError("EXT specifies code <= 0")
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001348 raise ValueError("unregistered extension code %d" % code)
1349 obj = self.find_class(*key)
Guido van Rossumd4b920c2003-02-04 01:54:49 +00001350 _extension_cache[code] = obj
Guido van Rossum255f3ee2003-01-29 06:14:11 +00001351 self.append(obj)
1352
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001353 def find_class(self, module, name):
Antoine Pitroud9dfaa92009-06-04 20:32:06 +00001354 # Subclasses may override this.
1355 if self.proto < 3 and self.fix_imports:
1356 if (module, name) in _compat_pickle.NAME_MAPPING:
1357 module, name = _compat_pickle.NAME_MAPPING[(module, name)]
1358 if module in _compat_pickle.IMPORT_MAPPING:
1359 module = _compat_pickle.IMPORT_MAPPING[module]
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001360 __import__(module, level=0)
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001361 return _getattribute(sys.modules[module], name,
1362 allow_qualname=self.proto >= 4)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001363
1364 def load_reduce(self):
1365 stack = self.stack
Guido van Rossumb26a97a2003-01-28 22:29:13 +00001366 args = stack.pop()
1367 func = stack[-1]
Guido van Rossum99603b02007-07-20 00:22:32 +00001368 try:
1369 value = func(*args)
1370 except:
1371 print(sys.exc_info())
1372 print(func, args)
1373 raise
Guido van Rossumb26a97a2003-01-28 22:29:13 +00001374 stack[-1] = value
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001375 dispatch[REDUCE[0]] = load_reduce
Guido van Rossuma48061a1995-01-10 00:31:14 +00001376
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001377 def load_pop(self):
1378 del self.stack[-1]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001379 dispatch[POP[0]] = load_pop
Guido van Rossum7b5430f1995-03-04 22:25:21 +00001380
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001381 def load_pop_mark(self):
1382 k = self.marker()
Guido van Rossum45e2fbc1998-03-26 21:13:24 +00001383 del self.stack[k:]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001384 dispatch[POP_MARK[0]] = load_pop_mark
Guido van Rossuma48061a1995-01-10 00:31:14 +00001385
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001386 def load_dup(self):
Guido van Rossumb1062fc1998-03-31 17:00:46 +00001387 self.append(self.stack[-1])
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001388 dispatch[DUP[0]] = load_dup
Guido van Rossuma48061a1995-01-10 00:31:14 +00001389
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001390 def load_get(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001391 i = int(self.readline()[:-1])
1392 self.append(self.memo[i])
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001393 dispatch[GET[0]] = load_get
Guido van Rossum78536471996-04-12 13:36:27 +00001394
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001395 def load_binget(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001396 i = self.read(1)[0]
1397 self.append(self.memo[i])
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001398 dispatch[BINGET[0]] = load_binget
Guido van Rossum78536471996-04-12 13:36:27 +00001399
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001400 def load_long_binget(self):
Antoine Pitroubf6ecf92012-11-24 20:40:21 +01001401 i, = unpack('<I', self.read(4))
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001402 self.append(self.memo[i])
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001403 dispatch[LONG_BINGET[0]] = load_long_binget
Guido van Rossum78536471996-04-12 13:36:27 +00001404
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001405 def load_put(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001406 i = int(self.readline()[:-1])
Antoine Pitrou55549ec2011-08-30 00:27:10 +02001407 if i < 0:
1408 raise ValueError("negative PUT argument")
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001409 self.memo[i] = self.stack[-1]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001410 dispatch[PUT[0]] = load_put
Guido van Rossuma48061a1995-01-10 00:31:14 +00001411
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001412 def load_binput(self):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001413 i = self.read(1)[0]
Antoine Pitrou55549ec2011-08-30 00:27:10 +02001414 if i < 0:
1415 raise ValueError("negative BINPUT argument")
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001416 self.memo[i] = self.stack[-1]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001417 dispatch[BINPUT[0]] = load_binput
Guido van Rossuma48061a1995-01-10 00:31:14 +00001418
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001419 def load_long_binput(self):
Antoine Pitroubf6ecf92012-11-24 20:40:21 +01001420 i, = unpack('<I', self.read(4))
1421 if i > maxsize:
Antoine Pitrou55549ec2011-08-30 00:27:10 +02001422 raise ValueError("negative LONG_BINPUT argument")
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001423 self.memo[i] = self.stack[-1]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001424 dispatch[LONG_BINPUT[0]] = load_long_binput
Guido van Rossuma48061a1995-01-10 00:31:14 +00001425
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001426 def load_memoize(self):
1427 memo = self.memo
1428 memo[len(memo)] = self.stack[-1]
1429 dispatch[MEMOIZE[0]] = load_memoize
1430
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001431 def load_append(self):
1432 stack = self.stack
Raymond Hettinger46ac8eb2002-06-30 03:39:14 +00001433 value = stack.pop()
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001434 list = stack[-1]
1435 list.append(value)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001436 dispatch[APPEND[0]] = load_append
Guido van Rossuma48061a1995-01-10 00:31:14 +00001437
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001438 def load_appends(self):
1439 stack = self.stack
1440 mark = self.marker()
Alexandre Vassalotti1f7492c2013-04-20 13:19:46 -07001441 list_obj = stack[mark - 1]
1442 items = stack[mark + 1:]
1443 if isinstance(list_obj, list):
1444 list_obj.extend(items)
1445 else:
1446 append = list_obj.append
1447 for item in items:
1448 append(item)
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001449 del stack[mark:]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001450 dispatch[APPENDS[0]] = load_appends
Tim Peters2344fae2001-01-15 00:50:52 +00001451
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001452 def load_setitem(self):
1453 stack = self.stack
Raymond Hettinger46ac8eb2002-06-30 03:39:14 +00001454 value = stack.pop()
1455 key = stack.pop()
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001456 dict = stack[-1]
1457 dict[key] = value
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001458 dispatch[SETITEM[0]] = load_setitem
Guido van Rossum0c891ce1995-03-14 15:09:05 +00001459
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001460 def load_setitems(self):
1461 stack = self.stack
1462 mark = self.marker()
1463 dict = stack[mark - 1]
Guido van Rossum45e2fbc1998-03-26 21:13:24 +00001464 for i in range(mark + 1, len(stack), 2):
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001465 dict[stack[i]] = stack[i + 1]
Guido van Rossuma48061a1995-01-10 00:31:14 +00001466
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001467 del stack[mark:]
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001468 dispatch[SETITEMS[0]] = load_setitems
Guido van Rossuma48061a1995-01-10 00:31:14 +00001469
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001470 def load_additems(self):
1471 stack = self.stack
1472 mark = self.marker()
1473 set_obj = stack[mark - 1]
1474 items = stack[mark + 1:]
1475 if isinstance(set_obj, set):
1476 set_obj.update(items)
1477 else:
1478 add = set_obj.add
1479 for item in items:
1480 add(item)
1481 del stack[mark:]
1482 dispatch[ADDITEMS[0]] = load_additems
1483
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001484 def load_build(self):
1485 stack = self.stack
Guido van Rossumac5b5d22003-01-28 22:01:16 +00001486 state = stack.pop()
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001487 inst = stack[-1]
Guido van Rossumac5b5d22003-01-28 22:01:16 +00001488 setstate = getattr(inst, "__setstate__", None)
Serhiy Storchakaa3e32c92013-04-14 13:37:02 +03001489 if setstate is not None:
Guido van Rossumac5b5d22003-01-28 22:01:16 +00001490 setstate(state)
1491 return
1492 slotstate = None
1493 if isinstance(state, tuple) and len(state) == 2:
1494 state, slotstate = state
1495 if state:
Alexandre Vassalottiebfecfd2009-05-25 18:50:33 +00001496 inst_dict = inst.__dict__
Antoine Pitroua9f48a02009-05-02 21:41:14 +00001497 intern = sys.intern
Alexandre Vassalottiebfecfd2009-05-25 18:50:33 +00001498 for k, v in state.items():
1499 if type(k) is str:
1500 inst_dict[intern(k)] = v
1501 else:
1502 inst_dict[k] = v
Guido van Rossumac5b5d22003-01-28 22:01:16 +00001503 if slotstate:
1504 for k, v in slotstate.items():
1505 setattr(inst, k, v)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001506 dispatch[BUILD[0]] = load_build
Guido van Rossuma48061a1995-01-10 00:31:14 +00001507
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001508 def load_mark(self):
1509 self.append(self.mark)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001510 dispatch[MARK[0]] = load_mark
Guido van Rossuma48061a1995-01-10 00:31:14 +00001511
Guido van Rossumb72cf2d1997-04-09 17:32:51 +00001512 def load_stop(self):
Raymond Hettinger46ac8eb2002-06-30 03:39:14 +00001513 value = self.stack.pop()
Guido van Rossumff871742000-12-13 18:11:56 +00001514 raise _Stop(value)
Guido van Rossum2e6a4b32007-05-04 19:56:22 +00001515 dispatch[STOP[0]] = load_stop
Guido van Rossuma48061a1995-01-10 00:31:14 +00001516
Guido van Rossumd6c9e632003-01-28 03:49:52 +00001517
Guido van Rossum0c891ce1995-03-14 15:09:05 +00001518# Shorthands
1519
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001520def _dump(obj, file, protocol=None, *, fix_imports=True):
1521 _Pickler(file, protocol, fix_imports=fix_imports).dump(obj)
Guido van Rossum0c891ce1995-03-14 15:09:05 +00001522
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001523def _dumps(obj, protocol=None, *, fix_imports=True):
Guido van Rossumcfe5f202007-05-08 21:26:54 +00001524 f = io.BytesIO()
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001525 _Pickler(f, protocol, fix_imports=fix_imports).dump(obj)
Guido van Rossumcfe5f202007-05-08 21:26:54 +00001526 res = f.getvalue()
Guido van Rossum98297ee2007-11-06 21:34:58 +00001527 assert isinstance(res, bytes_types)
Guido van Rossumcfe5f202007-05-08 21:26:54 +00001528 return res
Guido van Rossum0c891ce1995-03-14 15:09:05 +00001529
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001530def _load(file, *, fix_imports=True, encoding="ASCII", errors="strict"):
1531 return _Unpickler(file, fix_imports=fix_imports,
Antoine Pitroud9dfaa92009-06-04 20:32:06 +00001532 encoding=encoding, errors=errors).load()
Guido van Rossum0c891ce1995-03-14 15:09:05 +00001533
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001534def _loads(s, *, fix_imports=True, encoding="ASCII", errors="strict"):
Guido van Rossumcfe5f202007-05-08 21:26:54 +00001535 if isinstance(s, str):
1536 raise TypeError("Can't load pickle from unicode string")
1537 file = io.BytesIO(s)
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001538 return _Unpickler(file, fix_imports=fix_imports,
1539 encoding=encoding, errors=errors).load()
Guido van Rossumd6c9e632003-01-28 03:49:52 +00001540
Antoine Pitrouea99c5c2010-09-09 18:33:21 +00001541# Use the faster _pickle if possible
1542try:
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001543 from _pickle import (
1544 PickleError,
1545 PicklingError,
1546 UnpicklingError,
1547 Pickler,
1548 Unpickler,
1549 dump,
1550 dumps,
1551 load,
1552 loads
1553 )
Brett Cannoncd171c82013-07-04 17:43:24 -04001554except ImportError:
Antoine Pitrouea99c5c2010-09-09 18:33:21 +00001555 Pickler, Unpickler = _Pickler, _Unpickler
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001556 dump, dumps, load, loads = _dump, _dumps, _load, _loads
Antoine Pitrouea99c5c2010-09-09 18:33:21 +00001557
Guido van Rossumd6c9e632003-01-28 03:49:52 +00001558# Doctest
Guido van Rossumd6c9e632003-01-28 03:49:52 +00001559def _test():
1560 import doctest
1561 return doctest.testmod()
1562
1563if __name__ == "__main__":
Florent Xicluna54540ec2011-11-04 08:29:17 +01001564 import argparse
Alexander Belopolsky455f7bd2010-07-27 23:02:38 +00001565 parser = argparse.ArgumentParser(
1566 description='display contents of the pickle files')
1567 parser.add_argument(
1568 'pickle_file', type=argparse.FileType('br'),
1569 nargs='*', help='the pickle file')
1570 parser.add_argument(
1571 '-t', '--test', action='store_true',
1572 help='run self-test suite')
1573 parser.add_argument(
1574 '-v', action='store_true',
1575 help='run verbosely; only affects self-test run')
1576 args = parser.parse_args()
1577 if args.test:
1578 _test()
1579 else:
1580 if not args.pickle_file:
1581 parser.print_help()
1582 else:
1583 import pprint
1584 for f in args.pickle_file:
1585 obj = load(f)
1586 pprint.pprint(obj)