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

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

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

Cmd で作成したコマンドインタープリタは通常、対話用のプロンプトを表示し、入力を 1 行ずつ読み取って、各コマンドを do_ にコマンド名を続けた名前のメソッドに振り分けます。例えば help コマンドは do_help() メソッドが処理します。組み込みの help コマンドを除き、インタープリタの動作の大半は、自分のサブクラスに追加する do_* メソッドで定義します。

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

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

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

デフォルト値 'tab' は、すべての readline.backend で Tab キーを指すように特別に扱われます。具体的には、readline.backend が editline の場合、Cmd は 'tab' の代わりに '^I' を使います。他の値はこのようには扱われず、特定のバックエンドでしか機能しない可能性があります。

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

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

バージョン 3.13 で変更: editline では completekey='tab' を '^I' に置き換えるようになりました。

Cmdオブジェクト¶

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

Cmd.cmdloop(intro=None)¶

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

オプションの引数は、最初のプロンプトの前に表示されるバナーあるいはイントロ用の文字列です (これはクラス属性 intro をオーバーライドします)。

readline モジュールがロードされているなら、入力は自動的に bash のような履歴リスト編集機能を受け継ぎます(例えば、 Control-P は直前のコマンドへのスクロールバック、 Control-N は次のものへ進む、 Control-F はカーソルを右へ非破壊的に進める、 Control-B はカーソルを非破壊的に左へ移動させる等)。

入力のファイル終端は、文字列 'EOF' として渡されます。

インタープリタのインスタンスがコマンド名 foo を認識するのは、do_foo() メソッドを持つ場合に限られます。例外として、'?' で始まる行は do_help() メソッドに振り分けます。また、'!' で始まる行は do_shell() メソッドが定義されていれば、そのメソッドに振り分けます。

このメソッドは、postcmd() メソッドが真の値を返すと終了します。 postcmd() の stop 引数は、コマンドに対応する do_*() メソッドの戻り値です。

補完が有効な場合、コマンド名は自動的に補完します。コマンドの引数の補完には、text、line、begidx、endidx を引数として complete_foo() を呼び出します。 text はマッチさせる文字列の接頭辞で、返す候補はすべてこの文字列で始まらなければなりません。 line は先頭の空白を取り除いた現在の入力行です。 begidx と endidx は接頭辞のテキストの開始・終了インデックスで、引数の位置に応じて補完内容を変えるために使えます。

Cmd.do_help(arg)¶: Cmd のすべてのサブクラスは、あらかじめ定義された do_help() を継承します。引数 'bar' を渡すと、対応する help_bar() メソッドを呼び出します。そのメソッドがなければ、do_bar() の docstring がある場合にそれを表示します。引数なしの場合、do_help() は利用可能なヘルプトピックをすべて表示します。つまり、対応する help_*() メソッドがあるコマンドや、docstring があるコマンドの一覧です。説明のないコマンドの一覧も表示します。

Cmd.onecmd(str)¶: Interpret the argument as though it had been typed in response to the prompt. This may be overridden, but should not normally need to be; see the precmd() and postcmd() methods for useful execution hooks. The return value is a flag indicating whether interpretation of commands by the interpreter should stop. If there is a do_*() method for the command str, the return value of that method is returned, otherwise the return value from the default() method is returned.

Cmd.emptyline()¶: プロンプトに空行が入力されたときに呼び出されるメソッド。このメソッドがオーバーライドされていないなら、最後に入力された空行でないコマンドが繰り返されます。

Cmd.default(line)¶: コマンドの先頭の語が認識されないときに、入力行に対して呼び出されます。このメソッドがオーバーライドされていないなら、エラーメッセージを表示して戻ります。

Cmd.completedefault(text, line, begidx, endidx)¶: コマンド専用の complete_*() メソッドがない場合に、入力行を補完するために呼び出されるメソッドです。デフォルトでは空のリストを返します。

Cmd.columnize(list, displaywidth=80)¶: 文字列のリストを、コンパクトな複数列の形式で表示するために呼び出されるメソッドです。各列の幅は必要な分だけ確保します。読みやすくするため、列の間は 2 つのスペースで区切ります。

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¶: The header to issue if the help output has a section for undocumented commands (that is, there are do_*() methods without corresponding help_*() methods).

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

Cmd.use_rawinput¶: A flag, defaulting to true. If true, cmdloop() uses input() to display a prompt and read the next command; if false, sys.stdout.write() and sys.stdin.readline() are used. (This means that by importing readline, on systems that support it, the interpreter will automatically support Emacs-like line editing and command-history keystrokes.)

Cmd の例¶

cmd モジュールは主に、ユーザーがプログラムを対話的に操作できる独自のシェルを作成するのに役立ちます。

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

forward() などの基本的な turtle コマンドを、do_forward() という名前のメソッドで Cmd のサブクラスに追加します。引数を数値に変換して turtle モジュールに渡します。 docstring はシェルのヘルプ機能で使われます。

この例には、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

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

Cmdオブジェクト¶

Cmd の例¶

目次

前のトピックへ

次のトピックへ

このページ

cmd --- 行指向のコマンドインタープリターのサポート¶

Cmdオブジェクト¶

Cmd の例¶

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