PythonのplistlibモジュールでMac OS Xの.plistファイルを生成・解析する方法

はじめに

拡張子が「.plist」のファイルは、Mac OS Xのアプリケーションが設定情報（プロパティ）を保存するために使用するファイルです。Pythonの標準ライブラリであるplistlibモジュールは、このプロパティリストファイルの読み書きを行うためのインターフェースを提供します。

plistファイル形式と扱えるデータ型

plistファイル形式は、辞書（dict）、リスト、数値、文字列といった基本オブジェクト型をシリアライズします。通常、最上位のオブジェクトは辞書です。

plistファイルへの書き出しと読み込み（パース）には、それぞれdump()関数とload()関数を使用します。また、シリアライズされたバイト文字列として扱いたい場合は、dumps()関数とloads()関数を使います。格納できる値は、文字列、整数、浮動小数点数、ブール値、タプル、リスト、そして辞書（キーは文字列のみ可）です。

plistlibモジュールの主な関数

plistファイルへの書き込み例

次のスクリプトでは、シリアライズした辞書をplistファイルとして保存しています。

import plistlib

properties = {
    "name": "Ramesh",
    "College": "ABC College",
    "Class": "FY",
    "marks": {"phy": 60, "che": 60, "maths": 60}
}

with open('props.plist', 'wb') as fp:
    plistlib.dump(properties, fp)

ここでは、辞書propertiesをdump()関数で「props.plist」というファイルに書き出しています。バイナリ形式ではなくXML形式で出力したい場合は、fmt=plistlib.FMT_XMLを引数に追加してください。

plistファイルの読み込み例

保存したplistファイルを読み込むには、load()関数を使用します。

with open('props.plist', 'rb') as fp:
    pl = plistlib.load(fp)
    print(pl)

このコードを実行すると、ファイルから読み込んだ内容が辞書として出力されます。

{'name': 'Ramesh', 'College': 'ABC College', 'Class': 'FY', 'marks': {'phy': 60, 'che': 60, 'maths': 60}}

まとめ

plistlibモジュールを使えば、Mac OS Xで広く使われているplist形式のファイルを、Pythonから簡単に生成・解析できます。ファイルオブジェクトを扱うload()/dump()と、bytesオブジェクトを扱うloads()/dumps()を使い分けることで、XML形式・バイナリ形式どちらのplistファイルにも柔軟に対応できます。