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 版更改: The stdin and stdout parameters were added.
23.1.1. Cmd 对象¶
Cmd 实例有下列方法：
-
Cmd.cmdloop([intro])¶ 反复发出提示，接受输入，从收到的输入中解析出一个初始前缀，并分派给操作方法，将其余的行作为参数传递给它们。
可选参数是在第一个提示之前发布的横幅或介绍字符串（这将覆盖
intro类属性）。如果
readline继承模块被加载，输入将自动继承类似 bash的历史列表编辑（例如， Control-P 滚动回到最后一个命令， Control-N 转到下一个命令，以 Control-F 非破坏性的方式向右 Control-B 移动光标，破坏性地等）。输入的文件结束符被作为字符串传回
'EOF'。解释器实例将会识别命令名称
foo当且仅当它有方法do_foo()。有一个特殊情况，分派始于字符'?'的行到方法do_help()。另一种特殊情况，分派始于字符'!'的行到方法do_shell()（如果定义了这个方法）这个方法将返回当
postcmd()方法返回一个真值 。参数 stop 到postcmd()是命令对应的返回值do_*()的方法。如果激活了完成，全部命令将会自动完成，并且通过调用
complete_foo()参数 text , line, begidx ,和 endidx 完成全部命令参数。 text 是我们试图匹配的字符串前缀，所有返回的匹配项必须以它为开头。 line 是删除了前导空格的当前的输入行， begidx 和 endidx 是前缀文本的开始和结束索引。，可以用于根据参数位置提供不同的完成。所有
Cmd的子类继承一个预定义do_help()。 这个方法使用参数'bar'调用， 调用对应的方法help_bar()，如果不存在，打印do_bar()的文档字符串，如果可用。没有参数的情况下，do_help()方法会列出所有可用的帮助主题 （即所有具有相应的help_*()方法或命令的 文档字符串），也会列举所有未被记录的命令。
-
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 相关联的内部标志的新值；返回 false 将导致解释继续。
Instances of Cmd subclasses have some public instance variables:
-
Cmd.prompt¶ 发出提示以请求输入。
-
Cmd.identchars¶ 接受命令前缀的字符串。
-
Cmd.lastcmd¶ 看到最后一个非空命令前缀。
-
Cmd.doc_header¶ 如果帮助输出具有记录命令的段落，则发出头文件。
-
Cmd.misc_header¶ 如果帮助输出其他帮助主题的部分（即与
do_*()方法没有关联的help_*()方法），则发出头文件。
-
Cmd.undoc_header¶ 如果帮助输出未被记录命令的部分（即与
help_*()方法没有关联的do_*()方法），则发出头文件。
-
Cmd.ruler¶ 用于在帮助信息标题的下方绘制分隔符的字符，如果为空，则不绘制标尺线。这个字符默认是
'='。
-
Cmd.use_rawinput¶ A flag, defaulting to true. If true,
cmdloop()usesraw_input()to display a prompt and read the next command; if false,sys.stdout.write()andsys.stdin.readline()are used. (This means that by importingreadline, on systems that support it, the interpreter will automatically support Emacs-like line editing and command-history keystrokes.)