参数

Click仅支持脚本的两种主要参数类型(根据设计):选项和参数。

选项

  • 是可选的。

  • 建议用于除子命令、网址或文件之外的所有内容。

  • 可以接受固定数量的参数。默认为1。它们可以使用多次指定 多种选择方案 .

  • 帮助页面已完整记录。

  • 自动提示丢失输入。

  • 可以充当标志(布尔值或其他)。

  • 可以从环境变量中提取。

论点

  • 在合理的情况下是可选的,但并非完全如此。

  • 建议用于子命令、网址或文件。

  • 可以接受任意数量的参数。

  • 帮助页面没有完全记录,因为它们可能太具体而无法自动记录。 详情请参阅 记录参数 .

  • 可以从环境变量中提取,但只能显式命名。详情请参阅 环境变量 .

您可以指定每个原则类型 参数类型 .查找这些类型有助于单击将详细信息添加到您的帮助页面并帮助处理这些类型。

参数名

参数(选项和参数)的名称将在调用带有值的装饰函数时用作Python参数名称。

@click.command()
@click.argument('filename')
@click.option('-t', '--times', type=int)
def multi_echo(filename, times):
    """Print value filename multiple times."""
    for x in range(times):
        click.echo(filename)

在上面的例子中,参数的名称是 filename .名称必须与python arg名称匹配。若要提供不同的名称以用于帮助文本,请参见 截断帮助文本 .该选项的名称为 -t--times .更多名称可供选择,请参阅 选项 .

以及运行时的样子:

$ multi_echo --times=3 index.txt
index.txt
index.txt
index.txt