blob: 9965c1fe2e5f17583f49450cffcaa806d777054f [file] [log] [blame]
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001from test import support
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +02002from test.support import bigmemtest, _4G
Tim Peters499d09a2002-11-09 06:31:56 +00003
Miss Islington (bot)01858fb2021-06-22 06:59:53 -07004import array
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +00005import unittest
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +02006from io import BytesIO, DEFAULT_BUFFER_SIZE
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +00007import os
Nadeem Vawda37970652013-10-28 21:35:23 +01008import pickle
Antoine Pitroue71258a2015-02-26 13:08:07 +01009import glob
Tim Golden6a62e1d2018-07-26 22:05:00 +010010import tempfile
Berker Peksag8bdd4482016-10-02 20:07:06 +030011import pathlib
Nadeem Vawdaea4b46f2011-04-12 23:02:42 +020012import random
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +020013import shutil
Guido van Rossum360e4b82007-05-14 22:51:27 +000014import subprocess
Antoine Pitroua6a4dc82017-09-07 18:56:24 +020015import threading
Hai Shi3ddc6342020-06-30 21:46:06 +080016from test.support import import_helper
Hai Shie80697d2020-05-28 06:10:27 +080017from test.support import threading_helper
Hai Shi3ddc6342020-06-30 21:46:06 +080018from test.support.os_helper import unlink
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +020019import _compression
Oren Milmand019bc82018-02-13 12:28:33 +020020import sys
Victor Stinner45df8202010-04-28 22:31:17 +000021
Tim Peters499d09a2002-11-09 06:31:56 +000022
R. David Murraya21e4ca2009-03-31 23:16:50 +000023# Skip tests if the bz2 module doesn't exist.
Hai Shi3ddc6342020-06-30 21:46:06 +080024bz2 = import_helper.import_module('bz2')
Tim Peters499d09a2002-11-09 06:31:56 +000025from bz2 import BZ2File, BZ2Compressor, BZ2Decompressor
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +000026
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +020027has_cmdline_bunzip2 = None
28
29def ext_decompress(data):
30 global has_cmdline_bunzip2
31 if has_cmdline_bunzip2 is None:
32 has_cmdline_bunzip2 = bool(shutil.which('bunzip2'))
33 if has_cmdline_bunzip2:
34 return subprocess.check_output(['bunzip2'], input=data)
35 else:
36 return bz2.decompress(data)
Tim Peters9de06bd2002-11-09 06:45:31 +000037
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +000038class BaseTest(unittest.TestCase):
Tim Peters3de75262002-11-09 05:26:15 +000039 "Base for other testcases."
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +020040
Antoine Pitrou37dc5f82011-04-03 17:05:46 +020041 TEXT_LINES = [
42 b'root:x:0:0:root:/root:/bin/bash\n',
43 b'bin:x:1:1:bin:/bin:\n',
44 b'daemon:x:2:2:daemon:/sbin:\n',
45 b'adm:x:3:4:adm:/var/adm:\n',
46 b'lp:x:4:7:lp:/var/spool/lpd:\n',
47 b'sync:x:5:0:sync:/sbin:/bin/sync\n',
48 b'shutdown:x:6:0:shutdown:/sbin:/sbin/shutdown\n',
49 b'halt:x:7:0:halt:/sbin:/sbin/halt\n',
50 b'mail:x:8:12:mail:/var/spool/mail:\n',
51 b'news:x:9:13:news:/var/spool/news:\n',
52 b'uucp:x:10:14:uucp:/var/spool/uucp:\n',
53 b'operator:x:11:0:operator:/root:\n',
54 b'games:x:12:100:games:/usr/games:\n',
55 b'gopher:x:13:30:gopher:/usr/lib/gopher-data:\n',
56 b'ftp:x:14:50:FTP User:/var/ftp:/bin/bash\n',
57 b'nobody:x:65534:65534:Nobody:/home:\n',
58 b'postfix:x:100:101:postfix:/var/spool/postfix:\n',
59 b'niemeyer:x:500:500::/home/niemeyer:/bin/bash\n',
60 b'postgres:x:101:102:PostgreSQL Server:/var/lib/pgsql:/bin/bash\n',
61 b'mysql:x:102:103:MySQL server:/var/lib/mysql:/bin/bash\n',
62 b'www:x:103:104::/var/www:/bin/false\n',
63 ]
64 TEXT = b''.join(TEXT_LINES)
Guido van Rossum522a6c62007-05-22 23:13:45 +000065 DATA = b'BZh91AY&SY.\xc8N\x18\x00\x01>_\x80\x00\x10@\x02\xff\xf0\x01\x07n\x00?\xe7\xff\xe00\x01\x99\xaa\x00\xc0\x03F\x86\x8c#&\x83F\x9a\x03\x06\xa6\xd0\xa6\x93M\x0fQ\xa7\xa8\x06\x804hh\x12$\x11\xa4i4\xf14S\xd2<Q\xb5\x0fH\xd3\xd4\xdd\xd5\x87\xbb\xf8\x94\r\x8f\xafI\x12\xe1\xc9\xf8/E\x00pu\x89\x12]\xc9\xbbDL\nQ\x0e\t1\x12\xdf\xa0\xc0\x97\xac2O9\x89\x13\x94\x0e\x1c7\x0ed\x95I\x0c\xaaJ\xa4\x18L\x10\x05#\x9c\xaf\xba\xbc/\x97\x8a#C\xc8\xe1\x8cW\xf9\xe2\xd0\xd6M\xa7\x8bXa<e\x84t\xcbL\xb3\xa7\xd9\xcd\xd1\xcb\x84.\xaf\xb3\xab\xab\xad`n}\xa0lh\tE,\x8eZ\x15\x17VH>\x88\xe5\xcd9gd6\x0b\n\xe9\x9b\xd5\x8a\x99\xf7\x08.K\x8ev\xfb\xf7xw\xbb\xdf\xa1\x92\xf1\xdd|/";\xa2\xba\x9f\xd5\xb1#A\xb6\xf6\xb3o\xc9\xc5y\\\xebO\xe7\x85\x9a\xbc\xb6f8\x952\xd5\xd7"%\x89>V,\xf7\xa6z\xe2\x9f\xa3\xdf\x11\x11"\xd6E)I\xa9\x13^\xca\xf3r\xd0\x03U\x922\xf26\xec\xb6\xed\x8b\xc3U\x13\x9d\xc5\x170\xa4\xfa^\x92\xacDF\x8a\x97\xd6\x19\xfe\xdd\xb8\xbd\x1a\x9a\x19\xa3\x80ankR\x8b\xe5\xd83]\xa9\xc6\x08\x82f\xf6\xb9"6l$\xb8j@\xc0\x8a\xb0l1..\xbak\x83ls\x15\xbc\xf4\xc1\x13\xbe\xf8E\xb8\x9d\r\xa8\x9dk\x84\xd3n\xfa\xacQ\x07\xb1%y\xaav\xb4\x08\xe0z\x1b\x16\xf5\x04\xe9\xcc\xb9\x08z\x1en7.G\xfc]\xc9\x14\xe1B@\xbb!8`'
Nadeem Vawda638fb9b2013-01-02 23:02:00 +010066 EMPTY_DATA = b'BZh9\x17rE8P\x90\x00\x00\x00\x00'
Nadeem Vawda1de19ac2013-12-04 23:01:15 +010067 BAD_DATA = b'this is not a valid bzip2 file'
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +000068
Antoine Pitroue71258a2015-02-26 13:08:07 +010069 # Some tests need more than one block of uncompressed data. Since one block
Victor Stinner8c663fd2017-11-08 14:44:44 -080070 # is at least 100,000 bytes, we gather some data dynamically and compress it.
Antoine Pitroue71258a2015-02-26 13:08:07 +010071 # Note that this assumes that compression works correctly, so we cannot
72 # simply use the bigger test data for all tests.
73 test_size = 0
74 BIG_TEXT = bytearray(128*1024)
Serhiy Storchaka93558682020-06-20 11:10:31 +030075 for fname in glob.glob(os.path.join(glob.escape(os.path.dirname(__file__)), '*.py')):
Antoine Pitroue71258a2015-02-26 13:08:07 +010076 with open(fname, 'rb') as fh:
77 test_size += fh.readinto(memoryview(BIG_TEXT)[test_size:])
78 if test_size > 128*1024:
79 break
80 BIG_DATA = bz2.compress(BIG_TEXT, compresslevel=1)
81
Nadeem Vawdaaf518c12012-06-04 23:32:38 +020082 def setUp(self):
Tim Golden6a62e1d2018-07-26 22:05:00 +010083 fd, self.filename = tempfile.mkstemp()
84 os.close(fd)
Nadeem Vawdaaf518c12012-06-04 23:32:38 +020085
86 def tearDown(self):
Tim Golden15617032018-07-28 18:27:11 +010087 unlink(self.filename)
Nadeem Vawdaaf518c12012-06-04 23:32:38 +020088
Tim Peters9de06bd2002-11-09 06:45:31 +000089
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +000090class BZ2FileTest(BaseTest):
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +020091 "Test the BZ2File class."
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +000092
Nadeem Vawda1de19ac2013-12-04 23:01:15 +010093 def createTempFile(self, streams=1, suffix=b""):
Brian Curtind2e948d2010-10-13 02:56:26 +000094 with open(self.filename, "wb") as f:
Nadeem Vawda07d291a2011-05-30 01:44:45 +020095 f.write(self.DATA * streams)
Nadeem Vawda1de19ac2013-12-04 23:01:15 +010096 f.write(suffix)
Tim Peters230a60c2002-11-09 05:08:07 +000097
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +020098 def testBadArgs(self):
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +020099 self.assertRaises(TypeError, BZ2File, 123.456)
Serhiy Storchaka85c30332015-02-15 13:58:23 +0200100 self.assertRaises(ValueError, BZ2File, os.devnull, "z")
101 self.assertRaises(ValueError, BZ2File, os.devnull, "rx")
102 self.assertRaises(ValueError, BZ2File, os.devnull, "rbt")
103 self.assertRaises(ValueError, BZ2File, os.devnull, compresslevel=0)
104 self.assertRaises(ValueError, BZ2File, os.devnull, compresslevel=10)
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200105
Victor Stinner9baf2422020-01-16 15:33:30 +0100106 # compresslevel is keyword-only
107 self.assertRaises(TypeError, BZ2File, os.devnull, "r", 3)
108
Tim Peters3de75262002-11-09 05:26:15 +0000109 def testRead(self):
Tim Peters3de75262002-11-09 05:26:15 +0000110 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000111 with BZ2File(self.filename) as bz2f:
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200112 self.assertRaises(TypeError, bz2f.read, float())
Brian Curtind2e948d2010-10-13 02:56:26 +0000113 self.assertEqual(bz2f.read(), self.TEXT)
Tim Peters230a60c2002-11-09 05:08:07 +0000114
Nadeem Vawda1de19ac2013-12-04 23:01:15 +0100115 def testReadBadFile(self):
116 self.createTempFile(streams=0, suffix=self.BAD_DATA)
117 with BZ2File(self.filename) as bz2f:
118 self.assertRaises(OSError, bz2f.read)
119
Nadeem Vawda55b43382011-05-27 01:52:15 +0200120 def testReadMultiStream(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200121 self.createTempFile(streams=5)
122 with BZ2File(self.filename) as bz2f:
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200123 self.assertRaises(TypeError, bz2f.read, float())
Nadeem Vawda55b43382011-05-27 01:52:15 +0200124 self.assertEqual(bz2f.read(), self.TEXT * 5)
125
126 def testReadMonkeyMultiStream(self):
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200127 # Test BZ2File.read() on a multi-stream archive where a stream
128 # boundary coincides with the end of the raw read buffer.
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200129 buffer_size = _compression.BUFFER_SIZE
130 _compression.BUFFER_SIZE = len(self.DATA)
Nadeem Vawda55b43382011-05-27 01:52:15 +0200131 try:
132 self.createTempFile(streams=5)
133 with BZ2File(self.filename) as bz2f:
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200134 self.assertRaises(TypeError, bz2f.read, float())
Nadeem Vawda55b43382011-05-27 01:52:15 +0200135 self.assertEqual(bz2f.read(), self.TEXT * 5)
136 finally:
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200137 _compression.BUFFER_SIZE = buffer_size
Nadeem Vawda55b43382011-05-27 01:52:15 +0200138
Nadeem Vawda1de19ac2013-12-04 23:01:15 +0100139 def testReadTrailingJunk(self):
140 self.createTempFile(suffix=self.BAD_DATA)
141 with BZ2File(self.filename) as bz2f:
142 self.assertEqual(bz2f.read(), self.TEXT)
143
144 def testReadMultiStreamTrailingJunk(self):
145 self.createTempFile(streams=5, suffix=self.BAD_DATA)
146 with BZ2File(self.filename) as bz2f:
147 self.assertEqual(bz2f.read(), self.TEXT * 5)
148
Guido van Rossum75c26bc2007-08-07 23:29:20 +0000149 def testRead0(self):
Guido van Rossum75c26bc2007-08-07 23:29:20 +0000150 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000151 with BZ2File(self.filename) as bz2f:
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200152 self.assertRaises(TypeError, bz2f.read, float())
Brian Curtind2e948d2010-10-13 02:56:26 +0000153 self.assertEqual(bz2f.read(0), b"")
Guido van Rossum75c26bc2007-08-07 23:29:20 +0000154
Tim Peters3de75262002-11-09 05:26:15 +0000155 def testReadChunk10(self):
Tim Peters3de75262002-11-09 05:26:15 +0000156 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000157 with BZ2File(self.filename) as bz2f:
158 text = b''
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200159 while True:
Brian Curtind2e948d2010-10-13 02:56:26 +0000160 str = bz2f.read(10)
161 if not str:
162 break
163 text += str
Antoine Pitrou528d9f62011-01-26 23:29:28 +0000164 self.assertEqual(text, self.TEXT)
Tim Peters230a60c2002-11-09 05:08:07 +0000165
Nadeem Vawda55b43382011-05-27 01:52:15 +0200166 def testReadChunk10MultiStream(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200167 self.createTempFile(streams=5)
168 with BZ2File(self.filename) as bz2f:
169 text = b''
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200170 while True:
Nadeem Vawda55b43382011-05-27 01:52:15 +0200171 str = bz2f.read(10)
172 if not str:
173 break
174 text += str
175 self.assertEqual(text, self.TEXT * 5)
176
Tim Peters3de75262002-11-09 05:26:15 +0000177 def testRead100(self):
Tim Peters3de75262002-11-09 05:26:15 +0000178 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000179 with BZ2File(self.filename) as bz2f:
180 self.assertEqual(bz2f.read(100), self.TEXT[:100])
Tim Peters230a60c2002-11-09 05:08:07 +0000181
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200182 def testPeek(self):
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200183 self.createTempFile()
184 with BZ2File(self.filename) as bz2f:
185 pdata = bz2f.peek()
186 self.assertNotEqual(len(pdata), 0)
187 self.assertTrue(self.TEXT.startswith(pdata))
188 self.assertEqual(bz2f.read(), self.TEXT)
189
190 def testReadInto(self):
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200191 self.createTempFile()
192 with BZ2File(self.filename) as bz2f:
193 n = 128
194 b = bytearray(n)
195 self.assertEqual(bz2f.readinto(b), n)
196 self.assertEqual(b, self.TEXT[:n])
197 n = len(self.TEXT) - n
198 b = bytearray(len(self.TEXT))
199 self.assertEqual(bz2f.readinto(b), n)
200 self.assertEqual(b[:n], self.TEXT[-n:])
201
Tim Peters3de75262002-11-09 05:26:15 +0000202 def testReadLine(self):
Tim Peters3de75262002-11-09 05:26:15 +0000203 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000204 with BZ2File(self.filename) as bz2f:
205 self.assertRaises(TypeError, bz2f.readline, None)
Nadeem Vawda72e58652011-05-30 02:09:54 +0200206 for line in self.TEXT_LINES:
Brian Curtind2e948d2010-10-13 02:56:26 +0000207 self.assertEqual(bz2f.readline(), line)
Tim Peters230a60c2002-11-09 05:08:07 +0000208
Nadeem Vawda55b43382011-05-27 01:52:15 +0200209 def testReadLineMultiStream(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200210 self.createTempFile(streams=5)
211 with BZ2File(self.filename) as bz2f:
212 self.assertRaises(TypeError, bz2f.readline, None)
Nadeem Vawda72e58652011-05-30 02:09:54 +0200213 for line in self.TEXT_LINES * 5:
Nadeem Vawda55b43382011-05-27 01:52:15 +0200214 self.assertEqual(bz2f.readline(), line)
215
Tim Peters3de75262002-11-09 05:26:15 +0000216 def testReadLines(self):
Tim Peters3de75262002-11-09 05:26:15 +0000217 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000218 with BZ2File(self.filename) as bz2f:
219 self.assertRaises(TypeError, bz2f.readlines, None)
Nadeem Vawda72e58652011-05-30 02:09:54 +0200220 self.assertEqual(bz2f.readlines(), self.TEXT_LINES)
Tim Peters230a60c2002-11-09 05:08:07 +0000221
Nadeem Vawda55b43382011-05-27 01:52:15 +0200222 def testReadLinesMultiStream(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200223 self.createTempFile(streams=5)
224 with BZ2File(self.filename) as bz2f:
225 self.assertRaises(TypeError, bz2f.readlines, None)
Nadeem Vawda72e58652011-05-30 02:09:54 +0200226 self.assertEqual(bz2f.readlines(), self.TEXT_LINES * 5)
Nadeem Vawda55b43382011-05-27 01:52:15 +0200227
Tim Peters3de75262002-11-09 05:26:15 +0000228 def testIterator(self):
Tim Peters3de75262002-11-09 05:26:15 +0000229 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000230 with BZ2File(self.filename) as bz2f:
Nadeem Vawda72e58652011-05-30 02:09:54 +0200231 self.assertEqual(list(iter(bz2f)), self.TEXT_LINES)
Tim Peters230a60c2002-11-09 05:08:07 +0000232
Nadeem Vawda55b43382011-05-27 01:52:15 +0200233 def testIteratorMultiStream(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200234 self.createTempFile(streams=5)
235 with BZ2File(self.filename) as bz2f:
Nadeem Vawda72e58652011-05-30 02:09:54 +0200236 self.assertEqual(list(iter(bz2f)), self.TEXT_LINES * 5)
Nadeem Vawda55b43382011-05-27 01:52:15 +0200237
Georg Brandl86b2fb92008-07-16 03:43:04 +0000238 def testClosedIteratorDeadlock(self):
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200239 # Issue #3309: Iteration on a closed BZ2File should release the lock.
Georg Brandl86b2fb92008-07-16 03:43:04 +0000240 self.createTempFile()
241 bz2f = BZ2File(self.filename)
242 bz2f.close()
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200243 self.assertRaises(ValueError, next, bz2f)
244 # This call will deadlock if the above call failed to release the lock.
Georg Brandl86b2fb92008-07-16 03:43:04 +0000245 self.assertRaises(ValueError, bz2f.readlines)
246
Tim Peters3de75262002-11-09 05:26:15 +0000247 def testWrite(self):
Brian Curtind2e948d2010-10-13 02:56:26 +0000248 with BZ2File(self.filename, "w") as bz2f:
249 self.assertRaises(TypeError, bz2f.write)
250 bz2f.write(self.TEXT)
251 with open(self.filename, 'rb') as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200252 self.assertEqual(ext_decompress(f.read()), self.TEXT)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000253
Tim Peters3de75262002-11-09 05:26:15 +0000254 def testWriteChunks10(self):
Brian Curtind2e948d2010-10-13 02:56:26 +0000255 with BZ2File(self.filename, "w") as bz2f:
256 n = 0
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200257 while True:
Brian Curtind2e948d2010-10-13 02:56:26 +0000258 str = self.TEXT[n*10:(n+1)*10]
259 if not str:
260 break
261 bz2f.write(str)
262 n += 1
263 with open(self.filename, 'rb') as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200264 self.assertEqual(ext_decompress(f.read()), self.TEXT)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000265
Nadeem Vawda249ab5e2011-09-11 22:38:11 +0200266 def testWriteNonDefaultCompressLevel(self):
267 expected = bz2.compress(self.TEXT, compresslevel=5)
268 with BZ2File(self.filename, "w", compresslevel=5) as bz2f:
269 bz2f.write(self.TEXT)
270 with open(self.filename, "rb") as f:
271 self.assertEqual(f.read(), expected)
272
Tim Peters3de75262002-11-09 05:26:15 +0000273 def testWriteLines(self):
Brian Curtind2e948d2010-10-13 02:56:26 +0000274 with BZ2File(self.filename, "w") as bz2f:
275 self.assertRaises(TypeError, bz2f.writelines)
Nadeem Vawda72e58652011-05-30 02:09:54 +0200276 bz2f.writelines(self.TEXT_LINES)
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200277 # Issue #1535500: Calling writelines() on a closed BZ2File
278 # should raise an exception.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000279 self.assertRaises(ValueError, bz2f.writelines, ["a"])
Brian Curtind2e948d2010-10-13 02:56:26 +0000280 with open(self.filename, 'rb') as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200281 self.assertEqual(ext_decompress(f.read()), self.TEXT)
Tim Peters230a60c2002-11-09 05:08:07 +0000282
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000283 def testWriteMethodsOnReadOnlyFile(self):
Brian Curtind2e948d2010-10-13 02:56:26 +0000284 with BZ2File(self.filename, "w") as bz2f:
285 bz2f.write(b"abc")
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000286
Brian Curtind2e948d2010-10-13 02:56:26 +0000287 with BZ2File(self.filename, "r") as bz2f:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200288 self.assertRaises(OSError, bz2f.write, b"a")
289 self.assertRaises(OSError, bz2f.writelines, [b"a"])
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000290
Nadeem Vawda55b43382011-05-27 01:52:15 +0200291 def testAppend(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200292 with BZ2File(self.filename, "w") as bz2f:
293 self.assertRaises(TypeError, bz2f.write)
294 bz2f.write(self.TEXT)
295 with BZ2File(self.filename, "a") as bz2f:
296 self.assertRaises(TypeError, bz2f.write)
297 bz2f.write(self.TEXT)
298 with open(self.filename, 'rb') as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200299 self.assertEqual(ext_decompress(f.read()), self.TEXT * 2)
Nadeem Vawda55b43382011-05-27 01:52:15 +0200300
Tim Peters3de75262002-11-09 05:26:15 +0000301 def testSeekForward(self):
Tim Peters3de75262002-11-09 05:26:15 +0000302 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000303 with BZ2File(self.filename) as bz2f:
304 self.assertRaises(TypeError, bz2f.seek)
305 bz2f.seek(150)
306 self.assertEqual(bz2f.read(), self.TEXT[150:])
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000307
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200308 def testSeekForwardAcrossStreams(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200309 self.createTempFile(streams=2)
310 with BZ2File(self.filename) as bz2f:
311 self.assertRaises(TypeError, bz2f.seek)
312 bz2f.seek(len(self.TEXT) + 150)
313 self.assertEqual(bz2f.read(), self.TEXT[150:])
314
Tim Peters3de75262002-11-09 05:26:15 +0000315 def testSeekBackwards(self):
Tim Peters3de75262002-11-09 05:26:15 +0000316 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000317 with BZ2File(self.filename) as bz2f:
318 bz2f.read(500)
319 bz2f.seek(-150, 1)
320 self.assertEqual(bz2f.read(), self.TEXT[500-150:])
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000321
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200322 def testSeekBackwardsAcrossStreams(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200323 self.createTempFile(streams=2)
324 with BZ2File(self.filename) as bz2f:
325 readto = len(self.TEXT) + 100
326 while readto > 0:
327 readto -= len(bz2f.read(readto))
328 bz2f.seek(-150, 1)
329 self.assertEqual(bz2f.read(), self.TEXT[100-150:] + self.TEXT)
330
Tim Peters3de75262002-11-09 05:26:15 +0000331 def testSeekBackwardsFromEnd(self):
Tim Peters3de75262002-11-09 05:26:15 +0000332 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000333 with BZ2File(self.filename) as bz2f:
334 bz2f.seek(-150, 2)
335 self.assertEqual(bz2f.read(), self.TEXT[len(self.TEXT)-150:])
Tim Peters230a60c2002-11-09 05:08:07 +0000336
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200337 def testSeekBackwardsFromEndAcrossStreams(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200338 self.createTempFile(streams=2)
339 with BZ2File(self.filename) as bz2f:
340 bz2f.seek(-1000, 2)
341 self.assertEqual(bz2f.read(), (self.TEXT * 2)[-1000:])
342
Tim Peters3de75262002-11-09 05:26:15 +0000343 def testSeekPostEnd(self):
Tim Peters3de75262002-11-09 05:26:15 +0000344 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000345 with BZ2File(self.filename) as bz2f:
346 bz2f.seek(150000)
347 self.assertEqual(bz2f.tell(), len(self.TEXT))
348 self.assertEqual(bz2f.read(), b"")
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000349
Nadeem Vawda55b43382011-05-27 01:52:15 +0200350 def testSeekPostEndMultiStream(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200351 self.createTempFile(streams=5)
352 with BZ2File(self.filename) as bz2f:
353 bz2f.seek(150000)
354 self.assertEqual(bz2f.tell(), len(self.TEXT) * 5)
355 self.assertEqual(bz2f.read(), b"")
356
Tim Peters3de75262002-11-09 05:26:15 +0000357 def testSeekPostEndTwice(self):
Tim Peters3de75262002-11-09 05:26:15 +0000358 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000359 with BZ2File(self.filename) as bz2f:
360 bz2f.seek(150000)
361 bz2f.seek(150000)
362 self.assertEqual(bz2f.tell(), len(self.TEXT))
363 self.assertEqual(bz2f.read(), b"")
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000364
Nadeem Vawda55b43382011-05-27 01:52:15 +0200365 def testSeekPostEndTwiceMultiStream(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200366 self.createTempFile(streams=5)
367 with BZ2File(self.filename) as bz2f:
368 bz2f.seek(150000)
369 bz2f.seek(150000)
370 self.assertEqual(bz2f.tell(), len(self.TEXT) * 5)
371 self.assertEqual(bz2f.read(), b"")
372
Tim Peters3de75262002-11-09 05:26:15 +0000373 def testSeekPreStart(self):
Tim Peters3de75262002-11-09 05:26:15 +0000374 self.createTempFile()
Brian Curtind2e948d2010-10-13 02:56:26 +0000375 with BZ2File(self.filename) as bz2f:
376 bz2f.seek(-150)
377 self.assertEqual(bz2f.tell(), 0)
378 self.assertEqual(bz2f.read(), self.TEXT)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000379
Nadeem Vawda55b43382011-05-27 01:52:15 +0200380 def testSeekPreStartMultiStream(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200381 self.createTempFile(streams=2)
382 with BZ2File(self.filename) as bz2f:
383 bz2f.seek(-150)
384 self.assertEqual(bz2f.tell(), 0)
385 self.assertEqual(bz2f.read(), self.TEXT * 2)
386
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200387 def testFileno(self):
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200388 self.createTempFile()
Victor Stinner938f6352011-06-30 18:25:07 +0200389 with open(self.filename, 'rb') as rawf:
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200390 bz2f = BZ2File(rawf)
Nadeem Vawda44ae4a22011-11-30 17:39:30 +0200391 try:
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200392 self.assertEqual(bz2f.fileno(), rawf.fileno())
Nadeem Vawda44ae4a22011-11-30 17:39:30 +0200393 finally:
394 bz2f.close()
395 self.assertRaises(ValueError, bz2f.fileno)
396
397 def testSeekable(self):
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200398 bz2f = BZ2File(BytesIO(self.DATA))
Nadeem Vawda44ae4a22011-11-30 17:39:30 +0200399 try:
400 self.assertTrue(bz2f.seekable())
401 bz2f.read()
402 self.assertTrue(bz2f.seekable())
403 finally:
404 bz2f.close()
405 self.assertRaises(ValueError, bz2f.seekable)
406
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200407 bz2f = BZ2File(BytesIO(), "w")
Nadeem Vawda44ae4a22011-11-30 17:39:30 +0200408 try:
409 self.assertFalse(bz2f.seekable())
410 finally:
411 bz2f.close()
412 self.assertRaises(ValueError, bz2f.seekable)
413
Nadeem Vawdaae557d72012-02-12 01:51:38 +0200414 src = BytesIO(self.DATA)
415 src.seekable = lambda: False
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200416 bz2f = BZ2File(src)
Nadeem Vawdaae557d72012-02-12 01:51:38 +0200417 try:
418 self.assertFalse(bz2f.seekable())
419 finally:
420 bz2f.close()
421 self.assertRaises(ValueError, bz2f.seekable)
422
Nadeem Vawda44ae4a22011-11-30 17:39:30 +0200423 def testReadable(self):
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200424 bz2f = BZ2File(BytesIO(self.DATA))
Nadeem Vawda44ae4a22011-11-30 17:39:30 +0200425 try:
426 self.assertTrue(bz2f.readable())
427 bz2f.read()
428 self.assertTrue(bz2f.readable())
429 finally:
430 bz2f.close()
431 self.assertRaises(ValueError, bz2f.readable)
432
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200433 bz2f = BZ2File(BytesIO(), "w")
Nadeem Vawda44ae4a22011-11-30 17:39:30 +0200434 try:
435 self.assertFalse(bz2f.readable())
436 finally:
437 bz2f.close()
438 self.assertRaises(ValueError, bz2f.readable)
439
440 def testWritable(self):
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200441 bz2f = BZ2File(BytesIO(self.DATA))
Nadeem Vawda44ae4a22011-11-30 17:39:30 +0200442 try:
443 self.assertFalse(bz2f.writable())
444 bz2f.read()
445 self.assertFalse(bz2f.writable())
446 finally:
447 bz2f.close()
448 self.assertRaises(ValueError, bz2f.writable)
449
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200450 bz2f = BZ2File(BytesIO(), "w")
Nadeem Vawda44ae4a22011-11-30 17:39:30 +0200451 try:
452 self.assertTrue(bz2f.writable())
453 finally:
454 bz2f.close()
455 self.assertRaises(ValueError, bz2f.writable)
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200456
Neal Norwitz7cbd2472003-02-12 23:09:53 +0000457 def testOpenDel(self):
458 self.createTempFile()
Guido van Rossum805365e2007-05-07 22:24:25 +0000459 for i in range(10000):
Neal Norwitz7cbd2472003-02-12 23:09:53 +0000460 o = BZ2File(self.filename)
461 del o
462
Gustavo Niemeyer572f5232003-04-29 14:53:08 +0000463 def testOpenNonexistent(self):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200464 self.assertRaises(OSError, BZ2File, "/non/existent")
Gustavo Niemeyer572f5232003-04-29 14:53:08 +0000465
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200466 def testReadlinesNoNewline(self):
467 # Issue #1191043: readlines() fails on a file containing no newline.
Guido van Rossum522a6c62007-05-22 23:13:45 +0000468 data = b'BZh91AY&SY\xd9b\x89]\x00\x00\x00\x03\x80\x04\x00\x02\x00\x0c\x00 \x00!\x9ah3M\x13<]\xc9\x14\xe1BCe\x8a%t'
Brian Curtind2e948d2010-10-13 02:56:26 +0000469 with open(self.filename, "wb") as f:
470 f.write(data)
471 with BZ2File(self.filename) as bz2f:
472 lines = bz2f.readlines()
Guido van Rossum522a6c62007-05-22 23:13:45 +0000473 self.assertEqual(lines, [b'Test'])
Brian Curtind2e948d2010-10-13 02:56:26 +0000474 with BZ2File(self.filename) as bz2f:
475 xlines = list(bz2f.readlines())
Guido van Rossum522a6c62007-05-22 23:13:45 +0000476 self.assertEqual(xlines, [b'Test'])
Georg Brandl33a5f2a2005-08-21 14:16:04 +0000477
Antoine Pitrou308705e2009-01-10 16:22:51 +0000478 def testContextProtocol(self):
Antoine Pitrou308705e2009-01-10 16:22:51 +0000479 f = None
480 with BZ2File(self.filename, "wb") as f:
481 f.write(b"xxx")
482 f = BZ2File(self.filename, "rb")
483 f.close()
484 try:
485 with f:
486 pass
487 except ValueError:
488 pass
489 else:
490 self.fail("__enter__ on a closed file didn't raise an exception")
491 try:
492 with BZ2File(self.filename, "wb") as f:
493 1/0
494 except ZeroDivisionError:
495 pass
496 else:
497 self.fail("1/0 didn't raise an exception")
498
Antoine Pitrouc66363f2009-10-27 17:47:14 +0000499 def testThreading(self):
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200500 # Issue #7205: Using a BZ2File from several threads shouldn't deadlock.
Antoine Pitrouc66363f2009-10-27 17:47:14 +0000501 data = b"1" * 2**20
502 nthreads = 10
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200503 with BZ2File(self.filename, 'wb') as f:
Antoine Pitrouc66363f2009-10-27 17:47:14 +0000504 def comp():
505 for i in range(5):
506 f.write(data)
507 threads = [threading.Thread(target=comp) for i in range(nthreads)]
Hai Shie80697d2020-05-28 06:10:27 +0800508 with threading_helper.start_threads(threads):
Serhiy Storchaka263dcd22015-04-01 13:01:14 +0300509 pass
Antoine Pitrouc66363f2009-10-27 17:47:14 +0000510
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200511 def testMixedIterationAndReads(self):
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200512 self.createTempFile()
513 linelen = len(self.TEXT_LINES[0])
514 halflen = linelen // 2
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200515 with BZ2File(self.filename) as bz2f:
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200516 bz2f.read(halflen)
517 self.assertEqual(next(bz2f), self.TEXT_LINES[0][halflen:])
518 self.assertEqual(bz2f.read(), self.TEXT[linelen:])
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200519 with BZ2File(self.filename) as bz2f:
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200520 bz2f.readline()
521 self.assertEqual(next(bz2f), self.TEXT_LINES[1])
522 self.assertEqual(bz2f.readline(), self.TEXT_LINES[2])
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200523 with BZ2File(self.filename) as bz2f:
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200524 bz2f.readlines()
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200525 self.assertRaises(StopIteration, next, bz2f)
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200526 self.assertEqual(bz2f.readlines(), [])
527
Nadeem Vawdaf3ecb832011-05-30 01:58:12 +0200528 def testMultiStreamOrdering(self):
529 # Test the ordering of streams when reading a multi-stream archive.
530 data1 = b"foo" * 1000
531 data2 = b"bar" * 1000
532 with BZ2File(self.filename, "w") as bz2f:
533 bz2f.write(data1)
534 with BZ2File(self.filename, "a") as bz2f:
535 bz2f.write(data2)
536 with BZ2File(self.filename) as bz2f:
537 self.assertEqual(bz2f.read(), data1 + data2)
538
Nadeem Vawda10c87912012-06-20 01:48:50 +0200539 def testOpenBytesFilename(self):
540 str_filename = self.filename
541 try:
542 bytes_filename = str_filename.encode("ascii")
543 except UnicodeEncodeError:
544 self.skipTest("Temporary file name needs to be ASCII")
545 with BZ2File(bytes_filename, "wb") as f:
546 f.write(self.DATA)
547 with BZ2File(bytes_filename, "rb") as f:
548 self.assertEqual(f.read(), self.DATA)
549 # Sanity check that we are actually operating on the right file.
550 with BZ2File(str_filename, "rb") as f:
551 self.assertEqual(f.read(), self.DATA)
552
Berker Peksag8bdd4482016-10-02 20:07:06 +0300553 def testOpenPathLikeFilename(self):
554 filename = pathlib.Path(self.filename)
555 with BZ2File(filename, "wb") as f:
556 f.write(self.DATA)
557 with BZ2File(filename, "rb") as f:
558 self.assertEqual(f.read(), self.DATA)
559
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200560 def testDecompressLimited(self):
561 """Decompressed data buffering should be limited"""
Serhiy Storchaka5f1a5182016-09-11 14:41:02 +0300562 bomb = bz2.compress(b'\0' * int(2e6), compresslevel=9)
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200563 self.assertLess(len(bomb), _compression.BUFFER_SIZE)
564
565 decomp = BZ2File(BytesIO(bomb))
Serhiy Storchaka5f1a5182016-09-11 14:41:02 +0300566 self.assertEqual(decomp.read(1), b'\0')
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200567 max_decomp = 1 + DEFAULT_BUFFER_SIZE
568 self.assertLessEqual(decomp._buffer.raw.tell(), max_decomp,
569 "Excessive amount of data was decompressed")
570
Nadeem Vawda10c87912012-06-20 01:48:50 +0200571
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200572 # Tests for a BZ2File wrapping another file object:
573
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200574 def testReadBytesIO(self):
Nadeem Vawda07d291a2011-05-30 01:44:45 +0200575 with BytesIO(self.DATA) as bio:
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200576 with BZ2File(bio) as bz2f:
Antoine Pitrou2dbc6e62015-04-11 00:31:01 +0200577 self.assertRaises(TypeError, bz2f.read, float())
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200578 self.assertEqual(bz2f.read(), self.TEXT)
579 self.assertFalse(bio.closed)
580
581 def testPeekBytesIO(self):
Nadeem Vawda07d291a2011-05-30 01:44:45 +0200582 with BytesIO(self.DATA) as bio:
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200583 with BZ2File(bio) as bz2f:
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200584 pdata = bz2f.peek()
585 self.assertNotEqual(len(pdata), 0)
586 self.assertTrue(self.TEXT.startswith(pdata))
587 self.assertEqual(bz2f.read(), self.TEXT)
588
589 def testWriteBytesIO(self):
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200590 with BytesIO() as bio:
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200591 with BZ2File(bio, "w") as bz2f:
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200592 self.assertRaises(TypeError, bz2f.write)
593 bz2f.write(self.TEXT)
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200594 self.assertEqual(ext_decompress(bio.getvalue()), self.TEXT)
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200595 self.assertFalse(bio.closed)
596
597 def testSeekForwardBytesIO(self):
Nadeem Vawda07d291a2011-05-30 01:44:45 +0200598 with BytesIO(self.DATA) as bio:
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200599 with BZ2File(bio) as bz2f:
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200600 self.assertRaises(TypeError, bz2f.seek)
601 bz2f.seek(150)
602 self.assertEqual(bz2f.read(), self.TEXT[150:])
603
604 def testSeekBackwardsBytesIO(self):
Nadeem Vawda07d291a2011-05-30 01:44:45 +0200605 with BytesIO(self.DATA) as bio:
Nadeem Vawdaaebcdba2012-06-04 23:31:20 +0200606 with BZ2File(bio) as bz2f:
Antoine Pitrou37dc5f82011-04-03 17:05:46 +0200607 bz2f.read(500)
608 bz2f.seek(-150, 1)
609 self.assertEqual(bz2f.read(), self.TEXT[500-150:])
Georg Brandl33a5f2a2005-08-21 14:16:04 +0000610
Serhiy Storchaka7c3922f2013-01-22 17:01:59 +0200611 def test_read_truncated(self):
612 # Drop the eos_magic field (6 bytes) and CRC (4 bytes).
613 truncated = self.DATA[:-10]
Serhiy Storchaka57f9b7a2013-01-22 17:07:49 +0200614 with BZ2File(BytesIO(truncated)) as f:
Serhiy Storchaka7c3922f2013-01-22 17:01:59 +0200615 self.assertRaises(EOFError, f.read)
Serhiy Storchaka57f9b7a2013-01-22 17:07:49 +0200616 with BZ2File(BytesIO(truncated)) as f:
Serhiy Storchaka7c3922f2013-01-22 17:01:59 +0200617 self.assertEqual(f.read(len(self.TEXT)), self.TEXT)
618 self.assertRaises(EOFError, f.read, 1)
619 # Incomplete 4-byte file header, and block header of at least 146 bits.
620 for i in range(22):
Serhiy Storchaka57f9b7a2013-01-22 17:07:49 +0200621 with BZ2File(BytesIO(truncated[:i])) as f:
Serhiy Storchaka7c3922f2013-01-22 17:01:59 +0200622 self.assertRaises(EOFError, f.read, 1)
623
Miss Islington (bot)01858fb2021-06-22 06:59:53 -0700624 def test_issue44439(self):
625 q = array.array('Q', [1, 2, 3, 4, 5])
626 LENGTH = len(q) * q.itemsize
627
628 with BZ2File(BytesIO(), 'w') as f:
629 self.assertEqual(f.write(q), LENGTH)
630 self.assertEqual(f.tell(), LENGTH)
631
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200632
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000633class BZ2CompressorTest(BaseTest):
Tim Peters3de75262002-11-09 05:26:15 +0000634 def testCompress(self):
Tim Peters3de75262002-11-09 05:26:15 +0000635 bz2c = BZ2Compressor()
Walter Dörwaldbb9c7392004-11-01 17:10:19 +0000636 self.assertRaises(TypeError, bz2c.compress)
Tim Peters3de75262002-11-09 05:26:15 +0000637 data = bz2c.compress(self.TEXT)
638 data += bz2c.flush()
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200639 self.assertEqual(ext_decompress(data), self.TEXT)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000640
Nadeem Vawda638fb9b2013-01-02 23:02:00 +0100641 def testCompressEmptyString(self):
642 bz2c = BZ2Compressor()
643 data = bz2c.compress(b'')
644 data += bz2c.flush()
645 self.assertEqual(data, self.EMPTY_DATA)
646
Tim Peters3de75262002-11-09 05:26:15 +0000647 def testCompressChunks10(self):
Tim Peters3de75262002-11-09 05:26:15 +0000648 bz2c = BZ2Compressor()
649 n = 0
Guido van Rossum522a6c62007-05-22 23:13:45 +0000650 data = b''
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200651 while True:
Tim Peters3de75262002-11-09 05:26:15 +0000652 str = self.TEXT[n*10:(n+1)*10]
653 if not str:
654 break
655 data += bz2c.compress(str)
656 n += 1
657 data += bz2c.flush()
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200658 self.assertEqual(ext_decompress(data), self.TEXT)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000659
Neil Schemenauer52a48e62019-07-30 11:08:18 -0700660 @support.skip_if_pgo_task
Antoine Pitrou1a3ff482011-10-04 10:28:37 +0200661 @bigmemtest(size=_4G + 100, memuse=2)
Nadeem Vawdaea4b46f2011-04-12 23:02:42 +0200662 def testCompress4G(self, size):
663 # "Test BZ2Compressor.compress()/flush() with >4GiB input"
664 bz2c = BZ2Compressor()
665 data = b"x" * size
666 try:
667 compressed = bz2c.compress(data)
668 compressed += bz2c.flush()
669 finally:
670 data = None # Release memory
671 data = bz2.decompress(compressed)
672 try:
673 self.assertEqual(len(data), size)
674 self.assertEqual(len(data.strip(b"x")), 0)
675 finally:
676 data = None
677
Nadeem Vawda37970652013-10-28 21:35:23 +0100678 def testPickle(self):
Serhiy Storchakabad12572014-12-15 14:03:42 +0200679 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
680 with self.assertRaises(TypeError):
681 pickle.dumps(BZ2Compressor(), proto)
Nadeem Vawda37970652013-10-28 21:35:23 +0100682
683
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000684class BZ2DecompressorTest(BaseTest):
Walter Dörwaldbb9c7392004-11-01 17:10:19 +0000685 def test_Constructor(self):
686 self.assertRaises(TypeError, BZ2Decompressor, 42)
687
Tim Peters3de75262002-11-09 05:26:15 +0000688 def testDecompress(self):
Tim Peters3de75262002-11-09 05:26:15 +0000689 bz2d = BZ2Decompressor()
Walter Dörwaldbb9c7392004-11-01 17:10:19 +0000690 self.assertRaises(TypeError, bz2d.decompress)
Tim Peters3de75262002-11-09 05:26:15 +0000691 text = bz2d.decompress(self.DATA)
692 self.assertEqual(text, self.TEXT)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000693
Tim Peters3de75262002-11-09 05:26:15 +0000694 def testDecompressChunks10(self):
Tim Peters3de75262002-11-09 05:26:15 +0000695 bz2d = BZ2Decompressor()
Guido van Rossum522a6c62007-05-22 23:13:45 +0000696 text = b''
Tim Peters3de75262002-11-09 05:26:15 +0000697 n = 0
Nadeem Vawda98838ba2011-05-30 01:12:24 +0200698 while True:
Tim Peters3de75262002-11-09 05:26:15 +0000699 str = self.DATA[n*10:(n+1)*10]
700 if not str:
701 break
702 text += bz2d.decompress(str)
703 n += 1
704 self.assertEqual(text, self.TEXT)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000705
Tim Peters3de75262002-11-09 05:26:15 +0000706 def testDecompressUnusedData(self):
Tim Peters3de75262002-11-09 05:26:15 +0000707 bz2d = BZ2Decompressor()
Guido van Rossum522a6c62007-05-22 23:13:45 +0000708 unused_data = b"this is unused data"
Tim Peters3de75262002-11-09 05:26:15 +0000709 text = bz2d.decompress(self.DATA+unused_data)
710 self.assertEqual(text, self.TEXT)
711 self.assertEqual(bz2d.unused_data, unused_data)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000712
Tim Peters3de75262002-11-09 05:26:15 +0000713 def testEOFError(self):
Tim Peters3de75262002-11-09 05:26:15 +0000714 bz2d = BZ2Decompressor()
715 text = bz2d.decompress(self.DATA)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000716 self.assertRaises(EOFError, bz2d.decompress, b"anything")
Nadeem Vawdaa1952d42012-10-28 15:20:48 +0100717 self.assertRaises(EOFError, bz2d.decompress, b"")
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000718
Neil Schemenauer52a48e62019-07-30 11:08:18 -0700719 @support.skip_if_pgo_task
Serhiy Storchaka4847e4e2014-01-10 13:37:54 +0200720 @bigmemtest(size=_4G + 100, memuse=3.3)
Nadeem Vawdaea4b46f2011-04-12 23:02:42 +0200721 def testDecompress4G(self, size):
722 # "Test BZ2Decompressor.decompress() with >4GiB input"
723 blocksize = 10 * 1024 * 1024
Victor Stinner87502dd2020-04-17 22:54:38 +0200724 block = random.randbytes(blocksize)
Nadeem Vawdaea4b46f2011-04-12 23:02:42 +0200725 try:
726 data = block * (size // blocksize + 1)
727 compressed = bz2.compress(data)
728 bz2d = BZ2Decompressor()
729 decompressed = bz2d.decompress(compressed)
730 self.assertTrue(decompressed == data)
731 finally:
732 data = None
733 compressed = None
734 decompressed = None
735
Nadeem Vawda37970652013-10-28 21:35:23 +0100736 def testPickle(self):
Serhiy Storchakabad12572014-12-15 14:03:42 +0200737 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
738 with self.assertRaises(TypeError):
739 pickle.dumps(BZ2Decompressor(), proto)
Nadeem Vawda37970652013-10-28 21:35:23 +0100740
Antoine Pitroue71258a2015-02-26 13:08:07 +0100741 def testDecompressorChunksMaxsize(self):
742 bzd = BZ2Decompressor()
743 max_length = 100
744 out = []
745
746 # Feed some input
747 len_ = len(self.BIG_DATA) - 64
748 out.append(bzd.decompress(self.BIG_DATA[:len_],
749 max_length=max_length))
750 self.assertFalse(bzd.needs_input)
751 self.assertEqual(len(out[-1]), max_length)
752
753 # Retrieve more data without providing more input
754 out.append(bzd.decompress(b'', max_length=max_length))
755 self.assertFalse(bzd.needs_input)
756 self.assertEqual(len(out[-1]), max_length)
757
758 # Retrieve more data while providing more input
759 out.append(bzd.decompress(self.BIG_DATA[len_:],
760 max_length=max_length))
761 self.assertLessEqual(len(out[-1]), max_length)
762
763 # Retrieve remaining uncompressed data
764 while not bzd.eof:
765 out.append(bzd.decompress(b'', max_length=max_length))
766 self.assertLessEqual(len(out[-1]), max_length)
767
768 out = b"".join(out)
769 self.assertEqual(out, self.BIG_TEXT)
770 self.assertEqual(bzd.unused_data, b"")
771
772 def test_decompressor_inputbuf_1(self):
773 # Test reusing input buffer after moving existing
774 # contents to beginning
775 bzd = BZ2Decompressor()
776 out = []
777
778 # Create input buffer and fill it
779 self.assertEqual(bzd.decompress(self.DATA[:100],
780 max_length=0), b'')
781
782 # Retrieve some results, freeing capacity at beginning
783 # of input buffer
784 out.append(bzd.decompress(b'', 2))
785
786 # Add more data that fits into input buffer after
787 # moving existing data to beginning
788 out.append(bzd.decompress(self.DATA[100:105], 15))
789
790 # Decompress rest of data
791 out.append(bzd.decompress(self.DATA[105:]))
792 self.assertEqual(b''.join(out), self.TEXT)
793
794 def test_decompressor_inputbuf_2(self):
795 # Test reusing input buffer by appending data at the
796 # end right away
797 bzd = BZ2Decompressor()
798 out = []
799
800 # Create input buffer and empty it
801 self.assertEqual(bzd.decompress(self.DATA[:200],
802 max_length=0), b'')
803 out.append(bzd.decompress(b''))
804
805 # Fill buffer with new data
806 out.append(bzd.decompress(self.DATA[200:280], 2))
807
808 # Append some more data, not enough to require resize
809 out.append(bzd.decompress(self.DATA[280:300], 2))
810
811 # Decompress rest of data
812 out.append(bzd.decompress(self.DATA[300:]))
813 self.assertEqual(b''.join(out), self.TEXT)
814
815 def test_decompressor_inputbuf_3(self):
816 # Test reusing input buffer after extending it
817
818 bzd = BZ2Decompressor()
819 out = []
820
821 # Create almost full input buffer
822 out.append(bzd.decompress(self.DATA[:200], 5))
823
824 # Add even more data to it, requiring resize
825 out.append(bzd.decompress(self.DATA[200:300], 5))
826
827 # Decompress rest of data
828 out.append(bzd.decompress(self.DATA[300:]))
829 self.assertEqual(b''.join(out), self.TEXT)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000830
Martin Panter38317d32016-10-01 02:45:17 +0000831 def test_failure(self):
832 bzd = BZ2Decompressor()
833 self.assertRaises(Exception, bzd.decompress, self.BAD_DATA * 30)
834 # Previously, a second call could crash due to internal inconsistency
835 self.assertRaises(Exception, bzd.decompress, self.BAD_DATA * 30)
836
Oren Milmand019bc82018-02-13 12:28:33 +0200837 @support.refcount_test
838 def test_refleaks_in___init__(self):
839 gettotalrefcount = support.get_attribute(sys, 'gettotalrefcount')
840 bzd = BZ2Decompressor()
841 refs_before = gettotalrefcount()
842 for i in range(100):
843 bzd.__init__()
844 self.assertAlmostEqual(gettotalrefcount() - refs_before, 0, delta=10)
845
846
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200847class CompressDecompressTest(BaseTest):
Tim Peters3de75262002-11-09 05:26:15 +0000848 def testCompress(self):
Tim Peters499d09a2002-11-09 06:31:56 +0000849 data = bz2.compress(self.TEXT)
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200850 self.assertEqual(ext_decompress(data), self.TEXT)
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000851
Nadeem Vawda638fb9b2013-01-02 23:02:00 +0100852 def testCompressEmptyString(self):
853 text = bz2.compress(b'')
854 self.assertEqual(text, self.EMPTY_DATA)
855
Tim Peters3de75262002-11-09 05:26:15 +0000856 def testDecompress(self):
Tim Peters499d09a2002-11-09 06:31:56 +0000857 text = bz2.decompress(self.DATA)
Tim Peters3de75262002-11-09 05:26:15 +0000858 self.assertEqual(text, self.TEXT)
Tim Peters230a60c2002-11-09 05:08:07 +0000859
Tim Peters3de75262002-11-09 05:26:15 +0000860 def testDecompressEmpty(self):
Guido van Rossum522a6c62007-05-22 23:13:45 +0000861 text = bz2.decompress(b"")
862 self.assertEqual(text, b"")
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000863
Nadeem Vawda638fb9b2013-01-02 23:02:00 +0100864 def testDecompressToEmptyString(self):
865 text = bz2.decompress(self.EMPTY_DATA)
866 self.assertEqual(text, b'')
867
Tim Peters3de75262002-11-09 05:26:15 +0000868 def testDecompressIncomplete(self):
Tim Peters499d09a2002-11-09 06:31:56 +0000869 self.assertRaises(ValueError, bz2.decompress, self.DATA[:-10])
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +0000870
Nadeem Vawda1de19ac2013-12-04 23:01:15 +0100871 def testDecompressBadData(self):
872 self.assertRaises(OSError, bz2.decompress, self.BAD_DATA)
873
Nadeem Vawda55b43382011-05-27 01:52:15 +0200874 def testDecompressMultiStream(self):
Nadeem Vawda55b43382011-05-27 01:52:15 +0200875 text = bz2.decompress(self.DATA * 5)
876 self.assertEqual(text, self.TEXT * 5)
877
Nadeem Vawda1de19ac2013-12-04 23:01:15 +0100878 def testDecompressTrailingJunk(self):
879 text = bz2.decompress(self.DATA + self.BAD_DATA)
880 self.assertEqual(text, self.TEXT)
881
882 def testDecompressMultiStreamTrailingJunk(self):
883 text = bz2.decompress(self.DATA * 5 + self.BAD_DATA)
884 self.assertEqual(text, self.TEXT * 5)
885
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200886
887class OpenTest(BaseTest):
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200888 "Test the open function."
889
890 def open(self, *args, **kwargs):
891 return bz2.open(*args, **kwargs)
892
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200893 def test_binary_modes(self):
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200894 for mode in ("wb", "xb"):
895 if mode == "xb":
896 unlink(self.filename)
897 with self.open(self.filename, mode) as f:
898 f.write(self.TEXT)
899 with open(self.filename, "rb") as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200900 file_data = ext_decompress(f.read())
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200901 self.assertEqual(file_data, self.TEXT)
902 with self.open(self.filename, "rb") as f:
903 self.assertEqual(f.read(), self.TEXT)
904 with self.open(self.filename, "ab") as f:
905 f.write(self.TEXT)
906 with open(self.filename, "rb") as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200907 file_data = ext_decompress(f.read())
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200908 self.assertEqual(file_data, self.TEXT * 2)
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200909
910 def test_implicit_binary_modes(self):
911 # Test implicit binary modes (no "b" or "t" in mode string).
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200912 for mode in ("w", "x"):
913 if mode == "x":
914 unlink(self.filename)
915 with self.open(self.filename, mode) as f:
916 f.write(self.TEXT)
917 with open(self.filename, "rb") as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200918 file_data = ext_decompress(f.read())
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200919 self.assertEqual(file_data, self.TEXT)
920 with self.open(self.filename, "r") as f:
921 self.assertEqual(f.read(), self.TEXT)
922 with self.open(self.filename, "a") as f:
923 f.write(self.TEXT)
924 with open(self.filename, "rb") as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200925 file_data = ext_decompress(f.read())
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200926 self.assertEqual(file_data, self.TEXT * 2)
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200927
928 def test_text_modes(self):
929 text = self.TEXT.decode("ascii")
930 text_native_eol = text.replace("\n", os.linesep)
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200931 for mode in ("wt", "xt"):
932 if mode == "xt":
933 unlink(self.filename)
Inada Naoki35715d12021-04-04 09:01:23 +0900934 with self.open(self.filename, mode, encoding="ascii") as f:
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200935 f.write(text)
936 with open(self.filename, "rb") as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200937 file_data = ext_decompress(f.read()).decode("ascii")
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200938 self.assertEqual(file_data, text_native_eol)
Inada Naoki35715d12021-04-04 09:01:23 +0900939 with self.open(self.filename, "rt", encoding="ascii") as f:
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200940 self.assertEqual(f.read(), text)
Inada Naoki35715d12021-04-04 09:01:23 +0900941 with self.open(self.filename, "at", encoding="ascii") as f:
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200942 f.write(text)
943 with open(self.filename, "rb") as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200944 file_data = ext_decompress(f.read()).decode("ascii")
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200945 self.assertEqual(file_data, text_native_eol * 2)
946
947 def test_x_mode(self):
948 for mode in ("x", "xb", "xt"):
949 unlink(self.filename)
Inada Naoki35715d12021-04-04 09:01:23 +0900950 encoding = "utf-8" if "t" in mode else None
951 with self.open(self.filename, mode, encoding=encoding) as f:
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200952 pass
953 with self.assertRaises(FileExistsError):
954 with self.open(self.filename, mode) as f:
955 pass
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200956
957 def test_fileobj(self):
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200958 with self.open(BytesIO(self.DATA), "r") as f:
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200959 self.assertEqual(f.read(), self.TEXT)
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200960 with self.open(BytesIO(self.DATA), "rb") as f:
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200961 self.assertEqual(f.read(), self.TEXT)
962 text = self.TEXT.decode("ascii")
Inada Naoki35715d12021-04-04 09:01:23 +0900963 with self.open(BytesIO(self.DATA), "rt", encoding="utf-8") as f:
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200964 self.assertEqual(f.read(), text)
965
966 def test_bad_params(self):
967 # Test invalid parameter combinations.
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200968 self.assertRaises(ValueError,
969 self.open, self.filename, "wbt")
970 self.assertRaises(ValueError,
Nadeem Vawda8a9e99c2013-10-19 00:11:06 +0200971 self.open, self.filename, "xbt")
972 self.assertRaises(ValueError,
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200973 self.open, self.filename, "rb", encoding="utf-8")
974 self.assertRaises(ValueError,
975 self.open, self.filename, "rb", errors="ignore")
976 self.assertRaises(ValueError,
977 self.open, self.filename, "rb", newline="\n")
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200978
979 def test_encoding(self):
980 # Test non-default encoding.
981 text = self.TEXT.decode("ascii")
982 text_native_eol = text.replace("\n", os.linesep)
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200983 with self.open(self.filename, "wt", encoding="utf-16-le") as f:
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200984 f.write(text)
985 with open(self.filename, "rb") as f:
Serhiy Storchaka5adc22b2016-11-11 17:10:24 +0200986 file_data = ext_decompress(f.read()).decode("utf-16-le")
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200987 self.assertEqual(file_data, text_native_eol)
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200988 with self.open(self.filename, "rt", encoding="utf-16-le") as f:
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200989 self.assertEqual(f.read(), text)
990
991 def test_encoding_error_handler(self):
992 # Test with non-default encoding error handler.
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200993 with self.open(self.filename, "wb") as f:
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200994 f.write(b"foo\xffbar")
Nadeem Vawda3b4a4f52012-10-08 19:20:49 +0200995 with self.open(self.filename, "rt", encoding="ascii", errors="ignore") \
Nadeem Vawdaaf518c12012-06-04 23:32:38 +0200996 as f:
997 self.assertEqual(f.read(), "foobar")
998
999 def test_newline(self):
1000 # Test with explicit newline (universal newline mode disabled).
1001 text = self.TEXT.decode("ascii")
Inada Naoki35715d12021-04-04 09:01:23 +09001002 with self.open(self.filename, "wt", encoding="utf-8", newline="\n") as f:
Nadeem Vawdaaf518c12012-06-04 23:32:38 +02001003 f.write(text)
Inada Naoki35715d12021-04-04 09:01:23 +09001004 with self.open(self.filename, "rt", encoding="utf-8", newline="\r") as f:
Nadeem Vawdaaf518c12012-06-04 23:32:38 +02001005 self.assertEqual(f.readlines(), [text])
1006
1007
Serhiy Storchakabedce352021-09-19 22:36:03 +03001008def tearDownModule():
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001009 support.reap_children()
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +00001010
Serhiy Storchakabedce352021-09-19 22:36:03 +03001011
Gustavo Niemeyerf8ca8362002-11-05 16:50:05 +00001012if __name__ == '__main__':
Serhiy Storchakabedce352021-09-19 22:36:03 +03001013 unittest.main()