blob: 4871d60d756c0345e4e00f01a5f6b06e6f18cc71 [file] [log] [blame]
Guido van Rossum7d9ea502003-02-03 20:45:52 +00001import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002from test import support
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00003import binascii
Zackery Spytzd2cbfff2018-06-27 12:04:51 -06004import copy
Serhiy Storchakad7a44152015-11-12 11:23:04 +02005import pickle
Andrew M. Kuchling9a0f98e2001-02-21 02:17:01 +00006import random
Antoine Pitrouf3d22752011-02-21 18:09:00 +00007import sys
Antoine Pitrou94190bb2011-10-04 10:22:36 +02008from test.support import bigmemtest, _1G, _4G
Andrew M. Kuchling9a0f98e2001-02-21 02:17:01 +00009
R. David Murraya21e4ca2009-03-31 23:16:50 +000010zlib = support.import_module('zlib')
11
Serhiy Storchaka43767632013-11-03 21:31:38 +020012requires_Compress_copy = unittest.skipUnless(
13 hasattr(zlib.compressobj(), "copy"),
14 'requires Compress.copy()')
15requires_Decompress_copy = unittest.skipUnless(
16 hasattr(zlib.decompressobj(), "copy"),
17 'requires Decompress.copy()')
18
Andrew M. Kuchling9a0f98e2001-02-21 02:17:01 +000019
Nadeem Vawda64d25dd2011-09-12 00:04:13 +020020class VersionTestCase(unittest.TestCase):
21
22 def test_library_version(self):
Nadeem Vawda131c7072012-01-25 23:16:50 +020023 # Test that the major version of the actual library in use matches the
24 # major version that we were compiled against. We can't guarantee that
25 # the minor versions will match (even on the machine on which the module
26 # was compiled), and the API is stable between minor versions, so
Nadeem Vawdad770fe42012-01-28 17:32:47 +020027 # testing only the major versions avoids spurious failures.
Nadeem Vawda131c7072012-01-25 23:16:50 +020028 self.assertEqual(zlib.ZLIB_RUNTIME_VERSION[0], zlib.ZLIB_VERSION[0])
Nadeem Vawda64d25dd2011-09-12 00:04:13 +020029
30
Guido van Rossum7d9ea502003-02-03 20:45:52 +000031class ChecksumTestCase(unittest.TestCase):
32 # checksum test cases
33 def test_crc32start(self):
Guido van Rossum776152b2007-05-22 22:44:07 +000034 self.assertEqual(zlib.crc32(b""), zlib.crc32(b"", 0))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000035 self.assertTrue(zlib.crc32(b"abc", 0xffffffff))
Andrew M. Kuchlingfcfc8d52001-08-10 15:50:11 +000036
Guido van Rossum7d9ea502003-02-03 20:45:52 +000037 def test_crc32empty(self):
Guido van Rossum776152b2007-05-22 22:44:07 +000038 self.assertEqual(zlib.crc32(b"", 0), 0)
39 self.assertEqual(zlib.crc32(b"", 1), 1)
40 self.assertEqual(zlib.crc32(b"", 432), 432)
Andrew M. Kuchling9a0f98e2001-02-21 02:17:01 +000041
Guido van Rossum7d9ea502003-02-03 20:45:52 +000042 def test_adler32start(self):
Guido van Rossum776152b2007-05-22 22:44:07 +000043 self.assertEqual(zlib.adler32(b""), zlib.adler32(b"", 1))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000044 self.assertTrue(zlib.adler32(b"abc", 0xffffffff))
Jeremy Hylton6eb4b6a1997-08-15 15:59:43 +000045
Guido van Rossum7d9ea502003-02-03 20:45:52 +000046 def test_adler32empty(self):
Guido van Rossum776152b2007-05-22 22:44:07 +000047 self.assertEqual(zlib.adler32(b"", 0), 0)
48 self.assertEqual(zlib.adler32(b"", 1), 1)
49 self.assertEqual(zlib.adler32(b"", 432), 432)
Jeremy Hylton6eb4b6a1997-08-15 15:59:43 +000050
Guido van Rossum7d9ea502003-02-03 20:45:52 +000051 def test_penguins(self):
Martin Panterb82032f2015-12-11 05:19:29 +000052 self.assertEqual(zlib.crc32(b"penguin", 0), 0x0e5c1a120)
53 self.assertEqual(zlib.crc32(b"penguin", 1), 0x43b6aa94)
54 self.assertEqual(zlib.adler32(b"penguin", 0), 0x0bcf02f6)
55 self.assertEqual(zlib.adler32(b"penguin", 1), 0x0bd602f7)
Guido van Rossum7d9ea502003-02-03 20:45:52 +000056
Guido van Rossum776152b2007-05-22 22:44:07 +000057 self.assertEqual(zlib.crc32(b"penguin"), zlib.crc32(b"penguin", 0))
58 self.assertEqual(zlib.adler32(b"penguin"),zlib.adler32(b"penguin",1))
Guido van Rossum7d9ea502003-02-03 20:45:52 +000059
Gregory P. Smithab0d8a12008-03-17 20:24:09 +000060 def test_crc32_adler32_unsigned(self):
Antoine Pitrou77b338b2009-12-14 18:00:06 +000061 foo = b'abcdefghijklmnop'
Gregory P. Smithab0d8a12008-03-17 20:24:09 +000062 # explicitly test signed behavior
Gregory P. Smith27275032008-03-20 06:20:09 +000063 self.assertEqual(zlib.crc32(foo), 2486878355)
Antoine Pitrou77b338b2009-12-14 18:00:06 +000064 self.assertEqual(zlib.crc32(b'spam'), 1138425661)
Gregory P. Smithab0d8a12008-03-17 20:24:09 +000065 self.assertEqual(zlib.adler32(foo+foo), 3573550353)
Antoine Pitrou77b338b2009-12-14 18:00:06 +000066 self.assertEqual(zlib.adler32(b'spam'), 72286642)
Gregory P. Smithab0d8a12008-03-17 20:24:09 +000067
Christian Heimesd5e2b6f2008-03-19 21:50:51 +000068 def test_same_as_binascii_crc32(self):
Martin v. Löwis15b16a32008-12-02 06:00:15 +000069 foo = b'abcdefghijklmnop'
Gregory P. Smith27275032008-03-20 06:20:09 +000070 crc = 2486878355
Christian Heimesd5e2b6f2008-03-19 21:50:51 +000071 self.assertEqual(binascii.crc32(foo), crc)
72 self.assertEqual(zlib.crc32(foo), crc)
Martin v. Löwis15b16a32008-12-02 06:00:15 +000073 self.assertEqual(binascii.crc32(b'spam'), zlib.crc32(b'spam'))
Guido van Rossum7d9ea502003-02-03 20:45:52 +000074
75
Victor Stinner8c663fd2017-11-08 14:44:44 -080076# Issue #10276 - check that inputs >=4 GiB are handled correctly.
Antoine Pitrouf3d22752011-02-21 18:09:00 +000077class ChecksumBigBufferTestCase(unittest.TestCase):
78
Nadeem Vawdabc8c8172012-02-23 14:16:15 +020079 @bigmemtest(size=_4G + 4, memuse=1, dry_run=False)
80 def test_big_buffer(self, size):
Nadeem Vawdab063a482012-02-23 13:36:25 +020081 data = b"nyan" * (_1G + 1)
82 self.assertEqual(zlib.crc32(data), 1044521549)
83 self.assertEqual(zlib.adler32(data), 2256789997)
Antoine Pitrouf3d22752011-02-21 18:09:00 +000084
Christian Heimesb186d002008-03-18 15:15:01 +000085
Guido van Rossum7d9ea502003-02-03 20:45:52 +000086class ExceptionTestCase(unittest.TestCase):
87 # make sure we generate some expected errors
Guido van Rossum8ce8a782007-11-01 19:42:39 +000088 def test_badlevel(self):
89 # specifying compression level out of range causes an error
90 # (but -1 is Z_DEFAULT_COMPRESSION and apparently the zlib
91 # accepts 0 too)
Antoine Pitrou77b338b2009-12-14 18:00:06 +000092 self.assertRaises(zlib.error, zlib.compress, b'ERROR', 10)
93
94 def test_badargs(self):
95 self.assertRaises(TypeError, zlib.adler32)
96 self.assertRaises(TypeError, zlib.crc32)
97 self.assertRaises(TypeError, zlib.compress)
98 self.assertRaises(TypeError, zlib.decompress)
99 for arg in (42, None, '', 'abc', (), []):
100 self.assertRaises(TypeError, zlib.adler32, arg)
101 self.assertRaises(TypeError, zlib.crc32, arg)
102 self.assertRaises(TypeError, zlib.compress, arg)
103 self.assertRaises(TypeError, zlib.decompress, arg)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000104
105 def test_badcompressobj(self):
106 # verify failure on building compress object with bad params
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000107 self.assertRaises(ValueError, zlib.compressobj, 1, zlib.DEFLATED, 0)
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000108 # specifying total bits too large causes an error
109 self.assertRaises(ValueError,
110 zlib.compressobj, 1, zlib.DEFLATED, zlib.MAX_WBITS + 1)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000111
112 def test_baddecompressobj(self):
113 # verify failure on building decompress object with bad params
Antoine Pitrou90ee4df2010-04-06 17:23:13 +0000114 self.assertRaises(ValueError, zlib.decompressobj, -1)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000115
Christian Heimes5e696852008-04-09 08:37:03 +0000116 def test_decompressobj_badflush(self):
117 # verify failure on calling decompressobj.flush with bad params
118 self.assertRaises(ValueError, zlib.decompressobj().flush, 0)
119 self.assertRaises(ValueError, zlib.decompressobj().flush, -1)
120
Martin Pantere99e9772015-11-20 08:13:35 +0000121 @support.cpython_only
122 def test_overflow(self):
123 with self.assertRaisesRegex(OverflowError, 'int too large'):
124 zlib.decompress(b'', 15, sys.maxsize + 1)
125 with self.assertRaisesRegex(OverflowError, 'int too large'):
Martin Panter84544c12016-07-23 03:02:07 +0000126 zlib.decompressobj().decompress(b'', sys.maxsize + 1)
127 with self.assertRaisesRegex(OverflowError, 'int too large'):
Martin Pantere99e9772015-11-20 08:13:35 +0000128 zlib.decompressobj().flush(sys.maxsize + 1)
129
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000130
Antoine Pitrou89562712010-05-07 17:04:02 +0000131class BaseCompressTestCase(object):
132 def check_big_compress_buffer(self, size, compress_func):
133 _1M = 1024 * 1024
Victor Stinner8c663fd2017-11-08 14:44:44 -0800134 # Generate 10 MiB worth of random, and expand it by repeating it.
Antoine Pitrou89562712010-05-07 17:04:02 +0000135 # The assumption is that zlib's memory is not big enough to exploit
136 # such spread out redundancy.
137 data = b''.join([random.getrandbits(8 * _1M).to_bytes(_1M, 'little')
138 for i in range(10)])
139 data = data * (size // len(data) + 1)
140 try:
141 compress_func(data)
142 finally:
143 # Release memory
144 data = None
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000145
Antoine Pitrou89562712010-05-07 17:04:02 +0000146 def check_big_decompress_buffer(self, size, decompress_func):
147 data = b'x' * size
148 try:
149 compressed = zlib.compress(data, 1)
150 finally:
151 # Release memory
152 data = None
153 data = decompress_func(compressed)
154 # Sanity check
155 try:
156 self.assertEqual(len(data), size)
157 self.assertEqual(len(data.strip(b'x')), 0)
158 finally:
159 data = None
160
161
162class CompressTestCase(BaseCompressTestCase, unittest.TestCase):
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000163 # Test compression in one go (whole message compression)
164 def test_speech(self):
Neil Schemenauer6412b122004-06-05 19:34:28 +0000165 x = zlib.compress(HAMLET_SCENE)
166 self.assertEqual(zlib.decompress(x), HAMLET_SCENE)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000167
Martin Panter1fe0d132016-02-10 10:06:36 +0000168 def test_keywords(self):
Serhiy Storchaka95657cd2016-06-25 22:43:05 +0300169 x = zlib.compress(HAMLET_SCENE, level=3)
Martin Panter1fe0d132016-02-10 10:06:36 +0000170 self.assertEqual(zlib.decompress(x), HAMLET_SCENE)
Serhiy Storchaka95657cd2016-06-25 22:43:05 +0300171 with self.assertRaises(TypeError):
172 zlib.compress(data=HAMLET_SCENE, level=3)
Serhiy Storchaka15f32282016-08-15 10:06:16 +0300173 self.assertEqual(zlib.decompress(x,
174 wbits=zlib.MAX_WBITS,
175 bufsize=zlib.DEF_BUF_SIZE),
176 HAMLET_SCENE)
Martin Panter1fe0d132016-02-10 10:06:36 +0000177
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000178 def test_speech128(self):
Neil Schemenauer6412b122004-06-05 19:34:28 +0000179 # compress more data
180 data = HAMLET_SCENE * 128
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000181 x = zlib.compress(data)
Antoine Pitrou77b338b2009-12-14 18:00:06 +0000182 self.assertEqual(zlib.compress(bytearray(data)), x)
183 for ob in x, bytearray(x):
184 self.assertEqual(zlib.decompress(ob), data)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000185
Antoine Pitrou53b21662010-05-11 23:46:02 +0000186 def test_incomplete_stream(self):
Martin Panter6245cb32016-04-15 02:14:19 +0000187 # A useful error message is given
Antoine Pitrou53b21662010-05-11 23:46:02 +0000188 x = zlib.compress(HAMLET_SCENE)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000189 self.assertRaisesRegex(zlib.error,
Antoine Pitrou53b21662010-05-11 23:46:02 +0000190 "Error -5 while decompressing data: incomplete or truncated stream",
191 zlib.decompress, x[:-1])
192
Antoine Pitrou89562712010-05-07 17:04:02 +0000193 # Memory use of the following functions takes into account overallocation
194
Antoine Pitrou94190bb2011-10-04 10:22:36 +0200195 @bigmemtest(size=_1G + 1024 * 1024, memuse=3)
Antoine Pitrou89562712010-05-07 17:04:02 +0000196 def test_big_compress_buffer(self, size):
197 compress = lambda s: zlib.compress(s, 1)
198 self.check_big_compress_buffer(size, compress)
199
Antoine Pitrou94190bb2011-10-04 10:22:36 +0200200 @bigmemtest(size=_1G + 1024 * 1024, memuse=2)
Antoine Pitrou89562712010-05-07 17:04:02 +0000201 def test_big_decompress_buffer(self, size):
202 self.check_big_decompress_buffer(size, zlib.decompress)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000203
Martin Pantere99e9772015-11-20 08:13:35 +0000204 @bigmemtest(size=_4G, memuse=1)
205 def test_large_bufsize(self, size):
206 # Test decompress(bufsize) parameter greater than the internal limit
207 data = HAMLET_SCENE * 10
208 compressed = zlib.compress(data, 1)
209 self.assertEqual(zlib.decompress(compressed, 15, size), data)
210
211 def test_custom_bufsize(self):
212 data = HAMLET_SCENE * 10
213 compressed = zlib.compress(data, 1)
214 self.assertEqual(zlib.decompress(compressed, 15, CustomInt()), data)
215
Martin Panter84544c12016-07-23 03:02:07 +0000216 @unittest.skipUnless(sys.maxsize > 2**32, 'requires 64bit platform')
217 @bigmemtest(size=_4G + 100, memuse=4)
218 def test_64bit_compress(self, size):
219 data = b'x' * size
220 try:
221 comp = zlib.compress(data, 0)
222 self.assertEqual(zlib.decompress(comp), data)
223 finally:
224 comp = data = None
225
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000226
Antoine Pitrou89562712010-05-07 17:04:02 +0000227class CompressObjectTestCase(BaseCompressTestCase, unittest.TestCase):
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000228 # Test compression object
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000229 def test_pair(self):
Neil Schemenauer6412b122004-06-05 19:34:28 +0000230 # straightforward compress/decompress objects
Antoine Pitrou77b338b2009-12-14 18:00:06 +0000231 datasrc = HAMLET_SCENE * 128
232 datazip = zlib.compress(datasrc)
233 # should compress both bytes and bytearray data
234 for data in (datasrc, bytearray(datasrc)):
235 co = zlib.compressobj()
236 x1 = co.compress(data)
237 x2 = co.flush()
238 self.assertRaises(zlib.error, co.flush) # second flush should not work
239 self.assertEqual(x1 + x2, datazip)
240 for v1, v2 in ((x1, x2), (bytearray(x1), bytearray(x2))):
241 dco = zlib.decompressobj()
242 y1 = dco.decompress(v1 + v2)
243 y2 = dco.flush()
244 self.assertEqual(data, y1 + y2)
245 self.assertIsInstance(dco.unconsumed_tail, bytes)
246 self.assertIsInstance(dco.unused_data, bytes)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000247
Serhiy Storchaka15f32282016-08-15 10:06:16 +0300248 def test_keywords(self):
249 level = 2
250 method = zlib.DEFLATED
251 wbits = -12
252 memLevel = 9
253 strategy = zlib.Z_FILTERED
254 co = zlib.compressobj(level=level,
255 method=method,
256 wbits=wbits,
257 memLevel=memLevel,
258 strategy=strategy,
259 zdict=b"")
260 do = zlib.decompressobj(wbits=wbits, zdict=b"")
261 with self.assertRaises(TypeError):
262 co.compress(data=HAMLET_SCENE)
263 with self.assertRaises(TypeError):
264 do.decompress(data=zlib.compress(HAMLET_SCENE))
265 x = co.compress(HAMLET_SCENE) + co.flush()
266 y = do.decompress(x, max_length=len(HAMLET_SCENE)) + do.flush()
267 self.assertEqual(HAMLET_SCENE, y)
268
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000269 def test_compressoptions(self):
270 # specify lots of options to compressobj()
271 level = 2
272 method = zlib.DEFLATED
273 wbits = -12
Martin Panterbf19d162015-09-09 01:01:13 +0000274 memLevel = 9
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000275 strategy = zlib.Z_FILTERED
Martin Panterbf19d162015-09-09 01:01:13 +0000276 co = zlib.compressobj(level, method, wbits, memLevel, strategy)
Neil Schemenauer6412b122004-06-05 19:34:28 +0000277 x1 = co.compress(HAMLET_SCENE)
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000278 x2 = co.flush()
279 dco = zlib.decompressobj(wbits)
280 y1 = dco.decompress(x1 + x2)
281 y2 = dco.flush()
Neil Schemenauer6412b122004-06-05 19:34:28 +0000282 self.assertEqual(HAMLET_SCENE, y1 + y2)
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000283
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000284 def test_compressincremental(self):
285 # compress object in steps, decompress object as one-shot
Neil Schemenauer6412b122004-06-05 19:34:28 +0000286 data = HAMLET_SCENE * 128
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000287 co = zlib.compressobj()
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000288 bufs = []
289 for i in range(0, len(data), 256):
290 bufs.append(co.compress(data[i:i+256]))
291 bufs.append(co.flush())
Guido van Rossum776152b2007-05-22 22:44:07 +0000292 combuf = b''.join(bufs)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000293
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000294 dco = zlib.decompressobj()
Guido van Rossum776152b2007-05-22 22:44:07 +0000295 y1 = dco.decompress(b''.join(bufs))
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000296 y2 = dco.flush()
297 self.assertEqual(data, y1 + y2)
298
Neil Schemenauer6412b122004-06-05 19:34:28 +0000299 def test_decompinc(self, flush=False, source=None, cx=256, dcx=64):
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000300 # compress object in steps, decompress object in steps
Neil Schemenauer6412b122004-06-05 19:34:28 +0000301 source = source or HAMLET_SCENE
302 data = source * 128
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000303 co = zlib.compressobj()
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000304 bufs = []
Neil Schemenauer6412b122004-06-05 19:34:28 +0000305 for i in range(0, len(data), cx):
306 bufs.append(co.compress(data[i:i+cx]))
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000307 bufs.append(co.flush())
Guido van Rossum776152b2007-05-22 22:44:07 +0000308 combuf = b''.join(bufs)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000309
Gregory P. Smith693fc462008-09-06 20:13:06 +0000310 decombuf = zlib.decompress(combuf)
311 # Test type of return value
Ezio Melottie9615932010-01-24 19:26:24 +0000312 self.assertIsInstance(decombuf, bytes)
Gregory P. Smith693fc462008-09-06 20:13:06 +0000313
314 self.assertEqual(data, decombuf)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000315
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000316 dco = zlib.decompressobj()
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000317 bufs = []
Neil Schemenauer6412b122004-06-05 19:34:28 +0000318 for i in range(0, len(combuf), dcx):
319 bufs.append(dco.decompress(combuf[i:i+dcx]))
Guido van Rossum776152b2007-05-22 22:44:07 +0000320 self.assertEqual(b'', dco.unconsumed_tail, ########
321 "(A) uct should be b'': not %d long" %
Neil Schemenauer6412b122004-06-05 19:34:28 +0000322 len(dco.unconsumed_tail))
Amaury Forgeot d'Arce43d33a2008-07-02 20:50:16 +0000323 self.assertEqual(b'', dco.unused_data)
Neil Schemenauer6412b122004-06-05 19:34:28 +0000324 if flush:
325 bufs.append(dco.flush())
326 else:
327 while True:
Antoine Pitrou77b338b2009-12-14 18:00:06 +0000328 chunk = dco.decompress(b'')
Neil Schemenauer6412b122004-06-05 19:34:28 +0000329 if chunk:
330 bufs.append(chunk)
331 else:
332 break
Guido van Rossum776152b2007-05-22 22:44:07 +0000333 self.assertEqual(b'', dco.unconsumed_tail, ########
334 "(B) uct should be b'': not %d long" %
Neil Schemenauer6412b122004-06-05 19:34:28 +0000335 len(dco.unconsumed_tail))
Amaury Forgeot d'Arce43d33a2008-07-02 20:50:16 +0000336 self.assertEqual(b'', dco.unused_data)
Guido van Rossum776152b2007-05-22 22:44:07 +0000337 self.assertEqual(data, b''.join(bufs))
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000338 # Failure means: "decompressobj with init options failed"
339
Neil Schemenauer6412b122004-06-05 19:34:28 +0000340 def test_decompincflush(self):
341 self.test_decompinc(flush=True)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000342
Neil Schemenauer6412b122004-06-05 19:34:28 +0000343 def test_decompimax(self, source=None, cx=256, dcx=64):
344 # compress in steps, decompress in length-restricted steps
345 source = source or HAMLET_SCENE
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000346 # Check a decompression object with max_length specified
Neil Schemenauer6412b122004-06-05 19:34:28 +0000347 data = source * 128
348 co = zlib.compressobj()
349 bufs = []
350 for i in range(0, len(data), cx):
351 bufs.append(co.compress(data[i:i+cx]))
352 bufs.append(co.flush())
Guido van Rossum776152b2007-05-22 22:44:07 +0000353 combuf = b''.join(bufs)
Neil Schemenauer6412b122004-06-05 19:34:28 +0000354 self.assertEqual(data, zlib.decompress(combuf),
355 'compressed data failure')
356
357 dco = zlib.decompressobj()
358 bufs = []
359 cb = combuf
360 while cb:
361 #max_length = 1 + len(cb)//10
362 chunk = dco.decompress(cb, dcx)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000363 self.assertFalse(len(chunk) > dcx,
Neil Schemenauer6412b122004-06-05 19:34:28 +0000364 'chunk too big (%d>%d)' % (len(chunk), dcx))
365 bufs.append(chunk)
366 cb = dco.unconsumed_tail
367 bufs.append(dco.flush())
Guido van Rossum776152b2007-05-22 22:44:07 +0000368 self.assertEqual(data, b''.join(bufs), 'Wrong data retrieved')
Neil Schemenauer6412b122004-06-05 19:34:28 +0000369
370 def test_decompressmaxlen(self, flush=False):
371 # Check a decompression object with max_length specified
372 data = HAMLET_SCENE * 128
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000373 co = zlib.compressobj()
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000374 bufs = []
375 for i in range(0, len(data), 256):
376 bufs.append(co.compress(data[i:i+256]))
377 bufs.append(co.flush())
Guido van Rossum776152b2007-05-22 22:44:07 +0000378 combuf = b''.join(bufs)
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000379 self.assertEqual(data, zlib.decompress(combuf),
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000380 'compressed data failure')
381
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000382 dco = zlib.decompressobj()
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000383 bufs = []
384 cb = combuf
385 while cb:
Guido van Rossumf3594102003-02-27 18:39:18 +0000386 max_length = 1 + len(cb)//10
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000387 chunk = dco.decompress(cb, max_length)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000388 self.assertFalse(len(chunk) > max_length,
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000389 'chunk too big (%d>%d)' % (len(chunk),max_length))
390 bufs.append(chunk)
391 cb = dco.unconsumed_tail
Neil Schemenauer6412b122004-06-05 19:34:28 +0000392 if flush:
393 bufs.append(dco.flush())
394 else:
395 while chunk:
Antoine Pitrou77b338b2009-12-14 18:00:06 +0000396 chunk = dco.decompress(b'', max_length)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000397 self.assertFalse(len(chunk) > max_length,
Neil Schemenauer6412b122004-06-05 19:34:28 +0000398 'chunk too big (%d>%d)' % (len(chunk),max_length))
399 bufs.append(chunk)
Guido van Rossum776152b2007-05-22 22:44:07 +0000400 self.assertEqual(data, b''.join(bufs), 'Wrong data retrieved')
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000401
Neil Schemenauer6412b122004-06-05 19:34:28 +0000402 def test_decompressmaxlenflush(self):
403 self.test_decompressmaxlen(flush=True)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000404
405 def test_maxlenmisc(self):
406 # Misc tests of max_length
Neil Schemenauer94afd3e2004-06-05 19:02:52 +0000407 dco = zlib.decompressobj()
Antoine Pitrou77b338b2009-12-14 18:00:06 +0000408 self.assertRaises(ValueError, dco.decompress, b"", -1)
Guido van Rossum776152b2007-05-22 22:44:07 +0000409 self.assertEqual(b'', dco.unconsumed_tail)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000410
Martin Pantere99e9772015-11-20 08:13:35 +0000411 def test_maxlen_large(self):
412 # Sizes up to sys.maxsize should be accepted, although zlib is
413 # internally limited to expressing sizes with unsigned int
414 data = HAMLET_SCENE * 10
415 self.assertGreater(len(data), zlib.DEF_BUF_SIZE)
416 compressed = zlib.compress(data, 1)
417 dco = zlib.decompressobj()
418 self.assertEqual(dco.decompress(compressed, sys.maxsize), data)
419
420 def test_maxlen_custom(self):
421 data = HAMLET_SCENE * 10
422 compressed = zlib.compress(data, 1)
423 dco = zlib.decompressobj()
424 self.assertEqual(dco.decompress(compressed, CustomInt()), data[:100])
425
Nadeem Vawda7619e882011-05-14 14:05:20 +0200426 def test_clear_unconsumed_tail(self):
427 # Issue #12050: calling decompress() without providing max_length
428 # should clear the unconsumed_tail attribute.
429 cdata = b"x\x9cKLJ\x06\x00\x02M\x01" # "abc"
430 dco = zlib.decompressobj()
431 ddata = dco.decompress(cdata, 1)
432 ddata += dco.decompress(dco.unconsumed_tail)
433 self.assertEqual(dco.unconsumed_tail, b"")
434
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000435 def test_flushes(self):
436 # Test flush() with the various options, using all the
437 # different levels in order to provide more variations.
Xiang Zhangbc3f2282018-03-07 13:05:37 +0800438 sync_opt = ['Z_NO_FLUSH', 'Z_SYNC_FLUSH', 'Z_FULL_FLUSH',
439 'Z_PARTIAL_FLUSH', 'Z_BLOCK']
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000440 sync_opt = [getattr(zlib, opt) for opt in sync_opt
441 if hasattr(zlib, opt)]
Neil Schemenauer6412b122004-06-05 19:34:28 +0000442 data = HAMLET_SCENE * 8
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000443
444 for sync in sync_opt:
445 for level in range(10):
446 obj = zlib.compressobj( level )
447 a = obj.compress( data[:3000] )
448 b = obj.flush( sync )
449 c = obj.compress( data[3000:] )
450 d = obj.flush()
Guido van Rossum776152b2007-05-22 22:44:07 +0000451 self.assertEqual(zlib.decompress(b''.join([a,b,c,d])),
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000452 data, ("Decompress failed: flush "
453 "mode=%i, level=%i") % (sync, level))
454 del obj
455
Serhiy Storchaka43767632013-11-03 21:31:38 +0200456 @unittest.skipUnless(hasattr(zlib, 'Z_SYNC_FLUSH'),
457 'requires zlib.Z_SYNC_FLUSH')
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000458 def test_odd_flush(self):
459 # Test for odd flushing bugs noted in 2.0, and hopefully fixed in 2.1
460 import random
Serhiy Storchaka43767632013-11-03 21:31:38 +0200461 # Testing on 17K of "random" data
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000462
Serhiy Storchaka43767632013-11-03 21:31:38 +0200463 # Create compressor and decompressor objects
464 co = zlib.compressobj(zlib.Z_BEST_COMPRESSION)
465 dco = zlib.decompressobj()
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000466
Serhiy Storchaka43767632013-11-03 21:31:38 +0200467 # Try 17K of data
468 # generate random data stream
469 try:
470 # In 2.3 and later, WichmannHill is the RNG of the bug report
471 gen = random.WichmannHill()
472 except AttributeError:
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000473 try:
Serhiy Storchaka43767632013-11-03 21:31:38 +0200474 # 2.2 called it Random
475 gen = random.Random()
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000476 except AttributeError:
Serhiy Storchaka43767632013-11-03 21:31:38 +0200477 # others might simply have a single RNG
478 gen = random
479 gen.seed(1)
480 data = genblock(1, 17 * 1024, generator=gen)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000481
Serhiy Storchaka43767632013-11-03 21:31:38 +0200482 # compress, sync-flush, and decompress
483 first = co.compress(data)
484 second = co.flush(zlib.Z_SYNC_FLUSH)
485 expanded = dco.decompress(first + second)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000486
Serhiy Storchaka43767632013-11-03 21:31:38 +0200487 # if decompressed data is different from the input data, choke.
488 self.assertEqual(expanded, data, "17K random source doesn't match")
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000489
Andrew M. Kuchling3b585b32004-12-28 20:10:48 +0000490 def test_empty_flush(self):
491 # Test that calling .flush() on unused objects works.
492 # (Bug #1083110 -- calling .flush() on decompress objects
493 # caused a core dump.)
494
495 co = zlib.compressobj(zlib.Z_BEST_COMPRESSION)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000496 self.assertTrue(co.flush()) # Returns a zlib header
Andrew M. Kuchling3b585b32004-12-28 20:10:48 +0000497 dco = zlib.decompressobj()
Guido van Rossum776152b2007-05-22 22:44:07 +0000498 self.assertEqual(dco.flush(), b"") # Returns nothing
Tim Peters5a9fb3c2005-01-07 16:01:32 +0000499
Nadeem Vawdafd8a8382012-06-21 02:13:12 +0200500 def test_dictionary(self):
501 h = HAMLET_SCENE
Nadeem Vawdacf5e1d82012-06-22 00:35:57 +0200502 # Build a simulated dictionary out of the words in HAMLET.
Nadeem Vawdafd8a8382012-06-21 02:13:12 +0200503 words = h.split()
504 random.shuffle(words)
505 zdict = b''.join(words)
Nadeem Vawdacf5e1d82012-06-22 00:35:57 +0200506 # Use it to compress HAMLET.
Nadeem Vawdafd8a8382012-06-21 02:13:12 +0200507 co = zlib.compressobj(zdict=zdict)
508 cd = co.compress(h) + co.flush()
Nadeem Vawdacf5e1d82012-06-22 00:35:57 +0200509 # Verify that it will decompress with the dictionary.
Nadeem Vawdafd8a8382012-06-21 02:13:12 +0200510 dco = zlib.decompressobj(zdict=zdict)
511 self.assertEqual(dco.decompress(cd) + dco.flush(), h)
Nadeem Vawdacf5e1d82012-06-22 00:35:57 +0200512 # Verify that it fails when not given the dictionary.
Nadeem Vawdafd8a8382012-06-21 02:13:12 +0200513 dco = zlib.decompressobj()
514 self.assertRaises(zlib.error, dco.decompress, cd)
515
516 def test_dictionary_streaming(self):
Nadeem Vawdacf5e1d82012-06-22 00:35:57 +0200517 # This simulates the reuse of a compressor object for compressing
518 # several separate data streams.
Nadeem Vawdafd8a8382012-06-21 02:13:12 +0200519 co = zlib.compressobj(zdict=HAMLET_SCENE)
520 do = zlib.decompressobj(zdict=HAMLET_SCENE)
521 piece = HAMLET_SCENE[1000:1500]
522 d0 = co.compress(piece) + co.flush(zlib.Z_SYNC_FLUSH)
523 d1 = co.compress(piece[100:]) + co.flush(zlib.Z_SYNC_FLUSH)
524 d2 = co.compress(piece[:-100]) + co.flush(zlib.Z_SYNC_FLUSH)
525 self.assertEqual(do.decompress(d0), piece)
526 self.assertEqual(do.decompress(d1), piece[100:])
527 self.assertEqual(do.decompress(d2), piece[:-100])
528
Antoine Pitrouc09c92f2010-05-11 23:36:40 +0000529 def test_decompress_incomplete_stream(self):
530 # This is 'foo', deflated
531 x = b'x\x9cK\xcb\xcf\x07\x00\x02\x82\x01E'
532 # For the record
533 self.assertEqual(zlib.decompress(x), b'foo')
534 self.assertRaises(zlib.error, zlib.decompress, x[:-5])
535 # Omitting the stream end works with decompressor objects
536 # (see issue #8672).
537 dco = zlib.decompressobj()
538 y = dco.decompress(x[:-5])
539 y += dco.flush()
540 self.assertEqual(y, b'foo')
541
Nadeem Vawda1c385462011-08-13 15:22:40 +0200542 def test_decompress_eof(self):
543 x = b'x\x9cK\xcb\xcf\x07\x00\x02\x82\x01E' # 'foo'
544 dco = zlib.decompressobj()
545 self.assertFalse(dco.eof)
546 dco.decompress(x[:-5])
547 self.assertFalse(dco.eof)
548 dco.decompress(x[-5:])
549 self.assertTrue(dco.eof)
550 dco.flush()
551 self.assertTrue(dco.eof)
552
553 def test_decompress_eof_incomplete_stream(self):
554 x = b'x\x9cK\xcb\xcf\x07\x00\x02\x82\x01E' # 'foo'
555 dco = zlib.decompressobj()
556 self.assertFalse(dco.eof)
557 dco.decompress(x[:-5])
558 self.assertFalse(dco.eof)
559 dco.flush()
560 self.assertFalse(dco.eof)
561
Nadeem Vawda39079942012-11-05 00:37:42 +0100562 def test_decompress_unused_data(self):
563 # Repeated calls to decompress() after EOF should accumulate data in
564 # dco.unused_data, instead of just storing the arg to the last call.
Nadeem Vawdaee7889d2012-11-11 02:14:36 +0100565 source = b'abcdefghijklmnopqrstuvwxyz'
566 remainder = b'0123456789'
567 y = zlib.compress(source)
568 x = y + remainder
569 for maxlen in 0, 1000:
570 for step in 1, 2, len(y), len(x):
571 dco = zlib.decompressobj()
572 data = b''
573 for i in range(0, len(x), step):
574 if i < len(y):
575 self.assertEqual(dco.unused_data, b'')
576 if maxlen == 0:
577 data += dco.decompress(x[i : i + step])
578 self.assertEqual(dco.unconsumed_tail, b'')
579 else:
580 data += dco.decompress(
581 dco.unconsumed_tail + x[i : i + step], maxlen)
582 data += dco.flush()
Nadeem Vawdadd1253a2012-11-11 02:21:22 +0100583 self.assertTrue(dco.eof)
Nadeem Vawdaee7889d2012-11-11 02:14:36 +0100584 self.assertEqual(data, source)
585 self.assertEqual(dco.unconsumed_tail, b'')
586 self.assertEqual(dco.unused_data, remainder)
Nadeem Vawda39079942012-11-05 00:37:42 +0100587
Martin Panter3f0ee832016-06-05 10:48:34 +0000588 # issue27164
589 def test_decompress_raw_with_dictionary(self):
590 zdict = b'abcdefghijklmnopqrstuvwxyz'
591 co = zlib.compressobj(wbits=-zlib.MAX_WBITS, zdict=zdict)
592 comp = co.compress(zdict) + co.flush()
593 dco = zlib.decompressobj(wbits=-zlib.MAX_WBITS, zdict=zdict)
594 uncomp = dco.decompress(comp) + dco.flush()
595 self.assertEqual(zdict, uncomp)
596
Nadeem Vawda7ee95552012-11-11 03:15:32 +0100597 def test_flush_with_freed_input(self):
598 # Issue #16411: decompressor accesses input to last decompress() call
599 # in flush(), even if this object has been freed in the meanwhile.
600 input1 = b'abcdefghijklmnopqrstuvwxyz'
601 input2 = b'QWERTYUIOPASDFGHJKLZXCVBNM'
602 data = zlib.compress(input1)
603 dco = zlib.decompressobj()
604 dco.decompress(data, 1)
605 del data
606 data = zlib.compress(input2)
607 self.assertEqual(dco.flush(), input1[1:])
608
Martin Pantere99e9772015-11-20 08:13:35 +0000609 @bigmemtest(size=_4G, memuse=1)
610 def test_flush_large_length(self, size):
611 # Test flush(length) parameter greater than internal limit UINT_MAX
612 input = HAMLET_SCENE * 10
613 data = zlib.compress(input, 1)
614 dco = zlib.decompressobj()
615 dco.decompress(data, 1)
616 self.assertEqual(dco.flush(size), input[1:])
617
618 def test_flush_custom_length(self):
619 input = HAMLET_SCENE * 10
620 data = zlib.compress(input, 1)
621 dco = zlib.decompressobj()
622 dco.decompress(data, 1)
623 self.assertEqual(dco.flush(CustomInt()), input[1:])
624
Serhiy Storchaka43767632013-11-03 21:31:38 +0200625 @requires_Compress_copy
626 def test_compresscopy(self):
627 # Test copying a compression object
628 data0 = HAMLET_SCENE
629 data1 = bytes(str(HAMLET_SCENE, "ascii").swapcase(), "ascii")
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600630 for func in lambda c: c.copy(), copy.copy, copy.deepcopy:
631 c0 = zlib.compressobj(zlib.Z_BEST_COMPRESSION)
632 bufs0 = []
633 bufs0.append(c0.compress(data0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000634
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600635 c1 = func(c0)
636 bufs1 = bufs0[:]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000637
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600638 bufs0.append(c0.compress(data0))
639 bufs0.append(c0.flush())
640 s0 = b''.join(bufs0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000641
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600642 bufs1.append(c1.compress(data1))
643 bufs1.append(c1.flush())
644 s1 = b''.join(bufs1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000645
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600646 self.assertEqual(zlib.decompress(s0),data0+data0)
647 self.assertEqual(zlib.decompress(s1),data0+data1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000648
Serhiy Storchaka43767632013-11-03 21:31:38 +0200649 @requires_Compress_copy
650 def test_badcompresscopy(self):
651 # Test copying a compression object in an inconsistent state
652 c = zlib.compressobj()
653 c.compress(HAMLET_SCENE)
654 c.flush()
655 self.assertRaises(ValueError, c.copy)
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600656 self.assertRaises(ValueError, copy.copy, c)
657 self.assertRaises(ValueError, copy.deepcopy, c)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000658
Serhiy Storchaka43767632013-11-03 21:31:38 +0200659 @requires_Decompress_copy
660 def test_decompresscopy(self):
661 # Test copying a decompression object
662 data = HAMLET_SCENE
663 comp = zlib.compress(data)
664 # Test type of return value
665 self.assertIsInstance(comp, bytes)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000666
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600667 for func in lambda c: c.copy(), copy.copy, copy.deepcopy:
668 d0 = zlib.decompressobj()
669 bufs0 = []
670 bufs0.append(d0.decompress(comp[:32]))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000671
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600672 d1 = func(d0)
673 bufs1 = bufs0[:]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000674
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600675 bufs0.append(d0.decompress(comp[32:]))
676 s0 = b''.join(bufs0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000677
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600678 bufs1.append(d1.decompress(comp[32:]))
679 s1 = b''.join(bufs1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000680
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600681 self.assertEqual(s0,s1)
682 self.assertEqual(s0,data)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000683
Serhiy Storchaka43767632013-11-03 21:31:38 +0200684 @requires_Decompress_copy
685 def test_baddecompresscopy(self):
686 # Test copying a compression object in an inconsistent state
687 data = zlib.compress(HAMLET_SCENE)
688 d = zlib.decompressobj()
689 d.decompress(data)
690 d.flush()
691 self.assertRaises(ValueError, d.copy)
Zackery Spytzd2cbfff2018-06-27 12:04:51 -0600692 self.assertRaises(ValueError, copy.copy, d)
693 self.assertRaises(ValueError, copy.deepcopy, d)
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000694
Serhiy Storchakad7a44152015-11-12 11:23:04 +0200695 def test_compresspickle(self):
696 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
697 with self.assertRaises((TypeError, pickle.PicklingError)):
698 pickle.dumps(zlib.compressobj(zlib.Z_BEST_COMPRESSION), proto)
699
700 def test_decompresspickle(self):
701 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
702 with self.assertRaises((TypeError, pickle.PicklingError)):
703 pickle.dumps(zlib.decompressobj(), proto)
704
Antoine Pitrou89562712010-05-07 17:04:02 +0000705 # Memory use of the following functions takes into account overallocation
706
Antoine Pitrou94190bb2011-10-04 10:22:36 +0200707 @bigmemtest(size=_1G + 1024 * 1024, memuse=3)
Antoine Pitrou89562712010-05-07 17:04:02 +0000708 def test_big_compress_buffer(self, size):
709 c = zlib.compressobj(1)
710 compress = lambda s: c.compress(s) + c.flush()
711 self.check_big_compress_buffer(size, compress)
712
Antoine Pitrou94190bb2011-10-04 10:22:36 +0200713 @bigmemtest(size=_1G + 1024 * 1024, memuse=2)
Antoine Pitrou89562712010-05-07 17:04:02 +0000714 def test_big_decompress_buffer(self, size):
715 d = zlib.decompressobj()
716 decompress = lambda s: d.decompress(s) + d.flush()
717 self.check_big_decompress_buffer(size, decompress)
718
Martin Panter84544c12016-07-23 03:02:07 +0000719 @unittest.skipUnless(sys.maxsize > 2**32, 'requires 64bit platform')
720 @bigmemtest(size=_4G + 100, memuse=4)
721 def test_64bit_compress(self, size):
Nadeem Vawda0c3d96a2011-05-15 00:19:50 +0200722 data = b'x' * size
Martin Panter84544c12016-07-23 03:02:07 +0000723 co = zlib.compressobj(0)
724 do = zlib.decompressobj()
Nadeem Vawda0c3d96a2011-05-15 00:19:50 +0200725 try:
Martin Panter84544c12016-07-23 03:02:07 +0000726 comp = co.compress(data) + co.flush()
727 uncomp = do.decompress(comp) + do.flush()
728 self.assertEqual(uncomp, data)
Nadeem Vawda0c3d96a2011-05-15 00:19:50 +0200729 finally:
Martin Panter84544c12016-07-23 03:02:07 +0000730 comp = uncomp = data = None
731
732 @unittest.skipUnless(sys.maxsize > 2**32, 'requires 64bit platform')
733 @bigmemtest(size=_4G + 100, memuse=3)
734 def test_large_unused_data(self, size):
735 data = b'abcdefghijklmnop'
736 unused = b'x' * size
737 comp = zlib.compress(data) + unused
738 do = zlib.decompressobj()
739 try:
740 uncomp = do.decompress(comp) + do.flush()
741 self.assertEqual(unused, do.unused_data)
742 self.assertEqual(uncomp, data)
743 finally:
744 unused = comp = do = None
745
746 @unittest.skipUnless(sys.maxsize > 2**32, 'requires 64bit platform')
747 @bigmemtest(size=_4G + 100, memuse=5)
748 def test_large_unconsumed_tail(self, size):
749 data = b'x' * size
750 do = zlib.decompressobj()
751 try:
752 comp = zlib.compress(data, 0)
753 uncomp = do.decompress(comp, 1) + do.flush()
754 self.assertEqual(uncomp, data)
755 self.assertEqual(do.unconsumed_tail, b'')
756 finally:
757 comp = uncomp = data = None
Nadeem Vawda0c3d96a2011-05-15 00:19:50 +0200758
Martin Panter0fdf41d2016-05-27 07:32:11 +0000759 def test_wbits(self):
Martin Panterc618ae82016-05-27 11:20:21 +0000760 # wbits=0 only supported since zlib v1.2.3.5
761 # Register "1.2.3" as "1.2.3.0"
pmp-p4c7108a2018-02-19 04:45:11 +0100762 # or "1.2.0-linux","1.2.0.f","1.2.0.f-linux"
763 v = zlib.ZLIB_RUNTIME_VERSION.split('-', 1)[0].split('.')
764 if len(v) < 4:
765 v.append('0')
766 elif not v[-1].isnumeric():
767 v[-1] = '0'
768
769 v = tuple(map(int, v))
770 supports_wbits_0 = v >= (1, 2, 3, 5)
Martin Panterc618ae82016-05-27 11:20:21 +0000771
Martin Panter0fdf41d2016-05-27 07:32:11 +0000772 co = zlib.compressobj(level=1, wbits=15)
773 zlib15 = co.compress(HAMLET_SCENE) + co.flush()
774 self.assertEqual(zlib.decompress(zlib15, 15), HAMLET_SCENE)
Martin Panterc618ae82016-05-27 11:20:21 +0000775 if supports_wbits_0:
776 self.assertEqual(zlib.decompress(zlib15, 0), HAMLET_SCENE)
Martin Panter0fdf41d2016-05-27 07:32:11 +0000777 self.assertEqual(zlib.decompress(zlib15, 32 + 15), HAMLET_SCENE)
778 with self.assertRaisesRegex(zlib.error, 'invalid window size'):
779 zlib.decompress(zlib15, 14)
780 dco = zlib.decompressobj(wbits=32 + 15)
781 self.assertEqual(dco.decompress(zlib15), HAMLET_SCENE)
782 dco = zlib.decompressobj(wbits=14)
783 with self.assertRaisesRegex(zlib.error, 'invalid window size'):
784 dco.decompress(zlib15)
785
786 co = zlib.compressobj(level=1, wbits=9)
787 zlib9 = co.compress(HAMLET_SCENE) + co.flush()
788 self.assertEqual(zlib.decompress(zlib9, 9), HAMLET_SCENE)
789 self.assertEqual(zlib.decompress(zlib9, 15), HAMLET_SCENE)
Martin Panterc618ae82016-05-27 11:20:21 +0000790 if supports_wbits_0:
791 self.assertEqual(zlib.decompress(zlib9, 0), HAMLET_SCENE)
Martin Panter0fdf41d2016-05-27 07:32:11 +0000792 self.assertEqual(zlib.decompress(zlib9, 32 + 9), HAMLET_SCENE)
793 dco = zlib.decompressobj(wbits=32 + 9)
794 self.assertEqual(dco.decompress(zlib9), HAMLET_SCENE)
795
796 co = zlib.compressobj(level=1, wbits=-15)
797 deflate15 = co.compress(HAMLET_SCENE) + co.flush()
798 self.assertEqual(zlib.decompress(deflate15, -15), HAMLET_SCENE)
799 dco = zlib.decompressobj(wbits=-15)
800 self.assertEqual(dco.decompress(deflate15), HAMLET_SCENE)
801
802 co = zlib.compressobj(level=1, wbits=-9)
803 deflate9 = co.compress(HAMLET_SCENE) + co.flush()
804 self.assertEqual(zlib.decompress(deflate9, -9), HAMLET_SCENE)
805 self.assertEqual(zlib.decompress(deflate9, -15), HAMLET_SCENE)
806 dco = zlib.decompressobj(wbits=-9)
807 self.assertEqual(dco.decompress(deflate9), HAMLET_SCENE)
808
809 co = zlib.compressobj(level=1, wbits=16 + 15)
810 gzip = co.compress(HAMLET_SCENE) + co.flush()
811 self.assertEqual(zlib.decompress(gzip, 16 + 15), HAMLET_SCENE)
812 self.assertEqual(zlib.decompress(gzip, 32 + 15), HAMLET_SCENE)
813 dco = zlib.decompressobj(32 + 15)
814 self.assertEqual(dco.decompress(gzip), HAMLET_SCENE)
815
Antoine Pitrou89562712010-05-07 17:04:02 +0000816
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000817def genblock(seed, length, step=1024, generator=random):
818 """length-byte stream of random data from a seed (in step-byte blocks)."""
819 if seed is not None:
820 generator.seed(seed)
821 randint = generator.randint
822 if length < step or step < 2:
823 step = length
Guido van Rossum776152b2007-05-22 22:44:07 +0000824 blocks = bytes()
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000825 for i in range(0, length, step):
Guido van Rossum776152b2007-05-22 22:44:07 +0000826 blocks += bytes(randint(0, 255) for x in range(step))
827 return blocks
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000828
829
830
831def choose_lines(source, number, seed=None, generator=random):
832 """Return a list of number lines randomly chosen from the source"""
833 if seed is not None:
834 generator.seed(seed)
835 sources = source.split('\n')
836 return [generator.choice(sources) for n in range(number)]
837
838
839
Guido van Rossum776152b2007-05-22 22:44:07 +0000840HAMLET_SCENE = b"""
Fred Drake004d5e62000-10-23 17:22:08 +0000841LAERTES
Jeremy Hylton6eb4b6a1997-08-15 15:59:43 +0000842
843 O, fear me not.
844 I stay too long: but here my father comes.
845
846 Enter POLONIUS
847
848 A double blessing is a double grace,
849 Occasion smiles upon a second leave.
850
Fred Drake004d5e62000-10-23 17:22:08 +0000851LORD POLONIUS
Jeremy Hylton6eb4b6a1997-08-15 15:59:43 +0000852
853 Yet here, Laertes! aboard, aboard, for shame!
854 The wind sits in the shoulder of your sail,
855 And you are stay'd for. There; my blessing with thee!
856 And these few precepts in thy memory
857 See thou character. Give thy thoughts no tongue,
858 Nor any unproportioned thought his act.
859 Be thou familiar, but by no means vulgar.
860 Those friends thou hast, and their adoption tried,
861 Grapple them to thy soul with hoops of steel;
862 But do not dull thy palm with entertainment
863 Of each new-hatch'd, unfledged comrade. Beware
864 Of entrance to a quarrel, but being in,
865 Bear't that the opposed may beware of thee.
866 Give every man thy ear, but few thy voice;
867 Take each man's censure, but reserve thy judgment.
868 Costly thy habit as thy purse can buy,
869 But not express'd in fancy; rich, not gaudy;
870 For the apparel oft proclaims the man,
871 And they in France of the best rank and station
872 Are of a most select and generous chief in that.
873 Neither a borrower nor a lender be;
874 For loan oft loses both itself and friend,
875 And borrowing dulls the edge of husbandry.
876 This above all: to thine ownself be true,
877 And it must follow, as the night the day,
878 Thou canst not then be false to any man.
879 Farewell: my blessing season this in thee!
880
Fred Drake004d5e62000-10-23 17:22:08 +0000881LAERTES
Jeremy Hylton6eb4b6a1997-08-15 15:59:43 +0000882
883 Most humbly do I take my leave, my lord.
884
Fred Drake004d5e62000-10-23 17:22:08 +0000885LORD POLONIUS
Jeremy Hylton6eb4b6a1997-08-15 15:59:43 +0000886
887 The time invites you; go; your servants tend.
888
Fred Drake004d5e62000-10-23 17:22:08 +0000889LAERTES
Jeremy Hylton6eb4b6a1997-08-15 15:59:43 +0000890
891 Farewell, Ophelia; and remember well
892 What I have said to you.
893
Fred Drake004d5e62000-10-23 17:22:08 +0000894OPHELIA
Jeremy Hylton6eb4b6a1997-08-15 15:59:43 +0000895
896 'Tis in my memory lock'd,
897 And you yourself shall keep the key of it.
898
Fred Drake004d5e62000-10-23 17:22:08 +0000899LAERTES
Jeremy Hylton6eb4b6a1997-08-15 15:59:43 +0000900
901 Farewell.
902"""
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000903
904
Martin Pantere99e9772015-11-20 08:13:35 +0000905class CustomInt:
906 def __int__(self):
907 return 100
908
909
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000910if __name__ == "__main__":
Zachary Ware38c707e2015-04-13 15:00:43 -0500911 unittest.main()