Как argparse (и устаревший optparse) реагирует на нажатие клавиши «tab» после имени программы python в bash? - PullRequest
Новая
       17

Как argparse (и устаревший optparse) реагирует на нажатие клавиши «tab» после имени программы python в bash?

11 голосов
/ 05 марта 2012

Я тестировал optcomplete, работающий с модулем optparse. Его пример - простой файл, так что я могу заставить его работать. Я также протестировал его с помощью модуля argparse, так как предыдущий устарел. Но я действительно не понимаю, как и кем вызывается программа python при нажатии вкладок. Я подозреваю, что bash вместе со строкой shebang и модулем argparse (или optparse) так или иначе вовлечены. Я пытался понять это (теперь собираюсь прочитать исходный код).

У меня есть немного более сложная структура программы, которая включает в себя обертку вокруг фрагмента кода, который обрабатывает аргументы. Его экземпляр argparse.ArgumentParser() и вызовы add_argument(), которые суперклассируются в другой промежуточный модуль, чтобы избежать дублирования кода и обертки вокруг вызываемого, находятся внутри функции.

Я хочу понять, как завершается эта вкладка между bash и python (или, в этом отношении, любым другим интерпретатором, таким как perl).

ПРИМЕЧАНИЕ. У меня есть четкое представление о завершении bash (которое я узнал только сейчас), и мне кажется, что я понимаю пользовательское завершение bash (только).

ПРИМЕЧАНИЕ. Я читал другие подобные вопросы SO, и никто не ответил на этот вопрос.

Редактировать: Здесь - это функция bash.
Я уже понял, как модуль python узнает о словах, напечатанных в командной строке, прочитав os.environ значения переменных 

$COMP_WORDS
$COMP_CWORD
$COMP_LINE
$COMP_POINT
$COMPREPLY

Эти переменные имеют значения только при нажатии клавиши табуляции. Мой вопрос: как запускается модуль python?

1 Ответ

14 голосов
/ 05 марта 2012

Чтобы понять, что здесь происходит, давайте проверим, что на самом деле делает эта функция 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

Итак1012 * просто читает окружение, готовит совпадения, записывает их в STDOUT и завершает работу.Результат -o -h -s -p --script --simple --help --output затем помещается в массив bash (COMPREPLY=( ... )) и возвращается в bash, чтобы представить выбор пользователю.Никакой магии не было:)

...