Skip to content
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

Docs: Fix document for plistlib.load #132069

Merged
merged 4 commits into from
Apr 5, 2025
Merged

Docs: Fix document for plistlib.load #132069

merged 4 commits into from
Apr 5, 2025

Conversation

koyuki7w
Copy link
Contributor

@koyuki7w koyuki7w commented Apr 4, 2025

The document states that plistlib.load raises InvalidFileException if the binary file cannot be parsed. But as of 05ee790, the function now also raises the exception if it cannot parse an XML text file.


📚 Documentation preview 📚: https://cpython-previews--132069.org.readthedocs.build/

[The document](https://docs.python.org/3/library/plistlib.html#plistlib.load)
states that `plistlib.load` raises `InvalidFileException` if the binary file cannot be parsed.
But as of 05ee790,
the function now also raises the exception if it cannot parse an XML text file.
@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Apr 4, 2025
@koyuki7w koyuki7w requested a review from picnixz April 5, 2025 01:06
@picnixz picnixz enabled auto-merge (squash) April 5, 2025 08:43
@picnixz picnixz added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Apr 5, 2025
@picnixz picnixz merged commit 99e9798 into python:main Apr 5, 2025
31 checks passed
@miss-islington-app
Copy link

Thanks @koyuki7w for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 5, 2025
(cherry picked from commit 99e9798)

Co-authored-by: Yuki Kobayashi <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 5, 2025
(cherry picked from commit 99e9798)

Co-authored-by: Yuki Kobayashi <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Apr 5, 2025

GH-132116 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Apr 5, 2025
@bedevere-app
Copy link

bedevere-app bot commented Apr 5, 2025

GH-132117 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Apr 5, 2025
picnixz pushed a commit that referenced this pull request Apr 5, 2025
…32117)

Docs: document `plistlib.InvalidFileException` (GH-132069)
(cherry picked from commit 99e9798)

Co-authored-by: Yuki Kobayashi <[email protected]>
picnixz pushed a commit that referenced this pull request Apr 5, 2025
…32116)

Docs: document `plistlib.InvalidFileException` (GH-132069)
(cherry picked from commit 99e9798)

Co-authored-by: Yuki Kobayashi <[email protected]>
@koyuki7w koyuki7w deleted the doc-fix-2 branch April 5, 2025 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants