PythonのGNU readlineインターフェース：履歴管理と主要関数を徹底解説

readlineモジュールは、UNIX環境向けに提供されているPython標準ライブラリの一つです。このモジュールを利用すると、Pythonインタープリタから履歴ファイルの読み書きを簡単に行えるようになります。単体で使用できるほか、rlcompleterモジュールと組み合わせてタブ補完機能を実現することも可能です。さらに、このモジュールの設定は、組み込み関数input()のプロンプトや対話型シェルの動作にも影響を与えます。

なお、macOS（Mac OS X）環境では、readlineモジュールはlibeditライブラリによって実装されています。そのため、GNU readlineとは設定方法が異なる点に注意が必要です。

このモジュールを使用するには、Pythonコード内でreadlineをインポートします。

import readline

readlineモジュールの主な関数一覧

コマンド履歴をファイルに保存するサンプルコード

次のコードは、履歴ファイルを読み込み、ホームディレクトリに保存する実用的な例です。このコードは対話モードで実行した場合に有効となり、Pythonシェルを終了すると履歴ファイルが自動的に書き込まれます。

import readline as rl
import os
import atexit

my_hist_file = os.path.join(os.path.expanduser("~"), ".my_python_hist")
try:
   rl.read_history_file(my_hist_file)
   rl.clear_history()
except FileNotFoundError:
   pass
   
print("Done")
atexit.register(rl.write_history_file, my_hist_file)
del os, my_hist_file

このスクリプトのポイントは、atexit.register()を使ってPythonシェル終了時にwrite_history_file()が自動的に呼び出されるようにしている点です。これにより、セッション中に入力したコマンドが~/.my_python_histファイルに記録され、次回起動時にはread_history_file()によって過去の履歴が復元されます。

実際に対話シェルで実行すると、次のようになります。

$ python3
Python 3.6.5 (default, Apr  1 2018, 05:46:30)
[GCC 7.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> exec(open("./readline_task.py").read())
Done
>>> print("readline_task.py is ececuted")
readline_task.py is ececuted
>>> print("History File will be updated after exit.")
History File will be updated after exit.
>>> 2 ** 10
1024
>>> 2 ** 20
1048576
>>> 2 ** 30
1073741824
>>> import math
>>> math.factorial(6)
720
>>> exit()
$ cat ~/.my_python_hist
print("readline_task.py is ececuted")
print("History File will be updated after exit.")
2 ** 10
2 ** 20
2 ** 30
import math
math.factorial(6)
exit()
$

シェルを終了した後、catコマンドで履歴ファイルの中身を確認すると、セッション中に入力したコマンドがすべて記録されていることが分かります。この仕組みを応用すれば、独自のカスタムPythonシェルや、履歴を永続化したいCLIツールを簡単に構築できます。