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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-113537: support loads str in plistlib.loads #113582

Merged
merged 10 commits into from Jan 6, 2024
Merged

gh-113537: support loads str in plistlib.loads #113582

merged 10 commits into from Jan 6, 2024

Conversation

aisk
Copy link
Contributor

@aisk aisk commented Dec 30, 2023 •
edited by github-actions bot

@bedevere-app bedevere-app bot mentioned this pull request Dec 30, 2023
Closed
ronaldoussoren
ronaldoussoren requested changes Dec 30, 2023
View reviewed changes
Copy link
Contributor

@ronaldoussoren ronaldoussoren left a comment

Choose a reason for hiding this comment

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

plistlib supports two formats for the plist file: XML and Binary. Accepting strings for input is only useful for the XML format.

The loads implementation should assert that fmt == FMT_XML when the value is a string and raise ValueError when it is not. This also needs to be tested.

Lib/plistlib.py Outdated Show resolved Hide resolved
Lib/test/test_plistlib.py Outdated Show resolved Hide resolved
@bedevere-app
Copy link

bedevere-app bot commented Dec 30, 2023

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

aisk and others added 5 commits December 31, 2023 20:54
@aisk @ronaldoussoren
Update Lib/plistlib.py
489c731 
Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
@aisk @ronaldoussoren
Update Lib/test/test_plistlib.py
113ebbc 
Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
@aisk @ronaldoussoren
Update Doc/library/plistlib.rst
63ee02f 
Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
@aisk
fix rst grammar
d192968
@aisk
raise TypeError when value is str and fmt is FMT_BINARY
da368f3
@aisk
Copy link
Contributor Author

aisk commented Dec 31, 2023

The loads implementation should assert that fmt == FMT_XML when the value is a string and raise ValueError when it is not.

Updated, but I think raising a TypeError is more suitable here. And it has more compatibility; the old version will raise a TypeError: a bytes-like object is required, not 'str' if a string argument is passed to loads, so it's better to raise the same error type.

@ronaldoussoren
Copy link
Contributor

The loads implementation should assert that fmt == FMT_XML when the value is a string and raise ValueError when it is not.

Updated, but I think raising a TypeError is more suitable here. And it has more compatibility; the old version will raise a TypeError: a bytes-like object is required, not 'str' if a string argument is passed to loads, so it's better to raise the same error type.

I agree.

ronaldoussoren
ronaldoussoren requested changes Jan 1, 2024
View reviewed changes
Copy link
Contributor

@ronaldoussoren ronaldoussoren left a comment

Choose a reason for hiding this comment

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

Getting there!

The PR looks good at this point, just some minor changes.

Lib/plistlib.py Outdated
Comment on lines 893 to 894
msg = "value must be bytes-like oebject when fmt is FMT_BINARY"
raise TypeError(msg)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
msg = "value must be bytes-like oebject when fmt is FMT_BINARY"
raise TypeError(msg)
raise TypeError("value must be bytes-like object when fmt is FMT_BINARY")

The msg variable is not necessary (also fixes a typo in the message itself)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review, I fixed the typo, but kept the msg variable. It's here to make the line length shorter than 80.

Copy link
Contributor

Choose a reason for hiding this comment

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

I still don't like introducing a variable for the message here. You could do this instead:

            raise TypeError(
                        "value must be bytes-like object when fmt is FMT_BINARY"
             )

If I counted correctly this just about fits into 80 characters. Alternatively split the string:

            raise TypeError(
                        "value must be bytes-like object "
                         "when fmt is FMT_BINARY"
             )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it, updated.

Lib/test/test_plistlib.py Outdated Show resolved Hide resolved
aisk and others added 3 commits January 2, 2024 22:37
@aisk @ronaldoussoren
Update Lib/test/test_plistlib.py
37c8965 
Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
@aisk
fix typo
abe7cdf
@aisk
remove the msg temp variable
e097d4c
ronaldoussoren
ronaldoussoren approved these changes Jan 6, 2024
View reviewed changes
Copy link
Contributor

@ronaldoussoren ronaldoussoren left a comment

Choose a reason for hiding this comment

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

LGTM.

Thanks for the PR!

@ronaldoussoren ronaldoussoren merged commit bbf214d into python:main Jan 6, 2024
30 of 31 checks passed
@aisk aisk deleted the plists-loads-str branch January 6, 2024 09:42
@aisk
Copy link
Contributor Author

aisk commented Jan 6, 2024

Thanks for the view!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ronaldoussoren ronaldoussoren ronaldoussoren approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@aisk @ronaldoussoren