Pythonのshelveモジュール解説：辞書感覚で使えるデータ永続化

shelveモジュールとは

Pythonの標準ライブラリに含まれるshelveモジュールは、本格的なリレーショナルデータベースを導入するまでもない規模のデータを、手軽に永続化したいときに役立つシンプルかつ効果的なツールです。

このモジュールで定義される「shelf（シェルフ）」オブジェクトは、通常の辞書（dict）とほぼ同じ感覚で操作できますが、その内容はディスク上のファイルに保存されるため、プログラムを終了してもデータが失われません。UNIX系システムで使われるdbmデータベースに似たファイルが生成される点も特徴です。

キーに指定できるのは文字列型のみという制限がありますが、値にはpickle化（シリアライズ）可能な任意のオブジェクトを格納できます。数値や文字列はもちろん、リスト・辞書・タプル、さらにはユーザー定義クラスのインスタンスまで保存可能です。

shelveモジュールを構成する3つのクラス

open()関数でShelfオブジェクトを作成する

Shelfオブジェクトを最も簡単に生成する方法は、shelveモジュールに定義された open() 関数を使うことです。この関数はDbfilenameShelfオブジェクトを返します。

open(filename, flag='c', protocol=None, writeback=False)

各パラメータの意味

• filename：作成されるデータベースファイルの名前を指定します。
• flag：ファイルの開き方を指定します。デフォルトは 'c' です。
  • 'c' … 読み書き可（デフォルト）
  • 'w' … 書き込み専用
  • 'r' … 読み取り専用
  • 'n' … 新規作成して読み書き
• protocol：pickleプロトコルのバージョンを指定します。Noneの場合はデフォルトのプロトコルが使用されます。
• writeback：デフォルトはFalse。Trueにするとアクセスされたエントリがメモリ上にキャッシュされ、sync()およびclose()の呼び出し時にまとめて書き戻されます。ただしキャッシュ管理のオーバーヘッドがあるため、処理速度が低下する可能性があります。

基本的な使い方：データベースへの保存

次のコードは、データベースを作成し、辞書形式でエントリを保存する例です。

import shelve

s = shelve.open("test")
s['name'] = "Ajay"
s['age'] = 23
s['marks'] = 75
s.close()

このコードを実行すると、カレントディレクトリに test.dir（使用するdbm実装によっては test.dat や test.db などのファイル）が作成され、キーと値のペアがハッシュ化された形で保存されます。

Shelfオブジェクトの主なメソッド

値の取得と更新

特定のキーの値にアクセスするには、通常の辞書と同じように記述します。

>>> s = shelve.open('test')
>>> s['age']
23
>>> s['age'] = 25
>>> s.get('age')
25

items()・keys()・values()による一覧取得

これらのメソッドはビューオブジェクトを返すため、list()で変換すると中身を確認しやすくなります。

>>> list(s.items())
[('name', 'Ajay'), ('age', 25), ('marks', 75)]
>>> list(s.keys())
['name', 'age', 'marks']
>>> list(s.values())
['Ajay', 25, 75]

pop()でキーと値のペアを削除する

>>> s.pop('marks')
75
>>> list(s.items())
[('name', 'Ajay'), ('age', 25)]

marks-75 のペアが削除されたことが確認できます。

update()で別の辞書をマージする

別の辞書の要素をshelfに統合するには update() メソッドを使用します。

>>> d = {'salary': 10000, 'designation': 'manager'}
>>> s.update(d)
>>> list(s.items())
[('name', 'Ajay'), ('age', 25), ('salary', 10000), ('designation', 'manager')]

まとめ

本記事では、永続的な辞書オブジェクトを手軽に扱えるshelveモジュールについて解説しました。小規模なデータ保存やアプリケーションの設定情報の管理など、データベースサーバーを用意するほどではないケースにおいて、shelveは非常に便利な選択肢となります。ぜひ実際の開発で活用してみてください。