Skip to content

[3.9] bpo-44439: BZ2File.write()/LZMAFile.write() handle length correctly #26846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from Jun 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions Lib/bz2.py
Original file line number Diff line number Diff line change
Expand Up @@ -226,15 +226,23 @@ def write(self, data):
"""Write a byte string to the file.

Returns the number of uncompressed bytes written, which is
always len(data). Note that due to buffering, the file on disk
may not reflect the data written until close() is called.
always the length of data in bytes. Note that due to buffering,
the file on disk may not reflect the data written until close()
is called.
"""
with self._lock:
self._check_can_write()
if isinstance(data, (bytes, bytearray)):
length = len(data)
else:
# accept any data that supports the buffer protocol
data = memoryview(data)
length = data.nbytes

compressed = self._compressor.compress(data)
self._fp.write(compressed)
self._pos += len(data)
return len(data)
self._pos += length
return length

def writelines(self, seq):
"""Write a sequence of byte strings to the file.
Expand Down
16 changes: 12 additions & 4 deletions Lib/lzma.py
Original file line number Diff line number Diff line change
Expand Up @@ -225,14 +225,22 @@ def write(self, data):
"""Write a bytes object to the file.

Returns the number of uncompressed bytes written, which is
always len(data). Note that due to buffering, the file on disk
may not reflect the data written until close() is called.
always the length of data in bytes. Note that due to buffering,
the file on disk may not reflect the data written until close()
is called.
"""
self._check_can_write()
if isinstance(data, (bytes, bytearray)):
length = len(data)
else:
# accept any data that supports the buffer protocol
data = memoryview(data)
length = data.nbytes

compressed = self._compressor.compress(data)
self._fp.write(compressed)
self._pos += len(data)
return len(data)
self._pos += length
return length

def seek(self, offset, whence=io.SEEK_SET):
"""Change the file position.
Expand Down
9 changes: 9 additions & 0 deletions Lib/test/test_bz2.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from test import support
from test.support import bigmemtest, _4G

import array
import unittest
from io import BytesIO, DEFAULT_BUFFER_SIZE
import os
Expand Down Expand Up @@ -618,6 +619,14 @@ def test_read_truncated(self):
with BZ2File(BytesIO(truncated[:i])) as f:
self.assertRaises(EOFError, f.read, 1)

def test_issue44439(self):
q = array.array('Q', [1, 2, 3, 4, 5])
LENGTH = len(q) * q.itemsize

with BZ2File(BytesIO(), 'w') as f:
self.assertEqual(f.write(q), LENGTH)
self.assertEqual(f.tell(), LENGTH)


class BZ2CompressorTest(BaseTest):
def testCompress(self):
Expand Down
9 changes: 9 additions & 0 deletions Lib/test/test_lzma.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import _compression
import array
from io import BytesIO, UnsupportedOperation, DEFAULT_BUFFER_SIZE
import os
import pathlib
Expand Down Expand Up @@ -1227,6 +1228,14 @@ def test_issue21872(self):
self.assertTrue(d2.eof)
self.assertEqual(out1 + out2, entire)

def test_issue44439(self):
q = array.array('Q', [1, 2, 3, 4, 5])
LENGTH = len(q) * q.itemsize

with LZMAFile(BytesIO(), 'w') as f:
self.assertEqual(f.write(q), LENGTH)
self.assertEqual(f.tell(), LENGTH)


class OpenTestCase(unittest.TestCase):

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fix in :meth:`bz2.BZ2File.write` / :meth:`lzma.LZMAFile.write` methods, when
the input data is an object that supports the buffer protocol, the file length
may be wrong.