Skip to content

Commit

Permalink
[doc] bpo-43066: zipfile - add note on leading slash in the filename …
Browse files Browse the repository at this point in the history
…arg (GH-26899)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7c5dab4)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
  • Loading branch information
miss-islington and akulakov committed Aug 4, 2021
1 parent cdcae41 commit 98f6a72
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 5 additions & 1 deletion Doc/library/zipfile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ The module defines the following items:
of the last modification to the file; the fields are described in section
:ref:`zipinfo-objects`.


.. function:: is_zipfile(filename)

Returns ``True`` if *filename* is a valid ZIP file based on its magic number,
Expand Down Expand Up @@ -406,6 +405,11 @@ ZipFile Objects
If ``arcname`` (or ``filename``, if ``arcname`` is not given) contains a null
byte, the name of the file in the archive will be truncated at the null byte.

.. note::

A leading slash in the filename may lead to the archive being impossible to
open in some zip programs on Windows systems.

.. versionchanged:: 3.6
Calling :meth:`write` on a ZipFile created with mode ``'r'`` or
a closed ZipFile will raise a :exc:`ValueError`. Previously,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added a warning to :mod:`zipfile` docs: filename arg with a leading slash may cause archive to
be un-openable on Windows systems.

0 comments on commit 98f6a72

Please sign in to comment.