Python CLI开发指南：Click库实用教程

使用 Python 的 Click 库可快速开发 CLI 工具，其核心是装饰器模式。1. 安装 Click：pip install click；2. 编写命令：通过 @click.command() 定义命令函数；3. 添加参数和选项：@click.argument() 用于必填参数，@click.option() 用于可选参数；4. 组织多个命令：用 @click.group() 管理子命令；5. 实用技巧：支持自动生成帮助文档、彩色输出、用户输入提示及操作确认功能。

想用 Python 写个命令行工具？Click 是个不错的选择。它简单易用，功能又强大，能让你快速搭出结构清晰、交互友好的 CLI 工具。不需要复杂的配置，也不需要手动解析参数，Click 把这些都帮你做了。

安装 Click

要开始使用 Click，第一步自然是安装它。你可以用 pip 安装：

pip install click

确认是否安装成功也很简单，在 Python 脚本中导入 click，不报错就说明装好了。

编写第一个命令行命令

Click 的核心是装饰器模式，通过给函数添加装饰器来定义命令和参数。来看一个最简单的例子：

import click

@click.command()
def hello():
    click.echo("Hello, World!")

if __name__ == '__main__':
    hello()

运行这个脚本后，就会输出 “Hello, World!”。虽然简单，但它已经是一个完整的 CLI 工具了。你还可以给它加参数或选项。

添加参数和选项

CLI 工具通常都需要接收用户输入的参数。Click 提供了两种主要方式：参数（arguments） 和 选项（options）。

参数（Arguments）

适合必填内容，比如文件名、用户名等。例如：

@click.command()
@click.argument('name')
def greet(name):
    click.echo(f"Hello, {name}")

运行时必须传入一个名字，如 greet Alice。

选项（Options）

用于可选参数，比如开关标志、配置项等。例如：

@click.command()
@click.option('--count', default=1, help='Number of greetings.')
def hello(count):
    for _ in range(count):
        click.echo("Hello!")

这样可以指定 --count=3 来控制输出几次“Hello!”。

你也可以把选项设为布尔值，比如：

@click.option('--verbose', is_flag=True)

当加上 --verbose 时，变量就是 True，否则是 False。

组织多个命令：Group 管理子命令

如果你的 CLI 工具有多个功能模块，可以用 @click.group() 把它们组织起来，就像 Git 那样有子命令：

@click.group()
def cli():
    pass

@cli.command()
def init():
    click.echo("Initializing...")

@cli.command()
def start():
    click.echo("Starting...")

if __name__ == '__main__':
    cli()

这样就可以运行 python script.py init 或 start，管理更清晰。

一些实用技巧

• 显示帮助信息：Click 自动生成帮助文档，只要在命令后加 --help 就能看到。
• 颜色输出：用 click.secho("Text", fg="red") 可以输出彩色文字，提升用户体验。
• 提示用户输入：click.prompt("Enter your name") 可以用来交互式获取输入。
• 确认操作：click.confirm("Are you sure?") 常用于删除等危险操作前让用户二次确认。

基本上就这些。用 Click 开发 CLI 工具，不复杂但容易忽略细节，比如参数顺序、默认值设置、类型转换这些地方，稍不注意可能就会出错。不过只要按着官方推荐的方式写，问题不大。