我可以有一个 main() Click 函数来调用所有其他子命令吗?

Question

我有一个脚本，如下所示：

#myscript.py
import click
def step1(arg1):
print('Step 1: ' + arg1)
def step2(arg2):
print('Step 2: ' + arg2)
def main(arg1, arg2):
step1(arg1)
step2(arg2)

大多数时候我想用myscript arg1 arg2运行脚本，但偶尔我可能只想运行一个步骤：例如myscript step1 arg1.如何设置点击来执行此操作？有没有办法先有一个默认命令，然后是其他可选命令？

这似乎是Click不鼓励的一件事：

有时，从另一个命令调用一个命令可能会很有趣。这种模式通常不鼓励使用 Click，但仍然有可能。

我需要使用此click.invoke()模式吗？

Answer 1

我认为多命令链和多命令管道功能旨在涵盖这种情况。流水线提供了请求的确切行为(当命令行上没有给出任何内容时，step1和step2调用)，但它更详细，并且chain=True没有任何参数可以是可选的;你必须 (a) 总是同时给出arg1和arg2，即使只调用step2;或 (b) 将这些参数转换为选项(--arg1 foo而不是foo)。

链接

import click
@click.group(chain=True)
def cli():
pass
@cli.command()
@click.argument('arg1')
def step1(arg1):
click.echo('Step 1: ' + arg1)
@cli.command()
@click.argument('arg2')
def step2(arg2):
click.echo('Step 2: ' + arg2)
cli()

然后：

$ python3 chain.py step1 foo step2 bar
Step 1: foo
Step 2: bar
$ python3 chain.py step2 bar
Step 2: bar

流水线

import click
@click.group(chain=True, invoke_without_command=True)
@click.argument('arg1')
@click.argument('arg2')
def cli(arg1, arg2):
pass
@cli.resultcallback()
def process_pipeline(processors, **kwargs):
# If no commands given, invoke step1 then step2
processors = processors if len(processors) else [step1, step2]
for processor in processors:
processor(**kwargs)
def step1(**kwargs):
click.echo('Step 1: ' + kwargs['arg1'])
def step2(**kwargs):
click.echo('Step 2: ' + kwargs['arg2'])
@cli.command('step1')
def make_step1():
return step1
@cli.command('step2')
def make_step2():
return step2
cli()

然后

$ python3 pipeline.py foo bar
Step 1: foo
Step 2: bar
$ python3 pipeline.py foo bar step2
Step 2: bar

Answer 2

我没有用这个问题来充分解释我想要做什么，因为每个步骤也需要前一步的输出。非常感谢保罗让我走上了正确的道路。

我的解决方案是这样的：

@click.group(invoke_without_command=True)
@click.option('--arg1')
@click.option('--arg2')
@click.pass_context
def cli(ctx, arg1, arg2):
'''Description
'''
if ctx.invoked_subcommand is None:
do_everything(ctx, arg1, arg2)
@cli.command()
@click.option('--arg1')
def step_1(arg1):
return do_something(arg1)
@cli.command()
@click.argument('step_one_result')
@click.option('--arg2')
def step_2(step_one_result, arg2):
do_something_else(step_one_result, arg2)
def do_everything(ctx, arg1, arg2):
step_one_result = ctx.invoke(step_1, arg1=arg1)
ctx.invoke(do_something_else, step_one_result=step_one_result, arg2=arg2)
#and because of weirdness with pass_context and using setuptools
def main():
cli(obj={})
if __name__ == '__main__':
main()

编辑：您会注意到调用函数所必需的ctx.invoke()的使用，而不会收到以下错误

line 619, in make_context
ctx = Context(self, info_name=info_name, parent=parent, **extra)
TypeError: __init__() got an unexpected keyword argument 'arg1'