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