如何让 Python 命令行程序自动完成任意内容，而不是解释器

问题描述：

我知道如何在 Python 解释器（在 Unix 上）中设置 Python 对象的自动完成。

• 谷歌显示有很多关于如何做到这一点的解释。

• 不幸的是，有太多的参考资料，很难找到我需要做的，这略有不同。

我需要知道如何在用 python 编写的命令行程序中启用任意项目的制表符/自动完成。

我的具体用例是一个需要发送电子邮件的命令行 Python 程序。我希望能够在用户输入部分内容时（并可选择按下 TAB 键）自动完成电子邮件地址（我的磁盘上有地址）。

我不需要它在 Windows 或 Mac 上运行，只需要 Linux。

解决方案 1：

使用 Python 的readline绑定。例如，

import readline

def completer(text, state):
    options = [i for i in commands if i.startswith(text)]
    if state < len(options):
        return options[state]
    else:
        return None

readline.parse_and_bind("tab: complete")
readline.set_completer(completer)

官方模块文档不太详细，请参阅readline 文档了解更多信息。

解决方案 2：

按照cmd 文档操作就可以了

import cmd

addresses = [
    'here@blubb.com',
    'foo@bar.com',
    'whatever@wherever.org',
]

class MyCmd(cmd.Cmd):
    def do_send(self, line):
        pass

    def complete_send(self, text, line, start_index, end_index):
        if text:
            return [
                address for address in addresses
                if address.startswith(text)
            ]
        else:
            return addresses


if __name__ == '__main__':
    my_cmd = MyCmd()
    my_cmd.cmdloop()

tab 的输出 -> tab -> send -> tab -> tab -> f -> tab

(Cmd)
help  send
(Cmd) send
foo@bar.com            here@blubb.com         whatever@wherever.org
(Cmd) send foo@bar.com
(Cmd)

解决方案 3：

既然你在问题中说“不是解释器”，我猜你不想要涉及 python readline 和诸如此类的答案。（编辑：事后看来，显然事实并非如此。呵呵。我觉得这个信息无论如何都很有趣，所以我就把它留在这里吧。）

我想你可能会追寻这个。

它是关于向任意命令添加 shell 级别的完成，扩展 bash 自己的 tab 完成功能。

简而言之，您将创建一个包含 shell 函数的文件，该函数将生成可能的补全，将其保存到命令中/etc/bash_completion.d/并将其注册到命令中complete。以下是链接页面的片段：

_foo() 
{
    local cur prev opts
    COMPREPLY=()
    cur="${COMP_WORDS[COMP_CWORD]}"
    prev="${COMP_WORDS[COMP_CWORD-1]}"
    opts="--help --verbose --version"

    if [[ ${cur} == -* ]] ; then
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
    fi
}
complete -F _foo foo

在这种情况下，输入foo --[TAB]将为您提供变量中的值opts，即--help和--verbose。--version出于您的目的，您本质上需要自定义输入的值opts。

请查看链接页面上的示例，它非常简单。

解决方案 4：

我很惊讶没有人提到argcompletePyPI 提供的。argcomplete在 Python 程序运行时不提供通用的自动完成功能，而是提供与 shell 的集成，以便 shell 可以为其命令行选项提供自动完成功能。以下是来自文档的示例：

from argcomplete.completers import ChoicesCompleter

parser.add_argument("--protocol", choices=('http', 'https', 'ssh', 'rsync', 'wss'))
parser.add_argument("--proto").completer=ChoicesCompleter(('http', 'https', 'ssh', 'rsync', 'wss'))

解决方案 5：

这是 ephemient 提供的代码的完整工作版本（谢谢）。

import readline

addrs = ['angela@domain.com', 'michael@domain.com', 'david@test.com']

def completer(text, state):
    options = [x for x in addrs if x.startswith(text)]
    try:
        return options[state]
    except IndexError:
        return None

readline.set_completer(completer)
readline.parse_and_bind("tab: complete")

while 1:
    a = raw_input("> ")
    print "You entered", a

解决方案 6：

# ~/.pythonrc
import rlcompleter, readline
readline.parse_and_bind('tab:complete')

# ~/.bashrc
export PYTHONSTARTUP=~/.pythonrc

解决方案 7：

您可以尝试使用Python Prompt Toolkit，这是一个用于在 Python 中构建交互式命令行应用程序的库。

该库可以轻松添加交互式自动完成功能，允许用户使用按键Tab以可视方式循环显示可用选项。该库是跨平台的（Linux、OS X、FreeBSD、OpenBSD、Windows）。示例：

（图片来源：pcgli）

解决方案 8：

发布的答案工作正常，但我已经开源了一个我在工作中编写的自动完成库。我们已经在生产中使用它一段时间了，它快速、稳定且易于使用。它甚至有一个演示模式，因此您可以快速测试输入单词时会得到什么。

要安装它，只需运行：pip install fast-autocomplete

以下是一个例子：

>>> from fast_autocomplete import AutoComplete
>>> words = {'book': {}, 'burrito': {}, 'pizza': {}, 'pasta':{}}
>>> autocomplete = AutoComplete(words=words)
>>> autocomplete.search(word='b', max_cost=3, size=3)
[['book'], ['burrito']]
>>> autocomplete.search(word='bu', max_cost=3, size=3)
[['burrito']]
>>> autocomplete.search(word='barrito', max_cost=3, size=3)  # mis-spelling
[['burrito']]

请查看：https://github.com/seperman/fast-autocomplete获取源代码。

这里解释了它的工作原理：http://zepworks.com/posts/you-autocomplete-me/

它处理拼写错误，并可选择按单词的权重进行排序。（假设burrito比更重要book，那么您给出burrito更高的“计数”，它将book在结果中首先显示。）

Words 是一本词典，每个单词都可以有一个上下文。例如“计数”、如何显示单词、单词周围的其他上下文等。在这个例子中，单词没有任何上下文。

解决方案 9：

效果很好。

#!/usr/bin/python3

import readline
readline.parse_and_bind("tab: complete")

def complete(text,state):
    volcab = ['dog','cat','rabbit','bird','slug','snail']
    results = [x for x in volcab if x.startswith(text)] + [None]
    return results[state]

readline.set_completer(complete)

line = input('prompt> ')