23.1. cmd — 行指向のコマンドインタープリタのサポート¶
ソースコード: Lib/cmd.py
Cmd クラスでは、行指向のコマンドインタープリタを書くための簡単なフレームワークを提供します。テストハーネスや管理ツール、そして、後により洗練されたインターフェイスでラップするプロトタイプとして、こうしたインタープリタはよく役に立ちます。
-
class
cmd.Cmd([completekey[, stdin[, stdout]]])¶ Cmdインスタンス、あるいはサブクラスのインスタンスは、行指向のインタープリタ・フレームワークです。Cmd自身をインスタンス化することはありません。むしろ、Cmdのメソッドを継承したり、アクションメソッドをカプセル化するために、あなたが自分で定義するインタープリタクラスのスーパークラスとしての便利です。オプション引数 completekey は、補完キーの
readline名です。デフォルトはTabです。 completekey がNoneでなく、readlineが利用できるならば、コマンド補完は自動的に行われます。オプション引数 stdin と stdout には、Cmd またはそのサブクラスのインスタンスが入出力に使用するファイルオブジェクトを指定します。省略時には
sys.stdinとsys.stdoutが使用されます。引数に渡した stdin を使いたい場合は、インスタンスの
use_rawinput属性をFalseにセットしてください。そうしないと stdin は無視されます。バージョン 2.3 で変更: パラメータ stdin と stdout が追加されました.
23.1.1. Cmdオブジェクト¶
Cmd インスタンスは、次のメソッドを持ちます:
-
Cmd.cmdloop([intro])¶ プロンプトを繰り返し出力し、入力を受け取り、受け取った入力から取り去った先頭の語を解析し、その行の残りを引数としてアクションメソッドへディスパッチします。
オプションの引数は、最初のプロンプトの前に表示されるバナーあるいはイントロ用の文字列です (これはクラス属性
introをオーバーライドします)。readlineモジュールがロードされているなら、入力は自動的に bash のような履歴リスト編集機能を受け継ぎます(例えば、Control-Pは直前のコマンドへのスクロールバック、Control-Nは次のものへ進む、Control-Fはカーソルを右へ非破壊的に進める、Control-Bはカーソルを非破壊的に左へ移動させる等)。入力のファイル終端は、文字列
'EOF'として渡されます。メソッド
do_foo()を持っている場合に限って、インタープリタのインスタンスはコマンド名fooを認識します。特別な場合として、文字'?'で始まる行はメソッドdo_help()へディスパッチします。他の特別な場合として、文字'!'で始まる行はメソッドdo_shell()へディスパッチします(このようなメソッドが定義されている場合)。このメソッドは
postcmd()メソッドが真を返したときに return します。postcmd()に対する stop 引数は、このコマンドが対応するdo_*()メソッドからの返り値です。補完が有効になっているなら、コマンドの補完が自動的に行われます。また、コマンド引数の補完は、引数 text, line, begidx, および endidx と共に
complete_foo()を呼び出すことによって行われます。 text は、マッチしようとしている文字列の先頭の語です。返されるマッチは全てそれで始まっていなければなりません。 line は始めの空白を除いた現在の入力行です。 begidx と endidx は先頭のテキストの始まりと終わりのインデックスで、引数の位置に依存した異なる補完を提供するのに使えます。Cmdのすべてのサブクラスは、定義済みのdo_help()を継承します。このメソッドは、(引数'bar'と共に呼ばれたとすると)対応するメソッドhelp_bar()を呼び出します。そのメソッドが存在しない場合、do_bar()の docstring があればそれを表示します。引数がなければ、do_help()は、すべての利用可能なヘルプ見出し(すなわち、対応するhelp_*()メソッドを持つすべてのコマンドまたは docstring を持つコマンド)をリストアップします。また、文書化されていないコマンドでも、すべてリストアップします。
-
Cmd.onecmd(str)¶ プロンプトに答えてタイプしたかのように引数を解釈実行します。これをオーバーライドすることがあるかもしれませんが、通常は必要ないでしょう。便利な実行フックについては、
precmd()とpostcmd()メソッドを参照してください。戻り値は、インタープリタによるコマンドの解釈実行をやめるかどうかを示すフラグです。コマンド str に対応するdo_*()メソッドがある場合、そのメソッドの返り値が返されます。そうでない場合はdefault()メソッドからの返り値が返されます。
-
Cmd.emptyline()¶ プロンプトに空行が入力されたときに呼び出されるメソッド。このメソッドがオーバーライドされていないなら、最後に入力された空行でないコマンドが繰り返されます。
-
Cmd.default(line)¶ コマンドの先頭の語が認識されないときに、入力行に対して呼び出されます。このメソッドがオーバーライドされていないなら、エラーメッセージを表示して戻ります。
-
Cmd.completedefault(text, line, begidx, endidx)¶ 利用可能なコマンド固有の
complete_*()が存在しないときに、入力行を補完するために呼び出されるメソッド。デフォルトでは、空行を返します。
-
Cmd.precmd(line)¶ コマンド行 line が解釈実行される直前、しかし入力プロンプトが作られ表示された後に実行されるフックメソッド。このメソッドは
Cmd内のスタブであって、サブクラスでオーバーライドされるために存在します。戻り値はonecmd()メソッドが実行するコマンドとして使われます。precmd()の実装では、コマンドを書き換えるかもしれないし、あるいは単に変更していない line を返すかもしれません。
-
Cmd.postcmd(stop, line)¶ コマンドディスパッチが終わった直後に実行されるフックメソッド。このメソッドは
Cmd内のスタブで、サブクラスでオーバーライドされるために存在します。 line は実行されたコマンド行で、 stop はpostcmd()の呼び出しの後に実行を停止するかどうかを示すフラグです。これはonecmd()メソッドの戻り値です。このメソッドの戻り値は、 stop に対応する内部フラグの新しい値として使われます。偽を返すと、実行を続けます。
Cmd のサブクラスのインスタンスは、公開されたインスタンス変数をいくつか持っています:
-
Cmd.prompt¶ 入力を求めるために表示されるプロンプト。
-
Cmd.identchars¶ コマンドの先頭の語として受け入れられる文字の文字列。
-
Cmd.lastcmd¶ 最後の空でないコマンドプリフィックス。
-
Cmd.cmdqueue¶ キューに入れられた入力行のリスト。cmdqueue リストは新たな入力が必要な際に
cmdloop()内でチェックされます; これが空でない場合、その要素は、あたかもプロンプトから入力されたかのように順に処理されます。
-
Cmd.doc_header¶ ヘルプ出力に文書化されたコマンドのセクションがある場合に表示するヘッダ。
-
Cmd.misc_header¶ ヘルプの出力にその他のヘルプ見出しがある(すなわち、
do_*()メソッドに対応していないhelp_*()メソッドが存在する)場合に表示するヘッダ。
-
Cmd.undoc_header¶ ヘルプ出力に文書化されていないコマンドのセクションがある(すなわち、対応する
help_*()メソッドを持たないdo_*()メソッドが存在する)場合に表示するヘッダ。
-
Cmd.ruler¶ ヘルプメッセージのヘッダの下に、区切り行を表示するために使われる文字。空のときは、ルーラ行が表示されません。デフォルトでは、
'='です。
-
Cmd.use_rawinput¶ フラグで、デフォルトでは真です。真ならば、
cmdloop()はプロンプトを表示して次のコマンド読み込むためにraw_input()を使います。偽ならば、sys.stdout.write()とsys.stdin.readline()が使われます。 (これが意味するのは、readlineを import することによって、それをサポートするシステム上では、インタープリタが自動的に Emacs 形式の行編集とコマンド履歴のキーストロークをサポートするということです。)