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工具内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Python爬虫PyQuery库基本用法入门教程

    Python爬虫PyQuery库基本用法入门教程

    这篇文章主要介绍了Python爬虫PyQuery库基本用法,结合实例形式较为详细的分析了pyQuery库字符串初始化、打开网页、css属性、标签内容等获取、DOM基本操作等相关技巧与使用注意事项,需要的朋友可以参考下
    2018-08-08
  • jupyter notebook参数化运行python方式

    jupyter notebook参数化运行python方式

    这篇文章主要介绍了jupyter notebook参数化运行python方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-04-04
  • Python中包管理工具pip安装及常用命令总结

    Python中包管理工具pip安装及常用命令总结

    这篇文章主要介绍了Python的包管理工具pip的安装步骤和常用命令,以及如何在Python环境迁移中安装依赖,文中通过图文以及代码示例介绍的非常详细,需要的朋友可以参考下
    2024-12-12
  • Python蓄水池算法的应用案例与代码详解

    Python蓄水池算法的应用案例与代码详解

    蓄水池算法(Reservoir Sampling)是一种用于处理大规模数据流的随机抽样算法,该算法能够在不知道数据流大小的情况下,从数据流中均匀随机地抽取固定大小的样本,本文给大家介绍了一个详细的Python蓄水池算法的实现,包括完整的代码示例,需要的朋友可以参考下
    2024-11-11
  • 浅析python 定时拆分备份 nginx 日志的方法

    浅析python 定时拆分备份 nginx 日志的方法

    本文给大家分享python 定时拆分备份 nginx 日志的方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2020-04-04
  • Python实现简繁体转换

    Python实现简繁体转换

    很多时候简繁体转换,掌握了简体与繁体的转换,往往能够事半功倍,本文主要介绍了Python实现简繁体转换,感兴趣的可以了解一下
    2021-06-06
  • 使用python爬取taptap网站游戏截图的步骤

    使用python爬取taptap网站游戏截图的步骤

    这篇文章主要介绍了使用python爬取taptap游戏截图的步骤,帮助大家更好的理解和学习使用python进行爬虫,感兴趣的朋友可以了解下
    2021-05-05
  • Linux系统中安装Python3版本的安全方法与避坑指南

    Linux系统中安装Python3版本的安全方法与避坑指南

    如果你正在Linux系统上安装Python3,请立即停止,常规安装方法有99%的概率会让你的系统包管理器(yum/apt)彻底报废,本文将揭露这个致命陷阱,并提供无风险的解决方案
    2025-12-12
  • 解决Jupyter Notebook “signal only works in main thread“问题

    解决Jupyter Notebook “signal only works&nb

    这篇文章主要介绍了解决Jupyter Notebook “signal only works in main thread“问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-09-09
  • python实现类之间的方法互相调用

    python实现类之间的方法互相调用

    下面小编就为大家分享一篇python实现类之间的方法互相调用,具有很的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-04-04

最新评论