Clarify that plistlib's load and dump functions take a binary file object #9825
Conversation
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
…ject The documentation says that the fp parameter to plistlib.load "should be a readable and binary file object" but the docstring only mentions that it should be readable. Similarly, plistlib.dump's docstring only mentions "writable". This commit clarifies that fp should also be binary. https://docs.python.org/3/library/plistlib.html#plistlib.load https://docs.python.org/3/library/plistlib.html#plistlib.dump
|
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA). Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. You can check yourself to see if the CLA has been received. Thanks again for your contribution, we look forward to reviewing it! |
|
Can I request the "type-documentation", "skip issue", and "skip news" tags? |
|
@ronaldoussoren As per Serhiy's request, please review when you get a chance. Thanks! |
ronaldoussoren
approved these changes
Jul 14, 2019
|
Thanks @cstyles for the PR, and @ronaldoussoren for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8. |
|
I'm having trouble backporting to |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 14, 2019
…ject (pythonGH-9825) The documentation says that the fp parameter to plistlib.load "should be a readable and binary file object" but the docstring only mentions that it should be readable. Similarly, plistlib.dump's docstring only mentions "writable". This commit clarifies that fp should also be binary. https://docs.python.org/3/library/plistlib.htmlGH-plistlib.load https://docs.python.org/3/library/plistlib.htmlGH-plistlib.dump (cherry picked from commit 0d4f435) Co-authored-by: Collin Styles <[email protected]>
|
GH-14769 is a backport of this pull request to the 3.7 branch. |
|
Thanks @cstyles for the PR, and @ronaldoussoren for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 14, 2019
…ject (pythonGH-9825) The documentation says that the fp parameter to plistlib.load "should be a readable and binary file object" but the docstring only mentions that it should be readable. Similarly, plistlib.dump's docstring only mentions "writable". This commit clarifies that fp should also be binary. https://docs.python.org/3/library/plistlib.htmlGH-plistlib.load https://docs.python.org/3/library/plistlib.htmlGH-plistlib.dump (cherry picked from commit 0d4f435) Co-authored-by: Collin Styles <[email protected]>
|
GH-14770 is a backport of this pull request to the 3.8 branch. |
miss-islington
added a commit
that referenced
this pull request
Jul 14, 2019
…ject (GH-9825) The documentation says that the fp parameter to plistlib.load "should be a readable and binary file object" but the docstring only mentions that it should be readable. Similarly, plistlib.dump's docstring only mentions "writable". This commit clarifies that fp should also be binary. https://docs.python.org/3/library/plistlib.htmlGH-plistlib.load https://docs.python.org/3/library/plistlib.htmlGH-plistlib.dump (cherry picked from commit 0d4f435) Co-authored-by: Collin Styles <[email protected]>
miss-islington
added a commit
that referenced
this pull request
Jul 14, 2019
…ject (GH-9825) The documentation says that the fp parameter to plistlib.load "should be a readable and binary file object" but the docstring only mentions that it should be readable. Similarly, plistlib.dump's docstring only mentions "writable". This commit clarifies that fp should also be binary. https://docs.python.org/3/library/plistlib.htmlGH-plistlib.load https://docs.python.org/3/library/plistlib.htmlGH-plistlib.dump (cherry picked from commit 0d4f435) Co-authored-by: Collin Styles <[email protected]>
lisroach
pushed a commit
to lisroach/cpython
that referenced
this pull request
Sep 10, 2019
…ject (pythonGH-9825) The documentation says that the fp parameter to plistlib.load "should be a readable and binary file object" but the docstring only mentions that it should be readable. Similarly, plistlib.dump's docstring only mentions "writable". This commit clarifies that fp should also be binary. https://docs.python.org/3/library/plistlib.html#plistlib.load https://docs.python.org/3/library/plistlib.html#plistlib.dump
DinoV
pushed a commit
to DinoV/cpython
that referenced
this pull request
Jan 14, 2020
…ject (pythonGH-9825) The documentation says that the fp parameter to plistlib.load "should be a readable and binary file object" but the docstring only mentions that it should be readable. Similarly, plistlib.dump's docstring only mentions "writable". This commit clarifies that fp should also be binary. https://docs.python.org/3/library/plistlib.html#plistlib.load https://docs.python.org/3/library/plistlib.html#plistlib.dump
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation says that the fp parameter to plistlib.load "should be a
readable and binary file object" but the docstring only mentions that it
should be readable. Similarly, plistlib.dump's docstring only mentions
"writable". This commit clarifies that fp should also be binary.
https://docs.python.org/3/library/plistlib.html#plistlib.load
https://docs.python.org/3/library/plistlib.html#plistlib.dump