getpass --- 可搬性のあるパスワード入力機構

ソースコード: Lib/getpass.py


利用可能な環境: not WASI.

このモジュールは WebAssembly では動作しないか、利用不可です。詳しくは、WebAssembly プラットフォーム を見てください。

getpass モジュールは二つの関数を提供します:

getpass.getpass(prompt='Password: ', stream=None)

エコーなしでユーザーにパスワードを入力させるプロンプト。 ユーザーは prompt の文字列をプロンプトに使え、デフォルトは 'Password: ' です。 Unixではプロンプトはファイルに似たオブジェクト stream へ、必要なら replace エラーハンドラを使って出力されます。 stream のデフォルトは、制御端末(/dev/tty)か、それが利用できない場合は sys.stderr です (この引数は Windowsでは無視されます)。

もしエコーなしで入力が利用できない場合は、 getpass() は stream に警告メッセージを出力し、 sys.stdin から読み込み、 GetPassWarning 警告を発生させます。

注釈

IDLE 内から getpass() を呼び出すと、IDLE のウィンドウではなく、IDLE を起動したターミナルで入力することになる場合があります。

exception getpass.GetPassWarning

パスワードの入力内容がエコーされる可能性がある場合に発行される、UserWarning のサブクラスです。

getpass.getuser()

ユーザーの "ログイン名"を返します。

この関数は環境変数 LOGNAME USER LNAME USERNAME の順序でチェックして、最初の空ではない文字列が設定された値を返します。もし、なにも設定されていない場合は pwd モジュールが提供するシステム上のパスワードデータベースから返します。それ以外の場合は、 OSError が送出されます。

一般に、os.getlogin() よりもこの関数を使うことを推奨します。

バージョン 3.13 で変更: 以前は OSError だけでなく、様々な例外が送出されていました。