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

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

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

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

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

Для работы с данными plist в объектах bytes используйте 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. Точную структуру plist можно восстановить, используя collections.OrderedDict (хотя порядок ключей в файлах 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 из объекта 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 как объект байтов в формате plist. См. документацию для dump() для объяснения ключевых аргументов этой функции.

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

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

plistlib.readPlist(pathOrFile)

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

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

Примечание

Значения словарей в результате имеют метод __getattr__ , который пересылает на __getitem_. Это означает, что вы можете использовать доступ к атрибутам для доступа к элементам этих словарей.

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

plistlib.writePlist(rootObject, pathOrFile)

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

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

plistlib.readPlistFromBytes(data)

Прочитать данные plist из объекта bytes. Возвращает корневой объект.

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

Примечание

Значения словарей в результате имеют метод __getattr__ , который пересылает на __getitem_. Это означает, что вы можете использовать доступ к атрибутам для доступа к элементам этих словарей.

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

plistlib.writePlistToBytes(rootObject)

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

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

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

Dict([dict]):

Возвращает расширенный объект отображения со значением, равным словарю dict.

Этот класс является подклассом dict, где доступ к атрибутам можно использовать для доступа к элементам. То есть, aDict.key эквивалентно aDict['key'] для получения, установки и удаления элементов в отображении.

Устарело начиная с версии 3.0.

class plistlib.Data(data)

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

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

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

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

plistlib.FMT_XML

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

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

plistlib.FMT_BINARY

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

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

1. Примеры

Генерация 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"])