Question

点击，我定义了这个命令：

@click.command('time', short_help='Timesheet Generator')
@click.argument('time_command', type=click.Choice(['this', 'last']))
@click.argument('data_mode', type=click.Choice(['excel', 'exchange']), default='exchange')
@click.option('--password', prompt=True, hide_input=True, confirmation_prompt=False)
@pass_context
def cli(ctx, time_command, data_mode, password):

我遇到的问题是，我只希望密码提示data_mode参数是否等于exchange。我该怎么办呢？

Answer 1

您可以尝试将其拆分为多个命令。例如，time将是入口点命令。然后time_excel或time_exchange将根据time的值调用data_mode或def format_float(num): return ('%i' if num == int(num) else '%s') % num。一个人可能有密码提示而另一个人不会。

请参阅Click的文档中的Invoking Other Commands。

Answer 2

如果另一个参数与特定值不匹配，我们可以通过构建从click.Option派生的自定义类来删除对提示的需要，并且在该类中使用click.Option.handle_parse_result()方法，如：

自定义类：

import click

def PromptIf(arg_name, arg_value):

    class Cls(click.Option):

        def __init__(self, *args, **kwargs):
            kwargs['prompt'] = kwargs.get('prompt', True)
            super(Cls, self).__init__(*args, **kwargs)

        def handle_parse_result(self, ctx, opts, args):
            assert any(c.name == arg_name for c in ctx.command.params), \
                "Param '{}' not found for option '{}'".format(
                    arg_name, self.name)

            if arg_name not in opts:
                raise click.UsageError(
                    "Illegal usage: `%s` is a required parameter with" % (
                        arg_name))

            # remove prompt from 
            if opts[arg_name] != arg_value:
                self.prompt = None

            return super(Cls, self).handle_parse_result(ctx, opts, args)

    return Cls

使用自定义类：

要使用自定义类，请将cls参数传递给click.option装饰器，如：

@click.option('--an_option', cls=PromptIf('an_argument', 'an_arg_value'))

传入参数名称以检查所需的值以及要检查的值。

这是如何工作的？

这是有效的，因为click是一个设计良好的OO框架。 @click.option()装饰器通常实例化click.Option对象，但允许使用cls参数覆盖此行为。因此，在我们自己的班级继承click.Option并过度使用所需的方法是一件相对容易的事。

在这种情况下，我们超越click.Option.handle_parse_result()并禁用提示其他指定参数是否与所需参数不匹配。

注意：这个答案的灵感来自this answer。

测试代码：

@click.command()
@click.argument('an_argument', type=click.Choice(['excel', 'exchange']),
                default='exchange')
@click.option('--password', hide_input=True, confirmation_prompt=False,
              cls=PromptIf('an_argument', 'exchange'))
def cli(an_argument, password):
    click.echo(an_argument)
    click.echo(password)

cli('exchange'.split())

仅当参数等于某事时才单击密码选项

2 个答案:

自定义类：

使用自定义类：

这是如何工作的？

测试代码：