Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-08 06:10:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

Revise docstring

Browse source
This commit is contained in:
Danny Lin 2025-05-27 08:27:17 +08:00
parent 93f4c25d39
commit 9e94209e94
1 changed files with 33 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

62
Lib/zipfile/__init__.py
View file

@ -1380,67 +1380,71 @@ def _debug(self, level, *msg):
def repack(self, zfile, removed=None): def repack(self, zfile, removed=None):
""" """
Repack the ZIP file, removing unrecorded local file entries and random Repack the ZIP file, stripping unreferenced local file entries.
bytes not listed in the central directory.
Assumes that local file entries are written consecutively without gaps. Assumes that local file entries are stored consecutively, with no gaps
or overlaps.
Truncation is applied in two phases: Stripping occurs in two phases:
1. Before the first recorded file entry: 1. Before the first recorded file entry:
- If a sequence of valid local file entries (starting with - If a sequence of valid local file entries (starting with
`PK\x03\x04`) is found leading up to the first recorded entry, `PK\x03\x04`) is found immediately before the first recorded
it is truncated. entry, it is stripped.
- Otherwise, all leading bytes are preserved (e.g., in cases such - Otherwise, all leading bytes are preserved (e.g., in cases such
as self-extracting code or embedded ZIP libraries). as self-extracting archives or embedded ZIP payloads).
2. Between or after the recorded entries: 2. Between or after the recorded entries:
- Any data between two recorded entries, or after the last recorded - Any bytes between two recorded entries, or between the last
entry but before the central directory, is removed—regardless of recorded and the central directory, are removed—regardless of
whether it resembles a valid entry. whether they resemble valid entries.
### Examples Examples:
Truncation before first recorded entry: Stripping before first recorded entry:
[random bytes] [random bytes]
[unrecorded local file entry 1] [unreferenced local file entry 1]
[unrecorded local file entry 2] [unreferenced local file entry 2]
[random bytes] [random bytes]
<- truncation start <-- stripping start
[unrecorded local file entry 3] [unreferenced local file entry 3]
[unrecorded local file entry 4] [unreferenced local file entry 4]
<- truncation end <-- stripping end
[recorded local file entry 1] [recorded local file entry 1]
... ...
[central directory] [central directory]
Truncation between recorded entries: Stripping between recorded entries:
... ...
[recorded local file entry 5] [recorded local file entry 5]
<- truncation start <-- stripping start
[random bytes] [random bytes]
[unrecorded local file entry] [unreferenced local file entry]
[random bytes] [random bytes]
<- truncation end <-- stripping end
[recorded local file entry 6] [recorded local file entry 6]
... ...
[recorded local file entry n] [recorded local file entry n]
<- truncation start <-- stripping start
[unrecorded local file entry] [unreferenced local file entry]
<- truncation end <-- stripping end
[central directory] [central directory]
No truncation case: No stripping:
[unrecorded local file entry 1] [unreferenced local file entry 1]
[unrecorded local file entry 2] [unreferenced local file entry 2]
... ...
[unrecorded local file entry n] [unreferenced local file entry n]
[random bytes] [random bytes]
[recorded local file entry 1] [recorded local file entry 1]
... ...
removed: None or a sequence of ZipInfo instances representing removed
entries. When provided, only their corresponding local file
entries are stripped.
""" """
removed_zinfos = set(removed or ()) removed_zinfos = set(removed or ())