# 24.2。 `cmd` - 支持面向行的命令解释器

源代码： Lib / cmd.py

`Cmd`类提供了一个用于编写面向行的命令解释器的简单框架。这些对于测试套件，管理工具和原型通常是有用的，它们将被包装在更复杂的界面中。

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

  A `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对象

A `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()`方法返回true值时，此方法将返回。`postcmd()`的stop参数是命令的相应`do_*()`方法的返回值。

  如果启用完成，则将自动完成命令，并且通过使用参数文本，行调用`complete_foo()`完成命令args ，begidx和endidx。text是我们尝试匹配的字符串前缀：所有返回的匹配都必须以它开头。行是移除了前导空白的当前输入行，begidx和endidx是前缀文本的开始和结束索引，以根据参数在哪个位置提供不同的完成。

  `Cmd`的所有子类继承预定义的`do_help()`。这个方法用参数`'bar'`调用，调用相应的方法`help_bar()`，如果不存在，打印`do_bar()`（如果可用）。没有参数，`do_help()`列出所有可用的帮助主题（即，所有命令与相应的`help_*()`方法或具有docstrings的命令）未记录的命令。

`Cmd.``onecmd`(str)

  解释参数，就像它已经响应提示输入。这可能被覆盖，但通常不需要；请参阅有用的执行钩子的`precmd()`和`postcmd()`方法。返回值是指示解释器对命令的解释是否应该停止的标志。如果命令str有`do_*()`方法，则返回该方法的返回值，否则返回`default()`

`Cmd.``emptyline`()

  响应提示输入空行时调用的方法。如果此方法未被覆盖，它将重复输入的最后一个非空命令。

`Cmd.``default`(line)

  无法识别命令前缀时在输入行上调用的方法。如果此方法未覆盖，它将输出错误消息并返回。

`Cmd.``completedefault`(text, line, begidx, endidx)

  当没有特定于命令的`complete_*()`方法可用时，调用完成输入行的方法。默认情况下，它返回一个空列表。

`Cmd.``precmd`(line)

  在命令行行之前执行的Hook方法被解释，但是在生成并发出输入提示之后。此方法是`Cmd`中的存根；它存在被子类覆盖。返回值用作将由`onecmd()`方法执行的命令； `precmd()`实现可以重写命令或简单地返回行而不改变。

`Cmd.``postcmd`(stop, line)

  在命令分派完成后执行Hook方法。此方法是`Cmd`中的存根；它存在被子类覆盖。行是被执行的命令行，停止是指示在调用`postcmd()`后是否终止执行的标志；这将是`onecmd()`方法的返回值。此方法的返回值将用作对应于stop的内部标志的新值；返回false将导致解释继续。

`Cmd.``preloop`()

  当调用`cmdloop()`时执行一次Hook方法。此方法是`Cmd`中的存根；它存在被子类覆盖。

`Cmd.``postloop`()

  当`cmdloop()`即将返回时执行一次Hook方法。此方法是`Cmd`中的存根；它存在被子类覆盖。

`Cmd`子类的实例有一些公共实例变量：

`Cmd.``prompt`

  发出提示以征求输入。

`Cmd.``identchars`

  命令前缀接受的字符串字符串。

`Cmd.``lastcmd`

  显示的最后一个非空命令前缀。

`Cmd.``cmdqueue`

  队列输入行的列表。当需要新输入时，在`cmdloop()`中检查cmdqueue列表；如果它是非空的，其元素将按顺序处理，如同在提示符处输入。

`Cmd.``intro`

  要作为简介或横幅发出的字符串。可以通过将`cmdloop()`方法作为参数来覆盖。

`Cmd.``doc_header`

  如果帮助输出具有已记录命令的部分，则发出标题。

`Cmd.``misc_header`

  如果帮助输出具有其他帮助主题的部分（即，没有对应的`do_*()`方法的`help_*()`方法），则发出标题。

`Cmd.``undoc_header`

  如果帮助输出具有未记录的命令的部分（即，没有相应的`help_*()`方法的`do_*()`方法），则发出标题。

`Cmd.``ruler`

  用于在帮助消息标题下绘制分隔线的字符。如果为空，则不绘制标尺线。它默认为`'='`。

`Cmd.``use_rawinput`

  一个标志，默认为true。如果为true，则`cmdloop()`使用`input()`显示提示并读取下一个命令；如果为false，则使用`sys.stdout.write()`和`sys.stdin.readline()`。（这意味着通过导入`readline`，在支持它的系统上，解释器将自动支持Emacs - 例如行编辑和命令历史击键。

## 24.2.2. Cmd示例

`cmd`模块主要用于构建允许用户以交互方式处理程序的自定义外壳。

本节介绍如何在`turtle`模块中的几个命令构建shell的简单示例。

使用名为`do_forward()`的方法将基本龟图命令（例如`forward()`添加到`Cmd`子类中）。参数被转换为一个数字并被分派到龟模块。docstring在shell提供的帮助实用程序中使用。

该示例还包括使用`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 turle position:  POSITION'
            print('Current position is %d %d\n' % position())
        def do_heading(self, arg):
            'Print the current turle 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()

下面是一个带有龟壳的示例会话，显示帮助功能，使用空行重复命令，以及简单的记录和回放设施：

    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