了解和使用python的click命令行cli工具

誰氵难浔2026-03-16 9:55

了解和使用python的click命令行cli工具

💡 关于通过简单的代码就能让一个python文件中的函数变成一个cli命令行工具。

安装

arduino 复制代码

pip install click

简单使用

1、创建文件

创建一个hello.py文件，代码如下：

arduino 复制代码

import click
@click.command()
def hi():    
    click.echo("Hello, World!")
    
if __name__ == '__main__':
    hi()

2、执行

如果使用@click.command()的话，那么只能有一个命令，这里我们就要用到@click.group()，声明一个组后就可以使用多个命令了，如：

python 复制代码

import click

# 1. 声明一个组
@click.group()
def cli():    
    """附件管理工具 - 支持搜索、删除等操作"""    
    pass# 
    
2. 将命令挂载到组上（使用 @cli.command 而不是 @click.command）
@cli.command()
@click.option('--name', help='文件夹名称')
def create(name):    
    """新建一个案例文件夹"""    
    click.echo(f"正在创建文件夹: {name}")
    
@cli.command()
@click.argument('keyword')
    def search(keyword):    
        """搜索指定的附件"""    
        click.echo(f"正在搜索关键字: {keyword}")

# 3. 运行组
if __name__ == '__main__':    
    cli()

如果不加命令名称运行：默认打印命令介绍。

此时就需要指定命令名运行了：此时我没有加参数运行，结果打印的文件夹名为None，加一个名称再打印：

OK！可以正常拿到参数值了。