12

我已经测试过optcomplete使用该optparse模块。它的例子是一个简单的文件，所以我可以让它工作。我还使用该argparse模块对其进行了测试，因为不推荐使用之前的模块。但我真的不明白 python 程序是如何以及由谁在制表机上调用的。我怀疑bash与shebangline 和argparse(or optparse) 模块一起以某种方式参与。我一直在试图解决这个问题（现在要阅读源代码）。

我有一个更复杂的程序结构，其中包括处理参数的代码段的包装器。它的argparse.ArgumentParser()实例化和调用add_argument()——它们被超类到另一个中间模块以避免重复代码，以及被调用的包装器——都在一个函数内部。

我想了解此选项卡完成在 bash 和 python 之间的工作方式（或就此而言，任何其他解释器，如perl）。

注意：我对 bash 补全（我刚刚学到的）有相当了解，并且我想我理解 bash(only) 自定义补全。

注意：我已经阅读了其他类似的 SO 问题，但没有人真正回答这个问题。

编辑：这是 bash 功能。
我已经了解了 python 模块如何通过读取os.environ变量 的值来了解在命令行中键入的单词

$COMP_WORDS
$COMP_CWORD
$COMP_LINE
$COMP_POINT
$COMPREPLY

这些变量仅在制表符上具有值。我的问题是如何触发 python 模块？

4

1 回答 1

16

要了解这里发生了什么，让我们检查一下 bash 函数的实际作用：

COMPREPLY=( $( \
    COMP_LINE=$COMP_LINE  COMP_POINT=$COMP_POINT \
    COMP_WORDS="${COMP_WORDS[*]}"  COMP_CWORD=$COMP_CWORD \
    OPTPARSE_AUTO_COMPLETE=1 $1 ) )

看到$1最后了吗？这意味着它实际上调用了我们想要执行的 Python 文件，并设置了特殊的环境变量！为了追踪正在发生的事情，让我们准备一个小脚本来截取所做的事情optcomplete.autocomplete：

#!/usr/bin/env python2
import os, sys
import optparse, optcomplete
from cStringIO import StringIO

if __name__ == '__main__':    
    parser = optparse.OptionParser()

    parser.add_option('-s', '--simple', action='store_true',
                      help="Simple really simple option without argument.")

    parser.add_option('-o', '--output', action='store',
                      help="Option that requires an argument.")

    opt = parser.add_option('-p', '--script', action='store',
                            help="Option that takes python scripts args only.")
    opt.completer = optcomplete.RegexCompleter('.*\.py')

    # debug env variables
    sys.stderr.write("\ncalled with args: %s\n" % repr(sys.argv))
    for k, v in sorted(os.environ.iteritems()):
        sys.stderr.write("  %s: %s\n" % (k, v))

    # setup capturing the actions of `optcomplete.autocomplete`
    def fake_exit(i):
      sys.stderr.write("autocomplete tried to exit with status %d\n" % i)
    sys.stdout = StringIO()
    sys.exit = fake_exit

    # Support completion for the command-line of this script.
    optcomplete.autocomplete(parser, ['.*\.tar.*'])

    sys.stderr.write("autocomplete tried to write to STDOUT:\n")
    sys.stderr.write(sys.stdout.getvalue())
    sys.stderr.write("\n")

    opts, args = parser.parse_args()

当我们尝试自动完成它时，这给了我们以下信息：

$ ./test.py [tab]
called with args: ['./test.py']
  ...
  COMP_CWORD: 1
  COMP_LINE: ./test.py 
  COMP_POINT: 10
  COMP_WORDS: ./test.py 
  ...
  OPTPARSE_AUTO_COMPLETE: 1
  ...
autocomplete tried to exit with status 1
autocomplete tried to write to STDOUT:
-o -h -s -p --script --simple --help --output

所以optcomplete.autocomplete只需读取环境，准备匹配，将它们写入 STDOUT 并退出。然后将结果-o -h -s -p --script --simple --help --output放入 bash 数组 ( COMPREPLY=( ... )) 并返回到 bash 以将选择呈现给用户。不涉及魔法:)

于 2012-03-05T17:52:58.750 回答