From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 1 Apr 2024 01:53:51 +0000 (+0200)
Subject: [3.12] gh-102190: Add additional zipfile `pwd=` arg docstrings (gh-102195) (GH-117408)
X-Git-Tag: v3.12.3~19
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0b23bc334c3762615ef44a53663aeab1ed625595;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-102190: Add additional zipfile `pwd=` arg docstrings (gh-102195) (GH-117408)

gh-102190: Add additional zipfile `pwd=` arg docstrings (gh-102195)

This just documents the parameter that already exists.

---------

(cherry picked from commit a32d6939486d7f90ee57e215077f6116e19de24d)

Co-authored-by: Deborah <32307299+dlwrnc@users.noreply.github.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
---

diff --git a/Lib/zipfile/__init__.py b/Lib/zipfile/__init__.py
index a05c97ab8946..91358156bc1e 100644
--- a/Lib/zipfile/__init__.py
+++ b/Lib/zipfile/__init__.py
@@ -1562,7 +1562,8 @@ class ZipFile:
         self._didModify = True
 
     def read(self, name, pwd=None):
-        """Return file bytes for name."""
+        """Return file bytes for name. 'pwd' is the password to decrypt
+        encrypted files."""
         with self.open(name, "r", pwd) as fp:
             return fp.read()
 
@@ -1714,7 +1715,8 @@ class ZipFile:
         """Extract a member from the archive to the current working directory,
            using its full name. Its file information is extracted as accurately
            as possible. `member' may be a filename or a ZipInfo object. You can
-           specify a different directory using `path'.
+           specify a different directory using `path'. You can specify the
+           password to decrypt the file using 'pwd'.
         """
         if path is None:
             path = os.getcwd()
@@ -1727,7 +1729,8 @@ class ZipFile:
         """Extract all members from the archive to the current working
            directory. `path' specifies a different directory to extract to.
            `members' is optional and must be a subset of the list returned
-           by namelist().
+           by namelist(). You can specify the password to decrypt all files
+           using 'pwd'.
         """
         if members is None:
             members = self.namelist()