diff options
author | Ronald Oussoren <ronaldoussoren@mac.com> | 2014-01-15 10:32:35 (GMT) |
---|---|---|
committer | Ronald Oussoren <ronaldoussoren@mac.com> | 2014-01-15 10:32:35 (GMT) |
commit | 6db6653bbc0841600248e4d7b7542591067c4157 (patch) | |
tree | 1c3c992658e8f361b903bfcd3956956fcf7abf5e /Doc/library/plistlib.rst | |
parent | 4a714d48ad727f6ad708ba2d3695f1dea4479fb6 (diff) | |
download | cpython-6db6653bbc0841600248e4d7b7542591067c4157.zip cpython-6db6653bbc0841600248e4d7b7542591067c4157.tar.gz cpython-6db6653bbc0841600248e4d7b7542591067c4157.tar.bz2 |
Issue #14455: Fix some issues with plistlib
* Negative integer support in binary plists was broken
* Better exception for invalid data
* Fix the versionadded/versionchanged markup in the documentation
* Add the interface cleanup to what's new for 3.4
Diffstat (limited to 'Doc/library/plistlib.rst')
-rw-r--r-- | Doc/library/plistlib.rst | 19 |
1 files changed, 14 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: |