PyPI - zipremove - Versions diffs - 0.4.1__tar.gz → 0.6.0__tar.gz - Mend

zipremove 0.4.1tar.gz → 0.6.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

{zipremove-0.4.1/src/zipremove.egg-info → zipremove-0.6.0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zipremove
-Version: 0.4.1
+Version: 0.6.0
 Summary: Extend `zipfile` with `remove`-related functionalities
 Home-page: https://github.com/danny0838/zipremove
 Author: Danny Lin
@@ -45,14 +45,10 @@ This package extends `zipfile` with `remove`-related functionalities.
 * `ZipFile.remove(zinfo_or_arcname)`
-   Removes a member from the archive.  *zinfo_or_arcname* may be the full path
-   of the member or a `ZipInfo` instance.
-   If multiple members share the same full path, only one is removed when
-   a path is provided.
-   This does not physically remove the local file entry from the archive.
-   Call `ZipFile.repack` afterwards to reclaim space.
+   Removes a member entry from the archive's central directory.
+   *zinfo_or_arcname* may be the full path of the member or a `ZipInfo`
+   instance.  If multiple members share the same full path and the path is
+   provided, only one of them is removed.
    The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'``.
@@ -60,42 +56,49 @@ This package extends `zipfile` with `remove`-related functionalities.
    Calling `remove` on a closed ZipFile will raise a `ValueError`.
+   > **Note:**
+   > This method only removes the member's entry from the central directory,
+   > making it inaccessible to most tools.  The member's local file entry,
+   > including content and metadata, remains in the archive and is still
+   > recoverable using forensic tools.  Call `repack` afterwards to completely
+   > remove the member and reclaim space.
 * `ZipFile.repack(removed=None, *, strict_descriptor=False[, chunk_size])`
-   Rewrites the archive to remove stale local file entries, shrinking its file
-   size.
+   Rewrites the archive to remove unreferenced local file entries, shrinking
+   its file size.  The archive must be opened with mode ``'a'``.
    If *removed* is provided, it must be a sequence of `ZipInfo` objects
-   representing removed entries; only their corresponding local file entries
-   will be removed.
-   If *removed* is not provided, the archive is scanned to identify and remove
-   local file entries that are no longer referenced in the central directory.
-   The algorithm assumes that local file entries (and the central directory,
-   which is mostly treated as the "last entry") are stored consecutively:
-   1. Data before the first referenced entry is removed only when it appears to
-      be a sequence of consecutive entries with no extra following bytes; extra
-      preceding bytes are preserved.
-   2. Data between referenced entries is removed only when it appears to
-      be a sequence of consecutive entries with no extra preceding bytes; extra
-      following bytes are preserved.
-   3. Entries must not overlap. If any entry's data overlaps with another, a
-      `BadZipFile` error is raised and no changes are made.
-   When scanning, setting `strict_descriptor=True` disables detection of any
-   entry using an unsigned data descriptor (deprecated in the ZIP specification
-   since version 6.3.0, released on 2006-09-29, and used only by some legacy
-   tools). This improves performance, but may cause some stale entries to be
-   preserved.
+   representing the recently removed members, and only their corresponding
+   local file entries will be removed.  Otherwise, the archive is scanned to
+   locate and remove local file entries that are no longer referenced in the
+   central directory.
+   When scanning, setting ``strict_descriptor=True`` disables detection of any
+   entry using an unsigned data descriptor (a format deprecated by the ZIP
+   specification since version 6.3.0, released on 2006-09-29, and used only by
+   some legacy tools), which is significantly slower to scan—around 100 to
+   1000 times in the worst case. This does not affect performance on entries
+   without such feature.
    *chunk_size* may be specified to control the buffer size when moving
    entry data (default is 1 MiB).
-   The archive must be opened with mode ``'a'``.
    Calling `repack` on a closed ZipFile will raise a `ValueError`.
+   > **Note:**
+   > The scanning algorithm is heuristic-based and assumes that the ZIP file
+   > is normally structured—for example, with local file entries stored
+   > consecutively, without overlap or interleaved binary data.  Prepended
+   > binary data, such as a self-extractor stub, is recognized and preserved
+   > unless it happens to contain bytes that coincidentally resemble a valid
+   > local file entry in multiple respects—an extremely rare case. Embedded
+   > ZIP payloads are also handled correctly, as long as they follow normal
+   > structure.  However, the algorithm does not guarantee correctness or
+   > safety on untrusted or intentionally crafted input.  It is generally
+   > recommended to provide the *removed* argument for better reliability and
+   > performance.
 * `ZipFile.copy(zinfo_or_arcname, new_arcname[, chunk_size])`
    Copies a member *zinfo_or_arcname* to *new_arcname* in the archive.

{zipremove-0.4.1 → zipremove-0.6.0}/README.md RENAMED Viewed

@@ -11,14 +11,10 @@ This package extends `zipfile` with `remove`-related functionalities.
 * `ZipFile.remove(zinfo_or_arcname)`
-   Removes a member from the archive.  *zinfo_or_arcname* may be the full path
-   of the member or a `ZipInfo` instance.
-   If multiple members share the same full path, only one is removed when
-   a path is provided.
-   This does not physically remove the local file entry from the archive.
-   Call `ZipFile.repack` afterwards to reclaim space.
+   Removes a member entry from the archive's central directory.
+   *zinfo_or_arcname* may be the full path of the member or a `ZipInfo`
+   instance.  If multiple members share the same full path and the path is
+   provided, only one of them is removed.
    The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'``.
@@ -26,42 +22,49 @@ This package extends `zipfile` with `remove`-related functionalities.
    Calling `remove` on a closed ZipFile will raise a `ValueError`.
+   > **Note:**
+   > This method only removes the member's entry from the central directory,
+   > making it inaccessible to most tools.  The member's local file entry,
+   > including content and metadata, remains in the archive and is still
+   > recoverable using forensic tools.  Call `repack` afterwards to completely
+   > remove the member and reclaim space.
 * `ZipFile.repack(removed=None, *, strict_descriptor=False[, chunk_size])`
-   Rewrites the archive to remove stale local file entries, shrinking its file
-   size.
+   Rewrites the archive to remove unreferenced local file entries, shrinking
+   its file size.  The archive must be opened with mode ``'a'``.
    If *removed* is provided, it must be a sequence of `ZipInfo` objects
-   representing removed entries; only their corresponding local file entries
-   will be removed.
-   If *removed* is not provided, the archive is scanned to identify and remove
-   local file entries that are no longer referenced in the central directory.
-   The algorithm assumes that local file entries (and the central directory,
-   which is mostly treated as the "last entry") are stored consecutively:
-   1. Data before the first referenced entry is removed only when it appears to
-      be a sequence of consecutive entries with no extra following bytes; extra
-      preceding bytes are preserved.
-   2. Data between referenced entries is removed only when it appears to
-      be a sequence of consecutive entries with no extra preceding bytes; extra
-      following bytes are preserved.
-   3. Entries must not overlap. If any entry's data overlaps with another, a
-      `BadZipFile` error is raised and no changes are made.
-   When scanning, setting `strict_descriptor=True` disables detection of any
-   entry using an unsigned data descriptor (deprecated in the ZIP specification
-   since version 6.3.0, released on 2006-09-29, and used only by some legacy
-   tools). This improves performance, but may cause some stale entries to be
-   preserved.
+   representing the recently removed members, and only their corresponding
+   local file entries will be removed.  Otherwise, the archive is scanned to
+   locate and remove local file entries that are no longer referenced in the
+   central directory.
+   When scanning, setting ``strict_descriptor=True`` disables detection of any
+   entry using an unsigned data descriptor (a format deprecated by the ZIP
+   specification since version 6.3.0, released on 2006-09-29, and used only by
+   some legacy tools), which is significantly slower to scan—around 100 to
+   1000 times in the worst case. This does not affect performance on entries
+   without such feature.
    *chunk_size* may be specified to control the buffer size when moving
    entry data (default is 1 MiB).
-   The archive must be opened with mode ``'a'``.
    Calling `repack` on a closed ZipFile will raise a `ValueError`.
+   > **Note:**
+   > The scanning algorithm is heuristic-based and assumes that the ZIP file
+   > is normally structured—for example, with local file entries stored
+   > consecutively, without overlap or interleaved binary data.  Prepended
+   > binary data, such as a self-extractor stub, is recognized and preserved
+   > unless it happens to contain bytes that coincidentally resemble a valid
+   > local file entry in multiple respects—an extremely rare case. Embedded
+   > ZIP payloads are also handled correctly, as long as they follow normal
+   > structure.  However, the algorithm does not guarantee correctness or
+   > safety on untrusted or intentionally crafted input.  It is generally
+   > recommended to provide the *removed* argument for better reliability and
+   > performance.
 * `ZipFile.copy(zinfo_or_arcname, new_arcname[, chunk_size])`
    Copies a member *zinfo_or_arcname* to *new_arcname* in the archive.

{zipremove-0.4.1 → zipremove-0.6.0}/setup.cfg RENAMED Viewed

@@ -1,6 +1,6 @@
 [metadata]
 name = zipremove
-version = 0.4.1
+version = 0.6.0
 author = Danny Lin
 author_email = danny0838@gmail.com
 url = https://github.com/danny0838/zipremove

{zipremove-0.4.1 → zipremove-0.6.0}/src/zipremove/__init__.py RENAMED Viewed

@@ -82,7 +82,7 @@ class _ZipRepacker:
     def copy(self, zfile, zinfo, filename):
         # make a copy of zinfo
-        zinfo2 = copy.deepcopy(zinfo)
+        zinfo2 = copy.copy(zinfo)
         # apply sanitized new filename as in `ZipInfo.__init__`
         zinfo2.orig_filename = filename
@@ -90,7 +90,7 @@ class _ZipRepacker:
         zinfo2.header_offset = zfile.start_dir
-        # polyfill: update zinfo2._end_offset if exists
+        # polyfill: clear zinfo2._end_offset if exists
         # (Python >= 3.8 with fix #109858)
         if hasattr(zinfo2, '_end_offset'):
             zinfo2._end_offset = None
@@ -113,10 +113,9 @@ class _ZipRepacker:
         """
         Repack the ZIP file, stripping unreferenced local file entries.
-        Assumes that local file entries are stored consecutively, with no gaps
-        or overlaps.
-        Behavior:
+        Assumes that local file entries (and the central directory, which is
+        mostly treated as the "last entry") are stored consecutively, with no
+        gaps or overlaps:
         1. If any referenced entry overlaps with another, a `BadZipFile` error
            is raised since safe repacking cannot be guaranteed.
@@ -129,8 +128,8 @@ class _ZipRepacker:
            be a sequence of consecutive entries with no extra preceding bytes;
            extra following bytes are preserved.
-        4. This is to prevent an unexpected data removal (false positive),
-           though a false negative may happen in certain rare cases.
+        This is to prevent an unexpected data removal (false positive), though
+        a false negative may happen in certain rare cases.
         Examples:
@@ -178,10 +177,11 @@ class _ZipRepacker:
         Side effects:
             - Modifies the ZIP file in place.
-            - Updates zfile.start_dir to account for removed data.
+            - Updates zfile.start_dir and zfile.data_offset to account for
+              removed data.
             - Sets zfile._didModify to True.
-            - Updates header_offset and _end_offset of referenced ZipInfo
-              instances.
+            - Updates header_offset and clears _end_offset of referenced
+              ZipInfo instances.
         Parameters:
             zfile: A ZipFile object representing the archive to repack.
@@ -283,17 +283,20 @@ class _ZipRepacker:
         zfile.start_dir -= entry_offset
         zfile._didModify = True
-        # polyfill: update ZipInfo._end_offset if exists
+        # polyfill: update _data_offset if exists
+        if getattr(zfile, '_data_offset', None):
+            try:
+                offset = filelist[0].header_offset
+            except IndexError:
+                offset = zfile.start_dir
+            if offset < zfile._data_offset:
+                zfile._data_offset = offset
+        # polyfill: clear ZipInfo._end_offset if exists
         # (Python >= 3.8 with fix #109858)
         if hasattr(ZipInfo, '_end_offset'):
-            end_offset = zfile.start_dir
-            for zinfo in reversed(filelist):
-                if zinfo in removed_zinfos:
-                    zinfo._end_offset = None
-                else:
-                    if zinfo._end_offset is not None:
-                        zinfo._end_offset = end_offset
-                    end_offset = zinfo.header_offset
+            for zinfo in filelist:
+                zinfo._end_offset = None
     def _calc_initial_entry_offset(self, fp, data_offset):
         checked_offsets = {}
@@ -307,7 +310,8 @@ class _ZipRepacker:
                     return entry_size
         return 0
-    def _iter_scan_signature(self, fp, signature, start_offset, end_offset, chunk_size=4096):
+    def _iter_scan_signature(self, fp, signature, start_offset, end_offset,
+                             chunk_size=io.DEFAULT_BUFFER_SIZE):
         sig_len = len(signature)
         remainder = b''
         pos = start_offset
@@ -513,7 +517,8 @@ class _ZipRepacker:
         return crc, compress_size, file_size, dd_size
-    def _trace_compressed_block_end(self, fp, offset, end_offset, decompressor, chunk_size=4096):
+    def _trace_compressed_block_end(self, fp, offset, end_offset, decompressor,
+                                    chunk_size=io.DEFAULT_BUFFER_SIZE):
         fp.seek(offset)
         read_size = 0
         while True:

{zipremove-0.4.1 → zipremove-0.6.0/src/zipremove.egg-info}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zipremove
-Version: 0.4.1
+Version: 0.6.0
 Summary: Extend `zipfile` with `remove`-related functionalities
 Home-page: https://github.com/danny0838/zipremove
 Author: Danny Lin
@@ -45,14 +45,10 @@ This package extends `zipfile` with `remove`-related functionalities.
 * `ZipFile.remove(zinfo_or_arcname)`
-   Removes a member from the archive.  *zinfo_or_arcname* may be the full path
-   of the member or a `ZipInfo` instance.
-   If multiple members share the same full path, only one is removed when
-   a path is provided.
-   This does not physically remove the local file entry from the archive.
-   Call `ZipFile.repack` afterwards to reclaim space.
+   Removes a member entry from the archive's central directory.
+   *zinfo_or_arcname* may be the full path of the member or a `ZipInfo`
+   instance.  If multiple members share the same full path and the path is
+   provided, only one of them is removed.
    The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'``.
@@ -60,42 +56,49 @@ This package extends `zipfile` with `remove`-related functionalities.
    Calling `remove` on a closed ZipFile will raise a `ValueError`.
+   > **Note:**
+   > This method only removes the member's entry from the central directory,
+   > making it inaccessible to most tools.  The member's local file entry,
+   > including content and metadata, remains in the archive and is still
+   > recoverable using forensic tools.  Call `repack` afterwards to completely
+   > remove the member and reclaim space.
 * `ZipFile.repack(removed=None, *, strict_descriptor=False[, chunk_size])`
-   Rewrites the archive to remove stale local file entries, shrinking its file
-   size.
+   Rewrites the archive to remove unreferenced local file entries, shrinking
+   its file size.  The archive must be opened with mode ``'a'``.
    If *removed* is provided, it must be a sequence of `ZipInfo` objects
-   representing removed entries; only their corresponding local file entries
-   will be removed.
-   If *removed* is not provided, the archive is scanned to identify and remove
-   local file entries that are no longer referenced in the central directory.
-   The algorithm assumes that local file entries (and the central directory,
-   which is mostly treated as the "last entry") are stored consecutively:
-   1. Data before the first referenced entry is removed only when it appears to
-      be a sequence of consecutive entries with no extra following bytes; extra
-      preceding bytes are preserved.
-   2. Data between referenced entries is removed only when it appears to
-      be a sequence of consecutive entries with no extra preceding bytes; extra
-      following bytes are preserved.
-   3. Entries must not overlap. If any entry's data overlaps with another, a
-      `BadZipFile` error is raised and no changes are made.
-   When scanning, setting `strict_descriptor=True` disables detection of any
-   entry using an unsigned data descriptor (deprecated in the ZIP specification
-   since version 6.3.0, released on 2006-09-29, and used only by some legacy
-   tools). This improves performance, but may cause some stale entries to be
-   preserved.
+   representing the recently removed members, and only their corresponding
+   local file entries will be removed.  Otherwise, the archive is scanned to
+   locate and remove local file entries that are no longer referenced in the
+   central directory.
+   When scanning, setting ``strict_descriptor=True`` disables detection of any
+   entry using an unsigned data descriptor (a format deprecated by the ZIP
+   specification since version 6.3.0, released on 2006-09-29, and used only by
+   some legacy tools), which is significantly slower to scan—around 100 to
+   1000 times in the worst case. This does not affect performance on entries
+   without such feature.
    *chunk_size* may be specified to control the buffer size when moving
    entry data (default is 1 MiB).
-   The archive must be opened with mode ``'a'``.
    Calling `repack` on a closed ZipFile will raise a `ValueError`.
+   > **Note:**
+   > The scanning algorithm is heuristic-based and assumes that the ZIP file
+   > is normally structured—for example, with local file entries stored
+   > consecutively, without overlap or interleaved binary data.  Prepended
+   > binary data, such as a self-extractor stub, is recognized and preserved
+   > unless it happens to contain bytes that coincidentally resemble a valid
+   > local file entry in multiple respects—an extremely rare case. Embedded
+   > ZIP payloads are also handled correctly, as long as they follow normal
+   > structure.  However, the algorithm does not guarantee correctness or
+   > safety on untrusted or intentionally crafted input.  It is generally
+   > recommended to provide the *removed* argument for better reliability and
+   > performance.
 * `ZipFile.copy(zinfo_or_arcname, new_arcname[, chunk_size])`
    Copies a member *zinfo_or_arcname* to *new_arcname* in the archive.

zipremove 0.4.1__tar.gz → 0.6.0__tar.gz

zipremove 0.4.1tar.gz → 0.6.0tar.gz