From: Collin Styles <collingstyles@gmail.com>
Date: Sun, 14 Jul 2019 09:01:48 +0000 (-0700)
Subject: Clarify that plistlib's load and dump functions take a binary file object (GH-9825)
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0d4f4352efecf1b044c88e234e71774fe04b7d6c;p=python

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.html#plistlib.load
https://docs.python.org/3/library/plistlib.html#plistlib.dump
---

diff --git a/Lib/plistlib.py b/Lib/plistlib.py
index 0133c89bdc..04f8a87634 100644
--- a/Lib/plistlib.py
+++ b/Lib/plistlib.py
@@ -971,7 +971,7 @@ _FORMATS={
 
 
 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,))