This document is for an old version of Python that is no longer supported. You should upgrade, and read the Python documentation for the current stable release.

# `plistlib` — Genera y analiza archivos `.plist` de Apple

Código fuente: Lib/plistlib.py

Este módulo proporciona una interfaz para leer y escribir los archivos de «lista de propiedades» utilizados por Apple, principalmente en macOS e iOS. Este módulo admite archivos plist binarios y XML.

El formato de lista de propiedades (`.plist`) es una serialización simple que soporta tipos de objetos básicos, como diccionarios, listas, números y cadenas. Generalmente el objeto de nivel superior es un diccionario.

Para escribir y analizar un archivo plist usa las funciones `dump()` y `load()`.

Para trabajar con datos plist en objetos de bytes usa `dumps()` y `loads()`.

Los valores pueden ser cadenas, enteros, flotantes, booleanos, tuplas, listas, diccionarios (pero solo con claves de cadena), `bytes`, `bytearray` u objetos `datetime.datetime`.

Distinto en la versión 3.4: Nueva API, API antigua obsoleta. Añadido soporte para plists en formato binario.

Distinto en la versión 3.8: Añadido soporte para lectura y escritura de tokens `UID` en plists binarios como lo usan NSKeyedArchiver y NSKeyedUnarchiver.

Distinto en la versión 3.9: API antigua eliminada.

Ver también

Página del manual PList

  Documentación de Apple del formato de archivo.

Este módulo define las siguientes funciones:

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

  Lee un archivo plist. fp debe ser un objeto de archivo binario y legible. Retorna el objeto raíz desempaquetado (el cual generalmente es un diccionario).

  El fmt es el formato del archivo y los siguientes valores son válidos:

  - `None`: Autodetecta el formato de archivo

  - `FMT_XML`: Formato de archivo XML

  - `FMT_BINARY`: Formato binario plist

  EL dict_type es el tipo usado por los diccionarios que son leídos del archivo plist.

  Los datos XML para el formato `FMT_XML` son analizados usando el analizador Expat desde `xml.parsers.expat` – consulte su documentación para conocer las posibles excepciones en XML mal formado. Elementos desconocidos serán simplemente ignorados por el analizador plist.

  El analizar para el formato binario lanza `InvalidFileException` cuando el archivo no puede ser analizado.

  Nuevo en la versión 3.4.

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

  Carga un plist desde un objeto de bytes. Consulte `load()` para una explicación de los argumentos de palabra clave.

  Nuevo en la versión 3.4.

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

  Escribe value a un archivo plist. Fp debe ser un objeto de archivo binario escribible.

  El argumento fmt especifica el formato del archivo plist y puede ser uno de los siguientes valores:

  - `FMT_XML`: Archivo plist con formato XML

  - `FMT_BINARY`: Archivo plist con formato binario

  Cuando sort_keys es verdadero (el valor por defecto) las claves para los diccionarios serán escritas al plist ordenadamente, si no serán escritas en el orden de iteración del diccionario.

  Cuando skipkeys es falso (el valor por defecto) la función levanta `TypeError` cuando una clave del diccionario no es una cadena de caracteres, si no tales claves serán omitidas.

  Una excepción `TypeError` será levantada si el objeto es un tipo no admitido o el contenedor que contiene tipos no admitidos.

  Una excepción `OverflowError` será levantada para valores enteros que no pueden ser representados en archivos plist (binarios).

  Nuevo en la versión 3.4.

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

  Retorna value como un objeto de bytes con formato plist. Consulte la documentación de `dump()` para una explicación de los argumentos de palabra clave de esta función.

  Nuevo en la versión 3.4.

Las siguientes clases están disponibles:

class `plistlib.``UID`(data)

  Envuelve un `int`. Este es usado leyendo o escribiendo datos codificados NSKeyedArchiver, los cuales contienen UID (ver manual PList).

  It has one attribute, `data`, which can be used to retrieve the int value of the UID. `data` must be in the range `0 <= data < 2**64`.

  Nuevo en la versión 3.8.

Las siguientes constantes están disponibles:

`plistlib.``FMT_XML`

  El formato XML para archivos plist.

  Nuevo en la versión 3.4.

`plistlib.``FMT_BINARY`

  El formato binario para archivos plist

  Nuevo en la versión 3.4.

## Ejemplos

Generar un 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)

Analizar un plist:

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