`plistlib.md`

158 строк · 9.4 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.12/library/plistlib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `plistlib` – Генерирование и разбор файлов `.plist` Apple89**Исходный код:** [Lib/plistlib.py](https://python-all.ru/src/3.12/Lib/plistlib.py)1011---1213Этот модуль предоставляет интерфейс для чтения и записи файлов «списка свойств» (property list), используемых Apple, в первую очередь на macOS и iOS. Модуль поддерживает как бинарные, так и XML plist-файлы.1415Формат файла списка свойств (`.plist`) – это простая сериализация, поддерживающая базовые типы объектов: словари, списки, числа и строки. Обычно корневой объект является словарём.1617Для записи и разбора plist-файла используйте функции [`dump()`](https://python-all.ru/3.12/library/plistlib.html#plistlib.dump) и [`load()`](https://python-all.ru/3.12/library/plistlib.html#plistlib.load).1819Для работы с plist-данными в виде объектов bytes используйте [`dumps()`](https://python-all.ru/3.12/library/plistlib.html#plistlib.dumps) и [`loads()`](https://python-all.ru/3.12/library/plistlib.html#plistlib.loads).2021Значениями могут быть строки, целые числа, числа с плавающей запятой, булевы значения, кортежи, списки, словари (но только со строковыми ключами), объекты [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes), [`bytearray`](https://python-all.ru/3.12/library/stdtypes.html#bytearray) или [`datetime.datetime`](https://python-all.ru/3.12/library/datetime.html#datetime.datetime).2223Изменено в версии 3.4: Новый API, старый API помечен как устаревший. Добавлена поддержка бинарного формата списков свойств.2425Изменено в версии 3.8: Добавлена поддержка чтения и записи токенов [...](https://python-all.ru/3.12/library/plistlib.html#plistlib.UID) в бинарных файлах списков свойств, используемых NSKeyedArchiver и NSKeyedUnarchiver.2627Изменено в версии 3.9: Старый API удалён.2829> **См. также**30>31> **[Страница руководства PList](https://python-all.ru/3.12/library/plistlib.html)**32>33> Документация Apple по формату файлов.3435Этот модуль определяет следующие функции:3637#### `plistlib.load(fp, *, fmt=None, dict_type=dict)`3839Читает plist-файл. *fp* должен быть читаемым бинарным файловым объектом. Возвращает распакованный корневой объект (обычно это словарь).4041Параметр *fmt* задаёт формат файла; допустимы следующие значения:4243- [`None`](https://python-all.ru/3.12/library/constants.html#None): Автоопределение формата файла44- [`FMT_XML`](https://python-all.ru/3.12/library/plistlib.html#plistlib.FMT_XML): Формат XML45- [`FMT_BINARY`](https://python-all.ru/3.12/library/plistlib.html#plistlib.FMT_BINARY): Бинарный формат plist4647Параметр *dict\_type* задаёт тип, используемый для словарей, читаемых из plist-файла.4849XML-данные для формата [`FMT_XML`](https://python-all.ru/3.12/library/plistlib.html#plistlib.FMT_XML) разбираются с помощью парсера Expat из [`xml.parsers.expat`](https://python-all.ru/3.12/library/pyexpat.html#module-xml.parsers.expat). Обратитесь к его документации за информацией о возможных исключениях при некорректном XML. Неизвестные элементы просто игнорируются парсером plist.5051Парсер возбуждает исключение [`InvalidFileException`](https://python-all.ru/3.12/library/plistlib.html#plistlib.InvalidFileException), если файл не может быть разобран.5253Добавлено в версии 3.4.5455#### `plistlib.loads(data, *, fmt=None, dict_type=dict)`5657Загружает plist из байтового объекта. Пояснение именованных аргументов см. в [`load()`](https://python-all.ru/3.12/library/plistlib.html#plistlib.load).5859Добавлено в версии 3.4.6061#### `plistlib.dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)`6263Записывает *value* в plist-файл. *fp* должен быть доступным для записи бинарным файловым объектом.6465Аргумент *fmt* задаёт формат plist-файла и может принимать одно из следующих значений:6667- [`FMT_XML`](https://python-all.ru/3.12/library/plistlib.html#plistlib.FMT_XML): plist-файл в формате XML68- [`FMT_BINARY`](https://python-all.ru/3.12/library/plistlib.html#plistlib.FMT_BINARY): plist-файл в бинарном формате6970Если *sort\_keys* имеет значение true (по умолчанию), ключи словарей записываются в plist в отсортированном порядке, иначе – в порядке обхода словаря.7172Если *skipkeys* равен false (по умолчанию), функция возбуждает [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError), когда ключ словаря не является строкой; в противном случае такие ключи пропускаются.7374[`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError) будет возбуждено, если объект имеет неподдерживаемый тип или является контейнером, содержащим объекты неподдерживаемых типов.7576[`OverflowError`](https://python-all.ru/3.12/library/exceptions.html#OverflowError) будет возбуждено для целочисленных значений, которые не могут быть представлены в (бинарных) файлах plist.7778Добавлено в версии 3.4.7980#### `plistlib.dumps(value, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)`8182Возвращает *value* в виде bytes-объекта в формате plist. См. документацию для [`dump()`](https://python-all.ru/3.12/library/plistlib.html#plistlib.dump) с описанием ключевых аргументов этой функции.8384Добавлено в версии 3.4.8586Доступны следующие классы:8788#### `class plistlib.UID(data)`8990Обёртка для [`int`](https://python-all.ru/3.12/library/functions.html#int). Используется при чтении или записи данных, закодированных NSKeyedArchiver, которые содержат UID (см. руководство по PList).9192У него есть один атрибут, `data`, с помощью которого можно получить целочисленное значение UID. `data` должно находиться в диапазоне `0 <= data < 2**64`.9394Добавлено в версии 3.8.9596Доступны следующие константы:9798#### `plistlib.FMT_XML`99100Формат XML для файлов plist.101102Добавлено в версии 3.4.103104#### `plistlib.FMT_BINARY`105106Бинарный формат для файлов plist107108Добавлено в версии 3.4.109110Модуль определяет следующие исключения:111112#### `exception plistlib.InvalidFileException`113114Возбуждается, когда файл не может быть разобран.115116Добавлено в версии 3.4.117118## Примеры119120Генерация plist:121122```python123import datetime124import plistlib125126pl = dict(127    aString = "Doodah",128    aList = ["A", "B", 12, 32.1, [1, 2, 3]],129    aFloat = 0.1,130    anInt = 728,131    aDict = dict(132        anotherString = "<hello & hi there!>",133        aThirdString = "M\xe4ssig, Ma\xdf",134        aTrueValue = True,135        aFalseValue = False,136    ),137    someData = b"<binary gunk>",138    someMoreData = b"<lots of binary gunk>" * 10,139    aDate = datetime.datetime.now()140)141print(plistlib.dumps(pl).decode())142```143144Разбор plist:145146```python147import plistlib148149plist = b"""<plist version="1.0">150<dict>151    <key>foo</key>152    <string>bar</string>153</dict>154</plist>"""155pl = plistlib.loads(plist)156print(pl["foo"])157```158