前言:

        Python 的 click 是一个用于创建命令行界面的库,语法简洁、功能强大,特别适合构建复杂的 CLI 工具。

安装:

pip install click

简单的示例:

import click

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

if __name__ == '__main__':
    hello()

运行:

python script.py
# 输出: Hello, Click!

支持参数和选项:

1. 带参数

@click.command()
@click.argument('name')
def greet(name):
    click.echo(f"Hello, {name}!")
python script.py Mark
# 输出: Hello, Mark!

2. 带选项(可选参数)

@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):
    for _ in range(count):
        click.echo(f"Hello, {name}!")
python script.py --count 3 --name Mark

支持子命令(多命令结构)

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

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

@cli.command()
def run():
    click.echo('Running...')

if __name__ == '__main__':
    cli()
python script.py init
# 输出: Initializing...

python script.py run
# 输出: Running...

常用功能 

功能 用法
输出文字 click.echo()
读取输入 click.prompt()
确认提示 click.confirm()
颜色输出 click.secho("text", fg='red', bg='white', bold=True)
密码输入 click.prompt(..., hide_input=True)

进阶功能

  • 自动生成 --help 帮助文档

  • 参数类型限制(如:type=int, type=click.Path()

  • 支持环境变量、配置文件等集成

  • 支持命令链(Command Chaining)

 

Logo

Agent 垂直技术社区,欢迎活跃、内容共建。

更多推荐