Могу ли я использовать значение контекста в качестве click.option () по умолчанию? - PullRequest
Новая
       19

Могу ли я использовать значение контекста в качестве click.option () по умолчанию?

1 голос
/ 08 мая 2019

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

Это мой пример скрипта: 

import sys
import click

@click.group()
@click.pass_context
def cli(ctx):
    """
    CLI
    """
    ctx.ensure_object(dict)
    ctx.obj['DEFAULT_ENVIRONMENT'] = "dev"


@cli.command()
@click.option('-e', '--environment', required=True, default=click.get_current_context().obj['DEFAULT_ENVIRONMENT'])
def show_env(environment):
    click.echo(environment)


if __name__ == '__main__':
    cli()

Цель, если я запускаю python cli.py show-env, состоит в том, чтобы получить его для вывода dev (потому что я не передал параметр, поскольку он загружен из контекста).

Это не с 

Traceback (most recent call last):
  File "testcli.py", line 15, in <module>
    @click.option('-e', '--environment', required=True, default=click.get_current_context().obj['DEFAULT_ENVIRONMENT'])
  File "/home/devuser/.virtualenvs/cli/lib/python3.6/site-packages/click/globals.py", line 26, in get_current_context
    raise RuntimeError('There is no active click context.')
RuntimeError: There is no active click context.

Я также пытался использовать @pass_context в моей команде show_env следующим образом: 

@cli.command()
@click.option('-e', '--environment', required=True, default=ctx.obj['DEFAULT_ENVIRONMENT'])
@click.pass_context
def show_env(ctx, environment):
    click.echo(environment)

Что не получается, потому что ctx не определено в этой точке. 

Traceback (most recent call last):
  File "testcli.py", line 15, in <module>
    @click.option('-e', '--environment', required=True, default=ctx.obj['DEFAULT_ENVIRONMENT'])
NameError: name 'ctx' is not defined

Могу ли я использовать свой контекст для установки значения параметра команды по умолчанию?

1 Ответ

1 голос
/ 08 мая 2019

Как вы заметили, контекст еще не существует в то время, когда вы пытаетесь его исследовать. Вы можете отложить поиск по умолчанию из контекста, пока контекст не существует, с помощью пользовательского класса, такого как:

Пользовательский класс 

def default_from_context(default_name):

    class OptionDefaultFromContext(click.Option):

        def get_default(self, ctx):
            self.default = ctx.obj[default_name]
            return super(OptionDefaultFromContext, self).get_default(ctx)

    return OptionDefaultFromContext

Использование пользовательского класса

Чтобы использовать пользовательский класс, передайте его click.option через параметр cls, например: 

@click.option('-e', '--environment', required=True,
              cls=default_from_context('DEFAULT_ENVIRONMENT'))

Как это работает?

Это работает, потому что click - это хорошо спроектированная OO-инфраструктура. Декоратор @click.option() обычно создает экземпляр объекта click.Option, но позволяет переопределить это поведение параметром cls. Так что относительно просто унаследовать от click.Option в нашем собственном классе и переопределить нужные методы.

В этом случае мы переопределяем click.Option.get_default(). В нашем get_default() мы изучаем контекст и устанавливаем значение по умолчанию. Затем мы вызываем родителя get_default() для продолжения дальнейшей обработки.

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

import click

@click.group()
@click.pass_context
def cli(ctx):
    """
    CLI
    """
    ctx.ensure_object(dict)
    ctx.obj['DEFAULT_ENVIRONMENT'] = "dev"


@cli.command()
@click.option('-e', '--environment', required=True,
              cls=default_from_context('DEFAULT_ENVIRONMENT'))
def show_env(environment):
    click.echo(environment)


if __name__ == "__main__":
    commands = (
        'show_env',
        '--help',
    )

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

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

Результаты: 

Click Version: 6.7
Python Version: 3.6.5 (v3.6.5:f59c0932b4, Mar 28 2018, 05:52:31) 
[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.57)]
-----------
> show_env
dev
-----------
> --help
Usage: click_prog.py [OPTIONS] COMMAND [ARGS]...

  CLI

Options:
  --help  Show this message and exit.

Commands:
  show_env
...