[doc] bpo-43066: zipfile - add note on leading slash in the filename arg (GH-26899)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
This commit is contained in:
andrei kulakov 2021-08-04 15:34:34 -04:00 committed by GitHub
parent cc77193127
commit 7c5dab4340
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 1 deletions

View file

@ -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,