python argparse 中的自定义选项卡补全

Question

如何在Python脚本中与

argparse

配合使用shell tab完成？

#!/usr/bin/env python
import argparse

def main(**args):
    pass

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('positional', choices=['spam', 'eggs'])
    parser.add_argument('--optional', choices=['foo1', 'foo2', 'bar'])
    args = parser.parse_args()
    main(**vars(args))

在 .py 文件上设置可执行标志后，预期结果应该类似于：

$ ./example.py sp<tab>             
   ->  completes to "./example.py spam"
$ ./example.py --op<tab> 
   ->  completes to "./example.py --optional"
$ ./example.py --optional b<tab>
   ->  completes to "./example.py --optional bar"
$ ./example.py --optional f<tab>   
   ->  completes to "./example.py --optional foo"
       and, additionally, prints  "foo1  foo2"  choices on stdout on a new line

Answer 1

看看 Andrey Kislyuk 的 argcomplete。

安装它：

pip install argcomplete

导入模块并在调用之前在源代码中添加一行

parser.parse_args()

:

#!/usr/bin/env python

import argparse as ap
import argcomplete

def main(**args):
  pass

if __name__ == '__main__':
  parser = ap.ArgumentParser()
  parser.add_argument('positional', choices=['spam', 'eggs'])
  parser.add_argument('--optional', choices=['foo1', 'foo2', 'bar'])
  argcomplete.autocomplete(parser)
  args = parser.parse_args()
  main(**vars(args))

为了确保 bash 知道这个脚本，您可以使用

eval "$(register-python-argcomplete your_script)"

您应该将该行放在您的

~/.bashrc

中或按照 argcomplete 的文档并激活“全局”完成。

之后，您将按要求完成工作。

其工作方式是 eval 行创建一个使用

_python_argcomplete

注册的函数

complete

。 （运行

register-python-argcomplete your_script

来看看 bash 中评估了什么）。自动完成功能会查找 bash 完成机制设置的环境变量，以查看是否需要执行操作。如果它起作用，则退出程序。如果它不动作，这是对程序的正常调用，该函数不执行任何操作，程序的正常流程将继续。

Answer 2

要使自动完成工作，您需要一个 bash 函数来生成可能的选项，然后需要运行

complete -F <function_name> <program_name>

最好的方法是让程序根据自己的解析算法生成补全函数，以避免重复。然而，快速浏览一下 argparse，我找不到访问其内部结构的方法，但我建议您寻找它。

这是一个适用于上述程序的 bash 函数：

function _example_auto() {
    local cur=${COMP_WORDS[COMP_CWORD]}
    local prev=${COMP_WORDS[COMP_CWORD-1]}

    case "$prev" in
    --optional ) 
        COMPREPLY=( $(compgen -W "foo1 foo2 bar" -- $cur) )
        return 0
        ;;
    *)
        COMPREPLY=( $(compgen -W "--optional spam eggs" -- $cur) )
        return 0
        ;;
    esac
}