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

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

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

安装

复制代码
pip install click

简单使用

1、创建文件

创建一个hello.py文件,代码如下:

复制代码
import click

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

if __name__ == '__main__':
    hi()
2、执行

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

复制代码
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!可以正常拿到参数值了。

相关推荐
starzy199013 分钟前
深入理解Scala隐式参数:上下文流转
开发语言·python·scala
wuyk5551 小时前
Spider-第16讲-线程池与竞态问题
大数据·爬虫·python·elasticsearch·搜索引擎
feixing_fx1 小时前
JavaScript 是什么:从浏览器脚本到通用编程语言
开发语言·前端·javascript·前端框架·ecmascript
惜.己3 小时前
Java结合idea简单使用Playwright
java·开发语言·自动化
利威尔xu3 小时前
PostgreSQL 索引失效 4 类:函数运算让查询全表扫描拖垮性能
开发语言·数据库·postgresql·性能优化·索引优化
ShineWinsu3 小时前
对于Qt:QSpacerItem常见属性以及方法的解析
开发语言·c++·qt·面试·系统架构·客户端·qspaceritem
ShineWinsu7 小时前
对于Qt:QGripLayout常见属性、方法以及QSizePolicy的解析
开发语言·c++·qt·面试·gui·客户端·网格
艾莉丝努力练剑7 小时前
【AI大模型接入SDK】C++的SessionManager 线程安全
java·开发语言·前端·c++·人工智能·学习·安全
kyle~7 小时前
FastAPI --- 将业务能力以 API 的形式提供给外部系统
python·fastapi·前后端
aiotto资源分享7 小时前
Python 写 JSON 文件,程序中途退出会留下什么?
java·python·json·jsondecodeerror