Georg Brandl | c575c90 | 2008-09-13 17:46:05 +0000 | [diff] [blame] | 1 | :mod:`plistlib` --- Generate and parse Mac OS X ``.plist`` files |
| 2 | ================================================================ |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 3 | |
| 4 | .. module:: plistlib |
Georg Brandl | c575c90 | 2008-09-13 17:46:05 +0000 | [diff] [blame] | 5 | :synopsis: Generate and parse Mac OS X plist files. |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 6 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 7 | .. moduleauthor:: Jack Jansen |
| 8 | .. sectionauthor:: Georg Brandl <georg@python.org> |
| 9 | .. (harvested from docstrings in the original file) |
| 10 | |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 11 | **Source code:** :source:`Lib/plistlib.py` |
| 12 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 13 | .. index:: |
| 14 | pair: plist; file |
| 15 | single: property list |
| 16 | |
Raymond Hettinger | 469271d | 2011-01-27 20:38:46 +0000 | [diff] [blame] | 17 | -------------- |
| 18 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 19 | This module provides an interface for reading and writing the "property list" |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 20 | files used mainly by Mac OS X and supports both binary and XML plist files. |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 21 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 22 | The property list (``.plist``) file format is a simple serialization supporting |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 23 | basic object types, like dictionaries, lists, numbers and strings. Usually the |
| 24 | top level object is a dictionary. |
| 25 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 26 | To write out and to parse a plist file, use the :func:`dump` and |
| 27 | :func:`load` functions. |
Ezio Melotti | 6e9b1df | 2009-09-16 00:49:03 +0000 | [diff] [blame] | 28 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 29 | To work with plist data in bytes objects, use :func:`dumps` |
| 30 | and :func:`loads`. |
Ezio Melotti | 6e9b1df | 2009-09-16 00:49:03 +0000 | [diff] [blame] | 31 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 32 | Values can be strings, integers, floats, booleans, tuples, lists, dictionaries |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 33 | (but only with string keys), :class:`Data`, :class:`bytes`, :class:`bytesarray` |
| 34 | or :class:`datetime.datetime` objects. |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 35 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 36 | .. versionchanged:: 3.4 |
| 37 | New API, old API deprecated. Support for binary format plists added. |
| 38 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 39 | .. seealso:: |
| 40 | |
Sanyam Khurana | 338cd83 | 2018-01-20 05:55:37 +0530 | [diff] [blame] | 41 | `PList manual page <https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/PropertyLists/>`_ |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 42 | Apple's documentation of the file format. |
| 43 | |
| 44 | |
| 45 | This module defines the following functions: |
| 46 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 47 | .. function:: load(fp, \*, fmt=None, use_builtin_types=True, dict_type=dict) |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 48 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 49 | Read a plist file. *fp* should be a readable and binary file object. |
| 50 | Return the unpacked root object (which usually is a |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 51 | dictionary). |
| 52 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 53 | The *fmt* is the format of the file and the following values are valid: |
| 54 | |
| 55 | * :data:`None`: Autodetect the file format |
| 56 | |
| 57 | * :data:`FMT_XML`: XML file format |
| 58 | |
| 59 | * :data:`FMT_BINARY`: Binary plist format |
| 60 | |
Serhiy Storchaka | 0e90e99 | 2013-11-29 12:19:53 +0200 | [diff] [blame] | 61 | If *use_builtin_types* is true (the default) binary data will be returned |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 62 | as instances of :class:`bytes`, otherwise it is returned as instances of |
| 63 | :class:`Data`. |
| 64 | |
| 65 | The *dict_type* is the type used for dictionaries that are read from the |
Andrés Delfino | 1cbdb22 | 2018-06-08 18:51:20 -0300 | [diff] [blame] | 66 | plist file. |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 67 | |
| 68 | XML data for the :data:`FMT_XML` format is parsed using the Expat parser |
| 69 | from :mod:`xml.parsers.expat` -- see its documentation for possible |
| 70 | exceptions on ill-formed XML. Unknown elements will simply be ignored |
| 71 | by the plist parser. |
| 72 | |
| 73 | The parser for the binary format raises :exc:`InvalidFileException` |
| 74 | when the file cannot be parsed. |
| 75 | |
| 76 | .. versionadded:: 3.4 |
| 77 | |
| 78 | |
| 79 | .. function:: loads(data, \*, fmt=None, use_builtin_types=True, dict_type=dict) |
| 80 | |
| 81 | Load a plist from a bytes object. See :func:`load` for an explanation of |
| 82 | the keyword arguments. |
| 83 | |
Ronald Oussoren | 6db6653 | 2014-01-15 11:32:35 +0100 | [diff] [blame] | 84 | .. versionadded:: 3.4 |
| 85 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 86 | |
| 87 | .. function:: dump(value, fp, \*, fmt=FMT_XML, sort_keys=True, skipkeys=False) |
| 88 | |
| 89 | Write *value* to a plist file. *Fp* should be a writable, binary |
| 90 | file object. |
| 91 | |
| 92 | The *fmt* argument specifies the format of the plist file and can be |
| 93 | one of the following values: |
| 94 | |
| 95 | * :data:`FMT_XML`: XML formatted plist file |
| 96 | |
| 97 | * :data:`FMT_BINARY`: Binary formatted plist file |
| 98 | |
| 99 | When *sort_keys* is true (the default) the keys for dictionaries will be |
| 100 | written to the plist in sorted order, otherwise they will be written in |
| 101 | the iteration order of the dictionary. |
| 102 | |
| 103 | When *skipkeys* is false (the default) the function raises :exc:`TypeError` |
| 104 | when a key of a dictionary is not a string, otherwise such keys are skipped. |
| 105 | |
| 106 | A :exc:`TypeError` will be raised if the object is of an unsupported type or |
| 107 | a container that contains objects of unsupported types. |
| 108 | |
Ronald Oussoren | 6db6653 | 2014-01-15 11:32:35 +0100 | [diff] [blame] | 109 | An :exc:`OverflowError` will be raised for integer values that cannot |
| 110 | be represented in (binary) plist files. |
| 111 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 112 | .. versionadded:: 3.4 |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 113 | |
| 114 | |
| 115 | .. function:: dumps(value, \*, fmt=FMT_XML, sort_keys=True, skipkeys=False) |
| 116 | |
| 117 | Return *value* as a plist-formatted bytes object. See |
| 118 | the documentation for :func:`dump` for an explanation of the keyword |
| 119 | arguments of this function. |
| 120 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 121 | .. versionadded:: 3.4 |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 122 | |
| 123 | The following functions are deprecated: |
| 124 | |
| 125 | .. function:: readPlist(pathOrFile) |
| 126 | |
| 127 | Read a plist file. *pathOrFile* may be either a file name or a (readable |
| 128 | and binary) file object. Returns the unpacked root object (which usually |
| 129 | is a dictionary). |
| 130 | |
Senthil Kumaran | b4760ef | 2015-06-14 17:35:37 -0700 | [diff] [blame] | 131 | This function calls :func:`load` to do the actual work, see the documentation |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 132 | of :func:`that function <load>` for an explanation of the keyword arguments. |
| 133 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 134 | .. deprecated:: 3.4 Use :func:`load` instead. |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 135 | |
Serhiy Storchaka | edef358 | 2017-05-15 13:21:31 +0300 | [diff] [blame] | 136 | .. versionchanged:: 3.7 |
| 137 | Dict values in the result are now normal dicts. You no longer can use |
| 138 | attribute access to access items of these dictionaries. |
| 139 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 140 | |
| 141 | .. function:: writePlist(rootObject, pathOrFile) |
| 142 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 143 | Write *rootObject* to an XML plist file. *pathOrFile* may be either a file name |
| 144 | or a (writable and binary) file object |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 145 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 146 | .. deprecated:: 3.4 Use :func:`dump` instead. |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 147 | |
| 148 | |
Ezio Melotti | 6e9b1df | 2009-09-16 00:49:03 +0000 | [diff] [blame] | 149 | .. function:: readPlistFromBytes(data) |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 150 | |
Ezio Melotti | 6e9b1df | 2009-09-16 00:49:03 +0000 | [diff] [blame] | 151 | Read a plist data from a bytes object. Return the root object. |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 152 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 153 | See :func:`load` for a description of the keyword arguments. |
| 154 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 155 | .. deprecated:: 3.4 Use :func:`loads` instead. |
| 156 | |
Serhiy Storchaka | edef358 | 2017-05-15 13:21:31 +0300 | [diff] [blame] | 157 | .. versionchanged:: 3.7 |
| 158 | Dict values in the result are now normal dicts. You no longer can use |
| 159 | attribute access to access items of these dictionaries. |
| 160 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 161 | |
Ezio Melotti | 6e9b1df | 2009-09-16 00:49:03 +0000 | [diff] [blame] | 162 | .. function:: writePlistToBytes(rootObject) |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 163 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 164 | Return *rootObject* as an XML plist-formatted bytes object. |
| 165 | |
| 166 | .. deprecated:: 3.4 Use :func:`dumps` instead. |
| 167 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 168 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 169 | The following classes are available: |
| 170 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 171 | .. class:: Data(data) |
| 172 | |
Ezio Melotti | 6e9b1df | 2009-09-16 00:49:03 +0000 | [diff] [blame] | 173 | Return a "data" wrapper object around the bytes object *data*. This is used |
| 174 | in functions converting from/to plists to represent the ``<data>`` type |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 175 | available in plists. |
| 176 | |
| 177 | It has one attribute, :attr:`data`, that can be used to retrieve the Python |
Ezio Melotti | 6e9b1df | 2009-09-16 00:49:03 +0000 | [diff] [blame] | 178 | bytes object stored in it. |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 179 | |
Martin Panter | d21e0b5 | 2015-10-10 10:36:22 +0000 | [diff] [blame] | 180 | .. deprecated:: 3.4 Use a :class:`bytes` object instead. |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 181 | |
| 182 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 183 | The following constants are available: |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 184 | |
| 185 | .. data:: FMT_XML |
| 186 | |
| 187 | The XML format for plist files. |
| 188 | |
| 189 | .. versionadded:: 3.4 |
| 190 | |
| 191 | |
| 192 | .. data:: FMT_BINARY |
| 193 | |
| 194 | The binary format for plist files |
| 195 | |
| 196 | .. versionadded:: 3.4 |
| 197 | |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 198 | |
| 199 | Examples |
| 200 | -------- |
| 201 | |
| 202 | Generating a plist:: |
| 203 | |
| 204 | pl = dict( |
Ezio Melotti | 985e24d | 2009-09-13 07:54:02 +0000 | [diff] [blame] | 205 | aString = "Doodah", |
| 206 | aList = ["A", "B", 12, 32.1, [1, 2, 3]], |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 207 | aFloat = 0.1, |
| 208 | anInt = 728, |
Ezio Melotti | 985e24d | 2009-09-13 07:54:02 +0000 | [diff] [blame] | 209 | aDict = dict( |
| 210 | anotherString = "<hello & hi there!>", |
| 211 | aThirdString = "M\xe4ssig, Ma\xdf", |
| 212 | aTrueValue = True, |
| 213 | aFalseValue = False, |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 214 | ), |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 215 | someData = b"<binary gunk>", |
| 216 | someMoreData = b"<lots of binary gunk>" * 10, |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 217 | aDate = datetime.datetime.fromtimestamp(time.mktime(time.gmtime())), |
| 218 | ) |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 219 | with open(fileName, 'wb') as fp: |
| 220 | dump(pl, fp) |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 221 | |
| 222 | Parsing a plist:: |
| 223 | |
Ronald Oussoren | c5cf797 | 2013-11-21 15:46:49 +0100 | [diff] [blame] | 224 | with open(fileName, 'rb') as fp: |
| 225 | pl = load(fp) |
Neal Norwitz | 752abd0 | 2008-05-13 04:55:24 +0000 | [diff] [blame] | 226 | print(pl["aKey"]) |