Python cmd.Cmd 怎样为交互命令实现参数补全

给 cmd.Cmd 的某条命令添加参数补全，需要实现同名的 complete_命令名(self, text, line, begidx, endidx)，返回以 text 开头的候选字符串列表。例如 do_inspect 对应 complete_inspect；回调利用当前行和片段位置区分任务名、查看模式。候选应是替换当前片段的完整词，而不是整条命令。

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

下面设计一个只读任务控制台：输入 inspect TASK MODE 查看任务属性。参数建议与实际查询分开，Tab 只读候选，不改任务状态；真正回车执行时仍判断参数是否有效。代码为本文原创示例，未在本文制作过程中运行，不将下列交互分析视为实测记录。

明确命令语法和候选词表

把任务表设为 archive、audit、backup 三项，模式只允许 owner 和 state。第一个参数从任务表的键取词，第二个参数从模式元组取词。让补全和执行共用同一份定义，才能减少“建议里有，执行却不认识”的配置偏差。

本文语法特意限制为不含引号、空格的 ASCII 参数词，大小写敏感。这样用 split() 统计当前片段前的词就够用；文件路径、带空格名称和引号未闭合的输入不属于这份实现。

把参数位置交给 complete_inspect

回调中 text 是当前要匹配的前缀，line 是去掉前导空白的输入行，begidx 与 endidx 表示补全片段的起止位置。关键是取 line[:begidx]，而不是直接对整行分词：已经输入的部分前缀不应算作一个完成的参数。相关接口契约见 cmd 官方文档。

对于本例的普通单词输入，片段前只有 inspect 就选任务词表；片段前还有一个有效任务名，就选模式词表。第三个参数、未知任务或不支持的上下文返回空列表。text 为空时，startswith("") 可以保留该位置的全部候选；不要因此提前返回空列表。

表格只描述方法对这些输入的预期候选集合。候选如何显示、是否自动插入公共前缀，以及需要按一次还是多次 Tab，由行编辑器与当前键绑定共同决定。

给执行入口保留独立判断

import cmd

class TaskConsole(cmd.Cmd):
    prompt = "(task) "
    intro = "输入 help inspect 查看语法，输入 quit 退出。"
    tasks = {
        "archive": {"state": "ready", "owner": "ops"},
        "audit": {"state": "waiting", "owner": "data"},
        "backup": {"state": "ready", "owner": "ops"},
    }
    modes = ("owner", "state")

    def complete_inspect(self, text, line, begidx, endidx):
        # 只解析当前待补全片段之前的内容；本例参数不含空格和引号。
        prefix = line[:begidx].split()
        if not prefix or prefix[0] != "inspect":
            return []
        if len(prefix) == 1:
            choices = self.tasks
        elif len(prefix) == 2 and prefix[1] in self.tasks:
            choices = self.modes
        else:
            return []
        # 返回完整替换词，不拼接命令，也不在补全期间执行查询。
        return sorted(word for word in choices if word.startswith(text))

    def do_inspect(self, arg):
        """查询任务属性：inspect TASK MODE；MODE 为 owner 或 state。"""
        parts = arg.split()
        # 用户可以跳过 Tab 直接输入，因此执行入口仍需判断全部参数。
        if len(parts) != 2:
            self.stdout.write("用法：inspect TASK MODE\n")
            return
        task, mode = parts
        if task not in self.tasks or mode not in self.modes:
            self.stdout.write("未知任务或模式，请输入 help inspect。\n")
            return
        self.stdout.write(str(self.tasks[task][mode]) + "\n")

    def emptyline(self):
        # 空行不重复上一次命令，避免将来接入有副作用的业务动作。
        return None

    def do_quit(self, arg):
        """退出交互控制台。"""
        return True

    def do_EOF(self, arg):
        # 输入结束时统一走退出逻辑。
        self.stdout.write("\n")
        return True

if __name__ == "__main__":
    TaskConsole(completekey="tab").cmdloop()

将代码保存为 task_console.py，在具备行编辑支持的交互终端里启动该文件后输入示例命令。调用补全方法本身只返回列表，不会走 do_inspect。因此不能靠候选列表限制用户最终提交的内容：粘贴、手工输入、补全后继续修改都可能产生无效参数。

这个例子把实际操作限定为读取字典字段。若以后接入外部系统，应在执行方法中处理权限、异常与业务反馈，不要在补全回调里提前调用写入、提交或耗时远程请求。该建议是控制台设计约束，并不代表 cmd 自带业务权限系统。

处理补全不响应和输入边界

先区分回调逻辑与键盘环境。readline 是可选模块，官方标注其可用平台为 Unix；底层也可能是 libedit。键绑定和补全片段的索引会受底层实现影响。Windows 原生环境、重定向输入或编辑器内嵌输入框不能直接假定具备相同的 Tab 行为，参见 readline 平台与补全说明。

在具备支持的环境中，保留默认 completekey="tab" 和交互输入方式；若自行设置 use_rawinput=False，应认识到自己已改变输入路径，不能期待普通文件流提供同样的行编辑体验。不要同时安装另一个全局补全器覆盖 cmdloop 的设置。

实现层面的常见错误包括：把方法写成 complete_do_inspect、返回整条 inspect archive、忽略 text 过滤，以及对整行使用 split() 后把正在输入的词误算为已完成参数。CPython 的 cmd 实现 展示了命令专属补全的选择和候选列表的保存方式；业务代码通常不需要重写底层 complete(text, state)。

若候选扩展到 build-prod 这样的词，行编辑器可能把标点识别成分隔符；此时要统一词边界配置和解析规则。若支持带空格参数，需要设计引号、转义和未完成输入的解析，不能仅把当前回调改成 shlex.split(line) 就宣称支持：用户按 Tab 时引号可能尚未闭合。

常见问题

只写 do_inspect 会自动补全参数吗？

命令名与参数是不同层次。参数建议需要自己的 complete_inspect；没有专属回调时可以考虑 completedefault 作为统一兜底。本文不设置兜底，避免其他命令误用任务词表。

为什么空行不再重复上一条命令？

这是示例主动覆盖 emptyline 的结果。它让控制台在今后扩展有副作用的操作时减少误触发；不影响 Tab 的候选选择。

任务列表变化后怎么办？

本例每次从当前任务表取候选。真实应用若使用远程数据，可采用只读缓存并给执行入口保留最终判断；缓存中的建议不是操作一定成功的承诺。