python的click命令行cli工具使用
更新时间:2026年04月05日 09:42:24 作者:一方_self
本文主要介绍了使用Python的click库将函数转换为命令行工具的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
💡 关于通过简单的代码就能让一个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!可以正常拿到参数值了。
到此这篇关于python的click命令行cli工具使用的文章就介绍到这了,更多相关python cli工具内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!
相关文章
解决Jupyter Notebook “signal only works&nb
这篇文章主要介绍了解决Jupyter Notebook “signal only works in main thread“问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2023-09-09


最新评论