> **Источник:** https://python-all.ru/3.14/library/plistlib.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# `plistlib` – Генерирование и разбор файлов `.plist` Apple

**Исходный код:** [Lib/plistlib.py](https://python-all.ru/src/3.14/Lib/plistlib.py)

---

Этот модуль предоставляет интерфейс для чтения и записи файлов «списка свойств» (property list), используемых Apple, в первую очередь на macOS и iOS. Модуль поддерживает как бинарные, так и XML plist-файлы.

Формат файла списка свойств (`.plist`) – это простая сериализация, поддерживающая базовые типы объектов: словари, списки, числа и строки. Обычно корневой объект является словарём.

Для записи и разбора plist-файла используйте функции [`dump()`](https://python-all.ru/3.14/library/plistlib.html#plistlib.dump) и [`load()`](https://python-all.ru/3.14/library/plistlib.html#plistlib.load).

Для работы с plist-данными в объектах bytes или string используйте [`dumps()`](https://python-all.ru/3.14/library/plistlib.html#plistlib.dumps) и [`loads()`](https://python-all.ru/3.14/library/plistlib.html#plistlib.loads).

Значениями могут быть строки, целые числа, числа с плавающей запятой, булевы значения, кортежи, списки, словари (но только со строковыми ключами), объекты [`bytes`](https://python-all.ru/3.14/library/stdtypes.html#bytes), [`bytearray`](https://python-all.ru/3.14/library/stdtypes.html#bytearray) или [`datetime.datetime`](https://python-all.ru/3.14/library/datetime.html#datetime.datetime).

Изменено в версии 3.4: Новый API, старый API помечен как устаревший. Добавлена поддержка бинарного формата списков свойств.

Изменено в версии 3.8: Добавлена поддержка чтения и записи токенов [...](https://python-all.ru/3.14/library/plistlib.html#plistlib.UID) в бинарных файлах списков свойств, используемых NSKeyedArchiver и NSKeyedUnarchiver.

Изменено в версии 3.9: Старый API удалён.

> **См. также**
>
> **[Страница руководства PList](https://python-all.ru/3.14/library/plistlib.html)**
>
> Документация Apple по формату файлов.

Этот модуль определяет следующие функции:

#### `plistlib.load(fp, *, fmt=None, dict_type=dict, aware_datetime=False)`

Читает plist-файл. *fp* должен быть читаемым бинарным файловым объектом. Возвращает распакованный корневой объект (обычно это словарь).

Параметр *fmt* задаёт формат файла; допустимы следующие значения:

- [`None`](https://python-all.ru/3.14/library/constants.html#None): Автоопределение формата файла
- [`FMT_XML`](https://python-all.ru/3.14/library/plistlib.html#plistlib.FMT_XML): Формат XML
- [`FMT_BINARY`](https://python-all.ru/3.14/library/plistlib.html#plistlib.FMT_BINARY): Бинарный формат plist

Параметр *dict\_type* задаёт тип, используемый для словарей, читаемых из plist-файла.

Когда *aware\_datetime* равен true, поля с типом `datetime.datetime` будут создаваться как [aware-объект](https://python-all.ru/3.14/library/datetime.html#datetime-naive-aware), с `tzinfo` в качестве [`datetime.UTC`](https://python-all.ru/3.14/library/datetime.html#datetime.UTC).

XML-данные для формата [`FMT_XML`](https://python-all.ru/3.14/library/plistlib.html#plistlib.FMT_XML) разбираются с помощью парсера Expat из [`xml.parsers.expat`](https://python-all.ru/3.14/library/pyexpat.html#module-xml.parsers.expat). Обратитесь к его документации за информацией о возможных исключениях при некорректном XML. Неизвестные элементы просто игнорируются парсером plist.

Парсер возбуждает исключение [`InvalidFileException`](https://python-all.ru/3.14/library/plistlib.html#plistlib.InvalidFileException), если файл не может быть разобран.

Добавлено в версии 3.4.

Изменено в версии 3.13: добавлен параметр только по ключевому слову *aware\_datetime*.

#### `plistlib.loads(data, *, fmt=None, dict_type=dict, aware_datetime=False)`

Загружает plist из объекта bytes или string. Описание именованных аргументов см. в [`load()`](https://python-all.ru/3.14/library/plistlib.html#plistlib.load).

Добавлено в версии 3.4.

Изменено в версии 3.13: *data* может быть строкой, если *fmt* равен [`FMT_XML`](https://python-all.ru/3.14/library/plistlib.html#plistlib.FMT_XML).

#### `plistlib.dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False, aware_datetime=False)`

Записывает *value* в plist-файл. *fp* должен быть доступным для записи бинарным файловым объектом.

Аргумент *fmt* задаёт формат plist-файла и может принимать одно из следующих значений:

- [`FMT_XML`](https://python-all.ru/3.14/library/plistlib.html#plistlib.FMT_XML): plist-файл в формате XML
- [`FMT_BINARY`](https://python-all.ru/3.14/library/plistlib.html#plistlib.FMT_BINARY): plist-файл в бинарном формате

Если *sort\_keys* имеет значение true (по умолчанию), ключи словарей записываются в plist в отсортированном порядке, иначе – в порядке обхода словаря.

Если *skipkeys* равен false (по умолчанию), функция возбуждает [`TypeError`](https://python-all.ru/3.14/library/exceptions.html#TypeError), когда ключ словаря не является строкой; в противном случае такие ключи пропускаются.

Если *aware\_datetime* равен true и какое-либо поле типа `datetime.datetime` установлено как [объект с часовым поясом](https://python-all.ru/3.14/library/datetime.html#datetime-naive-aware), перед записью оно будет преобразовано в часовой пояс UTC.

[`TypeError`](https://python-all.ru/3.14/library/exceptions.html#TypeError) будет возбуждено, если объект имеет неподдерживаемый тип или является контейнером, содержащим объекты неподдерживаемых типов.

[`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError) будет возбуждено для целочисленных значений, которые не могут быть представлены в (бинарных) файлах plist.

Добавлено в версии 3.4.

Изменено в версии 3.13: добавлен параметр только по ключевому слову *aware\_datetime*.

#### `plistlib.dumps(value, *, fmt=FMT_XML, sort_keys=True, skipkeys=False, aware_datetime=False)`

Возвращает *value* в виде bytes-объекта в формате plist. См. документацию для [`dump()`](https://python-all.ru/3.14/library/plistlib.html#plistlib.dump) с описанием ключевых аргументов этой функции.

Добавлено в версии 3.4.

Доступны следующие классы:

#### `class plistlib.UID(data)`

Обёртка для [`int`](https://python-all.ru/3.14/library/functions.html#int). Используется при чтении или записи данных, закодированных NSKeyedArchiver, которые содержат UID (см. руководство по PList).

#### `data`

Целое значение UID. Оно должно быть в диапазоне `0 <= data < 2**64`.

Добавлено в версии 3.8.

Доступны следующие константы:

#### `plistlib.FMT_XML`

Формат XML для файлов plist.

Добавлено в версии 3.4.

#### `plistlib.FMT_BINARY`

Бинарный формат для файлов plist

Добавлено в версии 3.4.

Модуль определяет следующие исключения:

#### `exception plistlib.InvalidFileException`

Возбуждается, когда файл не может быть разобран.

Добавлено в версии 3.4.

## Примеры

Генерация plist:

```python
import datetime as dt
import plistlib

pl = dict(
    aString = "Doodah",
    aList = ["A", "B", 12, 32.1, [1, 2, 3]],
    aFloat = 0.1,
    anInt = 728,
    aDict = dict(
        anotherString = "<hello & hi there!>",
        aThirdString = "M\xe4ssig, Ma\xdf",
        aTrueValue = True,
        aFalseValue = False,
    ),
    someData = b"<binary gunk>",
    someMoreData = b"<lots of binary gunk>" * 10,
    aDate = dt.datetime.now()
)
print(plistlib.dumps(pl).decode())
```

Разбор plist:

```python
import plistlib

plist = b"""<plist version="1.0">
<dict>
    <key>foo</key>
    <string>bar</string>
</dict>
</plist>"""
pl = plistlib.loads(plist)
print(pl["foo"])
```
