gh-51067: Add remove() in ZipInfo by yudilevi2 · Pull Request #19358 · python/cpython · GitHub

Issue: remove/delete method for zipfile objects #51067

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@nergall2

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

This addition would be useful for my projects. Thanks!

I think this should change should include unit tests in https://github.com/python/cpython/blob/master/Lib/test/test_zipfile.py -- perhaps a test to remove a middle entry and one to remove the last entry in a zip file.

Does removing an entry truncate the zipfile to the new file length? If not, should it? Either way, a comment in the code and a test for verification would be helpful too.

Does this code work on both 32-bit and 64-bit zip files?

@yudilevi2, please sign the CLA as requested in the comment from @the-knights-who-say-ni . Thank you!

@csabella done

Hi @yudilevi2, thanks for contributing to Python!

It looks like you signed the CLA but @the-knights-who-say-ni cannot find it. Can you make sure that you your GitHub username is listed in your details on https://bugs.python.org (https://cloud.githubusercontent.com/assets/2680980/23276970/d14a380c-f9d1-11e6-883d-e13b6b211239.png)?

Also to be accepted, this change will need some tests and documentation.

This change will also require a NEWS entry, you can add one by using https://blurb-it.herokuapp.com/

@yudilevi2, it seems that you haven't created a user on bugs.python.org (or if you have, then I can't find it.) For our CLA bot to recognize your signature you'll have to have a user there. See the above comments for links with more details.

Sorry for requiring this bureaucracy, but please just let us know if you run into any trouble or would like more help with this.

hey @taleinat my username there is yudilevi

@yudilevi2, on b.p.o. the username yudilevi has a different GitHub username configured. That's likely why, for this PR, our bot isn't picking up on the fact that you've signed the CLA.

It seems that your options are:

Change the GitHub user associated with your b.p.o. account to "yudilevi2"
Create a new "yudilevi2" user on b.p.o., associate it with your yudilevi2 GitHub username, and sign the CLA again with that account.

Could we get an update on this? Is it just being held back by the CLA?

Sorry, there has been some confusion because I renamed the account. I did sign the CLA multiple times already so it should be good but I'm not sure it's all been registered correctly. How do I check?

…

On Thu, Jan 21, 2021 at 4:04 AM Peter DeVita ***@***.***> wrote: Could we get an update on this? Is it just being held back by the CLA? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#19358 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/APBPVNVUAUZOTQ5FZZKTNC3S26RV3ANCNFSM4L542K3Q> .

Sorry, there has been some confusion because I renamed the account. I did sign the CLA multiple times already so it should be good but I'm not sure it's all been registered correctly. How do I check?

@yudilevi2 Checking here https://check-python-cla.herokuapp.com/ says you don't have an account associated with your Github account.

Was there any progress on this?

Hi @yudilevi2, thanks for contributing to Python!

It looks like you signed the CLA but @the-knights-who-say-ni cannot find it. Can you make sure that you your GitHub username is listed in your details on https://bugs.python.org (https://cloud.githubusercontent.com/assets/2680980/23276970/d14a380c-f9d1-11e6-883d-e13b6b211239.png)?

Also to be accepted, this change will need some tests and documentation.

This change will also require a NEWS entry, you can add one by using https://blurb-it.herokuapp.com/

Sorry for the mess, the correct github name is now updated in my python bugs profile.

As to progress, nothing yet on my end, can't find the time to dig into the code/flows yet in order to write proper tests, will try to get to it soon.

Since this has gotten a bit stuck, I'm just chiming in to share that I came here while researching a legislative proposal to generate massive bulk data files of American legal documents. One of the sticking points I anticipate with the proposal to create bulk files is that sealed content will need to occasionally be removed from them. Currently, doing so with Python requires decompressing the zip, removing a file, and then recompressing it (doing it with the zip CLI tool would work sans Python).

All this to say, I'm excited to see this PR and hope it can move forward. Thank you all.

I hope this remove() get merge soon.

As mentioned, it will not get merged without tests and documentation.

Is there anything in zipfile spec which says the header offsets have to be contiguous?

It doesn't matter anyway. The implementation moves all bytes between the start of a section and the start of the next section. If there were to be random bytes between the end of a section and the start of the next section, they will be moved too.

This is unsafe. The ZipInfo instances in self.filelist will not compare equal with this zinfo even if the filename is matching - they compare by identity.

Additionally, if remove is able to accept a ZipInfo instance, then there needs to be handling of the possibility that the instance is not present in the zipfile at all.

I recommend to document that member is a string, and then use self.getinfo(member), avoiding these issues.

Comparing by identity when passing a zinfo is a feature and is consistent to the behavior of writestr etc. I don't think this need to change.

It actually is a problem if the zinfo/filename does not exist in the zipfile at all, my revision has added a check to prevent that.

The following commit authors need to sign the Contributor License Agreement:

63109814+nergall2@users.noreply.github.com

Would something like this be accepted with minimal design debate if:

tests
news
rebased
cla signed
it worked in "w" mode, and actually truncated
it correctly grabbed the pseudo-lock _writing to prevent concurrent writes
it errored if removed count != 1 [to also catch the duplicate-filename ambiguity]

or are there questions we should settle first?

Would something like this be accepted with minimal design debate if:

After reading the discussion here and in the related issue, I think so, yes. But I'm not an expert on this module, and it would be best to get an opinion from someone who is. @serhiy-storchaka, @Yhg1s, @gpshead?

