summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/plistlib.rst19
-rw-r--r--Doc/whatsnew/3.4.rst2
2 files changed, 16 insertions, 5 deletions
diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst
index 3cf8086..03cd3c1 100644
--- a/Doc/library/plistlib.rst
+++ b/Doc/library/plistlib.rst
@@ -79,6 +79,8 @@ This module defines the following functions:
Load a plist from a bytes object. See :func:`load` for an explanation of
the keyword arguments.
+ .. versionadded:: 3.4
+
.. function:: dump(value, fp, \*, fmt=FMT_XML, sort_keys=True, skipkeys=False)
@@ -102,8 +104,17 @@ This module defines the following functions:
A :exc:`TypeError` will be raised if the object is of an unsupported type or
a container that contains objects of unsupported types.
- .. versionchanged:: 3.4
- Added the *fmt*, *sort_keys* and *skipkeys* arguments.
+ An :exc:`OverflowError` will be raised for integer values that cannot
+ be represented in (binary) plist files.
+
+ .. warning::
+
+ For compatibility with Apple's libraries it is possible to write
+ an integer in the range from 2 ** 63 upto (and including) 2 ** 64
+ to binary plists, even though these will be read back as negative
+ values.
+
+ .. versionadded: 3.4
.. function:: dumps(value, \*, fmt=FMT_XML, sort_keys=True, skipkeys=False)
@@ -112,6 +123,7 @@ This module defines the following functions:
the documentation for :func:`dump` for an explanation of the keyword
arguments of this function.
+ .. versionadded: 3.4
The following functions are deprecated:
@@ -162,9 +174,6 @@ The following functions are deprecated:
.. deprecated:: 3.4 Use :func:`dumps` instead.
- .. versionchanged:: 3.4
- Added the *fmt*, *sort_keys* and *skipkeys* arguments.
-
The following classes are available:
diff --git a/Doc/whatsnew/3.4.rst b/Doc/whatsnew/3.4.rst
index d543973..6ace6d6 100644
--- a/Doc/whatsnew/3.4.rst
+++ b/Doc/whatsnew/3.4.rst
@@ -132,6 +132,8 @@ Significantly Improved Library Modules:
a new :mod:`~email.message.Message` subclass
(:class:`~email.contentmanager.EmailMessage`) that :ref:`simplify MIME
handling <whatsnew_email_contentmanager>` (:issue:`18891`).
+* :mod:`plistlib` has a cleaned up interface and support for binary
+ plist files (:issue:`14455`)
CPython implementation improvements: