Skip to content

Commit 8e69c09

Browse files
committed
Revise doc for remove
1 parent f20ec5d commit 8e69c09

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

Doc/library/zipfile.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -520,21 +520,24 @@ ZipFile Objects
520520

521521
.. method:: ZipFile.remove(zinfo_or_arcname)
522522

523-
Removes a member from the archive. *zinfo_or_arcname* may be the full path
524-
of the member or a :class:`ZipInfo` instance.
525-
526-
If multiple members share the same full path, only one is removed when
527-
a path is provided.
528-
529-
This does not physically remove the local file entry from the archive.
530-
Call :meth:`repack` afterwards to reclaim space.
523+
Removes a member entry from the archive's central directory.
524+
*zinfo_or_arcname* may be the full path of the member or a :class:`ZipInfo`
525+
instance. If multiple members share the same full path and the path is
526+
provided, only one of them is removed.
531527

532528
The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'``.
533529

534530
Returns the removed :class:`ZipInfo` instance.
535531

536532
Calling :meth:`remove` on a closed ZipFile will raise a :exc:`ValueError`.
537533

534+
.. note::
535+
This method only removes the member's entry from the central directory,
536+
making it inaccessible to most tools. The member's local file entry,
537+
including content and metadata, remains in the archive and is still
538+
recoverable using forensic tools. Call :meth:`repack` afterwards to
539+
completely remove the member and reclaim space.
540+
538541
.. versionadded:: next
539542

540543

0 commit comments

Comments
 (0)