Расширение завершения BASH с помощью Python Click

Question

Я хочу настроить функцию завершения BASH моей программы CLI Python Click, чтобы она включала не только команды / подкоманды сценария, но и объекты, которые создает сценарий.

Допустим, моя программа называется cli-tool и он может создать объект foo используя команду:

cli-tool object create foo

Для простоты, скажем, команда просто объединяет строку аргумента (foo в этом случае) в текстовый файл с тем же именем, расположенный в ~/.cli-tool/objects/foo, дела cat ~/.cli-tool/objects/foo затем распечатать foo в вашем терминале.

То, что я хотел бы, чтобы инструмент сделал, когда я тогда наберу:

cli-tool object get <TAB><TAB>

Терминал будет затем перечислять foo и любые другие файлы, которые живут внутри ~/.cli-tool/objects,

Для справки, я прочитал стабильную документацию Python Click 6.x, в которой четко сказано:

В настоящее время завершение Bash является внутренней функцией, которую нельзя настроить. Это может быть смягчено в будущих версиях.

Я надеялся, что найдется способ извлечь полный скрипт завершения BASH из следующей команды:

eval "$(_CLI_TOOL_COMPLETE=source cli-tool)"

А потом настраивай сам. Я также видел проект завершения клика, но я не уверен, что он делает, кроме расширения завершения для оболочек Zsh и Fish.

Кто-нибудь достиг такого типа завершения, о котором я упоминал выше?

Answer 1

Используя завершение клика, это довольно просто.

Код:

Импорт и init() Нажмите Завершение:

import click
import click_completion

click_completion.init()

Затем создать экземпляр click.Choice объект:

option_type = click.Choice('obj1 obj2 obj3'.split())

В случае вашего каталога параметров, передайте список соответствующих элементов вместо примера obj1-obj3.

Затем передайте тип параметра click.argument() декоратор вроде:

@click.argument('option', type=option_type)

И не забудьте активировать завершение своей оболочкой. Вариант клика для bash находится здесь:

Тестовый код:

import click
import click_completion

click_completion.init()

option_type = click.Choice('obj1 obj2 obj3'.split())

@click.group()
def cli():
    """My Cool Tool"""

@cli.group(name='object')
def object_group():
    """Object subcommand"""

@object_group.command()
@click.argument('option', type=option_type)
def get(option):
    click.echo('option: {}'.format(option))


commands = (
    ('"" object get ""', 1),
    ('"" object get ""', 2),
    ('"" object get ""', 3),
    'object get obj1',
    '--help',
    'object --help',
    'object get --help',
)

os.environ['BASH_COMP'] = 'complete'

import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Click Completion Version: {}'.format(click_completion.__version__))
print('Python Version: {}'.format(sys.version))
for cmd in commands:
    try:
        time.sleep(0.1)
        print('\n-----------')
        print('> ' + str(cmd))
        time.sleep(0.1)

        if len(cmd) == 2:
            os.environ['COMP_WORDS'] = cmd[0]
            os.environ['COMP_CWORD'] = str(cmd[1])
            cli(complete_var='BASH_COMP')
        else:
            try:
                del os.environ['COMP_WORDS']
                del os.environ['COMP_CWORD']
            except:
                pass
            cli(cmd.split())


    except BaseException as exc:
        if str(exc) != '0' and \
                not isinstance(exc, (click.ClickException, SystemExit)):
            raise

Результаты:

Click Version: 6.7
Click Completion Version: 0.4.1
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct  3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]

-----------
> ('"" object get ""', 1)
object
-----------
> ('"" object get ""', 2)
get
-----------
> ('"" object get ""', 3)
obj1    obj2    obj3
-----------
> object get obj1
option: obj1

-----------
> --help
Usage: test.py [OPTIONS] COMMAND [ARGS]...

  My Cool Tool

Options:
  --help  Show this message and exit.

Commands:
  object  Object subcommand

-----------
> object --help
Usage: test.py object [OPTIONS] COMMAND [ARGS]...

  Object subcommand

Options:
  --help  Show this message and exit.

Commands:
  get

-----------
> object get --help
Usage: test.py object get [OPTIONS] OPTION

Options:
  --help  Show this message and exit.

Answer 2

Для Click 8.1.3 можно использовать автодополнение переопределяющего значения или автодополнение пользовательского типа .

Вот пример из документов , где вы можете использовать пользовательский shell_completeфункция. Он должен вернуть списокCompletionItemобъектов или в качестве ярлыка он может возвращать список строк.

      def complete_env_vars(ctx, param, incomplete):
    return [k for k in os.environ if k.startswith(incomplete)]

@click.command()
@click.argument("name", shell_complete=complete_env_vars)
def cli(name):
    click.echo(f"Name: {name}")
    click.echo(f"Value: {os.environ[name]}")