欢迎点击¶

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(f"Hello {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
文件¶
备注
构建时间: 2025 年 05 月 28 日
教程¶
实务指南¶
概念指南¶
一般参考¶
API参考¶
关于项目¶
本文档的结构根据 Diataxis
Version Policy <https://palletsprojects.com/versions>
_Contributing <https://palletsprojects.com/contributing/>
_Donate <https://palletsprojects.com/donate>
_