这个 python-click 行为正确吗？

Question

我正在尝试使用 Pallets Click 来制作一个命令行程序，该程序采用输入参数列表和一个可选输出参数。

在带有 python-click 版本 7.0 的 Ubuntu 18.04 Python 3.6 和 Windows 10 Python 3.7 上的行为相同。

我做了一个测试文件click_test.py:

import click


@click.command()
@click.argument('src', nargs=-1, required=True)
@click.argument('dst', required=False)
def copy(src, dst):
    print(f'{src!r}')
    print(f'{dst!r}')


if __name__ == '__main__':
    copy()

运行python click_test.py first-argument 给出这个输出：

Usage: click_test.py [OPTIONS] SRC... [DST]
Try "click_test.py --help" for help.

Error: Missing argument "SRC...".

使用说明描述了我的期望。 SRC 是必需的，但 DST 是可选的。但是，错误消息仍然显示缺少 SRC。

这是正确的行为，还是这是一个错误？

Answer 1

您想要的命令行有点模棱两可。点击如何知道src 是src 还是最后一个dst？因此，对于nargs=-1，解析器将值从src 推迟到dst。

但是，您的问题中的期望可以通过以自定义 click.Argument 类的形式进行一些重新设计来实现。

自定义类：

def take_empty_from(other_param_name):

    class EmptyFrom(click.Argument):

        def consume_value(self, ctx, opts):
            value = opts.get(self.name)
            if value == () and opts.get(other_param_name):
                value = opts[self.name] = (opts.get(other_param_name), )
                opts[other_param_name] = None
                return value
            else:
                return super(EmptyFrom, self).consume_value(ctx, opts)

    return EmptyFrom

使用自定义类：

@click.command()
@click.argument('src', nargs=-1, required=True, cls=take_empty_from('dst'))
@click.argument('dst', required=False)
def copy(src, dst):

这是如何工作的？

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

在这种情况下，我们覆盖click.Argument.consume_value()，然后在只有一个参数的情况下，从dst获取参数并将其放入src。

注意：虽然此行为符合问题中的要求，但仍然无法回答为什么只有一个 dst 参数时才不需要 src。

测试代码：

import click


@click.command()
@click.argument('src', nargs=-1, required=True, cls=take_empty_from('dst'))
@click.argument('dst', required=False)
def copy(src, dst):
    click.echo('src: {}'.format(src))
    click.echo('dst: {}'.format(dst))


if __name__ == "__main__":
    commands = (
        '',
        'a',
        'a b',
        'a b c',
        '--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)
            copy(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)]
-----------
> 
Usage: click_prog.py [OPTIONS] SRC... [DST]

Error: Missing argument "src".
-----------
> a
src: ('a',)
dst: None
-----------
> a b
src: ('a',)
dst: b
-----------
> a b c
src: ('a', 'b')
dst: c
-----------
> --help
Usage: click_prog.py [OPTIONS] SRC... [DST]

Options:
  --help  Show this message and exit.