Pythonのtermiosモジュールを使ったPOSIXスタイルのTTY制御入門

Pythonのtermiosモジュールは、POSIX準拠のtty（端末）I/O制御を行うためのインターフェースを提供します。なお、このモジュールはUnix系システムでのみ利用可能であり、Windows環境では使用できない点に注意してください。

termiosモジュールを使用するには、まず次のようにインポートします。

import termios

このモジュールに含まれるすべてのメソッドは、対象となるファイルディスクリプタを引数として受け取ります。以下に、主なメソッドを紹介します。

termios.tcgetattr(fd)

指定されたファイルディスクリプタに対するtty属性のリストを取得します。返される属性は、iflag（入力フラグ）、oflag（出力フラグ）、cflag（制御フラグ）、lflag（ローカルフラグ）、ispeed（入力速度）、ospeed（出力速度）、cc（制御文字）です。

termios.tcsetattr(fd, when, attributes)

属性リストの内容をもとに、ttyの属性を設定します。第2引数の「when」は、属性をいつ変更するかを決定します。指定できる定数は以下の通りです。

termios.tcsendbreak(fd, duration)

ファイルディスクリプタに対してブレーク信号を送信します。durationに0を指定した場合、0.25〜0.5秒間のブレークが送られます。

termios.tcdrain(fd)

ファイルディスクリプタに書き込まれたすべての出力が実際に送信されるまで待機します。

termios.tcflush(fd, queue)

ファイルディスクリプタ上のキューデータを破棄します。第2引数の「queue」で、どのキューを対象にするかを指定できます。TCIFLUSHは入力キュー、TCOFLUSHは出力キュー、TCIOFLUSHはその両方を対象とします。

実装例：パスワード入力時のエコー無効化

以下は、termiosモジュールを活用した実践的な例です。パスワード入力時に画面へ文字が表示されないよう、エコー機能を一時的に無効化しています。

import termios, sys

def get_password(prompt="Enter Password: "):
    file_desc = sys.stdin.fileno()
    old_pass = termios.tcgetattr(file_desc)
    new_pass = termios.tcgetattr(file_desc)
    new_pass[3] &= ~termios.ECHO
    try:
        termios.tcsetattr(file_desc, termios.TCSADRAIN, new_pass)
        password = input(prompt)
    finally:
        termios.tcsetattr(file_desc, termios.TCSADRAIN, old_pass)
    return password

このコードでは、まずtcgetattr()で現在の端末設定を保存し、lflagからECHOフラグを取り除いた新しい設定を作成します。その後tcsetattr()でエコーを無効化してパスワードを受け付け、処理完了後はfinallyブロックによって、例外が発生した場合でも必ず元の設定へ復元されます。

実行結果

$ python3 example.py
Enter Password: 
Entered Password: my_password

このように、termiosモジュールを使えば端末の低レベルな動作を細かく制御でき、セキュアなパスワード入力など、標準ライブラリだけでは実現しづらい処理を実装できます。