欢迎查阅 Click 中文文档¶
Click 是一个利用很少的代码以可组合的方式创造优雅命令行工具接口的 Python 库。 它是高度可配置的，但却有合理默认值的“命令行接口创建工具”。
它致力于将创建命令行工具的过程变的快速而有趣，免除你因无法实现一个 CLI API 的挫败感。
Click 的三个特性:
- 任意嵌套命令
- 自动生成帮助页面
- 支持在运行时延迟加载子命令
那么它到底什么样呢? 下面有一个简单的 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
文档内容¶
这部分文档将指引你浏览所有 Click 的使用方法。
API Reference¶
如果你想查阅一个特定函数、类或者方法的具体信息，请查阅这部分文档。