← 返回首页
Document that zipfile's pwd parameter is a bytes object by JustAnotherArchivist · Pull Request #100209 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

Document that zipfile's pwd parameter is a bytes object#100209

Merged
kumaraditya303 merged 1 commit into
python:mainfrom
JustAnotherArchivist:docs-zipfile-pwd-type
Dec 16, 2022
Merged

Document that zipfile's pwd parameter is a bytes object#100209
kumaraditya303 merged 1 commit into
python:mainfrom
JustAnotherArchivist:docs-zipfile-pwd-type

Conversation

JustAnotherArchivist commented Dec 13, 2022

Copy link
Copy Markdown
Contributor

Trivial docs change for which no issue exists.

This has been a requirement for a very long time (the exception on using non-bytes was added before 2.7; I didn't search beyond that) but was never documented anywhere as far as I can see.

Needs backports to earlier branches.

netlify Bot commented Dec 13, 2022 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for python-cpython-preview ready!

Name Link
🔨 Latest commit 81b6e1a
🔍 Latest deploy log https://app.netlify.com/sites/python-cpython-preview/deploys/6398236f8640a20009af66fd
😎 Deploy Preview https://deploy-preview-100209--python-cpython-preview.netlify.app/library/zipfile
📱 Preview on mobile Toggle QR Code...



Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

bedevere-bot added docs Documentation in the Doc dir skip news labels Dec 13, 2022
hauntsaninja approved these changes Dec 13, 2022
View reviewed changes

hauntsaninja left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Thanks, this looks good to me. I confirmed that pwd does seem to need to be bytes and not e.g. bytearray or a buffer.

Comment thread Doc/library/zipfile.rst Outdated Show resolved Hide resolved
kumaraditya303 approved these changes Dec 16, 2022
View reviewed changes

kumaraditya303 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

It is checked here:

cpython/Lib/zipfile/__init__.py

Lines 1491 to 1498 in e00266f

def setpassword(self, pwd):
"""Set default password for encrypted files."""
if pwd and not isinstance(pwd, bytes):
raise TypeError("pwd: expected bytes, got %s" % type(pwd).__name__)
if pwd:
self.pwd = pwd
else:
self.pwd = None

LGTM thanks!

kumaraditya303 merged commit 5ee7eb9 into python:main Dec 16, 2022
carljm added a commit to carljm/cpython that referenced this pull request Dec 16, 2022
Merge branch 'main' into fastmock …
2260a54
* main: Improve stats presentation for calls. (pythonGH-100274) Better stats for `LOAD_ATTR` and `STORE_ATTR` (pythonGH-100295) pythongh-81057: Move the Cached Parser Dummy Name to _PyRuntimeState (python#100277) Document that zipfile's pwd parameter is a `bytes` object (python#100209) pythongh-99767: mark `PyTypeObject.tp_watched` as internal use only in table (python#100271) Fix typo in introduction.rst (python#100266) pythongh-78997: AttributeError if loading fails in LibraryLoader.__getattr__ pythonGH-100234: Set a default value for random.expovariate() (pythonGH-100235) Remove uninformative itertools recipe (pythonGH-100253) pythonGH-99767: update PyTypeObject docs for type watchers (pythonGH-99928) Move stats for the method cache into the `Py_STAT` machinery (pythonGH-100255) pythonGH-100222: fix typo _py_set_opocde -> _py_set_opcode (pythonGH-100259) pythonGH-100000: Cleanup and polish various watchers code (pythonGH-99998) pythongh-90111: Minor Cleanup for Runtime-Global Objects (pythongh-100254)

JustAnotherArchivist commented Dec 16, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@kumaraditya303 Thanks for merging! How about backporting it to the other branches (at least the supported ones)? I think this needs some 'needs backport to X' labels.

kumaraditya303 added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Dec 17, 2022

miss-islington commented Dec 17, 2022

Copy link
Copy Markdown
Contributor

Thanks @JustAnotherArchivist for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

miss-islington commented Dec 17, 2022

Copy link
Copy Markdown
Contributor

Thanks @JustAnotherArchivist for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

bedevere-bot commented Dec 17, 2022

Copy link
Copy Markdown

GH-100309 is a backport of this pull request to the 3.11 branch.

bedevere-bot removed the needs backport to 3.11 only security fixes label Dec 17, 2022

bedevere-bot commented Dec 17, 2022

Copy link
Copy Markdown

GH-100310 is a backport of this pull request to the 3.10 branch.

bedevere-bot removed the needs backport to 3.10 only security fixes label Dec 17, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 17, 2022
Document that zipfile's pwd parameter is a bytes object (pythonGH-1… …
bd330a4
…00209) (cherry picked from commit 5ee7eb9) Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 17, 2022
Document that zipfile's pwd parameter is a bytes object (pythonGH-1… …
6c5e97a
…00209) (cherry picked from commit 5ee7eb9) Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Dec 17, 2022
Document that zipfile's pwd parameter is a bytes object (GH-100209) …
697a07a
(cherry picked from commit 5ee7eb9) Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Dec 17, 2022
Document that zipfile's pwd parameter is a bytes object (GH-100209) …
e3d8578
(cherry picked from commit 5ee7eb9) Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
shihai1991 added a commit to shihai1991/cpython that referenced this pull request Dec 18, 2022
Merge remote-tracking branch 'origin/main' into bpo_34697 …
2878571
* origin/main: (1306 commits) Correct CVE-2020-10735 documentation (python#100306) pythongh-100272: Fix JSON serialization of OrderedDict (pythonGH-100273) pythongh-93649: Split tracemalloc tests from _testcapimodule.c (python#99551) Docs: Use `PY_VERSION_HEX` for version comparison (python#100179) pythongh-97909: Fix markup for `PyMethodDef` members (python#100089) pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890) pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890) pythonGH-98831: Add DECREF_INPUTS(), expanding to DECREF() each stack input (python#100205) pythongh-78707: deprecate passing >1 argument to `PurePath.[is_]relative_to()` (pythonGH-94469) pythongh-99540: Constant hash for _PyNone_Type to aid reproducibility (pythonGH-99541) pythongh-100039: enhance __signature__ to work with str and callables (pythonGH-100168) pythongh-99830: asyncio: Document returns of remove_{reader,writer} (python#100302) "Compound statement" docs: Fix with-statement step indexing (python#100286) pythonGH-90043: Handle NaNs in COMPARE_OP_FLOAT_JUMP (pythonGH-100278) Improve stats presentation for calls. (pythonGH-100274) Better stats for `LOAD_ATTR` and `STORE_ATTR` (pythonGH-100295) pythongh-81057: Move the Cached Parser Dummy Name to _PyRuntimeState (python#100277) Document that zipfile's pwd parameter is a `bytes` object (python#100209) pythongh-99767: mark `PyTypeObject.tp_watched` as internal use only in table (python#100271) Fix typo in introduction.rst (python#100266) ...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hauntsaninja hauntsaninja approved these changes
kumaraditya303 kumaraditya303 approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Footer

© 2026 GitHub, Inc.