我可以使用上下文值作为 click.option() 默认值吗？

Question

我想在我的配置（我加载到我的上下文中）中使用一个值作为单击命令选项的默认值。我已阅读 this section 文档，但我认为我不了解我需要做什么。

这是我的示例脚本：

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.

我也试过在我的 show_env 命令上使用 @pass_context，如下所示：

@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

我可以使用上下文设置命令选项默认值吗？

Answer 1

正如您所指出的，在您尝试检查时上下文尚不存在。您可以延迟从上下文中进行默认查找，直到上下文确实存在，方法是使用自定义 class，例如：

自定义Class

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

使用自定义 Class

要使用自定义 class 通过 cls 参数将其传递给 click.option，例如：

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

这是如何工作的？

之所以可行，是因为 click 是一个设计良好的 OO 框架。 @click.option() 装饰器通常实例化一个 click.Option 对象，但允许使用 cls 参数覆盖此行为。因此，在我们自己的 class 中继承 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

Answer 2

为了扩展上面的，对于 Click 8，click.Option.get_default 的签名是 get_default(self, ctx: Context, call: bool = True)，因此您可能需要添加 call 参数。

我可以使用上下文值作为 click.option() 默认值吗？

Can I use a context value as a click.option() default?

python

command-line-interface

python-click

自定义Class

使用自定义 Class

这是如何工作的？

测试代码：

结果：