Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions Lib/zipfile/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1562,7 +1562,8 @@ def comment(self, comment):
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()

Expand Down Expand Up @@ -1714,7 +1715,8 @@ def extract(self, member, path=None, pwd=None):
"""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()
Expand All @@ -1727,7 +1729,8 @@ def extractall(self, path=None, members=None, pwd=None):
"""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()
Expand Down