`plistlib.md`

173 строк · 11.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.7/library/plistlib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`plistlib`](https://python-all.ru/3.7/library/plistlib.html#module-plistlib) – создание и разбор файлов Mac OS X `.plist`89**Исходный код:** [Lib/plistlib.py](https://python-all.ru/src/3.7/Lib/plistlib.py)1011---1213Этот модуль предоставляет интерфейс для чтения и записи файлов «property list» (списков свойств), используемых в основном в Mac OS X, и поддерживает как двоичные, так и XML-файлы plist.1415Формат файла списка свойств (`.plist`) – это простая сериализация, поддерживающая базовые типы объектов: словари, списки, числа и строки. Обычно корневой объект является словарём.1617Для записи и разбора plist-файла используйте функции [`dump()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.dump) и [`load()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.load).1819Для работы с plist-данными в виде объектов bytes используйте [`dumps()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.dumps) и [`loads()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.loads).2021Значениями могут быть строки, целые числа, числа с плавающей запятой, булевы значения, кортежи, списки, словари (но только со строковыми ключами), объекты [`Data`](https://python-all.ru/3.7/library/plistlib.html#plistlib.Data), [`bytes`](https://python-all.ru/3.7/library/stdtypes.html#bytes), `bytesarray` или [`datetime.datetime`](https://python-all.ru/3.7/library/datetime.html#datetime.datetime).2223Изменено в версии 3.4: Новый API, старый API помечен как устаревший. Добавлена поддержка бинарного формата списков свойств.2425> **См. также**26>27> **[Страница руководства PList](https://python-all.ru/3.7/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.7/library/constants.html#None): Автоопределение формата файла40- [`FMT_XML`](https://python-all.ru/3.7/library/plistlib.html#plistlib.FMT_XML): Формат XML41- [`FMT_BINARY`](https://python-all.ru/3.7/library/plistlib.html#plistlib.FMT_BINARY): Бинарный формат plist4243Если *use\_builtin\_types* имеет значение true (по умолчанию), то бинарные данные будут возвращены как экземпляры [`bytes`](https://python-all.ru/3.7/library/stdtypes.html#bytes), иначе – как экземпляры [`Data`](https://python-all.ru/3.7/library/plistlib.html#plistlib.Data).4445Параметр *dict\_type* задаёт тип, используемый для словарей, читаемых из plist-файла.4647XML-данные для формата [`FMT_XML`](https://python-all.ru/3.7/library/plistlib.html#plistlib.FMT_XML) разбираются с помощью парсера Expat из [`xml.parsers.expat`](https://python-all.ru/3.7/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.7/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.7/library/plistlib.html#plistlib.FMT_XML): plist-файл в формате XML66- [`FMT_BINARY`](https://python-all.ru/3.7/library/plistlib.html#plistlib.FMT_BINARY): plist-файл в бинарном формате6768Если *sort\_keys* имеет значение true (по умолчанию), ключи словарей записываются в plist в отсортированном порядке, иначе – в порядке обхода словаря.6970Если *skipkeys* равен false (по умолчанию), функция возбуждает [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError), когда ключ словаря не является строкой; в противном случае такие ключи пропускаются.7172[`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError) будет возбуждено, если объект имеет неподдерживаемый тип или является контейнером, содержащим объекты неподдерживаемых типов.7374[`OverflowError`](https://python-all.ru/3.7/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.7/library/plistlib.html#plistlib.dump) с описанием ключевых аргументов этой функции.8182Новое в версии 3.4.8384Следующие функции устарели:8586#### `plistlib.readPlist(pathOrFile)`8788Читает plist-файл. *pathOrFile* может быть именем файла или (читаемым и бинарным) файловым объектом. Возвращает распакованный корневой объект (который обычно является словарём).8990Эта функция вызывает [`load()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.load) для выполнения фактической работы; за объяснением именованных аргументов обратитесь к документации [`that function`](https://python-all.ru/3.7/library/plistlib.html#plistlib.load).9192Устарело с версии 3.4: Вместо этого используйте [`load()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.load).9394Изменено в версии 3.7: Значения словарей в результате теперь являются обычными словарями. Доступ по атрибутам для получения элементов этих словарей больше не поддерживается.9596#### `plistlib.writePlist(rootObject, pathOrFile)`9798Записывает *rootObject* в XML plist-файл. *pathOrFile* может быть именем файла или (доступным для записи и бинарным) файловым объектом99100Устарело с версии 3.4: Вместо этого используйте [`dump()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.dump).101102#### `plistlib.readPlistFromBytes(data)`103104Читает plist-данные из объекта bytes. Возвращает корневой объект.105106Описание именованных аргументов см. в [`load()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.load).107108Устарело с версии 3.4: Вместо этого используйте [`loads()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.loads).109110Изменено в версии 3.7: Значения словарей в результате теперь являются обычными словарями. Доступ по атрибутам для получения элементов этих словарей больше не поддерживается.111112#### `plistlib.writePlistToBytes(rootObject)`113114Возвращает *rootObject* в виде объекта bytes, отформатированного как XML plist.115116Устарело с версии 3.4: Вместо этого используйте [`dumps()`](https://python-all.ru/3.7/library/plistlib.html#plistlib.dumps).117118Доступны следующие классы:119120#### `class plistlib.Data(data)`121122Возвращает объект-обёртку «data» вокруг объекта bytes *data*. Он используется в функциях преобразования из plist-файлов и в plist-файлы для представления типа `<data>`, доступного в plist-файлах.123124У него есть один атрибут, `data`, который можно использовать для получения хранящегося в нём Python-объекта bytes.125126Устарело с версии 3.4: Вместо этого используйте объект [`bytes`](https://python-all.ru/3.7/library/stdtypes.html#bytes).127128Доступны следующие константы:129130#### `plistlib.FMT_XML`131132Формат XML для файлов plist.133134Новое в версии 3.4.135136#### `plistlib.FMT_BINARY`137138Бинарный формат для файлов plist139140Новое в версии 3.4.141142## Примеры143144Генерация plist:145146```python147pl = dict(148    aString = "Doodah",149    aList = ["A", "B", 12, 32.1, [1, 2, 3]],150    aFloat = 0.1,151    anInt = 728,152    aDict = dict(153        anotherString = "<hello & hi there!>",154        aThirdString = "M\xe4ssig, Ma\xdf",155        aTrueValue = True,156        aFalseValue = False,157    ),158    someData = b"<binary gunk>",159    someMoreData = b"<lots of binary gunk>" * 10,160    aDate = datetime.datetime.fromtimestamp(time.mktime(time.gmtime())),161)162with open(fileName, 'wb') as fp:163    dump(pl, fp)164```165166Разбор plist:167168```python169with open(fileName, 'rb') as fp:170    pl = load(fp)171print(pl["aKey"])172```173