欢迎使用 Click

_images/click-logo.png

click是一个python包,用于以可组合的方式创建漂亮的命令行接口,必要时只需很少的代码。它是“命令行界面创建工具包”。它是高度可配置的,但有现成的合理默认值。

它旨在使编写命令行工具的过程快速、有趣,同时防止由于无法实现预期的cli api而导致的任何挫折。

点击三点:

  • 任意嵌套命令

  • 自动生成帮助页

  • 支持在运行时延迟加载子命令

它是什么样子的?下面是一个简单的 Click 程序示例:

import click

@click.command()
@click.option('--count', default=1, help='Number of greetings.')
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def hello(count, name):
    """Simple program that greets NAME for a total of COUNT times."""
    for x in range(count):
        click.echo('Hello %s!' % name)

if __name__ == '__main__':
    hello()

以及跑步时的样子:

$ python hello.py --count=3
Your name: John
Hello John!
Hello John!
Hello John!

它自动生成格式良好的帮助页面:

$ python hello.py --help
Usage: hello.py [OPTIONS]

  Simple program that greets NAME for a total of COUNT times.

Options:
  --count INTEGER  Number of greetings.
  --name TEXT      The person to greet.
  --help           Show this message and exit.

您可以直接从pypi获取库:

pip install click

文档

文档的这一部分指导您了解库的所有使用模式。

API引用

如果您要查找有关特定函数、类或方法的信息,则文档的这一部分是为您准备的。