# 24.2. `cmd` --- 行指向のコマンドインタープリタのサポート

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

`Cmd` クラスでは、行指向のコマンドインタープリタを書くための簡単なフレームワークを提供します。テストハーネスや管理ツール、そして、後により洗練されたインターフェイスでラップするプロトタイプとして、こうしたインタープリタはよく役に立ちます。

class `cmd.``Cmd`(completekey='tab', stdin=None, stdout=None)

  `Cmd` インスタンス、あるいはサブクラスのインスタンスは、行指向のインタープリタ・フレームワークです。 `Cmd` 自身をインスタンス化することはありません。むしろ、 `Cmd` のメソッドを継承したり、アクションメソッドをカプセル化するために、あなたが自分で定義するインタープリタクラスのスーパークラスとしての便利です。

  オプション引数 completekey は、補完キーの `readline` 名です。デフォルトは `Tab` です。 completekey が `None` でなく、 `readline` が利用できるならば、コマンド補完は自動的に行われます。

  オプション引数の stdin と stdout には、Cmd またはそのサブクラスのインスタンスが入出力に使用するファイルオブジェクトを指定します。省略時には `sys.stdin` と `sys.stdout` が使用されます。

  引数に渡した stdin を使いたい場合は、インスタンスの `use_rawinput` 属性を `False` にセットしてください。そうしないと stdin は無視されます。

## 24.2.1. Cmdオブジェクト

`Cmd` インスタンスは、次のメソッドを持ちます:

