[Python-checkins] Clarify that plistlib's load and dump functions take a binary file object (GH-9825)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/3958b7aae8cc7c571a842ff43c1dea1da9abdd9d
commit: 3958b7aae8cc7c571a842ff43c1dea1da9abdd9d
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-07-14T02:25:43-07:00
summary:

Clarify that plistlib's load and dump functions take a binary file object (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 0d4f4352efecf1b044c88e234e71774fe04b7d6c)

Co-authored-by: Collin Styles <collingstyles at gmail.com>

files:
M Lib/plistlib.py

diff --git a/Lib/plistlib.py b/Lib/plistlib.py
index 0133c89bdc66..04f8a87634d3 100644
--- a/Lib/plistlib.py
+++ b/Lib/plistlib.py
@@ -971,7 +971,7 @@ def _is_fmt_binary(header):
 
 
 def load(fp, *, fmt=None, use_builtin_types=True, dict_type=dict):
-    """Read a .plist file. 'fp' should be (readable) file object.
+    """Read a .plist file. 'fp' should be a readable and binary file object.
     Return the unpacked root object (which usually is a dictionary).
     """
     if fmt is None:
@@ -1002,8 +1002,8 @@ def loads(value, *, fmt=None, use_builtin_types=True, dict_type=dict):
 
 
 def dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False):
-    """Write 'value' to a .plist file. 'fp' should be a (writable)
-    file object.
+    """Write 'value' to a .plist file. 'fp' should be a writable,
+    binary file object.
     """
     if fmt not in _FORMATS:
         raise ValueError("Unsupported format: %r"%(fmt,))