summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorandrei kulakov <andrei.avk@gmail.com>2021-08-04 19:34:34 (GMT)
committerGitHub <noreply@github.com>2021-08-04 19:34:34 (GMT)
commit7c5dab4340032eb15d3797d8b601ef11649bbab3 (patch)
treefa1b577c8e946109203aac85c530b851358ff2bb /Doc/library
parentcc77193127381be16467ad10f421d3ba147ed972 (diff)
downloadcpython-7c5dab4340032eb15d3797d8b601ef11649bbab3.zip
cpython-7c5dab4340032eb15d3797d8b601ef11649bbab3.tar.gz
cpython-7c5dab4340032eb15d3797d8b601ef11649bbab3.tar.bz2
[doc] bpo-43066: zipfile - add note on leading slash in the filename arg (GH-26899)
Co-authored-by: Ɓukasz Langa <lukasz@langa.pl>
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/zipfile.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
index 19a67ab..a0bbdbf 100644
--- a/Doc/library/zipfile.rst
+++ b/Doc/library/zipfile.rst
@@ -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,
@@ -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,