zipremove 0.1.0__tar.gz → 0.3.0__tar.gz

{zipremove-0.1.0 → zipremove-0.3.0}/LICENSE.txt

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Danny Lin
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Danny Lin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{zipremove-0.1.0/src/zipremove.egg-info → zipremove-0.3.0}/PKG-INFO

@@ -1,176 +1,218 @@
-Metadata-Version: 2.4
-Name: zipremove
-Version: 0.1.0
-Summary: Extend `zipfile` with `remove`-related functionalities
-Home-page: https://github.com/danny0838/zipremove
-Author: Danny Lin
-Author-email: danny0838@gmail.com
-License: MIT
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: System :: Archiving :: Compression
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Operating System :: OS Independent
-Requires-Python: ~=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Provides-Extra: dev
-Requires-Dist: tox>=4.0; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine>=4.0; extra == "dev"
-Requires-Dist: flake8>=5.0; extra == "dev"
-Requires-Dist: flake8-comprehensions>=3.12; extra == "dev"
-Requires-Dist: flake8-bugbear>=22.0; extra == "dev"
-Requires-Dist: flake8-isort>=6.0; extra == "dev"
-Requires-Dist: isort>=5.5; extra == "dev"
-Dynamic: license-file
-
-This package extends `zipfile` with `remove`-related functionalities.
-
-## API
-
-* `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;
-   the ZIP file size remains unchanged. Call `ZipFile.repack` afterwards
-   to reclaim space.
-
-   The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'``.
-
-   Returns the removed `ZipInfo` instance.
-
-   Calling `remove` on a closed ZipFile will raise a `ValueError`.
-
-* `ZipFile.repack(removed=None, *, strict_descriptor=False[, chunk_size])`
-
-   Rewrites the archive to remove stale local file entries, shrinking the ZIP
-   file size.
-
-   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, local file entries no longer referenced in the
-   central directory will be removed.  The algorithm assumes that local file
-   entries 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
-      preceeding 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.
-
-   ``strict_descriptor=True`` can be provided to skip the slower scan for an
-   unsigned data descriptor (deprecated in the latest ZIP specification and is
-   only used by legacy tools) when checking for bytes resembling a valid local
-   file entry.  This improves performance, but may cause some stale local file
-   entries to be preserved, as any entry using an unsigned descriptor cannot
-   be detected.
-
-   *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`.
-
-* `ZipFile.copy(zinfo_or_arcname, new_arcname[, chunk_size])`
-
-   Copies a member *zinfo_or_arcname* to *new_arcname* in the archive.
-   *zinfo_or_arcname* may be the full path of the member or a `ZipInfo`
-   instance.
-
-   *chunk_size* may be specified to control the buffer size when copying
-   entry data (default is 1 MiB).
-
-   The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'``, and the
-   underlying stream must be seekable.
-
-   Returns the original version of the copied `ZipInfo` instance.
-
-   Calling `copy` on a closed ZipFile will raise a `ValueError`.
-
-
-## Examples
-
-### Remove files and reclaim space
-
-```python
-import os
-import zipremove as zipfile
-
-with zipfile.ZipFile('archive.zip', 'w') as zh:
-    zh.writestr('file1', 'content1')
-    zh.writestr('file2', 'content2')
-    zh.writestr('file3', 'content3')
-    zh.writestr('file4', 'content4')
-
-print(os.path.getsize('archive.zip'))  # 398
-
-with zipfile.ZipFile('archive.zip', 'a') as zh:
-    zh.remove('file1')
-    zh.remove('file2')
-    zh.remove('file3')
-    zh.repack()
-
-print(os.path.getsize('archive.zip'))  # 116
-```
-
-### Remove files under a directory and reclaim space
-
-```python
-import os
-import zipremove as zipfile
-
-with zipfile.ZipFile('archive.zip', 'w') as zh:
-    zh.writestr('file0', 'content0')
-    zh.writestr('folder/file1', 'content1')
-    zh.writestr('folder/file2', 'content2')
-    zh.writestr('folder/file3', 'content3')
-
-print(os.path.getsize('archive.zip'))  # 440
-
-with zipfile.ZipFile('archive.zip', 'a') as zh:
-    zinfos = [zh.remove(n) for n in zh.namelist() if n.startswith('folder/')]
-    zh.repack(zinfos)
-
-print(os.path.getsize('archive.zip'))  # 116
-```
-
-### Rename files under a directory and reclaim space
-
-```python
-import os
-import zipremove as zipfile
-
-with zipfile.ZipFile('archive.zip', 'w') as zh:
-    zh.writestr('file0', 'content0')
-    zh.writestr('folder1/file1', 'content1')
-    zh.writestr('folder1/file2', 'content2')
-    zh.writestr('folder1/file3', 'content3')
-
-print(os.path.getsize('archive.zip'))  # 446
-
-with zipfile.ZipFile('archive.zip', 'a') as zh:
-    for n in zh.namelist():
-        if n.startswith('folder1/'):
-            n2 = 'folder2/' + n[len('folder1/'):]
-            zh.copy(n, n2)
-            zh.remove(n)
-    zh.repack()
-
-print(os.path.getsize('archive.zip'))  # 446
-```
+Metadata-Version: 2.4
+Name: zipremove
+Version: 0.3.0
+Summary: Extend `zipfile` with `remove`-related functionalities
+Home-page: https://github.com/danny0838/zipremove
+Author: Danny Lin
+Author-email: danny0838@gmail.com
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: System :: Archiving :: Compression
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: ~=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Provides-Extra: dev
+Requires-Dist: tox>=4.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Requires-Dist: flake8>=5.0; extra == "dev"
+Requires-Dist: flake8-comprehensions>=3.12; extra == "dev"
+Requires-Dist: flake8-bugbear>=22.0; extra == "dev"
+Requires-Dist: flake8-isort>=6.0; extra == "dev"
+Requires-Dist: isort>=5.5; extra == "dev"
+Dynamic: license-file
+
+![PyPI version](https://img.shields.io/pypi/v/zipremove.svg)
+![Python Versions](https://img.shields.io/pypi/pyversions/zipremove)
+![Status](https://img.shields.io/pypi/status/zipremove)
+![License](https://img.shields.io/github/license/danny0838/zipremove)
+[![Downloads](https://static.pepy.tech/personalized-badge/zipremove?period=month&left_text=Downloads)](https://pepy.tech/project/zipremove)
+
+This package extends `zipfile` with `remove`-related functionalities.
+
+## API
+
+* `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.
+
+   The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'``.
+
+   Returns the removed `ZipInfo` instance.
+
+   Calling `remove` on a closed ZipFile will raise a `ValueError`.
+
+* `ZipFile.repack(removed=None, *, strict_descriptor=False[, chunk_size])`
+
+   Rewrites the archive to remove stale local file entries, shrinking the ZIP
+   file size.
+
+   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, local file entries no longer referenced in the
+   central directory will be removed.  The algorithm assumes that local file
+   entries 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
+      preceeding 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.
+
+   ``strict_descriptor=True`` can be provided to skip the slower scan for an
+   unsigned data descriptor (deprecated in the latest ZIP specification and is
+   only used by legacy tools) when checking for bytes resembling a valid local
+   file entry.  This improves performance, but may cause some stale local file
+   entries to be preserved, as any entry using an unsigned descriptor cannot
+   be detected.
+
+   *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`.
+
+* `ZipFile.copy(zinfo_or_arcname, new_arcname[, chunk_size])`
+
+   Copies a member *zinfo_or_arcname* to *new_arcname* in the archive.
+   *zinfo_or_arcname* may be the full path of the member or a `ZipInfo`
+   instance.
+
+   *chunk_size* may be specified to control the buffer size when copying
+   entry data (default is 1 MiB).
+
+   The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'``, and the
+   underlying stream must be seekable.
+
+   Returns the original version of the copied `ZipInfo` instance.
+
+   Calling `copy` on a closed ZipFile will raise a `ValueError`.
+
+
+## Examples
+
+### Remove entries and reclaim space
+
+Call `repack` after `remove`s to reclaim the space of the removed entries:
+
+```python
+import os
+import zipremove as zipfile
+
+with zipfile.ZipFile('archive.zip', 'w') as zh:
+    zh.writestr('file1', 'content1')
+    zh.writestr('file2', 'content2')
+    zh.writestr('file3', 'content3')
+    zh.writestr('file4', 'content4')
+
+print(os.path.getsize('archive.zip'))  # 398
+
+with zipfile.ZipFile('archive.zip', 'a') as zh:
+    zh.remove('file1')
+    zh.remove('file2')
+    zh.remove('file3')
+    zh.repack()
+
+print(os.path.getsize('archive.zip'))  # 116 (would be 245 without `repack`)
+```
+
+Alternatively, pass the ZipInfo objects of the removed entries, for better
+performance and error-proofing:
+
+```python
+import os
+import zipremove as zipfile
+
+with zipfile.ZipFile('archive.zip', 'w') as zh:
+    zh.writestr('file1', 'content1')
+    zh.writestr('file2', 'content2')
+    zh.writestr('file3', 'content3')
+    zh.writestr('file4', 'content4')
+
+print(os.path.getsize('archive.zip'))  # 398
+
+with zipfile.ZipFile('archive.zip', 'a') as zh:
+    zinfos = []
+    zinfos.append(zh.remove('file1'))
+    zinfos.append(zh.remove('file2'))
+    zinfos.append(zh.remove('file3'))
+    zh.repack(zinfos)
+
+print(os.path.getsize('archive.zip'))  # 116 (would be 245 without `repack`)
+```
+
+### Move entries under a folder and reclaim space
+
+Moving entries in a ZIP file must be done as a combination of `copy`, `remove`,
+and optionally `repack`, because every local file entry contains the filename
+and requires rewriting.
+
+```python
+import os
+import zipremove as zipfile
+
+with zipfile.ZipFile('archive.zip', 'w') as zh:
+    zh.writestr('file0', 'content0')
+    zh.writestr('folder1/file1', 'content1')
+    zh.writestr('folder1/file2', 'content2')
+    zh.writestr('folder1/file3', 'content3')
+
+print(os.path.getsize('archive.zip'))  # 446
+
+with zipfile.ZipFile('archive.zip', 'a') as zh:
+    for n in zh.namelist():
+        if n.startswith('folder1/'):
+            n2 = 'folder2/' + n[len('folder1/'):]
+            zh.copy(n, n2)
+            zh.remove(n)
+    zh.repack()
+
+print(os.path.getsize('archive.zip'))  # 446 (would be 599 without `repack`)
+```
+
+Similarly, pass the ZipInfo objects of the copied/removed entries for better
+performance and error-proofing:
+
+```python
+import os
+import zipremove as zipfile
+
+with zipfile.ZipFile('archive.zip', 'w') as zh:
+    zh.writestr('file0', 'content0')
+    zh.writestr('folder1/file1', 'content1')
+    zh.writestr('folder1/file2', 'content2')
+    zh.writestr('folder1/file3', 'content3')
+
+print(os.path.getsize('archive.zip'))  # 446
+
+with zipfile.ZipFile('archive.zip', 'a') as zh:
+    zinfos = []
+    for n in zh.namelist():
+        if n.startswith('folder1/'):
+            n2 = 'folder2/' + n[len('folder1/'):]
+            zinfos.append(zh.remove(zh.copy(n, n2)))
+    zh.repack(zinfos)
+
+print(os.path.getsize('archive.zip'))  # 446 (would be 599 without `repack`)
+```