Python 命令行界面中的 Tab 补全 - 如何捕获 Tab 事件

Question

我正在用 Python 编写一个小 CLI（作为 Mercurial 的扩展），并且希望支持制表符补全。具体来说，我想在提示符中捕获选项卡并显示匹配选项的列表（就像 bash 一样）。

示例：输入部分名称：

 ext*TAB*  
 extensions  
 extras

问题是我不确定如何捕获 Tab 事件。我正在使用 Mercurial 的 ui.prompt() API，它只是在底层调用 raw_input() 。

据我所知，raw_input() 仅在“输入”时返回，如果用户输入选项卡，则返回的字符串仅包含 "\t"。

Answer 1

为此，您可以使用 readline 模块。

我能想到的最简单的代码：

import readline
COMMANDS = ['extra', 'extension', 'stuff', 'errors',
            'email', 'foobar', 'foo']

def complete(text, state):
    for cmd in COMMANDS:
        if cmd.startswith(text):
            if not state:
                return cmd
            else:
                state -= 1

readline.parse_and_bind("tab: complete")
readline.set_completer(complete)
raw_input('Enter section name: ')

示例用法：

Enter section name: <tab>
email      errors     extension  extra      foo        foobar    stuff
Enter section name: e<tab>
email      errors     extension  extra      
Enter section name: ext<tab>
extension  extra      

除了补全之外，readline 还为您提供：

• 行编辑
• 按键绑定配置（包括 emacs 和 vi 模式）
• 历史记录（向上箭头可调用以前的值）
• 历史记录搜索、保存和加载

Answer 2

您几乎肯定应该使用 cmd 模块，它已经实现了制表符补全等功能，以及可能您想要做的其他部分，使用 readline 模块等等。重新发明轮子是没有意义的。

Answer 3

一个很好的例子，展示了如何与 readline 配合进行制表符补全在标准库中作为 rlcompleter 模块提供 - 您不能将其用作-is（它根据当前在 Python 的 main 和builtin 中定义的名称完成），但它显示了如何执行一般任务以及如何将其连接到 readline。