plistlib — Генерация и разбор файлов Mac OS X .plist

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

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

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

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

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

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

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

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

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

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

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

Если use_builtin_types имеет значение true (по умолчанию), двоичные данные будут возвращаться как экземпляры bytes, в противном случае они возвращаются как экземпляры Data.

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

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

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

Новое в версии 3.4.

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

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

Новое в версии 3.4.

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

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

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

• FMT_XML: XML-форматированный файл plist
• 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 в виде объекта байтов в формате plist. См. документацию по dump() для объяснения ключевых аргументов этой функции.

Новое в версии 3.4.

Следующие функции устарели:

plistlib.readPlist(pathOrFile)

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

Эта функция вызывает load() для выполнения фактической работы; см. документацию that function для объяснения ключевых аргументов.

Устарело начиная с версии 3.4: Используйте load() вместо этого.

Изменено в версии 3.7: Значения словарей в результате теперь являются обычными словарями. Вы больше не можете использовать доступ по атрибутам для доступа к элементам этих словарей.

plistlib.writePlist(rootObject, pathOrFile)

Запись rootObject в XML-файл plist. pathOrFile может быть именем файла или объектом файла (для записи в двоичном формате)

Устарело начиная с версии 3.4: Используйте dump() вместо этого.

plistlib.readPlistFromBytes(data)

Чтение данных plist из объекта байтов. Возвращает корневой объект.

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

Устарело начиная с версии 3.4: Используйте loads() вместо этого.

Изменено в версии 3.7: Значения словарей в результате теперь являются обычными словарями. Вы больше не можете использовать доступ по атрибутам для доступа к элементам этих словарей.

plistlib.writePlistToBytes(rootObject)

Возврат rootObject в виде объекта байтов в формате XML plist.

Устарело начиная с версии 3.4: Используйте dumps() вместо этого.

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

class plistlib.Data(data)

Возвращает объект-оболочку «данных» вокруг объекта байтов data. Используется в функциях преобразования из/в plist для представления типа <data>, доступного в plist.

Он имеет один атрибут, data, который может быть использован для извлечения хранящегося в нем объекта байтов Python.

Устарело начиная с версии 3.4: Используйте объект bytes вместо этого.

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

plistlib.FMT_XML

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

Новое в версии 3.4.

plistlib.FMT_BINARY

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

Новое в версии 3.4.

Примеры

Генерация plist:

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.fromtimestamp(time.mktime(time.gmtime())),
)
with open(fileName, 'wb') as fp:
    dump(pl, fp)

Разбор plist:

with open(fileName, 'rb') as fp:
    pl = load(fp)
print(pl["aKey"])