如何使python命令行程序自动完成任意内容而不是解释程序


92

我知道如何在python解释器(在Unix上)中设置python对象的自动完成功能。

  • Google展示了许多热门内容,以说明如何执行此操作。
  • 不幸的是,有太多的参考文献,很难找到我需要做的事情,这略有不同。

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

我的特定用例是需要发送电子邮件的命令行python程序。我希望能够在用户键入部分电子邮件地址(并有选择地按TAB键)时自动完成电子邮件地址(磁盘上有地址)。

我不需要它就可以在Windows或Mac上运行,而只需Linux。


这个博客应该通过配置.pythonrc文件来解决问题。
克里斯·瑞夫

Answers:


63

使用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文档以获取更多信息。


1
请注意,如果使用cmd模块编写命令行,则有更好的方法来执行此操作。
FlorianBösch,

60

遵循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()

选项卡->选项卡->发送->选项卡->选项卡-> f->选项卡的输出

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

有什么方法可以控制readline如何对其输出进行列化?因此,可以说我希望它在每个项目之间用两个空格列化。
2013年

当我运行此代码时,选项卡只是简单地打印到命令行中。实际上,无论我使用cmd还是直接的readline,这都是正确的。
Hack Saw

38

由于您在问题中说“不翻译”,所以我想您不想要涉及python readline之类的答案。(编辑:事后看来,情况显然并非如此。Ho。我认为此信息仍然很有趣,因此我将其保留在此处。

我想你可能会这样

这是关于在任意命令中添加shell级完成功能,扩展bash自己的tab-completion。

简而言之,您将创建一个包含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

请看一下链接页面上的示例,这非常简单。


10
实际上,我因为这个原因来到这里
user1767754

谢谢,这正是我想要的!
Teekeks

27

我很惊讶没有人提到argcomplete,这是docs中的示例:

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'))

这是一个古老的帖子,也许argcomplete当时不存在?不过,感谢您提到它,我认为这正是我的项目所需要的!
FrustratedWithFormsDesigner 2015年

argparse结合使用也非常好!
AstroFloyd

13

这是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

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

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

1
对于Mac OS,请替换readline.parse_and_bind('tab:complete')readline.parse_and_bind ("bind ^I rl_complete")
Mani,

这太棒了。为我工作。感谢分享。
Ajay Ahuja,

@Mani我被困在这里很长时间了。非常感谢
AnaS Kayed

5

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

该库使添加交互式自动完成功能变得容易,从而允许用户使用该Tab键直观地浏览可用选项。该库是跨平台的(Linux,OS X,FreeBSD,OpenBSD,Windows)。例:

pgcli-Python提示工具包

(图片来源:pcgli


1

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

要安装它,只需运行: 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/wearefair/fast-autocomplete作为源代码。

以下是其工作原理的说明:http: //zepworks.com/posts/you-autocomplete-me/

它处理拼写错误,并可以选择按单词的权重排序。(比如说burrito比更为重要book,那么您赋予burrito更高的“计数”,它将首先出现book在结果中。

单词是字典,每个单词都可以有上下文。例如,“计数”,如何显示单词,单词周围的其他上下文等。在此示例中,单词没有任何上下文。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.