blob: 49be72047d019f4ee30df25b81f0786fd5b75aa3 [file] [log] [blame]
Collin Winter771d8342009-04-16 03:18:06 +00001import io
Jeremy Hylton66426532001-10-15 21:38:56 +00002import unittest
Tim Peters4190fb82003-02-02 16:09:05 +00003import pickle
Tim Peters31f119e2003-02-03 16:20:13 +00004import pickletools
Antoine Pitrou82be19f2011-08-29 23:09:33 +02005import sys
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +00006import copyreg
Antoine Pitroud9dfaa92009-06-04 20:32:06 +00007from http.cookies import SimpleCookie
Tim Peters4190fb82003-02-02 16:09:05 +00008
Antoine Pitrou82be19f2011-08-29 23:09:33 +02009from test.support import (
10 TestFailed, TESTFN, run_with_locale,
Antoine Pitrou94190bb2011-10-04 10:22:36 +020011 _2G, _4G, bigmemtest,
Antoine Pitrou82be19f2011-08-29 23:09:33 +020012 )
Tim Peterse089c682001-04-10 03:41:41 +000013
Guido van Rossum98297ee2007-11-06 21:34:58 +000014from pickle import bytes_types
15
Tim Petersee1a53c2003-02-02 02:57:53 +000016# Tests that try a number of pickle protocols should have a
17# for proto in protocols:
Tim Peters8587b3c2003-02-13 15:44:41 +000018# kind of outer loop.
Tim Peters8587b3c2003-02-13 15:44:41 +000019protocols = range(pickle.HIGHEST_PROTOCOL + 1)
Tim Petersee1a53c2003-02-02 02:57:53 +000020
Antoine Pitrou82be19f2011-08-29 23:09:33 +020021character_size = 4 if sys.maxunicode > 0xFFFF else 2
22
Tim Peters22e71712003-02-03 22:27:38 +000023
24# Return True if opcode code appears in the pickle, else False.
25def opcode_in_pickle(code, pickle):
26 for op, dummy, dummy in pickletools.genops(pickle):
Guido van Rossumcfe5f202007-05-08 21:26:54 +000027 if op.code == code.decode("latin-1"):
Tim Peters22e71712003-02-03 22:27:38 +000028 return True
29 return False
30
Tim Peters8d2613a2003-02-11 16:40:16 +000031# Return the number of times opcode code appears in pickle.
32def count_opcode(code, pickle):
33 n = 0
34 for op, dummy, dummy in pickletools.genops(pickle):
Guido van Rossumcfe5f202007-05-08 21:26:54 +000035 if op.code == code.decode("latin-1"):
Tim Peters8d2613a2003-02-11 16:40:16 +000036 n += 1
37 return n
38
Antoine Pitrou04248a82010-10-12 20:51:21 +000039
40class UnseekableIO(io.BytesIO):
41 def peek(self, *args):
42 raise NotImplementedError
43
44 def seekable(self):
45 return False
46
47 def seek(self, *args):
48 raise io.UnsupportedOperation
49
50 def tell(self):
51 raise io.UnsupportedOperation
52
53
Tim Peters3e667d52003-02-04 21:47:44 +000054# We can't very well test the extension registry without putting known stuff
55# in it, but we have to be careful to restore its original state. Code
56# should do this:
57#
58# e = ExtensionSaver(extension_code)
59# try:
60# fiddle w/ the extension registry's stuff for extension_code
61# finally:
62# e.restore()
63
64class ExtensionSaver:
65 # Remember current registration for code (if any), and remove it (if
66 # there is one).
67 def __init__(self, code):
68 self.code = code
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +000069 if code in copyreg._inverted_registry:
70 self.pair = copyreg._inverted_registry[code]
71 copyreg.remove_extension(self.pair[0], self.pair[1], code)
Tim Peters3e667d52003-02-04 21:47:44 +000072 else:
73 self.pair = None
74
75 # Restore previous registration for code.
76 def restore(self):
77 code = self.code
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +000078 curpair = copyreg._inverted_registry.get(code)
Tim Peters3e667d52003-02-04 21:47:44 +000079 if curpair is not None:
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +000080 copyreg.remove_extension(curpair[0], curpair[1], code)
Tim Peters3e667d52003-02-04 21:47:44 +000081 pair = self.pair
82 if pair is not None:
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +000083 copyreg.add_extension(pair[0], pair[1], code)
Tim Peters3e667d52003-02-04 21:47:44 +000084
Jeremy Hylton66426532001-10-15 21:38:56 +000085class C:
Guido van Rossum47b9ff62006-08-24 00:41:19 +000086 def __eq__(self, other):
87 return self.__dict__ == other.__dict__
Jeremy Hylton66426532001-10-15 21:38:56 +000088
Alexander Belopolskyd92f0402010-07-17 22:50:45 +000089class D(C):
90 def __init__(self, arg):
91 pass
92
93class E(C):
94 def __getinitargs__(self):
95 return ()
96
Jeremy Hylton66426532001-10-15 21:38:56 +000097import __main__
98__main__.C = C
99C.__module__ = "__main__"
Alexander Belopolskyd92f0402010-07-17 22:50:45 +0000100__main__.D = D
101D.__module__ = "__main__"
102__main__.E = E
103E.__module__ = "__main__"
Jeremy Hylton66426532001-10-15 21:38:56 +0000104
105class myint(int):
106 def __init__(self, x):
107 self.str = str(x)
108
109class initarg(C):
Guido van Rossum1444f672001-12-19 16:38:29 +0000110
Jeremy Hylton66426532001-10-15 21:38:56 +0000111 def __init__(self, a, b):
112 self.a = a
113 self.b = b
114
115 def __getinitargs__(self):
116 return self.a, self.b
117
Guido van Rossum04a86612001-12-19 16:58:54 +0000118class metaclass(type):
119 pass
120
Guido van Rossum52cc1d82007-03-18 15:41:51 +0000121class use_metaclass(object, metaclass=metaclass):
122 pass
Guido van Rossum04a86612001-12-19 16:58:54 +0000123
Antoine Pitrouffd41d92011-10-04 09:23:04 +0200124class pickling_metaclass(type):
125 def __eq__(self, other):
126 return (type(self) == type(other) and
127 self.reduce_args == other.reduce_args)
128
129 def __reduce__(self):
130 return (create_dynamic_class, self.reduce_args)
131
132def create_dynamic_class(name, bases):
133 result = pickling_metaclass(name, bases, dict())
134 result.reduce_args = (name, bases)
135 return result
136
Tim Peters70b02d72003-02-02 17:26:40 +0000137# DATA0 .. DATA2 are the pickles we expect under the various protocols, for
138# the object returned by create_data().
Tim Petersee1a53c2003-02-02 02:57:53 +0000139
Guido van Rossum98297ee2007-11-06 21:34:58 +0000140DATA0 = (
Mark Dickinson8dd05142009-01-20 20:43:58 +0000141 b'(lp0\nL0L\naL1L\naF2.0\nac'
Georg Brandl1a3284e2007-12-02 09:40:06 +0000142 b'builtins\ncomplex\n'
Guido van Rossum98297ee2007-11-06 21:34:58 +0000143 b'p1\n(F3.0\nF0.0\ntp2\nRp'
Mark Dickinson8dd05142009-01-20 20:43:58 +0000144 b'3\naL1L\naL-1L\naL255L\naL-'
145 b'255L\naL-256L\naL65535L\na'
146 b'L-65535L\naL-65536L\naL2'
147 b'147483647L\naL-2147483'
148 b'647L\naL-2147483648L\na('
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +0000149 b'Vabc\np4\ng4\nccopyreg'
Guido van Rossum98297ee2007-11-06 21:34:58 +0000150 b'\n_reconstructor\np5\n('
Georg Brandl1a3284e2007-12-02 09:40:06 +0000151 b'c__main__\nC\np6\ncbu'
152 b'iltins\nobject\np7\nNt'
Guido van Rossum98297ee2007-11-06 21:34:58 +0000153 b'p8\nRp9\n(dp10\nVfoo\np1'
Mark Dickinson8dd05142009-01-20 20:43:58 +0000154 b'1\nL1L\nsVbar\np12\nL2L\nsb'
155 b'g9\ntp13\nag13\naL5L\na.'
Guido van Rossum98297ee2007-11-06 21:34:58 +0000156)
Tim Peterse9358162001-01-22 22:05:20 +0000157
Guido van Rossum98297ee2007-11-06 21:34:58 +0000158# Disassembly of DATA0
Tim Peters70b02d72003-02-02 17:26:40 +0000159DATA0_DIS = """\
160 0: ( MARK
161 1: l LIST (MARK at 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000162 2: p PUT 0
163 5: L LONG 0
Mark Dickinson8dd05142009-01-20 20:43:58 +0000164 9: a APPEND
165 10: L LONG 1
166 14: a APPEND
167 15: F FLOAT 2.0
168 20: a APPEND
169 21: c GLOBAL 'builtins complex'
170 39: p PUT 1
171 42: ( MARK
172 43: F FLOAT 3.0
173 48: F FLOAT 0.0
174 53: t TUPLE (MARK at 42)
175 54: p PUT 2
176 57: R REDUCE
177 58: p PUT 3
178 61: a APPEND
179 62: L LONG 1
180 66: a APPEND
181 67: L LONG -1
182 72: a APPEND
183 73: L LONG 255
184 79: a APPEND
185 80: L LONG -255
186 87: a APPEND
187 88: L LONG -256
188 95: a APPEND
189 96: L LONG 65535
190 104: a APPEND
191 105: L LONG -65535
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +0000192 114: a APPEND
Mark Dickinson8dd05142009-01-20 20:43:58 +0000193 115: L LONG -65536
194 124: a APPEND
195 125: L LONG 2147483647
196 138: a APPEND
197 139: L LONG -2147483647
198 153: a APPEND
199 154: L LONG -2147483648
200 168: a APPEND
201 169: ( MARK
202 170: V UNICODE 'abc'
203 175: p PUT 4
204 178: g GET 4
205 181: c GLOBAL 'copyreg _reconstructor'
206 205: p PUT 5
207 208: ( MARK
208 209: c GLOBAL '__main__ C'
209 221: p PUT 6
210 224: c GLOBAL 'builtins object'
211 241: p PUT 7
212 244: N NONE
213 245: t TUPLE (MARK at 208)
214 246: p PUT 8
215 249: R REDUCE
216 250: p PUT 9
217 253: ( MARK
218 254: d DICT (MARK at 253)
219 255: p PUT 10
220 259: V UNICODE 'foo'
221 264: p PUT 11
222 268: L LONG 1
223 272: s SETITEM
224 273: V UNICODE 'bar'
225 278: p PUT 12
226 282: L LONG 2
227 286: s SETITEM
228 287: b BUILD
229 288: g GET 9
230 291: t TUPLE (MARK at 169)
231 292: p PUT 13
232 296: a APPEND
233 297: g GET 13
234 301: a APPEND
235 302: L LONG 5
236 306: a APPEND
237 307: . STOP
Tim Peters70b02d72003-02-02 17:26:40 +0000238highest protocol among opcodes = 0
239"""
240
Guido van Rossum98297ee2007-11-06 21:34:58 +0000241DATA1 = (
Georg Brandl1a3284e2007-12-02 09:40:06 +0000242 b']q\x00(K\x00K\x01G@\x00\x00\x00\x00\x00\x00\x00c'
243 b'builtins\ncomplex\nq\x01'
Guido van Rossum98297ee2007-11-06 21:34:58 +0000244 b'(G@\x08\x00\x00\x00\x00\x00\x00G\x00\x00\x00\x00\x00\x00\x00\x00t'
245 b'q\x02Rq\x03K\x01J\xff\xff\xff\xffK\xffJ\x01\xff\xff\xffJ'
246 b'\x00\xff\xff\xffM\xff\xffJ\x01\x00\xff\xffJ\x00\x00\xff\xffJ\xff\xff'
247 b'\xff\x7fJ\x01\x00\x00\x80J\x00\x00\x00\x80(X\x03\x00\x00\x00ab'
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +0000248 b'cq\x04h\x04ccopyreg\n_reco'
Guido van Rossum98297ee2007-11-06 21:34:58 +0000249 b'nstructor\nq\x05(c__main'
Georg Brandl1a3284e2007-12-02 09:40:06 +0000250 b'__\nC\nq\x06cbuiltins\n'
Guido van Rossum98297ee2007-11-06 21:34:58 +0000251 b'object\nq\x07Ntq\x08Rq\t}q\n('
252 b'X\x03\x00\x00\x00fooq\x0bK\x01X\x03\x00\x00\x00bar'
253 b'q\x0cK\x02ubh\ttq\rh\rK\x05e.'
254)
Tim Peters70b02d72003-02-02 17:26:40 +0000255
Guido van Rossum98297ee2007-11-06 21:34:58 +0000256# Disassembly of DATA1
Tim Peters70b02d72003-02-02 17:26:40 +0000257DATA1_DIS = """\
258 0: ] EMPTY_LIST
Guido van Rossum98297ee2007-11-06 21:34:58 +0000259 1: q BINPUT 0
Tim Peters70b02d72003-02-02 17:26:40 +0000260 3: ( MARK
261 4: K BININT1 0
Guido van Rossum98297ee2007-11-06 21:34:58 +0000262 6: K BININT1 1
263 8: G BINFLOAT 2.0
Georg Brandl1a3284e2007-12-02 09:40:06 +0000264 17: c GLOBAL 'builtins complex'
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +0000265 35: q BINPUT 1
266 37: ( MARK
267 38: G BINFLOAT 3.0
268 47: G BINFLOAT 0.0
269 56: t TUPLE (MARK at 37)
270 57: q BINPUT 2
271 59: R REDUCE
272 60: q BINPUT 3
273 62: K BININT1 1
274 64: J BININT -1
275 69: K BININT1 255
276 71: J BININT -255
277 76: J BININT -256
278 81: M BININT2 65535
279 84: J BININT -65535
280 89: J BININT -65536
281 94: J BININT 2147483647
282 99: J BININT -2147483647
283 104: J BININT -2147483648
284 109: ( MARK
285 110: X BINUNICODE 'abc'
286 118: q BINPUT 4
287 120: h BINGET 4
288 122: c GLOBAL 'copyreg _reconstructor'
289 146: q BINPUT 5
290 148: ( MARK
291 149: c GLOBAL '__main__ C'
292 161: q BINPUT 6
293 163: c GLOBAL 'builtins object'
294 180: q BINPUT 7
295 182: N NONE
296 183: t TUPLE (MARK at 148)
297 184: q BINPUT 8
298 186: R REDUCE
299 187: q BINPUT 9
300 189: } EMPTY_DICT
301 190: q BINPUT 10
302 192: ( MARK
303 193: X BINUNICODE 'foo'
304 201: q BINPUT 11
305 203: K BININT1 1
306 205: X BINUNICODE 'bar'
307 213: q BINPUT 12
308 215: K BININT1 2
309 217: u SETITEMS (MARK at 192)
310 218: b BUILD
311 219: h BINGET 9
312 221: t TUPLE (MARK at 109)
313 222: q BINPUT 13
314 224: h BINGET 13
315 226: K BININT1 5
316 228: e APPENDS (MARK at 3)
317 229: . STOP
Tim Peters70b02d72003-02-02 17:26:40 +0000318highest protocol among opcodes = 1
319"""
Tim Peterse0c446b2001-10-18 21:57:37 +0000320
Guido van Rossum98297ee2007-11-06 21:34:58 +0000321DATA2 = (
322 b'\x80\x02]q\x00(K\x00K\x01G@\x00\x00\x00\x00\x00\x00\x00c'
Georg Brandl1a3284e2007-12-02 09:40:06 +0000323 b'builtins\ncomplex\n'
Guido van Rossum98297ee2007-11-06 21:34:58 +0000324 b'q\x01G@\x08\x00\x00\x00\x00\x00\x00G\x00\x00\x00\x00\x00\x00\x00\x00'
325 b'\x86q\x02Rq\x03K\x01J\xff\xff\xff\xffK\xffJ\x01\xff\xff\xff'
326 b'J\x00\xff\xff\xffM\xff\xffJ\x01\x00\xff\xffJ\x00\x00\xff\xffJ\xff'
327 b'\xff\xff\x7fJ\x01\x00\x00\x80J\x00\x00\x00\x80(X\x03\x00\x00\x00a'
328 b'bcq\x04h\x04c__main__\nC\nq\x05'
329 b')\x81q\x06}q\x07(X\x03\x00\x00\x00fooq\x08K\x01'
330 b'X\x03\x00\x00\x00barq\tK\x02ubh\x06tq\nh'
331 b'\nK\x05e.'
332)
Tim Petersfc273752003-03-02 04:54:24 +0000333
Guido van Rossum98297ee2007-11-06 21:34:58 +0000334# Disassembly of DATA2
Tim Petersfc273752003-03-02 04:54:24 +0000335DATA2_DIS = """\
336 0: \x80 PROTO 2
337 2: ] EMPTY_LIST
Guido van Rossum98297ee2007-11-06 21:34:58 +0000338 3: q BINPUT 0
Tim Petersfc273752003-03-02 04:54:24 +0000339 5: ( MARK
340 6: K BININT1 0
Guido van Rossum98297ee2007-11-06 21:34:58 +0000341 8: K BININT1 1
342 10: G BINFLOAT 2.0
Georg Brandl1a3284e2007-12-02 09:40:06 +0000343 19: c GLOBAL 'builtins complex'
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +0000344 37: q BINPUT 1
345 39: G BINFLOAT 3.0
346 48: G BINFLOAT 0.0
347 57: \x86 TUPLE2
348 58: q BINPUT 2
349 60: R REDUCE
350 61: q BINPUT 3
351 63: K BININT1 1
352 65: J BININT -1
353 70: K BININT1 255
354 72: J BININT -255
355 77: J BININT -256
356 82: M BININT2 65535
357 85: J BININT -65535
358 90: J BININT -65536
359 95: J BININT 2147483647
360 100: J BININT -2147483647
361 105: J BININT -2147483648
362 110: ( MARK
363 111: X BINUNICODE 'abc'
364 119: q BINPUT 4
365 121: h BINGET 4
366 123: c GLOBAL '__main__ C'
367 135: q BINPUT 5
368 137: ) EMPTY_TUPLE
369 138: \x81 NEWOBJ
370 139: q BINPUT 6
371 141: } EMPTY_DICT
372 142: q BINPUT 7
373 144: ( MARK
374 145: X BINUNICODE 'foo'
375 153: q BINPUT 8
376 155: K BININT1 1
377 157: X BINUNICODE 'bar'
378 165: q BINPUT 9
379 167: K BININT1 2
380 169: u SETITEMS (MARK at 144)
381 170: b BUILD
382 171: h BINGET 6
383 173: t TUPLE (MARK at 110)
384 174: q BINPUT 10
385 176: h BINGET 10
386 178: K BININT1 5
387 180: e APPENDS (MARK at 5)
388 181: . STOP
Tim Petersfc273752003-03-02 04:54:24 +0000389highest protocol among opcodes = 2
390"""
391
Antoine Pitroud9dfaa92009-06-04 20:32:06 +0000392# set([1,2]) pickled from 2.x with protocol 2
393DATA3 = b'\x80\x02c__builtin__\nset\nq\x00]q\x01(K\x01K\x02e\x85q\x02Rq\x03.'
394
395# xrange(5) pickled from 2.x with protocol 2
396DATA4 = b'\x80\x02c__builtin__\nxrange\nq\x00K\x00K\x05K\x01\x87q\x01Rq\x02.'
397
398# a SimpleCookie() object pickled from 2.x with protocol 2
399DATA5 = (b'\x80\x02cCookie\nSimpleCookie\nq\x00)\x81q\x01U\x03key'
400 b'q\x02cCookie\nMorsel\nq\x03)\x81q\x04(U\x07commentq\x05U'
401 b'\x00q\x06U\x06domainq\x07h\x06U\x06secureq\x08h\x06U\x07'
402 b'expiresq\th\x06U\x07max-ageq\nh\x06U\x07versionq\x0bh\x06U'
403 b'\x04pathq\x0ch\x06U\x08httponlyq\rh\x06u}q\x0e(U\x0b'
404 b'coded_valueq\x0fU\x05valueq\x10h\x10h\x10h\x02h\x02ubs}q\x11b.')
405
406# set([3]) pickled from 2.x with protocol 2
407DATA6 = b'\x80\x02c__builtin__\nset\nq\x00]q\x01K\x03a\x85q\x02Rq\x03.'
408
409
Jeremy Hylton66426532001-10-15 21:38:56 +0000410def create_data():
Tim Peterse9358162001-01-22 22:05:20 +0000411 c = C()
412 c.foo = 1
413 c.bar = 2
Guido van Rossume2a383d2007-01-15 16:59:06 +0000414 x = [0, 1, 2.0, 3.0+0j]
Tim Peters461922a2001-04-09 20:07:05 +0000415 # Append some integer test cases at cPickle.c's internal size
416 # cutoffs.
417 uint1max = 0xff
418 uint2max = 0xffff
419 int4max = 0x7fffffff
420 x.extend([1, -1,
421 uint1max, -uint1max, -uint1max-1,
422 uint2max, -uint2max, -uint2max-1,
423 int4max, -int4max, -int4max-1])
Tim Peterse9358162001-01-22 22:05:20 +0000424 y = ('abc', 'abc', c, c)
425 x.append(y)
426 x.append(y)
427 x.append(5)
Jeremy Hylton66426532001-10-15 21:38:56 +0000428 return x
Tim Petersc58440f2001-04-09 17:16:31 +0000429
Jeremy Hylton66426532001-10-15 21:38:56 +0000430class AbstractPickleTests(unittest.TestCase):
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000431 # Subclass must define self.dumps, self.loads.
Tim Petersc58440f2001-04-09 17:16:31 +0000432
Jeremy Hylton66426532001-10-15 21:38:56 +0000433 _testdata = create_data()
Tim Petersc58440f2001-04-09 17:16:31 +0000434
Jeremy Hylton66426532001-10-15 21:38:56 +0000435 def setUp(self):
Tim Peterse9358162001-01-22 22:05:20 +0000436 pass
Tim Petersc58440f2001-04-09 17:16:31 +0000437
Jeremy Hylton66426532001-10-15 21:38:56 +0000438 def test_misc(self):
439 # test various datatypes not tested by testdata
Tim Peters70b02d72003-02-02 17:26:40 +0000440 for proto in protocols:
441 x = myint(4)
442 s = self.dumps(x, proto)
443 y = self.loads(s)
444 self.assertEqual(x, y)
Tim Peterse9358162001-01-22 22:05:20 +0000445
Tim Peters70b02d72003-02-02 17:26:40 +0000446 x = (1, ())
447 s = self.dumps(x, proto)
448 y = self.loads(s)
449 self.assertEqual(x, y)
Tim Peterse9358162001-01-22 22:05:20 +0000450
Tim Peters70b02d72003-02-02 17:26:40 +0000451 x = initarg(1, x)
452 s = self.dumps(x, proto)
453 y = self.loads(s)
454 self.assertEqual(x, y)
Tim Peterse9358162001-01-22 22:05:20 +0000455
Jeremy Hylton66426532001-10-15 21:38:56 +0000456 # XXX test __reduce__ protocol?
457
Tim Peters70b02d72003-02-02 17:26:40 +0000458 def test_roundtrip_equality(self):
459 expected = self._testdata
460 for proto in protocols:
461 s = self.dumps(expected, proto)
462 got = self.loads(s)
463 self.assertEqual(expected, got)
Jeremy Hylton66426532001-10-15 21:38:56 +0000464
Guido van Rossum98297ee2007-11-06 21:34:58 +0000465 def test_load_from_data0(self):
466 self.assertEqual(self._testdata, self.loads(DATA0))
467
468 def test_load_from_data1(self):
469 self.assertEqual(self._testdata, self.loads(DATA1))
470
471 def test_load_from_data2(self):
472 self.assertEqual(self._testdata, self.loads(DATA2))
Jeremy Hylton66426532001-10-15 21:38:56 +0000473
Alexander Belopolskyd92f0402010-07-17 22:50:45 +0000474 def test_load_classic_instance(self):
475 # See issue5180. Test loading 2.x pickles that
476 # contain an instance of old style class.
477 for X, args in [(C, ()), (D, ('x',)), (E, ())]:
478 xname = X.__name__.encode('ascii')
479 # Protocol 0 (text mode pickle):
480 """
481 0: ( MARK
482 1: i INST '__main__ X' (MARK at 0)
483 15: p PUT 0
484 18: ( MARK
485 19: d DICT (MARK at 18)
486 20: p PUT 1
487 23: b BUILD
488 24: . STOP
489 """
490 pickle0 = (b"(i__main__\n"
491 b"X\n"
492 b"p0\n"
493 b"(dp1\nb.").replace(b'X', xname)
494 self.assertEqual(X(*args), self.loads(pickle0))
495
496 # Protocol 1 (binary mode pickle)
497 """
498 0: ( MARK
499 1: c GLOBAL '__main__ X'
500 15: q BINPUT 0
501 17: o OBJ (MARK at 0)
502 18: q BINPUT 1
503 20: } EMPTY_DICT
504 21: q BINPUT 2
505 23: b BUILD
506 24: . STOP
507 """
508 pickle1 = (b'(c__main__\n'
509 b'X\n'
510 b'q\x00oq\x01}q\x02b.').replace(b'X', xname)
511 self.assertEqual(X(*args), self.loads(pickle1))
512
513 # Protocol 2 (pickle2 = b'\x80\x02' + pickle1)
514 """
515 0: \x80 PROTO 2
516 2: ( MARK
517 3: c GLOBAL '__main__ X'
518 17: q BINPUT 0
519 19: o OBJ (MARK at 2)
520 20: q BINPUT 1
521 22: } EMPTY_DICT
522 23: q BINPUT 2
523 25: b BUILD
524 26: . STOP
525 """
526 pickle2 = (b'\x80\x02(c__main__\n'
527 b'X\n'
528 b'q\x00oq\x01}q\x02b.').replace(b'X', xname)
529 self.assertEqual(X(*args), self.loads(pickle2))
530
Tim Peters70b02d72003-02-02 17:26:40 +0000531 # There are gratuitous differences between pickles produced by
532 # pickle and cPickle, largely because cPickle starts PUT indices at
533 # 1 and pickle starts them at 0. See XXX comment in cPickle's put2() --
534 # there's a comment with an exclamation point there whose meaning
535 # is a mystery. cPickle also suppresses PUT for objects with a refcount
536 # of 1.
537 def dont_test_disassembly(self):
Guido van Rossum34d19282007-08-09 01:03:29 +0000538 from io import StringIO
Tim Peters70b02d72003-02-02 17:26:40 +0000539 from pickletools import dis
540
541 for proto, expected in (0, DATA0_DIS), (1, DATA1_DIS):
542 s = self.dumps(self._testdata, proto)
543 filelike = StringIO()
544 dis(s, out=filelike)
545 got = filelike.getvalue()
546 self.assertEqual(expected, got)
Jeremy Hylton66426532001-10-15 21:38:56 +0000547
548 def test_recursive_list(self):
549 l = []
550 l.append(l)
Tim Peters70b02d72003-02-02 17:26:40 +0000551 for proto in protocols:
552 s = self.dumps(l, proto)
553 x = self.loads(s)
Armin Rigo2b3eb402003-10-28 12:05:48 +0000554 self.assertEqual(len(x), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000555 self.assertTrue(x is x[0])
Jeremy Hylton66426532001-10-15 21:38:56 +0000556
Collin Winter8ca69de2009-05-26 16:53:41 +0000557 def test_recursive_tuple(self):
558 t = ([],)
559 t[0].append(t)
560 for proto in protocols:
561 s = self.dumps(t, proto)
562 x = self.loads(s)
563 self.assertEqual(len(x), 1)
564 self.assertEqual(len(x[0]), 1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000565 self.assertTrue(x is x[0][0])
Collin Winter8ca69de2009-05-26 16:53:41 +0000566
Jeremy Hylton66426532001-10-15 21:38:56 +0000567 def test_recursive_dict(self):
568 d = {}
569 d[1] = d
Tim Peters70b02d72003-02-02 17:26:40 +0000570 for proto in protocols:
571 s = self.dumps(d, proto)
572 x = self.loads(s)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000573 self.assertEqual(list(x.keys()), [1])
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000574 self.assertTrue(x[1] is x)
Jeremy Hylton66426532001-10-15 21:38:56 +0000575
576 def test_recursive_inst(self):
577 i = C()
578 i.attr = i
Tim Peters70b02d72003-02-02 17:26:40 +0000579 for proto in protocols:
580 s = self.dumps(i, 2)
581 x = self.loads(s)
Armin Rigo2b3eb402003-10-28 12:05:48 +0000582 self.assertEqual(dir(x), dir(i))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000583 self.assertTrue(x.attr is x)
Jeremy Hylton66426532001-10-15 21:38:56 +0000584
585 def test_recursive_multi(self):
586 l = []
587 d = {1:l}
588 i = C()
589 i.attr = d
590 l.append(i)
Tim Peters70b02d72003-02-02 17:26:40 +0000591 for proto in protocols:
592 s = self.dumps(l, proto)
593 x = self.loads(s)
Armin Rigo2b3eb402003-10-28 12:05:48 +0000594 self.assertEqual(len(x), 1)
595 self.assertEqual(dir(x[0]), dir(i))
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000596 self.assertEqual(list(x[0].attr.keys()), [1])
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000597 self.assertTrue(x[0].attr[1] is x)
Jeremy Hylton66426532001-10-15 21:38:56 +0000598
Alexandre Vassalottica2d6102008-06-12 18:26:05 +0000599 def test_get(self):
600 self.assertRaises(KeyError, self.loads, b'g0\np0')
Ezio Melottib3aedd42010-11-20 19:04:17 +0000601 self.assertEqual(self.loads(b'((Kdtp0\nh\x00l.))'), [(100,), (100,)])
Jeremy Hylton66426532001-10-15 21:38:56 +0000602
603 def test_insecure_strings(self):
Guido van Rossum39478e82007-08-27 17:23:59 +0000604 # XXX Some of these tests are temporarily disabled
605 insecure = [b"abc", b"2 + 2", # not quoted
606 ## b"'abc' + 'def'", # not a single quoted string
607 b"'abc", # quote is not closed
608 b"'abc\"", # open quote and close quote don't match
609 b"'abc' ?", # junk after close quote
610 b"'\\'", # trailing backslash
Jeremy Hylton66426532001-10-15 21:38:56 +0000611 # some tests of the quoting rules
Guido van Rossum39478e82007-08-27 17:23:59 +0000612 ## b"'abc\"\''",
613 ## b"'\\\\a\'\'\'\\\'\\\\\''",
Jeremy Hylton66426532001-10-15 21:38:56 +0000614 ]
Guido van Rossum39478e82007-08-27 17:23:59 +0000615 for b in insecure:
616 buf = b"S" + b + b"\012p0\012."
Jeremy Hylton66426532001-10-15 21:38:56 +0000617 self.assertRaises(ValueError, self.loads, buf)
618
Walter Dörwald9b775532007-06-08 14:30:53 +0000619 def test_unicode(self):
Benjamin Petersond1486302008-12-27 16:58:50 +0000620 endcases = ['', '<\\u>', '<\\\u1234>', '<\n>',
Victor Stinner485fb562010-04-13 11:07:24 +0000621 '<\\>', '<\\\U00012345>',
622 # surrogates
623 '<\udc80>']
Walter Dörwald9b775532007-06-08 14:30:53 +0000624 for proto in protocols:
625 for u in endcases:
626 p = self.dumps(u, proto)
627 u2 = self.loads(p)
628 self.assertEqual(u2, u)
Tim Peterse089c682001-04-10 03:41:41 +0000629
Alexandre Vassalotti554d8782008-12-27 07:32:41 +0000630 def test_unicode_high_plane(self):
631 t = '\U00012345'
632 for proto in protocols:
633 p = self.dumps(t, proto)
634 t2 = self.loads(p)
635 self.assertEqual(t2, t)
636
Guido van Rossumf4169812008-03-17 22:56:06 +0000637 def test_bytes(self):
638 for proto in protocols:
639 for u in b'', b'xyz', b'xyz'*100:
640 p = self.dumps(u)
641 self.assertEqual(self.loads(p), u)
642
Jeremy Hylton66426532001-10-15 21:38:56 +0000643 def test_ints(self):
644 import sys
Tim Petersee1a53c2003-02-02 02:57:53 +0000645 for proto in protocols:
Christian Heimesa37d4c62007-12-04 23:02:19 +0000646 n = sys.maxsize
Tim Petersee1a53c2003-02-02 02:57:53 +0000647 while n:
648 for expected in (-n, n):
649 s = self.dumps(expected, proto)
650 n2 = self.loads(s)
651 self.assertEqual(expected, n2)
652 n = n >> 1
Tim Peters19ef62d2001-08-28 22:21:18 +0000653
Jeremy Hylton66426532001-10-15 21:38:56 +0000654 def test_maxint64(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000655 maxint64 = (1 << 63) - 1
Guido van Rossum39478e82007-08-27 17:23:59 +0000656 data = b'I' + str(maxint64).encode("ascii") + b'\n.'
Jeremy Hylton66426532001-10-15 21:38:56 +0000657 got = self.loads(data)
658 self.assertEqual(got, maxint64)
659
660 # Try too with a bogus literal.
Guido van Rossum39478e82007-08-27 17:23:59 +0000661 data = b'I' + str(maxint64).encode("ascii") + b'JUNK\n.'
Jeremy Hylton66426532001-10-15 21:38:56 +0000662 self.assertRaises(ValueError, self.loads, data)
663
Tim Petersee1a53c2003-02-02 02:57:53 +0000664 def test_long(self):
665 for proto in protocols:
Tim Petersbf2674b2003-02-02 07:51:32 +0000666 # 256 bytes is where LONG4 begins.
Tim Petersee1a53c2003-02-02 02:57:53 +0000667 for nbits in 1, 8, 8*254, 8*255, 8*256, 8*257:
Guido van Rossume2a383d2007-01-15 16:59:06 +0000668 nbase = 1 << nbits
Tim Petersee1a53c2003-02-02 02:57:53 +0000669 for npos in nbase-1, nbase, nbase+1:
670 for n in npos, -npos:
671 pickle = self.dumps(n, proto)
672 got = self.loads(pickle)
673 self.assertEqual(n, got)
674 # Try a monster. This is quadratic-time in protos 0 & 1, so don't
675 # bother with those.
Guido van Rossume2a383d2007-01-15 16:59:06 +0000676 nbase = int("deadbeeffeedface", 16)
Tim Petersee1a53c2003-02-02 02:57:53 +0000677 nbase += nbase << 1000000
678 for n in nbase, -nbase:
Tim Petersee1a53c2003-02-02 02:57:53 +0000679 p = self.dumps(n, 2)
Tim Petersee1a53c2003-02-02 02:57:53 +0000680 got = self.loads(p)
Tim Petersee1a53c2003-02-02 02:57:53 +0000681 self.assertEqual(n, got)
682
Mark Dickinsoncddcf442009-01-24 21:46:33 +0000683 def test_float(self):
684 test_values = [0.0, 4.94e-324, 1e-310, 7e-308, 6.626e-34, 0.1, 0.5,
685 3.14, 263.44582062374053, 6.022e23, 1e30]
686 test_values = test_values + [-x for x in test_values]
687 for proto in protocols:
688 for value in test_values:
689 pickle = self.dumps(value, proto)
690 got = self.loads(pickle)
691 self.assertEqual(value, got)
692
Thomas Wouters477c8d52006-05-27 19:21:47 +0000693 @run_with_locale('LC_ALL', 'de_DE', 'fr_FR')
694 def test_float_format(self):
Guido van Rossumf4169812008-03-17 22:56:06 +0000695 # make sure that floats are formatted locale independent with proto 0
696 self.assertEqual(self.dumps(1.2, 0)[0:3], b'F1.')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000697
Jeremy Hylton66426532001-10-15 21:38:56 +0000698 def test_reduce(self):
Tim Peters19ef62d2001-08-28 22:21:18 +0000699 pass
Jeremy Hylton66426532001-10-15 21:38:56 +0000700
701 def test_getinitargs(self):
702 pass
703
Guido van Rossum04a86612001-12-19 16:58:54 +0000704 def test_metaclass(self):
705 a = use_metaclass()
Tim Peters70b02d72003-02-02 17:26:40 +0000706 for proto in protocols:
707 s = self.dumps(a, proto)
708 b = self.loads(s)
709 self.assertEqual(a.__class__, b.__class__)
Guido van Rossum04a86612001-12-19 16:58:54 +0000710
Antoine Pitrouffd41d92011-10-04 09:23:04 +0200711 def test_dynamic_class(self):
712 a = create_dynamic_class("my_dynamic_class", (object,))
713 copyreg.pickle(pickling_metaclass, pickling_metaclass.__reduce__)
714 for proto in protocols:
715 s = self.dumps(a, proto)
716 b = self.loads(s)
717 self.assertEqual(a, b)
718
Michael W. Hudson7bb466a2002-03-05 13:27:58 +0000719 def test_structseq(self):
720 import time
Michael W. Hudson0e025302002-03-06 17:11:18 +0000721 import os
Tim Peters70b02d72003-02-02 17:26:40 +0000722
723 t = time.localtime()
724 for proto in protocols:
725 s = self.dumps(t, proto)
Michael W. Hudson0e025302002-03-06 17:11:18 +0000726 u = self.loads(s)
727 self.assertEqual(t, u)
Tim Peters70b02d72003-02-02 17:26:40 +0000728 if hasattr(os, "stat"):
729 t = os.stat(os.curdir)
730 s = self.dumps(t, proto)
731 u = self.loads(s)
732 self.assertEqual(t, u)
733 if hasattr(os, "statvfs"):
734 t = os.statvfs(os.curdir)
735 s = self.dumps(t, proto)
736 u = self.loads(s)
737 self.assertEqual(t, u)
Michael W. Hudson7bb466a2002-03-05 13:27:58 +0000738
Guido van Rossumd6c9e632003-01-28 03:49:52 +0000739 # Tests for protocol 2
740
Tim Peters4190fb82003-02-02 16:09:05 +0000741 def test_proto(self):
742 build_none = pickle.NONE + pickle.STOP
743 for proto in protocols:
744 expected = build_none
745 if proto >= 2:
Guido van Rossumcfe5f202007-05-08 21:26:54 +0000746 expected = pickle.PROTO + bytes([proto]) + expected
Tim Peters4190fb82003-02-02 16:09:05 +0000747 p = self.dumps(None, proto)
748 self.assertEqual(p, expected)
749
750 oob = protocols[-1] + 1 # a future protocol
Guido van Rossumcfe5f202007-05-08 21:26:54 +0000751 badpickle = pickle.PROTO + bytes([oob]) + build_none
Tim Peters4190fb82003-02-02 16:09:05 +0000752 try:
753 self.loads(badpickle)
Guido van Rossumb940e112007-01-10 16:19:56 +0000754 except ValueError as detail:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000755 self.assertTrue(str(detail).startswith(
Tim Peters4190fb82003-02-02 16:09:05 +0000756 "unsupported pickle protocol"))
757 else:
758 self.fail("expected bad protocol number to raise ValueError")
759
Guido van Rossumd6c9e632003-01-28 03:49:52 +0000760 def test_long1(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000761 x = 12345678910111213141516178920
Tim Peters61bf2572003-02-03 21:31:22 +0000762 for proto in protocols:
763 s = self.dumps(x, proto)
764 y = self.loads(s)
765 self.assertEqual(x, y)
Tim Peters22e71712003-02-03 22:27:38 +0000766 self.assertEqual(opcode_in_pickle(pickle.LONG1, s), proto >= 2)
Guido van Rossumd6c9e632003-01-28 03:49:52 +0000767
768 def test_long4(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000769 x = 12345678910111213141516178920 << (256*8)
Tim Peters61bf2572003-02-03 21:31:22 +0000770 for proto in protocols:
771 s = self.dumps(x, proto)
772 y = self.loads(s)
773 self.assertEqual(x, y)
Tim Peters22e71712003-02-03 22:27:38 +0000774 self.assertEqual(opcode_in_pickle(pickle.LONG4, s), proto >= 2)
Guido van Rossumd6c9e632003-01-28 03:49:52 +0000775
Guido van Rossum44f0ea52003-01-28 04:14:51 +0000776 def test_short_tuples(self):
Tim Peters1d63c9f2003-02-02 20:29:39 +0000777 # Map (proto, len(tuple)) to expected opcode.
778 expected_opcode = {(0, 0): pickle.TUPLE,
779 (0, 1): pickle.TUPLE,
780 (0, 2): pickle.TUPLE,
781 (0, 3): pickle.TUPLE,
782 (0, 4): pickle.TUPLE,
783
784 (1, 0): pickle.EMPTY_TUPLE,
785 (1, 1): pickle.TUPLE,
786 (1, 2): pickle.TUPLE,
787 (1, 3): pickle.TUPLE,
788 (1, 4): pickle.TUPLE,
789
790 (2, 0): pickle.EMPTY_TUPLE,
791 (2, 1): pickle.TUPLE1,
792 (2, 2): pickle.TUPLE2,
793 (2, 3): pickle.TUPLE3,
794 (2, 4): pickle.TUPLE,
Guido van Rossumf4169812008-03-17 22:56:06 +0000795
796 (3, 0): pickle.EMPTY_TUPLE,
797 (3, 1): pickle.TUPLE1,
798 (3, 2): pickle.TUPLE2,
799 (3, 3): pickle.TUPLE3,
800 (3, 4): pickle.TUPLE,
Tim Peters1d63c9f2003-02-02 20:29:39 +0000801 }
Guido van Rossum44f0ea52003-01-28 04:14:51 +0000802 a = ()
Guido van Rossum025bc2f2003-01-28 04:20:02 +0000803 b = (1,)
804 c = (1, 2)
805 d = (1, 2, 3)
806 e = (1, 2, 3, 4)
Tim Peters4190fb82003-02-02 16:09:05 +0000807 for proto in protocols:
Guido van Rossum44f0ea52003-01-28 04:14:51 +0000808 for x in a, b, c, d, e:
809 s = self.dumps(x, proto)
810 y = self.loads(s)
811 self.assertEqual(x, y, (proto, x, s, y))
Tim Peters1d63c9f2003-02-02 20:29:39 +0000812 expected = expected_opcode[proto, len(x)]
Tim Peters22e71712003-02-03 22:27:38 +0000813 self.assertEqual(opcode_in_pickle(expected, s), True)
Tim Peters1d63c9f2003-02-02 20:29:39 +0000814
Guido van Rossum7d97d312003-01-28 04:25:27 +0000815 def test_singletons(self):
Tim Peters61bf2572003-02-03 21:31:22 +0000816 # Map (proto, singleton) to expected opcode.
817 expected_opcode = {(0, None): pickle.NONE,
818 (1, None): pickle.NONE,
819 (2, None): pickle.NONE,
Guido van Rossumf4169812008-03-17 22:56:06 +0000820 (3, None): pickle.NONE,
Tim Peters61bf2572003-02-03 21:31:22 +0000821
822 (0, True): pickle.INT,
823 (1, True): pickle.INT,
824 (2, True): pickle.NEWTRUE,
Guido van Rossumf4169812008-03-17 22:56:06 +0000825 (3, True): pickle.NEWTRUE,
Tim Peters61bf2572003-02-03 21:31:22 +0000826
827 (0, False): pickle.INT,
828 (1, False): pickle.INT,
829 (2, False): pickle.NEWFALSE,
Guido van Rossumf4169812008-03-17 22:56:06 +0000830 (3, False): pickle.NEWFALSE,
Tim Peters61bf2572003-02-03 21:31:22 +0000831 }
Tim Peters4190fb82003-02-02 16:09:05 +0000832 for proto in protocols:
Guido van Rossum7d97d312003-01-28 04:25:27 +0000833 for x in None, False, True:
834 s = self.dumps(x, proto)
835 y = self.loads(s)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000836 self.assertTrue(x is y, (proto, x, s, y))
Tim Peters61bf2572003-02-03 21:31:22 +0000837 expected = expected_opcode[proto, x]
Tim Peters22e71712003-02-03 22:27:38 +0000838 self.assertEqual(opcode_in_pickle(expected, s), True)
Tim Peters3c67d792003-02-02 17:59:11 +0000839
Guido van Rossum533dbcf2003-01-28 17:55:05 +0000840 def test_newobj_tuple(self):
Guido van Rossum3d8c01b2003-01-28 19:48:18 +0000841 x = MyTuple([1, 2, 3])
842 x.foo = 42
843 x.bar = "hello"
Tim Peters894453a2003-02-03 22:32:18 +0000844 for proto in protocols:
845 s = self.dumps(x, proto)
846 y = self.loads(s)
847 self.assertEqual(tuple(x), tuple(y))
848 self.assertEqual(x.__dict__, y.__dict__)
Guido van Rossum533dbcf2003-01-28 17:55:05 +0000849
850 def test_newobj_list(self):
Guido van Rossum3d8c01b2003-01-28 19:48:18 +0000851 x = MyList([1, 2, 3])
852 x.foo = 42
853 x.bar = "hello"
Tim Peters894453a2003-02-03 22:32:18 +0000854 for proto in protocols:
855 s = self.dumps(x, proto)
856 y = self.loads(s)
857 self.assertEqual(list(x), list(y))
858 self.assertEqual(x.__dict__, y.__dict__)
Guido van Rossum533dbcf2003-01-28 17:55:05 +0000859
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000860 def test_newobj_generic(self):
Tim Peters5013bd92003-02-03 22:28:41 +0000861 for proto in protocols:
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000862 for C in myclasses:
863 B = C.__base__
864 x = C(C.sample)
865 x.foo = 42
866 s = self.dumps(x, proto)
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000867 y = self.loads(s)
868 detail = (proto, C, B, x, y, type(y))
869 self.assertEqual(B(x), B(y), detail)
870 self.assertEqual(x.__dict__, y.__dict__, detail)
871
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +0000872 # Register a type with copyreg, with extension code extcode. Pickle
Tim Peters22e71712003-02-03 22:27:38 +0000873 # an object of that type. Check that the resulting pickle uses opcode
874 # (EXT[124]) under proto 2, and not in proto 1.
Tim Peters3e667d52003-02-04 21:47:44 +0000875
Tim Peters22e71712003-02-03 22:27:38 +0000876 def produce_global_ext(self, extcode, opcode):
Tim Peters3e667d52003-02-04 21:47:44 +0000877 e = ExtensionSaver(extcode)
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000878 try:
Alexandre Vassalottif7fa63d2008-05-11 08:55:36 +0000879 copyreg.add_extension(__name__, "MyList", extcode)
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000880 x = MyList([1, 2, 3])
881 x.foo = 42
882 x.bar = "hello"
883
Tim Peters22e71712003-02-03 22:27:38 +0000884 # Dump using protocol 1 for comparison.
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000885 s1 = self.dumps(x, 1)
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000886 self.assertIn(__name__.encode("utf-8"), s1)
887 self.assertIn(b"MyList", s1)
Tim Peters3e667d52003-02-04 21:47:44 +0000888 self.assertEqual(opcode_in_pickle(opcode, s1), False)
889
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000890 y = self.loads(s1)
891 self.assertEqual(list(x), list(y))
892 self.assertEqual(x.__dict__, y.__dict__)
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000893
Tim Peters22e71712003-02-03 22:27:38 +0000894 # Dump using protocol 2 for test.
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000895 s2 = self.dumps(x, 2)
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000896 self.assertNotIn(__name__.encode("utf-8"), s2)
897 self.assertNotIn(b"MyList", s2)
Guido van Rossumcfe5f202007-05-08 21:26:54 +0000898 self.assertEqual(opcode_in_pickle(opcode, s2), True, repr(s2))
Tim Peters3e667d52003-02-04 21:47:44 +0000899
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000900 y = self.loads(s2)
901 self.assertEqual(list(x), list(y))
902 self.assertEqual(x.__dict__, y.__dict__)
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000903
904 finally:
Tim Peters3e667d52003-02-04 21:47:44 +0000905 e.restore()
Tim Peters22e71712003-02-03 22:27:38 +0000906
907 def test_global_ext1(self):
Tim Peters3e667d52003-02-04 21:47:44 +0000908 self.produce_global_ext(0x00000001, pickle.EXT1) # smallest EXT1 code
909 self.produce_global_ext(0x000000ff, pickle.EXT1) # largest EXT1 code
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000910
911 def test_global_ext2(self):
Tim Peters3e667d52003-02-04 21:47:44 +0000912 self.produce_global_ext(0x00000100, pickle.EXT2) # smallest EXT2 code
913 self.produce_global_ext(0x0000ffff, pickle.EXT2) # largest EXT2 code
914 self.produce_global_ext(0x0000abcd, pickle.EXT2) # check endianness
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000915
916 def test_global_ext4(self):
Tim Peters3e667d52003-02-04 21:47:44 +0000917 self.produce_global_ext(0x00010000, pickle.EXT4) # smallest EXT4 code
918 self.produce_global_ext(0x7fffffff, pickle.EXT4) # largest EXT4 code
919 self.produce_global_ext(0x12abcdef, pickle.EXT4) # check endianness
920
Tim Peters8d2613a2003-02-11 16:40:16 +0000921 def test_list_chunking(self):
922 n = 10 # too small to chunk
Guido van Rossum805365e2007-05-07 22:24:25 +0000923 x = list(range(n))
Tim Peters8d2613a2003-02-11 16:40:16 +0000924 for proto in protocols:
925 s = self.dumps(x, proto)
926 y = self.loads(s)
927 self.assertEqual(x, y)
928 num_appends = count_opcode(pickle.APPENDS, s)
929 self.assertEqual(num_appends, proto > 0)
930
931 n = 2500 # expect at least two chunks when proto > 0
Guido van Rossum805365e2007-05-07 22:24:25 +0000932 x = list(range(n))
Tim Peters8d2613a2003-02-11 16:40:16 +0000933 for proto in protocols:
934 s = self.dumps(x, proto)
935 y = self.loads(s)
936 self.assertEqual(x, y)
937 num_appends = count_opcode(pickle.APPENDS, s)
938 if proto == 0:
939 self.assertEqual(num_appends, 0)
940 else:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000941 self.assertTrue(num_appends >= 2)
Tim Peters8d2613a2003-02-11 16:40:16 +0000942
943 def test_dict_chunking(self):
944 n = 10 # too small to chunk
945 x = dict.fromkeys(range(n))
946 for proto in protocols:
947 s = self.dumps(x, proto)
Ezio Melottie9615932010-01-24 19:26:24 +0000948 self.assertIsInstance(s, bytes_types)
Tim Peters8d2613a2003-02-11 16:40:16 +0000949 y = self.loads(s)
950 self.assertEqual(x, y)
951 num_setitems = count_opcode(pickle.SETITEMS, s)
952 self.assertEqual(num_setitems, proto > 0)
953
954 n = 2500 # expect at least two chunks when proto > 0
955 x = dict.fromkeys(range(n))
956 for proto in protocols:
957 s = self.dumps(x, proto)
958 y = self.loads(s)
959 self.assertEqual(x, y)
960 num_setitems = count_opcode(pickle.SETITEMS, s)
961 if proto == 0:
962 self.assertEqual(num_setitems, 0)
963 else:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000964 self.assertTrue(num_setitems >= 2)
Guido van Rossum0322d0f2003-01-29 06:12:46 +0000965
Tim Peterse9ef2032003-02-13 18:42:00 +0000966 def test_simple_newobj(self):
967 x = object.__new__(SimpleNewObj) # avoid __init__
968 x.abc = 666
969 for proto in protocols:
970 s = self.dumps(x, proto)
971 self.assertEqual(opcode_in_pickle(pickle.NEWOBJ, s), proto >= 2)
972 y = self.loads(s) # will raise TypeError if __init__ called
973 self.assertEqual(y.abc, 666)
974 self.assertEqual(x.__dict__, y.__dict__)
975
Tim Peters42f08ac2003-02-11 22:43:24 +0000976 def test_newobj_list_slots(self):
977 x = SlotList([1, 2, 3])
978 x.foo = 42
979 x.bar = "hello"
980 s = self.dumps(x, 2)
981 y = self.loads(s)
982 self.assertEqual(list(x), list(y))
983 self.assertEqual(x.__dict__, y.__dict__)
984 self.assertEqual(x.foo, y.foo)
985 self.assertEqual(x.bar, y.bar)
986
Guido van Rossum2a30b212003-02-18 22:41:24 +0000987 def test_reduce_overrides_default_reduce_ex(self):
Collin Winter771d8342009-04-16 03:18:06 +0000988 for proto in protocols:
Guido van Rossum2a30b212003-02-18 22:41:24 +0000989 x = REX_one()
990 self.assertEqual(x._reduce_called, 0)
991 s = self.dumps(x, proto)
992 self.assertEqual(x._reduce_called, 1)
993 y = self.loads(s)
994 self.assertEqual(y._reduce_called, 0)
995
996 def test_reduce_ex_called(self):
Collin Winter771d8342009-04-16 03:18:06 +0000997 for proto in protocols:
Guido van Rossum2a30b212003-02-18 22:41:24 +0000998 x = REX_two()
999 self.assertEqual(x._proto, None)
1000 s = self.dumps(x, proto)
1001 self.assertEqual(x._proto, proto)
1002 y = self.loads(s)
1003 self.assertEqual(y._proto, None)
1004
1005 def test_reduce_ex_overrides_reduce(self):
Collin Winter771d8342009-04-16 03:18:06 +00001006 for proto in protocols:
Guido van Rossum2a30b212003-02-18 22:41:24 +00001007 x = REX_three()
1008 self.assertEqual(x._proto, None)
1009 s = self.dumps(x, proto)
1010 self.assertEqual(x._proto, proto)
1011 y = self.loads(s)
1012 self.assertEqual(y._proto, None)
1013
Guido van Rossumd8faa362007-04-27 19:54:29 +00001014 def test_reduce_ex_calls_base(self):
Collin Winter771d8342009-04-16 03:18:06 +00001015 for proto in protocols:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001016 x = REX_four()
1017 self.assertEqual(x._proto, None)
1018 s = self.dumps(x, proto)
1019 self.assertEqual(x._proto, proto)
1020 y = self.loads(s)
1021 self.assertEqual(y._proto, proto)
1022
1023 def test_reduce_calls_base(self):
Collin Winter771d8342009-04-16 03:18:06 +00001024 for proto in protocols:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001025 x = REX_five()
1026 self.assertEqual(x._reduce_called, 0)
1027 s = self.dumps(x, proto)
1028 self.assertEqual(x._reduce_called, 1)
1029 y = self.loads(s)
1030 self.assertEqual(y._reduce_called, 1)
1031
Alexandre Vassalotti1f9d9072008-08-15 03:07:47 +00001032 def test_bad_getattr(self):
1033 x = BadGetattr()
1034 for proto in 0, 1:
1035 self.assertRaises(RuntimeError, self.dumps, x, proto)
1036 # protocol 2 don't raise a RuntimeError.
1037 d = self.dumps(x, 2)
Antoine Pitrouff150f22010-10-22 21:41:05 +00001038 self.assertRaises(RuntimeError, self.loads, d)
Alexandre Vassalotti1f9d9072008-08-15 03:07:47 +00001039
Amaury Forgeot d'Arc424b4812008-10-30 22:25:31 +00001040 def test_reduce_bad_iterator(self):
1041 # Issue4176: crash when 4th and 5th items of __reduce__()
1042 # are not iterators
1043 class C(object):
1044 def __reduce__(self):
1045 # 4th item is not an iterator
1046 return list, (), None, [], None
1047 class D(object):
1048 def __reduce__(self):
1049 # 5th item is not an iterator
1050 return dict, (), None, None, []
1051
Amaury Forgeot d'Arc6285ffd2008-10-31 17:52:47 +00001052 # Protocol 0 is less strict and also accept iterables.
Amaury Forgeot d'Arc424b4812008-10-30 22:25:31 +00001053 for proto in protocols:
Amaury Forgeot d'Arc6285ffd2008-10-31 17:52:47 +00001054 try:
1055 self.dumps(C(), proto)
1056 except (pickle.PickleError):
1057 pass
1058 try:
1059 self.dumps(D(), proto)
1060 except (pickle.PickleError):
1061 pass
Amaury Forgeot d'Arc424b4812008-10-30 22:25:31 +00001062
Collin Winter771d8342009-04-16 03:18:06 +00001063 def test_many_puts_and_gets(self):
1064 # Test that internal data structures correctly deal with lots of
1065 # puts/gets.
1066 keys = ("aaa" + str(i) for i in range(100))
1067 large_dict = dict((k, [4, 5, 6]) for k in keys)
1068 obj = [dict(large_dict), dict(large_dict), dict(large_dict)]
1069
1070 for proto in protocols:
1071 dumped = self.dumps(obj, proto)
1072 loaded = self.loads(dumped)
1073 self.assertEqual(loaded, obj,
1074 "Failed protocol %d: %r != %r"
1075 % (proto, obj, loaded))
1076
Antoine Pitroua9f48a02009-05-02 21:41:14 +00001077 def test_attribute_name_interning(self):
1078 # Test that attribute names of pickled objects are interned when
1079 # unpickling.
1080 for proto in protocols:
1081 x = C()
1082 x.foo = 42
1083 x.bar = "hello"
1084 s = self.dumps(x, proto)
1085 y = self.loads(s)
1086 x_keys = sorted(x.__dict__)
1087 y_keys = sorted(y.__dict__)
1088 for x_key, y_key in zip(x_keys, y_keys):
1089 self.assertIs(x_key, y_key)
1090
Antoine Pitroud9dfaa92009-06-04 20:32:06 +00001091 def test_unpickle_from_2x(self):
1092 # Unpickle non-trivial data from Python 2.x.
1093 loaded = self.loads(DATA3)
1094 self.assertEqual(loaded, set([1, 2]))
1095 loaded = self.loads(DATA4)
1096 self.assertEqual(type(loaded), type(range(0)))
1097 self.assertEqual(list(loaded), list(range(5)))
1098 loaded = self.loads(DATA5)
1099 self.assertEqual(type(loaded), SimpleCookie)
1100 self.assertEqual(list(loaded.keys()), ["key"])
1101 self.assertEqual(loaded["key"].value, "Set-Cookie: key=value")
1102
1103 def test_pickle_to_2x(self):
1104 # Pickle non-trivial data with protocol 2, expecting that it yields
1105 # the same result as Python 2.x did.
1106 # NOTE: this test is a bit too strong since we can produce different
1107 # bytecode that 2.x will still understand.
1108 dumped = self.dumps(range(5), 2)
1109 self.assertEqual(dumped, DATA4)
1110 dumped = self.dumps(set([3]), 2)
1111 self.assertEqual(dumped, DATA6)
1112
Antoine Pitrouea99c5c2010-09-09 18:33:21 +00001113 def test_large_pickles(self):
1114 # Test the correctness of internal buffering routines when handling
1115 # large data.
1116 for proto in protocols:
Antoine Pitrou04248a82010-10-12 20:51:21 +00001117 data = (1, min, b'xy' * (30 * 1024), len)
Antoine Pitrouea99c5c2010-09-09 18:33:21 +00001118 dumped = self.dumps(data, proto)
1119 loaded = self.loads(dumped)
Antoine Pitrou04248a82010-10-12 20:51:21 +00001120 self.assertEqual(len(loaded), len(data))
Antoine Pitrouea99c5c2010-09-09 18:33:21 +00001121 self.assertEqual(loaded, data)
1122
Alexander Belopolskyec8f0df2011-02-24 20:34:38 +00001123 def test_empty_bytestring(self):
1124 # issue 11286
1125 empty = self.loads(b'\x80\x03U\x00q\x00.', encoding='koi8-r')
1126 self.assertEqual(empty, '')
Antoine Pitroud9dfaa92009-06-04 20:32:06 +00001127
Antoine Pitrou82be19f2011-08-29 23:09:33 +02001128 def check_negative_32b_binXXX(self, dumped):
1129 if sys.maxsize > 2**32:
1130 self.skipTest("test is only meaningful on 32-bit builds")
1131 # XXX Pure Python pickle reads lengths as signed and passes
1132 # them directly to read() (hence the EOFError)
1133 with self.assertRaises((pickle.UnpicklingError, EOFError,
1134 ValueError, OverflowError)):
1135 self.loads(dumped)
1136
1137 def test_negative_32b_binbytes(self):
1138 # On 32-bit builds, a BINBYTES of 2**31 or more is refused
1139 self.check_negative_32b_binXXX(b'\x80\x03B\xff\xff\xff\xffxyzq\x00.')
1140
1141 def test_negative_32b_binunicode(self):
1142 # On 32-bit builds, a BINUNICODE of 2**31 or more is refused
1143 self.check_negative_32b_binXXX(b'\x80\x03X\xff\xff\xff\xffxyzq\x00.')
1144
Antoine Pitrou55549ec2011-08-30 00:27:10 +02001145 def test_negative_put(self):
1146 # Issue #12847
1147 dumped = b'Va\np-1\n.'
1148 self.assertRaises(ValueError, self.loads, dumped)
1149
1150 def test_negative_32b_binput(self):
1151 # Issue #12847
1152 if sys.maxsize > 2**32:
1153 self.skipTest("test is only meaningful on 32-bit builds")
1154 dumped = b'\x80\x03X\x01\x00\x00\x00ar\xff\xff\xff\xff.'
1155 self.assertRaises(ValueError, self.loads, dumped)
1156
Antoine Pitrou82be19f2011-08-29 23:09:33 +02001157
1158class BigmemPickleTests(unittest.TestCase):
1159
1160 # Binary protocols can serialize longs of up to 2GB-1
1161
Antoine Pitrou94190bb2011-10-04 10:22:36 +02001162 @bigmemtest(size=_2G, memuse=1 + 1, dry_run=False)
Antoine Pitrou82be19f2011-08-29 23:09:33 +02001163 def test_huge_long_32b(self, size):
1164 data = 1 << (8 * size)
1165 try:
1166 for proto in protocols:
1167 if proto < 2:
1168 continue
1169 with self.assertRaises((ValueError, OverflowError)):
1170 self.dumps(data, protocol=proto)
1171 finally:
1172 data = None
1173
1174 # Protocol 3 can serialize up to 4GB-1 as a bytes object
1175 # (older protocols don't have a dedicated opcode for bytes and are
1176 # too inefficient)
1177
Antoine Pitrou94190bb2011-10-04 10:22:36 +02001178 @bigmemtest(size=_2G, memuse=1 + 1, dry_run=False)
Antoine Pitrou82be19f2011-08-29 23:09:33 +02001179 def test_huge_bytes_32b(self, size):
1180 data = b"abcd" * (size // 4)
1181 try:
1182 for proto in protocols:
1183 if proto < 3:
1184 continue
1185 try:
1186 pickled = self.dumps(data, protocol=proto)
1187 self.assertTrue(b"abcd" in pickled[:15])
1188 self.assertTrue(b"abcd" in pickled[-15:])
1189 finally:
1190 pickled = None
1191 finally:
1192 data = None
1193
Antoine Pitrou94190bb2011-10-04 10:22:36 +02001194 @bigmemtest(size=_4G, memuse=1 + 1, dry_run=False)
Antoine Pitrou82be19f2011-08-29 23:09:33 +02001195 def test_huge_bytes_64b(self, size):
1196 data = b"a" * size
1197 try:
1198 for proto in protocols:
1199 if proto < 3:
1200 continue
1201 with self.assertRaises((ValueError, OverflowError)):
1202 self.dumps(data, protocol=proto)
1203 finally:
1204 data = None
1205
1206 # All protocols use 1-byte per printable ASCII character; we add another
1207 # byte because the encoded form has to be copied into the internal buffer.
1208
Antoine Pitrou94190bb2011-10-04 10:22:36 +02001209 @bigmemtest(size=_2G, memuse=2 + character_size, dry_run=False)
Antoine Pitrou82be19f2011-08-29 23:09:33 +02001210 def test_huge_str_32b(self, size):
1211 data = "abcd" * (size // 4)
1212 try:
1213 for proto in protocols:
1214 try:
1215 pickled = self.dumps(data, protocol=proto)
1216 self.assertTrue(b"abcd" in pickled[:15])
1217 self.assertTrue(b"abcd" in pickled[-15:])
1218 finally:
1219 pickled = None
1220 finally:
1221 data = None
1222
Antoine Pitroue897e952011-08-30 23:39:34 +02001223 # BINUNICODE (protocols 1, 2 and 3) cannot carry more than
1224 # 2**32 - 1 bytes of utf-8 encoded unicode.
1225
Antoine Pitrou94190bb2011-10-04 10:22:36 +02001226 @bigmemtest(size=_4G, memuse=1 + character_size, dry_run=False)
Antoine Pitrou82be19f2011-08-29 23:09:33 +02001227 def test_huge_str_64b(self, size):
1228 data = "a" * size
1229 try:
1230 for proto in protocols:
Antoine Pitroue897e952011-08-30 23:39:34 +02001231 if proto == 0:
1232 continue
Antoine Pitrou82be19f2011-08-29 23:09:33 +02001233 with self.assertRaises((ValueError, OverflowError)):
1234 self.dumps(data, protocol=proto)
1235 finally:
1236 data = None
1237
1238
Guido van Rossum2a30b212003-02-18 22:41:24 +00001239# Test classes for reduce_ex
1240
1241class REX_one(object):
1242 _reduce_called = 0
1243 def __reduce__(self):
1244 self._reduce_called = 1
1245 return REX_one, ()
1246 # No __reduce_ex__ here, but inheriting it from object
1247
1248class REX_two(object):
1249 _proto = None
1250 def __reduce_ex__(self, proto):
1251 self._proto = proto
1252 return REX_two, ()
1253 # No __reduce__ here, but inheriting it from object
1254
1255class REX_three(object):
1256 _proto = None
1257 def __reduce_ex__(self, proto):
1258 self._proto = proto
1259 return REX_two, ()
1260 def __reduce__(self):
Collin Winter3add4d72007-08-29 23:37:32 +00001261 raise TestFailed("This __reduce__ shouldn't be called")
Guido van Rossum2a30b212003-02-18 22:41:24 +00001262
Guido van Rossumd8faa362007-04-27 19:54:29 +00001263class REX_four(object):
1264 _proto = None
1265 def __reduce_ex__(self, proto):
1266 self._proto = proto
1267 return object.__reduce_ex__(self, proto)
1268 # Calling base class method should succeed
1269
1270class REX_five(object):
1271 _reduce_called = 0
1272 def __reduce__(self):
1273 self._reduce_called = 1
1274 return object.__reduce__(self)
1275 # This one used to fail with infinite recursion
1276
Guido van Rossum2a30b212003-02-18 22:41:24 +00001277# Test classes for newobj
Tim Peters080c88b2003-02-15 03:01:11 +00001278
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001279class MyInt(int):
1280 sample = 1
1281
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001282class MyFloat(float):
1283 sample = 1.0
1284
1285class MyComplex(complex):
1286 sample = 1.0 + 0.0j
1287
1288class MyStr(str):
1289 sample = "hello"
1290
Guido van Rossumef87d6e2007-05-02 19:09:54 +00001291class MyUnicode(str):
1292 sample = "hello \u1234"
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001293
Guido van Rossum533dbcf2003-01-28 17:55:05 +00001294class MyTuple(tuple):
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001295 sample = (1, 2, 3)
Guido van Rossum533dbcf2003-01-28 17:55:05 +00001296
1297class MyList(list):
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001298 sample = [1, 2, 3]
1299
1300class MyDict(dict):
1301 sample = {"a": 1, "b": 2}
1302
Mark Dickinson5c2db372009-12-05 20:28:34 +00001303myclasses = [MyInt, MyFloat,
Guido van Rossum206b9a72003-03-02 13:53:18 +00001304 MyComplex,
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001305 MyStr, MyUnicode,
1306 MyTuple, MyList, MyDict]
1307
Guido van Rossum533dbcf2003-01-28 17:55:05 +00001308
Guido van Rossumc8d6ef52003-01-28 22:02:31 +00001309class SlotList(MyList):
1310 __slots__ = ["foo"]
1311
Tim Peterse9ef2032003-02-13 18:42:00 +00001312class SimpleNewObj(object):
1313 def __init__(self, a, b, c):
1314 # raise an error, to make sure this isn't called
1315 raise TypeError("SimpleNewObj.__init__() didn't expect to get called")
1316
Alexandre Vassalotti1f9d9072008-08-15 03:07:47 +00001317class BadGetattr:
1318 def __getattr__(self, key):
1319 self.foo
1320
Collin Winter771d8342009-04-16 03:18:06 +00001321
Jeremy Hylton66426532001-10-15 21:38:56 +00001322class AbstractPickleModuleTests(unittest.TestCase):
1323
1324 def test_dump_closed_file(self):
Guido van Rossum3b0a3292002-08-09 16:38:32 +00001325 import os
Walter Dörwald11b41f62007-06-20 12:46:31 +00001326 f = open(TESTFN, "wb")
Guido van Rossum3b0a3292002-08-09 16:38:32 +00001327 try:
1328 f.close()
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001329 self.assertRaises(ValueError, pickle.dump, 123, f)
Guido van Rossum3b0a3292002-08-09 16:38:32 +00001330 finally:
1331 os.remove(TESTFN)
Jeremy Hylton66426532001-10-15 21:38:56 +00001332
1333 def test_load_closed_file(self):
Guido van Rossum3b0a3292002-08-09 16:38:32 +00001334 import os
Walter Dörwald11b41f62007-06-20 12:46:31 +00001335 f = open(TESTFN, "wb")
Guido van Rossum3b0a3292002-08-09 16:38:32 +00001336 try:
1337 f.close()
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001338 self.assertRaises(ValueError, pickle.dump, 123, f)
Guido van Rossum3b0a3292002-08-09 16:38:32 +00001339 finally:
1340 os.remove(TESTFN)
Jeremy Hylton4c8be852002-11-13 22:10:47 +00001341
Collin Winter771d8342009-04-16 03:18:06 +00001342 def test_load_from_and_dump_to_file(self):
1343 stream = io.BytesIO()
1344 data = [123, {}, 124]
1345 pickle.dump(data, stream)
1346 stream.seek(0)
1347 unpickled = pickle.load(stream)
1348 self.assertEqual(unpickled, data)
1349
Tim Petersc0c93702003-02-13 19:30:57 +00001350 def test_highest_protocol(self):
1351 # Of course this needs to be changed when HIGHEST_PROTOCOL changes.
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001352 self.assertEqual(pickle.HIGHEST_PROTOCOL, 3)
Tim Petersc0c93702003-02-13 19:30:57 +00001353
Martin v. Löwis544f1192004-07-27 05:22:33 +00001354 def test_callapi(self):
Collin Winter771d8342009-04-16 03:18:06 +00001355 f = io.BytesIO()
Martin v. Löwis544f1192004-07-27 05:22:33 +00001356 # With and without keyword arguments
Alexandre Vassalottica2d6102008-06-12 18:26:05 +00001357 pickle.dump(123, f, -1)
1358 pickle.dump(123, file=f, protocol=-1)
1359 pickle.dumps(123, -1)
1360 pickle.dumps(123, protocol=-1)
1361 pickle.Pickler(f, -1)
1362 pickle.Pickler(f, protocol=-1)
Tim Petersc0c93702003-02-13 19:30:57 +00001363
Amaury Forgeot d'Arc87eee632008-10-17 20:15:53 +00001364 def test_bad_init(self):
1365 # Test issue3664 (pickle can segfault from a badly initialized Pickler).
Amaury Forgeot d'Arc87eee632008-10-17 20:15:53 +00001366 # Override initialization without calling __init__() of the superclass.
1367 class BadPickler(pickle.Pickler):
1368 def __init__(self): pass
1369
1370 class BadUnpickler(pickle.Unpickler):
1371 def __init__(self): pass
1372
1373 self.assertRaises(pickle.PicklingError, BadPickler().dump, 0)
1374 self.assertRaises(pickle.UnpicklingError, BadUnpickler().load)
1375
Amaury Forgeot d'Arc3e4e72f2008-11-11 20:05:06 +00001376 def test_bad_input(self):
1377 # Test issue4298
1378 s = bytes([0x58, 0, 0, 0, 0x54])
1379 self.assertRaises(EOFError, pickle.loads, s)
Antoine Pitrou01a15ea2010-01-07 17:57:31 +00001380 # Test issue7455
1381 s = b'0'
1382 self.assertRaises(pickle.UnpicklingError, pickle.loads, s)
Amaury Forgeot d'Arc3e4e72f2008-11-11 20:05:06 +00001383
Amaury Forgeot d'Arc87eee632008-10-17 20:15:53 +00001384
Jeremy Hylton4c8be852002-11-13 22:10:47 +00001385class AbstractPersistentPicklerTests(unittest.TestCase):
1386
1387 # This class defines persistent_id() and persistent_load()
1388 # functions that should be used by the pickler. All even integers
1389 # are pickled using persistent ids.
1390
1391 def persistent_id(self, object):
1392 if isinstance(object, int) and object % 2 == 0:
1393 self.id_count += 1
1394 return str(object)
1395 else:
1396 return None
1397
1398 def persistent_load(self, oid):
1399 self.load_count += 1
1400 object = int(oid)
1401 assert object % 2 == 0
1402 return object
1403
1404 def test_persistence(self):
1405 self.id_count = 0
1406 self.load_count = 0
Guido van Rossum805365e2007-05-07 22:24:25 +00001407 L = list(range(10))
Jeremy Hylton4c8be852002-11-13 22:10:47 +00001408 self.assertEqual(self.loads(self.dumps(L)), L)
1409 self.assertEqual(self.id_count, 5)
1410 self.assertEqual(self.load_count, 5)
1411
1412 def test_bin_persistence(self):
1413 self.id_count = 0
1414 self.load_count = 0
Guido van Rossum805365e2007-05-07 22:24:25 +00001415 L = list(range(10))
Jeremy Hylton4c8be852002-11-13 22:10:47 +00001416 self.assertEqual(self.loads(self.dumps(L, 1)), L)
1417 self.assertEqual(self.id_count, 5)
1418 self.assertEqual(self.load_count, 5)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001419
Collin Winter771d8342009-04-16 03:18:06 +00001420
1421class AbstractPicklerUnpicklerObjectTests(unittest.TestCase):
1422
1423 pickler_class = None
1424 unpickler_class = None
1425
1426 def setUp(self):
1427 assert self.pickler_class
1428 assert self.unpickler_class
1429
1430 def test_clear_pickler_memo(self):
1431 # To test whether clear_memo() has any effect, we pickle an object,
1432 # then pickle it again without clearing the memo; the two serialized
1433 # forms should be different. If we clear_memo() and then pickle the
1434 # object again, the third serialized form should be identical to the
1435 # first one we obtained.
1436 data = ["abcdefg", "abcdefg", 44]
1437 f = io.BytesIO()
1438 pickler = self.pickler_class(f)
1439
1440 pickler.dump(data)
1441 first_pickled = f.getvalue()
1442
1443 # Reset StringIO object.
1444 f.seek(0)
1445 f.truncate()
1446
1447 pickler.dump(data)
1448 second_pickled = f.getvalue()
1449
1450 # Reset the Pickler and StringIO objects.
1451 pickler.clear_memo()
1452 f.seek(0)
1453 f.truncate()
1454
1455 pickler.dump(data)
1456 third_pickled = f.getvalue()
1457
1458 self.assertNotEqual(first_pickled, second_pickled)
1459 self.assertEqual(first_pickled, third_pickled)
1460
1461 def test_priming_pickler_memo(self):
1462 # Verify that we can set the Pickler's memo attribute.
1463 data = ["abcdefg", "abcdefg", 44]
1464 f = io.BytesIO()
1465 pickler = self.pickler_class(f)
1466
1467 pickler.dump(data)
1468 first_pickled = f.getvalue()
1469
1470 f = io.BytesIO()
1471 primed = self.pickler_class(f)
1472 primed.memo = pickler.memo
1473
1474 primed.dump(data)
1475 primed_pickled = f.getvalue()
1476
1477 self.assertNotEqual(first_pickled, primed_pickled)
1478
1479 def test_priming_unpickler_memo(self):
1480 # Verify that we can set the Unpickler's memo attribute.
1481 data = ["abcdefg", "abcdefg", 44]
1482 f = io.BytesIO()
1483 pickler = self.pickler_class(f)
1484
1485 pickler.dump(data)
1486 first_pickled = f.getvalue()
1487
1488 f = io.BytesIO()
1489 primed = self.pickler_class(f)
1490 primed.memo = pickler.memo
1491
1492 primed.dump(data)
1493 primed_pickled = f.getvalue()
1494
1495 unpickler = self.unpickler_class(io.BytesIO(first_pickled))
1496 unpickled_data1 = unpickler.load()
1497
1498 self.assertEqual(unpickled_data1, data)
1499
1500 primed = self.unpickler_class(io.BytesIO(primed_pickled))
1501 primed.memo = unpickler.memo
1502 unpickled_data2 = primed.load()
1503
1504 primed.memo.clear()
1505
1506 self.assertEqual(unpickled_data2, data)
1507 self.assertTrue(unpickled_data2 is unpickled_data1)
1508
1509 def test_reusing_unpickler_objects(self):
1510 data1 = ["abcdefg", "abcdefg", 44]
1511 f = io.BytesIO()
1512 pickler = self.pickler_class(f)
1513 pickler.dump(data1)
1514 pickled1 = f.getvalue()
1515
1516 data2 = ["abcdefg", 44, 44]
1517 f = io.BytesIO()
1518 pickler = self.pickler_class(f)
1519 pickler.dump(data2)
1520 pickled2 = f.getvalue()
1521
1522 f = io.BytesIO()
1523 f.write(pickled1)
1524 f.seek(0)
1525 unpickler = self.unpickler_class(f)
1526 self.assertEqual(unpickler.load(), data1)
1527
1528 f.seek(0)
1529 f.truncate()
1530 f.write(pickled2)
1531 f.seek(0)
1532 self.assertEqual(unpickler.load(), data2)
1533
Antoine Pitrou04248a82010-10-12 20:51:21 +00001534 def _check_multiple_unpicklings(self, ioclass):
1535 for proto in protocols:
1536 data1 = [(x, str(x)) for x in range(2000)] + [b"abcde", len]
1537 f = ioclass()
1538 pickler = self.pickler_class(f, protocol=proto)
1539 pickler.dump(data1)
1540 pickled = f.getvalue()
1541
1542 N = 5
1543 f = ioclass(pickled * N)
1544 unpickler = self.unpickler_class(f)
1545 for i in range(N):
1546 if f.seekable():
1547 pos = f.tell()
1548 self.assertEqual(unpickler.load(), data1)
1549 if f.seekable():
1550 self.assertEqual(f.tell(), pos + len(pickled))
1551 self.assertRaises(EOFError, unpickler.load)
1552
1553 def test_multiple_unpicklings_seekable(self):
1554 self._check_multiple_unpicklings(io.BytesIO)
1555
1556 def test_multiple_unpicklings_unseekable(self):
1557 self._check_multiple_unpicklings(UnseekableIO)
1558
Antoine Pitrouf6c7a852011-08-11 21:04:02 +02001559 def test_unpickling_buffering_readline(self):
1560 # Issue #12687: the unpickler's buffering logic could fail with
1561 # text mode opcodes.
1562 data = list(range(10))
1563 for proto in protocols:
1564 for buf_size in range(1, 11):
1565 f = io.BufferedRandom(io.BytesIO(), buffer_size=buf_size)
1566 pickler = self.pickler_class(f, protocol=proto)
1567 pickler.dump(data)
1568 f.seek(0)
1569 unpickler = self.unpickler_class(f)
1570 self.assertEqual(unpickler.load(), data)
1571
Collin Winter771d8342009-04-16 03:18:06 +00001572
Guido van Rossum98297ee2007-11-06 21:34:58 +00001573if __name__ == "__main__":
1574 # Print some stuff that can be used to rewrite DATA{0,1,2}
1575 from pickletools import dis
1576 x = create_data()
1577 for i in range(3):
1578 p = pickle.dumps(x, i)
1579 print("DATA{0} = (".format(i))
1580 for j in range(0, len(p), 20):
1581 b = bytes(p[j:j+20])
1582 print(" {0!r}".format(b))
1583 print(")")
1584 print()
1585 print("# Disassembly of DATA{0}".format(i))
1586 print("DATA{0}_DIS = \"\"\"\\".format(i))
1587 dis(p)
1588 print("\"\"\"")
1589 print()