plistlib — Генерация и парсинг файлов Apple .plist

Исходный код: Lib/plistlib.py

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

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

Для записи и парсинга файла plist используйте функции dump() и load().

Для работы с данными plist в объектах типа bytes используйте dumps() и loads().

Значения могут быть строками, целыми числами, числами с плавающей точкой, булевыми значениями, кортежами, списками, словарями (но только со строковыми ключами), bytes, bytearray или объектами datetime.datetime.

В этом модуле определены следующие функции:

plistlib.load(fp, *, fmt=None, dict_type=dict)

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

fmt — это формат файла, и следующие значения допустимы:

• None: Автоматическое определение формата файла
• FMT_XML: Формат файла XML
• FMT_BINARY: Формат двоичного plist

dict_type — тип, используемый для словарей, считанных из файла plist.

XML-данные для формата FMT_XML анализируются с помощью парсера Expat из xml.parsers.expat — см. его документацию для возможных исключений при неправильно сформированном XML. Неизвестные элементы просто игнорируются парсером plist.

Парсер для двоичного формата вызывает InvalidFileException при невозможности разбора файла.

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

plistlib.loads(data, *, fmt=None, dict_type=dict)

Загрузка plist из объекта типа bytes. См. load() для объяснения ключевых аргументов.

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

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

Запись value в файл plist. Fp должен быть объектом двоичного файла для записи.

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

• FMT_XML: Файл plist в формате XML
• FMT_BINARY: Файл plist в двоичном формате

При sort_keys=True (по умолчанию) ключи словарей записываются в plist в отсортированном порядке, в противном случае они записываются в порядке итерации словаря.

При skipkeys=False (по умолчанию) функция вызывает TypeError, если ключ словаря не является строкой, в противном случае такие ключи пропускаются.

Будет вызвано TypeError, если объект имеет недопустимый тип или содержит контейнеры с недопустимыми типами объектов.

Будет вызвано OverflowError для целых значений, которые не могут быть представлены в файлах plist (двоичных).

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

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

Возвращает value в виде объекта bytes в формате plist. См. документацию для dump() для объяснения ключевых аргументов этой функции.

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

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

class plistlib.UID(data)

Оборачивает int. Используется при чтении или записи закодированных NSKeyedArchiver данных, содержащих UID (см. документацию по PList).

У него есть одно свойство, data, которое можно использовать для извлечения целочисленного значения UID. data должно находиться в диапазоне 0 <= data < 2**64.

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

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

plistlib.FMT_XML

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

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

plistlib.FMT_BINARY

Двоичный формат для файлов plist.

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

import datetime
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 = datetime.datetime.now()
)
print(plistlib.dumps(pl).decode())

import plistlib

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