`Cmd.``cmdloop`(intro=None)

  プロンプトを繰り返し出力し、入力を受け取り、受け取った入力から取り去った先頭の語を解析し、その行の残りを引数としてアクションメソッドへディスパッチします。

  オプションの引数は、最初のプロンプトの前に表示されるバナーあるいはイントロ用の文字列です (これはクラス属性 `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.``preloop`()

  `cmdloop()` が呼び出されたときに一度だけ実行されるフックメソッド。このメソッドは `Cmd` 内のスタブであって、サブクラスでオーバーライドされるために存在します。

`Cmd.``postloop`()

  `cmdloop()` が戻る直前に一度だけ実行されるフックメソッド。このメソッドは `Cmd` 内のスタブであって、サブクラスでオーバーライドされるために存在します。

`Cmd` のサブクラスのインスタンスは、公開されたインスタンス変数をいくつか持っています:

`Cmd.``prompt`

  入力を求めるために表示されるプロンプト。

`Cmd.``identchars`

  コマンドの先頭の語として受け入れられる文字の文字列。

`Cmd.``lastcmd`

  最後の空でないコマンド接頭辞。

`Cmd.``cmdqueue`

  キューに入れられた入力行のリスト。cmdqueue リストは新たな入力が必要な際に `cmdloop()` 内でチェックされます; これが空でない場合、その要素は、あたかもプロンプトから入力されたかのように順に処理されます。

`Cmd.``intro`

  イントロあるいはバナーとして表示される文字列。 `cmdloop()` メソッドに引数を与えるために、オーバーライドされるかもしれません。

`Cmd.``doc_header`

  ヘルプ出力に文書化されたコマンドのセクションがある場合に表示するヘッダ。

`Cmd.``misc_header`

  ヘルプの出力にその他のヘルプ見出しがある(すなわち、 `do_*()` メソッドに対応していない `help_*()` メソッドが存在する)場合に表示するヘッダ。

`Cmd.``undoc_header`

  ヘルプ出力に文書化されていないコマンドのセクションがある(すなわち、対応する `help_*()` メソッドを持たない `do_*()` メソッドが存在する)場合に表示するヘッダ。

`Cmd.``ruler`

  ヘルプメッセージのヘッダの下に、区切り行を表示するために使われる文字。空のときは、ルーラ行が表示されません。デフォルトでは、`'='` です。

`Cmd.``use_rawinput`

  フラグで、デフォルトでは真です。真ならば、 `cmdloop()` はプロンプトを表示して次のコマンド読み込むために `input()` を使います。偽ならば、 `sys.stdout.write()` と `sys.stdin.readline()` が使われます。 (これが意味するのは、 `readline` を import することによって、それをサポートするシステム上では、インタープリタが自動的に Emacs 形式の行編集とコマンド履歴のキーストロークをサポートするということです。)

## 24.2.2. Cmd の例

`cmd` モジュールは、ユーザーがプログラムと対話的に連携できるカスタムシェルを構築するのに主に役立ちます。

この節では、`turtle` モジュールのいくつかのコマンドを持ったシェルの作成方法の簡単な例を示します。

`forward()` のような基本的な turtle コマンドは `Cmd` のサブクラスに `do_forward()` と名付けられたメソッドで追加されます。 引数は数値に変換され、 turtle モジュールに振り分けられます。ドキュメント文字列はシェルによって提供されるヘルプユーティリティで使用されます。

この例には、基本的な記録機能と再実行機能が含まれていて、入力を小文字に変換しコマンドをファイルに書き込む責務を持たせた `precmd()` メソッドに実装されています。 `do_playback()` メソッドはファイルを読み込み、そこに記録されているコマンドをすぐに再実行するために `cmdqueue` に追加します:

    import cmd, sys
    from turtle import *

    class TurtleShell(cmd.Cmd):
        intro = 'Welcome to the turtle shell.   Type help or ? to list commands.\n'
        prompt = '(turtle) '
        file = None

        # ----- basic turtle commands -----
        def do_forward(self, arg):
            'Move the turtle forward by the specified distance:  FORWARD 10'
            forward(*parse(arg))
        def do_right(self, arg):
            'Turn turtle right by given number of degrees:  RIGHT 20'
            right(*parse(arg))
        def do_left(self, arg):
            'Turn turtle left by given number of degrees:  LEFT 90'
            left(*parse(arg))
        def do_goto(self, arg):
            'Move turtle to an absolute position with changing orientation.  GOTO 100 200'
            goto(*parse(arg))
        def do_home(self, arg):
            'Return turtle to the home position:  HOME'
            home()
        def do_circle(self, arg):
            'Draw circle with given radius an options extent and steps:  CIRCLE 50'
            circle(*parse(arg))
        def do_position(self, arg):
            'Print the current turtle position:  POSITION'
            print('Current position is %d %d\n' % position())
        def do_heading(self, arg):
            'Print the current turtle heading in degrees:  HEADING'
            print('Current heading is %d\n' % (heading(),))
        def do_color(self, arg):
            'Set the color:  COLOR BLUE'
            color(arg.lower())
        def do_undo(self, arg):
            'Undo (repeatedly) the last turtle action(s):  UNDO'
        def do_reset(self, arg):
            'Clear the screen and return turtle to center:  RESET'
            reset()
        def do_bye(self, arg):
            'Stop recording, close the turtle window, and exit:  BYE'
            print('Thank you for using Turtle')
            self.close()
            bye()
            return True

        # ----- record and playback -----
        def do_record(self, arg):
            'Save future commands to filename:  RECORD rose.cmd'
            self.file = open(arg, 'w')
        def do_playback(self, arg):
            'Playback commands from a file:  PLAYBACK rose.cmd'
            self.close()
            with open(arg) as f:
                self.cmdqueue.extend(f.read().splitlines())
        def precmd(self, line):
            line = line.lower()
            if self.file and 'playback' not in line:
                print(line, file=self.file)
            return line
        def close(self):
            if self.file:
                self.file.close()
                self.file = None

    def parse(arg):
        'Convert a series of zero or more numbers to an argument tuple'
        return tuple(map(int, arg.split()))

    if __name__ == '__main__':
        TurtleShell().cmdloop()

以下は、turtle シェルでの機能のヘルプ表示、空行によるコマンドの繰り返し、単純な記録と再実行のセッション例です:

    Welcome to the turtle shell.   Type help or ? to list commands.

    (turtle) ?

    Documented commands (type help <topic>):
    ========================================
    bye     color    goto     home  playback  record  right
    circle  forward  heading  left  position  reset   undo

    (turtle) help forward
    Move the turtle forward by the specified distance:  FORWARD 10
    (turtle) record spiral.cmd
    (turtle) position
    Current position is 0 0

    (turtle) heading
    Current heading is 0

    (turtle) reset
    (turtle) circle 20
    (turtle) right 30
    (turtle) circle 40
    (turtle) right 30
    (turtle) circle 60
    (turtle) right 30
    (turtle) circle 80
    (turtle) right 30
    (turtle) circle 100
    (turtle) right 30
    (turtle) circle 120
    (turtle) right 30
    (turtle) circle 120
    (turtle) heading
    Current heading is 180

    (turtle) forward 100
    (turtle)
    (turtle) right 90
    (turtle) forward 100
    (turtle)
    (turtle) right 90
    (turtle) forward 400
    (turtle) right 90
    (turtle) forward 500
    (turtle) right 90
    (turtle) forward 400
    (turtle) right 90
    (turtle) forward 300
    (turtle) playback spiral.cmd
    Current position is 0 0

    Current heading is 0

    Current heading is 180

    (turtle) bye
    Thank you for using Turtle