diff options
author | Jon Janzen <jjjonjanzen@gmail.com> | 2019-09-05 08:11:35 (GMT) |
---|---|---|
committer | Ronald Oussoren <ronaldoussoren@mac.com> | 2019-09-05 08:11:35 (GMT) |
commit | ce81a925ef2d466b0d801deaba9af44a0dfc2aa1 (patch) | |
tree | 79cb85d7a29b38ce1a94a4ca7baba1b01ac66239 /Doc/library | |
parent | 9b51570ffd0494c07dafe10c7d2afe865754694c (diff) | |
download | cpython-ce81a925ef2d466b0d801deaba9af44a0dfc2aa1.zip cpython-ce81a925ef2d466b0d801deaba9af44a0dfc2aa1.tar.gz cpython-ce81a925ef2d466b0d801deaba9af44a0dfc2aa1.tar.bz2 |
bpo-36409: Remove old plistlib API deprecated in 3.4 (GH-15615)
* Remove implementation for old plistlib API deprecated in 3.4
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/plistlib.rst | 82 |
1 files changed, 6 insertions, 76 deletions
diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index d84fcac..f71aaa2 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -30,7 +30,7 @@ To work with plist data in bytes objects, use :func:`dumps` and :func:`loads`. Values can be strings, integers, floats, booleans, tuples, lists, dictionaries -(but only with string keys), :class:`Data`, :class:`bytes`, :class:`bytesarray` +(but only with string keys), :class:`bytes`, :class:`bytearray` or :class:`datetime.datetime` objects. .. versionchanged:: 3.4 @@ -40,6 +40,9 @@ or :class:`datetime.datetime` objects. Support added for reading and writing :class:`UID` tokens in binary plists as used by NSKeyedArchiver and NSKeyedUnarchiver. +.. versionchanged:: 3.9 + Old API removed. + .. seealso:: `PList manual page <https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/PropertyLists/>`_ @@ -48,7 +51,7 @@ or :class:`datetime.datetime` objects. This module defines the following functions: -.. function:: load(fp, \*, fmt=None, use_builtin_types=True, dict_type=dict) +.. function:: load(fp, \*, fmt=None, dict_type=dict) Read a plist file. *fp* should be a readable and binary file object. Return the unpacked root object (which usually is a @@ -62,10 +65,6 @@ This module defines the following functions: * :data:`FMT_BINARY`: Binary plist format - If *use_builtin_types* is true (the default) binary data will be returned - as instances of :class:`bytes`, otherwise it is returned as instances of - :class:`Data`. - The *dict_type* is the type used for dictionaries that are read from the plist file. @@ -80,7 +79,7 @@ This module defines the following functions: .. versionadded:: 3.4 -.. function:: loads(data, \*, fmt=None, use_builtin_types=True, dict_type=dict) +.. function:: loads(data, \*, fmt=None, dict_type=dict) Load a plist from a bytes object. See :func:`load` for an explanation of the keyword arguments. @@ -124,75 +123,6 @@ This module defines the following functions: .. versionadded:: 3.4 -The following functions are deprecated: - -.. function:: readPlist(pathOrFile) - - Read a plist file. *pathOrFile* may be either a file name or a (readable - and binary) file object. Returns the unpacked root object (which usually - is a dictionary). - - This function calls :func:`load` to do the actual work, see the documentation - of :func:`that function <load>` for an explanation of the keyword arguments. - - .. deprecated:: 3.4 Use :func:`load` instead. - - .. versionchanged:: 3.7 - Dict values in the result are now normal dicts. You no longer can use - attribute access to access items of these dictionaries. - - -.. function:: writePlist(rootObject, pathOrFile) - - Write *rootObject* to an XML plist file. *pathOrFile* may be either a file name - or a (writable and binary) file object - - .. deprecated:: 3.4 Use :func:`dump` instead. - - -.. function:: readPlistFromBytes(data) - - Read a plist data from a bytes object. Return the root object. - - See :func:`load` for a description of the keyword arguments. - - .. deprecated:: 3.4 Use :func:`loads` instead. - - .. versionchanged:: 3.7 - Dict values in the result are now normal dicts. You no longer can use - attribute access to access items of these dictionaries. - - -.. function:: writePlistToBytes(rootObject) - - Return *rootObject* as an XML plist-formatted bytes object. - - .. deprecated:: 3.4 Use :func:`dumps` instead. - - -The following classes are available: - -.. class:: Data(data) - - Return a "data" wrapper object around the bytes object *data*. This is used - in functions converting from/to plists to represent the ``<data>`` type - available in plists. - - It has one attribute, :attr:`data`, that can be used to retrieve the Python - bytes object stored in it. - - .. deprecated:: 3.4 Use a :class:`bytes` object instead. - -.. class:: UID(data) - - Wraps an :class:`int`. This is used when reading or writing NSKeyedArchiver - encoded data, which contains UID (see PList manual). - - It has one attribute, :attr:`data` which can be used to retrieve the int value - of the UID. :attr:`data` must be in the range `0 <= data <= 2**64`. - - .. versionadded:: 3.8 - The following constants are available: |