This is a revision of commit 659eb04 (PR python#19358), notably with following changes: - Add documentation and tests. - Raise `ValueError` for a bad mode, as in other methods. - Support multi-member removal in `_remove_members()`. - Support non-physical removal in `_remove_members()`. - Move physical file data in chunks to prevent excessive memory usage on large files. - Fix missing entry in `self.NameToInfo` when removing a duplicated archive name. - Also update `ZipInfo._end_offset` for physically moved files. Co-authored-by: Éric <merwok@netwok.org> (cherry picked from commit e6bc82a (PR python#103033))

This PR is stale because it has been open for 30 days with no activity.

#134627 implemented a version of this.

enhancement-40175: Add remove() in ZipInfo

659eb04

the-knights-who-say-ni added the CLA not signed label Apr 4, 2020

bedevere-bot added the awaiting review label Apr 4, 2020

yudilevi2 mentioned this pull request Apr 4, 2020

bpo-6818: Add remove() in ZipInfo #19336

Closed

yudilevi2 changed the title enhancement-6818: Add remove() in ZipInfo enhancement 6818: Add remove() in ZipInfo Apr 4, 2020

yudilevi2 changed the title enhancement 6818: Add remove() in ZipInfo bpo-6818: Add remove() in ZipInfo Apr 4, 2020

csabella requested review from Yhg1s and serhiy-storchaka May 22, 2020 20:10

csabella removed the CLA not signed label May 22, 2020

the-knights-who-say-ni added the CLA not signed label May 22, 2020

csabella removed the CLA not signed label May 26, 2020

the-knights-who-say-ni added the CLA not signed label May 26, 2020

csabella removed the CLA not signed label May 28, 2020

the-knights-who-say-ni added the CLA not signed label May 28, 2020

csabella removed the CLA not signed label Jul 8, 2020

the-knights-who-say-ni added the CLA not signed label Jul 8, 2020

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Oct 5, 2021

wimglenn reviewed Apr 20, 2022

View reviewed changes

rossmclendon mannequin mentioned this pull request Apr 10, 2022

remove/delete method for zipfile objects #51067

Closed

ezio-melotti removed the CLA signed label Jul 13, 2022

terryjreedy changed the title bpo-6818: Add remove() in ZipInfo gh-51067: Add remove() in ZipInfo Dec 15, 2022

danny0838 mentioned this pull request Mar 25, 2023

gh-51067: add ZipFile.remove() #103033

Closed

github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 7, 2026

gpshead closed this Jun 20, 2026

+                          if i == len(filelist) - 1:
+                              entry_size = self.start_dir - info.header_offset
+                          else:
+                              entry_size = filelist[i + 1].header_offset - info.header_offset

+                      # Make sure we have an info object
+                      if isinstance(member, ZipInfo):
+                          # 'member' is already an info object
+                          zinfo = member

gh-51067: Add remove() in ZipInfo by yudilevi2 · Pull Request #19358 · python/cpython · GitHub

Repository navigation

gh-51067: Add remove() in ZipInfo - #19358

gh-51067: Add remove() in ZipInfo#19358yudilevi2 wants to merge 1 commit intopython:mainpython/cpython:mainfrom yudilevi2:bpo-6818yudilevi2/cpython:bpo-6818Copy head branch name to clipboard

Conversation

yudilevi2 commented Apr 4, 2020 • edited by terryjreedy Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

the-knights-who-say-ni commented Apr 4, 2020

CLA Missing

Uh oh!

cmeyer commented Apr 4, 2020

Uh oh!

csabella commented May 22, 2020

Uh oh!

yudilevi2 commented May 26, 2020

Uh oh!

remilapeyre commented Jun 1, 2020

Uh oh!

taleinat commented Sep 18, 2020

Uh oh!

yudilevi2 commented Sep 22, 2020

Uh oh!

taleinat commented Sep 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pmdevita commented Jan 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yudilevi2 commented Jan 21, 2021 via email

Uh oh!

peterstanton commented Feb 19, 2021

Uh oh!

marchinidavide commented Aug 12, 2021

Uh oh!

yudilevi2 commented Aug 12, 2021

Uh oh!

yudilevi2 commented Aug 12, 2021

Uh oh!

mlissner commented Dec 8, 2021

Uh oh!

quyentruong commented Apr 14, 2022

Uh oh!

wimglenn commented Apr 20, 2022

Uh oh!

wimglenn Apr 20, 2022

Choose a reason for hiding this comment

Uh oh!

danny0838 Mar 24, 2023

Choose a reason for hiding this comment

Uh oh!

wimglenn Apr 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danny0838 Mar 24, 2023

Choose a reason for hiding this comment

Uh oh!

python-cla-bot Bot commented Apr 18, 2025

Uh oh!

thatch commented May 20, 2025

Uh oh!

taleinat commented May 20, 2025

Uh oh!

github-actions Bot commented Apr 7, 2026

Uh oh!

gpshead commented Jun 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants

gh-51067: Add remove() in ZipInfo#19358
yudilevi2 wants to merge 1 commit into
python:mainfrom
yudilevi2:bpo-6818

yudilevi2 commented Apr 4, 2020 •
edited by terryjreedy
Loading

taleinat commented Sep 25, 2020 •
edited
Loading

pmdevita commented Jan 21, 2021 •
edited
Loading

wimglenn Apr 20, 2022 •
edited
Loading