7

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

@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。我怎样才能做到这一点？

4

2 回答 2

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()如果其他指定的参数与所需的参数不匹配，我们将忽略并禁用提示的需要。

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

测试代码：

@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())
于 2018-04-01T23:04:33.093 回答
0

您可以尝试将其拆分为多个命令。例如，time将是入口点命令。然后根据 的值调用time_excel或。一个可能有密码提示，而另一个则没有。time_exchangetimedata_mode

请参阅Click 文档中的调用其他命令。

于 2017-03-08T10:29:55.097 回答