`plistlib.md`

185 строк · 12.1 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/plistlib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 14.5. [`plistlib`](https://python-all.ru/3.6/library/plistlib.html#module-plistlib) – Generate and parse Mac OS X `.plist` files89**Исходный код:** [Lib/plistlib.py](https://python-all.ru/src/3.6/Lib/plistlib.py)1011---1213Этот модуль предоставляет интерфейс для чтения и записи файлов «property list» (списков свойств), используемых в основном в Mac OS X, и поддерживает как двоичные, так и XML-файлы plist.1415Формат файла списка свойств (`.plist`) – это простая сериализация, поддерживающая базовые типы объектов: словари, списки, числа и строки. Обычно корневой объект является словарём.1617Для записи и разбора plist-файла используйте функции [`dump()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.dump) и [`load()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.load).1819Для работы с plist-данными в виде объектов bytes используйте [`dumps()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.dumps) и [`loads()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.loads).2021Значениями могут быть строки, целые числа, числа с плавающей запятой, булевы значения, кортежи, списки, словари (но только со строковыми ключами), объекты [`Data`](https://python-all.ru/3.6/library/plistlib.html#plistlib.Data), [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes), `bytesarray` или [`datetime.datetime`](https://python-all.ru/3.6/library/datetime.html#datetime.datetime).2223Изменено в версии 3.4: Новый API, старый API помечен как устаревший. Добавлена поддержка бинарного формата списков свойств.2425> **См. также**26>27> **[Страница руководства PList](https://python-all.ru/3.6/library/plistlib.html)**28>29> Документация Apple по формату файлов.3031Этот модуль определяет следующие функции:3233#### `plistlib.load(fp, *, fmt=None, use_builtin_types=True, dict_type=dict)`3435Читает plist-файл. *fp* должен быть читаемым бинарным файловым объектом. Возвращает распакованный корневой объект (обычно это словарь).3637Параметр *fmt* задаёт формат файла; допустимы следующие значения:3839- [`None`](https://python-all.ru/3.6/library/constants.html#None): Автоопределение формата файла40- [`FMT_XML`](https://python-all.ru/3.6/library/plistlib.html#plistlib.FMT_XML): Формат XML41- [`FMT_BINARY`](https://python-all.ru/3.6/library/plistlib.html#plistlib.FMT_BINARY): Бинарный формат plist4243Если *use\_builtin\_types* имеет значение true (по умолчанию), то бинарные данные будут возвращены как экземпляры [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes), иначе – как экземпляры [`Data`](https://python-all.ru/3.6/library/plistlib.html#plistlib.Data).4445The *dict\_type* is the type used for dictionaries that are read from the plist file. The exact structure of the plist can be recovered by using [`collections.OrderedDict`](https://python-all.ru/3.6/library/collections.html#collections.OrderedDict) (although the order of keys shouldn’t be important in plist files).4647XML-данные для формата [`FMT_XML`](https://python-all.ru/3.6/library/plistlib.html#plistlib.FMT_XML) разбираются с помощью парсера Expat из [`xml.parsers.expat`](https://python-all.ru/3.6/library/pyexpat.html#module-xml.parsers.expat). Обратитесь к его документации за информацией о возможных исключениях при некорректном XML. Неизвестные элементы просто игнорируются парсером plist.4849Парсер бинарного формата вызывает `InvalidFileException` когда файл не удаётся разобрать.5051Новое в версии 3.4.5253#### `plistlib.loads(data, *, fmt=None, use_builtin_types=True, dict_type=dict)`5455Загружает plist из байтового объекта. Пояснение именованных аргументов см. в [`load()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.load).5657Новое в версии 3.4.5859#### `plistlib.dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)`6061Записывает *value* в plist-файл. *Fp* должен быть записываемым бинарным файловым объектом.6263Аргумент *fmt* задаёт формат plist-файла и может принимать одно из следующих значений:6465- [`FMT_XML`](https://python-all.ru/3.6/library/plistlib.html#plistlib.FMT_XML): plist-файл в формате XML66- [`FMT_BINARY`](https://python-all.ru/3.6/library/plistlib.html#plistlib.FMT_BINARY): plist-файл в бинарном формате6768Если *sort\_keys* имеет значение true (по умолчанию), ключи словарей записываются в plist в отсортированном порядке, иначе – в порядке обхода словаря.6970Если *skipkeys* равен false (по умолчанию), функция возбуждает [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError), когда ключ словаря не является строкой; в противном случае такие ключи пропускаются.7172[`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError) будет возбуждено, если объект имеет неподдерживаемый тип или является контейнером, содержащим объекты неподдерживаемых типов.7374[`OverflowError`](https://python-all.ru/3.6/library/exceptions.html#OverflowError) будет возбуждено для целочисленных значений, которые не могут быть представлены в (бинарных) файлах plist.7576Новое в версии 3.4.7778#### `plistlib.dumps(value, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)`7980Возвращает *value* в виде bytes-объекта в формате plist. См. документацию для [`dump()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.dump) с описанием ключевых аргументов этой функции.8182Новое в версии 3.4.8384Следующие функции устарели:8586#### `plistlib.readPlist(pathOrFile)`8788Читает plist-файл. *pathOrFile* может быть именем файла или (читаемым и бинарным) файловым объектом. Возвращает распакованный корневой объект (который обычно является словарём).8990Эта функция вызывает [`load()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.load) для выполнения фактической работы; за объяснением именованных аргументов обратитесь к документации [`that function`](https://python-all.ru/3.6/library/plistlib.html#plistlib.load).9192> **Примечание**93>94> Dict values in the result have a `__getattr__` method that defers to `__getitem_`. This means that you can use attribute access to access items of these dictionaries.9596Устарело с версии 3.4: Вместо этого используйте [`load()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.load).9798#### `plistlib.writePlist(rootObject, pathOrFile)`99100Записывает *rootObject* в XML plist-файл. *pathOrFile* может быть именем файла или (доступным для записи и бинарным) файловым объектом101102Устарело с версии 3.4: Вместо этого используйте [`dump()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.dump).103104#### `plistlib.readPlistFromBytes(data)`105106Читает plist-данные из объекта bytes. Возвращает корневой объект.107108Описание именованных аргументов см. в [`load()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.load).109110> **Примечание**111>112> Dict values in the result have a `__getattr__` method that defers to `__getitem_`. This means that you can use attribute access to access items of these dictionaries.113114Устарело с версии 3.4: Вместо этого используйте [`loads()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.loads).115116#### `plistlib.writePlistToBytes(rootObject)`117118Возвращает *rootObject* в виде объекта bytes, отформатированного как XML plist.119120Устарело с версии 3.4: Вместо этого используйте [`dumps()`](https://python-all.ru/3.6/library/plistlib.html#plistlib.dumps).121122Доступны следующие классы:123124#### `Dict([dict]):`125126Return an extended mapping object with the same value as dictionary *dict*.127128This class is a subclass of [`dict`](https://python-all.ru/3.6/library/stdtypes.html#dict) where attribute access can be used to access items. That is, `aDict.key` is the same as `aDict['key']` for getting, setting and deleting items in the mapping.129130Устарело с версии 3.0.131132#### `class plistlib.Data(data)`133134Возвращает объект-обёртку «data» вокруг объекта bytes *data*. Он используется в функциях преобразования из plist-файлов и в plist-файлы для представления типа `<data>`, доступного в plist-файлах.135136У него есть один атрибут, `data`, который можно использовать для получения хранящегося в нём Python-объекта bytes.137138Устарело с версии 3.4: Вместо этого используйте объект [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes).139140Доступны следующие константы:141142#### `plistlib.FMT_XML`143144Формат XML для файлов plist.145146Новое в версии 3.4.147148#### `plistlib.FMT_BINARY`149150Бинарный формат для файлов plist151152Новое в версии 3.4.153154## 14.5.1. Примеры155156Генерация plist:157158```python159pl = dict(160    aString = "Doodah",161    aList = ["A", "B", 12, 32.1, [1, 2, 3]],162    aFloat = 0.1,163    anInt = 728,164    aDict = dict(165        anotherString = "<hello & hi there!>",166        aThirdString = "M\xe4ssig, Ma\xdf",167        aTrueValue = True,168        aFalseValue = False,169    ),170    someData = b"<binary gunk>",171    someMoreData = b"<lots of binary gunk>" * 10,172    aDate = datetime.datetime.fromtimestamp(time.mktime(time.gmtime())),173)174with open(fileName, 'wb') as fp:175    dump(pl, fp)176```177178Разбор plist:179180```python181with open(fileName, 'rb') as fp:182    pl = load(fp)183print(pl["aKey"])184```185