Skip to content

Commit

Permalink
bpo-40105: ZipFile truncate in append mode with shorter comment (pyth…
Browse files Browse the repository at this point in the history
…onGH-19337)

(cherry picked from commit ff9147d)

Co-authored-by: Jan Mazur <16736821+mzr@users.noreply.github.com>
  • Loading branch information
miss-islington and mzr committed Sep 28, 2020
1 parent bdf46bc commit 048f54d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Lib/test/test_zipfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -1855,11 +1855,14 @@ def test_comments(self):
self.assertEqual(zipf.comment, b"an updated comment")

# check that comments are correctly shortened in append mode
# and the file is indeed truncated
with zipfile.ZipFile(TESTFN,mode="w") as zipf:
zipf.comment = b"original comment that's longer"
zipf.writestr("foo.txt", "O, for a Muse of Fire!")
original_zip_size = os.path.getsize(TESTFN)
with zipfile.ZipFile(TESTFN,mode="a") as zipf:
zipf.comment = b"shorter comment"
self.assertTrue(original_zip_size > os.path.getsize(TESTFN))
with zipfile.ZipFile(TESTFN,mode="r") as zipf:
self.assertEqual(zipf.comment, b"shorter comment")

Expand Down
2 changes: 2 additions & 0 deletions Lib/zipfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -1918,6 +1918,8 @@ def _write_end_record(self):
centDirSize, centDirOffset, len(self._comment))
self.fp.write(endrec)
self.fp.write(self._comment)
if self.mode == "a":
self.fp.truncate()
self.fp.flush()

def _fpclose(self, fp):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
ZipFile truncates files to avoid corruption when a shorter comment is provided
in append ("a") mode. Patch by Jan Mazur.

0 comments on commit 048f54d

Please sign in to comment.