Python cmd.Cmd 的 precmd 和 postcmd 怎样修改命令循环

Python 的 cmd.Cmd 命令循环里，precmd() 负责在命令分发前改写输入，postcmd() 负责在命令执行后重新决定循环是否停止。前者适合做别名、空白清理和统一命令格式，后者适合做命令计数、统一退出策略和收尾记录。这样可以保留 do_* 方法的业务职责，不必重写 onecmd()。

官方地址：https://docs.python.org/3/library/cmd.html

本文只围绕这两个钩子展开。文中图片是静态结构说明图，用来解释对象之间的关系，不是浏览器、终端或程序运行截图。

先分清 precmd 和 postcmd 的职责

cmdloop() 读取一行命令后，会先调用 precmd(line)，再把它交给 onecmd()。因此 precmd() 的返回值就是将要执行的命令文本：返回原字符串表示不改写，返回新字符串就等于在分发前完成了一次规范化。

onecmd() 找到对应的 do_* 方法并取得返回值后，再调用 postcmd(stop, line)。这里的 stop 来自命令处理方法，postcmd() 的返回值会成为新的停止标志。返回假值，循环会继续；返回真值，命令循环会结束。

这个顺序带来一个实用分工：输入层的修改放在 precmd()，结果层的决策放在 postcmd()。不要在 precmd() 里模拟执行命令，也不要为了统一退出逻辑而复制 onecmd()。

在 precmd 中改写命令文本

最小的改写通常包括三件事：去掉首尾空白、把短别名转换为正式命令、把原始输入保存到实例属性供后续记录。改写后仍然返回一行普通命令文本，do_* 只需要处理参数。

import cmd


class Console(cmd.Cmd):
    prompt = "app> "
    aliases = {"q": "quit", "s": "status"}

    def __init__(self):
        super().__init__()
        self.command_count = 0
        self.last_normalized = ""

    def precmd(self, line):
        # 先统一空白，避免别名判断被用户输入的多余空格干扰。
        normalized = line.strip()
        if normalized:
            parts = normalized.split(maxsplit=1)
            command = self.aliases.get(parts[0], parts[0])
            # 只替换命令名，后面的参数原样交给 do_* 方法。
            normalized = " ".join([command, *parts[1:]]) if len(parts) > 1 else command
        self.last_normalized = normalized
        return normalized

    def do_status(self, arg):
        """显示当前命令计数。"""
        print(f"已处理 {self.command_count} 条命令，参数：{arg or '无'}")
        return False

    def do_quit(self, arg):
        """退出命令循环。"""
        return True

    def postcmd(self, stop, line):
        # 统一统计已经分发的命令，并保留 do_* 返回的停止语义。
        self.command_count += 1
        if line == "quit" or self.command_count >= 3:
            return True
        return stop


if __name__ == "__main__":
    # 真实程序可在这里调用 cmdloop；示例只展示钩子如何组合。
    Console().cmdloop()

这里输入 q 时，precmd() 会把它转换成 quit，所以 postcmd() 收到的是规范化后、已经执行的命令行。参数没有被钩子拆成业务对象，仍由 do_status(arg) 自己解释，职责边界会更清楚。

在 postcmd 中控制循环收尾

postcmd(stop, line) 最容易出错的地方是忽略第一个参数。若 do_quit() 返回 True，而 postcmd() 无条件返回 False，退出信号就会被覆盖，命令循环会继续。更稳妥的写法是默认返回原来的 stop，只有确实需要统一策略时才覆盖它。

上面的示例把“命令达到三条就结束”作为统一策略，同时保留 do_* 的返回值。生产代码里可以把计数换成权限上下文、批处理边界或资源收尾状态，但不要让 postcmd() 重新执行命令。它只应观察本次结果并返回新的停止标志。

最小迁移清单和常见误区

还要注意，空行并不一定会进入你期待的业务方法：cmd.Cmd 默认会重复上一次非空命令，除非你重写 emptyline()。另外，precmd() 的返回值必须仍是命令字符串；把它改成字典或其他对象，会破坏后续命令识别。

相关问题

precmd 可以直接阻止命令执行吗？

它的主要契约是返回将要解释的命令文本。若需求是拒绝执行，更适合在 do_* 或 onecmd() 的明确边界处理，而不是让 precmd() 返回非字符串对象。

postcmd 返回 False 会发生什么？

返回假值会让命令循环继续，即使前面的命令曾返回过真值。因此统一钩子应谨慎覆盖 stop，通常以 return stop 作为默认行为。