Pythonのlinecacheモジュールでテキストファイルの任意の行にアクセスする方法

Python標準ライブラリのlinecacheモジュールは、テキストファイルへのランダムアクセス（任意の行への直接アクセス）を簡単に行うために用意されたモジュールです。実は、Pythonのtracebackモジュールがエラートレースバックを生成する際にも、このモジュールが内部的に活用されています。

linecacheの大きな特徴は、一度読み込んだ行をキャッシュに保持することです。そのため、同じ行を何度も読み出すような処理でも、毎回ファイルを開き直す必要がなく、処理時間を大幅に節約できます。

linecacheモジュールの主な関数

このモジュールで最も重要なのは、指定したファイルから特定の行番号の内容を読み取るgetline()関数です。以下に、linecacheが提供する主要な関数を紹介します。

getline(file, x)

指定したファイルからx番目の行を返します。該当する行が存在しない場合は空文字列が返されます。また、ファイルがカレントディレクトリに見つからない場合は、モジュール検索パスであるsys.path内のディレクトリからも自動的に探索してくれます。

clearcache()

以前のgetline()で取得した結果がもう不要になった場合、この関数を呼び出してキャッシュ全体をクリアできます。メモリを解放したいときに便利です。

checkcache()

キャッシュの内容が有効かどうかを検証します。キャッシュ対象のファイルがディスク上で更新されている可能性がある場合に呼び出すと、古いキャッシュを破棄して整合性を保てます。

lazycache(filename, module_globals)

module_globalsをもとに、指定したファイル名のキャッシュを事前に準備（シード）します。実際にソースコードが要求されるのはgetlines()が呼び出されたタイミングであり、即座に読み込まれるわけではありません。

getlines(filename)

ファイルの全行をリストオブジェクトとして返します。複数行をまとめて扱いたい場合に適しています。

updatecache(filename, module_globals)

キャッシュのエントリを更新し、行のリストを返します。

使用例：Zen of Pythonを読み込んでみよう

ここからは、linecacheの実際の使い方をデモンストレーションします。まず、「Zen of Python」（Pythonの設計思想を示す有名なソフトウェア原則のリスト）を格納するテキストファイルを作成しましょう。インタラクティブシェルでimport thisと入力すると表示される内容を、次のコードでzen.txtに出力します。

import sys, io
zen = io.StringIO()
old_stdout = sys.stdout
sys.stdout = zen
import this
sys.stdout = old_stdout
f=open('zen.txt','w')
f.write(zen.getvalue())
f.close()

上記のコードを実行すると、カレントディレクトリにzen.txtが作成されます。以降は、このテキストファイルを題材にgetline()関数で行を読み込んでいきます。

特定の1行を読み取る

たとえば、ファイルの4行目を読み取りたい場合は次のように書きます。

>>> import linecache
>>> linecache.getline('zen.txt',4)
'Explicit is better than implicit.\n'

戻り値の文字列が末尾の改行文字（\n）を含んでいる点に注意してください。改行を除去したい場合は.strip()などを併用するとよいでしょう。

複数行を範囲指定で読み取る

4行目から10行目までを表示したい場合は、getlines()関数が返すリストに対してスライス演算子を適用します。

>>> linecache.getlines('zen.txt')[4:10]
['Simple is better than complex.\n', 'Complex is better than complicated.\n', 'Flat is better than nested.\n', 'Sparse is better than dense.\n', 'Readability counts.\n', "Special cases aren't special enough to break the rules.\n"]

まとめ

本記事では、Python標準ライブラリのlinecacheモジュールについて学びました。getline()で任意の行を手軽に取得でき、キャッシュ機構によって繰り返し読み出しのパフォーマンスも向上します。大きなログファイルや設定ファイルの一部だけを頻繁に参照したいケースなどで、ぜひ活用してみてください。